Skip to content
Справочник APIConsumerConsumer.vspaces

List exit-node candidates for a VSpace

Эта страница пока доступна только на английском языке. Руководства переведены; автоматически генерируемый справочник API публикуется на английском.

GET
/consumer/v1/vspaces/{id}/exit-nodes

Returns the merged list of exit-node candidates the caller can pick as hops for this VSpace: own-account devices that are approved and (when the plan grants can_use_shared_exit_node) operator-shared infra nodes flagged is_exit_node. Free-plan callers see only their own approved devices.

Authorization

bearer_auth
AuthorizationBearer <token>

In: header

Path Parameters

id*string

VSpace ID

Formatuuid

Header Parameters

X-Project-Id*string

UUID of the project that scopes consumer accounts, devices, sessions, and VSpaces for the request.

Formatuuid

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/consumer/v1/vspaces/44444444-4444-4444-4444-444444444444/exit-nodes" \  -H "X-Project-Id: 11111111-1111-1111-1111-111111111111"
[  {    "country_code": null,    "health": "ready",    "id": "55555555-5555-5555-5555-555555555555",    "kind": "own",    "name": "Home Router",    "platform": "router",    "region": "derp:1"  }]
{  "detail": "Pool slug must be unique.",  "instance": "urn:forestvpn:trace:a1b2c3d4",  "title": "Validation Error",  "type": "https://fvpn.net/errors/validation"}
{  "detail": "Pool slug must be unique.",  "instance": "urn:forestvpn:trace:a1b2c3d4",  "title": "Validation Error",  "type": "https://fvpn.net/errors/validation"}
{  "detail": "Pool slug must be unique.",  "instance": "urn:forestvpn:trace:a1b2c3d4",  "title": "Validation Error",  "type": "https://fvpn.net/errors/validation"}