Skip to main content
POST
deploy.service.get

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Account
string

Optional. One of your account ids (GET /v1/accounts): run on that account, whatever your routing rules say. The response header X-Pramaan-Account names the account that ran.

Pramaan-End-User
string

Optional. Your own tag for your end user: a sticky: end_user rule keeps them on the account that first served them.

Maximum string length: 256
Pramaan-End-User-Group
string

Optional. Your end user's group, matched by rules with endUserGroup.

Maximum string length: 64

Body

application/json
id
string
required

Identifier in your connected hosting account.

Pattern: ^[A-Za-z0-9_-]{1,100}$

Response

The result

id
string
required

Identifier in your connected hosting account.

Pattern: ^[A-Za-z0-9_-]{1,100}$
name
string
required

Service name.

Required string length: 1 - 256
kind
enum<string>
required

Service kind.

Available options:
web,
private,
worker,
cron,
static
state
enum<string>
required

Suspension state, not a health check.

Available options:
active,
suspended
capacity
object

Compute capacity; ongoing charges are billed directly to your hosting account.

environmentId
string

Project environment identifier, when assigned.

Pattern: ^[A-Za-z0-9_-]{1,100}$
buildSourceId
string

Linked build source identifier.

Pattern: ^[A-Za-z0-9_-]{1,100}$
diskId
string

Persistent disk identifier.

Pattern: ^[A-Za-z0-9_-]{1,100}$
runtime
string

Execution runtime.

Required string length: 1 - 256
region
string

Hosting region.

Required string length: 1 - 256
branch
string

Configured repository branch.

Required string length: 1 - 256
repositoryUrl
string<uri>

Configured source repository address.

schedule
string

Cron schedule.

Required string length: 1 - 256
instances
integer

Configured manual instance count; not the running count under automatic scaling.

Required range: -9007199254740991 <= x <= 9007199254740991
deploymentId
string

Deployment started for this service, when returned.

Pattern: ^[A-Za-z0-9_-]{1,100}$
createdAt
string

Creation time, ISO 8601.

updatedAt
string

Last change time, ISO 8601.