v1

latestOpenAPI 3.0.02026-07-17493090.2 KB
Scabbard

Get a list of entries from a Scabbard service's state

This endpoint can be used to fetch a list of entries from a Scabbard service's state. The entries can be filtered using an address prefix provided with the prefix query parameter.

This endpoint requires the permission "scabbard.read".

get/scabbard/{circuit}/{service_id}/state

Path parameters

circuitstring required

Circuit the targeted service belongs to

service_idstring required

ID of the targeted service

Query parameters

prefixstring
Example:00ec01

An address prefix for filtering state entries. If no prefix is specified, all state entries will be returned.

Headers

Authorizationstring required

The client's authorization, which the server resolves to an identity. Currently supports Biome JWT (if Biome credentials is enabled), Cylinder JWT, and OAuth2 bearer tokens.

SplinterProtocolVersioninteger
Example:2

The protocol version which the client can understand. If not provided, the node will respond using its latest protocol version.

Response

The state entries were successfully retrieved

addressstring
valueinteger[]