Revoke an API key

DELETE

/v1/api-keys/{id}

const url = 'https://api.fromenance.com/v1/api-keys/key_01J8Z9X0Q3K4M5N6P7R8S9T0V1';
const options = {
  method: 'DELETE',
  headers: {cookie: 'fromenance.session_token=<fromenance.session_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.fromenance.com/v1/api-keys/key_01J8Z9X0Q3K4M5N6P7R8S9T0V1 \
  --cookie fromenance.session_token=<fromenance.session_token>

Authorizations

Session
ApiKey

Parameters

Path Parameters

required

string

/^key_[0-9A-Z]{26}$/

Example

key_01J8Z9X0Q3K4M5N6P7R8S9T0V1

Responses

200

Revoked

application/json

object

required

string

name

required

string

prefix

required

string

mode

required

string

Allowed values: live test

scopes

required

Array<string>

Allowed values: register read admin

last_used_at

required

string | null

revoked_at

required

string | null

created_at

required

string

Example

{
  "mode": "live",
  "scopes": [
    "register"
  ]
}