This is the multi-page printable view of this section. Click here to print.
ListGuardrails
1 - 1.1
scpcli cloudcontrol guardrail list
[--landing_zone_id <value>]
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--exclude_unit_id <value>]
[--guidance <value>]
[--service_name <value>]
[--status <value>]
Description
get guardrails list
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| landing_zone_id optional | string | Landing Zone ID | 2c8a138f8d78e1fc29a449dbfa8681 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | Guardrail Name | foo-guardrail |
| exclude_unit_id optional | string | Linked(Exclusion) Unit ID | ou-c29a138f8f1d78e24dbfa8681fc2fc8 |
| guidance optional | string | Policy Guidance | MANDATORY |
| service_name optional | string | Organization | iam |
| status optional | string | Application Status | ENABLED |
Responses
| Name | Description | Example |
|---|---|---|
| id | Guardrail ID | 2c8a138f8d78e1fc29a449dbfa8681 |
| binding_ous | ||
| created_at | Created At | 2025-01-01T00:00:00.000Z |
| created_by | Created By | c23fb561c689455993874fa5d5ed4a2f |
| description | Guardrail Description | This is an example guardrail. |
| guidance | Policy Guidance | MANDATORY |
| modified_at | Modified At | 2025-01-01T00:00:00.000Z |
| modified_by | Modified By | c23fb561c689455993874fa5d5ed4a2f |
| name | Guardrail Name | foo-guardrail |
| service_name | Organization | iam |
| srn | Guardrail SRN | srn:dev2:::::cloudcontrol:guardrail/2c8a138f8d78e1fc29a449dbfa8681 |
| status | Application Status | |
| type | Guardrail Type | PREVENTIVE |
2 - 1.0
scpcli cloudcontrol guardrail list
[--landing_zone_id <value>]
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--exclude_unit_id <value>]
[--guidance <value>]
[--service_name <value>]
[--status <value>]
Description
get guardrails list
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| landing_zone_id optional | string | Landing Zone ID | 2c8a138f8d78e1fc29a449dbfa8681 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | Guardrail Name | foo-guardrail |
| exclude_unit_id optional | string | Linked(Exclusion) Unit ID | ou-c29a138f8f1d78e24dbfa8681fc2fc8 |
| guidance optional | string | Policy Guidance | MANDATORY |
| service_name optional | string | Organization | iam |
| status optional | string | Application Status | ENABLED |
Responses
| Name | Description | Example |
|---|---|---|
| id | Guardrail ID | 2c8a138f8d78e1fc29a449dbfa8681 |
| binding_ous | ||
| created_at | Created At | 2025-01-01T00:00:00.000Z |
| created_by | Created By | c23fb561c689455993874fa5d5ed4a2f |
| description | Guardrail Description | This is an example guardrail. |
| guidance | Policy Guidance | MANDATORY |
| modified_at | Modified At | 2025-01-01T00:00:00.000Z |
| modified_by | Modified By | c23fb561c689455993874fa5d5ed4a2f |
| name | Guardrail Name | foo-guardrail |
| service_name | Organization | iam |
| srn | Guardrail SRN | srn:dev2:::::cloudcontrol:guardrail/2c8a138f8d78e1fc29a449dbfa8681 |
| status | Application Status | |
| type | Guardrail Type | PREVENTIVE |