API/API Reference/Create a node

Create a node

Create a Phoenixd node. Provisioning continues after the response is returned.

POST/nodes

Required scope: nodes:write.

FieldDescription
nameOptional node name, up to 16 characters after trimming.
autoLiquidityOptional: 2m, 5m, or 10m. Defaults to 2m.
accessModeOptional: limited or full. Defaults to limited. Chooses which password Nodana stores for dashboard access.

Save the returned credentials and recovery words securely. They are returned at creation, not by subsequent node reads. Creation requires sufficient account credit and can return 402 Payment Required.

limited stores the restricted password for dashboard reads and invoice creation. full stores the full password so the dashboard can also send payments. Both passwords are returned at creation and can be used to call the node directly.

Omit name or leave it blank to use Node n, where n is the account's previous node count plus one, including deleted nodes.

The node is usable once its status is ready.

Request

curl "https://api.nodana.io/v1/nodes" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Response

202 Accepted

{
  "node": {
    "id": "node-123",
    "name": "Node 1",
    "status": "provisioning",
    "endpointUrl": "https://node-abcd.nodana.app:9740",
    "failureMessage": null,
    "updateStatus": null,
    "updateCompletedAt": null,
    "createdAt": 1790852400,
    "updatedAt": 1790852400
  },
  "credentials": {
    "seed": "<recovery-words>",
    "password": "<full-access-password>",
    "restrictedPassword": "<restricted-access-password>"
  }
}

On this page