Download one cached object

GET

/domains/{domain}/cache/keys/content

const url = 'https://api.nsin.ir/domains/example.com/cache/keys/content?hostname=example&node=example&key_hash=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.nsin.ir/domains/example.com/cache/keys/content?hostname=example&node=example&key_hash=example' \
  --header 'Authorization: Bearer <token>'

The stored bytes behind a listing row, read straight from cache storage — your origin is never contacted, so this works even when the site is down.

Address the entry by its stored identity: copy hostname, node and key_hash verbatim from a /domains/{domain}/cache/keys row. node is the edge location that cached it, so the same URL cached at three locations is three entries and you choose which copy you get.

The body is returned in its original uncompressed form with the stored Content-Type, always as an attachment. The cached response’s own status code and age travel in X-Nsin-Cache-Status and X-Nsin-Cached-At — the HTTP status describes only whether the read succeeded.

A 404 with entry is no longer cached means the listing row outlived the object (it expired, was evicted, or was purged). Requires domain.view.

Authorizations

bearerAuth
apiKeyAuth

Parameters

Path Parameters

domain

required

string

The domain name (for example example.com) — not a numeric id.

Example

example.com

Query Parameters

hostname

required

string

The row’s hostname — the storage namespace, not the request host.

node

required

string

The row’s node — the edge location holding this copy. Case-sensitive.

key_hash

required

string

The row’s key_hash.

Responses

200

The stored object. Content-Type is whatever was cached; the payload is the uncompressed body.

application/octet-stream

string format: binary

Headers

X-Nsin-Cache-Node

string

Edge location this copy came from.

X-Nsin-Cache-Status

integer

HTTP status of the cached response.

X-Nsin-Cached-At

string format: date-time

When the object was cached (RFC 3339).

400

Missing or malformed hostname, node or key_hash.

application/json

The single error shape used by every endpoint.

object

error

required

Human-readable description of what went wrong.

string

Example

{
  "error": "read-only API key"
}

401

Missing, malformed, revoked or expired API key — or the owning account is inactive.

application/json

The single error shape used by every endpoint.

object

error

required

Human-readable description of what went wrong.

string

Examples

invalidKey

{
  "error": "invalid API key"
}

404

Domain or hostname not yours, or the entry is no longer cached.

application/json

The single error shape used by every endpoint.

object

error

required

Human-readable description of what went wrong.

string

Example

{
  "error": "read-only API key"
}

429

The key exceeded its request budget (300 requests per minute by default).

application/json

The single error shape used by every endpoint.

object

error

required

Human-readable description of what went wrong.

string

Examples

limited

{
  "error": "rate limit exceeded"
}

502

The stored entry could not be decoded.

application/json

The single error shape used by every endpoint.

object

error

required

Human-readable description of what went wrong.

string

Example

{
  "error": "read-only API key"
}

503

Cache storage is unavailable.

application/json

The single error shape used by every endpoint.

object

error

required

Human-readable description of what went wrong.

string

Example

{
  "error": "read-only API key"
}