API-keys

Get an API-key

Changed on

Get an API-key using ID.

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

Request

  • Base URL: https://global.api.konghq.com
  • URL: https://global.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/key-auths/{KeyAuthId}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

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

  • 76b0fefddb0dRevision changes
    • breaking

      the response property became nullable for the status

  • 2a7df3ca52c8Revision changes
    • breaking

      the response property became nullable for the status

    • breaking

      the response property became optional for the status