View an API key

View a single API key.

get
/users/{userid}/api_keys/{id}

https://console.automox.com/api/users/{userid}/api_keys/{id}
Note: The response does not contain the encrypted portion of the key (see Decrypt an API key).
Request
Response
Request
Path Parameters
userid
required
integer
The ID of the user to view keys 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 view.
Response
200: OK
This response does not contain 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"
},
}
}
}
}
‚Äč