Retrieve an API key

GET 
/auth/api_keys/:id

Retrieves the details of an existing API key.

Request

Path Parameters

id stringrequired

The id of the API Key

Query Parameters

include_permission_groups boolean

If false, only ids will be returned, otherwise the nested resources will be returned.

Responses

200: Successful response

application/json

• Schema
• Example (from schema)

Schema

data

object

id string

uuid.

description string

Human readable identifier.

secret string

Secret used to authenticate API Key.

backup_secret string

Secondary secret which may also be used to authenticate API Key.

status string

Status of the API Key.

permission_groups string[]

Array of ids of Permission Groups on the API Key.

admin boolean

True if the API Key has admin rights, false otherwise.

record_type string

Record type.

created_at string

Timestamp of resource creation.

updated_at string

Timestamp of last resource update.

{
  "data": {
    "id": "f30e7596-586e-44e1-ae7d-53db10f144d3",
    "description": "Tommy's Key",
    "secret": "XXXXXXXXXXXXX",
    "backup_secret": "XXXXXXXXXXXXX",
    "status": "active",
    "permission_groups": [
      "string"
    ],
    "admin": true,
    "record_type": "api_key",
    "created_at": "2018-02-08T18:49:22.998023Z",
    "updated_at": "2018-02-08T18:49:22.998023Z"
  }
}

401: Authentication error

application/json

• Schema
• Example (from schema)

Schema

errors

object[]

Array [

code string

an application-specific error code, expressed as a stringified integer.

title string

a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.

detail string

a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.

pointer string

JSON pointer to the field which is causing the error.

]

{
  "errors": [
    {
      "code": "10001",
      "title": "error title",
      "detail": "additional detail about the error",
      "pointer": "/pointer/to/field"
    }
  ]
}

403: Authorization error

application/json

• Schema
• Example (from schema)

Schema

errors

object[]

Array [

code string

an application-specific error code, expressed as a stringified integer.

title string

a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.

detail string

a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.

pointer string

JSON pointer to the field which is causing the error.

]

{
  "errors": [
    {
      "code": "10001",
      "title": "error title",
      "detail": "additional detail about the error",
      "pointer": "/pointer/to/field"
    }
  ]
}

404: Resource not found

application/json

• Schema
• Example (from schema)

Schema

errors

object[]

Array [

code string

an application-specific error code, expressed as a stringified integer.

title string

a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.

detail string

a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.

pointer string

JSON pointer to the field which is causing the error.

]

{
  "errors": [
    {
      "code": "10001",
      "title": "error title",
      "detail": "additional detail about the error",
      "pointer": "/pointer/to/field"
    }
  ]
}

Loading...