> ## Documentation Index > Fetch the complete documentation index at: https://docs.phoneuse.com/llms.txt > Use this file to discover all available pages before exploring further. # Read a device's confirmed Proxy relationship > Requires a first-party interactive organization session with devices:read. Financial commands require an administrator and the configured checkout step-up policy. Network commands also require devices:act, current device authority and explicit consent. New purchase/connection commands require current admission. No credentials are returned. A deployment without the durable composition returns capability_unavailable (422). Renewal, order target/delivery edits, operation resume and event feeds are not available. Preserve command identity after an uncertain reply and read the original order or operation. Hosted deployments only. A local checkout does not mount this route, so calling it there is a 404. ## OpenAPI ````yaml /api/openapi.json get /v1/devices/{deviceId}/proxy openapi: 3.1.0 info: title: Phonebase HTTP API version: 0.1.0 summary: >- Every HTTP operation the control plane mounts, generated from the app's own route table. description: >- The control plane exposes two HTTP surfaces, and reading the boundary between them matters more than reading any single endpoint. The CONTROL surface is what your backend and your operators call. It takes a bearer token in the `Authorization` header, and two credential channels resolve to the same authorization context: an OAuth 2.1 access token for interactive clients, or an org scoped API key for headless ones. The DEVICE surface, under `/vrx/{runToken}/v1`, is what a worker calls while executing one run. Its credential is the run token in the url path, and it reads no `Authorization` header at all. Device control itself is not REST. An agent taps, swipes and reads the screen over the Model Context Protocol at `POST /mcp`, one tool call at a time. There is no `POST /v1/devices/{id}/tap`, and if you are looking for one, start with the tool reference instead. Operations marked `"x-phonebase-modes": ["hosted"]` exist only on a hosted deployment; a local checkout does not mount them. servers: - url: '{origin}' description: Your control plane origin. variables: origin: default: https://mcp.phonebase.co enum: - https://mcp.phonebase.co - http://127.0.0.1:8788 description: >- The hosted deployment serves the public origin its metadata document advertises, and that is the default here. Select the loopback entry instead when you are running a local checkout, which serves the port `PORT` names. security: [] tags: - name: Apps description: Save immutable application builds and manage explicit device operations. - name: Managed Proxy description: >- Organization-owned fixed egress resources, independent one-time orders and verified network relationships. - name: Health description: Liveness, unauthenticated. - name: Gateway enrollment description: >- How a new gateway computer trades a one-time enrollment code for its tunnel credential. Unauthenticated: the code is the credential. - name: Gateway releases description: >- What a gateway computer installs: the current edge release of a channel. Called with the gateway's own credential. - name: MCP description: The JSON-RPC endpoint an agent drives devices through. - name: Copilot description: >- Drive a device by chatting. A signed in person's own conversations, streamed. Hosted deployments only. - name: Discovery description: Where to authenticate. Served on hosted deployments only. - name: Runs description: Start, watch and steer a run. - name: API keys description: Mint and revoke headless credentials. Hosted deployments only. - name: Device surface description: What a worker calls with its run token to observe and act. - name: Usage description: Read your org's own receipts and consumption. Hosted deployments only. - name: Devices description: Read the fleet your credential can see. Hosted deployments only. - name: Notifications description: >- What a person needs to know when they are not watching, and which emails they receive. Hosted deployments only. - name: Webhooks description: >- Subscribe your own system to what happens here, and read what was delivered. Hosted deployments only. - name: Provisioning description: >- Whether an organisation is provisioned, and how it becomes so. Hosted deployments only, and both operations answer a declared 503 on a deployment that cannot provision yet. paths: /v1/devices/{deviceId}/proxy: get: tags: - Managed Proxy summary: Read a device's confirmed Proxy relationship description: >- Requires a first-party interactive organization session with devices:read. Financial commands require an administrator and the configured checkout step-up policy. Network commands also require devices:act, current device authority and explicit consent. New purchase/connection commands require current admission. No credentials are returned. A deployment without the durable composition returns capability_unavailable (422). Renewal, order target/delivery edits, operation resume and event feeds are not available. Preserve command identity after an uncertain reply and read the original order or operation. Hosted deployments only. A local checkout does not mount this route, so calling it there is a 404. operationId: getV1DevicesByDeviceIdProxy parameters: - name: deviceId in: path required: true description: Opaque organization-scoped identifier. schema: type: string responses: '200': description: Authorized current projection. headers: Cache-Control: description: Responses are never cached. schema: type: string const: no-store X-Request-Id: description: Sanitized request correlation. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ManagedProxyDeviceProxyResponse' '400': description: >- Rejected or unavailable; inspect the structured error and retain original command identity. content: application/json: schema: $ref: '#/components/schemas/ManagedProxyErrorResponse' '401': description: >- Rejected or unavailable; inspect the structured error and retain original command identity. content: application/json: schema: $ref: '#/components/schemas/ManagedProxyErrorResponse' '403': description: >- Rejected or unavailable; inspect the structured error and retain original command identity. content: application/json: schema: $ref: '#/components/schemas/ManagedProxyErrorResponse' '404': description: >- Rejected or unavailable; inspect the structured error and retain original command identity. content: application/json: schema: $ref: '#/components/schemas/ManagedProxyErrorResponse' '409': description: >- Rejected or unavailable; inspect the structured error and retain original command identity. content: application/json: schema: $ref: '#/components/schemas/ManagedProxyErrorResponse' '422': description: >- Rejected or unavailable; inspect the structured error and retain original command identity. content: application/json: schema: $ref: '#/components/schemas/ManagedProxyErrorResponse' '429': description: >- Over the request budget for this caller. Hosted deployments only. Which budget applied depends on whether this request carried an `Authorization` header, not on which endpoint it was aimed at. Wait `Retry-After` seconds and retry the same request: the refusal happens before any work, so nothing was partially applied. See /api/rate-limits. headers: Retry-After: description: >- Whole seconds until one request is available again. Computed from the caller's own remaining allowance, not a fixed constant. schema: type: string RateLimit-Limit: description: >- The budget in effect for this caller class, in requests per minute. schema: type: string RateLimit-Remaining: description: >- Whole requests that were still available when this request was admitted. Zero on a 429. schema: type: string RateLimit-Reset: description: >- Seconds until the allowance is back to full. Longer than `Retry-After`, which is the wait for a single request. schema: type: string RateLimit-Policy: description: The budget and its window, as `;w=60`. schema: type: string content: application/json: schema: $ref: '#/components/schemas/RateLimitedError' '503': description: >- Rejected or unavailable; inspect the structured error and retain original command identity. content: application/json: schema: $ref: '#/components/schemas/ManagedProxyErrorResponse' security: - bearerAuth: [] components: schemas: ManagedProxyDeviceProxyResponse: type: object properties: data: $ref: '#/components/schemas/ManagedProxyDeviceProxy' snapshot: $ref: '#/components/schemas/ManagedProxySnapshot' request_id: $ref: '#/components/schemas/ManagedProxyId' required: - data - snapshot - request_id additionalProperties: false examples: - data: device_id: dev_demo_a device_version: 12 proxy: id: px_demo_1 version: 7 name: US egress 01 lifecycle: active country_code: US egress_ip: 203.0.113.24 service_window: starts_at: '2026-10-01T00:00:00Z' ends_at: '2026-10-31T00:00:00Z' duration_seconds: 2592000 renewal_mode: manual binding: state: connected device_id: dev_demo_a operation_id: null observed_egress_ip: 203.0.113.24 verified_at: '2026-10-01T00:00:00Z' message: null acquired_order_id: po_demo_ready created_at: '2026-10-01T00:00:00Z' updated_at: '2026-10-01T00:00:00Z' archived_at: null allowed_actions: - action: unbind allowed: true reason_code: null message: null - action: transfer allowed: true reason_code: null message: null - action: renew allowed: true reason_code: null message: null - action: rename allowed: true reason_code: null message: null binding: state: connected device_id: dev_demo_a operation_id: null observed_egress_ip: 203.0.113.24 verified_at: '2026-10-01T00:00:00Z' message: null change_eligibility: allowed: true reason_code: null message: null allowed_actions: - action: replace allowed: true reason_code: null message: null - action: unbind allowed: true reason_code: null message: null snapshot: freshness: fresh observed_at: '2026-10-01T00:00:00Z' served_at: '2026-10-01T00:00:00Z' message: null request_id: req_demo_1 ManagedProxyErrorResponse: type: object properties: error: type: object properties: code: type: string description: Stable snake_case code. pattern: ^[a-z][a-z0-9_]*$ message: type: string description: English, without credentials or raw vendor errors. request_id: $ref: '#/components/schemas/ManagedProxyId' details: $ref: '#/components/schemas/ManagedProxyErrorDetails' retryable: type: boolean description: Compatibility with existing reverification_required envelope. maxAgeMinutes: type: integer minimum: 1 required: - code - message additionalProperties: false required: - error additionalProperties: false examples: - error: code: version_conflict message: >- The device or resource changed. Refresh its status before confirming again. request_id: req_demo_2 details: retryable: false recovery_action: refresh_and_confirm resource_versions: px_demo_1: 8 device_versions: dev_demo_a: 13 dev_demo_b: 4 - error: code: reverification_required message: Verify again and retry. retryable: true maxAgeMinutes: 10 RateLimitedError: type: object properties: error: type: object properties: code: type: string const: rate_limited description: Always `rate_limited` on this response. message: type: string description: >- A human readable summary. The numbers are in the headers, not in here. required: - code - message additionalProperties: false required: - error additionalProperties: false description: >- Over the request budget. Raised by the rate limiter before any handler runs, which is why its code is not one of the action codes: nothing was attempted, so no action failed. ManagedProxyDeviceProxy: type: object properties: device_id: $ref: '#/components/schemas/ManagedProxyId' device_version: $ref: '#/components/schemas/ManagedProxyVersion' proxy: anyOf: - $ref: '#/components/schemas/ManagedProxyResource' - type: 'null' binding: $ref: '#/components/schemas/ManagedProxyBinding' change_eligibility: type: object properties: allowed: type: boolean reason_code: anyOf: - type: string - type: 'null' message: anyOf: - type: string - type: 'null' required: - allowed - reason_code - message additionalProperties: false allowed_actions: type: array items: $ref: '#/components/schemas/ManagedProxyActionEligibility' required: - device_id - device_version - proxy - binding - change_eligibility - allowed_actions additionalProperties: false examples: - device_id: dev_demo_a device_version: 12 proxy: id: px_demo_1 version: 7 name: US egress 01 lifecycle: active country_code: US egress_ip: 203.0.113.24 service_window: starts_at: '2026-10-01T00:00:00Z' ends_at: '2026-10-31T00:00:00Z' duration_seconds: 2592000 renewal_mode: manual binding: state: connected device_id: dev_demo_a operation_id: null observed_egress_ip: 203.0.113.24 verified_at: '2026-10-01T00:00:00Z' message: null acquired_order_id: po_demo_ready created_at: '2026-10-01T00:00:00Z' updated_at: '2026-10-01T00:00:00Z' archived_at: null allowed_actions: - action: unbind allowed: true reason_code: null message: null - action: transfer allowed: true reason_code: null message: null - action: renew allowed: true reason_code: null message: null - action: rename allowed: true reason_code: null message: null binding: state: connected device_id: dev_demo_a operation_id: null observed_egress_ip: 203.0.113.24 verified_at: '2026-10-01T00:00:00Z' message: null change_eligibility: allowed: true reason_code: null message: null allowed_actions: - action: replace allowed: true reason_code: null message: null - action: unbind allowed: true reason_code: null message: null ManagedProxySnapshot: type: object properties: freshness: $ref: '#/components/schemas/ManagedProxyFreshness' observed_at: $ref: '#/components/schemas/ManagedProxyNullableTimestamp' served_at: $ref: '#/components/schemas/ManagedProxyTimestamp' message: anyOf: - type: string - type: 'null' required: - freshness - observed_at - served_at - message additionalProperties: false ManagedProxyId: type: string description: Opaque organization-bound identifier. minLength: 1 maxLength: 128 pattern: ^[A-Za-z0-9][A-Za-z0-9_-]*$ ManagedProxyErrorDetails: type: object properties: retryable: type: boolean recovery_action: type: string resource_versions: $ref: '#/components/schemas/ManagedProxyVersionMap' device_versions: $ref: '#/components/schemas/ManagedProxyVersionMap' order_id: $ref: '#/components/schemas/ManagedProxyId' operation_id: $ref: '#/components/schemas/ManagedProxyId' required: [] additionalProperties: false ManagedProxyVersion: type: integer minimum: 1 ManagedProxyResource: type: object properties: id: $ref: '#/components/schemas/ManagedProxyId' version: $ref: '#/components/schemas/ManagedProxyVersion' name: $ref: '#/components/schemas/ManagedProxyResourceName' lifecycle: $ref: '#/components/schemas/ManagedProxyResourceLifecycle' country_code: const: US type: string egress_ip: $ref: '#/components/schemas/ManagedProxyIpAddress' service_window: $ref: '#/components/schemas/ManagedProxyServiceWindow' renewal_mode: const: manual type: string binding: $ref: '#/components/schemas/ManagedProxyBinding' acquired_order_id: $ref: '#/components/schemas/ManagedProxyId' created_at: $ref: '#/components/schemas/ManagedProxyTimestamp' updated_at: $ref: '#/components/schemas/ManagedProxyTimestamp' archived_at: $ref: '#/components/schemas/ManagedProxyNullableTimestamp' allowed_actions: type: array items: $ref: '#/components/schemas/ManagedProxyActionEligibility' expiry_disclosure: oneOf: - $ref: '#/components/schemas/ManagedProxyExpiryDisclosure' - type: 'null' description: >- Exact disclosed terms; null on historical records without captured commercial terms. required: - id - version - name - lifecycle - country_code - egress_ip - service_window - renewal_mode - binding - acquired_order_id - created_at - updated_at - archived_at - allowed_actions - expiry_disclosure additionalProperties: false examples: - id: px_demo_1 version: 7 name: US egress 01 lifecycle: active country_code: US egress_ip: 203.0.113.24 service_window: starts_at: '2026-10-01T00:00:00Z' ends_at: '2026-10-31T00:00:00Z' duration_seconds: 2592000 renewal_mode: manual binding: state: connected device_id: dev_demo_a operation_id: null observed_egress_ip: 203.0.113.24 verified_at: '2026-10-01T00:00:00Z' message: null acquired_order_id: po_demo_ready created_at: '2026-10-01T00:00:00Z' updated_at: '2026-10-01T00:00:00Z' archived_at: null allowed_actions: - action: unbind allowed: true reason_code: null message: null - action: transfer allowed: true reason_code: null message: null - action: renew allowed: true reason_code: null message: null - action: rename allowed: true reason_code: null message: null expiry_disclosure: null ManagedProxyBinding: type: object description: >- Last confirmed relationship is preserved while unknown; null observation never means direct networking is safe. properties: state: $ref: '#/components/schemas/ManagedProxyBindingState' device_id: anyOf: - $ref: '#/components/schemas/ManagedProxyId' - type: 'null' operation_id: anyOf: - $ref: '#/components/schemas/ManagedProxyId' - type: 'null' observed_egress_ip: anyOf: - $ref: '#/components/schemas/ManagedProxyIpAddress' - type: 'null' verified_at: $ref: '#/components/schemas/ManagedProxyNullableTimestamp' message: anyOf: - type: string - type: 'null' required: - state - device_id - operation_id - observed_egress_ip - verified_at - message additionalProperties: false ManagedProxyActionEligibility: type: object properties: action: type: string enum: - create_quote - create_order - checkout - cancel - change_delivery_mode - change_target_device - bind - unbind - transfer - replace - renew - rename - archive - resume - view_support allowed: type: boolean reason_code: anyOf: - type: string - type: 'null' message: anyOf: - type: string description: English reason. - type: 'null' required: - action - allowed - reason_code - message additionalProperties: false ManagedProxyFreshness: type: string enum: - fresh - stale - unavailable ManagedProxyNullableTimestamp: anyOf: - $ref: '#/components/schemas/ManagedProxyTimestamp' - type: 'null' ManagedProxyTimestamp: type: string format: date-time pattern: Z$ description: RFC3339 UTC; UI displays an explicit local timezone. ManagedProxyVersionMap: type: object maxProperties: 16 propertyNames: $ref: '#/components/schemas/ManagedProxyId' additionalProperties: $ref: '#/components/schemas/ManagedProxyVersion' description: >- Exact affected customer resource/device IDs and authoritative versions. Server validates completeness; hidden stock is guarded internally. ManagedProxyResourceName: type: string description: Trimmed; 1, 80 Unicode code points; no control characters. minLength: 1 maxLength: 80 pattern: ^[^\u0000-\u001F\u007F]+$ ManagedProxyResourceLifecycle: type: string enum: - active - expired - archived ManagedProxyIpAddress: oneOf: - type: string format: ipv4 - type: string format: ipv6 description: >- Verified egress only, never a provider endpoint. Protocol support is a separate capability. ManagedProxyServiceWindow: type: object description: Duration is integer seconds; ends_at must be after starts_at. properties: starts_at: $ref: '#/components/schemas/ManagedProxyTimestamp' ends_at: $ref: '#/components/schemas/ManagedProxyTimestamp' duration_seconds: type: integer minimum: 1 required: - starts_at - ends_at - duration_seconds additionalProperties: false ManagedProxyExpiryDisclosure: type: object description: >- Original commercial expiry terms. They do not establish device capability or authorize a network change. properties: version: type: string minLength: 1 maxLength: 128 pattern: ^[A-Za-z0-9][A-Za-z0-9_-]*$ strategy: type: string const: restore_default_network text: type: string minLength: 1 maxLength: 2000 digest: type: string pattern: ^[a-f0-9]{64}$ required: - version - strategy - text - digest additionalProperties: false ManagedProxyBindingState: type: string enum: - unbound - connecting - connected - disconnecting - changing - unavailable - unknown securitySchemes: bearerAuth: type: http scheme: bearer description: >- The control surface credential. Send `Authorization: Bearer `. Two kinds of token are accepted and they are told apart by shape, not by a separate header. A token beginning `pbk_` is an org scoped API key, whose public half and secret half are generated together and of which only a hash of the secret is ever stored; anything else is treated as an OAuth 2.1 access token and verified against the authorization server's keys. Both resolve to the same context: an org, a principal and a set of scopes. Nothing downstream branches on which channel you used, with one deliberate exception, key management, which requires a signed-in person so that a key can never mint another key. Scopes are enforced when MCP tools are REGISTERED rather than when they are called, so a tool your credential cannot use is absent from `tools/list` rather than refused mid gesture. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.