This is the multi-page printable view of this section. Click here to print.
Set Stage Configuration
1 - 1.2
scpcli application-apigateway stage set configuration
--api_id <value>
--stage_name <value>
--jwt_enabled <value>
--cors_enabled <value>
[--allow_credentials <value>]
[--allow_headers <value>]
[--allow_methods <value>]
[--allow_origins <value>]
[--connected_api_keys <value>]
[--description <value>]
[--expose_headers <value>]
[--max_age <value>]
[--usage_plan_id <value>]
Description
Set stage configuration
State ACTIVE (CURRENT)
| Version | Supported Until |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
| stage_name required | string | Stage Name | test-stage |
| jwt_enabled required | boolean | JWT Enabled | False |
| cors_enabled required | boolean | Cors Enabled | False |
| allow_credentials optional | boolean | Allow Credentials | True |
| allow_headers optional | array | Allow Headers | Content-Type |
| allow_methods optional | array | Allow Methods | '{}' |
| allow_origins optional | array | Allow Origins | * |
| connected_api_keys optional | array | Connected API Keys | key1 |
| description optional | string | Description | description |
| expose_headers optional | array | Expose Headers | test1 |
| max_age optional | integer | Max Age | 3600 |
| usage_plan_id optional | string | Usage Plan ID | 27bb070b564349f8a31cc60734cc36a5 |
2 - 1.1
scpcli application-apigateway stage set configuration
--api_id <value>
--stage_name <value>
--jwt_enabled <value>
--cors_enabled <value>
[--allow_credentials <value>]
[--allow_headers <value>]
[--allow_methods <value>]
[--allow_origins <value>]
[--connected_api_keys <value>]
[--description <value>]
[--expose_headers <value>]
[--max_age <value>]
[--usage_plan_id <value>]
Description
Set stage configuration
State ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|---|
| 1.1 | 20260430 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
| stage_name required | string | Stage Name | test-stage |
| jwt_enabled required | boolean | JWT Enabled | False |
| cors_enabled required | boolean | Cors Enabled | False |
| allow_credentials optional | boolean | Allow Credentials | True |
| allow_headers optional | array | Allow Headers | Content-Type |
| allow_methods optional | array | Allow Methods | '{}' |
| allow_origins optional | array | Allow Origins | * |
| connected_api_keys optional | array | Connected API Keys | key1 |
| description optional | string | Description | description |
| expose_headers optional | array | Expose Headers | test1 |
| max_age optional | integer | Max Age | 3600 |
| usage_plan_id optional | string | Usage Plan ID | 27bb070b564349f8a31cc60734cc36a5 |
3 - 1.0
scpcli application-apigateway stage set configuration
--api_id <value>
--stage_name <value>
--jwt_enabled <value>
--ip_restriction_enabled <value>
--cors_enabled <value>
[--allow_credentials <value>]
[--allow_headers <value>]
[--allow_methods <value>]
[--allow_origins <value>]
[--expose_headers <value>]
[--max_age <value>]
Description
Set stage configuration(Modifying ip_restriction_enabled is no longer supported)
State ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
| stage_name required | string | Stage Name | test-stage |
| jwt_enabled required | boolean | JWT Enabled | False |
| ip_restriction_enabled required | boolean | IP Restriction Enabled | False |
| cors_enabled required | boolean | Cors Enabled | False |
| allow_credentials optional | boolean | Allow Credentials | True |
| allow_headers optional | array | Allow Headers | Content-Type |
| allow_methods optional | array | Allow Methods | '{}' |
| allow_origins optional | array | Allow Origins | * |
| expose_headers optional | array | Expose Headers | test1 |
| max_age optional | integer | Max Age | 3600 |