POST
/
v1
/
networks
curl --request POST \
  --url https://api.chainstack.com/v1/networks/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "project": "PR-123-456",
  "protocol": "ethereum",
  "configuration": {
    "network": "ethereum-mainnet"
  },
  "nodes": [
    {
      "name": "My Ethereum node",
      "type": "dedicated",
      "role": "peer",
      "provider": "gcloud",
      "region": "asia-southeast1",
      "configuration": {
        "archive": true
      }
    }
  ]
}'
{
  "id": "NW-123-456-7",
  "name": "Mainnet",
  "project": "PR-123-456",
  "protocol": "ethereum",
  "configuration": {
    "network": "ethereum-mainnet"
  },
  "details": {},
  "status": "ok",
  "nodes": [
    {
      "id": "ND-123-456-789",
      "name": "My Ethereum node",
      "network": "NW-123-456-7",
      "organization": "RG-123-456",
      "type": "dedicated",
      "role": "peer",
      "provider": "gcloud",
      "region": "asia-southeast1",
      "status": "running",
      "configuration": {
        "archive": true
      },
      "details": {
        "mode": "archive",
        "version": "1.9.9",
        "api_namespaces": [
          "net",
          "eth",
          "web3",
          "txpool",
          "debug"
        ],
        "graphql_endpoint": "https://nd-123-456-789.p2pify.com/graphql",
        "https_endpoint": "https://nd-123-456-789.p2pify.com",
        "wss_endpoint": "wss://ws-nd-123-456-789.p2pify.com",
        "beacon_endpoint": "https://beacon-nd-123-456-789.p2pify.com",
        "auth_username": "user-name",
        "auth_password": "pass-word-pass-word-pass-word",
        "auth_key": "3c6e0b8a9c15224a8228b9a98ca1531d"
      },
      "created_at": "2020-06-15T07:38:00.747Z",
      "creator": {
        "id": "UR-111-111-111",
        "email": "john.smith@example.com",
        "first_name": "John",
        "last_name": "Smith",
        "organization": {
          "id": "RG-123-456",
          "name": "My organization"
        }
      }
    }
  ],
  "created_at": "2020-06-15T07:38:00.747Z",
  "creator": {
    "id": "UR-111-111-111",
    "email": "john.smith@example.com",
    "first_name": "John",
    "last_name": "Smith",
    "organization": {
      "id": "RG-123-456",
      "name": "My organization"
    }
  }
}

Authorizations

Authorization
string
header
required

Chainstack API uses API keys to authenticate requests. You can view and manage your API keys in the platform UI. Your API keys carry many privileges, so be sure to keep them secure! Provide your API key as the Authorization header. The value of the header consists of Bearer prefix and secret key generated through the platform UI.

curl -X GET 'https://api.chainstack.com/v1/organization/' \
--header 'Authorization: Bearer FX7CWlLg.FMpAO8cgCX2N7s41EncRru2nb5CmTZUt'

All API requests must be made over HTTPS.

Body

application/json
name
string
required

Name of the network.

  • Required for consortium networks.
  • Autogenerated for public chain networks.
project
string
required

ID of the network's project.

protocol
enum<string>
required

Protocol. <br>See also Supported protocols.

Available options:
ethereum,
polygon-pos,
bsc,
avalanche,
arbitrum,
near,
aurora,
gnosis,
cronos,
fantom,
starknet,
harmony,
tezos,
fuse,
bitcoin
configuration
object
required

Protocol-specific parameters. <br>Pass {} if there are no specific parameters for the chosen protocol.

nodes
object[]
required

List of nodes that will be initially created.

creator
object

Creator of the network.

created_at
string

When the network was created.

Response

201
application/json
id
string
name
string

Name of the network.

project
string

ID of the network's project.

protocol
enum<string>

Protocol. <br>See also Supported protocols.

Available options:
ethereum,
polygon-pos,
bsc,
avalanche,
arbitrum,
near,
aurora,
gnosis,
cronos,
fantom,
starknet,
harmony,
tezos,
fuse,
bitcoin
details
object
status
enum<string>

See more about statuses.

Available options:
pending,
ok,
failed,
warning,
stopping,
stopped,
starting
creator
object

Creator of the network.

created_at
string

When the network was created.

configuration
object

Ethereum network configuration.

nodes
object[]