AccountAPIKey

Account API key management

List all API keys

get
Authorizations
PRIVATE-TOKENstringRequired
Header parameters
RANGED-DATAstringOptional

Example header and default range: RANGED-DATA:start=0,results=25

Responses
chevron-right
200

OK

application/json
idinteger · integerRead-onlyRequired

API key ID

categoryinteger · integerRequired

API key access category

keystringRead-onlyRequired

API key

notestring · nullableOptional

API key note

assignOdpServerIpsinteger · integerRequired

Whether or not to assign ODP server IPs

usedinteger · integerRead-onlyRequired

Number of times that the API key was used

expiresAtinteger · integer · nullableOptional

API key expiration time as UNIX timestamp

get
/v3/account/apiKey

Generate API key

post
Authorizations
PRIVATE-TOKENstringRequired
Body
idinteger · integerRead-onlyRequired

API key ID

categoryinteger · integerRequired

API key access category

keystringRead-onlyRequired

API key

notestring · nullableOptional

API key note

assignOdpServerIpsinteger · integerRequired

Whether or not to assign ODP server IPs

usedinteger · integerRead-onlyRequired

Number of times that the API key was used

expiresAtinteger · integer · nullableOptional

API key expiration time as UNIX timestamp

Responses
chevron-right
200

OK

application/json
idinteger · integerRead-onlyRequired

API key ID

categoryinteger · integerRequired

API key access category

keystringRead-onlyRequired

API key

notestring · nullableOptional

API key note

assignOdpServerIpsinteger · integerRequired

Whether or not to assign ODP server IPs

usedinteger · integerRead-onlyRequired

Number of times that the API key was used

expiresAtinteger · integer · nullableOptional

API key expiration time as UNIX timestamp

post
/v3/account/apiKey

Update API key

put
Authorizations
PRIVATE-TOKENstringRequired
Path parameters
apiKeyIdintegerRequired

ID of API key to update

Body
idinteger · integerRead-onlyRequired

API key ID

categoryinteger · integerRequired

API key access category

keystringRead-onlyRequired

API key

notestring · nullableOptional

API key note

assignOdpServerIpsinteger · integerRequired

Whether or not to assign ODP server IPs

usedinteger · integerRead-onlyRequired

Number of times that the API key was used

expiresAtinteger · integer · nullableOptional

API key expiration time as UNIX timestamp

Responses
chevron-right
200

OK

application/json
idinteger · integerRead-onlyRequired

API key ID

categoryinteger · integerRequired

API key access category

keystringRead-onlyRequired

API key

notestring · nullableOptional

API key note

assignOdpServerIpsinteger · integerRequired

Whether or not to assign ODP server IPs

usedinteger · integerRead-onlyRequired

Number of times that the API key was used

expiresAtinteger · integer · nullableOptional

API key expiration time as UNIX timestamp

put
/v3/account/apiKey/{apiKeyId}

Delete API key

delete
Authorizations
PRIVATE-TOKENstringRequired
Path parameters
apiKeyIdintegerRequired

ID of API key to delete

Responses
delete
/v3/account/apiKey/{apiKeyId}

No content

Last updated

Was this helpful?