Keys

Delete a key.

Changed on

Deleting a key will remove it permanently from the system, however analytics relating to that key will still be available.

delete/tyk/keys/{keyID}

Request

  • Base URL
    https://localhost:8080
  • URL
    https://localhost:8080/tyk/keys/{keyID}
  • Auth
    API key in header X-Tyk-Authorization

Path parameters

keyIDstring required

The key ID.

Query parameters

hashedboolean

Use the hash of the key as input instead of the full key.

Response

Key deleted.

actionstring
keystring
key_hashstring
statusstring

Example response

{
  "action": "modified",
  "key": "b13d928b9972bd18",
  "status": "ok"
}

Changes

  • 59da626fc82dRevision changes
    • breaking

      removed the enum value false from the query request parameter hashed

    • breaking

      removed the enum value true from the query request parameter hashed

  • 111affa17abeRevision changes
    • breaking

      added the new path request parameter keyID

    • warning

      removed the optional property from the response with the status

    • info

      added the new optional query request parameter hashed

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status