Skip to content
Sencai Logo Sencai Logo Sencai Docs

Create a cluster

POST
/clusters

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
object
data
object
name
required
string
description
string
users_permissions_user
One of:

DocumentId reference to plugin::users-permissions.user

string
state
required
string
Allowed values: active inactive pending suspended
cluster_type
string
Allowed values: development staging production testing qa integration uat preview sandbox demo hotfix canary pre-production prod-like
region
string
max_services
integer
current_services_count
integer
monthly_cost
number
metadata

Arbitrary JSON value (object, array, string, number, boolean, or null)

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Created

object
data
object
name
required
string
description
string
users_permissions_user
One of:

DocumentId reference to plugin::users-permissions.user

string
state
required
string
Allowed values: active inactive pending suspended
cluster_type
string
Allowed values: development staging production testing qa integration uat preview sandbox demo hotfix canary pre-production prod-like
region
string
max_services
integer
current_services_count
integer
monthly_cost
number
metadata

Arbitrary JSON value (object, array, string, number, boolean, or null)

documentId
string
id
integer
createdAt
string format: date-time
updatedAt
string format: date-time
publishedAt
string format: date-time
nullable

400

Section titled “400 ”

Validation error

401

Section titled “401 ”

Missing or invalid authentication

403

Section titled “403 ”

Not authorized (tenant scope or capability)