Archivistnode Swagger API

GET /archivist/v1/archivistnode

Get information about an archivist node

Returns the identified archivist node

Status Codes

  • 200 OK – A successful response.

  • 401 Unauthorized – Returned when the user is not authenticated to the system.

  • 403 Forbidden – Returned when the user is not authorized to read the archivist node’s information

  • 404 Not Found – Returned when the identified archivist node does not exist

  • 429 Too Many Requests – Returned when a user exceeds their subscription’s rate limit for requests.

  • default – An unexpected error response.

Response JSON Object

  • blockchain_nodes[].block_height (string) – For the local node, the height of the last committed block (read only)

  • blockchain_nodes[].connection_status (string) –

  • blockchain_nodes[].genesis_hash (string) – HASH of genesis block. (read only)

  • blockchain_nodes[].peers[].connection_status (string) –

  • blockchain_nodes[].peers[].validator_pubkey.keyEC.crv (string) – The curve name for the key. 6.2.1.1 rfc 7518, 3.1 draft-ietf-cose-webauthn-algorithms-00 MUST be one of P-256K, P-256, P-384, P-521

  • blockchain_nodes[].peers[].validator_pubkey.keyEC.d (string) – Present only for PRIVATE keys. The base64url encoding of the private key 6.2.2.1 rfc 7518

  • blockchain_nodes[].peers[].validator_pubkey.keyEC.kty (string) –

  • blockchain_nodes[].peers[].validator_pubkey.keyEC.x (string) – The base64url encoding of the x component for the uncompressed point. 6.2.1.2 rfc 7518

  • blockchain_nodes[].peers[].validator_pubkey.keyEC.y (string) – The base64url encoding of the y component the uncompressed point 6.2.1.3 rfc 7518

  • blockchain_nodes[].state_root (string) – state root of genesis block. (read only)

  • blockchain_nodes[].syncStatus.current_block (string) – When syncing, the current block. (read only)

  • blockchain_nodes[].syncStatus.highest_block (string) – When syncing, the highest block. (read only)

  • blockchain_nodes[].syncStatus.starting_block (string) – When syncing, the starting block. (read only)

  • blockchain_nodes[].timestamp_committed (string) – Timestamp when consensus was achieved for the block at block_height (RFC 3339) obtained from the block info of the ‘latest’ block. (read only)

  • blockchain_nodes[].timestamp_created (string) – Timestamp of creation of the genesis block (RFC 3339) (read only)

  • blockchain_nodes[].validator_pubkey.keyEC.crv (string) – The curve name for the key. 6.2.1.1 rfc 7518, 3.1 draft-ietf-cose-webauthn-algorithms-00 MUST be one of P-256K, P-256, P-384, P-521

  • blockchain_nodes[].validator_pubkey.keyEC.d (string) – Present only for PRIVATE keys. The base64url encoding of the private key 6.2.2.1 rfc 7518

  • blockchain_nodes[].validator_pubkey.keyEC.kty (string) –

  • blockchain_nodes[].validator_pubkey.keyEC.x (string) – The base64url encoding of the x component for the uncompressed point. 6.2.1.2 rfc 7518

  • blockchain_nodes[].validator_pubkey.keyEC.y (string) – The base64url encoding of the y component the uncompressed point 6.2.1.3 rfc 7518

  • identity (string) – The identity of the archivistnode blockchain (read only)

GET /archivist/v1/archivistnode:openapi

Get OpenAPI spec for Archivistnode

Get OpenAPI v2.0 spec for Archivistnode

Status Codes

  • 200 OK – A successful response.

  • 401 Unauthorized – Returned when the user is not authenticated to the system.

  • 429 Too Many Requests – Returned when a user exceeds their subscription’s rate limit for requests.

  • default – An unexpected error response.

GET /archivist/v1/archivistnode:openapi-ui

Get OpenAPI html for Archivistnode

Get OpenAPI v2.0 html for Archivistnode

Status Codes

  • 200 OK – A successful response.

  • 401 Unauthorized – Returned when the user is not authenticated to the system.

  • 429 Too Many Requests – Returned when a user exceeds their subscription’s rate limit for requests.

  • default – An unexpected error response.