compute
service

List all services

Changed on
get/compute/{connection_id}/service

Request

  • Base URL: https://api.unified.to
  • URL: https://api.unified.to/compute/{connection_id}/service
  • Auth: API key in header authorization

Path parameters

connection_idstring required

ID of the connection

Query parameters

limitnumber
offsetnumber
updated_gtestring

Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

sortstring
orderstring
querystring

Query string to search. eg. email address or name

statusstring
typestring
region_idstring

The ComputeRegion ID to filter by

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Response

Successful

idstring

Unique identifier for the service (app or project)

created_atstring date-time

When the service was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

When the service was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

namestring

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

runtimestring

Runtime or framework (eg. node, python, docker, nextjs)

region_idstring

The region the service runs in

gputype_idstring

The plan or instance type the service runs on

skustring

The vendor's own plan or size name

instance_countnumber

Current number of running instances

min_instance_countnumber

Autoscaling minimum

max_instance_countnumber

Autoscaling maximum

repo_urlstring

Source repository URL

branchstring

Source branch deployed

imagestring

Container image, for image-based services

build_commandstring

Build command

start_commandstring

Start command

urlstring

Public URL of the service

project_identifierstring

Vendor project, team or environment that groups the service (reference to TaskProject)

rawobject

Raw data from integration

Changes