Skip to main content

List API Keys

GET https://infrahub-api.nexgencloud.com/v1/api-key​

Retrieves a list of your API keys that can be used to authenticate Infrahub API requests.


Parameters​

No parameters.


Attributes​

status boolean​

The status of the request to retrieve your API key, true indicates success, while false indicates error.

message string​

A message describing the status of the request to retrieve your API key.

api_key object​

Returns the api_keys array of objects, each containing details about your API keys.

For descriptions of the fields within the api_keys objects returned in response to your request, please refer to the documentation here.


Example request
curl -X GET "https://infrahub-api.nexgencloud.com/v1/api-key" \
  -H "accept: application/json"\
  -H "api_key: YOUR API KEY"
Response
{
  "status": true,
  "message": "Getting API Keys success",
  "api_keys": [
    {
      "created_at": "2024-06-14T13:29:50",
      "key": "********-****-****-****-********11bb",
      "description": "This is an example API key.",
      "id": 58,
      "name": "example-api-key"
    }
  ]
}

Returns​

Returns the status of the request to retrieve your API keys, where true indicates success. The api_keys object includes the key field with your active API key which is obfuscated, this value can be used to authenticate Infrahub API requests. For descriptions of the fields within the api_keys object, please refer to the documentation here.


Back to top​