API Key

Update API key

Updates the name and optionally the description of a specified API key. Include the ID of the API key in the path and the new name and optional description in the body of the request. To retrieve the ID of the API key call the List API Keys API.

put/api-key/{api_key_id}

Request

  • Base URL: https://infrahub-api.nexgencloud.com/v1
  • URL: https://infrahub-api.nexgencloud.com/v1/api-key/{api_key_id}
  • Auth: API key in header api_key

Path parameters

api_key_idinteger required

ID of the API key.

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.