Service data model
View field support, webhooks, and list parameters for each integration on the Supported Integrations page.
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier for the service (app or project) |
created_at | string (date-time) | No | When the service was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | When the service was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
name | string | No | Display name of the service |
type | enum | No | The kind of service Values: WEB, WORKER, CRON, STATIC, PRIVATE, OTHER |
status | enum | No | Normalized status; set to SUSPENDED or LIVE on update to suspend or resume Values: CREATING, DEPLOYING, LIVE, SUSPENDED, FAILED, OTHER |
runtime | string | No | Runtime or framework (eg. node, python, docker, nextjs) |
region_id | string | No | The region the service runs in |
gputype_id | string | No | The plan or instance type the service runs on |
sku | string | No | The vendor's own plan or size name |
instance_count | number | No | Current number of running instances |
min_instance_count | number | No | Autoscaling minimum |
max_instance_count | number | No | Autoscaling maximum |
repo_url | string | No | Source repository URL |
branch | string | No | Source branch deployed |
image | string | No | Container image, for image-based services |
build_command | string | No | Build command |
start_command | string | No | Start command |
url | string | No | Public URL of the service |
project_identifier | string | No | Vendor project, team or environment that groups the service (reference to TaskProject) |
env | ComputeEnv[] | No | Environment variables (write-only values) set when creating the service |
env[].name | string | Yes | Environment variable name |
env[].value | string | No | Environment variable value (write-only; never returned) |
metadata | ComputeMetadata[] | No | Vendor labels, tags and metadata |
metadata[].id | string | No | |
metadata[].slug | string | No | The label, tag or metadata key |
metadata[].value | object | No | The label, tag or metadata value |
metadata[].namespace | string | No | The origin of the value (eg. labels, tags, metadata) |
metadata[].format | enum | No | The data type of the value Values: TEXT, NUMBER, DATE, BOOLEAN, ARRAY, OBJECT |
metadata[].extra_data | object | No |
Are we missing anything? Let us know