API SpecificationApps
Activation (A2): the public "starts on first request" API. AcquireInstance returns a ready instance, cold-starting one if none exists and blocking up to wait_ms; ReportLoad feeds idle-reap without an RPC per HTTP request.
With an App now routable by hostname, AcquireInstance is no longer on the request path for a caller that just wants to reach the app — the proxy does it. It stays public for warmup: starting an instance at promote time, before any user request arrives.
Authorization
BearerAuth AuthorizationBearer <token>
A namespace-scoped API key (cpk_…) for machines, or a Xeonr Auth OIDC
token for humans. The key's namespace and role are pinned server-side.
In: header
Header Parameters
Connect-Protocol-Version*number
Define the version of the Connect protocol
Value in
1Connect-Timeout-Ms?number
Define the timeout, in ms
Request Body
application/json
appId?string
waitMs?integer
max time the caller may be blocked while cold-starting
[key: string]?never
Response Body
application/json
application/json
curl -X POST "https://containers.xeonr.io/containers.api.v1.AppService/AcquireInstance" \ -H "Connect-Protocol-Version: 1" \ -H "Content-Type: application/json" \ -d '{}'{
"address": "string",
"instanceId": "string",
"coldStart": true,
"waitedMs": 0
}{
"code": "not_found",
"message": "string",
"details": [
{
"type": "string",
"value": "string",
"debug": {}
}
]
}