container_groups
List Container Groups
- Community
- Blog
- container_groups
- GETList Container Groups
- POSTCreate a Container Group
- GETGet a Container Group
- DELDelete a Container Group
- PATCHUpdate a Container Group
- POSTStart a Container Group
- POSTStop a Container Group
- GETList Container Group Instances
- GETGet Container Group Instance by instance ID
- POSTReallocate container group instance to another node
- POSTRecreate container on a node
- POSTRestart container on a node
- GET
- inference_endpoints
- organization_data
- queues
- quotas
- recipe_deployments
- recipes
- workload_errors
API Documentation
container_groups
List Container Groups
Gets the list of container groups
GET
/
organizations
/
{organization_name}
/
projects
/
{project_name}
/
containers
Salad-Api-Key
string
*
Salad-Api-Key
Required
string
organization_name
string
*
organization_name
Required
string
The unique organization name
project_name
string
*
project_name
Required
string
The unique project name
Authorizations
Salad-Api-Key
string
headerrequiredPath Parameters
organization_name
string
requiredThe unique organization name
project_name
string
requiredThe unique project name
Response
200 - application/json
items
object[]
requireditems.id
string
requireditems.name
string
requireditems.display_name
string
requireditems.container
object
requiredRepresents a container
items.container.image
string
requireditems.container.resources
object
requiredRepresents a container resource requirements
items.container.resources.cpu
integer
requireditems.container.resources.memory
integer
requireditems.container.resources.gpu_class
string | null
deprecateditems.container.resources.gpu_classes
string[] | null
items.container.resources.storage_amount
integer | null
items.container.command
string[]
requireditems.container.size
integer
items.container.hash
string
items.container.environment_variables
object
items.container.logging
object | null
items.container.logging.axiom
object | null
items.container.logging.axiom.host
string
requireditems.container.logging.axiom.api_token
string
requireditems.container.logging.axiom.dataset
string
requireditems.container.logging.datadog
object | null
items.container.logging.datadog.host
string
requireditems.container.logging.datadog.api_key
string
requireditems.container.logging.datadog.tags
object[] | null
items.container.logging.datadog.tags.name
string
requireditems.container.logging.datadog.tags.value
string
requireditems.container.logging.new_relic
object | null
items.container.logging.new_relic.host
string
requireditems.container.logging.new_relic.ingestion_key
string
requireditems.container.logging.splunk
object | null
items.container.logging.splunk.host
string
requireditems.container.logging.splunk.token
string
requireditems.container.logging.tcp
object | null
items.container.logging.tcp.host
string
requireditems.container.logging.tcp.port
integer
requireditems.container.logging.http
object | null
items.container.logging.http.host
string
requireditems.container.logging.http.port
integer
requireditems.container.logging.http.user
string | null
items.container.logging.http.password
string | null
items.container.logging.http.path
string | null
items.container.logging.http.format
enum<string>
requiredAvailable options:
json
, json_lines
items.container.logging.http.headers
object[] | null
items.container.logging.http.headers.name
string
requireditems.container.logging.http.headers.value
string
requireditems.container.logging.http.compression
enum<string>
requiredAvailable options:
none
, gzip
items.autostart_policy
boolean
requireditems.restart_policy
enum<string>
requiredAvailable options:
always
, on_failure
, never
items.replicas
integer
requireditems.current_state
object
requiredRepresents a container group state
items.current_state.status
enum<string>
requiredAvailable options:
pending
, running
, stopped
, succeeded
, failed
, deploying
items.current_state.description
string | null
items.current_state.start_time
string
requireditems.current_state.finish_time
string
requireditems.current_state.instance_status_count
object
requiredRepresents a container group instance status count
items.current_state.instance_status_count.allocating_count
integer
requireditems.current_state.instance_status_count.creating_count
integer
requireditems.current_state.instance_status_count.running_count
integer
requireditems.current_state.instance_status_count.stopping_count
integer
requireditems.country_codes
enum<string>[]
List of countries nodes must be located in. Remove this field to permit nodes from any country.
Available options:
af
, al
, dz
, as
, ad
, ao
, ai
, aq
, ag
, ar
, am
, aw
, au
, at
, az
, bs
, bh
, bd
, bb
, by
, be
, bz
, bj
, bm
, bt
, bo
, bq
, ba
, bw
, bv
, br
, io
, bn
, bg
, bf
, bi
, cv
, kh
, cm
, ca
, ky
, cf
, td
, cl
, cn
, cx
, cc
, co
, km
, cd
, cg
, ck
, cr
, hr
, cu
, cw
, cy
, cz
, ci
, dk
, dj
, dm
, do
, ec
, eg
, sv
, gq
, er
, ee
, sz
, et
, fk
, fo
, fj
, fi
, fr
, gf
, pf
, tf
, ga
, gm
, ge
, de
, gh
, gi
, gr
, gl
, gd
, gp
, gu
, gt
, gg
, gn
, gw
, gy
, ht
, hm
, va
, hn
, hk
, hu
, is
, in
, id
, ir
, iq
, ie
, im
, il
, it
, jm
, jp
, je
, jo
, kz
, ke
, ki
, kp
, kr
, kw
, kg
, la
, lv
, lb
, ls
, lr
, ly
, li
, lt
, lu
, mo
, mg
, mw
, my
, mv
, ml
, mt
, mh
, mq
, mr
, mu
, yt
, mx
, fm
, md
, mc
, mn
, me
, ms
, ma
, mz
, mm
, na
, nr
, np
, nl
, nc
, nz
, ni
, ne
, ng
, nu
, nf
, mp
, no
, om
, pk
, pw
, ps
, pa
, pg
, py
, pe
, ph
, pn
, pl
, pt
, pr
, qa
, mk
, ro
, ru
, rw
, re
, bl
, sh
, kn
, lc
, mf
, pm
, vc
, ws
, sm
, st
, sa
, sn
, rs
, sc
, sl
, sg
, sx
, sk
, si
, sb
, so
, za
, gs
, ss
, es
, lk
, sd
, sr
, sj
, se
, ch
, sy
, tw
, tj
, tz
, th
, tl
, tg
, tk
, to
, tt
, tn
, tr
, tm
, tc
, tv
, ug
, ua
, ae
, gb
, um
, us
, uy
, uz
, vu
, ve
, vn
, vg
, vi
, wf
, eh
, ye
, zm
, zw
, ax
items.networking
object | null
Represents container group networking parameters
items.networking.protocol
enum<string>
requiredAvailable options:
http
items.networking.port
integer
requireditems.networking.auth
boolean
requireditems.networking.dns
string
requireditems.liveness_probe
object | null
Represents the container group liveness probe
items.liveness_probe.tcp
object
items.liveness_probe.tcp.port
integer
requireditems.liveness_probe.http
object
items.liveness_probe.http.path
string
requireditems.liveness_probe.http.port
integer
requireditems.liveness_probe.http.scheme
enum<string>
Available options:
http
items.liveness_probe.http.headers
object[]
items.liveness_probe.http.headers.name
string
requireditems.liveness_probe.http.headers.value
string
requireditems.liveness_probe.grpc
object
items.liveness_probe.grpc.service
string
requireditems.liveness_probe.grpc.port
integer
requireditems.liveness_probe.exec
object
items.liveness_probe.exec.command
string[]
requireditems.liveness_probe.initial_delay_seconds
integer
default: 0requireditems.liveness_probe.period_seconds
integer
default: 10requireditems.liveness_probe.timeout_seconds
integer
default: 30requireditems.liveness_probe.success_threshold
integer
default: 1requireditems.liveness_probe.failure_threshold
integer
default: 3requireditems.readiness_probe
object | null
Represents the container group readiness probe
items.readiness_probe.tcp
object
items.readiness_probe.tcp.port
integer
requireditems.readiness_probe.http
object
items.readiness_probe.http.path
string
requireditems.readiness_probe.http.port
integer
requireditems.readiness_probe.http.scheme
enum<string>
Available options:
http
items.readiness_probe.http.headers
object[]
items.readiness_probe.http.headers.name
string
requireditems.readiness_probe.http.headers.value
string
requireditems.readiness_probe.grpc
object
items.readiness_probe.grpc.service
string
requireditems.readiness_probe.grpc.port
integer
requireditems.readiness_probe.exec
object
items.readiness_probe.exec.command
string[]
requireditems.readiness_probe.initial_delay_seconds
integer
default: 0requireditems.readiness_probe.period_seconds
integer
default: 1requireditems.readiness_probe.timeout_seconds
integer
default: 1requireditems.readiness_probe.success_threshold
integer
default: 1requireditems.readiness_probe.failure_threshold
integer
default: 3requireditems.startup_probe
object | null
Represents the container group startup probe
items.startup_probe.tcp
object
items.startup_probe.tcp.port
integer
requireditems.startup_probe.http
object
items.startup_probe.http.path
string
requireditems.startup_probe.http.port
integer
requireditems.startup_probe.http.scheme
enum<string>
Available options:
http
items.startup_probe.http.headers
object[]
items.startup_probe.http.headers.name
string
requireditems.startup_probe.http.headers.value
string
requireditems.startup_probe.grpc
object
items.startup_probe.grpc.service
string
requireditems.startup_probe.grpc.port
integer
requireditems.startup_probe.exec
object
items.startup_probe.exec.command
string[]
requireditems.startup_probe.initial_delay_seconds
integer
default: 0requireditems.startup_probe.period_seconds
integer
default: 3requireditems.startup_probe.timeout_seconds
integer
default: 10requireditems.startup_probe.success_threshold
integer
default: 2requireditems.startup_probe.failure_threshold
integer
default: 1200requireditems.queue_connection
object | null
Represents container group queue connection
items.queue_connection.path
string
requireditems.queue_connection.port
integer
requireditems.queue_connection.queue_name
string
requireditems.create_time
string
requireditems.update_time
string
requireditems.pending_change
boolean
requireditems.version
integer
required