Listing Anchors

GET /api/v2/anchors/?page_size=5

Try it out

Standard query parameters apply: page, page_size, fields, sort, etc.

Filtering by Probe Status

An anchor's own state flags record how far it got through installation — they do not go back once set. To ask whether an anchor's probe is reachable now, filter on the probe's status:

Value	Status
0	Never Connected
1	Connected
2	Disconnected
3	Abandoned
4	Written Off

GET /api/v2/anchors/?probe_status=2&page_size=5

Try it out

probe_status__in takes a comma-separated list, and probe_status_name takes the name instead of the number:

GET /api/v2/anchors/?probe_status__in=2,3&page_size=5

Try it out

To exclude instead of include, use probe_status__not and probe_status__not__in. Anchors that have no probe yet are kept by the exclusions — they have no status to match — and are never returned by the inclusive filters.

GET /api/v2/anchors/?probe_status__not__in=3,4&page_size=5

Try it out

Anchor Detail

Retrieve a specific anchor by ID:

GET /api/v2/anchors/1/

Try it out

For the full list of anchor fields and filters, see the REST API Reference.