nodes

Scrape a node port for Prometheus exposition text

Register a Prometheus endpoint on a node for the platform to scrape and retain: every serving engine exposes /metrics - one call here replaces the scrape-loop scaffolding. The platform scrapes the container-local port at your org's interval (default 30s), stamps {node} labels, and stores it queryably (query_metrics) under your org. Registrations survive stop/wake (scraping pauses while stopped) and die with the node; get_node shows each registration's last scrape health - a failing scrape on a live container is the dead-engine signal. Metrics bill on active series past the free tier: keep label cardinality low (identity in labels, data in values; never a request id or timestamp in a label).

post/preview/nodes/{name}/scrapes

Request

  • Base URL: https://autoresearch.sfcompute.com
  • URL: https://autoresearch.sfcompute.com/preview/nodes/{name}/scrapes
  • Auth: HTTP bearer

Path parameters

namestring required

Node name (from list_nodes).

Query parameters

workspacestring

Act in this workspace (its slug). Omitted: the token's bound workspace, then the organization's default. Never ambient - there is no switch-workspace mutation on this door.

Request body

interval_secondsinteger nullable

Scrape interval in seconds (default: your org's setting, 30s; floor 10s). Finer intervals mean more samples.

pathstring nullable

Endpoint path (default "/metrics").

portinteger required

The container port serving Prometheus exposition text.

Response

The capability's JSON result.

objectstring

The resource type, when the result is one resource.

Changes

No recorded changes to this operation across all 1 revision of this API.