Create an API key

Returns a list of API keys for the given user under the requested organization.

post
/users/{userid}/api_keys

https://console.automox.com/api/users/{userid}/api_keys
Note: A user is only allowed to have a maximum of 10 active keys per organization at any given time.
Request
Response
Request
Path Parameters
userid
required
integer
The ID of the user you want to create a key for.
Headers
Authorization: Bearer
required
string
Your Automox API key for authentication Format: Authorization: Bearer your_automox_api_key
Content-Type: application/json
optional
string
Specify json as the content type
Query Parameters
o
required
integer
The Organization whose keys you want to create.
Body Parameters
name
required
string
A unique name for this key. Users are not allowed to have two keys with the same name under a given organization.
expires_at
optional
string
The time at which (in UTC) the key should automatically expire. Format is ISO8601. Example: 2020-08-05T18:21:47+0000
Response
200: OK
This response does not include the encrypted portion of the key.
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
},
"name": {
"type": "string"
},
"is_enabled": {
"type": "boolean"
},
"expires_at": {
"type": "string",
"format": "date-time"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"user": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
},
"firstname": {
"type": "string"
},
"lastname": {
"type": "string"
},
"email": {
"type": "string"
},
}
}
}
}
400: Bad Request
{
"errors": {
"field": [
"Error message for field."
]
}
}