An unauthenticated liveness probe. status is the one word to branch on: ok, degraded when a background loop has stopped moving, or incident when an operator has declared one. A declared incident also carries incident.title and incident.url.
A hosted deployment running the billing loop reports one boolean for it, and nothing else about the deployment is disclosed.
GET
/
healthz
Error
A valid request URL is required to generate request examples
Deliberately terse. The backend inventory is reconnaissance material and is never reported on an unauthenticated endpoint.
ok
boolean
required
True whenever the process is serving.
service
string
required
A constant service identifier.
status
enum<string>
required
ONE WORD about the whole service, so a reader does not have to invent its own definition of down from the per subsystem booleans below. degraded means at least one of those booleans is false; incident means an operator declared one, and a declaration wins over a clean set of loops because a person can see faults this process cannot. An absent subsystem is a configuration and never counts against this word.
Available options:
ok,
degraded,
incident
incident
object
Present only while an operator has declared an incident. A half declaration (a sentence with no link) is discarded rather than published, because a banner whose link goes nowhere teaches people to ignore banners.
Show child attributes
statusPage
string
The public status page, when this deployment has one. Published so a reader links to it without hardcoding an address, and absent rather than guessed when there is none.
revision
string
The exact build this process is running, as an opaque identifier. Published because it is the only way to tell a deployment that finished from one that is still rolling, and absent when nothing was baked into the image rather than guessed at.
billing
object
Present only on a hosted deployment that runs the billing loop. viewC appears only while a billing migration is outstanding and names which way it is outstanding.
Show child attributes
frames
object
Present only where the frame retention sweep runs.
Show child attributes
webhooks
object
Present only where the webhook delivery loop runs.
Show child attributes
fulfilmentUnwind
object
Present only where the loop that unwinds a paid order that never arrived runs.
Show child attributes
fleetIntegrity
object
Whether every device this deployment sells is one the provider still has, and none of them reaches the end of its paid provider term within the alert window (72 hours by default) without being renewed. ABSENT when the verdict is unknown, which is why a reader must treat a missing key as 'not answered' and never as 'fine': staging omits it today and production does not.
Show child attributes
email
object
Whether a notification can reach a person by mail. False is a real and ordinary state: the bell still fills, and nobody is told while the console is shut. Not counted into status.
Show child attributes
cloudReadyEmail
object
Whether the worker that emails the buyer when a Cloud phone is ready is running in this process. False is the ordinary state until delivery is switched on. Not counted into status.
Show child attributes
managedAppStore
object
Hosted only. Read on every request. Never counted into status.
Show child attributes
opsAlerts
object
Whether operations alerts reach a person by email here. Never counted into status.
Show child attributes
ownerMoney
object
Hosted only. A configuration, never counted into status.
Show child attributes
staffDirectory
object
Hosted only. A configuration, never counted into status.
Show child attributes
staffOrgs
object
Hosted only. A configuration, never counted into status. A state only, never an organisation id.
Show child attributes
schedules
object
Retired: the customer-facing schedule sweeper was removed, and current builds no longer send this key. Older builds sent it; disabled there was a configuration and never degraded status.
Option 1
Option 2
Show child attributes
provisioning
object
The loop that puts a cloud phone in a customer's hands. disabled means every such order waits for a person, which is why absence is PUBLISHED here rather than left as a missing key.
Option 1
Option 2
Show child attributes
deviceTakes
object
The loop that takes a device back when a session ends without releasing it. disabled means a session that ends badly keeps its machine.
Option 1
Option 2
Show child attributes
cloudBillingScan
object
The hosted missed-Stripe-webhook Cloud billing scan. disabled means no periodic recovery pass runs on this instance.
Option 1
Option 2
Show child attributes
cloudRenewalScan
object
The hosted managed Cloud term scan. disabled means no periodic pass runs; running can be observation-only, with supplier spending and period-end billing stop separately switched off.
Option 1
Option 2
Show child attributes
tenancy
object
Deployment posture, on a hosted deployment only. Enums throughout and never a timestamp, an issuer name or a count: a reader learns which gates are armed, not when one opens.
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"PhoneUse","description":"The mobile execution layer for AI agents.","colors":{"primary":"#0c6b4f","light":"#12a06a","dark":"#0a5a43"},"logo":{"light":"https://mintcdn.com/phonebase/asSC9ooLxq3ce7AH/images/logo-light.svg?fit=max\u0026auto=format\u0026n=asSC9ooLxq3ce7AH\u0026q=85\u0026s=797a832db8f0e271d5dbd6beba29a27b","dark":"https://mintcdn.com/phonebase/asSC9ooLxq3ce7AH/images/logo-dark.svg?fit=max\u0026auto=format\u0026n=asSC9ooLxq3ce7AH\u0026q=85\u0026s=82325f8969ce89102cc6e3af558a4436","href":"https://phoneuse.com"},"favicon":"https://mintcdn.com/phonebase/asSC9ooLxq3ce7AH/images/favicon.svg?fit=max\u0026auto=format\u0026n=asSC9ooLxq3ce7AH\u0026q=85\u0026s=5aebe1e05fdad8394b3f4d54e6e75f22","appearance":{"default":"light"},"navbar":{"primary":{"type":"button","label":"Main site","href":"https://phoneuse.com"}},"footer":{"socials":{"website":"https://phoneuse.com"}},"contextual":{"options":["copy","view","claude","chatgpt","cursor","vscode","mcp"],"display":"header"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"phonebase","hasAudioNarration":false,"actualSubdomain":"phonebase","customDomains":["docs.phoneuse.com"],"gitSource":{"type":"github","owner":"phoneuse-official","repo":"phoneuse-api","deployBranch":"docs-release","contentDirectory":"docs/site","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6afd0a6c8745fb0d64fce35c","clientVersion":"0.0.4227","searchFilterCounts":[{"language":"default","tag":"API","count":158},{"language":"default","tag":"Endpoints","count":155},{"language":"default","tag":"Docs","count":34},{"language":"default","tag":"Managed Proxy","count":22},{"language":"default","tag":"Minute billing","count":22},{"language":"default","tag":"Devices","count":19},{"language":"default","tag":"Apps","count":18},{"language":"default","tag":"Provisioning","count":14},{"language":"default","tag":"API keys","count":12},{"language":"default","tag":"Copilot","count":10}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[]}
{"page":{"pagePath":"api/endpoints/health/check-that-the-service-is-up","slug":"/api/endpoints/health/check-that-the-service-is-up","pageMetadata":{"title":"Check that the service is up","description":"An unauthenticated liveness probe. `status` is the one word to branch on: `ok`, `degraded` when a background loop has stopped moving, or `incident` when an operator has declared one. A declared incident also carries `incident.title` and `incident.url`.\n\nA hosted deployment running the billing loop reports one boolean for it, and nothing else about the deployment is disclosed.","deprecated":null,"version":null,"openapi":"/api/openapi.json get /healthz","href":"/api/endpoints/health/check-that-the-service-is-up","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [\"An unauthenticated liveness probe. \", _jsx(_components.code, {\n children: \"status\"\n }), \" is the one word to branch on: \", _jsx(_components.code, {\n children: \"ok\"\n }), \", \", _jsx(_components.code, {\n children: \"degraded\"\n }), \" when a background loop has stopped moving, or \", _jsx(_components.code, {\n children: \"incident\"\n }), \" when an operator has declared one. A declared incident also carries \", _jsx(_components.code, {\n children: \"incident.title\"\n }), \" and \", _jsx(_components.code, {\n children: \"incident.url\"\n }), \".\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"A hosted deployment running the billing loop reports one boolean for it, and nothing else about the deployment is disclosed.\"\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Check that the service is up","description":"An unauthenticated liveness probe. `status` is the one word to branch on: `ok`, `degraded` when a background loop has stopped moving, or `incident` when an operator has declared one. A declared incident also carries `incident.title` and `incident.url`.\n\nA hosted deployment running the billing loop reports one boolean for it, and nothing else about the deployment is disclosed.","deprecated":null,"version":null,"openapi":"/api/openapi.json get /healthz","href":"/api/endpoints/health/check-that-the-service-is-up","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"getHealthz","tags":["Health"],"summary":"Check that the service is up","description":"An unauthenticated liveness probe. `status` is the one word to branch on: `ok`, `degraded` when a background loop has stopped moving, or `incident` when an operator has declared one. A declared incident also carries `incident.title` and `incident.url`.\n\nA hosted deployment running the billing loop reports one boolean for it, and nothing else about the deployment is disclosed.","x-phoneuse-modes":["local","hosted"],"x-phoneuse-credential":"none","security":[],"responses":{"200":"58db3bef-46af-4b46-851a-701a03db113d"},"method":"get","type":"path","servers":["0b8b9ab5-c46d-4bb8-88b0-6eeb0d5654ea"],"path":"/healthz","baseUrlOptions":["{origin}"],"title":"Check that the service is up","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"responses":{"58db3bef-46af-4b46-851a-701a03db113d":{"description":"The service is serving.","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","description":"True whenever the process is serving.","isRequired":true,"uniqueKey":"ok","typeLabel":"boolean"},"service":{"type":"string","description":"A constant service identifier.","isRequired":true,"uniqueKey":"service","typeLabel":"string"},"status":{"type":"string","enum":["ok","degraded","incident"],"description":"ONE WORD about the whole service, so a reader does not have to invent its own definition of down from the per subsystem booleans below. `degraded` means at least one of those booleans is false; `incident` means an operator declared one, and a declaration wins over a clean set of loops because a person can see faults this process cannot. An absent subsystem is a configuration and never counts against this word.","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"incident":{"type":"object","properties":{"title":{"type":"string","description":"One sentence, written by an operator, meant to be shown to a person.","isRequired":true,"uniqueKey":"incident.title","typeLabel":"string"},"url":{"type":"string","description":"Where to read more. The public status page unless something narrower was named.","isRequired":true,"uniqueKey":"incident.url","typeLabel":"string"}},"required":["title","url"],"additionalProperties":false,"description":"Present only while an operator has declared an incident. A half declaration (a sentence with no link) is discarded rather than published, because a banner whose link goes nowhere teaches people to ignore banners.","uniqueKey":"incident","typeLabel":"object"},"statusPage":{"type":"string","description":"The public status page, when this deployment has one. Published so a reader links to it without hardcoding an address, and absent rather than guessed when there is none.","uniqueKey":"statusPage","typeLabel":"string"},"revision":{"type":"string","description":"The exact build this process is running, as an opaque identifier. Published because it is the only way to tell a deployment that finished from one that is still rolling, and absent when nothing was baked into the image rather than guessed at.","uniqueKey":"revision","typeLabel":"string"},"billing":{"type":"object","properties":{"ok":{"type":"boolean","isRequired":true,"uniqueKey":"billing.ok","typeLabel":"boolean"},"viewC":{"type":"string","uniqueKey":"billing.viewC","typeLabel":"string"}},"required":["ok"],"additionalProperties":false,"description":"Present only on a hosted deployment that runs the billing loop. `viewC` appears only while a billing migration is outstanding and names which way it is outstanding.","uniqueKey":"billing","typeLabel":"object"},"frames":{"type":"object","properties":{"ok":{"type":"boolean","isRequired":true,"uniqueKey":"frames.ok","typeLabel":"boolean"}},"required":["ok"],"additionalProperties":false,"description":"Present only where the frame retention sweep runs.","uniqueKey":"frames","typeLabel":"object"},"webhooks":{"type":"object","properties":{"ok":{"type":"boolean","isRequired":true,"uniqueKey":"webhooks.ok","typeLabel":"boolean"}},"required":["ok"],"additionalProperties":false,"description":"Present only where the webhook delivery loop runs.","uniqueKey":"webhooks","typeLabel":"object"},"fulfilmentUnwind":{"type":"object","properties":{"ok":{"type":"boolean","isRequired":true,"uniqueKey":"fulfilmentUnwind.ok","typeLabel":"boolean"}},"required":["ok"],"additionalProperties":false,"description":"Present only where the loop that unwinds a paid order that never arrived runs.","uniqueKey":"fulfilmentUnwind","typeLabel":"object"},"fleetIntegrity":{"type":"object","properties":{"ok":{"type":"boolean","isRequired":true,"uniqueKey":"fleetIntegrity.ok","typeLabel":"boolean"}},"required":["ok"],"additionalProperties":false,"description":"Whether every device this deployment sells is one the provider still has, and none of them reaches the end of its paid provider term within the alert window (72 hours by default) without being renewed. ABSENT when the verdict is unknown, which is why a reader must treat a missing key as 'not answered' and never as 'fine': staging omits it today and production does not.","uniqueKey":"fleetIntegrity","typeLabel":"object"},"email":{"type":"object","properties":{"ok":{"type":"boolean","isRequired":true,"uniqueKey":"email.ok","typeLabel":"boolean"}},"required":["ok"],"additionalProperties":false,"description":"Whether a notification can reach a person by mail. False is a real and ordinary state: the bell still fills, and nobody is told while the console is shut. Not counted into `status`.","uniqueKey":"email","typeLabel":"object"},"cloudReadyEmail":{"type":"object","properties":{"enabled":{"type":"boolean","isRequired":true,"uniqueKey":"cloudReadyEmail.enabled","typeLabel":"boolean"}},"required":["enabled"],"additionalProperties":false,"description":"Whether the worker that emails the buyer when a Cloud phone is ready is running in this process. False is the ordinary state until delivery is switched on. Not counted into `status`.","uniqueKey":"cloudReadyEmail","typeLabel":"object"},"managedAppStore":{"type":"object","properties":{"state":{"type":"string","enum":["ready","unavailable","paused","disabled"],"description":"`ready`: customers can install apps from the managed App Store here. `paused`: an operator switched new installs off (`PHONEBASE_MANAGED_APP_STORE_PAUSED=true`); installs already sent are still confirmed. `unavailable`: see `reason`. `disabled`: Apps is not configured on this deployment.","isRequired":true,"uniqueKey":"managedAppStore.state","typeLabel":"enum\u003cstring>"},"reason":{"type":"string","enum":["not_ready","worker_stopped"],"description":"Only with `unavailable`. `not_ready`: a database readiness check failed at startup (the startup log line `managed_app_store_readiness` names it). `worker_stopped`: the install worker is not running.","uniqueKey":"managedAppStore.reason","typeLabel":"enum\u003cstring>"}},"required":["state"],"additionalProperties":false,"description":"Hosted only. Read on every request. Never counted into `status`.","uniqueKey":"managedAppStore","typeLabel":"object"},"opsAlerts":{"type":"object","properties":{"state":{"type":"string","enum":["configured","partial","unconfigured","unavailable"],"description":"`configured`: operations alerts are mailed to the on-call list, or to the staff organization's admins. `unconfigured`: nothing alert-specific is set, an ordinary configuration. `partial`: somebody set part of it, so alerts are recorded and shown on the operations console and `reasons` says what is missing. `unavailable`: the database has no alert tables yet, so no alert is recorded or mailed at all (red for operations; still never counted into `status`).","isRequired":true,"uniqueKey":"opsAlerts.state","typeLabel":"enum\u003cstring>"},"reasons":{"type":"array","items":{"type":"string","enum":["not_hosted","email_sender","recipient_directory","staff_org_id","on_call_list_unusable","on_call_list_entries_dropped","alert_tables_missing"],"description":"What is missing or unusable, by name. Never an address or a value.","uniqueKey":"opsAlerts.reasons.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"Empty when `state` is `configured`.","isRequired":true,"uniqueKey":"opsAlerts.reasons","typeLabel":"enum\u003cstring>[]"}},"required":["state","reasons"],"additionalProperties":false,"description":"Whether operations alerts reach a person by email here. Never counted into `status`.","uniqueKey":"opsAlerts","typeLabel":"object"},"ownerMoney":{"type":"object","properties":{"state":{"type":"string","enum":["configured","unconfigured","refused_live_key_on_staging","refused_environment_undeclared"],"description":"Whether the owner's refund from the operator surface may move money here. `refused_live_key_on_staging`: this deployment says it is staging and holds a live payment key, so the refund is refused. `refused_environment_undeclared`: a live key on a deployment that does not say which it is.","isRequired":true,"uniqueKey":"ownerMoney.state","typeLabel":"enum\u003cstring>"}},"required":["state"],"additionalProperties":false,"description":"Hosted only. A configuration, never counted into `status`.","uniqueKey":"ownerMoney","typeLabel":"object"},"staffDirectory":{"type":"object","properties":{"state":{"type":"string","enum":["configured","unconfigured","partial"],"description":"Whether staff management from the operator surface can reach the identity provider. `partial`: keys are configured and none can be matched to the staff organisation, so staff management is refused.","isRequired":true,"uniqueKey":"staffDirectory.state","typeLabel":"enum\u003cstring>"}},"required":["state"],"additionalProperties":false,"description":"Hosted only. A configuration, never counted into `status`.","uniqueKey":"staffDirectory","typeLabel":"object"},"staffOrgs":{"type":"object","properties":{"state":{"type":"string","enum":["configured","unconfigured","unbound","misconfigured"],"description":"Whether anybody can be admitted to the operator surface. `configured`: the staff organisations are each bound to an identity provider instance this deployment trusts. `unconfigured`: none is set, so nobody is staff by choice. `unbound`: one is set without its instance while several instances or none are trusted, so nobody is staff and every operator call is answered 404 until it names its instance. `misconfigured`: at least one entry was malformed and left out at startup (the startup log says which and why); the others still admit their staff, unless the one left out was the first, in which case nobody is staff.","isRequired":true,"uniqueKey":"staffOrgs.state","typeLabel":"enum\u003cstring>"}},"required":["state"],"additionalProperties":false,"description":"Hosted only. A configuration, never counted into `status`. A state only, never an organisation id.","uniqueKey":"staffOrgs","typeLabel":"object"},"schedules":{"oneOf":[{"type":"object","description":"Retired: the customer-facing schedule sweeper was removed, and current builds no longer send this key. Older builds sent it; `disabled` there was a configuration and never degraded `status`.","required":["state"],"properties":{"state":{"type":"string","enum":["disabled"],"isRequired":true,"uniqueKey":"schedules.oneOf.0.state","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"schedules.oneOf.0","typeLabel":"object"},{"type":"object","description":"Retired: the customer-facing schedule sweeper was removed, and current builds no longer send this key. Older builds sent it; `disabled` there was a configuration and never degraded `status`.","required":["state","ok"],"properties":{"state":{"type":"string","enum":["running"],"isRequired":true,"uniqueKey":"schedules.oneOf.1.state","typeLabel":"enum\u003cstring>"},"ok":{"type":"boolean","isRequired":true,"uniqueKey":"schedules.oneOf.1.ok","typeLabel":"boolean"}},"additionalProperties":false,"uniqueKey":"schedules.oneOf.1","typeLabel":"object"}],"uniqueKey":"schedules","typeLabel":"object"},"provisioning":{"oneOf":[{"type":"object","description":"The loop that puts a cloud phone in a customer's hands. `disabled` means every such order waits for a person, which is why absence is PUBLISHED here rather than left as a missing key.","required":["state"],"properties":{"state":{"type":"string","enum":["disabled"],"isRequired":true,"uniqueKey":"provisioning.oneOf.0.state","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"provisioning.oneOf.0","typeLabel":"object"},{"type":"object","description":"The loop that puts a cloud phone in a customer's hands. `disabled` means every such order waits for a person, which is why absence is PUBLISHED here rather than left as a missing key.","required":["state","ok"],"properties":{"state":{"type":"string","enum":["running"],"isRequired":true,"uniqueKey":"provisioning.oneOf.1.state","typeLabel":"enum\u003cstring>"},"ok":{"type":"boolean","isRequired":true,"uniqueKey":"provisioning.oneOf.1.ok","typeLabel":"boolean"}},"additionalProperties":false,"uniqueKey":"provisioning.oneOf.1","typeLabel":"object"}],"uniqueKey":"provisioning","typeLabel":"object"},"deviceTakes":{"oneOf":[{"type":"object","description":"The loop that takes a device back when a session ends without releasing it. `disabled` means a session that ends badly keeps its machine.","required":["state"],"properties":{"state":{"type":"string","enum":["disabled"],"isRequired":true,"uniqueKey":"deviceTakes.oneOf.0.state","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"deviceTakes.oneOf.0","typeLabel":"object"},{"type":"object","description":"The loop that takes a device back when a session ends without releasing it. `disabled` means a session that ends badly keeps its machine.","required":["state","ok"],"properties":{"state":{"type":"string","enum":["running"],"isRequired":true,"uniqueKey":"deviceTakes.oneOf.1.state","typeLabel":"enum\u003cstring>"},"ok":{"type":"boolean","isRequired":true,"uniqueKey":"deviceTakes.oneOf.1.ok","typeLabel":"boolean"}},"additionalProperties":false,"uniqueKey":"deviceTakes.oneOf.1","typeLabel":"object"}],"uniqueKey":"deviceTakes","typeLabel":"object"},"cloudBillingScan":{"oneOf":[{"type":"object","description":"The hosted missed-Stripe-webhook Cloud billing scan. `disabled` means no periodic recovery pass runs on this instance.","required":["state"],"properties":{"state":{"type":"string","enum":["disabled"],"isRequired":true,"uniqueKey":"cloudBillingScan.oneOf.0.state","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"cloudBillingScan.oneOf.0","typeLabel":"object"},{"type":"object","description":"The hosted missed-Stripe-webhook Cloud billing scan. `disabled` means no periodic recovery pass runs on this instance.","required":["state","ok"],"properties":{"state":{"type":"string","enum":["running"],"isRequired":true,"uniqueKey":"cloudBillingScan.oneOf.1.state","typeLabel":"enum\u003cstring>"},"ok":{"type":"boolean","isRequired":true,"uniqueKey":"cloudBillingScan.oneOf.1.ok","typeLabel":"boolean"}},"additionalProperties":false,"uniqueKey":"cloudBillingScan.oneOf.1","typeLabel":"object"}],"uniqueKey":"cloudBillingScan","typeLabel":"object"},"cloudRenewalScan":{"oneOf":[{"type":"object","description":"The hosted managed Cloud term scan. `disabled` means no periodic pass runs; `running` can be observation-only, with supplier spending and period-end billing stop separately switched off.","required":["state"],"properties":{"state":{"type":"string","enum":["disabled"],"isRequired":true,"uniqueKey":"cloudRenewalScan.oneOf.0.state","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"cloudRenewalScan.oneOf.0","typeLabel":"object"},{"type":"object","description":"The hosted managed Cloud term scan. `disabled` means no periodic pass runs; `running` can be observation-only, with supplier spending and period-end billing stop separately switched off.","required":["state","ok"],"properties":{"state":{"type":"string","enum":["running"],"isRequired":true,"uniqueKey":"cloudRenewalScan.oneOf.1.state","typeLabel":"enum\u003cstring>"},"ok":{"type":"boolean","isRequired":true,"uniqueKey":"cloudRenewalScan.oneOf.1.ok","typeLabel":"boolean"}},"additionalProperties":false,"uniqueKey":"cloudRenewalScan.oneOf.1","typeLabel":"object"}],"uniqueKey":"cloudRenewalScan","typeLabel":"object"},"tenancy":{"type":"object","properties":{"checkout":{"type":"object","properties":{"state":{"type":"string","enum":["open","closed","unconfigured"],"description":"Whether the purchase surface is open, shut on purpose, or has never been configured. Shut and never-configured are the same absent settings, so they are told apart here rather than guessed at.","isRequired":true,"uniqueKey":"tenancy.checkout.state","typeLabel":"enum\u003cstring>"},"mode":{"type":"string","enum":["test","live","unknown"],"description":"Whether the purchase surface moves real money. Read off the payment provider key the deployment holds, so a deployment cannot declare one and charge the other. `unknown` means there is no key, or one whose shape this service does not recognise; a reader showing a test-mode notice must show it for `test` alone.","isRequired":true,"uniqueKey":"tenancy.checkout.mode","typeLabel":"enum\u003cstring>"},"cloudPhone":{"type":"string","enum":["priced","unpriced","withheld"],"description":"Whether Cloud phone prices are configured and available on this till. `withheld` means prices were configured but the live Cloud phone billing interlock removed them while supplier renewal and Stripe reconciliation are incomplete. The generic till may still be `open`.","uniqueKey":"tenancy.checkout.cloudPhone","typeLabel":"enum\u003cstring>"}},"required":["state","mode"],"additionalProperties":false,"isRequired":true,"uniqueKey":"tenancy.checkout","typeLabel":"object"}},"required":["checkout"],"description":"Deployment posture, on a hosted deployment only. Enums throughout and never a timestamp, an issuer name or a count: a reader learns which gates are armed, not when one opens.","uniqueKey":"tenancy","typeLabel":"object"}},"required":["ok","service","status"],"additionalProperties":false,"description":"Deliberately terse. The backend inventory is reconnaissance material and is never reported on an unauthenticated endpoint.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"ok":true,"service":"\u003cstring>","status":"ok","incident":{"title":"\u003cstring>","url":"\u003cstring>"},"statusPage":"\u003cstring>","revision":"\u003cstring>","billing":{"ok":true,"viewC":"\u003cstring>"},"frames":{"ok":true},"webhooks":{"ok":true},"fulfilmentUnwind":{"ok":true},"fleetIntegrity":{"ok":true},"email":{"ok":true},"cloudReadyEmail":{"enabled":true},"managedAppStore":{"state":"ready","reason":"not_ready"},"opsAlerts":{"state":"configured","reasons":["not_hosted"]},"ownerMoney":{"state":"configured"},"staffDirectory":{"state":"configured"},"staffOrgs":{"state":"configured"},"schedules":{"state":"disabled"},"provisioning":{"state":"disabled"},"deviceTakes":{"state":"disabled"},"cloudBillingScan":{"state":"disabled"},"cloudRenewalScan":{"state":"disabled"},"tenancy":{"checkout":{"state":"open","mode":"test","cloudPhone":"priced"}}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{},"servers":{"0b8b9ab5-c46d-4bb8-88b0-6eeb0d5654ea":{"url":"{origin}","description":"Your control plane origin.","variables":{"origin":{"default":"https://mcp.phoneuse.com","enum":["https://mcp.phoneuse.com","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."}}}}},"originalFileLocation":"api/openapi.json"},"subdomain":"phonebase","siteName":"PhoneUse","title":"Check that the service is up - PhoneUse","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-30T04:26:05.904Z","originalFileLocation":"api/endpoints/health/check-that-the-service-is-up.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"An unauthenticated liveness probe. status is the one word to branch on: ok, degraded when a background loop has stopped moving, or incident when an operator has declared one. A declared incident also carries incident.title and incident.url. A hosted deployment running the billing loop reports one boolean for it, and nothing else about the deployment is disclosed.\">\u003cmeta data-mint-head name=\"application-name\" content=\"PhoneUse\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/phonebase/kWipq_KjnF--s93A/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/phonebase/kWipq_KjnF--s93A/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/phonebase/kWipq_KjnF--s93A/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/phonebase/kWipq_KjnF--s93A/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/phonebase/kWipq_KjnF--s93A/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/phonebase/kWipq_KjnF--s93A/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/phonebase/kWipq_KjnF--s93A/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/phonebase/kWipq_KjnF--s93A/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/phonebase/kWipq_KjnF--s93A/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Check that the service is up - PhoneUse\">\u003cmeta data-mint-head property=\"og:description\" content=\"An unauthenticated liveness probe. status is the one word to branch on: ok, degraded when a background loop has stopped moving, or incident when an operator has declared one. A declared incident also carries incident.title and incident.url. A hosted deployment running the billing loop reports one boolean for it, and nothing else about the deployment is disclosed.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"PhoneUse\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.phoneuse.com/api/endpoints/health/check-that-the-service-is-up\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://phonebase.mintlify.site/_mintlify/api/og/v2?division=Health\u0026amp;title=Check+that+the+service+is+up\u0026amp;description=An+unauthenticated+liveness+probe.+%60status%60+is+the+one+word+to+branch+on%3A+%60ok%60%2C+%60degraded%60+when+a+background+loop+has+stopped+moving%2C+or+%60incident%60+when+an+oper\u0026amp;theme=370fb2999dfbb8f85a217f41\u0026amp;signature=af4745a6f03478060c980968ba58e65f941cbf5ec87113bcbc17f4124f381e83\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Check that the service is up - PhoneUse\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"An unauthenticated liveness probe. status is the one word to branch on: ok, degraded when a background loop has stopped moving, or incident when an operator has declared one. A declared incident also carries incident.title and incident.url. A hosted deployment running the billing loop reports one boolean for it, and nothing else about the deployment is disclosed.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://phonebase.mintlify.site/_mintlify/api/og/v2?division=Health\u0026amp;title=Check+that+the+service+is+up\u0026amp;description=An+unauthenticated+liveness+probe.+%60status%60+is+the+one+word+to+branch+on%3A+%60ok%60%2C+%60degraded%60+when+a+background+loop+has+stopped+moving%2C+or+%60incident%60+when+an+oper\u0026amp;theme=370fb2999dfbb8f85a217f41\u0026amp;signature=af4745a6f03478060c980968ba58e65f941cbf5ec87113bcbc17f4124f381e83\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/phonebase/kWipq_KjnF--s93A/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"PhoneUse\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0c6b4f\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.phoneuse.com/api/endpoints/health/check-that-the-service-is-up\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api/endpoints/health/check-that-the-service-is-up.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.phoneuse.com/#organization\",\"name\":\"PhoneUse\",\"url\":\"https://docs.phoneuse.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/phonebase/asSC9ooLxq3ce7AH/images/logo-light.svg?fit=max\u0026auto=format\u0026n=asSC9ooLxq3ce7AH\u0026q=85\u0026s=797a832db8f0e271d5dbd6beba29a27b\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.phoneuse.com#website\",\"name\":\"PhoneUse\",\"url\":\"https://docs.phoneuse.com\",\"publisher\":{\"@id\":\"https://docs.phoneuse.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.phoneuse.com/api/endpoints/health/check-that-the-service-is-up#webpage\",\"url\":\"https://docs.phoneuse.com/api/endpoints/health/check-that-the-service-is-up\",\"name\":\"Check that the service is up\",\"description\":\"An unauthenticated liveness probe. status is the one word to branch on: ok, degraded when a background loop has stopped moving, or incident when an operator has declared one. A declared incident also carries incident.title and incident.url. A hosted deployment running the billing loop reports one boolean for it, and nothing else about the deployment is disclosed.\",\"dateModified\":\"2026-10-30T04:26:05.904Z\",\"isPartOf\":{\"@id\":\"https://docs.phoneuse.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.phoneuse.com/api/endpoints/health/check-that-the-service-is-up#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.phoneuse.com/api/endpoints/health/check-that-the-service-is-up#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"PhoneUse\",\"item\":\"https://docs.phoneuse.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Check that the service is up\",\"item\":\"https://docs.phoneuse.com/api/endpoints/health/check-that-the-service-is-up\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.phoneuse.com/api/endpoints/health/check-that-the-service-is-up#apireference\",\"headline\":\"Check that the service is up\",\"name\":\"Check that the service is up\",\"description\":\"An unauthenticated liveness probe. status is the one word to branch on: ok, degraded when a background loop has stopped moving, or incident when an operator has declared one. A declared incident also carries incident.title and incident.url. A hosted deployment running the billing loop reports one boolean for it, and nothing else about the deployment is disclosed.\",\"url\":\"https://docs.phoneuse.com/api/endpoints/health/check-that-the-service-is-up\",\"mainEntityOfPage\":{\"@id\":\"https://docs.phoneuse.com/api/endpoints/health/check-that-the-service-is-up#webpage\"},\"dateModified\":\"2026-10-30T04:26:05.904Z\",\"publisher\":{\"@id\":\"https://docs.phoneuse.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.phoneuse.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"PhoneUse\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"PhoneUse\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api/endpoints/health/check-that-the-service-is-up.md","siteName":"PhoneUse","nav":{"global":null,"tabs":[{"tab":"Docs","pages":[{"title":"Docs","href":""}]},{"tab":"API","groups":[{"group":"Overview","pages":[{"title":"API overview","href":"/api"},{"title":"Versioning and compatibility","href":"/api/versioning"},{"title":"Rate limits","description":"Three budgets, one refusal shape, and the headers that tell you where you stand.","href":"/api/rate-limits"}]},{"group":"Endpoints","pages":[{"group":"Health","pages":[{"title":"Check that the service is up","deprecated":null,"version":null,"openapi":"/api/openapi.json get /healthz","href":"/api/endpoints/health/check-that-the-service-is-up"}]},{"group":"Device surface","pages":[{"title":"Check the run's device channel","description":"Confirms the run is live and its channel is serving.\n\nThis operation reads no `Authorization` header. The run token in the path IS the credential, so the whole url is secret: never log it, paste it, or commit it. Every example writes `{runToken}` for that reason.","deprecated":null,"version":null,"openapi":"/api/openapi.json get /vrx/{runToken}/v1/health","href":"/api/endpoints/device-surface/check-the-runs-device-channel"},{"title":"List the run's device","deprecated":null,"version":null,"openapi":"/api/openapi.json get /vrx/{runToken}/v1/devices","href":"/api/endpoints/device-surface/list-the-runs-device"},{"title":"Fetch a frame","deprecated":null,"version":null,"openapi":"/api/openapi.json get /vrx/{runToken}/v1/devices/{deviceId}/screenshot","href":"/api/endpoints/device-surface/fetch-a-frame"},{"title":"Report the run's outcome","deprecated":null,"version":null,"openapi":"/api/openapi.json post /vrx/{runToken}/v1/report","href":"/api/endpoints/device-surface/report-the-runs-outcome"},{"title":"Act on the device","deprecated":null,"version":null,"openapi":"/api/openapi.json post /vrx/{runToken}/v1/devices/{deviceId}/actions","href":"/api/endpoints/device-surface/act-on-the-device"}]},{"group":"MCP","pages":[{"title":"Why there is no event stream","deprecated":null,"version":null,"openapi":"/api/openapi.json get /mcp","href":"/api/endpoints/mcp/why-there-is-no-event-stream"},{"title":"Send a JSON-RPC request","deprecated":null,"version":null,"openapi":"/api/openapi.json post /mcp","href":"/api/endpoints/mcp/send-a-json-rpc-request"},{"title":"Why there is no session to end","deprecated":null,"version":null,"openapi":"/api/openapi.json delete /mcp","href":"/api/endpoints/mcp/why-there-is-no-session-to-end"}]},{"group":"Apps","pages":[{"title":"Discover visible devices and authoritative application scopes","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/app-library/device-capabilities","href":"/api/endpoints/apps/discover-visible-devices-and-authoritative-application-scopes"},{"title":"Read last confirmed phone apps","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/app-library/inventory","href":"/api/endpoints/apps/read-last-confirmed-phone-apps"},{"title":"Request bounded read-only application checks","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/app-library/inventory/refreshes","href":"/api/endpoints/apps/request-bounded-read-only-application-checks"},{"title":"Read application-check progress","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/app-library/inventory/refreshes/{refreshId}","href":"/api/endpoints/apps/read-application-check-progress"},{"title":"Read per-device check outcomes","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/app-library/inventory/refreshes/{refreshId}/results","href":"/api/endpoints/apps/read-per-device-check-outcomes"},{"title":"Recover a lost mutation response by original key","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/app-library/requests/{requestKey}","href":"/api/endpoints/apps/recover-a-lost-mutation-response-by-original-key"},{"title":"List installable apps","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/app-store/catalog","href":"/api/endpoints/apps/list-installable-apps"},{"title":"Read installation history","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/app-store/installations","href":"/api/endpoints/apps/read-installation-history"},{"title":"Install an app","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/app-store/installations","href":"/api/endpoints/apps/install-an-app"},{"title":"Recover an app installation","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/app-store/installations/by-request/{requestKey}","href":"/api/endpoints/apps/recover-an-app-installation"},{"title":"Check an app installation","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/app-store/installations/{installationId}","href":"/api/endpoints/apps/check-an-app-installation"},{"title":"Check an app installation again","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/app-store/installations/{installationId}/recheck","href":"/api/endpoints/apps/check-an-app-installation-again"},{"title":"Skip checking an unconfirmed installation","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/app-store/installations/{installationId}/skip","href":"/api/endpoints/apps/skip-checking-an-unconfirmed-installation"},{"title":"Read a phone's install queue","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/app-store/queue","href":"/api/endpoints/apps/read-a-phones-install-queue"},{"title":"Add an app to a phone's install queue","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/app-store/queue","href":"/api/endpoints/apps/add-an-app-to-a-phones-install-queue"},{"title":"Recover a queued app by its request key","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/app-store/queue/by-request/{requestKey}","href":"/api/endpoints/apps/recover-a-queued-app-by-its-request-key"},{"title":"Remove a waiting app from a phone's queue","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/app-store/queue/{entryId}/remove","href":"/api/endpoints/apps/remove-a-waiting-app-from-a-phones-queue"},{"title":"Pause or resume a phone's install queue","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/app-store/queue/pause","href":"/api/endpoints/apps/pause-or-resume-a-phones-install-queue"}]},{"group":"Runs","pages":[{"title":"Get a short-lived URL for one archived frame","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/frames/{frameId}","href":"/api/endpoints/runs/get-a-short-lived-url-for-one-archived-frame"},{"title":"List your runs","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/runs","href":"/api/endpoints/runs/list-your-runs"},{"title":"Start a run on a device","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/runs","href":"/api/endpoints/runs/start-a-run-on-a-device"},{"title":"Read a run, optionally waiting for it to move","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/runs/{runId}","href":"/api/endpoints/runs/read-a-run-optionally-waiting-for-it-to-move"},{"title":"Put a run on hold","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/runs/{runId}/pause","href":"/api/endpoints/runs/put-a-run-on-hold"},{"title":"Lift a stop and let the run carry on","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/runs/{runId}/resume","href":"/api/endpoints/runs/lift-a-stop-and-let-the-run-carry-on"},{"title":"Cancel a run","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/runs/{runId}/cancel","href":"/api/endpoints/runs/cancel-a-run"}]},{"group":"Discovery","pages":[{"title":"Discover where to authenticate","deprecated":null,"version":null,"openapi":"/api/openapi.json get /.well-known/oauth-protected-resource","href":"/api/endpoints/discovery/discover-where-to-authenticate"},{"title":"Discover where to authenticate, at the endpoint suffixed path","deprecated":null,"version":null,"openapi":"/api/openapi.json get /.well-known/oauth-protected-resource/mcp","href":"/api/endpoints/discovery/discover-where-to-authenticate-at-the-endpoint-suffixed-path"}]},{"group":"API keys","pages":[{"title":"List the org's keys","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/api-keys","href":"/api/endpoints/api-keys/list-the-orgs-keys"},{"title":"Mint an API key","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/api-keys","href":"/api/endpoints/api-keys/mint-an-api-key"},{"title":"Describe the calling key","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/api-keys/current","href":"/api/endpoints/api-keys/describe-the-calling-key"},{"title":"Revoke the calling key","deprecated":null,"version":null,"openapi":"/api/openapi.json delete /v1/api-keys/current","href":"/api/endpoints/api-keys/revoke-the-calling-key"},{"title":"Revoke a key","deprecated":null,"version":null,"openapi":"/api/openapi.json delete /v1/api-keys/{id}","href":"/api/endpoints/api-keys/revoke-a-key"},{"title":"Rename, renew or narrow a key","deprecated":null,"version":null,"openapi":"/api/openapi.json patch /v1/api-keys/{id}","href":"/api/endpoints/api-keys/rename-renew-or-narrow-a-key"},{"title":"Rotate a key","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/api-keys/{id}/rotate","href":"/api/endpoints/api-keys/rotate-a-key"},{"title":"Start a CLI sign-in","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/cli-sessions","href":"/api/endpoints/api-keys/start-a-cli-sign-in"},{"title":"Poll a CLI sign-in, and collect its key","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/cli-sessions/token","href":"/api/endpoints/api-keys/poll-a-cli-sign-in-and-collect-its-key"},{"title":"Look at a CLI sign-in before approving it","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/cli-sessions/{userCode}","href":"/api/endpoints/api-keys/look-at-a-cli-sign-in-before-approving-it"},{"title":"Approve a CLI sign-in","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/cli-sessions/{userCode}/approve","href":"/api/endpoints/api-keys/approve-a-cli-sign-in"},{"title":"Deny a CLI sign-in","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/cli-sessions/{userCode}/deny","href":"/api/endpoints/api-keys/deny-a-cli-sign-in"}]},{"group":"Usage","pages":[{"title":"List your org's receipts","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/receipts","href":"/api/endpoints/usage/list-your-orgs-receipts"},{"title":"Read one receipt","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/receipts/{idempotencyKey}","href":"/api/endpoints/usage/read-one-receipt"},{"title":"Mark a receipt reviewed","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/receipts/{idempotencyKey}/reviewed","href":"/api/endpoints/usage/mark-a-receipt-reviewed"},{"title":"List a phone's unclear actions","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/devices/{deviceId}/unclear-actions","href":"/api/endpoints/usage/list-a-phones-unclear-actions"},{"title":"Confirm a phone looks right","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/devices/{deviceId}/unclear-actions/confirm","href":"/api/endpoints/usage/confirm-a-phone-looks-right"},{"title":"Read your org's usage this period","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/usage","href":"/api/endpoints/usage/read-your-orgs-usage-this-period"}]},{"group":"Devices","pages":[{"title":"Small pictures of several devices' screens","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/device-thumbnails","href":"/api/endpoints/devices/small-pictures-of-several-devices-screens"},{"title":"List the devices you can see","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/devices","href":"/api/endpoints/devices/list-the-devices-you-can-see"},{"title":"Read one device","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/devices/{deviceId}","href":"/api/endpoints/devices/read-one-device"},{"title":"Rename a device","deprecated":null,"version":null,"openapi":"/api/openapi.json patch /v1/devices/{deviceId}","href":"/api/endpoints/devices/rename-a-device"},{"title":"Look at a device's screen","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/devices/{deviceId}/screenshot","href":"/api/endpoints/devices/look-at-a-devices-screen"},{"title":"Live video fault observation","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/devices/{deviceId}/image-maintenance/fault","href":"/api/endpoints/devices/live-video-fault-observation"},{"title":"Saved recovery plan cancellation","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/devices/{deviceId}/image-maintenance/cancel","href":"/api/endpoints/devices/saved-recovery-plan-cancellation"},{"title":"Original recovery result recheck","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/devices/{deviceId}/image-maintenance/recheck","href":"/api/endpoints/devices/original-recovery-result-recheck"},{"title":"Image recovery progress and availability","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/devices/{deviceId}/image-maintenance","href":"/api/endpoints/devices/image-recovery-progress-and-availability"},{"title":"Take a device","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/devices/{deviceId}/lease","href":"/api/endpoints/devices/take-a-device"},{"title":"Give a device back","deprecated":null,"version":null,"openapi":"/api/openapi.json delete /v1/devices/{deviceId}/lease","href":"/api/endpoints/devices/give-a-device-back"},{"title":"Keep a device longer","deprecated":null,"version":null,"openapi":"/api/openapi.json patch /v1/devices/{deviceId}/lease","href":"/api/endpoints/devices/keep-a-device-longer"},{"title":"Act on a device","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/devices/{deviceId}/actions","href":"/api/endpoints/devices/act-on-a-device"},{"title":"Who is driving a device","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/devices/{deviceId}/driving","href":"/api/endpoints/devices/who-is-driving-a-device"},{"title":"Open a live video session on a device","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/devices/{deviceId}/live-session","href":"/api/endpoints/devices/open-a-live-video-session-on-a-device"},{"title":"Wake a device's screen","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/devices/{deviceId}/wake","href":"/api/endpoints/devices/wake-a-devices-screen"},{"title":"Open a live view of a device","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/devices/{deviceId}/stream","href":"/api/endpoints/devices/open-a-live-view-of-a-device"},{"title":"Read the server's clock","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/time","href":"/api/endpoints/devices/read-the-servers-clock"},{"title":"List the devices your organisation currently holds","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/leases","href":"/api/endpoints/devices/list-the-devices-your-organisation-currently-holds"}]},{"group":"Copilot","pages":[{"title":"Ask the copilot","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/copilot","href":"/api/endpoints/copilot/ask-the-copilot"},{"title":"Answer a copilot approval","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/copilot/approvals","href":"/api/endpoints/copilot/answer-a-copilot-approval"},{"title":"Run one tool the person named","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/copilot/commands","href":"/api/endpoints/copilot/run-one-tool-the-person-named"},{"title":"Stop the turn this thread is running","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/copilot/threads/{id}/stop","href":"/api/endpoints/copilot/stop-the-turn-this-thread-is-running"},{"title":"Pick a cut copilot stream back up","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/copilot/threads/{id}/stream","href":"/api/endpoints/copilot/pick-a-cut-copilot-stream-back-up"},{"title":"Your copilot threads","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/copilot/threads","href":"/api/endpoints/copilot/your-copilot-threads"},{"title":"One thread, with a page of its messages","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/copilot/threads/{id}","href":"/api/endpoints/copilot/one-thread-with-a-page-of-its-messages"},{"title":"Delete a thread","deprecated":null,"version":null,"openapi":"/api/openapi.json delete /v1/copilot/threads/{id}","href":"/api/endpoints/copilot/delete-a-thread"},{"title":"Rename a thread","deprecated":null,"version":null,"openapi":"/api/openapi.json patch /v1/copilot/threads/{id}","href":"/api/endpoints/copilot/rename-a-thread"}]},{"group":"Webhooks","pages":[{"title":"Your webhook subscriptions","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/webhooks","href":"/api/endpoints/webhooks/your-webhook-subscriptions"},{"title":"Subscribe your system to what happens here","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/webhooks","href":"/api/endpoints/webhooks/subscribe-your-system-to-what-happens-here"},{"title":"Remove a subscription","deprecated":null,"version":null,"openapi":"/api/openapi.json delete /v1/webhooks/{webhookId}","href":"/api/endpoints/webhooks/remove-a-subscription"},{"title":"Enable or disable a subscription","deprecated":null,"version":null,"openapi":"/api/openapi.json patch /v1/webhooks/{webhookId}","href":"/api/endpoints/webhooks/enable-or-disable-a-subscription"},{"title":"Replace a signing secret","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/webhooks/{webhookId}/rotate","href":"/api/endpoints/webhooks/replace-a-signing-secret"},{"title":"Send a test delivery","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/webhooks/{webhookId}/test","href":"/api/endpoints/webhooks/send-a-test-delivery"},{"title":"What was delivered, and what happened","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/webhooks/{webhookId}/deliveries","href":"/api/endpoints/webhooks/what-was-delivered-and-what-happened"}]},{"group":"Robot purchases","pages":[{"title":"List your robot purchases","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/robot-purchases","href":"/api/endpoints/robot-purchases/list-your-robot-purchases"},{"title":"Read the monthly robot checkout offer","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/robot-purchases/offer","href":"/api/endpoints/robot-purchases/read-the-monthly-robot-checkout-offer"},{"title":"Open the original monthly robot checkout","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/robot-purchases/checkout","href":"/api/endpoints/robot-purchases/open-the-original-monthly-robot-checkout"},{"title":"Read your initial robot purchase receipt","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/robot-purchases/{orderId}","href":"/api/endpoints/robot-purchases/read-your-initial-robot-purchase-receipt"}]},{"group":"Managed Proxy","pages":[{"title":"Quote a multi-unit Proxy purchase","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/proxy-purchase-quotes","href":"/api/endpoints/managed-proxy/quote-a-multi-unit-proxy-purchase"},{"title":"Read the original purchase agreement","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/proxy-purchase-quotes/{quoteId}","href":"/api/endpoints/managed-proxy/read-the-original-purchase-agreement"},{"title":"Accept the original multi-unit purchase agreement","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/proxy-purchases","href":"/api/endpoints/managed-proxy/accept-the-original-multi-unit-purchase-agreement"},{"title":"Read unit delivery and original payment facts","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/proxy-purchases/{purchaseId}","href":"/api/endpoints/managed-proxy/read-unit-delivery-and-original-payment-facts"},{"title":"Cancel original undelivered units","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/proxy-purchases/{purchaseId}/cancel","href":"/api/endpoints/managed-proxy/cancel-original-undelivered-units"},{"title":"List managed Proxy products","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/proxy-products","href":"/api/endpoints/managed-proxy/list-managed-proxy-products"},{"title":"Read a managed Proxy product","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/proxy-products/{productId}","href":"/api/endpoints/managed-proxy/read-a-managed-proxy-product"},{"title":"Quote a managed Proxy purchase","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/proxy-quotes","href":"/api/endpoints/managed-proxy/quote-a-managed-proxy-purchase"},{"title":"Read the original quote","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/proxy-quotes/{quoteId}","href":"/api/endpoints/managed-proxy/read-the-original-quote"},{"title":"List your Proxy orders","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/proxy-orders","href":"/api/endpoints/managed-proxy/list-your-proxy-orders"},{"title":"Reserve a quoted Proxy order","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/proxy-orders","href":"/api/endpoints/managed-proxy/reserve-a-quoted-proxy-order"},{"title":"Read a Proxy order and its settlement","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/proxy-orders/{orderId}","href":"/api/endpoints/managed-proxy/read-a-proxy-order-and-its-settlement"},{"title":"Request hosted Checkout for an order","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/proxy-orders/{orderId}/checkout","href":"/api/endpoints/managed-proxy/request-hosted-checkout-for-an-order"},{"title":"Cancel a Proxy order","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/proxy-orders/{orderId}/cancel","href":"/api/endpoints/managed-proxy/cancel-a-proxy-order"},{"title":"List your managed Proxies","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/proxies","href":"/api/endpoints/managed-proxy/list-your-managed-proxies"},{"title":"Read a managed Proxy","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/proxies/{proxyId}","href":"/api/endpoints/managed-proxy/read-a-managed-proxy"},{"title":"Rename a managed Proxy","deprecated":null,"version":null,"openapi":"/api/openapi.json patch /v1/proxies/{proxyId}","href":"/api/endpoints/managed-proxy/rename-a-managed-proxy"},{"title":"Archive an expired detached Proxy","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/proxies/{proxyId}/archive","href":"/api/endpoints/managed-proxy/archive-an-expired-detached-proxy"},{"title":"List your Proxy network operations","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/proxy-operations","href":"/api/endpoints/managed-proxy/list-your-proxy-network-operations"},{"title":"Connect or disconnect a Proxy","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/proxy-operations","href":"/api/endpoints/managed-proxy/connect-or-disconnect-a-proxy"},{"title":"Read a Proxy operation","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/proxy-operations/{operationId}","href":"/api/endpoints/managed-proxy/read-a-proxy-operation"},{"title":"Read a device's confirmed Proxy relationship","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/devices/{deviceId}/proxy","href":"/api/endpoints/managed-proxy/read-a-devices-confirmed-proxy-relationship"}]},{"group":"Minute billing","pages":[{"title":"/v1/minute/requests/:requestId","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/minute/requests/{requestId}","href":"/api/endpoints/minute-billing/v1minuterequests:requestid"},{"title":"/v1/minute/catalog","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/minute/catalog","href":"/api/endpoints/minute-billing/v1minutecatalog"},{"title":"/v1/minute/wallet","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/minute/wallet","href":"/api/endpoints/minute-billing/v1minutewallet"},{"title":"/v1/minute/topup-quotes","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/minute/topup-quotes","href":"/api/endpoints/minute-billing/v1minutetopup-quotes"},{"title":"/v1/minute/topups","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/minute/topups","href":"/api/endpoints/minute-billing/v1minutetopups"},{"title":"/v1/minute/topups/:id","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/minute/topups/{id}","href":"/api/endpoints/minute-billing/v1minutetopups:id"},{"title":"/v1/minute/topups/:id/abandon","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/minute/topups/{id}/abandon","href":"/api/endpoints/minute-billing/v1minutetopups:idabandon"},{"title":"/v1/minute/starts","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/minute/starts","href":"/api/endpoints/minute-billing/v1minutestarts"},{"title":"/v1/minute/starts/:id","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/minute/starts/{id}","href":"/api/endpoints/minute-billing/v1minutestarts:id"},{"title":"/v1/minute/orders","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/minute/orders","href":"/api/endpoints/minute-billing/v1minuteorders"},{"title":"/v1/minute/orders","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/minute/orders","href":"/api/endpoints/minute-billing/v1minuteorders-1"},{"title":"/v1/minute/orders/:id","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/minute/orders/{id}","href":"/api/endpoints/minute-billing/v1minuteorders:id"},{"title":"/v1/minute/orders/:id/cancel","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/minute/orders/{id}/cancel","href":"/api/endpoints/minute-billing/v1minuteorders:idcancel"},{"title":"/v1/minute/rentals/:deviceId","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/minute/rentals/{deviceId}","href":"/api/endpoints/minute-billing/v1minuterentals:deviceid"},{"title":"/v1/minute/rentals/:deviceId/return","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/minute/rentals/{deviceId}/return","href":"/api/endpoints/minute-billing/v1minuterentals:deviceidreturn"},{"title":"/v1/minute/rentals/:deviceId/resume","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/minute/rentals/{deviceId}/resume","href":"/api/endpoints/minute-billing/v1minuterentals:deviceidresume"},{"title":"/v1/minute/refunds","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/minute/refunds","href":"/api/endpoints/minute-billing/v1minuterefunds"},{"title":"/v1/minute/refunds","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/minute/refunds","href":"/api/endpoints/minute-billing/v1minuterefunds-1"},{"title":"/v1/minute/cases","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/minute/cases","href":"/api/endpoints/minute-billing/v1minutecases"},{"title":"/v1/minute/cases","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/minute/cases","href":"/api/endpoints/minute-billing/v1minutecases-1"},{"title":"/v1/minute/cases/:id","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/minute/cases/{id}","href":"/api/endpoints/minute-billing/v1minutecases:id"},{"title":"/v1/minute/refunds/:id","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/minute/refunds/{id}","href":"/api/endpoints/minute-billing/v1minuterefunds:id"}]},{"group":"Provisioning","pages":[{"title":"Check whether your organisation is provisioned","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/admission","href":"/api/endpoints/provisioning/check-whether-your-organisation-is-provisioned"},{"title":"What your organisation has bought, and where each purchase got to","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/fulfilments","href":"/api/endpoints/provisioning/what-your-organisation-has-bought-and-where-each-purchase-got-to"},{"title":"Whether one checkout was paid","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/orders/{orderId}/payment-status","href":"/api/endpoints/provisioning/whether-one-checkout-was-paid"},{"title":"Cancelling online is retired: contact support","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/fulfilments/{id}/cancel","href":"/api/endpoints/provisioning/cancelling-online-is-retired:-contact-support"},{"title":"Returning online is retired: contact support","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/fulfilments/{id}/return","href":"/api/endpoints/provisioning/returning-online-is-retired:-contact-support"},{"title":"Stop future Cloud phone renewal at Stripe's current period end","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/fulfilments/{id}/cancel-renewal","href":"/api/endpoints/provisioning/stop-future-cloud-phone-renewal-at-stripes-current-period-end"},{"title":"Read a Cloud phone's current monthly renewal state","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/fulfilments/{id}/renewal-status","href":"/api/endpoints/provisioning/read-a-cloud-phones-current-monthly-renewal-state"},{"title":"What you owe next","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/billing/upcoming","href":"/api/endpoints/provisioning/what-you-owe-next"},{"title":"Open the billing portal","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/billing/portal-sessions","href":"/api/endpoints/provisioning/open-the-billing-portal"},{"title":"List what can be bought and what it costs","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/skus","href":"/api/endpoints/provisioning/list-what-can-be-bought-and-what-it-costs"},{"title":"Start provisioning this organisation","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/checkout-sessions","href":"/api/endpoints/provisioning/start-provisioning-this-organisation"},{"title":"Check one returned Checkout now","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/checkout-sessions/{orderId}/confirm","href":"/api/endpoints/provisioning/check-one-returned-checkout-now"},{"title":"Where the payment provider delivers","deprecated":null,"version":null,"openapi":"/api/openapi.json post /webhooks/stripe","href":"/api/endpoints/provisioning/where-the-payment-provider-delivers"},{"title":"Where the identity provider delivers","deprecated":null,"version":null,"openapi":"/api/openapi.json post /webhooks/clerk","href":"/api/endpoints/provisioning/where-the-identity-provider-delivers"}]},{"group":"Notifications","pages":[{"title":"The bell, and the list behind it","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/notifications","href":"/api/endpoints/notifications/the-bell-and-the-list-behind-it"},{"title":"Mark notifications read","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/notifications/read","href":"/api/endpoints/notifications/mark-notifications-read"},{"title":"Which emails you receive","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/me/notification-preferences","href":"/api/endpoints/notifications/which-emails-you-receive"},{"title":"Change which emails you receive","deprecated":null,"version":null,"openapi":"/api/openapi.json patch /v1/me/notification-preferences","href":"/api/endpoints/notifications/change-which-emails-you-receive"}]}]}]},{"tab":"Help","pages":[{"title":"Help","href":"/help/overview"}]}]},"basePath":"","title":"Check that the service is up - PhoneUse","deploymentId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","buildId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CrDfRf61.js","snippetPresets-Dv-cOUrx.js","utils-BUTreAgv.js","style-to-object-BY3JEAdk.js","utils-wsznt9RM.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-DEsMlaPy.js","conditional-requirements-CFM0id0Q.js","cloneDeep-DontW4xJ.js","_Uint8Array-pP7X6_RM.js","isObject-FP1Yky1u.js","ApiExamples-CU_aGGP0.js","usePlaygroundInputsStore-7dNmUIbS.js","shallow-fTtruD8x.js","isEqual-BRfNFpSD.js","CodeSnippets-52884wUJ.js","CodeSnippet-eoRjC4Le.js","getApiPlaygroundDisplay-CZyAPlR2.js","Page-Cr9IwkK7.js","DynamicMarkdown-NFqqduU7.js","SectionHeading-DQ-mJoAt.js","icon-DXTBUt6s.js","MethodPill-2v-b3js5.js","getPastedJson-v_8Y1_4v.js","DuplicateIcon-DXIkhZIo.js","createIcon-DRpYuPZs.js","axios-CsQoIw0U.js","Markdown-CwtoSfEf.js","AssistantPageLink-CTqa3eoi.js","dist-DIfYWxfm.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}