Skip to main content
GET
/
v1
/
status
TypeScript
import { Metadata, SaladCloudImdsSdk } from '@saladtechnologies-oss/salad-cloud-imds-sdk';

(async () => {
  const saladCloudImdsSdk = new SaladCloudImdsSdk({});

  const metadata = Metadata.TRUE_;

  const { data } = await saladCloudImdsSdk.metadata.getStatus({
    metadata: metadata,
  });

  console.log(data);
})();
{
  "ready": true,
  "started": true
}
Last Updated: May 10, 2025

Headers

​
Metadata
string
required

A custom request header required by all operations.

Allowed value: "true"

Response

OK

The health statuses of the current container instance.

​
ready
boolean
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.

Example:

true

​
started
boolean
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:

true