Skip to content

Get a service

A service with its environment, compose file, database access and 20 newest deployments.

Updated

get

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

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 service detail and its recent deployments.

serviceobjectrequired

deploymentsobject[]required

This answers a service's env, its compose_file and, inside database, a database's password. No list carries them. The three database endpoints answer the same detail for the database they change, so treat all four answers as secret.