Skip to content

Start a service

Start a stopped service again at the replica count it had before.

Updated

post

https://cloud.cahaves.com/api/services/{id}/start

Authorization

cahaves.cloud.sessionstringcookierequired

The session cookie Cloud sets when a customer signs in to the console with GitHub or Google. It is HttpOnly, so scripts cannot read it, and there are no API keys or tokens yet.

Path parameters

idstring<uuid>required

The service's id.

Example: "0b9e4d2a-7c13-4f6e-a8d5-3e1c9b7f2a40"

Headers

X-Cloud-Organizationstring<uuid>

The id of the organization the request works in, one the signed-in customer owns. Left out or empty, the request works in their oldest organization. Any other value answers 404 with `reason: "organization"`. A customer with no organization yet gets 409 "Create an organization first." from every route that works in one.

Example: "2f6c8e0a-4b1d-4e7f-9a3c-5d7e9f1b3a5c"

Responses

application/json

The started service.

serviceobjectrequired

Only a stopped service starts, at its recorded replica count; any other state is answered as it is. One that has never been deployed needs a deployment instead. A suspended account cannot start services.

Starting a paid service is paid work, refused with 409 and a reason while the organization is not in good standing or is stopped for billing (Errors). A service stopped for billing, which reads stopped_for_billing: true and run_state: "suspended", is refused the same way until the stop lifts, when Cloud starts it again itself. The free application and the free database are never refused for billing.