---
title: "Service data model"
url: "https://docs.unified.to/compute/service/model"
description: "The Service data model object in Unified's Service API: 22 fields, including created_at, updated_at and name, with types and enum values."
---
# Service data model

 View field support, webhooks, and list parameters for each integration on the [Supported Integrations](https://docs.unified.to/compute/integrations.md) 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](https://docs.unified.to/compute/service/model.md#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](https://docs.unified.to/compute/service/model.md#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       |                                                                                                                                        |

## TypeScript

```typescript
export type ComputeService = {
	id?: string; // Unique identifier for the service (app or project)
	created_at?: string-time; // When the service was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	updated_at?: string-time; // When the service was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	name?: string; // Display name of the service
	type?: 'WEB' | 'WORKER' | 'CRON' | 'STATIC' | 'PRIVATE' | 'OTHER'; // The kind of service
	status?: 'CREATING' | 'DEPLOYING' | 'LIVE' | 'SUSPENDED' | 'FAILED' | 'OTHER'; // Normalized status; set to SUSPENDED or LIVE on update to suspend or resume
	runtime?: string; // Runtime or framework (eg. node, python, docker, nextjs)
	region_id?: string; // The region the service runs in
	gputype_id?: string; // The plan or instance type the service runs on
	sku?: string; // The vendor's own plan or size name
	instance_count?: number; // Current number of running instances
	min_instance_count?: number; // Autoscaling minimum
	max_instance_count?: number; // Autoscaling maximum
	repo_url?: string; // Source repository URL
	branch?: string; // Source branch deployed
	image?: string; // Container image, for image-based services
	build_command?: string; // Build command
	start_command?: string; // Start command
	url?: string; // Public URL of the service
	project_identifier?: string; // Vendor project, team or environment that groups the service (reference to TaskProject)
	env?: []; // Environment variables (write-only values) set when creating the service
	metadata?: []; // Vendor labels, tags and metadata
	raw?: any; // Raw data from integration
} 
```

## Zod

```typescript
import { z } from 'zod';

export const ZodComputeService = z.object({
	id: z.string().optional().describe("Unique identifier for the service (app or project)"),
	created_at: z.string-time().optional().describe("When the service was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	updated_at: z.string-time().optional().describe("When the service was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	name: z.string().optional().describe("Display name of the service"),
	type: z.enum("WEB", "WORKER", "CRON", "STATIC", "PRIVATE", "OTHER").optional().describe("The kind of service"),
	status: z.enum("CREATING", "DEPLOYING", "LIVE", "SUSPENDED", "FAILED", "OTHER").optional().describe("Normalized status; set to SUSPENDED or LIVE on update to suspend or resume"),
	runtime: z.string().optional().describe("Runtime or framework (eg. node, python, docker, nextjs)"),
	region_id: z.string().optional().describe("The region the service runs in"),
	gputype_id: z.string().optional().describe("The plan or instance type the service runs on"),
	sku: z.string().optional().describe("The vendor's own plan or size name"),
	instance_count: z.number().optional().describe("Current number of running instances"),
	min_instance_count: z.number().optional().describe("Autoscaling minimum"),
	max_instance_count: z.number().optional().describe("Autoscaling maximum"),
	repo_url: z.string().optional().describe("Source repository URL"),
	branch: z.string().optional().describe("Source branch deployed"),
	image: z.string().optional().describe("Container image, for image-based services"),
	build_command: z.string().optional().describe("Build command"),
	start_command: z.string().optional().describe("Start command"),
	url: z.string().optional().describe("Public URL of the service"),
	project_identifier: z.string().optional().describe("Vendor project, team or environment that groups the service (reference to TaskProject)"),
	env: z.array().optional().describe("Environment variables (write-only values) set when creating the service"),
	metadata: z.array().optional().describe("Vendor labels, tags and metadata"),

});
```

## Python

```python
import dataclasses

@dataclasses.dataclass
class ComputeServiceType(str, Enum):
	WEB = 'WEB'
	WORKER = 'WORKER'
	CRON = 'CRON'
	STATIC = 'STATIC'
	PRIVATE = 'PRIVATE'
	OTHER = 'OTHER'

@dataclasses.dataclass
class ComputeServiceStatus(str, Enum):
	CREATING = 'CREATING'
	DEPLOYING = 'DEPLOYING'
	LIVE = 'LIVE'
	SUSPENDED = 'SUSPENDED'
	FAILED = 'FAILED'
	OTHER = 'OTHER'

@dataclasses.dataclass
class ComputeService:
	"""Unique identifier for the service (app or project)"""
	id: Optional[str]
	"""When the service was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	created_at: Optional[str]
	"""When the service was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	updated_at: Optional[str]
	"""Display name of the service"""
	name: Optional[str]
	"""The kind of service"""
	type: Optional[ComputeServiceType]
	"""Normalized status; set to SUSPENDED or LIVE on update to suspend or resume"""
	status: Optional[ComputeServiceStatus]
	"""Runtime or framework (eg. node, python, docker, nextjs)"""
	runtime: Optional[str]
	"""The region the service runs in"""
	region_id: Optional[str]
	"""The plan or instance type the service runs on"""
	gputype_id: Optional[str]
	"""The vendor's own plan or size name"""
	sku: Optional[str]
	"""Current number of running instances"""
	instance_count: Optional[int]
	"""Autoscaling minimum"""
	min_instance_count: Optional[int]
	"""Autoscaling maximum"""
	max_instance_count: Optional[int]
	"""Source repository URL"""
	repo_url: Optional[str]
	"""Source branch deployed"""
	branch: Optional[str]
	"""Container image, for image-based services"""
	image: Optional[str]
	"""Build command"""
	build_command: Optional[str]
	"""Start command"""
	start_command: Optional[str]
	"""Public URL of the service"""
	url: Optional[str]
	"""Vendor project, team or environment that groups the service (reference to TaskProject)"""
	project_identifier: Optional[str]
	"""Environment variables (write-only values) set when creating the service"""
	env: Optional[PropertyComputeServiceEnv]
	"""Vendor labels, tags and metadata"""
	metadata: Optional[PropertyComputeServiceMetadata]

```