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);
})();
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);
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)
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)
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);
}
}
curl --request GET \
--url http://169.254.169.254/v1/status \
--header 'Metadata: <metadata>'
const options = {method: 'GET', headers: {Metadata: '<metadata>'}};

fetch('http://169.254.169.254/v1/status', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "http://169.254.169.254/v1/status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Metadata: <metadata>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
require 'uri'
require 'net/http'

url = URI("http://169.254.169.254/v1/status")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["Metadata"] = '<metadata>'

response = http.request(request)
puts response.read_body
{
  "ready": true,
  "started": true
}
{
"code": "<string>",
"detail": "<string>",
"errors": {},
"instance": "<string>",
"status": 349,
"title": "<string>",
"type": "about:blank"
}
{
"code": "<string>",
"detail": "<string>",
"errors": {},
"instance": "<string>",
"status": 349,
"title": "<string>",
"type": "about:blank"
}
{
"code": "<string>",
"detail": "<string>",
"errors": {},
"instance": "<string>",
"status": 349,
"title": "<string>",
"type": "about:blank"
}
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