Skip to content

ServiceInstanceList

View as Markdown

A page of ServiceInstance objects.

Field Type Description
data * array of ServiceInstance
next_cursor * string or null Pass as cursor to get the next page; null on the last page.
has_more * boolean

* always present

{
"data": [
{
"service_id": "string",
"environment_id": "string",
"name": "string",
"kind": "web",
"status": "no_deployment",
"status_text": "Live. 2 of 2 copies healthy.",
"effective": {
"source": {
"kind": "git",
"repo": "string",
"root": "apps/web",
"watch": [
"apps/web/**",
"packages/ui/**",
"pnpm-lock.yaml"
],
"image": "ghcr.io/acme/api:1.4.2",
"registry_credentials_secret": "string"
},
"build": {
"builder": "railpack",
"dockerfile": "services/api/Dockerfile",
"context": "string"
},
"start": "pnpm --filter web start",
"pre_deploy": "pnpm --filter db migrate deploy",
"port": 3000,
"healthcheck": {
"type": "http",
"path": "/healthz",
"port": 1,
"timeout_seconds": 10,
"interval_seconds": 10,
"start_timeout_seconds": 300
},
"resources": {
"cpu": 1,
"memory_mb": 1024
},
"replicas": {
"min": 1,
"max": 1,
"scale_on": {}
},
"sleep_when_idle": false,
"private": false,
"cron": {
"schedule": "0 2 * * *",
"timezone": "Europe/London",
"timeout_seconds": 1,
"concurrency_policy": "forbid"
},
"restart_policy": {
"mode": "on_failure",
"max_retries": 10
},
"deploy": {
"overlap_seconds": 20,
"auto_rollback": false
},
"volumes": [
{}
]
},
"overrides": {
"source": {
"kind": "git",
"repo": "string",
"root": "apps/web",
"watch": [
"apps/web/**",
"packages/ui/**",
"pnpm-lock.yaml"
],
"image": "ghcr.io/acme/api:1.4.2",
"registry_credentials_secret": "string"
},
"build": {
"builder": "railpack",
"dockerfile": "services/api/Dockerfile",
"context": "string"
},
"start": "pnpm --filter web start",
"pre_deploy": "pnpm --filter db migrate deploy",
"port": 3000,
"healthcheck": {
"type": "http",
"path": "/healthz",
"port": 1,
"timeout_seconds": 10,
"interval_seconds": 10,
"start_timeout_seconds": 300
},
"resources": {
"cpu": 1,
"memory_mb": 1024
},
"replicas": {
"min": 1,
"max": 1,
"scale_on": {}
},
"sleep_when_idle": false,
"private": false,
"cron": {
"schedule": "0 2 * * *",
"timezone": "Europe/London",
"timeout_seconds": 1,
"concurrency_policy": "forbid"
},
"restart_policy": {
"mode": "on_failure",
"max_retries": 10
},
"deploy": {
"overlap_seconds": 20,
"auto_rollback": false
},
"volumes": [
{}
]
},
"current_deployment": {
"id": "dep_01jbx2m9k7q4r8t5v6w3y0z1dp",
"project_id": "prj_01jbx2m9k7q4r8t5v6w3y0z1pr",
"environment_id": "env_01jbx2m9k7q4r8t5v6w3y0z1en",
"service_id": "svc_01jbx2m9k7q4r8t5v6w3y0z1sv",
"service_name": "web",
"environment_name": "production",
"status": "active",
"status_text": "Live since 14:05",
"trigger": {
"kind": "git_push",
"actor": {
"type": "github",
"id": "stewartwebb",
"display": "stewartwebb pushed to main"
}
},
"source": {
"kind": "git",
"commit": {
"sha": "a1b2c3d4e5f60718293a4b5c6d7e8f9012345678",
"branch": "main",
"message": "Fix rota export",
"author": "Stewart Webb"
}
},
"build_id": "bld_01jbx2m9k7q4r8t5v6w3y0z1bd",
"image": {
"digest": "sha256:4b1f0e9d8c7b6a5948372615f4e3d2c1b0a9f8e7d6c5b4a3928170f6e5d4c3b2",
"signed": true
},
"rollback_of": null,
"operation_id": "op_01jbx2m9k7q4r8t5v6w3y0z1op",
"url": "https://www.primecarers.co.uk",
"failure": null,
"created_at": "2026-10-23T14:02:00Z",
"started_at": "2026-10-23T14:02:01Z",
"active_at": "2026-10-23T14:05:12Z",
"finished_at": "2026-10-23T14:05:12Z",
"duration_ms": 191000
},
"urls": {
"public": [
"https://web-primecarers-k7q4.guv.run",
"https://www.primecarers.co.uk"
],
"internal_host": "web.guv.internal"
},
"replicas": {
"desired": 1,
"running": 1
},
"last_error": {
"message": "string",
"explanation_url": "string"
},
"cost_today": {
"amount": "7.42",
"currency": "GBP",
"display": "£7.42"
},
"updated_at": "2026-10-22T13:05:00Z"
}
],
"next_cursor": "string",
"has_more": false
}