INinfobip
platform
account-management
api-keys

Create API key

This method allows you to create an API key.

post/settings/1/accounts/{accountKey}/api-keys

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

accountKeystring required

Key of the main account the API key belongs to. Use the special _ value to reference the account of the user making the API request or a standard account key such as 8F0792F86035A9F4290821F1EE6BC06A to reference an account explicitly.

Request body

namestring required

Name of the 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.

validTostring date-time

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

validFromstring date-time

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

enabledboolean

Only enabled API keys will be accepted. When revoking existing API key, this property can be set to false.

permissionsBb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7Permission[]

List of permissions this API key has granted. Default permission is 'ALL'. This data may be inaccurate. Migrate to new API key management endpoints and use API scopes for fine grained control.

Response

Created

keystring

Unique key specifying this api key.

publicApiKeystring

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

accountKeystring

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.

permissionsBb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7Permission[]

List of permissions this API key has granted.

Changes

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