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

Error

Standard error envelope. code is the stable machine identifier for client branching and i18n. The wording of error is a human-readable fallback and is not part of the contract. Specialized responses keep narrower code enums where clients already branch on them.

object

error

required

Human-readable error message.

string

code

required

Stable machine code. Prefer this over matching on error. The values this API can answer with are listed in the ApiErrorCode schema of the raw document at https://api.aetherpush.com/openapi.yaml. The field stays an open string here so that a release adding a value does not invalidate this response.

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.",
  "code": "not_found",
  "requestId": "req_abc123"
}

403

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

application/json

Error

object

error

required

Human-readable error message.

string

code

required

string

requestId

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

string

Example

{
  "error": "This operation requires a login session. API keys and named access keys cannot access it.",
  "code": "session_required",
  "requestId": "req_abc123"
}

429

The tenant’s per-minute management API budget is spent. Retry-After and X-RateLimit-* say when to retry. This is not a plan quota: quota 429s use the Error envelope and do not set Retry-After.

application/json

RateLimitError

Returned with HTTP 429 when an endpoint-specific rate limit is hit, including the per-tenant management API budget. Not the process-wide address limiter (see GlobalAddressRateLimitErrorResponse). retryAfterSeconds indicates how long the client should wait before retrying, and matches the Retry-After header when that header is set. code names the limit that fired so clients can translate without matching on error.

object

error

required

string

code

required

string

retryAfterSeconds

required

integer

>= 1

requestId

string

Example

{
  "error": "Rate limit exceeded",
  "code": "tenant_rate_limit_exceeded",
  "retryAfterSeconds": 60
}

Headers

Retry-After

integer

>= 1

Seconds until the tenant window resets.