Create a new API key for a specified user.

POST

https://demo.azuracast.com/api/admin/api-keys

curl -X POST 'https://demo.azuracast.com/api/admin/api-keys' \
  -H 'X-API-Key: YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "user": 0,
  "comment": "Admin-generated API key"
}'

const body = `{
  "user": 0,
  "comment": "Admin-generated API key"
}`;

const response = await fetch('https://demo.azuracast.com/api/admin/api-keys', {
  method: 'POST',
  headers: {
    'X-API-Key': 'YOUR_TOKEN',
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();

import requests

body = '''{
  "user": 0,
  "comment": "Admin-generated API key"
}'''

response = requests.post(
    'https://demo.azuracast.com/api/admin/api-keys',
    data=body.encode('utf-8'),
    headers={
        'X-API-Key': 'YOUR_TOKEN',
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

{
  "user": 0,
  "comment": "Admin-generated API key"
}

{
  "key": "string",
  "id": "string",
  "verifier": "string",
  "user": {
    "id": 0,
    "email": "demo@azuracast.com",
    "auth_password": "",
    "name": "Demo Account",
    "locale": "en_US",
    "show_24_hour_time": true,
    "two_factor_secret": "A1B2C3D4",
    "created_at": 1609480800,
    "updated_at": 1609480800,
    "roles": []
  },
  "comment": "string",
  "links": {}
}

{
  "code": 500,
  "type": "NotLoggedInException",
  "message": "Error description.",
  "formatted_message": "<b>Error description.</b><br>Detailed error text.",
  "extra_data": [],
  "success": false
}

{
  "code": 500,
  "type": "NotLoggedInException",
  "message": "Error description.",
  "formatted_message": "<b>Error description.</b><br>Detailed error text.",
  "extra_data": [],
  "success": false
}

Body

application/json

userinteger | stringrequired

User ID or e-mail address.

Show child attributes

Any of

integer<int64>

string

commentstring

Example

Admin-generated API key

Response

200OKApi_Account_NewApiKey & HasSplitTokenFields & object & HasLinks

Success

Response fields application/json

keystringrequiredread only

The newly generated API key.

idstringread only

verifierstringread only

userHasAutoIncrementId & object

Show child attributes

idintegerrequiredread only

emailstring

Example

demo@azuracast.com

auth_passwordstring

Example

namestring | null

Example

Demo Account

localestring | null

Example

en_US

show_24_hour_timeboolean | null

Example

true

two_factor_secretstring | null

Example

A1B2C3D4

created_atinteger

Example

1609480800

updated_atinteger

Example

1609480800

rolesArray<any>

commentstring

linksobjectread only

Show child attributes

[key: string]string

403ForbiddenApi_Error

Access denied.

Response fields application/json

codeintegerrequired

The numeric code of the error.

Example

typestringrequired

The programmatic class of error.

Example

NotLoggedInException

messagestringrequired

The text description of the error.

Example

Error description.

formatted_messagestring | nullrequired

The HTML-formatted text description of the error.

Example

<b>Error description.</b><br>Detailed error text.

extra_dataArray<any>required

Stack traces and other supplemental data.

successbooleanrequired

Used for API calls that expect an \Entity\Api\Status type response.

Example

false

500Internal Server ErrorApi_Error

A generic exception has occurred.

Response fields application/json

codeintegerrequired

The numeric code of the error.

Example

typestringrequired

The programmatic class of error.

Example

NotLoggedInException

messagestringrequired

The text description of the error.

Example

Error description.

formatted_messagestring | nullrequired

The HTML-formatted text description of the error.

Example

<b>Error description.</b><br>Detailed error text.

extra_dataArray<any>required

Stack traces and other supplemental data.

successbooleanrequired

Used for API calls that expect an \Entity\Api\Status type response.

Example

false

Authorization

ApiKeyapiKey in header

Docs by Sourcey