List the caller's API keys

GET

/v1/keys

const url = 'https://api.satellitedata.net/v1/keys';
const options = {method: 'GET', headers: {'X-API-Key': '<X-API-Key>'}};

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.satellitedata.net/v1/keys \
  --header 'X-API-Key: <X-API-Key>'

Lists the API keys of the calling account with id, label, the first eight characters of the secret, creation time, last use to the hour, expiry and status. Secrets are never returned after creation because only a peppered hash is stored. Never cached and never metered.

Authorizations

ApiKey
OAuth2
account
Session

Responses

200

Keys.

application/json

Key list.

object

keys

required

Keys, newest first.

Array<object>

API key metadata; the secret is never returned after creation.

object

required

Key id, safe to log.

string

name

required

Label chosen by the owner.

string

prefix

required

First 8 characters of the secret, shown so owners can tell keys apart.

string

scopes

Scopes: data for data routes, account for key management.

Array<string>

unique items

Allowed values: data account

created

required

Created.

string format: date-time

lastUsed

Last use, to the hour.

string | null format: date-time

expires

Expiry, or null.

string | null format: date-time

status

required

Status.

string

Allowed values: active revoked expired

max

required

Maximum active keys.

integer

Example

{
  "keys": [
    {
      "id": "key_7Hq2Lm9Xr4Tw",
      "name": "laptop",
      "prefix": "sdn_4kQ9",
      "scopes": [
        "data",
        "account"
      ],
      "created": "2026-09-02T14:12:40Z",
      "lastUsed": "2026-10-13T07:00:00Z",
      "expires": null,
      "status": "active"
    }
  ],
  "max": 2
}

Headers

X-Request-Id

string

Request id for support and logs.

Example

01JQ7Z3M8R5V2W6X9Y0A1B2C3D

401

The API key or bearer token is missing, unknown, revoked or expired.

application/problem+json

RFC 9457 problem details. Every 4xx and 5xx response uses this shape with media type application/problem+json. The type URL opens a documentation page that explains the cause and the fix.

object

type

required

URL of the documentation page for this problem type, stable for the life of /v1.

string format: uri

title

required

Short summary of the problem type. It does not change between occurrences.

string

status

required

HTTP status code, repeated for clients that lose the status line.

integer

>= 400 <= 599

detail

required

Explanation specific to this occurrence, written for a developer.

string

instance

Path of the request that failed.

string

code

Machine-readable problem code; equals the last path segment of type.

string

/^[a-z0-9-]+$/

requestId

Request id, also sent in X-Request-Id. Quote it in support requests.

string

errors

Field-level validation failures, present on 400 and 422.

Array<object>

One field-level failure.

object

pointer

required

JSON Pointer (RFC 6901) into the request body, or the query parameter name.

string

detail

required

What is wrong with that member.

string

retryAfter

Seconds until the request can succeed; equals the Retry-After header.

integer

limits

The limit that was hit and the value requested, for example maxWidth and requestedWidth.

object

key

additional properties

number

unitsEstimated

Units the request would have cost, computed before execution.

number

error

OAuth 2.0 error code (RFC 6749 section 5.2). Present only on /oauth/token responses.

string

Allowed values: invalid_request invalid_client invalid_grant unauthorized_client unsupported_grant_type invalid_scope

error_description

OAuth 2.0 error description. Present only on /oauth/token responses.

string

message

Copy of detail for openEO clients, which read message. Present only on /v1/openeo routes.

string

key

additional properties

any

Example

{
  "type": "https://docs.satellitedata.net/problems/invalid-key",
  "title": "Invalid or missing credentials",
  "status": 401,
  "detail": "Send a verified key in X-API-Key or a bearer token from /oauth/token.",
  "instance": "/v1/process",
  "code": "invalid-key",
  "requestId": "01JQ7Z3M8R5V2W6X9Y0A1B2C3D"
}

Headers

X-Request-Id

string

Request id for support and logs.

Example

01JQ7Z3M8R5V2W6X9Y0A1B2C3D

WWW-Authenticate

string

Challenge naming the accepted schemes.

Example

Bearer realm="satellitedata.net", ApiKey header="X-API-Key"

403

The credentials are valid but cannot use this route, for example before email verification or without the scope.

application/problem+json

RFC 9457 problem details. Every 4xx and 5xx response uses this shape with media type application/problem+json. The type URL opens a documentation page that explains the cause and the fix.

object

type

required

URL of the documentation page for this problem type, stable for the life of /v1.

string format: uri

title

required

Short summary of the problem type. It does not change between occurrences.

string

status

required

HTTP status code, repeated for clients that lose the status line.

integer

>= 400 <= 599

detail

required

Explanation specific to this occurrence, written for a developer.

string

instance

Path of the request that failed.

string

code

Machine-readable problem code; equals the last path segment of type.

string

/^[a-z0-9-]+$/

requestId

Request id, also sent in X-Request-Id. Quote it in support requests.

string

errors

Field-level validation failures, present on 400 and 422.

Array<object>

One field-level failure.

object

pointer

required

JSON Pointer (RFC 6901) into the request body, or the query parameter name.

string

detail

required

What is wrong with that member.

string

retryAfter

Seconds until the request can succeed; equals the Retry-After header.

integer

limits

The limit that was hit and the value requested, for example maxWidth and requestedWidth.

object

key

additional properties

number

unitsEstimated

Units the request would have cost, computed before execution.

number

error

OAuth 2.0 error code (RFC 6749 section 5.2). Present only on /oauth/token responses.

string

Allowed values: invalid_request invalid_client invalid_grant unauthorized_client unsupported_grant_type invalid_scope

error_description

OAuth 2.0 error description. Present only on /oauth/token responses.

string

message

Copy of detail for openEO clients, which read message. Present only on /v1/openeo routes.

string

key

additional properties

any

Example

{
  "type": "https://docs.satellitedata.net/problems/email-unverified",
  "title": "Email not verified",
  "status": 403,
  "detail": "Keys work only after the account email is verified. Check your inbox or resend from the dashboard.",
  "instance": "/v1/process",
  "code": "email-unverified",
  "requestId": "01JQ7Z3M8R5V2W6X9Y0A1B2C3D"
}

Headers

X-Request-Id

string

Request id for support and logs.

Example

01JQ7Z3M8R5V2W6X9Y0A1B2C3D

429

A per-minute, concurrency, monthly or per-IP limit was hit. Retry-After says when to retry.

application/problem+json

RFC 9457 problem details. Every 4xx and 5xx response uses this shape with media type application/problem+json. The type URL opens a documentation page that explains the cause and the fix.

object

type

required

URL of the documentation page for this problem type, stable for the life of /v1.

string format: uri

title

required

Short summary of the problem type. It does not change between occurrences.

string

status

required

HTTP status code, repeated for clients that lose the status line.

integer

>= 400 <= 599

detail

required

Explanation specific to this occurrence, written for a developer.

string

instance

Path of the request that failed.

string

code

Machine-readable problem code; equals the last path segment of type.

string

/^[a-z0-9-]+$/

requestId

Request id, also sent in X-Request-Id. Quote it in support requests.

string

errors

Field-level validation failures, present on 400 and 422.

Array<object>

One field-level failure.

object

pointer

required

JSON Pointer (RFC 6901) into the request body, or the query parameter name.

string

detail

required

What is wrong with that member.

string

retryAfter

Seconds until the request can succeed; equals the Retry-After header.

integer

limits

The limit that was hit and the value requested, for example maxWidth and requestedWidth.

object

key

additional properties

number

unitsEstimated

Units the request would have cost, computed before execution.

number

error

OAuth 2.0 error code (RFC 6749 section 5.2). Present only on /oauth/token responses.

string

Allowed values: invalid_request invalid_client invalid_grant unauthorized_client unsupported_grant_type invalid_scope

error_description

OAuth 2.0 error description. Present only on /oauth/token responses.

string

message

Copy of detail for openEO clients, which read message. Present only on /v1/openeo routes.

string

key

additional properties

any

Example

{
  "type": "https://docs.satellitedata.net/problems/rate-limited",
  "title": "Rate limit exceeded",
  "status": 429,
  "detail": "This key spent 300 of its 300 units in the current minute.",
  "instance": "/v1/process",
  "code": "rate-limited",
  "requestId": "01JQ7Z3M8R5V2W6X9Y0A1B2C3D",
  "retryAfter": 17,
  "limits": {
    "unitsPerMinute": 300,
    "unitsSpentThisMinute": 300
  }
}

Headers

X-Request-Id

string

Request id for support and logs.

Example

01JQ7Z3M8R5V2W6X9Y0A1B2C3D

Retry-After

integer

Seconds to wait before retrying.

Example

RateLimit

string

Remaining units and seconds to reset in the current window (IETF RateLimit header draft).

Example

"units";r=287;t=41

RateLimit-Policy

string

Quota policy of the caller (IETF RateLimit header draft).

Example

"units";q=300;w=60

500

An unexpected server error. No units are charged.

application/problem+json

RFC 9457 problem details. Every 4xx and 5xx response uses this shape with media type application/problem+json. The type URL opens a documentation page that explains the cause and the fix.

object

type

required

URL of the documentation page for this problem type, stable for the life of /v1.

string format: uri

title

required

Short summary of the problem type. It does not change between occurrences.

string

status

required

HTTP status code, repeated for clients that lose the status line.

integer

>= 400 <= 599

detail

required

Explanation specific to this occurrence, written for a developer.

string

instance

Path of the request that failed.

string

code

Machine-readable problem code; equals the last path segment of type.

string

/^[a-z0-9-]+$/

requestId

Request id, also sent in X-Request-Id. Quote it in support requests.

string

errors

Field-level validation failures, present on 400 and 422.

Array<object>

One field-level failure.

object

pointer

required

JSON Pointer (RFC 6901) into the request body, or the query parameter name.

string

detail

required

What is wrong with that member.

string

retryAfter

Seconds until the request can succeed; equals the Retry-After header.

integer

limits

The limit that was hit and the value requested, for example maxWidth and requestedWidth.

object

key

additional properties

number

unitsEstimated

Units the request would have cost, computed before execution.

number

error

OAuth 2.0 error code (RFC 6749 section 5.2). Present only on /oauth/token responses.

string

Allowed values: invalid_request invalid_client invalid_grant unauthorized_client unsupported_grant_type invalid_scope

error_description

OAuth 2.0 error description. Present only on /oauth/token responses.

string

message

Copy of detail for openEO clients, which read message. Present only on /v1/openeo routes.

string

key

additional properties

any

Example

{
  "type": "https://docs.satellitedata.net/problems/internal",
  "title": "Internal error",
  "status": 500,
  "detail": "The request failed on our side and was logged. No units were charged.",
  "instance": "/v1/process",
  "code": "internal",
  "requestId": "01JQ7Z3M8R5V2W6X9Y0A1B2C3D"
}

Headers

X-Request-Id

string

Request id for support and logs.

Example

01JQ7Z3M8R5V2W6X9Y0A1B2C3D