PATCH
/
v1
/
nodes
/
{id}
curl --request PATCH \
  --url https://api.chainstack.com/v1/nodes/{id}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "My new node name"
}'
{
  "id": "ND-123-456-789",
  "name": "My Ethereum archive 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"
    }
  }
}

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.

Path Parameters

​
id
string
required

A unique value identifying the Object.

Body

application/json
​
name
string

Name of the node.

​
network
string

ID of the network.

​
type
enum<string>

Type of the node. <br>Available types:

  • shared — only for ethereum, polygon-pos, bsc, avalanche, fantom, tezos, bitcoin
  • dedicated — for all protocols
Available options:
shared,
dedicated
​
provider
enum<string>

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

Available options:
aws,
azure,
gcloud,
vzo
​
region
enum<string>

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
Available options:
asia-southeast1,
ap-southeast-1,
us-west-2,
us-east-1,
uksouth,
eu3
​
details
object

Protocol-specific attributes.

​
creator
object

Creator of the network.

​
created_at
string

When the node was created.

Response

200
application/json
​
id
string
​
name
string

Name of the node.

​
network
string

ID of the network.

​
organization
string

ID of the organization that owns this node.

​
type
enum<string>

Type of the node. <br>Available types:

  • shared — only for ethereum, polygon-pos, bsc, avalanche, fantom, tezos, bitcoin
  • dedicated — for all protocols
Available options:
shared,
dedicated
​
provider
enum<string>

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

Available options:
aws,
azure,
gcloud,
vzo
​
region
enum<string>

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
Available options:
asia-southeast1,
ap-southeast-1,
us-west-2,
us-east-1,
uksouth,
eu3
​
details
object

Protocol-specific attributes.

​
status
enum<string>

See more about statuses.

Available options:
pending,
running,
maintenance,
failed,
error,
stopping,
stopped,
starting
​
creator
object

Creator of the network.

​
created_at
string

When the node was created.

​
role
enum<string>

Role of the node. <br>Available roles:

  • peer — peer node
Available options:
peer
​
configuration
object

Ethereum node configuration.

Was this page helpful?

Suggest editsRaise issue