API Key

Generate API key

Generates a new API key for use in authenticating API requests. Provide the API key name in the request body, plus an optional description. For details on how to pass the key in subsequent requests, see Authentication.

post/api-key/generate

Request

  • Base URL: https://infrahub-api.nexgencloud.com/v1
  • URL: https://infrahub-api.nexgencloud.com/v1/api-key/generate
  • Auth: none required

Request body

namestring required

Name of the API key. Maximum length: 50 characters.

descriptionstring

Optional description of the API key.

Response

Success

statusboolean

Whether the request succeeded.

messagestring

Human-readable description of the result.

Example response

{
  "message": "Maximum API key limit reached",
  "api_key": {
    "id": 3287,
    "name": "api-example-key",
    "key": "********-****-****-****-********be9a",
    "created_at": "2026-05-06T16:04:09Z"
  }
}

Changes

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