Check connectivity and authentication

GET

/ping

const url = 'https://api.sealpost.app/v1/ping';
const options = {
  method: 'GET',
  headers: {'Sign-Test-Mode': 'true', 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.sealpost.app/v1/ping \
  --header 'Authorization: Bearer <token>' \
  --header 'Sign-Test-Mode: true'

Authorizations

ApiKey

Parameters

Header Parameters

Sign-Test-Mode

string

Allowed values: true

true switches a live key into test mode for this request only. Ignored on test keys (they are always in test mode). Any other value is treated as absent.

Responses

200

The key is valid.

application/json

object

required

boolean

request_id

required

string

test_mode

required

Effective mode of this request.

boolean

Example

{
  "ok": true
}

Headers

Sign-Request-Id

string

Unique id of this request (req_…). Quote it in support requests.

401

No key, an unknown key, or a revoked or expired key.

application/problem+json

RFC 9457 problem details plus a stable code and the request_id.

object

type

required

https://sealpost.app/errors/{code}

string format: uri

title

required

string

status

required

integer

detail

Human-readable, safe to show to a developer, never contains secrets or signer data.

string

instance

The request path.

string

code

required

Stable machine-readable code from the catalogue (docs/errors.md).

string

request_id

required

string

errors

Field-level detail on validation_failed.

Array<object>

object

param

required

JSON pointer-ish path, e.g. scopes[2].

string

message

required

string

Example

{
  "type": "https://sealpost.app/errors/insufficient_scope",
  "title": "Forbidden",
  "status": 403,
  "detail": "This key lacks the api_keys:write scope.",
  "code": "insufficient_scope",
  "request_id": "req_01J9ZK3V8Q4M2XQ7W0E5D1R6TA"
}

Headers

Sign-Request-Id

string

Unique id of this request (req_…). Quote it in support requests.

429

The key is over its per-minute budget (600 live, 60 test, sliding window).

application/problem+json

RFC 9457 problem details plus a stable code and the request_id.

object

type

required

https://sealpost.app/errors/{code}

string format: uri

title

required

string

status

required

integer

detail

Human-readable, safe to show to a developer, never contains secrets or signer data.

string

instance

The request path.

string

code

required

Stable machine-readable code from the catalogue (docs/errors.md).

string

request_id

required

string

errors

Field-level detail on validation_failed.

Array<object>

object

param

required

JSON pointer-ish path, e.g. scopes[2].

string

message

required

string

Example

{
  "type": "https://sealpost.app/errors/insufficient_scope",
  "title": "Forbidden",
  "status": 403,
  "detail": "This key lacks the api_keys:write scope.",
  "code": "insufficient_scope",
  "request_id": "req_01J9ZK3V8Q4M2XQ7W0E5D1R6TA"
}

Headers

Sign-Request-Id

string

Unique id of this request (req_…). Quote it in support requests.

Retry-After

integer

Seconds to wait before retrying.

RateLimit-Limit

integer

Requests allowed per minute for this key (600 live, 60 test).

RateLimit-Remaining

integer

Requests remaining in the current window.

RateLimit-Reset

integer

Seconds until the window has capacity again.

500

Something failed on our side. The request_id is in our logs.

application/problem+json

RFC 9457 problem details plus a stable code and the request_id.

object

type

required

https://sealpost.app/errors/{code}

string format: uri

title

required

string

status

required

integer

detail

Human-readable, safe to show to a developer, never contains secrets or signer data.

string

instance

The request path.

string

code

required

Stable machine-readable code from the catalogue (docs/errors.md).

string

request_id

required

string

errors

Field-level detail on validation_failed.

Array<object>

object

param

required

JSON pointer-ish path, e.g. scopes[2].

string

message

required

string

Example

{
  "type": "https://sealpost.app/errors/insufficient_scope",
  "title": "Forbidden",
  "status": 403,
  "detail": "This key lacks the api_keys:write scope.",
  "code": "insufficient_scope",
  "request_id": "req_01J9ZK3V8Q4M2XQ7W0E5D1R6TA"
}

Headers

Sign-Request-Id

string

Unique id of this request (req_…). Quote it in support requests.