Get a single access key
const url = 'https://api.aetherpush.com/v1/access-keys/example';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/access-keys/example \ --header 'Authorization: Bearer <token>'Returns the metadata for a specific access key by its
friendlyName. The raw key value is omitted from the response.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The friendlyName of the access key.
Responses
Section titled “Responses”Access key metadata (raw name omitted).
object
object
The raw key string. Only returned in full on POST /v1/access-keys
(creation). On GET /v1/access-keys it is masked as (hidden).
On GET /v1/access-keys/{name} it is omitted entirely.
Human-friendly identifier for the key.
Mirrors friendlyName. Kept for legacy clients.
IP address that created the key.
Unix timestamp in milliseconds.
Unix timestamp in milliseconds.
True if the key was created by a login flow (vs. CLI/manual creation).
How the credential was created. Absent on credentials that predate
CLI browser login. cli_browser and cli_device credentials are
the ones listed and revoked through /v1/cli/devices.
Stable identifier the CLI generates once per machine.
Human-facing device label shown on the approval screen.
Client that requested the credential.
Client version at the time of authorization.
Operating system and architecture reported by the client.
Example
{ "accessKey": { "name": "abc123-base64url-secret", "friendlyName": "my-laptop", "description": "my-laptop", "createdBy": "203.0.113.42", "createdTime": 1714867200000, "expires": 1719964800000, "isSession": true, "credentialOrigin": "dashboard_session", "deviceId": "0f8c2a1e-9f1a-4b2c-8d3e-5a6b7c8d9e0f", "deviceName": "Adrian's MacBook Pro", "clientName": "aether-cli", "clientVersion": "0.5.0", "clientPlatform": "darwin-arm64" }}Unauthenticated.
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
Human-readable error message.
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.
Unique identifier for the request, also exposed as the X-Request-Id response header.
Example
{ "error": "The requested resource was not found.", "code": "not_found", "requestId": "req_abc123"}API keys and named access keys cannot access this endpoint; a login session is required.
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
Human-readable error message.
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.
Unique identifier for the request, also exposed as the X-Request-Id response header.
Example
{ "error": "This operation requires a login session. API keys and named access keys cannot access it.", "code": "session_required", "requestId": "req_abc123"}No access key with that friendlyName exists on this account.
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
Human-readable error message.
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.
Unique identifier for the request, also exposed as the X-Request-Id response header.
Example
{ "error": "The requested resource was not found.", "code": "not_found", "requestId": "req_abc123"}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.
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
Example
{ "error": "Rate limit exceeded", "code": "tenant_rate_limit_exceeded", "retryAfterSeconds": 60}Headers
Section titled “Headers”Seconds until the tenant window resets.