Sign in
API-keys

Get an API-key

Get an API-key using ID.

get/v2/control-planes/{controlPlaneId}/core-entities/key-auths/{KeyAuthId}

Response

Successfully fetched API-key

created_atinteger nullable

Unix epoch when the resource was created.

idstring nullable

A string representing a UUID (universally unique identifier).

keystring nullable
tagsstring[] nullable

A set of strings representing tags.

ttlinteger nullable

key-auth ttl in seconds

Example response

{
  "consumer": {
    "id": "84a73fb8-50fc-44a7-a4d5-aa17728ee83f"
  },
  "id": "b2f34145-0343-41a4-9602-4c69dec2f269",
  "key": "IL1deIyHyQA40WpeLeA1bIUXuvTwlGjo"
}

Changes

Changed in 2 of the 75 revisions of this API.3

  • 76b0fefddb0d1See the full diff
    • ▲

      the response property became nullable for the status

      response-property-became-nullable

  • 2a7df3ca52c82See the full diff
    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became optional for the status

      response-property-became-optional