Revoke an access key

DELETE

/v1/access-keys/{accessKeyName}

const url = 'https://api.aetherpush.com/v1/access-keys/example';
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.aetherpush.com/v1/access-keys/example \
  --header 'Authorization: Bearer <token>'

Permanently revokes the access key. Cannot be undone.

Authorizations

accessKeyAuth

Parameters

Path Parameters

accessKeyName

required

string

The friendlyName of the access key.

Responses

204

Access key revoked.

401

Unauthenticated.

application/json

object

error

required

Human-readable error message.

string

requestId

Unique identifier for the request, also exposed as the X-Request-Id response header.

string

Example

{
  "error": "The requested resource was not found.",
  "requestId": "req_abc123"
}

403

API keys and named access keys cannot access this endpoint; a login session is required.

application/json

object

error

required

Human-readable error message.

string

requestId

Unique identifier for the request, also exposed as the X-Request-Id response header.

string

Example

{
  "error": "The requested resource was not found.",
  "requestId": "req_abc123"
}

404

No access key with that friendlyName exists.

application/json

object

error

required

Human-readable error message.

string

requestId

Unique identifier for the request, also exposed as the X-Request-Id response header.

string

Example

{
  "error": "The requested resource was not found.",
  "requestId": "req_abc123"
}