Instance API

Use this API to manage instances on the ironSource dashboard.

Before you start make sure you go over our API introduction article.

Get Instances

Description
Use this API to retrieve a list of all of your application’s instances. The response will include all information from the Applications List API, as well as the following: instance name, instance ID, status, and pricing if relevant (pricing is only available for ironSource network instances)

Authentication Type

Bearer API authentication

Method
GET platform.ironsrc.com/partners/publisher/instances/v1?

Required Parameters

Name Type Description
appKey String application Key (as seen on our platform)

Request Example URL

https://platform.ironsrc.com/partners/publisher/instances/v1?appKey=6e9e4c111

Response Parameters

Name Description
ID unique instance ID generated by ironSource platform on instance creation
name instance name
status instance status can be active or inactive 
pricing pricing as set on the platform

JSON Example Response

{
  "appKey": "6e9e4c111",
  "adUnits": {
    "rewardedVideo": {
      "ironSourceNetworkStatus": "active",
      "activeNetworks": [
        "ironSource"
      ],
      "networkInstances": {
        "ironSource": [
          {
            "id": 0,
            "name": "Default",
            "status": "active"
          },
          {
            "id": 12345,
            "name": "secondRVInstance",
            "status": "active"
          },
          {
            "id": 45678,
            "name": "thirdRVInstance",
            "status": "inactive"
          }
        ]
      }
    },
    "offerWall": {
      "ironSourceNetworkStatus": "test",
      "activeNetworks": [
        "ironSource"
      ]
    },
    "interstitial": {
      "ironSourceNetworkStatus": "active",
      "activeNetworks": [
        "ironSource"
      ],
      "networkInstances": {
        "ironSource": [
          {
            "id": 0,
            "name": "Default",
            "status": "active"
          },
          {
            "id": 23456,
            "name": "secondISInstance",
            "status": "active",
            "pricing": [
              {
                "eCPM": "0.01",
                "Countries": [
                  "FR",
                  "UK"
                ]
              }
            ]
          }
        ]
      }
    },
    "banner": {
      "ironSourceNetworkStatus": "active",
      "activeNetworks": [
        "ironSource"
      ],
      "networkInstances": {
        "ironSource": [
          {
            "id": 0,
            "name": "Default",
            "status": "active"
          }
        ]
      }
    }
  }
}

Create Instances

Description
Use this API to create instances for both ironSource network and mediated ad sources. This API allows you to create multiple instances with a single API call.

Notes:

  1. Instances created without a ‘status’ parameter set will be automatically set according to that network’s default instance status.
  2. For Mediation users – each newly created instance will be included in all of the app’s mediation groups.
  3. Each app is limited up to 10 instances per ad unit. In order to extend this limitation Contact Us or reach out to your Account Manager.
  4. To create instances for mediated ad sources, please refer to this article for naming convention.

CPM pricing:

General –

  1. CPM Pricing allows you the control and flexibility to define expected CPM rates from ironSource’s network.  Read more here.
  2. CPM pricing is available for specific accounts only, to activate CPM pricing Contact Us or reach out to your Account Manager.
  3. For best practices on using instances with pricing go to our Best Practices article.

Notes –

  1. In order to set global pricing for an instance, populate the instance’s country field with asterisk character ‘*’.
  2. Instances created without pricing and countries without defined pricing will be set to use optimized pricing.
  3. Countries are defined based on 2 letter country code, as per ISO 3166-1 Alpha-2.

Authentication Type

Bearer API authentication

Method

POST platform.ironsrc.com/partners/publisher/instances/v1?

Required Parameters

Name Type Description
appKey String application Key (as seen on our platform)
provider String array for ad source naming convention refer to this article
adUnit String array “rewardedVideo”, “interstitial”, “banner”
instanceName String the newly created instance’s name 
provider instance level config* String for ad source instance level configs naming convention refer to this article

 *Note: provider instance level config is only mandatory on the creation of mediation a source instances. This parameter naming varies between mediation ad sources. For naming convention go to this article.


Optional Parameters

Name Type Description
status String instance status can be ‘active’ or ‘inactive’
pricing String  determine the eCPM to be delivered by ironSource network
provider app level configs* String for ad source app level configs naming convention refer to this article

 *Note: ad source app level configs varies between mediation ad sources. For naming convention go to this article. 

Request Example URL

https://platform.ironsrc.com/partners/publisher/instances/v1?

Request Example Body

{
  "appKey": "8a30e319",
  "configurations": {
    "ironSource": {
      "rewardedVideo": [
        {
          "instanceName": "high",
          "status": "inactive",
          "pricing": [
            {
              "eCPM": 0.99,
              "country": [
                "IL"
              ]
            },
            {
              "eCPM": 2.03,
              "country": [
                "US"
              ]
            }
          ]
        }
      ]
    },
    "adColony": {
      "appConfig": {
        "appID": "fk34sf"
      },
      "rewardedVideo": [
        {
          "instanceName": "default",
          "status": "active",
          "zoneId": 123
        },
        {
          "instanceName": "low",
          "status": "inactive",
          "zoneId": 1234
        }
      ]
    }
  }
}

JSON Example Response

{
  "rewardedVideo": {
    "ironSource": [
      {
        "id": 0,
        "name": "Default",
        "status": "inactive"
      },
      {
        "id": 1193297,
        "name": "high",
        "status": "inactive",
        "pricing": [
          {
            "eCPM": "0.99",
            "Countries": [
              "IL"
            ]
          },
          {
            "eCPM": "2.03",
            "Countries": [
              "US"
            ]
          }
        ]
      }
    ],
    "AdColony": [
      {
        "id": 0,
        "name": "default",
        "status": "active"
      },
      {
        "id": 1193299,
        "name": "low",
        "status": "inactive"
      }
    ]
  },
  "interstitial": {
    "ironSource": [
      {
        "id": 0,
        "name": "Default",
        "status": "inactive"
      }
    ]
  },
  "banner": {
    "ironSource": [
      {
        "id": 0,
        "name": "Default",
        "status": "inactive"
      }
    ]
  }
}

Update Instances

Description

Use this API to update instance name, status and pricing for ironSource network and mediation ad sources (pricing is only available for ironSource network). Multiple instances can be updated with a single API call.

Notes:

  1. Max number of update calls is limited to 6 per day.
  2. In order to activate ironSource’s non default instances you must first activate ironSource’s default instance (instance ID=0).
  3. Updating instance pricing will replace all pricing values on that same instance only.
  4. To update mediation ad source instances please refer to this article for naming convention.

Authentication Type

Bearer API authentication

Method

PUT platform.ironsrc.com/partners/publisher/instances/v1?

Required Parameters

Name Type Description
appKey String  Application Key (as seen on our platform)
provider String array For ad source naming convention refer to this article
adUnit String array “rewardedVideo”, “interstitial”, “banner”
instanceId String ID generated by ironSource platform on instance creation


Optional Parameters

Name Type Description
name String the desired instance’s name
pricing String determine the eCPM to be delivered by ironSource network
status String instance status can be ‘active’ or ‘inactive’
provider instance level config* String for ad source instance level configs naming convention refer to this article
provider app level config* String for ad source app level configs naming convention refer to this article

 *Note: provider app and instance level configs naming varies between mediation ad sources. For naming convention go to this article.

Request Example URL

https://platform.ironsrc.com/partners/publisher/instances/v1?

Request Body Example

{
  "appKey": "8e084315",
  "configurations": {
    "ironsource": {
      "rewardedVideo": [
        {
          "instanceId": "0",
          "status": "active",
          "pricing": [
            {
              "eCPM": 6,
              "country": [
                "GB",
                "US"
              ]
            },
            {
              "eCPM": 2.03,
              "country": [
                "AD"
              ]
            }
          ]
        }
      ]
    },
    "facebook": {
      "appConfig": {
        "appID": "fk34sf",
        "userAccessToken": "ff34jk566"
      },
      "rewardedVideo": [
        {
          "instanceId": "0",
          "status": "active",
          "instanceName": "Default"
        }
      ]
    }
  }
}

JSON Response Example

{
  "rewardedVideo": {
    "ironSource": [
      {
        "id": 0,
        "name": "Default",
        "status": "active",
        "pricing": [
          {
            "eCPM": 6,
            "Countries": [
              "GB",
              "US"
            ]
          },
          {
            "eCPM": "2.03",
            "Countries": [
              "AD"
            ]
          }
        ]
      }
    ],
    "Facebook": [
      {
        "id": 0,
        "name": "Default",
        "status": "active"
      },
      {
        "id": 1251905,
        "name": "low",
        "status": "inactive"
      }
    ]
  },
  "interstitial": {
    "ironSource": [
      {
        "id": 0,
        "name": "Default",
        "status": "inactive"
      }
    ]
  },
  "banner": {
    "ironSource": [
      {
        "id": 0,
        "name": "Default",
        "status": "inactive"
      }
    ]
  }
}

Delete Instance

Description

Use this API to delete an instance.

General notes:

  1. Can delete one instance per call.
  2. Default instance cannot be deleted.
  3. Deleted instance cannot be restored.
  4. Response includes all of the app’s instances excluding the deleted ones.

Authentication Type

Bearer API authentication

Method

DELETE platform.ironsrc.com/partners/publisher/instances/v1?

Required Parameters

Name Type Description
appKey String application Key (as seen on our platform)
instanceId String ID generated by ironSource platform on instance creation

Request Example URL

http://platform.ironsrc.com/partners/publisher/instances/v1?appKey=6e9e4c11&instanceId=12345

JSON Response Example

{
  "rewardedVideo": {
    "ironSource": [
      {
        "id": 0,
        "name": "Default",
        "status": "active"
      },
      {
        "id": 45678,
        "name": "thirdRVInstance",
        "status": "inactive"
      }
    ]
  },
  "interstitial": {
    "ironSource": [
      {
        "id": 0,
        "name": "Default",
        "status": "active"
      },
      {
        "id": 23456,
        "name": "secondISInstance",
        "status": "active",
        "pricing": [
          {
            "eCPM": "0.01",
            "Countries": [
              "FR",
              "UK"
            ]
          }
        ]
      }
    ]
  },
  "banner": {
    "ironSource": [
      {
        "id": 0,
        "name": "Default",
        "status": "inactive"
      }
    ]
  }
}