Containers

Get a container

The container with its newest deploys (status, steps, errors, the dependency scan) and its usage of the last 30 days.

get/containers/{id}

Request

  • Base URL: https://api.hypamoon.com/api/v1
  • URL: https://api.hypamoon.com/api/v1/containers/{id}
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.hypamoon.com/oauth/authorize, token URL https://api.hypamoon.com/oauth/token, scopes: sites:read)

Path parameters

idstring uuid required

The id of the container.

Response

The container.

idstring uuid required
site_idstring uuid required
namestring required
urlstring required
mode'live' | 'test' required
status'deploying' | 'running' | 'failed' | 'suspended' required
versioninteger required

The live version; 0 until the first deploy is live.

instance_typestring required
instancesinteger required
always_onboolean required
sleep_afterstring required
portinteger required
health_pathstring required
allowed_hostsstring[] required
secretsstring[] required
env_namesstring[] required

Names of the plain environment variables (never the values of secrets).

created_atstring required
updated_atstring required

Changes

No recorded changes to this operation across all 1 revision of this API.