/api/v1/api-keys (POST)
POST
/api/v1/api-keys
const url = 'https://example.com/api/v1/api-keys';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"name":"example","permissions":["example"],"expiresAt":null}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/api/v1/api-keys \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "name": "example", "permissions": [ "example" ], "expiresAt": null }'Authorizations
Section titled “Authorizations”Request Bodyrequired
Section titled “Request Bodyrequired”object
name
required
string
permissions
required
Array<string>
expiresAt
string format: date-time
object
name
required
string
permissions
required
Array<string>
expiresAt
string format: date-time
object
name
required
string
permissions
required
Array<string>
expiresAt
string format: date-time
Responses
Section titled “Responses”Created
object
id
required
string format: uuid
name
required
string
keyPrefix
required
string
permissions
required
Array<string>
status
required
string
createdAt
required
string format: date-time
createdByUserId
required
string format: uuid
lastUsedAt
required
string format: date-time
expiresAt
required
string format: date-time
key
required
string
object
id
required
string format: uuid
name
required
string
keyPrefix
required
string
permissions
required
Array<string>
status
required
string
createdAt
required
string format: date-time
createdByUserId
required
string format: uuid
lastUsedAt
required
string format: date-time
expiresAt
required
string format: date-time
key
required
string
Example
{ "status": "Active"}object
id
required
string format: uuid
name
required
string
keyPrefix
required
string
permissions
required
Array<string>
status
required
string
createdAt
required
string format: date-time
createdByUserId
required
string format: uuid
lastUsedAt
required
string format: date-time
expiresAt
required
string format: date-time
key
required
string
Example
{ "status": "Active"}Bad Request
object
type
string
title
string
status
integer format: int32
detail
string
instance
string
object
type
string
title
string
status
integer format: int32
detail
string
instance
string
Example generated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}object
type
string
title
string
status
integer format: int32
detail
string
instance
string
Example generated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Forbidden
object
type
string
title
string
status
integer format: int32
detail
string
instance
string
object
type
string
title
string
status
integer format: int32
detail
string
instance
string
Example generated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}object
type
string
title
string
status
integer format: int32
detail
string
instance
string
Example generated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Conflict
object
type
string
title
string
status
integer format: int32
detail
string
instance
string
object
type
string
title
string
status
integer format: int32
detail
string
instance
string
Example generated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}object
type
string
title
string
status
integer format: int32
detail
string
instance
string
Example generated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}