Skip to content
StratumStratum Docs

Upsert the custom-shape policy at a scope.

PUT
/v1/admin/compute/custom-shape-policies/{scope}/{scopeId}
Code sample: Shell / cURL
curl --request PUT \
  --url https://stratum.example.com/v1/admin/compute/custom-shape-policies/install/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "enabled": true, "minVcpus": 1, "maxVcpus": 1, "minMemoryMib": 1, "maxMemoryMib": 1, "alignmentMib": 1, "standardMinMibPerVcpu": 1, "standardMaxMibPerVcpu": 1, "extendedEnabled": true, "extendedMaxMibPerVcpu": 1 }'

Sparse upsert body — every field is optional:

  • field omitted → leave the existing value unchanged
  • field present + value → set the override at this scope
  • field present + null → clear the override (inherit from the parent scope at resolution time)

The install seed row carries Stratum’s GCP-shaped defaults (1-64 vCPU, 1-512 GiB RAM, 256 MiB alignment, standard ratio 0.5-8 GiB/vCPU, extended disabled with a 64 GiB/vCPU cap). enabled=false ships out-of-the-box; flip it at install scope to enable custom shapes globally, or at a narrower scope to enable per-region or per-project.

Cedar action: compute:UpdateCustomShapePolicy..

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
scope
required
string
Allowed values: install region project

Policy scope. Install policy is the install-wide default; region + project policies override it via the project -> region -> install precedence chain.

scopeId
required
string

For scope=install, pass _ (the install scope has no id). For scope=region, the region name. For scope=project, the project ID.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json

Sparse upsert body. Every field is optional; values follow the same three-state convention as the rest of the admin surface (omit / set / clear-via-null)..

object
enabled
boolean
nullable
minVcpus
integer
nullable >= 1
maxVcpus
integer
nullable >= 1
minMemoryMib
integer
nullable >= 1
maxMemoryMib
integer
nullable >= 1
alignmentMib
integer
nullable >= 1
standardMinMibPerVcpu
integer
nullable >= 1
standardMaxMibPerVcpu
integer
nullable >= 1
extendedEnabled
boolean
nullable
extendedMaxMibPerVcpu
integer
nullable >= 1

Example generated

{
  "enabled": true,
  "minVcpus": 1,
  "maxVcpus": 1,
  "minMemoryMib": 1,
  "maxMemoryMib": 1,
  "alignmentMib": 1,
  "standardMinMibPerVcpu": 1,
  "standardMaxMibPerVcpu": 1,
  "extendedEnabled": true,
  "extendedMaxMibPerVcpu": 1
}

Responses

Section titled “Responses”

200

Section titled “200”

Policy row after the upsert.

Media typeapplication/json

The explicit compute.custom_shape_policy row at one of install / region / project scopes. Pointer-shaped fields are nullable so the operator can distinguish “set at this scope” from “inherits from the parent”..

object
scope
required
string
Allowed values: install region project
scopeId
required

Empty string for install scope; region name for region scope; project id for project scope.

string
enabled
boolean
nullable
minVcpus
integer
nullable >= 1
maxVcpus
integer
nullable >= 1
minMemoryMib
integer
nullable >= 1
maxMemoryMib
integer
nullable >= 1
alignmentMib
integer
nullable >= 1
standardMinMibPerVcpu
integer
nullable >= 1
standardMaxMibPerVcpu
integer
nullable >= 1
extendedEnabled
boolean
nullable
extendedMaxMibPerVcpu
integer
nullable >= 1
updatedBy

User id of the last admin to write this scope row.

string

Example 

{
  "scope": "install"
}

400

Section titled “400”

Bad request.

Media typeapplication/problem+json
object
type
required
string format: uri
title
required
string
status
required
integer
>= 400 <= 599
detail
string
instance
string format: uri-reference
requestId
required
string
code
required
string
issues

The findings of a rejected IAM policy document (custom and resource policies).

Array<object>

One finding of a rejected IAM policy document. A rejection lists every finding, so the author fixes the document in one round trip.

object
code
required

The finding, e.g. INVALID_DOCUMENT, UNKNOWN_ACTION, ACTION_NOT_APPLICABLE.

string
statement
required

Index of the statement at fault; -1 for the document as a whole.

integer
>= -1
detail
required
string
action

The offending action, where one is at fault (ACTION_NOT_APPLICABLE).

string
errors

Field errors, for codes that carry them: each problem at its field (see FieldError). Documented on the responses that set it, e.g. approveNodeJoin’s INVALID_INPUT and JOIN_APPROVAL_REFUSED. Absent otherwise.

Array<object>

One field’s problem, the stage-2 installer API’s shape. field is the field’s path, message what is wrong with it.

object
field
required

The field’s path, e.g. links[0].interface, disks[1].confirm, mgmt.address or role; empty for the whole request.

string
message
required
string
details

Structured facts about the refusal, for codes that carry them. The shape is fixed per code and documented on the response that answers it, e.g. IMAGE_POOL_MISMATCH (see ImagePoolMismatchDetails) and IMAGE_IN_USE. Absent for codes that carry none.

object
key
additional properties
any

Example 

{
  "issues": [
    {
      "code": "ACTION_NOT_APPLICABLE",
      "action": "compute:CreateVpc"
    }
  ]
}

403

Section titled “403”

Authenticated but not authorized.

Media typeapplication/problem+json
object
type
required
string format: uri
title
required
string
status
required
integer
>= 400 <= 599
detail
string
instance
string format: uri-reference
requestId
required
string
code
required
string
issues

The findings of a rejected IAM policy document (custom and resource policies).

Array<object>

One finding of a rejected IAM policy document. A rejection lists every finding, so the author fixes the document in one round trip.

object
code
required

The finding, e.g. INVALID_DOCUMENT, UNKNOWN_ACTION, ACTION_NOT_APPLICABLE.

string
statement
required

Index of the statement at fault; -1 for the document as a whole.

integer
>= -1
detail
required
string
action

The offending action, where one is at fault (ACTION_NOT_APPLICABLE).

string
errors

Field errors, for codes that carry them: each problem at its field (see FieldError). Documented on the responses that set it, e.g. approveNodeJoin’s INVALID_INPUT and JOIN_APPROVAL_REFUSED. Absent otherwise.

Array<object>

One field’s problem, the stage-2 installer API’s shape. field is the field’s path, message what is wrong with it.

object
field
required

The field’s path, e.g. links[0].interface, disks[1].confirm, mgmt.address or role; empty for the whole request.

string
message
required
string
details

Structured facts about the refusal, for codes that carry them. The shape is fixed per code and documented on the response that answers it, e.g. IMAGE_POOL_MISMATCH (see ImagePoolMismatchDetails) and IMAGE_IN_USE. Absent for codes that carry none.

object
key
additional properties
any

Example 

{
  "issues": [
    {
      "code": "ACTION_NOT_APPLICABLE",
      "action": "compute:CreateVpc"
    }
  ]
}