Revoke an API key

DELETE

/api-keys/{id}

const url = 'https://api.vaartix.com/api-keys/key_02qa6ntf6p3nd3ng';
const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request DELETE \
  --url https://api.vaartix.com/api-keys/key_02qa6ntf6p3nd3ng \
  --header 'Authorization: Bearer <token>'

The key stops working immediately.

Authorizations

apiKey

Parameters

Path Parameters

required

string

Example

key_02qa6ntf6p3nd3ng

Responses

204

Revoked.

401

unauthorized: the API key is missing, invalid or revoked.

application/json

object

error

required

object

type

required

Stable, machine-readable error type.

string

Allowed values: validation_error unauthorized forbidden not_found conflict rate_limited daily_quota_exceeded domain_not_verified invalid_from_address account_paused idempotency_conflict bad_request internal_error

message

required

Human-readable explanation, safe to show to developers.

string

Example

{
  "error": {
    "type": "validation_error"
  }
}

403

forbidden: the key cannot do this, for example a send-only key on a management endpoint.

application/json

object

error

required

object

type

required

Stable, machine-readable error type.

string

message

required

Human-readable explanation, safe to show to developers.

string

Example

{
  "error": {
    "type": "validation_error"
  }
}

404

not_found: no such resource in your team.

application/json

object

error

required

object

type

required

Stable, machine-readable error type.

string

message

required

Human-readable explanation, safe to show to developers.

string

Example

{
  "error": {
    "type": "validation_error"
  }
}