Skip to content
nsin docs
EN فا

Cache totals with per-node breakdown

GET
/domains/{domain}/cache/keys/summary
 
curl --request GET \
  --url https://api.nsin.ir/domains/example.com/cache/keys/summary \
  --header 'Authorization: Bearer <token>'

Entry count and byte size for the whole domain, broken down by the edge node that cached each entry. It takes no filters — it always covers the whole domain. Computed at most once a minute per domain (a purge refreshes it at once). Requires domain.view.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
domain
required
string

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

Example 
example.com

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Totals.

Media type application/json
object
entries
integer
size_bytes
integer
by_node
Array<object>
object
node
string
entries
integer
size_bytes
integer
Example generated
{
  "entries": 1,
  "size_bytes": 1,
  "by_node": [
    {
      "node": "example",
      "entries": 1,
      "size_bytes": 1
    }
  ]
}

401

Section titled “401 ”

Missing, malformed, revoked or expired API key. (A valid key whose account has been deactivated gets 403 account is inactive instead.)

Media type application/json

The single error shape used by every endpoint.

object
error
required

Human-readable description of what went wrong.

string
Examples
Example invalidKey 
{
  "error": "invalid API key"
}

404

Section titled “404 ”

No such domain, or it is not visible to this account. Domains you cannot access are reported as not found rather than forbidden.

Media type 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

Section titled “429 ”

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

Media type application/json

The single error shape used by every endpoint.

object
error
required

Human-readable description of what went wrong.

string
Examples
Example limited 
{
  "error": "rate limit exceeded"
}

503

Section titled “503 ”

The cache registry is temporarily unreachable.

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