List ledger packages

get

https://example.com/api/v2/ledger/packages

Returns packages known to the selected validator node. Options control whether to refresh the list, include packages that may be out of date, and return additional package details.

Query Params

refresh

boolean

Refresh an empty or out-of-date package list before returning. Defaults to false.

includeStale

boolean

Include packages that may be out of date. Defaults to false.

includeVetting

boolean

Include package-vetting metadata. Defaults to true.

metadataSource

string

Metadata source filter: any, vetted, archive, or unknown. Defaults to any.

jwt

string

Ledger API JWT; use the header for normal clients.

nodeId

string

Configured validator-node identifier. Defaults to the deployment's default node.

Headers

jwt

string

Ledger API JWT used for package inventory access.

nodeId

string

Configured validator-node identifier; the query value takes precedence.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200OK

400Bad Request

401Unauthorized

403Forbidden

404Not Found

500Internal Server Error

503Service Unavailable