Xeonr Developer Docs
API SpecificationApps

List Apps

POST
/containers.api.v1.AppService/ListApps

Lists Apps in a namespace, newest first. page_size defaults to 100 and is clamped to 1000.

Access: namespace VIEWER or above (read). namespace is required unless the caller is a platform admin, for whom empty covers every namespace.

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

Connect-Timeout-Ms?number

Define the timeout, in ms

Request Body

application/json

namespace?string

Required for everyone but a platform administrator, for whom empty lists every namespace.

Lengthlength <= 64
pageSize?integer

validate:skip clamped server-side to 1000; 0 means 100

pageToken?string
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://containers.xeonr.io/containers.api.v1.AppService/ListApps" \  -H "Connect-Protocol-Version: 1" \  -H "Connect-Timeout-Ms: 1000" \  -H "Content-Type: application/json" \  -d '{}'
{
  "apps": [
    {
      "appId": "string",
      "namespace": "string",
      "label": "string",
      "scaling": {
        "minInstances": 0,
        "maxInstances": 0,
        "concurrency": 0,
        "idleTimeoutSec": 0,
        "activationTimeoutSec": 0
      },
      "resources": {
        "cpuMillis": 0,
        "memoryMb": 0,
        "ephemeralMb": 0,
        "pids": 0
      },
      "env": {
        "property1": "string",
        "property2": "string"
      },
      "egress": {
        "egressPolicyId": "string"
      },
      "state": "APP_STATE_UNSPECIFIED",
      "createdAtUnix": "string",
      "updatedAtUnix": "string",
      "hostname": "string",
      "activeVersionId": "string",
      "autoStart": true,
      "access": "APP_ACCESS_UNSPECIFIED",
      "key": "string"
    }
  ],
  "nextPageToken": "string",
  "total": 0
}
{
  "code": "not_found",
  "message": "string",
  "details": [
    {
      "type": "string",
      "value": "string",
      "debug": {}
    }
  ]
}

Get App POST

Returns an App, including its key, plus its live instances derived from pods (an instance has no address until a version is promoted). The hostname is derived for the current app domain. NotFound for an unknown id. **Access:** namespace VIEWER or above (read)

List App Versions POST

Lists every version of an App, newest first. page_size and page_token are not applied yet: the whole history is returned in one page. **Access:** namespace VIEWER or above (read)