Sign in
API keys

Read an API key

Reads an API key by ID.

get/api_key/{id}

Path parameters

idinteger required

The unique identifier for the API key.

Response

The operation was successful.

idinteger required

Unique ID for the API key.

namestring required

The descriptive name given to the API key.

masked_api_keystring nullable

Your masked API key.

owner_idinteger

The unique ID of the user that creates the API key.

last_used_atstring date-time nullable

The ISO-8601 UTC timestamp of when the API key was last used.

created_atstring date-time required

The ISO-8601 UTC timestamp of when the API key was created.

updated_atstring date-time nullable required

The ISO-8601 UTC timestamp of when the API key was last updated.

Example response

{
  "id": 1234,
  "name": "CI/CD Main",
  "masked_api_key": "AAAA.xxxxxxxxxxxxxxxxxxxxxPTs=",
  "tags": [
    {
      "key": "CI",
      "value": "main"
    }
  ],
  "grants": [
    {
      "nrn": "organization=1:account=1:namespace=1:application=4",
      "role_id": 1855672260,
      "role_slug": "machine:ci"
    }
  ],
  "owner_id": 1595,
  "last_used_at": "2021-01-02T00:00:00Z",
  "created_at": "2021-01-02T00:00:00Z",
  "updated_at": "2021-01-02T00:00:00Z"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.