Skip to main content

Delete API Key

DELETE https://infrahub-api.nexgencloud.com/v1/api-key/{api_key_id}​

Delete a specified API key by including the ID of the API key in the path. To retrieve the ID of the API key call the List API Keys API.


Path parameters​

api_key_id integer   Required​

The unique identifier of the API key to be deleted.


Attributes​

status boolean​

Indicates the success or failure of the operation. true, indicates success, while false indicates error.

message string​

A message confirming the status of the request to delete the specified API key.


Example request
curl -X DELETE "https://infrahub-api.nexgencloud.com/v1/api-key/{api_key_id}" \
  -H "accept: application/json"\
  -H "api_key: YOUR API KEY"
Response
{
  "status": true,
  "message": "API Key deleted successfully"
}

Returns​

Returns the status of the request to delete an API key. A true status indicates successful deletion, otherwise an error has occurred.


Back to top​