Get a single access key

GET

/v1/access-keys/{accessKeyName}

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

accessKeyAuth

Parameters

Path Parameters

accessKeyName

required

string

The friendlyName of the access key.

Responses

200

Access key metadata (raw name omitted).

application/json

object

accessKey

required

object

name

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.

string

friendlyName

Human-friendly identifier for the key.

string

<= 255 characters

description

Mirrors friendlyName. Kept for legacy clients.

string

createdBy

IP address that created the key.

string

createdTime

Unix timestamp in milliseconds.

integer format: int64

expires

required

Unix timestamp in milliseconds.

integer format: int64

isSession

True if the key was created by a login flow (vs. CLI/manual creation).

boolean

credentialOrigin

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.

string

Allowed values: dashboard_session cli_browser cli_device

deviceId

Stable identifier the CLI generates once per machine.

string

deviceName

Human-facing device label shown on the approval screen.

string

clientName

Client that requested the credential.

string

clientVersion

Client version at the time of authorization.

string

clientPlatform

Operating system and architecture reported by the client.

string

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

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 on this account.

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