PATCH
/
organizations
/
{organization_name}
/
projects
/
{project_name}
/
containers
/
{container_group_name}
/
instances
/
{container_group_instance_id}
Go
import (
  "fmt"
  "encoding/json"
  "github.com/saladtechnologies/salad-cloud-sdk-go/pkg/saladcloudsdkconfig"
  "github.com/saladtechnologies/salad-cloud-sdk-go/pkg/saladcloudsdk"
  "github.com/saladtechnologies/salad-cloud-sdk-go/pkg/util"
  "github.com/saladtechnologies/salad-cloud-sdk-go/pkg/containergroups"
)

config := saladcloudsdkconfig.NewConfig()
client := saladcloudsdk.NewSaladCloudSdk(config)


request := containergroups.ContainerGroupInstancePatch{
  DeletionCost: util.ToPointer(util.Nullable[int64]{ Value: int64(123) }),
}

response, err := client.ContainerGroups.UpdateContainerGroupInstance(context.Background(), "organizationName", "projectName", "containerGroupName", "containerGroupInstanceId", request)
if err != nil {
  panic(err)
}

fmt.Println(response)
{
  "id": "db3a4591-efc3-46c0-b06a-3d820c0ec100",
  "machine_id": "eb3a4591-efc3-46c0-b06a-3d820c0ec100",
  "state": "allocating",
  "update_time": "2023-11-07T05:31:56Z",
  "version": 1073741824,
  "ready": true,
  "started": true,
  "deletion_cost": 0
}
Last Updated: July 1, 2025

Authorizations

​
Salad-Api-Key
string
header
required

Path Parameters

​
organization_name
string
required

Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization.

Required string length: 2 - 63
Examples:

"acme-corp"

​
project_name
string
required

Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API.

Required string length: 2 - 63
Examples:

"dev-env"

​
container_group_name
string
required

The unique container group name

Required string length: 2 - 63
Examples:

"mandlebrot"

​
container_group_instance_id
string<uuid>
required

The unique container group instance identifier

Examples:

"db3a4591-efc3-46c0-b06a-3d820c0ec100"

Body

application/merge-patch+json

Represents a request to update a container group instance

​
deletion_cost
integer | null

The cost of deleting the container group instance

Required range: 0 <= x <= 100000

Response

OK

A Container Group Instance represents a running instance of a container group on a specific machine. It provides information about the execution state, readiness, and version of the deployed container group.

​
id
string<uuid>
required

The container group instance identifier.

Examples:

"db3a4591-efc3-46c0-b06a-3d820c0ec100"

​
machine_id
string<uuid>
required

The container group machine identifier.

Examples:

"eb3a4591-efc3-46c0-b06a-3d820c0ec100"

​
state
enum<string>
required

The state of the container group instance

Available options:
allocating,
downloading,
creating,
running,
stopping
​
update_time
string<date-time>
required

The UTC timestamp when the container group instance last changed its state. This helps track the lifecycle and state transitions of the instance.

​
version
integer
required

The version of the container group definition currently running on this instance. Used to track deployment and update progress across the container group fleet.

Required range: 1 <= x <= 2147483647
​
ready
boolean

Indicates whether the container group instance is currently passing its readiness checks and is able to receive traffic or perform its intended function. If no readiness probe is defined, this will be true once the instance is fully started.

​
started
boolean

Indicates whether the container group instance has successfully completed its startup sequence and passed any configured startup probes. This will always be true when no startup probe is defined for the container group.

​
deletion_cost
integer
default:0

The cost of deleting the container group instance

Required range: 0 <= x <= 100000