Revoke an API key

DELETE

/api-keys/{api_key_id}

Code sample: Shell / cURL

curl --request DELETE \
  --url https://api.grepvine.ai/v1/api-keys/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --cookie __Host-grepvine-session=<__Host-grepvine-session>

Authorizations

• cookieAuth
• apiKeyAuth

Parameters

Path Parameters

api_key_id

required

string format: uuid

Header Parameters

X-Csrf-Token

string

>= 16 characters <= 256 characters

Required for a state change that uses cookie authentication.

Responses

204

The API key was revoked.

404

The resource does not exist or is not visible.

Media typeapplication/json

object

code

required

string

reason

required

string

error

required

string

Example ^generated

{
  "code": "example",
  "reason": "example",
  "error": "example"
}

Headers

X-Request-Id

string

The request identifier used for support and audit correlation.

default

The request failed. A 429 carries Retry-After; the index is busy absorbing recent writes or is out of request capacity, and clients must slow down and retry after the interval. A 403 with code organization_suspended refuses every operation on a suspended organization’s members, indexes, documents and searches; reading the organization itself still answers and reports suspended, and the client should contact support.

Media typeapplication/json

object

code

required

string

reason

required

string

error

required

string

Example ^generated

{
  "code": "example",
  "reason": "example",
  "error": "example"
}

Headers

X-Request-Id

string

The request identifier used for support and audit correlation.

Retry-After

integer

Seconds to wait before retrying. Sent with every 429 so a client slows down instead of failing.