List API keys on the current tenant

GET

/v1/api-keys

const url = 'https://api.aetherpush.com/v1/api-keys?include_revoked=false';
const options = {method: 'GET', 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 GET \
  --url 'https://api.aetherpush.com/v1/api-keys?include_revoked=false' \
  --header 'Authorization: Bearer <token>'

Returns all API keys belonging to the tenant. By default revoked keys are excluded; pass include_revoked=true to include them.

Field names use snake_case for historical reasons. Tracked for normalization in a future API version.

Authorizations

accessKeyAuth

Parameters

Query Parameters

include_revoked

boolean

Responses

200

List of API keys.

application/json

object

api_keys

required

Array<object>

API key metadata. Fields use snake_case for historical reasons — this will be normalized to camelCase in a future API version.

object

required

string format: uuid

name

required

string

>= 1 characters <= 100 characters

key_prefix

required

Public, non-sensitive prefix for visual identification of the key. Format: aether_sk_live_ followed by 9 base62 characters.

string

scopes

required

Array<string>

>= 1 items

Allowed values: deploy apps keys read

expires_at

required

Null means no expiration.

string | null format: date-time

revoked_at

required

string | null format: date-time

last_used_at

required

string | null format: date-time

created_at

required

string format: date-time

updated_at

required

string format: date-time

Example

{
  "api_keys": [
    {
      "name": "github-actions-ci",
      "key_prefix": "aether_sk_live_AbC123XyZ",
      "scopes": [
        "deploy",
        "read"
      ]
    }
  ]
}

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"
}