Delete key with API ID and key ID.

curl --request DELETE \
  --url https://{tenant}/api/apis/{apiID}/keys/{keyID} \
  --header 'Authorization: Bearer <token>'

{
  "Message": "Key deleted successfully.",
  "Meta": null,
  "Status": "OK"
}

DELETE

api

apis

{apiID}

keys

{keyID}

Delete key with API ID and key ID.

curl --request DELETE \
  --url https://{tenant}/api/apis/{apiID}/keys/{keyID} \
  --header 'Authorization: Bearer <token>'

{
  "Message": "Key deleted successfully.",
  "Meta": null,
  "Status": "OK"
}

Authorizations

Authorization

string

header

required

The Tyk Dashboard API Access Credentials

Path Parameters

apiID

string

required

ID of API the keys grant access to. Can either be the internal or external API ID.

keyID

string

required

The key ID

Query Parameters

auto_guess

enum<boolean>

default:false

If you are not sure if a key is hashed you can send this as true.

Available options:

true,

false

hashed

string

Use the hash of the key as input instead of the full key. Any none empty string will be interpreted as to say you want to use hash input.

username

enum<boolean>

Set to true if the passed key is a username.

Available options:

true,

false

Response

Key deleted.

string

Message

string

Overview

Getting Started

Deploy Tyk

Managing APIs

Security in Tyk

Reference

Developer Support

Delete key with API ID and key ID.

Authorizations

Path Parameters

Query Parameters

Response