Documentation menu

Get service state

GEThttps://api.instacloud.com/projects/{projectId}/services/{serviceId}/state

Token scope: account · org · project — read-only tokens allowed.

A compute service's desired (developer intent) vs. live runtime state.

Parameters

NameInTypeRequiredDescription
projectIdpathstringyes
serviceIdpathstringyes

Responses

200

Default Response

FieldTypeRequiredDescription
desiredStatestringnorunning|stopped|suspended
statestringnorunning|suspended|stopped|none|unknown
lastFailureobjectnothe newest deploy attempt's failure; omitted when the newest attempt succeeded
lastFailure.kind"deploy" | "build"yesbuild: no image was produced; deploy: the image was built (or given) but did not go live
lastFailure.atstringyes
lastFailure.reasonstringyestenant-safe: the same message the failing deploy or build already reported
lastFailure.buildIdstringnowhen the attempt was a build: `insta build logs <buildId> --source <buildSource>`
lastFailure.buildSource"github" | "archive"no

400

Default Response

FieldTypeRequiredDescription
errorstringyes

404

Default Response

FieldTypeRequiredDescription
errorstringyes

View as Markdown