Skip to content
Sencai Logo Sencai Logo Sencai Docs

Create a cost-recommendation

POST
/cost-recommendations

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
object
data
object
provider
required
string
Allowed values: aws azure gcp hetzner ovhcloud scaleway upcloud digitalocean
recommendation_type
required
string
Allowed values: right-sizing reserved-instance idle-cleanup storage-tier egress-optimization what-if
estimated_saving_monthly
number
confidence
required
string
Allowed values: high medium low
status
required
string
Allowed values: open applied snoozed dismissed
detail

Provider-specific metadata: current/recommended resource specs, utilization data, break-even calc.

detected_at
required
string format: date-time
snoozed_until

Set when status=snoozed. Recommendation surfaced again after this date.

string format: date-time
credential
One of:

DocumentId reference to api::cloud-credential.cloud-credential

string
asset
One of:

DocumentId reference to api::cloud-asset.cloud-asset

string
organisation
One of:

DocumentId reference to api::organisation.organisation

string
home_region

Logical data-residency region of the tenant (CELL invariant, F2.CELL.01)

string
cell_id

Deployment cell within home_region for blast-radius isolation (CELL invariant, F2.CELL.01)

string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Created

object
data
object
provider
required
string
Allowed values: aws azure gcp hetzner ovhcloud scaleway upcloud digitalocean
recommendation_type
required
string
Allowed values: right-sizing reserved-instance idle-cleanup storage-tier egress-optimization what-if
estimated_saving_monthly
number
confidence
required
string
Allowed values: high medium low
status
required
string
Allowed values: open applied snoozed dismissed
detail

Provider-specific metadata: current/recommended resource specs, utilization data, break-even calc.

detected_at
required
string format: date-time
snoozed_until

Set when status=snoozed. Recommendation surfaced again after this date.

string format: date-time
credential
One of:

DocumentId reference to api::cloud-credential.cloud-credential

string
asset
One of:

DocumentId reference to api::cloud-asset.cloud-asset

string
organisation
One of:

DocumentId reference to api::organisation.organisation

string
home_region

Logical data-residency region of the tenant (CELL invariant, F2.CELL.01)

string
cell_id

Deployment cell within home_region for blast-radius isolation (CELL invariant, F2.CELL.01)

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