Delete Agent Key

DELETE /v1/security/agent-keys/{uuid}

Delete one of your active account's agent keys, whichever member registered it. The next login with the key is refused. An agent already connected with it is not disconnected: its tunnel keeps flowing until the agent reconnects, as when an agent auth token is revoked.

To use the key again, register it again. Deleting a key adds an agent_key entry ("Agent key deleted") to the account audit log.

Preview. See Key authentication.

Requires the endpoints:write permission on the active account, as revoking an agent auth token does. Refused while the account is suspended.

Path parameters

uuid string (uuid) Req
The key's uuid. Get it from /security/agent-keys or the response of registering the key.

Response (204 No Content)

Empty body on success.

Errors

401 Unauthorized
Missing auth.
403 Forbidden
The caller lacks the endpoints:write permission in the active account, or the account is suspended (code account_suspended).
404 Not Found
There is no such key in your active account.
Request
curl -X DELETE "https://api.ngris.com/v1/security/agent-keys/01a16821-d490-7359-a935-39a84a87074a" \ -H "X-API-KEY: <your_api_key>"
Response — 204 No Content
Was this helpful?
On this page
Delete Agent Key
Was this helpful?