Delete API key

View as Markdown
DELETE /users/auth/keys/{api_key_id}
Basic auth Api key

Delete or invalidate the API key.

Path parameters

  • api_key_id string Required

    The API Key ID.

Responses

  • 200 application/json

    The API key is deleted.
  • 404 application/json

    The {api_key_id} can't be found. (code: api_keys.key_not_found)

    Hide headers attribute Show headers attribute
    • x-cloud-error-codes string

      The error codes associated with the response

      Value is api_keys.key_not_found.

    Hide response attribute Show response attribute object
    • errors array[object] Required

      A list of errors that occurred in the failing request

      Hide errors attributes Show errors attributes object
      • code string Required

        A structured code representing the error type that occurred

      • message string Required

        A human readable message describing the error that occurred

      • fields array[string]

        If the error can be tied to a specific field or fields in the user request, this lists those fields
DELETE /users/auth/keys/{api_key_id} 
curl \
 --request DELETE 'https://{{hostname}}/api/v1/users/auth/keys/{api_key_id}' \
 --user "username:password"