INinfobip
platform
account-management
api-keys

Update API key

This method allows you to update an API key. Only users with certain roles can create api keys; for example, Account Manager and Integrations Manager roles.

put/settings/2/api-keys/{apiKeyId}

Request

  • Base URL
    https://api.infobip.com (the document declares no server; this is the origin it was published from)
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://api.infobip.com/auth/1/oauth2/token
    • or API key in header Authorization
    • or HTTP basic

Path parameters

apiKeyIdstring required

Unique identifier of api key to be updated.

Request body

accountIdstring

Unique identifier for account this API key belongs to. If not provided accountId of the user making the API request will be set. CPaaSX Applications and Entities can be set only on api keys that belong to the account of the user making the request and only if that account is main account.

namestring

Name of this API Key.

allowedIPsstring[]

List of IP addresses or IP ranges from which this API key will be used. Authentication will fail from any other IP not specified in this list.

validFromstring date-time

Date from which this API key is/will be valid. Time is in UTC.

validTostring date-time

Date until this API key will be valid. Time is in UTC.

enabledboolean

Enable or disable API key.

permissionsstring[]

List of permissions this API key has granted. Default permission is 'PUBLIC_API'. API key cannot be created with both 'PUBLIC_API' and WEB_SDK permissions. API key cannot be updated with both permissions and a collection of Applications and/or Entities in <code>platform</code>. If an empty list is sent all current permissions assigned to api key will be removed and 'PUBLIC_API' will be set as default.

scopeGuidsstring[]

List of API scopes that will be assigned to the API key. An API key cannot be updated with both scopes and a collection of Applications and/or Entities in <code>platform</code>. If an empty list is sent, all current scopes assigned to the API Key will be removed and it will no longer be able to access any API endpoint.

Response

OK

idstring

Unique identifier specifying this api key.

apiKeySecretstring

Authentication key. Use this value for authentication on API. Keep this in secure storage and don't share it.

accountIdstring

Unique identifier for account this API key belongs to.

namestring required

Name of this API Key.

allowedIPsstring[]

List of allowed IP addresses from which this API key will be used. Authentication will fail from any other IP not specified in this list.

validFromstring date-time

Date from which this API key is/will be valid. Time is in UTC.

validTostring date-time

Date until this API key will be valid. Time is in UTC.

enabledboolean

Is API key enabled.

permissionsstring[]

List of permissions this API key has granted.

scopeGuidsstring[]

List of Scopes assigned to API Key

Changes

No recorded changes to this operation across all 1 revision of this API.