keys

delete key

<h3>Administrator deletes the key.</h3> <p>This endpoint can also return metadata in the error response if sending an auth cert deletion management request fails. The metadata array contains the error details that were generated in core. The message is in plain English.</p> <p> Note that with this endpoint it's possible to delete an authentication key with a registered authentication certificate. <ul> <li>Attempt to delete an authentication key with a registered authentication certificate and with <code>ignore_warnings</code> = false causes the operation to fail with a warning in response's ErrorInfo object.</li> <li>Attempt to delete an authentication key with a registered authentication certificate and with <code>ignore_warnings</code> = true succeeds. The authentication certificate is first unregistered, and the key and certificate are deleted after that.</li> </ul> <p>When trying to delete an authentication key with a registered authentication certificate, the warning response has a warning code <code>auth_key_with_registered_cert_warning</code> and the metadata field contains the key id of the key</p> </p>
delete/keys/{id}

Request

  • Base URL: /api/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/keys/{id}
  • Auth: API key in header Authorization

Path parameters

idstring text required

id of the key

Query parameters

ignore_warningsboolean

if true, any ignorable warnings are ignored. if false (or missing), any warnings cause request to fail

Response

key deletion was successful

Changes

No recorded changes to this operation across all 50 revisions of this API.