metadata

Get Container Instance Status

Gets the health statuses of the current container instance

get/v1/status

Request

Base URL
https://api.salad.com/api/public
Auth
API key in header Salad-Api-Key
TypeScript
https://skmtc.dev/salad/apis/saladcloud-api/docs/v1/status/get.ts
A function with typed inputs. Its response is checked against the schema.

Headers

Metadata'true' required

A custom request header required by all operations.

Response

readyboolean required

true if the running container is ready. If a readiness probe is defined, this returns the latest result of the probe. If a readiness probe is not defined but a startup probe is defined, this returns the same value as the started property. If neither a readiness probe nor a startup probe are defined, returns true.

startedboolean required

true if the running container is started. If a startup probe is defined, this returns the latest result of the probe. If a startup probe is not defined, returns true.

Example response

{
  "ready": true,
  "started": true
}

Changes

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