Skip to main content
POST
/
v1
/
regions
/
global
/
iam
/
apikeys
Create API key
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({name: '<string>', scopes: ['<string>'], expiresAt: '2023-11-07T05:31:56Z'})
};

fetch('https://api.example.com/v1/regions/global/iam/apikeys', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "success": true,
  "data": {
    "id": "<string>",
    "name": "<string>",
    "prefix": "<string>",
    "scopes": [
      "<string>"
    ],
    "expiresAt": "2023-11-07T05:31:56Z",
    "lastUsedAt": "2023-11-07T05:31:56Z",
    "createdAt": "2023-11-07T05:31:56Z",
    "key": "<string>"
  }
}

Body

application/json
name
string
required
scopes
string[]
required
expiresAt
string<date-time> | null

Response

201 - application/json

API key created

success
enum<boolean>
Available options:
true
data
object

API key for programmatic access