Read the explicit custom-shape policy at a scope.

GET

/v1/admin/compute/custom-shape-policies/{scope}/{scopeId}

Code sample: Shell / cURL

curl --request GET \
  --url https://stratum.example.com/v1/admin/compute/custom-shape-policies/install/example \
  --header 'Authorization: Bearer <token>'

• A Stratum cluster endpoint.

Returns the row exactly as stored — null fields encode “inherit from the parent scope”. 404 when the scope has no explicit row (every field would be inherited).

Cedar action: compute:GetCustomShapePolicy. Install / region scopes are bootstrap-admin only; project scope is gated against the named project..

Authorizations

• bearerAuth

Parameters

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.

Responses

200

The explicit policy row at this scope.

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

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"
    }
  ]
}

404

Resource not found.

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"
    }
  ]
}