CHchainstack
Node

List all Nodes

Changed on

List all nodes in the networks your organization is part of.

get/v1/nodes/

Request

Query parameters

order_by'name' | 'created_at'

Which field to use when ordering the results. <br> Use the - prefix to perform descending ordering (-name).

pageinteger

A page number within the paginated result set.

projectstring

Filter by project ID.

organizationstring

Filter by organization ID.

networkstring

Filter by network ID.

region'asia-southeast1' | 'ap-southeast-1' | 'us-west-2' | 'us-east-1' | 'uksouth' | 'eu3'

Regions the nodes are deployed to.

Available for gcloud:

  • asia-southeast1

Available for aws:

  • ap-southeast-1
  • us-west-2
  • us-east-1

Available for azure:

  • uksouth

Available for vzo:

  • eu3

Filter by the region the node is deployed to.

provider'aws' | 'azure' | 'gcloud' | 'vzo'

Cloud provider. <br>See also Supported cloud providers.

Filter by the cloud provider of the node.

protocol'ethereum' | 'polygon-pos' | 'bsc' | 'avalanche' | 'arbitrum' | 'near' | 'aurora' | 'gnosis' | 'cronos' | 'fantom' | 'starknet' | 'tezos' | 'fuse' | 'bitcoin'

Protocol. <br>See also Supported protocols.

Filter by protocol.

status'pending' | 'running' | 'maintenance' | 'failed' | 'error' | 'stopping' | 'stopped' | 'starting'

See more about statuses.

Filter by node status.

role'peer'

Role of the node. <br>Available roles:

  • peer — peer node

Filter by node role.

type'shared' | 'dedicated'

Type of the node. <br>Available types:

  • shared — only for ethereum, polygon-pos, bsc, avalanche, fantom, tezos, bitcoin
  • dedicated — for all protocols

Filter by node type.

archiveboolean

Filter Ethereum, Polygon PoS, Binance Smart Chain, Avalanche, Fantom, and Tezos nodes by the archive mode flag.

public_network'ethereum-mainnet' | 'ethereum-ropsten-testnet' | 'ethereum-rinkeby-testnet' | 'polygon-pos-mainnet' | 'polygon-pos-testnet' | 'bsc-mainnet' | 'bsc-testnet' | 'avalanche-mainnet' | 'avalanche-testnet' | 'arbitrum-mainnet' | 'arbitrum-goerli' | 'near-mainnet' | 'near-testnet' | 'aurora-mainnet' | 'aurora-testnet' | 'gnosis-mainnet' | 'gnosis-testnet' | 'cronos-mainnet' | 'cronos-testnet' | 'fantom-mainnet' | 'fantom-testnet' | 'starknet-mainnet' | 'starknet-testnet' | 'tezos-mainnet' | 'tezos-testnet' | 'fuse-mainnet' | 'fuse-testnet' | 'bitcoin-mainnet' | 'bitcoin-testnet'
Example:corda-network-uat

Filter by public network.

namestring

Filter by name.

project_type'public'

Type of the project. <br>

  • public for public chain project

Filter by project type.

Response

countinteger

Number of the objects in the paginated results.

nextstring nullable

Link to the next page.

previousstring nullable

Link to the previous page.

Example response

{
  "count": 123
}

Changes

  • 7adaa13be98aRevision changes
    • breaking

      removed the enum value harmony from the query request parameter protocol

    • breaking

      removed the enum value harmony-devnet from the query request parameter public_network

    • breaking

      removed the enum value harmony-mainnet from the query request parameter public_network

    • info

      removed from the //// response property oneOf list for the response status

    • info

      removed from the /////////// response property oneOf list for the response status