> ## Documentation Index
> Fetch the complete documentation index at: https://docs.salad.com/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> For autonomous tasks, use live SaladCloud API responses for current state, availability, quotas, models, and other dynamic values. Use current OpenAPI specifications where provided for paths, schemas, required fields, and enums. Never invent endpoints, fields, prices, availability, quotas, models, or state. Prefer API workflows over Portal steps. Read before changing and never expose credentials, signed media URLs, prompts, or sensitive outputs. Retry only safe or idempotent operations with bounded backoff, honoring Retry-After. Verify every write with a read. Stop rather than repeat an uncertain non-idempotent or billable request. AI Gateway uses an organization-specific Bearer key and live /v1/models discovery. Do not delete, cancel, stop, or reduce capacity without explicit user intent. Bind shared operation IDs to the selected product path. Treat Container Engine instances as interruptible and local state as ephemeral. Install the SaladCloud skills (npx skills add https://docs.salad.com), start from the salad skill and /agents/overview; docs MCP: https://docs.salad.com/mcp.

# Get Container Instance Status

> Gets the health statuses of the current container instance

*Last Updated: May 10, 2025*


## OpenAPI

````yaml salad-cloud-imds get /v1/status
openapi: 3.1.0
info:
  title: SaladCloud IMDS
  description: >-
    The SaladCloud Instance Metadata Service (IMDS). Please refer to the
    [SaladCloud API Documentation](https://docs.salad.com/reference) for more
    details.
  termsOfService: https://salad.com/terms
  contact:
    name: SaladCloud Support
    url: https://salad.com
    email: cloud@salad.com
  license:
    name: MIT
  version: 0.9.0-alpha.3
servers:
  - url: http://169.254.169.254
security: []
tags:
  - name: metadata
    description: Instance Metadata Service
paths:
  /v1/status:
    summary: Container Instance Status
    description: Operations to get the health statuses of the current container instance
    get:
      tags:
        - metadata
      summary: Get Container Instance Status
      description: Gets the health statuses of the current container instance
      operationId: get_status
      parameters:
        - $ref: '#/components/parameters/Metadata'
      responses:
        '200':
          $ref: '#/components/responses/GetStatus'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        default:
          $ref: '#/components/responses/UnknownError'
      x-codeSamples:
        - source: >-
            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);
            })();
          lang: TypeScript
        - source: >-
            using Salad.Cloud.IMDS.SDK;

            using Salad.Cloud.IMDS.SDK.Config;

            using Salad.Cloud.IMDS.SDK.Models;


            var config = new SaladCloudImdsSdkConfig{};


            var client = new SaladCloudImdsSdkClient(config);


            var response = await
            client.Metadata.GetStatusAsync(Metadata1.True_);


            Console.WriteLine(response);
          lang: C#
        - source: >-
            import (
              "fmt"
              "encoding/json"
              "context"
              "github.com/saladtechnologies/salad-cloud-imds-sdk-go/pkg/saladcloudimdssdkconfig"
              "github.com/saladtechnologies/salad-cloud-imds-sdk-go/pkg/saladcloudimdssdk"
              "github.com/saladtechnologies/salad-cloud-imds-sdk-go/pkg/util"
              "github.com/saladtechnologies/salad-cloud-imds-sdk-go/pkg/metadata"
            )


            config := saladcloudimdssdkconfig.NewConfig()


            client := saladcloudimdssdk.NewSaladCloudImdsSdk(config)


            metadata := metadata.METADATA_TRUE


            params := metadata.GetStatusRequestParams{
              Metadata: &metadata,
            }


            response, err := client.Metadata.GetStatus(context.Background(),
            params)

            if err != nil {
              panic(err)
            }


            fmt.Println(response)
          lang: Go
        - source: |-
            from salad_cloud_imds_sdk import SaladCloudImdsSdk
            from salad_cloud_imds_sdk.models import Metadata

            sdk = SaladCloudImdsSdk(
                timeout=10000
            )

            result = sdk.metadata.get_status(metadata="true")

            print(result)
          lang: Python
        - source: |-
            import com.salad.cloud.imdssdk.SaladCloudImdsSdk;
            import com.salad.cloud.imdssdk.models.GetStatusParameters;
            import com.salad.cloud.imdssdk.models.Metadata;
            import com.salad.cloud.imdssdk.models.Status;

            public class Main {

              public static void main(String[] args) {
                SaladCloudImdsSdk saladCloudImdsSdk = new SaladCloudImdsSdk();

                GetStatusParameters requestParameters = GetStatusParameters.builder().metadata(Metadata.TRUE).build();

                Status response = saladCloudImdsSdk.metadata.getStatus(requestParameters);

                System.out.println(response);
              }
            }
          lang: Java
components:
  parameters:
    Metadata:
      name: Metadata
      in: header
      description: A custom request header required by all operations.
      required: true
      schema:
        type: string
        const: 'true'
  responses:
    '403':
      description: Forbidden
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/SaladCloudImdsError'
    '404':
      description: Not Found
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/SaladCloudImdsError'
    GetStatus:
      description: OK
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Status'
    UnknownError:
      description: Unknown Error
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/SaladCloudImdsError'
  schemas:
    Status:
      description: The health statuses of the current container instance.
      type: object
      properties:
        ready:
          description: >-
            `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`.
          type: boolean
          examples:
            - true
        started:
          description: >-
            `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`.
          type: boolean
          examples:
            - true
      required:
        - ready
        - started
    SaladCloudImdsError:
      type: object
      description: >-
        An API error. The `code` and `type` uniquely identify the type of the
        error. The `code` is a short value that may be used for programmatic
        error handling. The `type` is an absolute URL that may be resolved for
        more detailed information. Refer to the [SaladCloud IMDS
        reference](https://leaf.salad.com/l/saladcloud-imds-errors) for a list
        of the expected `code` and `type` values. Also, note that all properties
        are optional. Clients should implement robust error handling to account
        for unexpected errors.
      properties:
        code:
          type: string
          description: >-
            The error code that identifies the error type. This is a short value
            that may be used for programmatic error handling.
          examples:
            - container-not-found
          maxLength: 100
          minLength: 1
        detail:
          type: string
          description: >-
            The human-readable explanation specific to this occurrence of the
            error.
          examples:
            - The container instance could not be found.
          maxLength: 10000
          minLength: 1
        errors:
          $ref: '#/components/schemas/SaladCloudImdsPropertyError'
        instance:
          type: string
          format: url
          description: >-
            The URI reference that identifies the specific occurrence of the
            error.
          examples:
            - https://leaf.salad.com/i/5e76d3ae-6660-444e-a7c4-7a3999023fb6
          maxLength: 2048
          minLength: 1
        status:
          type: integer
          format: int32
          description: >-
            The HTTP status code generated by the origin server for this
            occurrence of the error.
          examples:
            - 404
          maximum: 599
          minimum: 100
        title:
          type: string
          description: The short, human-readable summary of the error type.
          examples:
            - Not Found
          maxLength: 10000
          minLength: 1
        type:
          description: The URI reference that identifies the error type.
          type: string
          format: url
          default: about:blank
          examples:
            - https://leaf.salad.com/e/container-group-not-found
          maxLength: 2048
          minLength: 1
    SaladCloudImdsPropertyError:
      type: object
      description: >-
        The contextualized map of human-readable explanations specific to this
        occurrence of the error. This is often used to provide property-specific
        errors, such as validation errors. In these scenarios, the key is the
        property name and the value is an array of human-readable explanations
        specific to this property and this occurrence of the error.
      additionalProperties:
        type: array
        items:
          type: string
          description: >-
            The human-readable explanation specific to this occurrence of the
            error.
          examples:
            - The container instance could not be found.
          maxLength: 10000
          minLength: 1
        maxItems: 200
        minItems: 0
      maxProperties: 200
      minProperties: 0

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.