Skip to main content
API docs by Redocly

Ledger Nodes (0.0.19)

Download OpenAPI specification:Download

Explorer

Get a list of all explorers Deprecated

Authorizations:
ApplicationToken
query Parameters
project
string

The project that you wish to filter by

resourceId
string
Default: ""

The resourceId of the project that you want to return

page
integer <int> >= 0
Default: 0

The page number that you want to return

size
integer <int> [ 5 .. 100 ]
Default: 20

The number of items to return per page

sort
Array of strings
Example: sort=name,name,asc,name,desc

The sort order that you want to return. You can specify one or more comma-separated sort keys, each followed by an optional sort direction of either asc (ascending) or desc (descending).

If you want to sort in descending order, append ,desc to the sort key; otherwise, the default is to sort in ascending order. If you want to sort in ascending order, you can optionally append ,asc.

Examples of valid sort query parameters include:

  • sort=name: Sort by name in ascending order
  • sort=name,desc: Sort by name in descending order
  • sort=name,desc,created,asc: Sort by name in descending order, then by created in ascending order
  • sort=name,desc&sort=created,asc: Sort by name in descending order, then by created in ascending order

Responses

Response samples

Content type
application/json
{
  • "contentType": "ExplorerPage"
}

Deletes an explorer by its ID Deprecated

Authorizations:
ApplicationToken
path Parameters
explorerId
required
string

The explorer that you wish to filter by

Responses

Gets an explorer by its ID Deprecated

Authorizations:
ApplicationToken
path Parameters
explorerId
required
string

The explorer that you wish to filter by

Responses

Response samples

Content type
application/json
{
  • "explorerID": "string",
  • "id": 0,
  • "implementations": [
    ],
  • "ledgerID": "string",
  • "name": "string",
  • "nodeID": "string",
  • "resourceId": "string"
}

Gets the default explorer for a ledger Deprecated

Authorizations:
ApplicationToken
path Parameters
ledgerId
required
string

The ledger that you wish to filter by

Responses

Response samples

Content type
application/json
{
  • "explorerID": "string",
  • "id": 0,
  • "implementations": [
    ],
  • "ledgerID": "string",
  • "name": "string",
  • "nodeID": "string",
  • "resourceId": "string"
}

Ledger

Get a list of all the Active Ledgers Deprecated

Authorizations:
ApplicationToken
query Parameters
project
string

The project that you wish to filter by

resourceId
string
Default: ""

The resourceId of the project that you want to return

page
integer <int> >= 0
Default: 0

The page number that you want to return

size
integer <int> [ 5 .. 100 ]
Default: 20

The number of items to return per page

sort
Array of strings
Example: sort=name,name,asc,name,desc

The sort order that you want to return. You can specify one or more comma-separated sort keys, each followed by an optional sort direction of either asc (ascending) or desc (descending).

If you want to sort in descending order, append ,desc to the sort key; otherwise, the default is to sort in ascending order. If you want to sort in ascending order, you can optionally append ,asc.

Examples of valid sort query parameters include:

  • sort=name: Sort by name in ascending order
  • sort=name,desc: Sort by name in descending order
  • sort=name,desc,created,asc: Sort by name in descending order, then by created in ascending order
  • sort=name,desc&sort=created,asc: Sort by name in descending order, then by created in ascending order

Responses

Response samples

Content type
application/json
{
  • "contentType": "LedgerPage"
}

Creates a new Ledger Deprecated

Authorizations:
ApplicationToken
Request Body schema: application/json
active
boolean
id
integer <int64>
ledgerID
string
object (LedgerTechnology)
name
string
Array of objects (LedgerProperty)
resourceId
string
object (LedgerType)

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "id": 0,
  • "ledgerID": "string",
  • "ledgerTechnology": {
    },
  • "name": "string",
  • "properties": [
    ],
  • "resourceId": "string",
  • "type": {
    }
}

Response samples

Content type
application/json
{
  • "active": true,
  • "id": 0,
  • "ledgerID": "string",
  • "ledgerTechnology": {
    },
  • "name": "string",
  • "properties": [
    ],
  • "resourceId": "string",
  • "type": {
    }
}

Get a list of all the featured Ledgers Deprecated

Authorizations:
ApplicationToken
query Parameters
page
integer <int> >= 0
Default: 0

The page number that you want to return

size
integer <int> [ 5 .. 100 ]
Default: 20

The number of items to return per page

sort
Array of strings
Example: sort=name,name,asc,name,desc

The sort order that you want to return. You can specify one or more comma-separated sort keys, each followed by an optional sort direction of either asc (ascending) or desc (descending).

If you want to sort in descending order, append ,desc to the sort key; otherwise, the default is to sort in ascending order. If you want to sort in ascending order, you can optionally append ,asc.

Examples of valid sort query parameters include:

  • sort=name: Sort by name in ascending order
  • sort=name,desc: Sort by name in descending order
  • sort=name,desc,created,asc: Sort by name in descending order, then by created in ascending order
  • sort=name,desc&sort=created,asc: Sort by name in descending order, then by created in ascending order

Responses

Response samples

Content type
application/json
{
  • "contentType": "LedgerPage"
}

Delete a Ledger by its ID Deprecated

Authorizations:
ApplicationToken
path Parameters
ledgerId
required
string

The ledger that you wish to filter by

Responses

Get a Ledger by its ID Deprecated

Authorizations:
ApplicationToken
path Parameters
ledgerId
required
string

The ledger that you wish to filter by

Responses

Response samples

Content type
application/json
{
  • "active": true,
  • "id": 0,
  • "ledgerID": "string",
  • "ledgerTechnology": {
    },
  • "name": "string",
  • "properties": [
    ],
  • "resourceId": "string",
  • "type": {
    }
}

Node

Get a list of all nodes Deprecated

Authorizations:
ApplicationToken
query Parameters
project
string

The project that you wish to filter by

resourceId
string
Default: ""

The resourceId of the project that you want to return

page
integer <int> >= 0
Default: 0

The page number that you want to return

size
integer <int> [ 5 .. 100 ]
Default: 20

The number of items to return per page

sort
Array of strings
Example: sort=name,name,asc,name,desc

The sort order that you want to return. You can specify one or more comma-separated sort keys, each followed by an optional sort direction of either asc (ascending) or desc (descending).

If you want to sort in descending order, append ,desc to the sort key; otherwise, the default is to sort in ascending order. If you want to sort in ascending order, you can optionally append ,asc.

Examples of valid sort query parameters include:

  • sort=name: Sort by name in ascending order
  • sort=name,desc: Sort by name in descending order
  • sort=name,desc,created,asc: Sort by name in descending order, then by created in ascending order
  • sort=name,desc&sort=created,asc: Sort by name in descending order, then by created in ascending order

Responses

Response samples

Content type
application/json
{
  • "contentType": "NodePage"
}

Creates a new Node Deprecated

Authorizations:
ApplicationToken
Request Body schema: application/json
client
string
id
integer <int64>
name
string
nodeID
string
object

Responses

Request samples

Content type
application/json
{
  • "client": "string",
  • "id": 0,
  • "name": "string",
  • "nodeID": "string",
  • "options": {
    }
}

Response samples

Content type
application/json
{
  • "client": "string",
  • "id": 0,
  • "name": "string",
  • "nodeID": "string",
  • "properties": [
    ],
  • "resourceId": "string",
  • "uri": "string"
}

Delete a Node by its ID Deprecated

Authorizations:
ApplicationToken
path Parameters
nodeId
required
string

The node that you wish to filter by

Responses

Get a Node by its ID Deprecated

Authorizations:
ApplicationToken
path Parameters
nodeId
required
string

The node that you wish to filter by

Responses

Response samples

Content type
application/json
{
  • "client": "string",
  • "id": 0,
  • "name": "string",
  • "nodeID": "string",
  • "properties": [
    ],
  • "resourceId": "string",
  • "uri": "string"
}

Get a list of all nodes of Ledger Id by Project Deprecated

Authorizations:
ApplicationToken
path Parameters
ledgerId
required
string

The ledger that you wish to filter by

query Parameters
project
string

The project that you wish to filter by

resourceId
string
Default: ""

The resourceId of the project that you want to return

page
integer <int> >= 0
Default: 0

The page number that you want to return

size
integer <int> [ 5 .. 100 ]
Default: 20

The number of items to return per page

sort
Array of strings
Example: sort=name,name,asc,name,desc

The sort order that you want to return. You can specify one or more comma-separated sort keys, each followed by an optional sort direction of either asc (ascending) or desc (descending).

If you want to sort in descending order, append ,desc to the sort key; otherwise, the default is to sort in ascending order. If you want to sort in ascending order, you can optionally append ,asc.

Examples of valid sort query parameters include:

  • sort=name: Sort by name in ascending order
  • sort=name,desc: Sort by name in descending order
  • sort=name,desc,created,asc: Sort by name in descending order, then by created in ascending order
  • sort=name,desc&sort=created,asc: Sort by name in descending order, then by created in ascending order

Responses

Response samples

Content type
application/json
{
  • "contentType": "NodePage"
}

Gets the default node of a Ledger Deprecated

Authorizations:
ApplicationToken
path Parameters
ledgerId
required
string

The ledger that you wish to filter by

Responses

Response samples

Content type
application/json
{
  • "client": "string",
  • "id": 0,
  • "name": "string",
  • "nodeID": "string",
  • "properties": [
    ],
  • "resourceId": "string",
  • "uri": "string"
}