This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

API Gateway

Overview

Provides a Command-line Interface (CLI) that supports programmatic use of IaaS/PaaS products provided by SCP.

This guide provides a brief description of API Gateway service and how to call CLI.

Version

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionStatusNot Before
1.3CURRENT-
1.2DEPRECATED20260630
1.1DEPRECATED20260430
1.0DEPRECATED20251231

1 - CLIs

1.1 - Approve PrivateLink Endpoint

1.1.1 - 1.3

scpcli application-apigateway privatelink endpoint approve
--privatelink_endpoint_id <value>
--type <value>
--api_id <value>

Description

Approve PrivateLink Endpoint

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink Endpoint ID27bb070b564349f8a31cc60734cc36a5
type
required
stringPrivateLink Endpoint Action TypeCANCEL
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

1.1.2 - 1.2

scpcli application-apigateway privatelink endpoint approve
--privatelink_endpoint_id <value>
--type <value>
--api_id <value>

Description

Approve PrivateLink Endpoint

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.220260630

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink Endpoint ID27bb070b564349f8a31cc60734cc36a5
type
required
stringPrivateLink Endpoint Action TypeCANCEL
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

1.2 - Connect PrivateLink Endpoint

1.2.1 - 1.3

scpcli application-apigateway privatelink endpoint connect
--privatelink_endpoint_id <value>
--type <value>
--api_id <value>

Description

Connect PrivateLink Endpoint

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink Endpoint ID27bb070b564349f8a31cc60734cc36a5
type
required
stringPrivateLink Endpoint Action TypeCANCEL
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

1.2.2 - 1.2

scpcli application-apigateway privatelink endpoint connect
--privatelink_endpoint_id <value>
--type <value>
--api_id <value>

Description

Connect PrivateLink Endpoint

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.220260630

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink Endpoint ID27bb070b564349f8a31cc60734cc36a5
type
required
stringPrivateLink Endpoint Action TypeCANCEL
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

1.3 - Create AccessControl

1.3.1 - 1.3

scpcli application-apigateway access control create
--api_id <value>
--name <value>
--connected_stages <value>
--allowed_ip_addr <value>
[--description <value>]

Description

Create access control

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID-
name
required
stringAccess Control NameDenyTest
connected_stages
required
arrayConnected Stagesdev,stg
allowed_ip_addr
required
arrayAllowed IP Address127.0.0.1/24,192.168.127.12
description
optional
stringDescriptiondescription

Responses

NameDescriptionExample
idAccess Control ID27bb070b564349f8a31cc60734cc36a5
allowed_ip_addrAllowed IP Address[‘127.0.0.1/24,192.168.127.12’]
connected_stagesConnected Stages[‘dev,stg’]
created_atCreation Date2024-05-19T00:23:17Z
descriptionDescription
nameAccess Control NameDenyTest

1.3.2 - 1.2

scpcli application-apigateway access control create
--api_id <value>
--name <value>
--connected_stages <value>
--allowed_ip_addr <value>
[--description <value>]

Description

Create access control

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.220260630

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID-
name
required
stringAccess Control NameDenyTest
connected_stages
required
arrayConnected Stagesdev,stg
allowed_ip_addr
required
arrayAllowed IP Address127.0.0.1/24,192.168.127.12
description
optional
stringDescriptiondescription

Responses

NameDescriptionExample
idAccess Control ID27bb070b564349f8a31cc60734cc36a5
allowed_ip_addrAllowed IP Address[‘127.0.0.1/24,192.168.127.12’]
connected_stagesConnected Stages[‘dev,stg’]
created_atCreation Date2024-05-19T00:23:17Z
descriptionDescription
nameAccess Control NameDenyTest

1.3.3 - 1.1

scpcli application-apigateway access control create
--api_id <value>
--name <value>
--connected_stages <value>
--allowed_ip_addr <value>
[--description <value>]

Description

Create access control

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID-
name
required
stringAccess Control NameDenyTest
connected_stages
required
arrayConnected Stagesdev,stg
allowed_ip_addr
required
arrayAllowed IP Address127.0.0.1/24,192.168.127.12
description
optional
stringDescriptiondescription

Responses

NameDescriptionExample
idAccess Control ID27bb070b564349f8a31cc60734cc36a5
allowed_ip_addrAllowed IP Address[‘127.0.0.1/24,192.168.127.12’]
connected_stagesConnected Stages[‘dev,stg’]
created_atCreation Date2024-05-19T00:23:17Z
descriptionDescription
nameAccess Control NameDenyTest

1.3.4 - 1.0

scpcli application-apigateway access control create
--api_id <value>
--name <value>
--connected_stages <value>
--allowed_ip_addr <value>
[--description <value>]

Description

Create access control

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID-
name
required
stringAccess Control NameDenyTest
connected_stages
required
arrayConnected Stagesdev,stg
allowed_ip_addr
required
arrayAllowed IP Address127.0.0.1/24,192.168.127.12
description
optional
stringDescriptiondescription

Responses

NameDescriptionExample
idAccess Control ID27bb070b564349f8a31cc60734cc36a5
allowed_ip_addrAllowed IP Address[‘127.0.0.1/24,192.168.127.12’]
connected_stagesConnected Stages[‘dev,stg’]
created_atCreation Date2024-05-19T00:23:17Z
descriptionDescription
nameAccess Control NameDenyTest

1.4 - Create Api

1.4.1 - 1.3

scpcli application-apigateway api create
--name <value>
[--description <value>]
[--endpoint_type <value>]
[--id <value>]
[--tags <value>]

Description

Create api

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
name
required
stringNametest-api
description
optional
stringDescriptiondescription
endpoint_type
optional
stringEndpoint Type-
id
optional
stringApi ID-
tags
optional
arrayTag List'{"key": "key", "value": "value"}'

Responses

NameDescriptionExample
idApi ID27bb070b564349f8a31cc60734cc36a5
descriptionDescriptionDescription
nameNametest-api

1.4.2 - 1.2

scpcli application-apigateway api create
--name <value>
[--description <value>]
[--endpoint_type <value>]
[--id <value>]
[--tags <value>]

Description

Create api

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.220260630

Parameters

NameTypeDescriptionExample
name
required
stringNametest-api
description
optional
stringDescriptiondescription
endpoint_type
optional
stringEndpoint Type-
id
optional
stringApi ID-
tags
optional
arrayTag List'{"key": "key", "value": "value"}'

Responses

NameDescriptionExample
idApi ID27bb070b564349f8a31cc60734cc36a5
descriptionDescriptionDescription
nameNametest-api

1.4.3 - 1.1

scpcli application-apigateway api create
--name <value>
[--description <value>]
[--id <value>]
[--tags <value>]

Description

Create api

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260430

Parameters

NameTypeDescriptionExample
name
required
stringNametest-api
description
optional
stringDescriptiondescription
id
optional
stringApi ID-
tags
optional
arrayTag List'{"key": "key", "value": "value"}'

Responses

NameDescriptionExample
idApi ID27bb070b564349f8a31cc60734cc36a5
descriptionDescriptionDescription
nameNametest-api

1.4.4 - 1.0

scpcli application-apigateway api create
--name <value>
[--description <value>]
[--id <value>]
[--tags <value>]

Description

Create api

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
name
required
stringNametest-api
description
optional
stringDescriptiondescription
id
optional
stringApi ID-
tags
optional
arrayTag List'{"key": "key", "value": "value"}'

Responses

NameDescriptionExample
idApi ID27bb070b564349f8a31cc60734cc36a5
descriptionDescriptionDescription
nameNametest-api

1.5 - Create Api Deployment

1.5.1 - 1.3

scpcli application-apigateway api deploy
--api_id <value>
--stage_type <value>
[--description <value>]
[--stage_name <value>]

Description

Create api deployment

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID31e749b7b260868f441e862b
stage_type
required
stringStage Typenew
description
optional
stringDescriptiondescription
stage_name
optional
stringStage Nametest-stage

Responses

NameDescriptionExample
deployment_idDeployment ID27bb070b564349f8a31cc60734cc36a5
descriptionDescriptiondescription

1.5.2 - 1.2

scpcli application-apigateway api deploy
--api_id <value>
--stage_type <value>
[--description <value>]
[--stage_name <value>]

Description

Create api deployment

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.220260630

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID31e749b7b260868f441e862b
stage_type
required
stringStage Typenew
description
optional
stringDescriptiondescription
stage_name
optional
stringStage Nametest-stage

Responses

NameDescriptionExample
deployment_idDeployment ID27bb070b564349f8a31cc60734cc36a5
descriptionDescriptiondescription

1.5.3 - 1.1

scpcli application-apigateway api deploy
--api_id <value>
--stage_type <value>
[--description <value>]
[--stage_name <value>]

Description

Create api deployment

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID31e749b7b260868f441e862b
stage_type
required
stringStage Typenew
description
optional
stringDescriptiondescription
stage_name
optional
stringStage Nametest-stage

Responses

NameDescriptionExample
deployment_idDeployment ID27bb070b564349f8a31cc60734cc36a5
descriptionDescriptiondescription

1.5.4 - 1.0

scpcli application-apigateway api deploy
--api_id <value>
--stage_type <value>
[--description <value>]
[--stage_name <value>]

Description

Create api deployment

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID31e749b7b260868f441e862b
stage_type
required
stringStage Typenew
description
optional
stringDescriptiondescription
stage_name
optional
stringStage Nametest-stage

Responses

NameDescriptionExample
deployment_idDeployment ID27bb070b564349f8a31cc60734cc36a5
descriptionDescriptiondescription

1.6 - Create Api Key

1.6.1 - 1.3

scpcli application-apigateway api key create
--usage_plan_id <value>
--api_id <value>
--name <value>
[--description <value>]

Description

Create api key

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
usage_plan_id
required
stringUsage Plan ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
name
required
stringNameapi-key-name
description
optional
stringDescriptiondescription

Responses

NameDescriptionExample
idAPI Key ID27bb070b564349f8a31cc60734cc36a5
created_atCreation Date
descriptionDescriptiondescription
keyKeykey
nameNameapi-key-name

1.6.2 - 1.2

scpcli application-apigateway api key create
--usage_plan_id <value>
--api_id <value>
--name <value>
[--description <value>]

Description

Create api key

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.220260630

Parameters

NameTypeDescriptionExample
usage_plan_id
required
stringUsage Plan ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
name
required
stringNameapi-key-name
description
optional
stringDescriptiondescription

Responses

NameDescriptionExample
idAPI Key ID27bb070b564349f8a31cc60734cc36a5
created_atCreation Date
descriptionDescriptiondescription
keyKeykey
nameNameapi-key-name

1.6.3 - 1.1

scpcli application-apigateway api key create
--usage_plan_id <value>
--api_id <value>
--name <value>
[--description <value>]

Description

Create api key

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260430

Parameters

NameTypeDescriptionExample
usage_plan_id
required
stringUsage Plan ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
name
required
stringNameapi-key-name
description
optional
stringDescriptiondescription

Responses

NameDescriptionExample
idAPI Key ID27bb070b564349f8a31cc60734cc36a5
created_atCreation Date
descriptionDescriptiondescription
keyKeykey
nameNameapi-key-name

1.7 - Create Auth

1.7.1 - 1.3

scpcli application-apigateway auth create
--api_id <value>
--name <value>
--expiration_period <value>
--connected_stages <value>

Description

Create auth

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID-
name
required
stringAuth NAMEToken01
expiration_period
required
integerExpiration Period90
connected_stages
required
arrayConnected Stagesdev,stg

Responses

NameDescriptionExample
access_tokenAccess Token***********************************************************

1.7.2 - 1.2

scpcli application-apigateway auth create
--api_id <value>
--name <value>
--expiration_period <value>
--connected_stages <value>

Description

Create auth

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.220260630

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID-
name
required
stringAuth NAMEToken01
expiration_period
required
integerExpiration Period90
connected_stages
required
arrayConnected Stagesdev,stg

Responses

NameDescriptionExample
access_tokenAccess Token***********************************************************

1.7.3 - 1.1

scpcli application-apigateway auth create
--api_id <value>
--name <value>
--expiration_period <value>
--connected_stages <value>

Description

Create auth

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID-
name
required
stringAuth NAMEToken01
expiration_period
required
integerExpiration Period90
connected_stages
required
arrayConnected Stagesdev,stg

Responses

NameDescriptionExample
access_tokenAccess Token***********************************************************

1.7.4 - 1.0

scpcli application-apigateway auth create
--api_id <value>
--name <value>
--expiration_period <value>
--connected_stages <value>

Description

Create auth

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID-
name
required
stringAuth NAMEToken01
expiration_period
required
integerExpiration Period90
connected_stages
required
arrayConnected Stagesdev,stg

Responses

NameDescriptionExample
access_tokenAccess Token***********************************************************

1.8 - Create Method

1.8.1 - 1.3

scpcli application-apigateway method create
--resource_id <value>
--api_id <value>
--method_type <value>
--integration_type <value>
[--api_key_required <value>]
[--endpoint_url <value>]
[--function_id <value>]
[--iam_enabled <value>]
[--privatelink_endpoint_id <value>]
[--query_strings <value>]
[--request_headers <value>]

Description

Create method

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
resource_id
required
stringResource ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
method_type
required
stringMethod TypeGET
integration_type
required
stringMethod Integration TypeHTTP
api_key_required
optional
booleanApi Key RequiredFalse
endpoint_url
optional
stringMethod Endpoint URLhttps://127.0.0.1:8000
function_id
optional
stringCloud Function ID27bb070b564349f8a31cc60734cc36a5
iam_enabled
optional
booleanIAM EnabledFalse
privatelink_endpoint_id
optional
stringPrivateLink Endpoint ID27bb070b564349f8a31cc60734cc36a5
query_strings
optional
objectMethod Query Strings{'param1': 'value1', 'param2': 'value2'}
request_headers
optional
objectMethod Request Headers{'test1' : True}

Responses

NameDescriptionExample
api_key_requiredApi Key RequiredFalse
endpoint_urlMethod Endpoint URLhttps://127.0.0.1:8000
function_idCloud Function ID27bb070b564349f8a31cc60734cc36a5
function_nameCloud Function Nametest-function
iam_enabledIAM EnabledFalse
integration_typeMethod Integration TypeHTTP
method_typeMethod TypeGET
privatelink_endpoint_idPrivateLink Endpoint ID27bb070b564349f8a31cc60734cc36a5
query_stringsMethod Query Strings{‘param1’: ‘value1’, ‘param2’: ‘value2’}
request_headersMethod Request Headers{’test1’ : True}
request_pathMethod Request Path{users}
srnSRNsrn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test

1.8.2 - 1.2

scpcli application-apigateway method create
--resource_id <value>
--api_id <value>
--method_type <value>
--integration_type <value>
[--api_key_required <value>]
[--endpoint_url <value>]
[--function_id <value>]
[--iam_enabled <value>]
[--privatelink_endpoint_id <value>]
[--query_strings <value>]
[--request_headers <value>]

Description

Create method

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.220260630

Parameters

NameTypeDescriptionExample
resource_id
required
stringResource ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
method_type
required
stringMethod TypeGET
integration_type
required
stringMethod Integration TypeHTTP
api_key_required
optional
booleanApi Key RequiredFalse
endpoint_url
optional
stringMethod Endpoint URLhttps://127.0.0.1:8000
function_id
optional
stringCloud Function ID27bb070b564349f8a31cc60734cc36a5
iam_enabled
optional
booleanIAM EnabledFalse
privatelink_endpoint_id
optional
stringPrivateLink Endpoint ID27bb070b564349f8a31cc60734cc36a5
query_strings
optional
objectMethod Query Strings{'param1': 'value1', 'param2': 'value2'}
request_headers
optional
objectMethod Request Headers{'test1' : True}

Responses

NameDescriptionExample
api_key_requiredApi Key RequiredFalse
endpoint_urlMethod Endpoint URLhttps://127.0.0.1:8000
function_idCloud Function ID27bb070b564349f8a31cc60734cc36a5
function_nameCloud Function Nametest-function
integration_typeMethod Integration TypeHTTP
method_typeMethod TypeGET
privatelink_endpoint_idPrivateLink Endpoint ID27bb070b564349f8a31cc60734cc36a5
query_stringsMethod Query Strings{‘param1’: ‘value1’, ‘param2’: ‘value2’}
request_headersMethod Request Headers{’test1’ : True}
request_pathMethod Request Path{users}
srnSRNsrn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test

1.8.3 - 1.1

scpcli application-apigateway method create
--resource_id <value>
--api_id <value>
--method_type <value>
--integration_type <value>
[--api_key_required <value>]
[--endpoint_url <value>]
[--function_id <value>]
[--iam_enabled <value>]
[--privatelink_endpoint_id <value>]
[--query_strings <value>]
[--request_headers <value>]

Description

Create method

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260430

Parameters

NameTypeDescriptionExample
resource_id
required
stringResource ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
method_type
required
stringMethod TypeGET
integration_type
required
stringMethod Integration TypeHTTP
api_key_required
optional
booleanApi Key RequiredFalse
endpoint_url
optional
stringMethod Endpoint URLhttps://127.0.0.1:8000
function_id
optional
stringCloud Function ID27bb070b564349f8a31cc60734cc36a5
iam_enabled
optional
booleanIAM EnabledFalse
privatelink_endpoint_id
optional
stringPrivateLink Endpoint ID27bb070b564349f8a31cc60734cc36a5
query_strings
optional
objectMethod Query Strings{'param1': 'value1', 'param2': 'value2'}
request_headers
optional
objectMethod Request Headers{'test1' : True}

Responses

NameDescriptionExample
api_key_requiredApi Key RequiredFalse
endpoint_urlMethod Endpoint URLhttps://127.0.0.1:8000
function_idCloud Function ID27bb070b564349f8a31cc60734cc36a5
function_nameCloud Function Nametest-function
integration_typeMethod Integration TypeHTTP
method_typeMethod TypeGET
query_stringsMethod Query Strings{‘param1’: ‘value1’, ‘param2’: ‘value2’}
request_headersMethod Request Headers{’test1’ : True}
request_pathMethod Request Path{users}
srnSRNsrn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test

1.8.4 - 1.0

scpcli application-apigateway method create
--resource_id <value>
--api_id <value>
--method_type <value>
--integration_type <value>
[--api_key_required <value>]
[--endpoint_url <value>]
[--function_id <value>]
[--iam_enabled <value>]
[--privatelink_endpoint_id <value>]
[--query_strings <value>]
[--request_headers <value>]

Description

Create method

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
resource_id
required
stringResource ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
method_type
required
stringMethod TypeGET
integration_type
required
stringMethod Integration TypeHTTP
api_key_required
optional
booleanApi Key RequiredFalse
endpoint_url
optional
stringMethod Endpoint URLhttps://127.0.0.1:8000
function_id
optional
stringCloud Function ID27bb070b564349f8a31cc60734cc36a5
iam_enabled
optional
booleanIAM EnabledFalse
privatelink_endpoint_id
optional
stringPrivateLink Endpoint ID27bb070b564349f8a31cc60734cc36a5
query_strings
optional
objectMethod Query Strings{'param1': 'value1', 'param2': 'value2'}
request_headers
optional
objectMethod Request Headers{'test1' : True}

Responses

NameDescriptionExample
endpoint_urlMethod Endpoint URLhttps://127.0.0.1:8000
function_idCloud Function ID27bb070b564349f8a31cc60734cc36a5
integration_typeMethod Integration TypeHTTP
method_typeMethod TypeGET
query_stringsMethod Query Strings{‘param1’: ‘value1’, ‘param2’: ‘value2’}
request_headersMethod Request Headers{’test1’ : True}
request_pathMethod Request Path{users}
srnSRNsrn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test

1.9 - Create PrivateLink Endpoint

1.9.1 - 1.3

scpcli application-apigateway privatelink endpoint create
--privatelink_service_id <value>
--name <value>
[--description <value>]

Description

Create PrivateLink Endpoint

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
privatelink_service_id
required
stringPrivateLink Service ID27bb070b564349f8a31cc60734cc36a5
name
required
stringPrivateLink Endpoint Nameendpoint
description
optional
stringDescriptiondescription

Responses

NameDescriptionExample
idPrivateLink Endpoint ID27bb070b564349f8a31cc60734cc36a5
created_atCreation Date2024-05-17T00:23:17Z
descriptionDescriptiondescription
namePrivateLink Endpoint Nameendpoint
privatelink_service_idPrivateLink Service ID27bb070b564349f8a31cc60734cc36a5
statusPrivateLink Endpoint StatusCANCELED

1.9.2 - 1.2

scpcli application-apigateway privatelink endpoint create
--privatelink_service_id <value>
--name <value>
[--description <value>]

Description

Create PrivateLink Endpoint

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.220260630

Parameters

NameTypeDescriptionExample
privatelink_service_id
required
stringPrivateLink Service ID27bb070b564349f8a31cc60734cc36a5
name
required
stringPrivateLink Endpoint Nameendpoint
description
optional
stringDescriptiondescription

Responses

NameDescriptionExample
idPrivateLink Endpoint ID27bb070b564349f8a31cc60734cc36a5
created_atCreation Date2024-05-17T00:23:17Z
descriptionDescriptiondescription
namePrivateLink Endpoint Nameendpoint
privatelink_service_idPrivateLink Service ID27bb070b564349f8a31cc60734cc36a5
statusPrivateLink Endpoint StatusCANCELED

1.10 - Create Resource

1.10.1 - 1.3

scpcli application-apigateway resource create
--parent_id <value>
--api_id <value>
--path_part <value>

Description

Create resource

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
parent_id
required
stringResource ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
path_part
required
stringPath Parttest

Responses

NameDescriptionExample
idResource ID27bb070b564349f8a31cc60734cc36a5
api_idApi ID27bb070b564349f8a31cc60734cc36a5
parent_idParent Resource ID27bb070b564349f8a31cc60734cc36a5
pathPath

1.10.2 - 1.2

scpcli application-apigateway resource create
--parent_id <value>
--api_id <value>
--path_part <value>

Description

Create resource

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.220260630

Parameters

NameTypeDescriptionExample
parent_id
required
stringResource ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
path_part
required
stringPath Parttest

Responses

NameDescriptionExample
idResource ID27bb070b564349f8a31cc60734cc36a5
api_idApi ID27bb070b564349f8a31cc60734cc36a5
parent_idParent Resource ID27bb070b564349f8a31cc60734cc36a5
pathPath

1.10.3 - 1.1

scpcli application-apigateway resource create
--parent_id <value>
--api_id <value>
--path_part <value>

Description

Create resource

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260430

Parameters

NameTypeDescriptionExample
parent_id
required
stringResource ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
path_part
required
stringPath Parttest

Responses

NameDescriptionExample
idResource ID27bb070b564349f8a31cc60734cc36a5
api_idApi ID27bb070b564349f8a31cc60734cc36a5
parent_idParent Resource ID27bb070b564349f8a31cc60734cc36a5
pathPath

1.10.4 - 1.0

scpcli application-apigateway resource create
--parent_id <value>
--api_id <value>
--path_part <value>

Description

Create resource

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
parent_id
required
stringResource ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
path_part
required
stringPath Parttest

Responses

NameDescriptionExample
idResource ID27bb070b564349f8a31cc60734cc36a5
api_idApi ID27bb070b564349f8a31cc60734cc36a5
parent_idParent Resource ID27bb070b564349f8a31cc60734cc36a5
pathPath

1.11 - Create Stage

1.11.1 - 1.3

scpcli application-apigateway stage create
--api_id <value>
--stage_name <value>
--deployment_id <value>
[--description <value>]

Description

Create stage

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
stage_name
required
stringNametest-stage
deployment_id
required
stringDeployment ID27bb070b564349f8a31cc60734cc36a5
description
optional
stringDescriptiondescription

Responses

NameDescriptionExample
active_deploymentActive Deployment2024-05-17T00:23:17Z
allow_credentialsAllow CredentialsTrue
allow_headersAllow Headers[‘Content-Type’, ‘Authorization’]
allow_methodsAllow Methods[‘GET’, ‘POST’, ‘PUT’, ‘PATCH’]
allow_originsAllow Origins[’*’]
api_idApi ID27bb070b564349f8a31cc60734cc36a5
api_key_requiredApi Key RequiredFalse
cors_enabledCors EnabledFalse
created_atCreation Date
deployment_idDeployment ID27bb070b564349f8a31cc60734cc36a5
descriptionDescriptiondescription
expose_headersExpose Headers[’test1’, ’test2’]
invoke_urlInvoke URLhttp://test.com/stg
jwt_enabledJWT EnabledFalse
max_ageMax Age3600
nameStage Nametest-stage
usage_plan_api_keysAPI Keys[]
usage_plan_idUsage Plan ID27bb070b564349f8a31cc60734cc36a5
usage_plan_limitUsage Plan Limit10
usage_plan_nameNameusage-plan-name
usage_plan_rateUsage Plan Rateday

1.11.2 - 1.2

scpcli application-apigateway stage create
--api_id <value>
--stage_name <value>
--deployment_id <value>
[--description <value>]

Description

Create stage

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.220260630

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
stage_name
required
stringNametest-stage
deployment_id
required
stringDeployment ID27bb070b564349f8a31cc60734cc36a5
description
optional
stringDescriptiondescription

Responses

NameDescriptionExample
active_deploymentActive Deployment2024-05-17T00:23:17Z
allow_credentialsAllow CredentialsTrue
allow_headersAllow Headers[‘Content-Type’, ‘Authorization’]
allow_methodsAllow Methods[‘GET’, ‘POST’, ‘PUT’, ‘PATCH’]
allow_originsAllow Origins[’*’]
api_idApi ID27bb070b564349f8a31cc60734cc36a5
api_key_requiredApi Key RequiredFalse
cors_enabledCors EnabledFalse
created_atCreation Date
deployment_idDeployment ID27bb070b564349f8a31cc60734cc36a5
descriptionDescriptiondescription
expose_headersExpose Headers[’test1’, ’test2’]
invoke_urlInvoke URLhttp://test.com/stg
jwt_enabledJWT EnabledFalse
max_ageMax Age3600
nameStage Nametest-stage
usage_plan_api_keysAPI Keys[]
usage_plan_idUsage Plan ID27bb070b564349f8a31cc60734cc36a5
usage_plan_limitUsage Plan Limit10
usage_plan_nameNameusage-plan-name
usage_plan_rateUsage Plan Rateday

1.11.3 - 1.1

scpcli application-apigateway stage create
--api_id <value>
--stage_name <value>
--deployment_id <value>
[--description <value>]

Description

Create stage

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
stage_name
required
stringNametest-stage
deployment_id
required
stringDeployment ID27bb070b564349f8a31cc60734cc36a5
description
optional
stringDescriptiondescription

Responses

NameDescriptionExample
active_deploymentActive Deployment2024-05-17T00:23:17Z
allow_credentialsAllow CredentialsTrue
allow_headersAllow Headers[‘Content-Type’, ‘Authorization’]
allow_methodsAllow Methods[‘GET’, ‘POST’, ‘PUT’, ‘PATCH’]
allow_originsAllow Origins[’*’]
api_idApi ID27bb070b564349f8a31cc60734cc36a5
api_key_requiredApi Key RequiredFalse
cors_enabledCors EnabledFalse
created_atCreation Date
deployment_idDeployment ID27bb070b564349f8a31cc60734cc36a5
descriptionDescriptiondescription
expose_headersExpose Headers[’test1’, ’test2’]
invoke_urlInvoke URLhttp://test.com/stg
jwt_enabledJWT EnabledFalse
max_ageMax Age3600
nameStage Nametest-stage
usage_plan_api_keysAPI Keys[]
usage_plan_idUsage Plan ID27bb070b564349f8a31cc60734cc36a5
usage_plan_limitUsage Plan Limit10
usage_plan_nameNameusage-plan-name
usage_plan_rateUsage Plan Rateday

1.11.4 - 1.0

scpcli application-apigateway stage create
--api_id <value>
--stage_name <value>
--deployment_id <value>
[--description <value>]

Description

Create stage

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
stage_name
required
stringNametest-stage
deployment_id
required
stringDeployment ID27bb070b564349f8a31cc60734cc36a5
description
optional
stringDescriptiondescription

Responses

NameDescriptionExample
active_deploymentActive Deployment2024-05-17T00:23:17Z
allow_credentialsAllow CredentialsTrue
allow_headersAllow Headers[‘Content-Type’, ‘Authorization’]
allow_methodsAllow Methods[‘GET’, ‘POST’, ‘PUT’, ‘PATCH’]
allow_originsAllow Origins[’*’]
api_idApi ID27bb070b564349f8a31cc60734cc36a5
cors_enabledCors EnabledFalse
created_atCreation Date
deployment_idDeployment ID27bb070b564349f8a31cc60734cc36a5
expose_headersExpose Headers[’test1’, ’test2’]
invoke_urlInvoke URLhttp://test.com/stg
ip_restriction_enabledIP Restriction EnabledFalse
jwt_enabledJWT EnabledFalse
max_ageMax Age3600
nameStage Nametest-stage

1.12 - Create Usage Plans

1.12.1 - 1.3

scpcli application-apigateway usage plan create
--api_id <value>
--rate <value>
--name <value>
--limit <value>
[--description <value>]

Description

Create usage plan

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
rate
required
stringUsage Plan Rateday
name
required
stringNameusage-plan-name
limit
required
integerUsage Plan Limit10
description
optional
stringDescriptiondescription

Responses

NameDescriptionExample
idUsage Plan ID27bb070b564349f8a31cc60734cc36a5
api_keysAPI Keys[]
created_atCreation Date
created_by_idCreated by27bb070b564349f8a31cc60734cc36a5
created_by_nameCreated byusername
descriptionDescriptiondescription
limitUsage Plan Limit10
modified_atModified at
modified_by_idModified by27bb070b564349f8a31cc60734cc36a5
modified_by_nameModified byusername
nameNameusage-plan-name
rateUsage Plan Rateday

1.12.2 - 1.2

scpcli application-apigateway usage plan create
--api_id <value>
--rate <value>
--name <value>
--limit <value>
[--description <value>]

Description

Create usage plan

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.220260630

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
rate
required
stringUsage Plan Rateday
name
required
stringNameusage-plan-name
limit
required
integerUsage Plan Limit10
description
optional
stringDescriptiondescription

Responses

NameDescriptionExample
idUsage Plan ID27bb070b564349f8a31cc60734cc36a5
api_keysAPI Keys[]
created_atCreation Date
created_by_idCreated by27bb070b564349f8a31cc60734cc36a5
created_by_nameCreated byusername
descriptionDescriptiondescription
limitUsage Plan Limit10
modified_atModified at
modified_by_idModified by27bb070b564349f8a31cc60734cc36a5
modified_by_nameModified byusername
nameNameusage-plan-name
rateUsage Plan Rateday

1.12.3 - 1.1

scpcli application-apigateway usage plan create
--api_id <value>
--rate <value>
--name <value>
--limit <value>
[--description <value>]

Description

Create usage plan

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
rate
required
stringUsage Plan Rateday
name
required
stringNameusage-plan-name
limit
required
integerUsage Plan Limit10
description
optional
stringDescriptiondescription

Responses

NameDescriptionExample
idUsage Plan ID27bb070b564349f8a31cc60734cc36a5
api_keysAPI Keys[]
created_atCreation Date
created_by_idCreated by27bb070b564349f8a31cc60734cc36a5
created_by_nameCreated byusername
descriptionDescriptiondescription
limitUsage Plan Limit10
modified_atModified at
modified_by_idModified by27bb070b564349f8a31cc60734cc36a5
modified_by_nameModified byusername
nameNameusage-plan-name
rateUsage Plan Rateday

1.13 - Delete Access Control

1.13.1 - 1.3

scpcli application-apigateway access control delete
--access_control_id <value>
--api_id <value>

Description

Delete access control

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
access_control_id
required
stringAccess Control ID-
api_id
required
stringApi ID-

1.13.2 - 1.2

scpcli application-apigateway access control delete
--access_control_id <value>
--api_id <value>

Description

Delete access control

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.220260630

Parameters

NameTypeDescriptionExample
access_control_id
required
stringAccess Control ID-
api_id
required
stringApi ID-

1.13.3 - 1.1

scpcli application-apigateway access control delete
--access_control_id <value>
--api_id <value>

Description

Delete access control

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260430

Parameters

NameTypeDescriptionExample
access_control_id
required
stringAccess Control ID-
api_id
required
stringApi ID-

1.13.4 - 1.0

scpcli application-apigateway access control delete
--access_control_id <value>
--api_id <value>

Description

Delete access control

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
access_control_id
required
stringAccess Control ID-
api_id
required
stringApi ID-

1.14 - Delete an API Key

1.14.1 - 1.3

scpcli application-apigateway api key delete
--api_key_id <value>
--usage_plan_id <value>
--api_id <value>

Description

Delete api key

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
api_key_id
required
stringAPI Key ID27bb070b564349f8a31cc60734cc36a5
usage_plan_id
required
stringUsage Plan ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

1.14.2 - 1.2

scpcli application-apigateway api key delete
--api_key_id <value>
--usage_plan_id <value>
--api_id <value>

Description

Delete api key

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.220260630

Parameters

NameTypeDescriptionExample
api_key_id
required
stringAPI Key ID27bb070b564349f8a31cc60734cc36a5
usage_plan_id
required
stringUsage Plan ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

1.14.3 - 1.1

scpcli application-apigateway api key delete
--api_key_id <value>
--usage_plan_id <value>
--api_id <value>

Description

Delete api key

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260430

Parameters

NameTypeDescriptionExample
api_key_id
required
stringAPI Key ID27bb070b564349f8a31cc60734cc36a5
usage_plan_id
required
stringUsage Plan ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

1.15 - Delete Api

1.15.1 - 1.3

scpcli application-apigateway api delete
--api_id <value>

Description

Delete api

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID31e749b7b260868f441e862b

1.15.2 - 1.2

scpcli application-apigateway api delete
--api_id <value>

Description

Delete api

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.220260630

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID31e749b7b260868f441e862b

1.15.3 - 1.1

scpcli application-apigateway api delete
--api_id <value>

Description

Delete api

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID31e749b7b260868f441e862b

1.15.4 - 1.0

scpcli application-apigateway api delete
--api_id <value>

Description

Delete api

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID31e749b7b260868f441e862b

1.16 - Delete Auth

1.16.1 - 1.3

scpcli application-apigateway auth delete
--auth_id <value>
--api_id <value>

Description

Delete auth

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
auth_id
required
stringAuth ID-
api_id
required
stringApi ID-

1.16.2 - 1.2

scpcli application-apigateway auth delete
--auth_id <value>
--api_id <value>

Description

Delete auth

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.220260630

Parameters

NameTypeDescriptionExample
auth_id
required
stringAuth ID-
api_id
required
stringApi ID-

1.16.3 - 1.1

scpcli application-apigateway auth delete
--auth_id <value>
--api_id <value>

Description

Delete auth

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260430

Parameters

NameTypeDescriptionExample
auth_id
required
stringAuth ID-
api_id
required
stringApi ID-

1.16.4 - 1.0

scpcli application-apigateway auth delete
--auth_id <value>
--api_id <value>

Description

Delete auth

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
auth_id
required
stringAuth ID-
api_id
required
stringApi ID-

1.17 - Delete Method

1.17.1 - 1.3

scpcli application-apigateway method delete
--method_type <value>
--resource_id <value>
--api_id <value>

Description

Delete method

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
method_type
required
****Method TypeGET
resource_id
required
stringResource ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

1.17.2 - 1.2

scpcli application-apigateway method delete
--method_type <value>
--resource_id <value>
--api_id <value>

Description

Delete method

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.220260630

Parameters

NameTypeDescriptionExample
method_type
required
****Method TypeGET
resource_id
required
stringResource ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

1.17.3 - 1.1

scpcli application-apigateway method delete
--method_type <value>
--resource_id <value>
--api_id <value>

Description

Delete method

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260430

Parameters

NameTypeDescriptionExample
method_type
required
****Method TypeGET
resource_id
required
stringResource ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

1.17.4 - 1.0

scpcli application-apigateway method delete
--method_type <value>
--resource_id <value>
--api_id <value>

Description

Delete method

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
method_type
required
****Method TypeGET
resource_id
required
stringResource ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

1.18 - Delete PrivateLink Endpoint

1.18.1 - 1.3

scpcli application-apigateway privatelink endpoint delete
--privatelink_endpoint_id <value>

Description

Delete PrivateLink Endpoint

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink Endpoint ID27bb070b564349f8a31cc60734cc36a5

1.18.2 - 1.2

scpcli application-apigateway privatelink endpoint delete
--privatelink_endpoint_id <value>

Description

Delete PrivateLink Endpoint

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.220260630

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink Endpoint ID27bb070b564349f8a31cc60734cc36a5

1.19 - Delete Resource

1.19.1 - 1.3

scpcli application-apigateway resource delete
--resource_id <value>
--api_id <value>

Description

Delete resource

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
resource_id
required
stringResource ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

1.19.2 - 1.2

scpcli application-apigateway resource delete
--resource_id <value>
--api_id <value>

Description

Delete resource

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.220260630

Parameters

NameTypeDescriptionExample
resource_id
required
stringResource ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

1.19.3 - 1.1

scpcli application-apigateway resource delete
--resource_id <value>
--api_id <value>

Description

Delete resource

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260430

Parameters

NameTypeDescriptionExample
resource_id
required
stringResource ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

1.19.4 - 1.0

scpcli application-apigateway resource delete
--resource_id <value>
--api_id <value>

Description

Delete resource

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
resource_id
required
stringResource ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

1.20 - Delete Resource Policy

1.20.1 - 1.3

scpcli application-apigateway resource policy delete
--api_id <value>

Description

Delete Resource Policy

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

1.21 - Delete Stage

1.21.1 - 1.3

scpcli application-apigateway stage delete
--api_id <value>
--stage_name <value>

Description

Delete stage

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
stage_name
required
stringStage Nametest-stage

1.21.2 - 1.2

scpcli application-apigateway stage delete
--api_id <value>
--stage_name <value>

Description

Delete stage

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.220260630

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
stage_name
required
stringStage Nametest-stage

1.21.3 - 1.1

scpcli application-apigateway stage delete
--api_id <value>
--stage_name <value>

Description

Delete stage

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
stage_name
required
stringStage Nametest-stage

1.21.4 - 1.0

scpcli application-apigateway stage delete
--api_id <value>
--stage_name <value>

Description

Delete stage

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
stage_name
required
stringStage Nametest-stage

1.22 - Delete Usage Plan

1.22.1 - 1.3

scpcli application-apigateway usage plan delete
--usage_plan_id <value>
--api_id <value>

Description

Delete usage plan

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
usage_plan_id
required
stringUsage Plan ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

1.22.2 - 1.2

scpcli application-apigateway usage plan delete
--usage_plan_id <value>
--api_id <value>

Description

Delete usage plan

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.220260630

Parameters

NameTypeDescriptionExample
usage_plan_id
required
stringUsage Plan ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

1.22.3 - 1.1

scpcli application-apigateway usage plan delete
--usage_plan_id <value>
--api_id <value>

Description

Delete usage plan

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260430

Parameters

NameTypeDescriptionExample
usage_plan_id
required
stringUsage Plan ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

1.23 - List AccessControls

1.23.1 - 1.3

scpcli application-apigateway access control list
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]

Description

Get access controls list

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
idAccess Control ID27bb070b564349f8a31cc60734cc36a5
allowed_ip_addrAllowed IP Address[‘127.0.0.1/24,192.168.127.12’]
connected_stagesConnected Stages[‘dev,stg’]
created_atCreation Date2024-05-19T00:23:17Z
descriptionDescription
nameAccess Control NameDenyTest

1.23.2 - 1.2

scpcli application-apigateway access control list
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]

Description

Get access controls 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.

VersionNot Before
1.220260630

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
idAccess Control ID27bb070b564349f8a31cc60734cc36a5
allowed_ip_addrAllowed IP Address[‘127.0.0.1/24,192.168.127.12’]
connected_stagesConnected Stages[‘dev,stg’]
created_atCreation Date2024-05-19T00:23:17Z
descriptionDescription
nameAccess Control NameDenyTest

1.23.3 - 1.1

scpcli application-apigateway access control list
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]

Description

Get access controls 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.

VersionNot Before
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
idAccess Control ID27bb070b564349f8a31cc60734cc36a5
allowed_ip_addrAllowed IP Address[‘127.0.0.1/24,192.168.127.12’]
connected_stagesConnected Stages[‘dev,stg’]
created_atCreation Date2024-05-19T00:23:17Z
descriptionDescription
nameAccess Control NameDenyTest

1.23.4 - 1.0

scpcli application-apigateway access control list
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]

Description

Get access controls 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.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
idAccess Control ID27bb070b564349f8a31cc60734cc36a5
allowed_ip_addrAllowed IP Address[‘127.0.0.1/24,192.168.127.12’]
connected_stagesConnected Stages[‘dev,stg’]
created_atCreation Date2024-05-19T00:23:17Z
descriptionDescription
nameAccess Control NameDenyTest

1.24 - List Api Deployments

1.24.1 - 1.3

scpcli application-apigateway api deployment list
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--deployment_id <value>]
[--stage_name <value>]

Description

Get api deployments list

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID31e749b7b260868f441e862b
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
deployment_id
optional
stringName27bb070b564349f8a31cc60734cc36a5
stage_name
optional
stringStage Nametest-stage

Responses

NameDescriptionExample
deployment_dateDeployment Date2024-05-17T00:23:17Z
deployment_idDeployment ID27bb070b564349f8a31cc60734cc36a5
descriptionDescriptiondescription
statusStatusActive

1.24.2 - 1.2

scpcli application-apigateway api deployment list
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--deployment_id <value>]
[--stage_name <value>]

Description

Get api deployments 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.

VersionNot Before
1.220260630

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID31e749b7b260868f441e862b
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
deployment_id
optional
stringName27bb070b564349f8a31cc60734cc36a5
stage_name
optional
stringStage Nametest-stage

Responses

NameDescriptionExample
deployment_dateDeployment Date2024-05-17T00:23:17Z
deployment_idDeployment ID27bb070b564349f8a31cc60734cc36a5
descriptionDescriptiondescription
statusStatusActive

1.24.3 - 1.1

scpcli application-apigateway api deployment list
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--deployment_id <value>]
[--stage_name <value>]

Description

Get api deployments 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.

VersionNot Before
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID31e749b7b260868f441e862b
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
deployment_id
optional
stringName27bb070b564349f8a31cc60734cc36a5
stage_name
optional
stringStage Nametest-stage

Responses

NameDescriptionExample
deployment_dateDeployment Date2024-05-17T00:23:17Z
deployment_idDeployment ID27bb070b564349f8a31cc60734cc36a5
descriptionDescriptiondescription
statusStatusActive

1.24.4 - 1.0

scpcli application-apigateway api deployment list
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--deployment_id <value>]
[--stage_name <value>]

Description

Get api deployments 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.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID31e749b7b260868f441e862b
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
deployment_id
optional
stringName27bb070b564349f8a31cc60734cc36a5
stage_name
optional
stringStage Nametest-stage

Responses

NameDescriptionExample
deployment_dateDeployment Date2024-05-17T00:23:17Z
deployment_idDeployment ID27bb070b564349f8a31cc60734cc36a5
descriptionDescriptiondescription
statusStatusActive

1.25 - List Api Keys

1.25.1 - 1.3

scpcli application-apigateway api key list
--usage_plan_id <value>
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]

Description

Get api key list

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
usage_plan_id
required
stringUsage Plan ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringNameapi-key-name

Responses

NameDescriptionExample
idAPI Key ID27bb070b564349f8a31cc60734cc36a5
created_atCreation Date
descriptionDescriptiondescription
keyKeykey
nameNameapi-key-name

1.25.2 - 1.2

scpcli application-apigateway api key list
--usage_plan_id <value>
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]

Description

Get api key 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.

VersionNot Before
1.220260630

Parameters

NameTypeDescriptionExample
usage_plan_id
required
stringUsage Plan ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringNameapi-key-name

Responses

NameDescriptionExample
idAPI Key ID27bb070b564349f8a31cc60734cc36a5
created_atCreation Date
descriptionDescriptiondescription
keyKeykey
nameNameapi-key-name

1.25.3 - 1.1

scpcli application-apigateway api key list
--usage_plan_id <value>
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]

Description

Get api key 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.

VersionNot Before
1.120260430

Parameters

NameTypeDescriptionExample
usage_plan_id
required
stringUsage Plan ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringNameapi-key-name

Responses

NameDescriptionExample
idAPI Key ID27bb070b564349f8a31cc60734cc36a5
created_atCreation Date
descriptionDescriptiondescription
keyKeykey
nameNameapi-key-name

1.26 - List Apis

1.26.1 - 1.3

scpcli application-apigateway api list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]

Description

Get apis list

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringNametest-api

Responses

NameDescriptionExample
idApi ID27bb070b564349f8a31cc60734cc36a5
account_idAccount ID27bb070b564349f8a31cc60734cc36a5
created_atCreation Date2024-05-17T00:23:17Z
descriptionDescriptionDescription
dns_record_statusDNS Record StatusActive
nameNametest-api
statusApi StatusActive

1.26.2 - 1.2

scpcli application-apigateway api list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]

Description

Get apis 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.

VersionNot Before
1.220260630

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringNametest-api

Responses

NameDescriptionExample
idApi ID27bb070b564349f8a31cc60734cc36a5
account_idAccount ID27bb070b564349f8a31cc60734cc36a5
created_atCreation Date2024-05-17T00:23:17Z
descriptionDescriptionDescription
dns_record_statusDNS Record StatusActive
nameNametest-api
statusApi StatusActive

1.26.3 - 1.1

scpcli application-apigateway api list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]

Description

Get apis 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.

VersionNot Before
1.120260430

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringNametest-api

Responses

NameDescriptionExample
idApi ID27bb070b564349f8a31cc60734cc36a5
account_idAccount ID27bb070b564349f8a31cc60734cc36a5
created_atCreation Date2024-05-17T00:23:17Z
descriptionDescriptionDescription
dns_record_statusDNS Record StatusActive
nameNametest-api
statusApi StatusActive

1.26.4 - 1.0

scpcli application-apigateway api list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]

Description

Get apis 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.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringNametest-api

Responses

NameDescriptionExample
idApi ID27bb070b564349f8a31cc60734cc36a5
account_idAccount ID27bb070b564349f8a31cc60734cc36a5
created_atCreation Date2024-05-17T00:23:17Z
descriptionDescriptionDescription
dns_record_statusDNS Record StatusActive
nameNametest-api
statusApi StatusActive

1.27 - List Auths

1.27.1 - 1.3

scpcli application-apigateway auth list
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]

Description

Get auths list

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
idAuth ID27bb070b564349f8a31cc60734cc36a5
auth_methodAUTH MethodJWT(JSON WEB Token)
connected_stagesConnected Stages[‘dev,stg’]
expired_atExpiration Date2024-05-17T00:23:17Z
nameAuth NAMEToken01

1.27.2 - 1.2

scpcli application-apigateway auth list
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]

Description

Get auths 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.

VersionNot Before
1.220260630

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
idAuth ID27bb070b564349f8a31cc60734cc36a5
auth_methodAUTH MethodJWT(JSON WEB Token)
connected_stagesConnected Stages[‘dev,stg’]
expired_atExpiration Date2024-05-17T00:23:17Z
nameAuth NAMEToken01

1.27.3 - 1.1

scpcli application-apigateway auth list
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]

Description

Get auths 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.

VersionNot Before
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
idAuth ID27bb070b564349f8a31cc60734cc36a5
auth_methodAUTH MethodJWT(JSON WEB Token)
connected_stagesConnected Stages[‘dev,stg’]
expired_atExpiration Date2024-05-17T00:23:17Z
nameAuth NAMEToken01

1.27.4 - 1.0

scpcli application-apigateway auth list
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]

Description

Get auths 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.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
idAuth ID27bb070b564349f8a31cc60734cc36a5
auth_methodAUTH MethodJWT(JSON WEB Token)
connected_stagesConnected Stages[‘dev,stg’]
expired_atExpiration Date2024-05-17T00:23:17Z
nameAuth NAMEToken01

1.28 - List Connected PrivateLink Endpoints

1.28.1 - 1.3

scpcli application-apigateway api connected endpoint list
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]

Description

Get connected privatelink endpoints

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID31e749b7b260868f441e862b
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
idPrivateLink Endpoint ID27bb070b564349f8a31cc60734cc36a5
created_atCreation Date2024-05-17T00:23:17Z
statusPrivateLink Endpoint StatusActive

1.28.2 - 1.2

scpcli application-apigateway api connected endpoint list
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]

Description

Get connected privatelink endpoints

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.220260630

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID31e749b7b260868f441e862b
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
idPrivateLink Endpoint ID27bb070b564349f8a31cc60734cc36a5
created_atCreation Date2024-05-17T00:23:17Z
statusPrivateLink Endpoint StatusActive

1.29 - List Methods

1.29.1 - 1.3

scpcli application-apigateway method list
--resource_id <value>
--api_id <value>

Description

Get methods list

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
resource_id
required
stringResource ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
api_key_requiredApi Key RequiredFalse
endpoint_urlMethod Endpoint URLhttps://127.0.0.1:8000
function_idCloud Function ID27bb070b564349f8a31cc60734cc36a5
function_nameCloud Function Nametest-function
iam_enabledIAM EnabledFalse
integration_typeMethod Integration TypeHTTP
method_typeMethod TypeGET
privatelink_endpoint_idPrivateLink Endpoint ID27bb070b564349f8a31cc60734cc36a5
query_stringsMethod Query Strings{‘param1’: ‘value1’, ‘param2’: ‘value2’}
request_headersMethod Request Headers{’test1’ : True}
request_pathMethod Request Path{users}
srnSRNsrn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test

1.29.2 - 1.2

scpcli application-apigateway method list
--resource_id <value>
--api_id <value>

Description

Get methods 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.

VersionNot Before
1.220260630

Parameters

NameTypeDescriptionExample
resource_id
required
stringResource ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
api_key_requiredApi Key RequiredFalse
endpoint_urlMethod Endpoint URLhttps://127.0.0.1:8000
function_idCloud Function ID27bb070b564349f8a31cc60734cc36a5
function_nameCloud Function Nametest-function
integration_typeMethod Integration TypeHTTP
method_typeMethod TypeGET
privatelink_endpoint_idPrivateLink Endpoint ID27bb070b564349f8a31cc60734cc36a5
query_stringsMethod Query Strings{‘param1’: ‘value1’, ‘param2’: ‘value2’}
request_headersMethod Request Headers{’test1’ : True}
request_pathMethod Request Path{users}
srnSRNsrn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test

1.29.3 - 1.1

scpcli application-apigateway method list
--resource_id <value>
--api_id <value>

Description

Get methods 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.

VersionNot Before
1.120260430

Parameters

NameTypeDescriptionExample
resource_id
required
stringResource ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
api_key_requiredApi Key RequiredFalse
endpoint_urlMethod Endpoint URLhttps://127.0.0.1:8000
function_idCloud Function ID27bb070b564349f8a31cc60734cc36a5
function_nameCloud Function Nametest-function
integration_typeMethod Integration TypeHTTP
method_typeMethod TypeGET
query_stringsMethod Query Strings{‘param1’: ‘value1’, ‘param2’: ‘value2’}
request_headersMethod Request Headers{’test1’ : True}
request_pathMethod Request Path{users}
srnSRNsrn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test

1.29.4 - 1.0

scpcli application-apigateway method list
--resource_id <value>
--api_id <value>

Description

Get methods 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.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
resource_id
required
stringResource ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
endpoint_urlMethod Endpoint URLhttps://127.0.0.1:8000
function_idCloud Function ID27bb070b564349f8a31cc60734cc36a5
integration_typeMethod Integration TypeHTTP
method_typeMethod TypeGET
query_stringsMethod Query Strings{‘param1’: ‘value1’, ‘param2’: ‘value2’}
request_headersMethod Request Headers{’test1’ : True}
request_pathMethod Request Path{users}
srnSRNsrn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test

1.30 - List PrivateLink Endpoints

1.30.1 - 1.3

scpcli application-apigateway privatelink endpoint list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]

Description

Get PrivateLink Endpoints list

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringPrivateLink Endpoint Nameendpoint

Responses

NameDescriptionExample
idPrivateLink Endpoint ID27bb070b564349f8a31cc60734cc36a5
created_atCreation Date2024-05-17T00:23:17Z
namePrivateLink Endpoint Nameendpoint
privatelink_service_idPrivateLink Service ID27bb070b564349f8a31cc60734cc36a5
statusPrivateLink Endpoint StatusCANCELED

1.30.2 - 1.2

scpcli application-apigateway privatelink endpoint list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]

Description

Get PrivateLink Endpoints 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.

VersionNot Before
1.220260630

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringPrivateLink Endpoint Nameendpoint

Responses

NameDescriptionExample
idPrivateLink Endpoint ID27bb070b564349f8a31cc60734cc36a5
created_atCreation Date2024-05-17T00:23:17Z
namePrivateLink Endpoint Nameendpoint
privatelink_service_idPrivateLink Service ID27bb070b564349f8a31cc60734cc36a5
statusPrivateLink Endpoint StatusCANCELED

1.31 - List Reports

1.31.1 - 1.3

scpcli application-apigateway report list
--api_id <value>
--end_date <value>
--start_date <value>
--stage_name <value>

Description

Get reports list

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
end_date
required
stringEnd Date2025-07-30
start_date
required
stringStart Date2025-07-01
stage_name
required
stringStage Nametest-stage

Responses

NameDescriptionExample
call_countCall Count10
dateDate
error_4xx_countError 4xx Count10
error_5xx_countError 5xx Count10
integration_latencyIntegration Latency10
latencyLatency10

1.31.2 - 1.2

scpcli application-apigateway report list
--api_id <value>
--end_date <value>
--start_date <value>
--stage_name <value>

Description

Get reports 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.

VersionNot Before
1.220260630

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
end_date
required
stringEnd Date2025-07-30
start_date
required
stringStart Date2025-07-01
stage_name
required
stringStage Nametest-stage

Responses

NameDescriptionExample
call_countCall Count10
dateDate
error_4xx_countError 4xx Count10
error_5xx_countError 5xx Count10
integration_latencyIntegration Latency10
latencyLatency10

1.31.3 - 1.1

scpcli application-apigateway report list
--api_id <value>
--end_date <value>
--start_date <value>
--stage_name <value>

Description

Get reports 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.

VersionNot Before
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
end_date
required
stringEnd Date2025-07-30
start_date
required
stringStart Date2025-07-01
stage_name
required
stringStage Nametest-stage

Responses

NameDescriptionExample
call_countCall Count10
dateDate
error_4xx_countError 4xx Count10
error_5xx_countError 5xx Count10
integration_latencyIntegration Latency10
latencyLatency10

1.32 - List Resources

1.32.1 - 1.3

scpcli application-apigateway resource list
--api_id <value>

Description

Get resources list

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
idResource ID27bb070b564349f8a31cc60734cc36a5
methods
parent_idParent Resource ID27bb070b564349f8a31cc60734cc36a5
pathPath/test/test1
path_partPath Parttest

1.32.2 - 1.2

scpcli application-apigateway resource list
--api_id <value>

Description

Get resources 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.

VersionNot Before
1.220260630

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
idResource ID27bb070b564349f8a31cc60734cc36a5
methods
parent_idParent Resource ID27bb070b564349f8a31cc60734cc36a5
pathPath/test/test1
path_partPath Parttest

1.32.3 - 1.1

scpcli application-apigateway resource list
--api_id <value>

Description

Get resources 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.

VersionNot Before
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
idResource ID27bb070b564349f8a31cc60734cc36a5
methods
parent_idParent Resource ID27bb070b564349f8a31cc60734cc36a5
pathPath/test/test1
path_partPath Parttest

1.32.4 - 1.0

scpcli application-apigateway resource list
--api_id <value>

Description

Get resources 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.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
idResource ID27bb070b564349f8a31cc60734cc36a5
methods
parent_idParent Resource ID27bb070b564349f8a31cc60734cc36a5
pathPath/test/test1
path_partPath Parttest

1.33 - List Stages

1.33.1 - 1.3

scpcli application-apigateway stage list
--api_id <value>

Description

Get stages list

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
active_deploymentActive Deployment2024-05-17T00:23:17Z
allow_credentialsAllow CredentialsTrue
allow_headersAllow Headers[‘Content-Type’, ‘Authorization’]
allow_methodsAllow Methods[‘GET’, ‘POST’, ‘PUT’, ‘PATCH’]
allow_originsAllow Origins[’*’]
api_idApi ID27bb070b564349f8a31cc60734cc36a5
api_summaryAPI Summary[{‘methods’: [{‘api_key_required’: True, ‘iam_enabled’: True, ’type’: ‘GET’}, {‘api_key_required’: False, ‘iam_enabled’: False, ’type’: ‘POST’}], ‘path’: ‘/’}, {‘methods’: [{‘api_key_required’: True, ‘iam_enabled’: True, ’type’: ‘GET’}, {‘api_key_required’: False, ‘iam_enabled’: False, ’type’: ‘POST’}], ‘path’: ‘/test’}]
cors_enabledCors EnabledFalse
created_atCreation Date
deployment_idDeployment ID27bb070b564349f8a31cc60734cc36a5
descriptionDescriptiondescription
expose_headersExpose Headers[’test1’, ’test2’]
invoke_urlInvoke URLhttp://test.com/stg
jwt_enabledJWT EnabledFalse
max_ageMax Age3600
nameStage Nametest-stage
usage_plan_api_keysAPI Keys[]
usage_plan_idUsage Plan ID27bb070b564349f8a31cc60734cc36a5
usage_plan_limitUsage Plan Limit10
usage_plan_nameNameusage-plan-name
usage_plan_rateUsage Plan Rateday

1.33.2 - 1.2

scpcli application-apigateway stage list
--api_id <value>

Description

Get stages 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.

VersionNot Before
1.220260630

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
active_deploymentActive Deployment2024-05-17T00:23:17Z
allow_credentialsAllow CredentialsTrue
allow_headersAllow Headers[‘Content-Type’, ‘Authorization’]
allow_methodsAllow Methods[‘GET’, ‘POST’, ‘PUT’, ‘PATCH’]
allow_originsAllow Origins[’*’]
api_idApi ID27bb070b564349f8a31cc60734cc36a5
api_key_requiredApi Key RequiredFalse
api_summaryAPI Summary[{‘methods’: [{‘api_key_required’: True, ’type’: ‘GET’}, {‘api_key_required’: False, ’type’: ‘POST’}], ‘path’: ‘/’}, {‘methods’: [{‘api_key_required’: True, ’type’: ‘GET’}, {‘api_key_required’: False, ’type’: ‘POST’}], ‘path’: ‘/test’}]
cors_enabledCors EnabledFalse
created_atCreation Date
deployment_idDeployment ID27bb070b564349f8a31cc60734cc36a5
descriptionDescriptiondescription
expose_headersExpose Headers[’test1’, ’test2’]
invoke_urlInvoke URLhttp://test.com/stg
jwt_enabledJWT EnabledFalse
max_ageMax Age3600
nameStage Nametest-stage
usage_plan_api_keysAPI Keys[]
usage_plan_idUsage Plan ID27bb070b564349f8a31cc60734cc36a5
usage_plan_limitUsage Plan Limit10
usage_plan_nameNameusage-plan-name
usage_plan_rateUsage Plan Rateday

1.33.3 - 1.1

scpcli application-apigateway stage list
--api_id <value>

Description

Get stages 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.

VersionNot Before
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
active_deploymentActive Deployment2024-05-17T00:23:17Z
allow_credentialsAllow CredentialsTrue
allow_headersAllow Headers[‘Content-Type’, ‘Authorization’]
allow_methodsAllow Methods[‘GET’, ‘POST’, ‘PUT’, ‘PATCH’]
allow_originsAllow Origins[’*’]
api_idApi ID27bb070b564349f8a31cc60734cc36a5
api_key_requiredApi Key RequiredFalse
api_summaryAPI Summary[{‘methods’: [{‘api_key_required’: True, ’type’: ‘GET’}, {‘api_key_required’: False, ’type’: ‘POST’}], ‘path’: ‘/’}, {‘methods’: [{‘api_key_required’: True, ’type’: ‘GET’}, {‘api_key_required’: False, ’type’: ‘POST’}], ‘path’: ‘/test’}]
cors_enabledCors EnabledFalse
created_atCreation Date
deployment_idDeployment ID27bb070b564349f8a31cc60734cc36a5
descriptionDescriptiondescription
expose_headersExpose Headers[’test1’, ’test2’]
invoke_urlInvoke URLhttp://test.com/stg
jwt_enabledJWT EnabledFalse
max_ageMax Age3600
nameStage Nametest-stage
usage_plan_api_keysAPI Keys[]
usage_plan_idUsage Plan ID27bb070b564349f8a31cc60734cc36a5
usage_plan_limitUsage Plan Limit10
usage_plan_nameNameusage-plan-name
usage_plan_rateUsage Plan Rateday

1.33.4 - 1.0

scpcli application-apigateway stage list
--api_id <value>

Description

Get stages 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.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
active_deploymentActive Deployment2024-05-17T00:23:17Z
allow_credentialsAllow CredentialsTrue
allow_headersAllow Headers[‘Content-Type’, ‘Authorization’]
allow_methodsAllow Methods[‘GET’, ‘POST’, ‘PUT’, ‘PATCH’]
allow_originsAllow Origins[’*’]
api_idApi ID27bb070b564349f8a31cc60734cc36a5
api_summaryAPI Summary[{‘methods’: [‘GET’, ‘POST’], ‘path’: ‘/’}, {‘methods’: [‘GET’, ‘POST’], ‘path’: ‘/test’}]
cors_enabledCors EnabledFalse
created_atCreation Date
deployment_idDeployment ID27bb070b564349f8a31cc60734cc36a5
expose_headersExpose Headers[’test1’, ’test2’]
invoke_urlInvoke URLhttp://test.com/stg
ip_restriction_enabledIP Restriction EnabledFalse
jwt_enabledJWT EnabledFalse
max_ageMax Age3600
nameStage Nametest-stage

1.34 - List Usage Plans

1.34.1 - 1.3

scpcli application-apigateway usage plan list
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]

Description

Get usage plans list

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringNameusage-plan-name

Responses

NameDescriptionExample
idUsage Plan ID27bb070b564349f8a31cc60734cc36a5
connected_api_keysConnected API Keys[‘key1’, ‘key2’]
created_atCreation Date
descriptionDescriptiondescription
limitUsage Plan Limit10
nameNameusage-plan-name
rateUsage Plan Rateday

1.34.2 - 1.2

scpcli application-apigateway usage plan list
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]

Description

Get usage plans 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.

VersionNot Before
1.220260630

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringNameusage-plan-name

Responses

NameDescriptionExample
idUsage Plan ID27bb070b564349f8a31cc60734cc36a5
connected_api_keysConnected API Keys[‘key1’, ‘key2’]
created_atCreation Date
descriptionDescriptiondescription
limitUsage Plan Limit10
nameNameusage-plan-name
rateUsage Plan Rateday

1.34.3 - 1.1

scpcli application-apigateway usage plan list
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]

Description

Get usage plans 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.

VersionNot Before
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringNameusage-plan-name

Responses

NameDescriptionExample
idUsage Plan ID27bb070b564349f8a31cc60734cc36a5
connected_api_keysConnected API Keys[‘key1’, ‘key2’]
created_atCreation Date
descriptionDescriptiondescription
limitUsage Plan Limit10
nameNameusage-plan-name
rateUsage Plan Rateday

1.35 - Request PrivateLink Endpoint

1.35.1 - 1.3

scpcli application-apigateway privatelink endpoint request
--privatelink_endpoint_id <value>
--type <value>

Description

Request PrivateLink Endpoint

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink Endpoint ID27bb070b564349f8a31cc60734cc36a5
type
required
stringPrivateLink Endpoint Action TypeCANCEL

1.35.2 - 1.2

scpcli application-apigateway privatelink endpoint request
--privatelink_endpoint_id <value>
--type <value>

Description

Request PrivateLink Endpoint

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.220260630

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink Endpoint ID27bb070b564349f8a31cc60734cc36a5
type
required
stringPrivateLink Endpoint Action TypeCANCEL

1.36 - Set Access Control

1.36.1 - 1.3

scpcli application-apigateway access control set
--access_control_id <value>
--api_id <value>
--connected_stages <value>
--allowed_ip_addr <value>
[--description <value>]

Description

Set access control

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
access_control_id
required
stringAccess Control ID-
api_id
required
stringApi ID-
connected_stages
required
arrayConnected Stagesdev,stg
allowed_ip_addr
required
arrayAllowed IP Address127.0.0.1/24,192.168.127.12
description
optional
stringDescriptiondescription

1.36.2 - 1.2

scpcli application-apigateway access control set
--access_control_id <value>
--api_id <value>
--connected_stages <value>
--allowed_ip_addr <value>
[--description <value>]

Description

Set access control

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.220260630

Parameters

NameTypeDescriptionExample
access_control_id
required
stringAccess Control ID-
api_id
required
stringApi ID-
connected_stages
required
arrayConnected Stagesdev,stg
allowed_ip_addr
required
arrayAllowed IP Address127.0.0.1/24,192.168.127.12
description
optional
stringDescriptiondescription

1.36.3 - 1.1

scpcli application-apigateway access control set
--access_control_id <value>
--api_id <value>
--connected_stages <value>
--allowed_ip_addr <value>
[--description <value>]

Description

Set access control

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260430

Parameters

NameTypeDescriptionExample
access_control_id
required
stringAccess Control ID-
api_id
required
stringApi ID-
connected_stages
required
arrayConnected Stagesdev,stg
allowed_ip_addr
required
arrayAllowed IP Address127.0.0.1/24,192.168.127.12
description
optional
stringDescriptiondescription

1.36.4 - 1.0

scpcli application-apigateway access control set
--access_control_id <value>
--api_id <value>
--connected_stages <value>
--allowed_ip_addr <value>
[--description <value>]

Description

Set access control

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
access_control_id
required
stringAccess Control ID-
api_id
required
stringApi ID-
connected_stages
required
arrayConnected Stagesdev,stg
allowed_ip_addr
required
arrayAllowed IP Address127.0.0.1/24,192.168.127.12
description
optional
stringDescriptiondescription

1.37 - Set Api Description

1.37.1 - 1.3

scpcli application-apigateway api description set
--api_id <value>
[--description <value>]

Description

Set api description

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID31e749b7b260868f441e862b
description
optional
stringDescriptiondescription

1.37.2 - 1.2

scpcli application-apigateway api description set
--api_id <value>
[--description <value>]

Description

Set api description

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.220260630

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID31e749b7b260868f441e862b
description
optional
stringDescriptiondescription

1.37.3 - 1.1

scpcli application-apigateway api description set
--api_id <value>
[--description <value>]

Description

Set api description

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID31e749b7b260868f441e862b
description
optional
stringDescriptiondescription

1.37.4 - 1.0

scpcli application-apigateway api description set
--api_id <value>
[--description <value>]

Description

Set api description

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID31e749b7b260868f441e862b
description
optional
stringDescriptiondescription

1.38 - Set API Key Description

1.38.1 - 1.3

scpcli application-apigateway api key set
--api_key_id <value>
--usage_plan_id <value>
--api_id <value>
[--description <value>]

Description

Set api key

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
api_key_id
required
stringAPI Key ID27bb070b564349f8a31cc60734cc36a5
usage_plan_id
required
stringUsage Plan ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
description
optional
stringDescriptiondescription

1.38.2 - 1.2

scpcli application-apigateway api key set
--api_key_id <value>
--usage_plan_id <value>
--api_id <value>
[--description <value>]

Description

Set api key

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.220260630

Parameters

NameTypeDescriptionExample
api_key_id
required
stringAPI Key ID27bb070b564349f8a31cc60734cc36a5
usage_plan_id
required
stringUsage Plan ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
description
optional
stringDescriptiondescription

1.38.3 - 1.1

scpcli application-apigateway api key set
--api_key_id <value>
--usage_plan_id <value>
--api_id <value>
[--description <value>]

Description

Set api key

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260430

Parameters

NameTypeDescriptionExample
api_key_id
required
stringAPI Key ID27bb070b564349f8a31cc60734cc36a5
usage_plan_id
required
stringUsage Plan ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
description
optional
stringDescriptiondescription

1.39 - Set Auth

1.39.1 - 1.3

scpcli application-apigateway auth set
--auth_id <value>
--api_id <value>
--connected_stages <value>

Description

Set auth

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
auth_id
required
stringAuth ID-
api_id
required
stringApi ID-
connected_stages
required
arrayConnected Stagesdev,stg

1.39.2 - 1.2

scpcli application-apigateway auth set
--auth_id <value>
--api_id <value>
--connected_stages <value>

Description

Set auth

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.220260630

Parameters

NameTypeDescriptionExample
auth_id
required
stringAuth ID-
api_id
required
stringApi ID-
connected_stages
required
arrayConnected Stagesdev,stg

1.39.3 - 1.1

scpcli application-apigateway auth set
--auth_id <value>
--api_id <value>
--connected_stages <value>

Description

Set auth

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260430

Parameters

NameTypeDescriptionExample
auth_id
required
stringAuth ID-
api_id
required
stringApi ID-
connected_stages
required
arrayConnected Stagesdev,stg

1.39.4 - 1.0

scpcli application-apigateway auth set
--auth_id <value>
--api_id <value>
--connected_stages <value>

Description

Set auth

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
auth_id
required
stringAuth ID-
api_id
required
stringApi ID-
connected_stages
required
arrayConnected Stagesdev,stg

1.40 - Set Method

1.40.1 - 1.3

scpcli application-apigateway method set
--method_type <value>
--resource_id <value>
--api_id <value>
--request_headers <value>
--query_strings <value>
--integration_type <value>
--iam_enabled <value>
--api_key_required <value>
[--endpoint_url <value>]
[--function_id <value>]
[--privatelink_endpoint_id <value>]

Description

Set method

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
method_type
required
****Method TypeGET
resource_id
required
stringResource ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
request_headers
required
dictMethod Request Headers{'test1' : True}
query_strings
required
dictMethod Query Strings{'param1': 'value1', 'param2': 'value2'}
integration_type
required
stringMethod Integration TypeHTTP
iam_enabled
required
booleanIAM EnabledFalse
api_key_required
required
booleanApi Key RequiredFalse
endpoint_url
optional
stringMethod Endpoint URLhttps://127.0.0.1:8000
function_id
optional
stringCloud Function ID27bb070b564349f8a31cc60734cc36a5
privatelink_endpoint_id
optional
stringPrivateLink Endpoint ID27bb070b564349f8a31cc60734cc36a5

1.40.2 - 1.2

scpcli application-apigateway method set
--method_type <value>
--resource_id <value>
--api_id <value>
--request_headers <value>
--query_strings <value>
--integration_type <value>
--api_key_required <value>
[--endpoint_url <value>]
[--function_id <value>]
[--privatelink_endpoint_id <value>]

Description

Set method

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.220260630

Parameters

NameTypeDescriptionExample
method_type
required
****Method TypeGET
resource_id
required
stringResource ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
request_headers
required
dictMethod Request Headers{'test1' : True}
query_strings
required
dictMethod Query Strings{'param1': 'value1', 'param2': 'value2'}
integration_type
required
stringMethod Integration TypeHTTP
api_key_required
required
booleanApi Key RequiredFalse
endpoint_url
optional
stringMethod Endpoint URLhttps://127.0.0.1:8000
function_id
optional
stringCloud Function ID27bb070b564349f8a31cc60734cc36a5
privatelink_endpoint_id
optional
stringPrivateLink Endpoint ID27bb070b564349f8a31cc60734cc36a5

1.40.3 - 1.1

scpcli application-apigateway method set
--method_type <value>
--resource_id <value>
--api_id <value>
--request_headers <value>
--query_strings <value>
--integration_type <value>
--api_key_required <value>
[--endpoint_url <value>]
[--function_id <value>]
[--privatelink_endpoint_id <value>]

Description

Set method

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260430

Parameters

NameTypeDescriptionExample
method_type
required
****Method TypeGET
resource_id
required
stringResource ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
request_headers
required
dictMethod Request Headers{'test1' : True}
query_strings
required
dictMethod Query Strings{'param1': 'value1', 'param2': 'value2'}
integration_type
required
stringMethod Integration TypeHTTP
api_key_required
required
booleanApi Key RequiredFalse
endpoint_url
optional
stringMethod Endpoint URLhttps://127.0.0.1:8000
function_id
optional
stringCloud Function ID27bb070b564349f8a31cc60734cc36a5
privatelink_endpoint_id
optional
stringPrivateLink Endpoint ID27bb070b564349f8a31cc60734cc36a5

1.40.4 - 1.0

scpcli application-apigateway method set
--method_type <value>
--resource_id <value>
--api_id <value>
--request_headers <value>
--query_strings <value>

Description

Set method

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
method_type
required
****Method TypeGET
resource_id
required
stringResource ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
request_headers
required
dictMethod Request Headers{'test1' : True}
query_strings
required
dictMethod Query Strings{'param1': 'value1', 'param2': 'value2'}

1.41 - Set PrivateLink Endpoint

1.41.1 - 1.3

scpcli application-apigateway privatelink endpoint set
--privatelink_endpoint_id <value>
[--description <value>]

Description

Set PrivateLink Endpoint

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink Endpoint ID27bb070b564349f8a31cc60734cc36a5
description
optional
stringDescriptiondescription

1.41.2 - 1.2

scpcli application-apigateway privatelink endpoint set
--privatelink_endpoint_id <value>
[--description <value>]

Description

Set PrivateLink Endpoint

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.220260630

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink Endpoint ID27bb070b564349f8a31cc60734cc36a5
description
optional
stringDescriptiondescription

1.42 - Set Resource Policy

1.42.1 - 1.3

scpcli application-apigateway resource policy set
--api_id <value>
--version <value>
--statement <value>

Description

Set Resource Policy

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
version
required
stringVersion2024-07-01
statement
required
arrayStatement'{"Action": ["iam:*"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": ["*"], "Sid": "Statement1"}'

1.43 - Set Stage Active Deployment

1.43.1 - 1.3

scpcli application-apigateway stage set active deployment
--api_id <value>
--stage_name <value>
--deployment_id <value>

Description

Set stage active deployment

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
stage_name
required
stringStage Nametest-stage
deployment_id
required
stringDeployment ID27bb070b564349f8a31cc60734cc36a5

1.43.2 - 1.2

scpcli application-apigateway stage set active deployment
--api_id <value>
--stage_name <value>
--deployment_id <value>

Description

Set stage active deployment

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.220260630

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
stage_name
required
stringStage Nametest-stage
deployment_id
required
stringDeployment ID27bb070b564349f8a31cc60734cc36a5

1.43.3 - 1.1

scpcli application-apigateway stage set active deployment
--api_id <value>
--stage_name <value>
--deployment_id <value>

Description

Set stage active deployment

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
stage_name
required
stringStage Nametest-stage
deployment_id
required
stringDeployment ID27bb070b564349f8a31cc60734cc36a5

1.43.4 - 1.0

scpcli application-apigateway stage set active deployment
--api_id <value>
--stage_name <value>
--deployment_id <value>

Description

Set stage active deployment

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
stage_name
required
stringStage Nametest-stage
deployment_id
required
stringDeployment ID27bb070b564349f8a31cc60734cc36a5

1.44 - Set Stage Configuration

1.44.1 - 1.3

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)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
stage_name
required
stringStage Nametest-stage
jwt_enabled
required
booleanJWT EnabledFalse
cors_enabled
required
booleanCors EnabledFalse
allow_credentials
optional
booleanAllow CredentialsTrue
allow_headers
optional
arrayAllow HeadersContent-Type
allow_methods
optional
arrayAllow Methods'{}'
allow_origins
optional
arrayAllow Origins*
connected_api_keys
optional
arrayConnected API Keyskey1
description
optional
stringDescriptiondescription
expose_headers
optional
arrayExpose Headerstest1
max_age
optional
integerMax Age3600
usage_plan_id
optional
stringUsage Plan ID27bb070b564349f8a31cc60734cc36a5

1.44.2 - 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 (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.220260630

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
stage_name
required
stringStage Nametest-stage
jwt_enabled
required
booleanJWT EnabledFalse
cors_enabled
required
booleanCors EnabledFalse
allow_credentials
optional
booleanAllow CredentialsTrue
allow_headers
optional
arrayAllow HeadersContent-Type
allow_methods
optional
arrayAllow Methods'{}'
allow_origins
optional
arrayAllow Origins*
connected_api_keys
optional
arrayConnected API Keyskey1
description
optional
stringDescriptiondescription
expose_headers
optional
arrayExpose Headerstest1
max_age
optional
integerMax Age3600
usage_plan_id
optional
stringUsage Plan ID27bb070b564349f8a31cc60734cc36a5

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

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
stage_name
required
stringStage Nametest-stage
jwt_enabled
required
booleanJWT EnabledFalse
cors_enabled
required
booleanCors EnabledFalse
allow_credentials
optional
booleanAllow CredentialsTrue
allow_headers
optional
arrayAllow HeadersContent-Type
allow_methods
optional
arrayAllow Methods'{}'
allow_origins
optional
arrayAllow Origins*
connected_api_keys
optional
arrayConnected API Keyskey1
description
optional
stringDescriptiondescription
expose_headers
optional
arrayExpose Headerstest1
max_age
optional
integerMax Age3600
usage_plan_id
optional
stringUsage Plan ID27bb070b564349f8a31cc60734cc36a5

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

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
stage_name
required
stringStage Nametest-stage
jwt_enabled
required
booleanJWT EnabledFalse
ip_restriction_enabled
required
booleanIP Restriction EnabledFalse
cors_enabled
required
booleanCors EnabledFalse
allow_credentials
optional
booleanAllow CredentialsTrue
allow_headers
optional
arrayAllow HeadersContent-Type
allow_methods
optional
arrayAllow Methods'{}'
allow_origins
optional
arrayAllow Origins*
expose_headers
optional
arrayExpose Headerstest1
max_age
optional
integerMax Age3600

1.45 - Set Usage Plan Description

1.45.1 - 1.3

scpcli application-apigateway usage plan set description
--usage_plan_id <value>
--api_id <value>
[--description <value>]

Description

Set usage plan description

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
usage_plan_id
required
stringUsage Plan ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
description
optional
stringDescriptiondescription

1.45.2 - 1.2

scpcli application-apigateway usage plan set description
--usage_plan_id <value>
--api_id <value>
[--description <value>]

Description

Set usage plan description

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.220260630

Parameters

NameTypeDescriptionExample
usage_plan_id
required
stringUsage Plan ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
description
optional
stringDescriptiondescription

1.45.3 - 1.1

scpcli application-apigateway usage plan set description
--usage_plan_id <value>
--api_id <value>
[--description <value>]

Description

Set usage plan description

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260430

Parameters

NameTypeDescriptionExample
usage_plan_id
required
stringUsage Plan ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
description
optional
stringDescriptiondescription

1.46 - Set Usage Plan Quota

1.46.1 - 1.3

scpcli application-apigateway usage plan set quota
--usage_plan_id <value>
--api_id <value>
--rate <value>
--limit <value>

Description

Set usage plan quota

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
usage_plan_id
required
stringUsage Plan ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
rate
required
stringUsage Plan Rateday
limit
required
integerUsage Plan Limit10

1.46.2 - 1.2

scpcli application-apigateway usage plan set quota
--usage_plan_id <value>
--api_id <value>
--rate <value>
--limit <value>

Description

Set usage plan quota

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.220260630

Parameters

NameTypeDescriptionExample
usage_plan_id
required
stringUsage Plan ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
rate
required
stringUsage Plan Rateday
limit
required
integerUsage Plan Limit10

1.46.3 - 1.1

scpcli application-apigateway usage plan set quota
--usage_plan_id <value>
--api_id <value>
--rate <value>
--limit <value>

Description

Set usage plan quota

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260430

Parameters

NameTypeDescriptionExample
usage_plan_id
required
stringUsage Plan ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
rate
required
stringUsage Plan Rateday
limit
required
integerUsage Plan Limit10

1.47 - Show Access Control

1.47.1 - 1.3

scpcli application-apigateway access control show
--access_control_id <value>
--api_id <value>

Description

Show access control

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
access_control_id
required
stringAccess Control ID-
api_id
required
stringApi ID-

Responses

NameDescriptionExample
idAccess Control ID27bb070b564349f8a31cc60734cc36a5
allowed_ip_addrAllowed IP Address[‘127.0.0.1/24,192.168.127.12’]
connected_stagesConnected Stages[‘dev,stg’]
created_atCreation Date2024-05-19T00:23:17Z
descriptionDescription
nameAccess Control NameDenyTest

1.47.2 - 1.2

scpcli application-apigateway access control show
--access_control_id <value>
--api_id <value>

Description

Show access control

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.220260630

Parameters

NameTypeDescriptionExample
access_control_id
required
stringAccess Control ID-
api_id
required
stringApi ID-

Responses

NameDescriptionExample
idAccess Control ID27bb070b564349f8a31cc60734cc36a5
allowed_ip_addrAllowed IP Address[‘127.0.0.1/24,192.168.127.12’]
connected_stagesConnected Stages[‘dev,stg’]
created_atCreation Date2024-05-19T00:23:17Z
descriptionDescription
nameAccess Control NameDenyTest

1.47.3 - 1.1

scpcli application-apigateway access control show
--access_control_id <value>
--api_id <value>

Description

Show access control

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260430

Parameters

NameTypeDescriptionExample
access_control_id
required
stringAccess Control ID-
api_id
required
stringApi ID-

Responses

NameDescriptionExample
idAccess Control ID27bb070b564349f8a31cc60734cc36a5
allowed_ip_addrAllowed IP Address[‘127.0.0.1/24,192.168.127.12’]
connected_stagesConnected Stages[‘dev,stg’]
created_atCreation Date2024-05-19T00:23:17Z
descriptionDescription
nameAccess Control NameDenyTest

1.47.4 - 1.0

scpcli application-apigateway access control show
--access_control_id <value>
--api_id <value>

Description

Show access control

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
access_control_id
required
stringAccess Control ID-
api_id
required
stringApi ID-

Responses

NameDescriptionExample
idAccess Control ID27bb070b564349f8a31cc60734cc36a5
allowed_ip_addrAllowed IP Address[‘127.0.0.1/24,192.168.127.12’]
connected_stagesConnected Stages[‘dev,stg’]
created_atCreation Date2024-05-19T00:23:17Z
descriptionDescription
nameAccess Control NameDenyTest

1.48 - Show Api

1.48.1 - 1.3

scpcli application-apigateway api show
--api_id <value>

Description

Show api

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID31e749b7b260868f441e862b

Responses

NameDescriptionExample
idApi ID27bb070b564349f8a31cc60734cc36a5
account_idAccount ID27bb070b564349f8a31cc60734cc36a5
created_atCreation Date2024-05-17T00:23:17Z
descriptionDescriptionDescription
dns_record_statusDNS Record StatusActive
nameNametest-api
statusApi StatusActive

1.48.2 - 1.2

scpcli application-apigateway api show
--api_id <value>

Description

Show api

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.220260630

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID31e749b7b260868f441e862b

Responses

NameDescriptionExample
idApi ID27bb070b564349f8a31cc60734cc36a5
account_idAccount ID27bb070b564349f8a31cc60734cc36a5
created_atCreation Date2024-05-17T00:23:17Z
descriptionDescriptionDescription
dns_record_statusDNS Record StatusActive
nameNametest-api
statusApi StatusActive

1.48.3 - 1.1

scpcli application-apigateway api show
--api_id <value>

Description

Show api

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID31e749b7b260868f441e862b

Responses

NameDescriptionExample
idApi ID27bb070b564349f8a31cc60734cc36a5
account_idAccount ID27bb070b564349f8a31cc60734cc36a5
created_atCreation Date2024-05-17T00:23:17Z
descriptionDescriptionDescription
dns_record_statusDNS Record StatusActive
nameNametest-api
statusApi StatusActive

1.48.4 - 1.0

scpcli application-apigateway api show
--api_id <value>

Description

Show api

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID31e749b7b260868f441e862b

Responses

NameDescriptionExample
idApi ID27bb070b564349f8a31cc60734cc36a5
account_idAccount ID27bb070b564349f8a31cc60734cc36a5
created_atCreation Date2024-05-17T00:23:17Z
descriptionDescriptionDescription
dns_record_statusDNS Record StatusActive
nameNametest-api
statusApi StatusActive

1.49 - Show Auth

1.49.1 - 1.3

scpcli application-apigateway auth show
--auth_id <value>
--api_id <value>

Description

Show auth

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
auth_id
required
stringAuth ID-
api_id
required
stringApi ID-

Responses

NameDescriptionExample
idAuth ID27bb070b564349f8a31cc60734cc36a5
auth_methodAUTH MethodJWT(JSON WEB Token)
connected_stagesConnected Stages[‘dev,stg’]
expired_atExpiration Date2024-05-17T00:23:17Z
nameAuth NAMEToken01

1.49.2 - 1.2

scpcli application-apigateway auth show
--auth_id <value>
--api_id <value>

Description

Show auth

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.220260630

Parameters

NameTypeDescriptionExample
auth_id
required
stringAuth ID-
api_id
required
stringApi ID-

Responses

NameDescriptionExample
idAuth ID27bb070b564349f8a31cc60734cc36a5
auth_methodAUTH MethodJWT(JSON WEB Token)
connected_stagesConnected Stages[‘dev,stg’]
expired_atExpiration Date2024-05-17T00:23:17Z
nameAuth NAMEToken01

1.49.3 - 1.1

scpcli application-apigateway auth show
--auth_id <value>
--api_id <value>

Description

Show auth

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260430

Parameters

NameTypeDescriptionExample
auth_id
required
stringAuth ID-
api_id
required
stringApi ID-

Responses

NameDescriptionExample
idAuth ID27bb070b564349f8a31cc60734cc36a5
auth_methodAUTH MethodJWT(JSON WEB Token)
connected_stagesConnected Stages[‘dev,stg’]
expired_atExpiration Date2024-05-17T00:23:17Z
nameAuth NAMEToken01

1.49.4 - 1.0

scpcli application-apigateway auth show
--auth_id <value>
--api_id <value>

Description

Show auth

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
auth_id
required
stringAuth ID-
api_id
required
stringApi ID-

Responses

NameDescriptionExample
idAuth ID27bb070b564349f8a31cc60734cc36a5
auth_methodAUTH MethodJWT(JSON WEB Token)
connected_stagesConnected Stages[‘dev,stg’]
expired_atExpiration Date2024-05-17T00:23:17Z
nameAuth NAMEToken01

1.50 - Show Method

1.50.1 - 1.3

scpcli application-apigateway method show
--method_type <value>
--resource_id <value>
--api_id <value>

Description

Show method

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
method_type
required
****Method TypeGET
resource_id
required
stringResource ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
api_key_requiredApi Key RequiredFalse
endpoint_urlMethod Endpoint URLhttps://127.0.0.1:8000
function_idCloud Function ID27bb070b564349f8a31cc60734cc36a5
function_nameCloud Function Nametest-function
iam_enabledIAM EnabledFalse
integration_typeMethod Integration TypeHTTP
method_typeMethod TypeGET
privatelink_endpoint_idPrivateLink Endpoint ID27bb070b564349f8a31cc60734cc36a5
query_stringsMethod Query Strings{‘param1’: ‘value1’, ‘param2’: ‘value2’}
request_headersMethod Request Headers{’test1’ : True}
request_pathMethod Request Path{users}
srnSRNsrn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test

1.50.2 - 1.2

scpcli application-apigateway method show
--method_type <value>
--resource_id <value>
--api_id <value>

Description

Show method

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.220260630

Parameters

NameTypeDescriptionExample
method_type
required
****Method TypeGET
resource_id
required
stringResource ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
api_key_requiredApi Key RequiredFalse
endpoint_urlMethod Endpoint URLhttps://127.0.0.1:8000
function_idCloud Function ID27bb070b564349f8a31cc60734cc36a5
function_nameCloud Function Nametest-function
integration_typeMethod Integration TypeHTTP
method_typeMethod TypeGET
privatelink_endpoint_idPrivateLink Endpoint ID27bb070b564349f8a31cc60734cc36a5
query_stringsMethod Query Strings{‘param1’: ‘value1’, ‘param2’: ‘value2’}
request_headersMethod Request Headers{’test1’ : True}
request_pathMethod Request Path{users}
srnSRNsrn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test

1.50.3 - 1.1

scpcli application-apigateway method show
--method_type <value>
--resource_id <value>
--api_id <value>

Description

Show method

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260430

Parameters

NameTypeDescriptionExample
method_type
required
****Method TypeGET
resource_id
required
stringResource ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
api_key_requiredApi Key RequiredFalse
endpoint_urlMethod Endpoint URLhttps://127.0.0.1:8000
function_idCloud Function ID27bb070b564349f8a31cc60734cc36a5
function_nameCloud Function Nametest-function
integration_typeMethod Integration TypeHTTP
method_typeMethod TypeGET
query_stringsMethod Query Strings{‘param1’: ‘value1’, ‘param2’: ‘value2’}
request_headersMethod Request Headers{’test1’ : True}
request_pathMethod Request Path{users}
srnSRNsrn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test

1.50.4 - 1.0

scpcli application-apigateway method show
--method_type <value>
--resource_id <value>
--api_id <value>

Description

Show method

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
method_type
required
****Method TypeGET
resource_id
required
stringResource ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
endpoint_urlMethod Endpoint URLhttps://127.0.0.1:8000
function_idCloud Function ID27bb070b564349f8a31cc60734cc36a5
integration_typeMethod Integration TypeHTTP
method_typeMethod TypeGET
query_stringsMethod Query Strings{‘param1’: ‘value1’, ‘param2’: ‘value2’}
request_headersMethod Request Headers{’test1’ : True}
request_pathMethod Request Path{users}
srnSRNsrn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test

1.51 - Show PrivateLink Endpoint

1.51.1 - 1.3

scpcli application-apigateway privatelink endpoint show
--privatelink_endpoint_id <value>

Description

Show PrivateLink Endpoint

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink Endpoint ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
idPrivateLink Endpoint ID27bb070b564349f8a31cc60734cc36a5
created_atCreation Date2024-05-17T00:23:17Z
descriptionDescriptiondescription
namePrivateLink Endpoint Nameendpoint
privatelink_service_idPrivateLink Service ID27bb070b564349f8a31cc60734cc36a5
statusPrivateLink Endpoint StatusCANCELED

1.51.2 - 1.2

scpcli application-apigateway privatelink endpoint show
--privatelink_endpoint_id <value>

Description

Show PrivateLink Endpoint

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.220260630

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink Endpoint ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
idPrivateLink Endpoint ID27bb070b564349f8a31cc60734cc36a5
created_atCreation Date2024-05-17T00:23:17Z
descriptionDescriptiondescription
namePrivateLink Endpoint Nameendpoint
privatelink_service_idPrivateLink Service ID27bb070b564349f8a31cc60734cc36a5
statusPrivateLink Endpoint StatusCANCELED

1.52 - Show Resource

1.52.1 - 1.3

scpcli application-apigateway resource show
--resource_id <value>
--api_id <value>

Description

Show resource

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
resource_id
required
stringResource ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
idResource ID27bb070b564349f8a31cc60734cc36a5
methods
parent_idParent Resource ID27bb070b564349f8a31cc60734cc36a5
pathPath/test/test1
path_partPath Parttest

1.52.2 - 1.2

scpcli application-apigateway resource show
--resource_id <value>
--api_id <value>

Description

Show resource

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.220260630

Parameters

NameTypeDescriptionExample
resource_id
required
stringResource ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
idResource ID27bb070b564349f8a31cc60734cc36a5
methods
parent_idParent Resource ID27bb070b564349f8a31cc60734cc36a5
pathPath/test/test1
path_partPath Parttest

1.52.3 - 1.1

scpcli application-apigateway resource show
--resource_id <value>
--api_id <value>

Description

Show resource

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260430

Parameters

NameTypeDescriptionExample
resource_id
required
stringResource ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
idResource ID27bb070b564349f8a31cc60734cc36a5
methods
parent_idParent Resource ID27bb070b564349f8a31cc60734cc36a5
pathPath/test/test1
path_partPath Parttest

1.52.4 - 1.0

scpcli application-apigateway resource show
--resource_id <value>
--api_id <value>

Description

Show resource

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
resource_id
required
stringResource ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
idResource ID27bb070b564349f8a31cc60734cc36a5
methods
parent_idParent Resource ID27bb070b564349f8a31cc60734cc36a5
pathPath/test/test1
path_partPath Parttest

1.53 - Show Resource Policy

1.53.1 - 1.3

scpcli application-apigateway resource policy show
--api_id <value>

Description

Show Resource Policy

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
policy_documentPolicy Document{‘Statement’: [{‘Action’: [‘apigateway:InvokeApigatewayRegion’], ‘Condition’: {‘SrnLike’: {“scp:RequestAttribute/body[‘method-srn’]”: [‘srn:dev2::27bb070b564349f8a31cc60734cc36a5:kr-west1::apigateway:method/a4b19a70b596467fb010d3c3//GET/n-f’]}}, ‘Effect’: ‘Allow’, ‘Principal’: ‘’, ‘Resource’: [‘srn:dev2::27bb070b564349f8a31cc60734cc36a5:kr-west1::apigateway:api/a4b19a70b596467fb010d3c3’], ‘Sid’: ‘Statement1’}], ‘Version’: ‘2024-07-01’}

1.54 - Show Stage

1.54.1 - 1.3

scpcli application-apigateway stage show
--api_id <value>
--stage_name <value>

Description

Show stage

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
stage_name
required
stringStage Nametest-stage

Responses

NameDescriptionExample
active_deploymentActive Deployment2024-05-17T00:23:17Z
allow_credentialsAllow CredentialsTrue
allow_headersAllow Headers[‘Content-Type’, ‘Authorization’]
allow_methodsAllow Methods[‘GET’, ‘POST’, ‘PUT’, ‘PATCH’]
allow_originsAllow Origins[’*’]
api_idApi ID27bb070b564349f8a31cc60734cc36a5
cors_enabledCors EnabledFalse
created_atCreation Date
deployment_idDeployment ID27bb070b564349f8a31cc60734cc36a5
descriptionDescriptiondescription
expose_headersExpose Headers[’test1’, ’test2’]
invoke_urlInvoke URLhttp://test.com/stg
jwt_enabledJWT EnabledFalse
max_ageMax Age3600
nameStage Nametest-stage
usage_plan_api_keysAPI Keys[]
usage_plan_idUsage Plan ID27bb070b564349f8a31cc60734cc36a5
usage_plan_limitUsage Plan Limit10
usage_plan_nameNameusage-plan-name
usage_plan_rateUsage Plan Rateday

1.54.2 - 1.2

scpcli application-apigateway stage show
--api_id <value>
--stage_name <value>

Description

Show stage

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.220260630

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
stage_name
required
stringStage Nametest-stage

Responses

NameDescriptionExample
active_deploymentActive Deployment2024-05-17T00:23:17Z
allow_credentialsAllow CredentialsTrue
allow_headersAllow Headers[‘Content-Type’, ‘Authorization’]
allow_methodsAllow Methods[‘GET’, ‘POST’, ‘PUT’, ‘PATCH’]
allow_originsAllow Origins[’*’]
api_idApi ID27bb070b564349f8a31cc60734cc36a5
api_key_requiredApi Key RequiredFalse
cors_enabledCors EnabledFalse
created_atCreation Date
deployment_idDeployment ID27bb070b564349f8a31cc60734cc36a5
descriptionDescriptiondescription
expose_headersExpose Headers[’test1’, ’test2’]
invoke_urlInvoke URLhttp://test.com/stg
jwt_enabledJWT EnabledFalse
max_ageMax Age3600
nameStage Nametest-stage
usage_plan_api_keysAPI Keys[]
usage_plan_idUsage Plan ID27bb070b564349f8a31cc60734cc36a5
usage_plan_limitUsage Plan Limit10
usage_plan_nameNameusage-plan-name
usage_plan_rateUsage Plan Rateday

1.54.3 - 1.1

scpcli application-apigateway stage show
--api_id <value>
--stage_name <value>

Description

Show stage

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
stage_name
required
stringStage Nametest-stage

Responses

NameDescriptionExample
active_deploymentActive Deployment2024-05-17T00:23:17Z
allow_credentialsAllow CredentialsTrue
allow_headersAllow Headers[‘Content-Type’, ‘Authorization’]
allow_methodsAllow Methods[‘GET’, ‘POST’, ‘PUT’, ‘PATCH’]
allow_originsAllow Origins[’*’]
api_idApi ID27bb070b564349f8a31cc60734cc36a5
api_key_requiredApi Key RequiredFalse
cors_enabledCors EnabledFalse
created_atCreation Date
deployment_idDeployment ID27bb070b564349f8a31cc60734cc36a5
descriptionDescriptiondescription
expose_headersExpose Headers[’test1’, ’test2’]
invoke_urlInvoke URLhttp://test.com/stg
jwt_enabledJWT EnabledFalse
max_ageMax Age3600
nameStage Nametest-stage
usage_plan_api_keysAPI Keys[]
usage_plan_idUsage Plan ID27bb070b564349f8a31cc60734cc36a5
usage_plan_limitUsage Plan Limit10
usage_plan_nameNameusage-plan-name
usage_plan_rateUsage Plan Rateday

1.54.4 - 1.0

scpcli application-apigateway stage show
--api_id <value>
--stage_name <value>

Description

Show stage

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
stage_name
required
stringStage Nametest-stage

Responses

NameDescriptionExample
active_deploymentActive Deployment2024-05-17T00:23:17Z
allow_credentialsAllow CredentialsTrue
allow_headersAllow Headers[‘Content-Type’, ‘Authorization’]
allow_methodsAllow Methods[‘GET’, ‘POST’, ‘PUT’, ‘PATCH’]
allow_originsAllow Origins[’*’]
api_idApi ID27bb070b564349f8a31cc60734cc36a5
cors_enabledCors EnabledFalse
created_atCreation Date
deployment_idDeployment ID27bb070b564349f8a31cc60734cc36a5
expose_headersExpose Headers[’test1’, ’test2’]
invoke_urlInvoke URLhttp://test.com/stg
ip_restriction_enabledIP Restriction EnabledFalse
jwt_enabledJWT EnabledFalse
max_ageMax Age3600
nameStage Nametest-stage

1.55 - Show Usage Plan

1.55.1 - 1.3

scpcli application-apigateway usage plan show
--usage_plan_id <value>
--api_id <value>

Description

Show usage plan

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
usage_plan_id
required
stringUsage Plan ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
idUsage Plan ID27bb070b564349f8a31cc60734cc36a5
api_keysAPI Keys[]
created_atCreation Date
created_by_idCreated by27bb070b564349f8a31cc60734cc36a5
created_by_nameCreated byusername
descriptionDescriptiondescription
limitUsage Plan Limit10
modified_atModified at
modified_by_idModified by27bb070b564349f8a31cc60734cc36a5
modified_by_nameModified byusername
nameNameusage-plan-name
rateUsage Plan Rateday

1.55.2 - 1.2

scpcli application-apigateway usage plan show
--usage_plan_id <value>
--api_id <value>

Description

Show usage plan

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.220260630

Parameters

NameTypeDescriptionExample
usage_plan_id
required
stringUsage Plan ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
idUsage Plan ID27bb070b564349f8a31cc60734cc36a5
api_keysAPI Keys[]
created_atCreation Date
created_by_idCreated by27bb070b564349f8a31cc60734cc36a5
created_by_nameCreated byusername
descriptionDescriptiondescription
limitUsage Plan Limit10
modified_atModified at
modified_by_idModified by27bb070b564349f8a31cc60734cc36a5
modified_by_nameModified byusername
nameNameusage-plan-name
rateUsage Plan Rateday

1.55.3 - 1.1

scpcli application-apigateway usage plan show
--usage_plan_id <value>
--api_id <value>

Description

Show usage plan

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260430

Parameters

NameTypeDescriptionExample
usage_plan_id
required
stringUsage Plan ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
idUsage Plan ID27bb070b564349f8a31cc60734cc36a5
api_keysAPI Keys[]
created_atCreation Date
created_by_idCreated by27bb070b564349f8a31cc60734cc36a5
created_by_nameCreated byusername
descriptionDescriptiondescription
limitUsage Plan Limit10
modified_atModified at
modified_by_idModified by27bb070b564349f8a31cc60734cc36a5
modified_by_nameModified byusername
nameNameusage-plan-name
rateUsage Plan Rateday