API: Nodes

Generated from openapi.json 0.1.0-draft (draft)

Optional callbacks a deploy pipeline sends about a single node.

Report that a node has been deployed

post/nodes/{nodeId}/ready

Optional callback. Tells Hetscale the deploy pipeline has finished with the node, which speeds the decision up and gives a better error message. It is not the source of truth: traffic opens only when the load balancer's per-target health check passes, regardless of this callback.

Parameters

Parameter	Type	Description
nodeId (path)*	string	Node identifier, a ULID prefixed with `node_`. Example: `node_01J8X4V9K2N7Q3R5S6T7V8W9XC`.

* required

Responses

202: The callback was recorded; the node still waits for the load balancer health check.
401: The API token is missing, invalid or revoked.
404: The group or node does not exist or belongs to another organisation.
422: The request body failed validation.
429: The organisation's API rate limit is exhausted; retry later.

Example

curl -X POST https://api.hetscale.com/nodes/node_01J8X4V9K2N7Q3R5S6T7V8W9XC/ready \
  -H "Authorization: Bearer $HETSCALE_API_TOKEN"

Report that the deploy to a node failed

post/nodes/{nodeId}/failed

Optional callback. Moves the node to DEPLOY_FAILED at once instead of waiting for the readiness deadline, and records the reason in the event timeline. The failure counts toward the group's bad-release brake: three consecutive failures pause the group.

Parameters

Parameter	Type	Description
nodeId (path)*	string	Node identifier, a ULID prefixed with `node_`. Example: `node_01J8X4V9K2N7Q3R5S6T7V8W9XC`.

* required

Request body

Field	Type	Description
reason*	string	Why the deploy failed; shown in the group's event timeline.

* required

{
  "reason": "docker compose up exited with status 1"
}

Responses

202: The node was marked as failed.
401: The API token is missing, invalid or revoked.
404: The group or node does not exist or belongs to another organisation.
422: The request body failed validation.
429: The organisation's API rate limit is exhausted; retry later.

Example

curl -X POST https://api.hetscale.com/nodes/node_01J8X4V9K2N7Q3R5S6T7V8W9XC/failed \
  -H "Authorization: Bearer $HETSCALE_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "reason": "docker compose up exited with status 1" }'