POST
/
organizations
/
{organization_name}
/
projects
/
{project_name}
/
containers

Authorizations

Salad-Api-Key
string
headerrequired

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
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

Body

application/json

Represents a request to create a container group

name
string
required
Required string length: 2 - 63
container
object
required

Represents a container

autostart_policy
boolean
required
restart_policy
enum<string>
required
Available options:
always,
on_failure,
never
replicas
integer
required
Required range: 0 < x < 250
display_name
string | null
Required string length: 2 - 63
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
networking
object | null

Represents container group networking parameters

liveness_probe
object | null

Represents the container group liveness probe

readiness_probe
object | null

Represents the container group readiness probe

startup_probe
object | null

Represents the container group startup probe

queue_connection
object | null

Represents container group queue connection

queue_autoscaler
object | null

Represents the autoscaling rules for a queue

Response

201 - application/json

Represents a container group

id
string
required
name
string
required
Required string length: 2 - 63
display_name
string
required
Required string length: 2 - 63
container
object
required

Represents a container

autostart_policy
boolean
required
restart_policy
enum<string>
required
Available options:
always,
on_failure,
never
replicas
integer
required
Required range: 0 < x < 100
current_state
object
required

Represents a container group state

create_time
string
required
update_time
string
required
pending_change
boolean
required
version
integer
required
Required range: x > 1
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
networking
object | null

Represents container group networking parameters

liveness_probe
object | null

Represents the container group liveness probe

readiness_probe
object | null

Represents the container group readiness probe

startup_probe
object | null

Represents the container group startup probe

queue_connection
object | null

Represents container group queue connection

queue_autoscaler
object | null

Represents the autoscaling rules for a queue

Was this page helpful?

Using the APIGet Container Group