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

Return to the regular view of this page.

CLIs

1: Approve PrivateLink Endpoint

1.1: 1.3
1.2: 1.2

2: Connect PrivateLink Endpoint

2.1: 1.3
2.2: 1.2

3: Create AccessControl

3.1: 1.3
3.2: 1.2
3.3: 1.1
3.4: 1.0

4: Create Api

4.1: 1.3
4.2: 1.2
4.3: 1.1
4.4: 1.0

5: Create Api Deployment

5.1: 1.3
5.2: 1.2
5.3: 1.1
5.4: 1.0

6: Create Api Key

6.1: 1.3
6.2: 1.2
6.3: 1.1

7: Create Auth

7.1: 1.3
7.2: 1.2
7.3: 1.1
7.4: 1.0

8: Create Method

8.1: 1.3
8.2: 1.2
8.3: 1.1
8.4: 1.0

9: Create PrivateLink Endpoint

9.1: 1.3
9.2: 1.2

10: Create Resource

10.1: 1.3
10.2: 1.2
10.3: 1.1
10.4: 1.0

11: Create Stage

11.1: 1.3
11.2: 1.2
11.3: 1.1
11.4: 1.0

12: Create Usage Plans

12.1: 1.3
12.2: 1.2
12.3: 1.1

13: Delete Access Control

13.1: 1.3
13.2: 1.2
13.3: 1.1
13.4: 1.0

14: Delete an API Key

14.1: 1.3
14.2: 1.2
14.3: 1.1

15: Delete Api

15.1: 1.3
15.2: 1.2
15.3: 1.1
15.4: 1.0

16: Delete Auth

16.1: 1.3
16.2: 1.2
16.3: 1.1
16.4: 1.0

17: Delete Method

17.1: 1.3
17.2: 1.2
17.3: 1.1
17.4: 1.0

18: Delete PrivateLink Endpoint

18.1: 1.3
18.2: 1.2

19: Delete Resource

19.1: 1.3
19.2: 1.2
19.3: 1.1
19.4: 1.0

20: Delete Resource Policy

20.1: 1.3

21: Delete Stage

21.1: 1.3
21.2: 1.2
21.3: 1.1
21.4: 1.0

22: Delete Usage Plan

22.1: 1.3
22.2: 1.2
22.3: 1.1

23: List AccessControls

23.1: 1.3
23.2: 1.2
23.3: 1.1
23.4: 1.0

24: List Api Deployments

24.1: 1.3
24.2: 1.2
24.3: 1.1
24.4: 1.0

25: List Api Keys

25.1: 1.3
25.2: 1.2
25.3: 1.1

26: List Apis

26.1: 1.3
26.2: 1.2
26.3: 1.1
26.4: 1.0

27: List Auths

27.1: 1.3
27.2: 1.2
27.3: 1.1
27.4: 1.0

28: List Connected PrivateLink Endpoints

28.1: 1.3
28.2: 1.2

29: List Methods

29.1: 1.3
29.2: 1.2
29.3: 1.1
29.4: 1.0

30: List PrivateLink Endpoints

30.1: 1.3
30.2: 1.2

31: List Reports

31.1: 1.3
31.2: 1.2
31.3: 1.1

32: List Resources

32.1: 1.3
32.2: 1.2
32.3: 1.1
32.4: 1.0

33: List Stages

33.1: 1.3
33.2: 1.2
33.3: 1.1
33.4: 1.0

34: List Usage Plans

34.1: 1.3
34.2: 1.2
34.3: 1.1

35: Request PrivateLink Endpoint

35.1: 1.3
35.2: 1.2

36: Set Access Control

36.1: 1.3
36.2: 1.2
36.3: 1.1
36.4: 1.0

37: Set Api Description

37.1: 1.3
37.2: 1.2
37.3: 1.1
37.4: 1.0

38: Set API Key Description

38.1: 1.3
38.2: 1.2
38.3: 1.1

39: Set Auth

39.1: 1.3
39.2: 1.2
39.3: 1.1
39.4: 1.0

40: Set Method

40.1: 1.3
40.2: 1.2
40.3: 1.1
40.4: 1.0

41: Set PrivateLink Endpoint

41.1: 1.3
41.2: 1.2

42: Set Resource Policy

42.1: 1.3

43: Set Stage Active Deployment

43.1: 1.3
43.2: 1.2
43.3: 1.1
43.4: 1.0

44: Set Stage Configuration

44.1: 1.3
44.2: 1.2
44.3: 1.1
44.4: 1.0

45: Set Usage Plan Description

45.1: 1.3
45.2: 1.2
45.3: 1.1

46: Set Usage Plan Quota

46.1: 1.3
46.2: 1.2
46.3: 1.1

47: Show Access Control

47.1: 1.3
47.2: 1.2
47.3: 1.1
47.4: 1.0

48: Show Api

48.1: 1.3
48.2: 1.2
48.3: 1.1
48.4: 1.0

49: Show Auth

49.1: 1.3
49.2: 1.2
49.3: 1.1
49.4: 1.0

50: Show Method

50.1: 1.3
50.2: 1.2
50.3: 1.1
50.4: 1.0

51: Show PrivateLink Endpoint

51.1: 1.3
51.2: 1.2

52: Show Resource

52.1: 1.3
52.2: 1.2
52.3: 1.1
52.4: 1.0

53: Show Resource Policy

53.1: 1.3

54: Show Stage

54.1: 1.3
54.2: 1.2
54.3: 1.1
54.4: 1.0

55: Show Usage Plan

55.1: 1.3
55.2: 1.2
55.3: 1.1

1 - Approve PrivateLink Endpoint

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)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
privatelink_endpoint_id required	string	PrivateLink Endpoint ID	`27bb070b564349f8a31cc60734cc36a5`
type required	string	PrivateLink Endpoint Action Type	`CANCEL`
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`

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.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
privatelink_endpoint_id required	string	PrivateLink Endpoint ID	`27bb070b564349f8a31cc60734cc36a5`
type required	string	PrivateLink Endpoint Action Type	`CANCEL`
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`

2 - Connect PrivateLink Endpoint

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)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
privatelink_endpoint_id required	string	PrivateLink Endpoint ID	`27bb070b564349f8a31cc60734cc36a5`
type required	string	PrivateLink Endpoint Action Type	`CANCEL`
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`

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.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
privatelink_endpoint_id required	string	PrivateLink Endpoint ID	`27bb070b564349f8a31cc60734cc36a5`
type required	string	PrivateLink Endpoint Action Type	`CANCEL`
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`

3 - Create AccessControl

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)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	-
name required	string	Access Control Name	`DenyTest`
connected_stages required	array	Connected Stages	`dev,stg`
allowed_ip_addr required	array	Allowed IP Address	`127.0.0.1/24,192.168.127.12`
description optional	string	Description	`description`

Responses

Name	Description	Example
id	Access Control ID	27bb070b564349f8a31cc60734cc36a5
allowed_ip_addr	Allowed IP Address	[‘127.0.0.1/24,192.168.127.12’]
connected_stages	Connected Stages	[‘dev,stg’]
created_at	Creation Date	2024-05-19T00:23:17Z
description	Description
name	Access Control Name	DenyTest

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.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	-
name required	string	Access Control Name	`DenyTest`
connected_stages required	array	Connected Stages	`dev,stg`
allowed_ip_addr required	array	Allowed IP Address	`127.0.0.1/24,192.168.127.12`
description optional	string	Description	`description`

Responses

Name	Description	Example
id	Access Control ID	27bb070b564349f8a31cc60734cc36a5
allowed_ip_addr	Allowed IP Address	[‘127.0.0.1/24,192.168.127.12’]
connected_stages	Connected Stages	[‘dev,stg’]
created_at	Creation Date	2024-05-19T00:23:17Z
description	Description
name	Access Control Name	DenyTest

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.

Version	Not Before
1.1	20260430

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	-
name required	string	Access Control Name	`DenyTest`
connected_stages required	array	Connected Stages	`dev,stg`
allowed_ip_addr required	array	Allowed IP Address	`127.0.0.1/24,192.168.127.12`
description optional	string	Description	`description`

Responses

Name	Description	Example
id	Access Control ID	27bb070b564349f8a31cc60734cc36a5
allowed_ip_addr	Allowed IP Address	[‘127.0.0.1/24,192.168.127.12’]
connected_stages	Connected Stages	[‘dev,stg’]
created_at	Creation Date	2024-05-19T00:23:17Z
description	Description
name	Access Control Name	DenyTest

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.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	-
name required	string	Access Control Name	`DenyTest`
connected_stages required	array	Connected Stages	`dev,stg`
allowed_ip_addr required	array	Allowed IP Address	`127.0.0.1/24,192.168.127.12`
description optional	string	Description	`description`

Responses

Name	Description	Example
id	Access Control ID	27bb070b564349f8a31cc60734cc36a5
allowed_ip_addr	Allowed IP Address	[‘127.0.0.1/24,192.168.127.12’]
connected_stages	Connected Stages	[‘dev,stg’]
created_at	Creation Date	2024-05-19T00:23:17Z
description	Description
name	Access Control Name	DenyTest

4 - Create Api

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)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
name required	string	Name	`test-api`
description optional	string	Description	`description`
endpoint_type optional	string	Endpoint Type	-
id optional	string	Api ID	-
tags optional	array	Tag List	`'{"key": "key", "value": "value"}'`

Responses

Name	Description	Example
id	Api ID	27bb070b564349f8a31cc60734cc36a5
description	Description	Description
name	Name	test-api

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.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
name required	string	Name	`test-api`
description optional	string	Description	`description`
endpoint_type optional	string	Endpoint Type	-
id optional	string	Api ID	-
tags optional	array	Tag List	`'{"key": "key", "value": "value"}'`

Responses

Name	Description	Example
id	Api ID	27bb070b564349f8a31cc60734cc36a5
description	Description	Description
name	Name	test-api

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.

Version	Not Before
1.1	20260430

Parameters

Name	Type	Description	Example
name required	string	Name	`test-api`
description optional	string	Description	`description`
id optional	string	Api ID	-
tags optional	array	Tag List	`'{"key": "key", "value": "value"}'`

Responses

Name	Description	Example
id	Api ID	27bb070b564349f8a31cc60734cc36a5
description	Description	Description
name	Name	test-api

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.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
name required	string	Name	`test-api`
description optional	string	Description	`description`
id optional	string	Api ID	-
tags optional	array	Tag List	`'{"key": "key", "value": "value"}'`

Responses

Name	Description	Example
id	Api ID	27bb070b564349f8a31cc60734cc36a5
description	Description	Description
name	Name	test-api

5 - Create Api Deployment

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)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	`31e749b7b260868f441e862b`
stage_type required	string	Stage Type	`new`
description optional	string	Description	`description`
stage_name optional	string	Stage Name	`test-stage`

Responses

Name	Description	Example
deployment_id	Deployment ID	27bb070b564349f8a31cc60734cc36a5
description	Description	description

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.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	`31e749b7b260868f441e862b`
stage_type required	string	Stage Type	`new`
description optional	string	Description	`description`
stage_name optional	string	Stage Name	`test-stage`

Responses

Name	Description	Example
deployment_id	Deployment ID	27bb070b564349f8a31cc60734cc36a5
description	Description	description

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.

Version	Not Before
1.1	20260430

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	`31e749b7b260868f441e862b`
stage_type required	string	Stage Type	`new`
description optional	string	Description	`description`
stage_name optional	string	Stage Name	`test-stage`

Responses

Name	Description	Example
deployment_id	Deployment ID	27bb070b564349f8a31cc60734cc36a5
description	Description	description

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.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	`31e749b7b260868f441e862b`
stage_type required	string	Stage Type	`new`
description optional	string	Description	`description`
stage_name optional	string	Stage Name	`test-stage`

Responses

Name	Description	Example
deployment_id	Deployment ID	27bb070b564349f8a31cc60734cc36a5
description	Description	description

6 - Create Api Key

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)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
usage_plan_id required	string	Usage Plan ID	`27bb070b564349f8a31cc60734cc36a5`
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`
name required	string	Name	`api-key-name`
description optional	string	Description	`description`

Responses

Name	Description	Example
id	API Key ID	27bb070b564349f8a31cc60734cc36a5
created_at	Creation Date
description	Description	description
key	Key	key
name	Name	api-key-name

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.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
usage_plan_id required	string	Usage Plan ID	`27bb070b564349f8a31cc60734cc36a5`
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`
name required	string	Name	`api-key-name`
description optional	string	Description	`description`

Responses

Name	Description	Example
id	API Key ID	27bb070b564349f8a31cc60734cc36a5
created_at	Creation Date
description	Description	description
key	Key	key
name	Name	api-key-name

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.

Version	Not Before
1.1	20260430

Parameters

Name	Type	Description	Example
usage_plan_id required	string	Usage Plan ID	`27bb070b564349f8a31cc60734cc36a5`
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`
name required	string	Name	`api-key-name`
description optional	string	Description	`description`

Responses

Name	Description	Example
id	API Key ID	27bb070b564349f8a31cc60734cc36a5
created_at	Creation Date
description	Description	description
key	Key	key
name	Name	api-key-name

7 - Create Auth

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)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	-
name required	string	Auth NAME	`Token01`
expiration_period required	integer	Expiration Period	`90`
connected_stages required	array	Connected Stages	`dev,stg`

Responses

Name	Description	Example
access_token	Access Token	***********************************************************

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.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	-
name required	string	Auth NAME	`Token01`
expiration_period required	integer	Expiration Period	`90`
connected_stages required	array	Connected Stages	`dev,stg`

Responses

Name	Description	Example
access_token	Access Token	***********************************************************

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.

Version	Not Before
1.1	20260430

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	-
name required	string	Auth NAME	`Token01`
expiration_period required	integer	Expiration Period	`90`
connected_stages required	array	Connected Stages	`dev,stg`

Responses

Name	Description	Example
access_token	Access Token	***********************************************************

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.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	-
name required	string	Auth NAME	`Token01`
expiration_period required	integer	Expiration Period	`90`
connected_stages required	array	Connected Stages	`dev,stg`

Responses

Name	Description	Example
access_token	Access Token	***********************************************************

8 - Create Method

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)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
resource_id required	string	Resource ID	`27bb070b564349f8a31cc60734cc36a5`
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`
method_type required	string	Method Type	`GET`
integration_type required	string	Method Integration Type	`HTTP`
api_key_required optional	boolean	Api Key Required	`False`
endpoint_url optional	string	Method Endpoint URL	`https://127.0.0.1:8000`
function_id optional	string	Cloud Function ID	`27bb070b564349f8a31cc60734cc36a5`
iam_enabled optional	boolean	IAM Enabled	`False`
privatelink_endpoint_id optional	string	PrivateLink Endpoint ID	`27bb070b564349f8a31cc60734cc36a5`
query_strings optional	object	Method Query Strings	`{'param1': 'value1', 'param2': 'value2'}`
request_headers optional	object	Method Request Headers	`{'test1' : True}`

Responses

Name	Description	Example
api_key_required	Api Key Required	False
endpoint_url	Method Endpoint URL	https://127.0.0.1:8000
function_id	Cloud Function ID	27bb070b564349f8a31cc60734cc36a5
function_name	Cloud Function Name	test-function
iam_enabled	IAM Enabled	False
integration_type	Method Integration Type	HTTP
method_type	Method Type	GET
privatelink_endpoint_id	PrivateLink Endpoint ID	27bb070b564349f8a31cc60734cc36a5
query_strings	Method Query Strings	{‘param1’: ‘value1’, ‘param2’: ‘value2’}
request_headers	Method Request Headers	{’test1’ : True}
request_path	Method Request Path	{users}
srn	SRN	srn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test

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.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
resource_id required	string	Resource ID	`27bb070b564349f8a31cc60734cc36a5`
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`
method_type required	string	Method Type	`GET`
integration_type required	string	Method Integration Type	`HTTP`
api_key_required optional	boolean	Api Key Required	`False`
endpoint_url optional	string	Method Endpoint URL	`https://127.0.0.1:8000`
function_id optional	string	Cloud Function ID	`27bb070b564349f8a31cc60734cc36a5`
iam_enabled optional	boolean	IAM Enabled	`False`
privatelink_endpoint_id optional	string	PrivateLink Endpoint ID	`27bb070b564349f8a31cc60734cc36a5`
query_strings optional	object	Method Query Strings	`{'param1': 'value1', 'param2': 'value2'}`
request_headers optional	object	Method Request Headers	`{'test1' : True}`

Responses

Name	Description	Example
api_key_required	Api Key Required	False
endpoint_url	Method Endpoint URL	https://127.0.0.1:8000
function_id	Cloud Function ID	27bb070b564349f8a31cc60734cc36a5
function_name	Cloud Function Name	test-function
integration_type	Method Integration Type	HTTP
method_type	Method Type	GET
privatelink_endpoint_id	PrivateLink Endpoint ID	27bb070b564349f8a31cc60734cc36a5
query_strings	Method Query Strings	{‘param1’: ‘value1’, ‘param2’: ‘value2’}
request_headers	Method Request Headers	{’test1’ : True}
request_path	Method Request Path	{users}
srn	SRN	srn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test

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.

Version	Not Before
1.1	20260430

Parameters

Name	Type	Description	Example
resource_id required	string	Resource ID	`27bb070b564349f8a31cc60734cc36a5`
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`
method_type required	string	Method Type	`GET`
integration_type required	string	Method Integration Type	`HTTP`
api_key_required optional	boolean	Api Key Required	`False`
endpoint_url optional	string	Method Endpoint URL	`https://127.0.0.1:8000`
function_id optional	string	Cloud Function ID	`27bb070b564349f8a31cc60734cc36a5`
iam_enabled optional	boolean	IAM Enabled	`False`
privatelink_endpoint_id optional	string	PrivateLink Endpoint ID	`27bb070b564349f8a31cc60734cc36a5`
query_strings optional	object	Method Query Strings	`{'param1': 'value1', 'param2': 'value2'}`
request_headers optional	object	Method Request Headers	`{'test1' : True}`

Responses

Name	Description	Example
api_key_required	Api Key Required	False
endpoint_url	Method Endpoint URL	https://127.0.0.1:8000
function_id	Cloud Function ID	27bb070b564349f8a31cc60734cc36a5
function_name	Cloud Function Name	test-function
integration_type	Method Integration Type	HTTP
method_type	Method Type	GET
query_strings	Method Query Strings	{‘param1’: ‘value1’, ‘param2’: ‘value2’}
request_headers	Method Request Headers	{’test1’ : True}
request_path	Method Request Path	{users}
srn	SRN	srn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test

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.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
resource_id required	string	Resource ID	`27bb070b564349f8a31cc60734cc36a5`
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`
method_type required	string	Method Type	`GET`
integration_type required	string	Method Integration Type	`HTTP`
api_key_required optional	boolean	Api Key Required	`False`
endpoint_url optional	string	Method Endpoint URL	`https://127.0.0.1:8000`
function_id optional	string	Cloud Function ID	`27bb070b564349f8a31cc60734cc36a5`
iam_enabled optional	boolean	IAM Enabled	`False`
privatelink_endpoint_id optional	string	PrivateLink Endpoint ID	`27bb070b564349f8a31cc60734cc36a5`
query_strings optional	object	Method Query Strings	`{'param1': 'value1', 'param2': 'value2'}`
request_headers optional	object	Method Request Headers	`{'test1' : True}`

Responses

Name	Description	Example
endpoint_url	Method Endpoint URL	https://127.0.0.1:8000
function_id	Cloud Function ID	27bb070b564349f8a31cc60734cc36a5
integration_type	Method Integration Type	HTTP
method_type	Method Type	GET
query_strings	Method Query Strings	{‘param1’: ‘value1’, ‘param2’: ‘value2’}
request_headers	Method Request Headers	{’test1’ : True}
request_path	Method Request Path	{users}
srn	SRN	srn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test

9 - Create PrivateLink Endpoint

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)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
privatelink_service_id required	string	PrivateLink Service ID	`27bb070b564349f8a31cc60734cc36a5`
name required	string	PrivateLink Endpoint Name	`endpoint`
description optional	string	Description	`description`

Responses

Name	Description	Example
id	PrivateLink Endpoint ID	27bb070b564349f8a31cc60734cc36a5
created_at	Creation Date	2024-05-17T00:23:17Z
description	Description	description
name	PrivateLink Endpoint Name	endpoint
privatelink_service_id	PrivateLink Service ID	27bb070b564349f8a31cc60734cc36a5
status	PrivateLink Endpoint Status	CANCELED

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.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
privatelink_service_id required	string	PrivateLink Service ID	`27bb070b564349f8a31cc60734cc36a5`
name required	string	PrivateLink Endpoint Name	`endpoint`
description optional	string	Description	`description`

Responses

Name	Description	Example
id	PrivateLink Endpoint ID	27bb070b564349f8a31cc60734cc36a5
created_at	Creation Date	2024-05-17T00:23:17Z
description	Description	description
name	PrivateLink Endpoint Name	endpoint
privatelink_service_id	PrivateLink Service ID	27bb070b564349f8a31cc60734cc36a5
status	PrivateLink Endpoint Status	CANCELED

10 - Create Resource

10.1 - 1.3

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

Description

Create resource

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
parent_id required	string	Resource ID	`27bb070b564349f8a31cc60734cc36a5`
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`
path_part required	string	Path Part	`test`

Responses

Name	Description	Example
id	Resource ID	27bb070b564349f8a31cc60734cc36a5
api_id	Api ID	27bb070b564349f8a31cc60734cc36a5
parent_id	Parent Resource ID	27bb070b564349f8a31cc60734cc36a5
path	Path

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.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
parent_id required	string	Resource ID	`27bb070b564349f8a31cc60734cc36a5`
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`
path_part required	string	Path Part	`test`

Responses

Name	Description	Example
id	Resource ID	27bb070b564349f8a31cc60734cc36a5
api_id	Api ID	27bb070b564349f8a31cc60734cc36a5
parent_id	Parent Resource ID	27bb070b564349f8a31cc60734cc36a5
path	Path

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.

Version	Not Before
1.1	20260430

Parameters

Name	Type	Description	Example
parent_id required	string	Resource ID	`27bb070b564349f8a31cc60734cc36a5`
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`
path_part required	string	Path Part	`test`

Responses

Name	Description	Example
id	Resource ID	27bb070b564349f8a31cc60734cc36a5
api_id	Api ID	27bb070b564349f8a31cc60734cc36a5
parent_id	Parent Resource ID	27bb070b564349f8a31cc60734cc36a5
path	Path

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.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
parent_id required	string	Resource ID	`27bb070b564349f8a31cc60734cc36a5`
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`
path_part required	string	Path Part	`test`

Responses

Name	Description	Example
id	Resource ID	27bb070b564349f8a31cc60734cc36a5
api_id	Api ID	27bb070b564349f8a31cc60734cc36a5
parent_id	Parent Resource ID	27bb070b564349f8a31cc60734cc36a5
path	Path

11 - Create Stage

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)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`
stage_name required	string	Name	`test-stage`
deployment_id required	string	Deployment ID	`27bb070b564349f8a31cc60734cc36a5`
description optional	string	Description	`description`

Responses

Name	Description	Example
active_deployment	Active Deployment	2024-05-17T00:23:17Z
allow_credentials	Allow Credentials	True
allow_headers	Allow Headers	[‘Content-Type’, ‘Authorization’]
allow_methods	Allow Methods	[‘GET’, ‘POST’, ‘PUT’, ‘PATCH’]
allow_origins	Allow Origins	[’*’]
api_id	Api ID	27bb070b564349f8a31cc60734cc36a5
api_key_required	Api Key Required	False
cors_enabled	Cors Enabled	False
created_at	Creation Date
deployment_id	Deployment ID	27bb070b564349f8a31cc60734cc36a5
description	Description	description
expose_headers	Expose Headers	[’test1’, ’test2’]
invoke_url	Invoke URL	http://test.com/stg
jwt_enabled	JWT Enabled	False
max_age	Max Age	3600
name	Stage Name	test-stage
usage_plan_api_keys	API Keys	[]
usage_plan_id	Usage Plan ID	27bb070b564349f8a31cc60734cc36a5
usage_plan_limit	Usage Plan Limit	10
usage_plan_name	Name	usage-plan-name
usage_plan_rate	Usage Plan Rate	day

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.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`
stage_name required	string	Name	`test-stage`
deployment_id required	string	Deployment ID	`27bb070b564349f8a31cc60734cc36a5`
description optional	string	Description	`description`

Responses

Name	Description	Example
active_deployment	Active Deployment	2024-05-17T00:23:17Z
allow_credentials	Allow Credentials	True
allow_headers	Allow Headers	[‘Content-Type’, ‘Authorization’]
allow_methods	Allow Methods	[‘GET’, ‘POST’, ‘PUT’, ‘PATCH’]
allow_origins	Allow Origins	[’*’]
api_id	Api ID	27bb070b564349f8a31cc60734cc36a5
api_key_required	Api Key Required	False
cors_enabled	Cors Enabled	False
created_at	Creation Date
deployment_id	Deployment ID	27bb070b564349f8a31cc60734cc36a5
description	Description	description
expose_headers	Expose Headers	[’test1’, ’test2’]
invoke_url	Invoke URL	http://test.com/stg
jwt_enabled	JWT Enabled	False
max_age	Max Age	3600
name	Stage Name	test-stage
usage_plan_api_keys	API Keys	[]
usage_plan_id	Usage Plan ID	27bb070b564349f8a31cc60734cc36a5
usage_plan_limit	Usage Plan Limit	10
usage_plan_name	Name	usage-plan-name
usage_plan_rate	Usage Plan Rate	day

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.

Version	Not Before
1.1	20260430

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`
stage_name required	string	Name	`test-stage`
deployment_id required	string	Deployment ID	`27bb070b564349f8a31cc60734cc36a5`
description optional	string	Description	`description`

Responses

Name	Description	Example
active_deployment	Active Deployment	2024-05-17T00:23:17Z
allow_credentials	Allow Credentials	True
allow_headers	Allow Headers	[‘Content-Type’, ‘Authorization’]
allow_methods	Allow Methods	[‘GET’, ‘POST’, ‘PUT’, ‘PATCH’]
allow_origins	Allow Origins	[’*’]
api_id	Api ID	27bb070b564349f8a31cc60734cc36a5
api_key_required	Api Key Required	False
cors_enabled	Cors Enabled	False
created_at	Creation Date
deployment_id	Deployment ID	27bb070b564349f8a31cc60734cc36a5
description	Description	description
expose_headers	Expose Headers	[’test1’, ’test2’]
invoke_url	Invoke URL	http://test.com/stg
jwt_enabled	JWT Enabled	False
max_age	Max Age	3600
name	Stage Name	test-stage
usage_plan_api_keys	API Keys	[]
usage_plan_id	Usage Plan ID	27bb070b564349f8a31cc60734cc36a5
usage_plan_limit	Usage Plan Limit	10
usage_plan_name	Name	usage-plan-name
usage_plan_rate	Usage Plan Rate	day

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.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`
stage_name required	string	Name	`test-stage`
deployment_id required	string	Deployment ID	`27bb070b564349f8a31cc60734cc36a5`
description optional	string	Description	`description`

Responses

Name	Description	Example
active_deployment	Active Deployment	2024-05-17T00:23:17Z
allow_credentials	Allow Credentials	True
allow_headers	Allow Headers	[‘Content-Type’, ‘Authorization’]
allow_methods	Allow Methods	[‘GET’, ‘POST’, ‘PUT’, ‘PATCH’]
allow_origins	Allow Origins	[’*’]
api_id	Api ID	27bb070b564349f8a31cc60734cc36a5
cors_enabled	Cors Enabled	False
created_at	Creation Date
deployment_id	Deployment ID	27bb070b564349f8a31cc60734cc36a5
expose_headers	Expose Headers	[’test1’, ’test2’]
invoke_url	Invoke URL	http://test.com/stg
ip_restriction_enabled	IP Restriction Enabled	False
jwt_enabled	JWT Enabled	False
max_age	Max Age	3600
name	Stage Name	test-stage

12 - Create Usage Plans

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)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`
rate required	string	Usage Plan Rate	`day`
name required	string	Name	`usage-plan-name`
limit required	integer	Usage Plan Limit	`10`
description optional	string	Description	`description`

Responses

Name	Description	Example
id	Usage Plan ID	27bb070b564349f8a31cc60734cc36a5
api_keys	API Keys	[]
created_at	Creation Date
created_by_id	Created by	27bb070b564349f8a31cc60734cc36a5
created_by_name	Created by	username
description	Description	description
limit	Usage Plan Limit	10
modified_at	Modified at
modified_by_id	Modified by	27bb070b564349f8a31cc60734cc36a5
modified_by_name	Modified by	username
name	Name	usage-plan-name
rate	Usage Plan Rate	day

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.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`
rate required	string	Usage Plan Rate	`day`
name required	string	Name	`usage-plan-name`
limit required	integer	Usage Plan Limit	`10`
description optional	string	Description	`description`

Responses

Name	Description	Example
id	Usage Plan ID	27bb070b564349f8a31cc60734cc36a5
api_keys	API Keys	[]
created_at	Creation Date
created_by_id	Created by	27bb070b564349f8a31cc60734cc36a5
created_by_name	Created by	username
description	Description	description
limit	Usage Plan Limit	10
modified_at	Modified at
modified_by_id	Modified by	27bb070b564349f8a31cc60734cc36a5
modified_by_name	Modified by	username
name	Name	usage-plan-name
rate	Usage Plan Rate	day

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.

Version	Not Before
1.1	20260430

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`
rate required	string	Usage Plan Rate	`day`
name required	string	Name	`usage-plan-name`
limit required	integer	Usage Plan Limit	`10`
description optional	string	Description	`description`

Responses

Name	Description	Example
id	Usage Plan ID	27bb070b564349f8a31cc60734cc36a5
api_keys	API Keys	[]
created_at	Creation Date
created_by_id	Created by	27bb070b564349f8a31cc60734cc36a5
created_by_name	Created by	username
description	Description	description
limit	Usage Plan Limit	10
modified_at	Modified at
modified_by_id	Modified by	27bb070b564349f8a31cc60734cc36a5
modified_by_name	Modified by	username
name	Name	usage-plan-name
rate	Usage Plan Rate	day

13 - Delete Access Control

13.1 - 1.3

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

Description

Delete access control

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
access_control_id required	string	Access Control ID	-
api_id required	string	Api ID	-

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.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
access_control_id required	string	Access Control ID	-
api_id required	string	Api ID	-

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.

Version	Not Before
1.1	20260430

Parameters

Name	Type	Description	Example
access_control_id required	string	Access Control ID	-
api_id required	string	Api ID	-

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.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
access_control_id required	string	Access Control ID	-
api_id required	string	Api ID	-

14 - Delete an API Key

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)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
api_key_id required	string	API Key ID	`27bb070b564349f8a31cc60734cc36a5`
usage_plan_id required	string	Usage Plan ID	`27bb070b564349f8a31cc60734cc36a5`
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`

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.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
api_key_id required	string	API Key ID	`27bb070b564349f8a31cc60734cc36a5`
usage_plan_id required	string	Usage Plan ID	`27bb070b564349f8a31cc60734cc36a5`
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`

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.

Version	Not Before
1.1	20260430

Parameters

Name	Type	Description	Example
api_key_id required	string	API Key ID	`27bb070b564349f8a31cc60734cc36a5`
usage_plan_id required	string	Usage Plan ID	`27bb070b564349f8a31cc60734cc36a5`
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`

15 - Delete Api

15.1 - 1.3

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

Description

Delete api

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	`31e749b7b260868f441e862b`

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.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	`31e749b7b260868f441e862b`

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.

Version	Not Before
1.1	20260430

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	`31e749b7b260868f441e862b`

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.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	`31e749b7b260868f441e862b`

16 - Delete Auth

16.1 - 1.3

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

Description

Delete auth

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
auth_id required	string	Auth ID	-
api_id required	string	Api ID	-

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.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
auth_id required	string	Auth ID	-
api_id required	string	Api ID	-

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.

Version	Not Before
1.1	20260430

Parameters

Name	Type	Description	Example
auth_id required	string	Auth ID	-
api_id required	string	Api ID	-

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.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
auth_id required	string	Auth ID	-
api_id required	string	Api ID	-

17 - Delete Method

17.1 - 1.3

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

Description

Delete method

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
method_type required	****	Method Type	`GET`
resource_id required	string	Resource ID	`27bb070b564349f8a31cc60734cc36a5`
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`

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.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
method_type required	****	Method Type	`GET`
resource_id required	string	Resource ID	`27bb070b564349f8a31cc60734cc36a5`
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`

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.

Version	Not Before
1.1	20260430

Parameters

Name	Type	Description	Example
method_type required	****	Method Type	`GET`
resource_id required	string	Resource ID	`27bb070b564349f8a31cc60734cc36a5`
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`

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.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
method_type required	****	Method Type	`GET`
resource_id required	string	Resource ID	`27bb070b564349f8a31cc60734cc36a5`
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`

18 - Delete PrivateLink Endpoint

18.1 - 1.3

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

Description

Delete PrivateLink Endpoint

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
privatelink_endpoint_id required	string	PrivateLink Endpoint ID	`27bb070b564349f8a31cc60734cc36a5`

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.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
privatelink_endpoint_id required	string	PrivateLink Endpoint ID	`27bb070b564349f8a31cc60734cc36a5`

19 - Delete Resource

19.1 - 1.3

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

Description

Delete resource

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
resource_id required	string	Resource ID	`27bb070b564349f8a31cc60734cc36a5`
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`

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.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
resource_id required	string	Resource ID	`27bb070b564349f8a31cc60734cc36a5`
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`

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.

Version	Not Before
1.1	20260430

Parameters

Name	Type	Description	Example
resource_id required	string	Resource ID	`27bb070b564349f8a31cc60734cc36a5`
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`

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.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
resource_id required	string	Resource ID	`27bb070b564349f8a31cc60734cc36a5`
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`

20 - Delete Resource Policy

20.1 - 1.3

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

Description

Delete Resource Policy

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`

21 - Delete Stage

21.1 - 1.3

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

Description

Delete stage

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`
stage_name required	string	Stage Name	`test-stage`

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.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`
stage_name required	string	Stage Name	`test-stage`

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.

Version	Not Before
1.1	20260430

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`
stage_name required	string	Stage Name	`test-stage`

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.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`
stage_name required	string	Stage Name	`test-stage`

22 - Delete Usage Plan

22.1 - 1.3

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

Description

Delete usage plan

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
usage_plan_id required	string	Usage Plan ID	`27bb070b564349f8a31cc60734cc36a5`
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`

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.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
usage_plan_id required	string	Usage Plan ID	`27bb070b564349f8a31cc60734cc36a5`
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`

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.

Version	Not Before
1.1	20260430

Parameters

Name	Type	Description	Example
usage_plan_id required	string	Usage Plan ID	`27bb070b564349f8a31cc60734cc36a5`
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`

23 - List AccessControls

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)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	-
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`

Responses

Name	Description	Example
id	Access Control ID	27bb070b564349f8a31cc60734cc36a5
allowed_ip_addr	Allowed IP Address	[‘127.0.0.1/24,192.168.127.12’]
connected_stages	Connected Stages	[‘dev,stg’]
created_at	Creation Date	2024-05-19T00:23:17Z
description	Description
name	Access Control Name	DenyTest

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.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	-
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`

Responses

Name	Description	Example
id	Access Control ID	27bb070b564349f8a31cc60734cc36a5
allowed_ip_addr	Allowed IP Address	[‘127.0.0.1/24,192.168.127.12’]
connected_stages	Connected Stages	[‘dev,stg’]
created_at	Creation Date	2024-05-19T00:23:17Z
description	Description
name	Access Control Name	DenyTest

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.

Version	Not Before
1.1	20260430

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	-
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`

Responses

Name	Description	Example
id	Access Control ID	27bb070b564349f8a31cc60734cc36a5
allowed_ip_addr	Allowed IP Address	[‘127.0.0.1/24,192.168.127.12’]
connected_stages	Connected Stages	[‘dev,stg’]
created_at	Creation Date	2024-05-19T00:23:17Z
description	Description
name	Access Control Name	DenyTest

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.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	-
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`

Responses

Name	Description	Example
id	Access Control ID	27bb070b564349f8a31cc60734cc36a5
allowed_ip_addr	Allowed IP Address	[‘127.0.0.1/24,192.168.127.12’]
connected_stages	Connected Stages	[‘dev,stg’]
created_at	Creation Date	2024-05-19T00:23:17Z
description	Description
name	Access Control Name	DenyTest

24 - List Api Deployments

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)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	`31e749b7b260868f441e862b`
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
deployment_id optional	string	Name	`27bb070b564349f8a31cc60734cc36a5`
stage_name optional	string	Stage Name	`test-stage`

Responses

Name	Description	Example
deployment_date	Deployment Date	2024-05-17T00:23:17Z
deployment_id	Deployment ID	27bb070b564349f8a31cc60734cc36a5
description	Description	description
status	Status	Active

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.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	`31e749b7b260868f441e862b`
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
deployment_id optional	string	Name	`27bb070b564349f8a31cc60734cc36a5`
stage_name optional	string	Stage Name	`test-stage`

Responses

Name	Description	Example
deployment_date	Deployment Date	2024-05-17T00:23:17Z
deployment_id	Deployment ID	27bb070b564349f8a31cc60734cc36a5
description	Description	description
status	Status	Active

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.

Version	Not Before
1.1	20260430

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	`31e749b7b260868f441e862b`
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
deployment_id optional	string	Name	`27bb070b564349f8a31cc60734cc36a5`
stage_name optional	string	Stage Name	`test-stage`

Responses

Name	Description	Example
deployment_date	Deployment Date	2024-05-17T00:23:17Z
deployment_id	Deployment ID	27bb070b564349f8a31cc60734cc36a5
description	Description	description
status	Status	Active

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.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	`31e749b7b260868f441e862b`
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
deployment_id optional	string	Name	`27bb070b564349f8a31cc60734cc36a5`
stage_name optional	string	Stage Name	`test-stage`

Responses

Name	Description	Example
deployment_date	Deployment Date	2024-05-17T00:23:17Z
deployment_id	Deployment ID	27bb070b564349f8a31cc60734cc36a5
description	Description	description
status	Status	Active

25 - List Api Keys

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)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
usage_plan_id required	string	Usage Plan ID	`27bb070b564349f8a31cc60734cc36a5`
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
name optional	string	Name	`api-key-name`

Responses

Name	Description	Example
id	API Key ID	27bb070b564349f8a31cc60734cc36a5
created_at	Creation Date
description	Description	description
key	Key	key
name	Name	api-key-name

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.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
usage_plan_id required	string	Usage Plan ID	`27bb070b564349f8a31cc60734cc36a5`
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
name optional	string	Name	`api-key-name`

Responses

Name	Description	Example
id	API Key ID	27bb070b564349f8a31cc60734cc36a5
created_at	Creation Date
description	Description	description
key	Key	key
name	Name	api-key-name

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.

Version	Not Before
1.1	20260430

Parameters

Name	Type	Description	Example
usage_plan_id required	string	Usage Plan ID	`27bb070b564349f8a31cc60734cc36a5`
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
name optional	string	Name	`api-key-name`

Responses

Name	Description	Example
id	API Key ID	27bb070b564349f8a31cc60734cc36a5
created_at	Creation Date
description	Description	description
key	Key	key
name	Name	api-key-name

26 - List Apis

26.1 - 1.3

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

Description

Get apis list

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
name optional	string	Name	`test-api`

Responses

Name	Description	Example
id	Api ID	27bb070b564349f8a31cc60734cc36a5
account_id	Account ID	27bb070b564349f8a31cc60734cc36a5
created_at	Creation Date	2024-05-17T00:23:17Z
description	Description	Description
dns_record_status	DNS Record Status	Active
name	Name	test-api
status	Api Status	Active

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.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
name optional	string	Name	`test-api`

Responses

Name	Description	Example
id	Api ID	27bb070b564349f8a31cc60734cc36a5
account_id	Account ID	27bb070b564349f8a31cc60734cc36a5
created_at	Creation Date	2024-05-17T00:23:17Z
description	Description	Description
dns_record_status	DNS Record Status	Active
name	Name	test-api
status	Api Status	Active

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.

Version	Not Before
1.1	20260430

Parameters

Name	Type	Description	Example
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
name optional	string	Name	`test-api`

Responses

Name	Description	Example
id	Api ID	27bb070b564349f8a31cc60734cc36a5
account_id	Account ID	27bb070b564349f8a31cc60734cc36a5
created_at	Creation Date	2024-05-17T00:23:17Z
description	Description	Description
dns_record_status	DNS Record Status	Active
name	Name	test-api
status	Api Status	Active

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.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
name optional	string	Name	`test-api`

Responses

Name	Description	Example
id	Api ID	27bb070b564349f8a31cc60734cc36a5
account_id	Account ID	27bb070b564349f8a31cc60734cc36a5
created_at	Creation Date	2024-05-17T00:23:17Z
description	Description	Description
dns_record_status	DNS Record Status	Active
name	Name	test-api
status	Api Status	Active

27 - List Auths

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)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	-
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`

Responses

Name	Description	Example
id	Auth ID	27bb070b564349f8a31cc60734cc36a5
auth_method	AUTH Method	JWT(JSON WEB Token)
connected_stages	Connected Stages	[‘dev,stg’]
expired_at	Expiration Date	2024-05-17T00:23:17Z
name	Auth NAME	Token01

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.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	-
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`

Responses

Name	Description	Example
id	Auth ID	27bb070b564349f8a31cc60734cc36a5
auth_method	AUTH Method	JWT(JSON WEB Token)
connected_stages	Connected Stages	[‘dev,stg’]
expired_at	Expiration Date	2024-05-17T00:23:17Z
name	Auth NAME	Token01

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.

Version	Not Before
1.1	20260430

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	-
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`

Responses

Name	Description	Example
id	Auth ID	27bb070b564349f8a31cc60734cc36a5
auth_method	AUTH Method	JWT(JSON WEB Token)
connected_stages	Connected Stages	[‘dev,stg’]
expired_at	Expiration Date	2024-05-17T00:23:17Z
name	Auth NAME	Token01

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.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	-
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`

Responses

Name	Description	Example
id	Auth ID	27bb070b564349f8a31cc60734cc36a5
auth_method	AUTH Method	JWT(JSON WEB Token)
connected_stages	Connected Stages	[‘dev,stg’]
expired_at	Expiration Date	2024-05-17T00:23:17Z
name	Auth NAME	Token01

28 - List Connected PrivateLink Endpoints

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)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	`31e749b7b260868f441e862b`
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`

Responses

Name	Description	Example
id	PrivateLink Endpoint ID	27bb070b564349f8a31cc60734cc36a5
created_at	Creation Date	2024-05-17T00:23:17Z
status	PrivateLink Endpoint Status	Active

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.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	`31e749b7b260868f441e862b`
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`

Responses

Name	Description	Example
id	PrivateLink Endpoint ID	27bb070b564349f8a31cc60734cc36a5
created_at	Creation Date	2024-05-17T00:23:17Z
status	PrivateLink Endpoint Status	Active

29 - List Methods

29.1 - 1.3

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

Description

Get methods list

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
resource_id required	string	Resource ID	`27bb070b564349f8a31cc60734cc36a5`
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`

Responses

Name	Description	Example
api_key_required	Api Key Required	False
endpoint_url	Method Endpoint URL	https://127.0.0.1:8000
function_id	Cloud Function ID	27bb070b564349f8a31cc60734cc36a5
function_name	Cloud Function Name	test-function
iam_enabled	IAM Enabled	False
integration_type	Method Integration Type	HTTP
method_type	Method Type	GET
privatelink_endpoint_id	PrivateLink Endpoint ID	27bb070b564349f8a31cc60734cc36a5
query_strings	Method Query Strings	{‘param1’: ‘value1’, ‘param2’: ‘value2’}
request_headers	Method Request Headers	{’test1’ : True}
request_path	Method Request Path	{users}
srn	SRN	srn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test

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.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
resource_id required	string	Resource ID	`27bb070b564349f8a31cc60734cc36a5`
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`

Responses

Name	Description	Example
api_key_required	Api Key Required	False
endpoint_url	Method Endpoint URL	https://127.0.0.1:8000
function_id	Cloud Function ID	27bb070b564349f8a31cc60734cc36a5
function_name	Cloud Function Name	test-function
integration_type	Method Integration Type	HTTP
method_type	Method Type	GET
privatelink_endpoint_id	PrivateLink Endpoint ID	27bb070b564349f8a31cc60734cc36a5
query_strings	Method Query Strings	{‘param1’: ‘value1’, ‘param2’: ‘value2’}
request_headers	Method Request Headers	{’test1’ : True}
request_path	Method Request Path	{users}
srn	SRN	srn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test

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.

Version	Not Before
1.1	20260430

Parameters

Name	Type	Description	Example
resource_id required	string	Resource ID	`27bb070b564349f8a31cc60734cc36a5`
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`

Responses

Name	Description	Example
api_key_required	Api Key Required	False
endpoint_url	Method Endpoint URL	https://127.0.0.1:8000
function_id	Cloud Function ID	27bb070b564349f8a31cc60734cc36a5
function_name	Cloud Function Name	test-function
integration_type	Method Integration Type	HTTP
method_type	Method Type	GET
query_strings	Method Query Strings	{‘param1’: ‘value1’, ‘param2’: ‘value2’}
request_headers	Method Request Headers	{’test1’ : True}
request_path	Method Request Path	{users}
srn	SRN	srn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test

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.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
resource_id required	string	Resource ID	`27bb070b564349f8a31cc60734cc36a5`
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`

Responses

Name	Description	Example
endpoint_url	Method Endpoint URL	https://127.0.0.1:8000
function_id	Cloud Function ID	27bb070b564349f8a31cc60734cc36a5
integration_type	Method Integration Type	HTTP
method_type	Method Type	GET
query_strings	Method Query Strings	{‘param1’: ‘value1’, ‘param2’: ‘value2’}
request_headers	Method Request Headers	{’test1’ : True}
request_path	Method Request Path	{users}
srn	SRN	srn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test

30 - List PrivateLink Endpoints

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)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
name optional	string	PrivateLink Endpoint Name	`endpoint`

Responses

Name	Description	Example
id	PrivateLink Endpoint ID	27bb070b564349f8a31cc60734cc36a5
created_at	Creation Date	2024-05-17T00:23:17Z
name	PrivateLink Endpoint Name	endpoint
privatelink_service_id	PrivateLink Service ID	27bb070b564349f8a31cc60734cc36a5
status	PrivateLink Endpoint Status	CANCELED

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.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
name optional	string	PrivateLink Endpoint Name	`endpoint`

Responses

Name	Description	Example
id	PrivateLink Endpoint ID	27bb070b564349f8a31cc60734cc36a5
created_at	Creation Date	2024-05-17T00:23:17Z
name	PrivateLink Endpoint Name	endpoint
privatelink_service_id	PrivateLink Service ID	27bb070b564349f8a31cc60734cc36a5
status	PrivateLink Endpoint Status	CANCELED

31 - List Reports

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)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`
end_date required	string	End Date	`2025-07-30`
start_date required	string	Start Date	`2025-07-01`
stage_name required	string	Stage Name	`test-stage`

Responses

Name	Description	Example
call_count	Call Count	10
date	Date
error_4xx_count	Error 4xx Count	10
error_5xx_count	Error 5xx Count	10
integration_latency	Integration Latency	10
latency	Latency	10

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.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`
end_date required	string	End Date	`2025-07-30`
start_date required	string	Start Date	`2025-07-01`
stage_name required	string	Stage Name	`test-stage`

Responses

Name	Description	Example
call_count	Call Count	10
date	Date
error_4xx_count	Error 4xx Count	10
error_5xx_count	Error 5xx Count	10
integration_latency	Integration Latency	10
latency	Latency	10

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.

Version	Not Before
1.1	20260430

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`
end_date required	string	End Date	`2025-07-30`
start_date required	string	Start Date	`2025-07-01`
stage_name required	string	Stage Name	`test-stage`

Responses

Name	Description	Example
call_count	Call Count	10
date	Date
error_4xx_count	Error 4xx Count	10
error_5xx_count	Error 5xx Count	10
integration_latency	Integration Latency	10
latency	Latency	10

32 - List Resources

32.1 - 1.3

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

Description

Get resources list

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`

Responses

Name	Description	Example
id	Resource ID	27bb070b564349f8a31cc60734cc36a5
methods
parent_id	Parent Resource ID	27bb070b564349f8a31cc60734cc36a5
path	Path	/test/test1
path_part	Path Part	test

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.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`

Responses

Name	Description	Example
id	Resource ID	27bb070b564349f8a31cc60734cc36a5
methods
parent_id	Parent Resource ID	27bb070b564349f8a31cc60734cc36a5
path	Path	/test/test1
path_part	Path Part	test

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.

Version	Not Before
1.1	20260430

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`

Responses

Name	Description	Example
id	Resource ID	27bb070b564349f8a31cc60734cc36a5
methods
parent_id	Parent Resource ID	27bb070b564349f8a31cc60734cc36a5
path	Path	/test/test1
path_part	Path Part	test

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.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`

Responses

Name	Description	Example
id	Resource ID	27bb070b564349f8a31cc60734cc36a5
methods
parent_id	Parent Resource ID	27bb070b564349f8a31cc60734cc36a5
path	Path	/test/test1
path_part	Path Part	test

33 - List Stages

33.1 - 1.3

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

Description

Get stages list

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`

Responses

Name	Description	Example
active_deployment	Active Deployment	2024-05-17T00:23:17Z
allow_credentials	Allow Credentials	True
allow_headers	Allow Headers	[‘Content-Type’, ‘Authorization’]
allow_methods	Allow Methods	[‘GET’, ‘POST’, ‘PUT’, ‘PATCH’]
allow_origins	Allow Origins	[’*’]
api_id	Api ID	27bb070b564349f8a31cc60734cc36a5
api_summary	API 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_enabled	Cors Enabled	False
created_at	Creation Date
deployment_id	Deployment ID	27bb070b564349f8a31cc60734cc36a5
description	Description	description
expose_headers	Expose Headers	[’test1’, ’test2’]
invoke_url	Invoke URL	http://test.com/stg
jwt_enabled	JWT Enabled	False
max_age	Max Age	3600
name	Stage Name	test-stage
usage_plan_api_keys	API Keys	[]
usage_plan_id	Usage Plan ID	27bb070b564349f8a31cc60734cc36a5
usage_plan_limit	Usage Plan Limit	10
usage_plan_name	Name	usage-plan-name
usage_plan_rate	Usage Plan Rate	day

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.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`

Responses

Name	Description	Example
active_deployment	Active Deployment	2024-05-17T00:23:17Z
allow_credentials	Allow Credentials	True
allow_headers	Allow Headers	[‘Content-Type’, ‘Authorization’]
allow_methods	Allow Methods	[‘GET’, ‘POST’, ‘PUT’, ‘PATCH’]
allow_origins	Allow Origins	[’*’]
api_id	Api ID	27bb070b564349f8a31cc60734cc36a5
api_key_required	Api Key Required	False
api_summary	API 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_enabled	Cors Enabled	False
created_at	Creation Date
deployment_id	Deployment ID	27bb070b564349f8a31cc60734cc36a5
description	Description	description
expose_headers	Expose Headers	[’test1’, ’test2’]
invoke_url	Invoke URL	http://test.com/stg
jwt_enabled	JWT Enabled	False
max_age	Max Age	3600
name	Stage Name	test-stage
usage_plan_api_keys	API Keys	[]
usage_plan_id	Usage Plan ID	27bb070b564349f8a31cc60734cc36a5
usage_plan_limit	Usage Plan Limit	10
usage_plan_name	Name	usage-plan-name
usage_plan_rate	Usage Plan Rate	day

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.

Version	Not Before
1.1	20260430

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`

Responses

Name	Description	Example
active_deployment	Active Deployment	2024-05-17T00:23:17Z
allow_credentials	Allow Credentials	True
allow_headers	Allow Headers	[‘Content-Type’, ‘Authorization’]
allow_methods	Allow Methods	[‘GET’, ‘POST’, ‘PUT’, ‘PATCH’]
allow_origins	Allow Origins	[’*’]
api_id	Api ID	27bb070b564349f8a31cc60734cc36a5
api_key_required	Api Key Required	False
api_summary	API 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_enabled	Cors Enabled	False
created_at	Creation Date
deployment_id	Deployment ID	27bb070b564349f8a31cc60734cc36a5
description	Description	description
expose_headers	Expose Headers	[’test1’, ’test2’]
invoke_url	Invoke URL	http://test.com/stg
jwt_enabled	JWT Enabled	False
max_age	Max Age	3600
name	Stage Name	test-stage
usage_plan_api_keys	API Keys	[]
usage_plan_id	Usage Plan ID	27bb070b564349f8a31cc60734cc36a5
usage_plan_limit	Usage Plan Limit	10
usage_plan_name	Name	usage-plan-name
usage_plan_rate	Usage Plan Rate	day

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.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`

Responses

Name	Description	Example
active_deployment	Active Deployment	2024-05-17T00:23:17Z
allow_credentials	Allow Credentials	True
allow_headers	Allow Headers	[‘Content-Type’, ‘Authorization’]
allow_methods	Allow Methods	[‘GET’, ‘POST’, ‘PUT’, ‘PATCH’]
allow_origins	Allow Origins	[’*’]
api_id	Api ID	27bb070b564349f8a31cc60734cc36a5
api_summary	API Summary	[{‘methods’: [‘GET’, ‘POST’], ‘path’: ‘/’}, {‘methods’: [‘GET’, ‘POST’], ‘path’: ‘/test’}]
cors_enabled	Cors Enabled	False
created_at	Creation Date
deployment_id	Deployment ID	27bb070b564349f8a31cc60734cc36a5
expose_headers	Expose Headers	[’test1’, ’test2’]
invoke_url	Invoke URL	http://test.com/stg
ip_restriction_enabled	IP Restriction Enabled	False
jwt_enabled	JWT Enabled	False
max_age	Max Age	3600
name	Stage Name	test-stage

34 - List Usage Plans

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)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
name optional	string	Name	`usage-plan-name`

Responses

Name	Description	Example
id	Usage Plan ID	27bb070b564349f8a31cc60734cc36a5
connected_api_keys	Connected API Keys	[‘key1’, ‘key2’]
created_at	Creation Date
description	Description	description
limit	Usage Plan Limit	10
name	Name	usage-plan-name
rate	Usage Plan Rate	day

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.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
name optional	string	Name	`usage-plan-name`

Responses

Name	Description	Example
id	Usage Plan ID	27bb070b564349f8a31cc60734cc36a5
connected_api_keys	Connected API Keys	[‘key1’, ‘key2’]
created_at	Creation Date
description	Description	description
limit	Usage Plan Limit	10
name	Name	usage-plan-name
rate	Usage Plan Rate	day

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.

Version	Not Before
1.1	20260430

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
name optional	string	Name	`usage-plan-name`

Responses

Name	Description	Example
id	Usage Plan ID	27bb070b564349f8a31cc60734cc36a5
connected_api_keys	Connected API Keys	[‘key1’, ‘key2’]
created_at	Creation Date
description	Description	description
limit	Usage Plan Limit	10
name	Name	usage-plan-name
rate	Usage Plan Rate	day

35 - Request PrivateLink Endpoint

35.1 - 1.3

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

Description

Request PrivateLink Endpoint

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
privatelink_endpoint_id required	string	PrivateLink Endpoint ID	`27bb070b564349f8a31cc60734cc36a5`
type required	string	PrivateLink Endpoint Action Type	`CANCEL`

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.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
privatelink_endpoint_id required	string	PrivateLink Endpoint ID	`27bb070b564349f8a31cc60734cc36a5`
type required	string	PrivateLink Endpoint Action Type	`CANCEL`

36 - Set Access Control

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)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
access_control_id required	string	Access Control ID	-
api_id required	string	Api ID	-
connected_stages required	array	Connected Stages	`dev,stg`
allowed_ip_addr required	array	Allowed IP Address	`127.0.0.1/24,192.168.127.12`
description optional	string	Description	`description`

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.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
access_control_id required	string	Access Control ID	-
api_id required	string	Api ID	-
connected_stages required	array	Connected Stages	`dev,stg`
allowed_ip_addr required	array	Allowed IP Address	`127.0.0.1/24,192.168.127.12`
description optional	string	Description	`description`

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.

Version	Not Before
1.1	20260430

Parameters

Name	Type	Description	Example
access_control_id required	string	Access Control ID	-
api_id required	string	Api ID	-
connected_stages required	array	Connected Stages	`dev,stg`
allowed_ip_addr required	array	Allowed IP Address	`127.0.0.1/24,192.168.127.12`
description optional	string	Description	`description`

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.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
access_control_id required	string	Access Control ID	-
api_id required	string	Api ID	-
connected_stages required	array	Connected Stages	`dev,stg`
allowed_ip_addr required	array	Allowed IP Address	`127.0.0.1/24,192.168.127.12`
description optional	string	Description	`description`

37 - Set Api Description

37.1 - 1.3

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

Description

Set api description

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	`31e749b7b260868f441e862b`
description optional	string	Description	`description`

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.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	`31e749b7b260868f441e862b`
description optional	string	Description	`description`

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.

Version	Not Before
1.1	20260430

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	`31e749b7b260868f441e862b`
description optional	string	Description	`description`

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.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	`31e749b7b260868f441e862b`
description optional	string	Description	`description`

38 - Set API Key Description

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)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
api_key_id required	string	API Key ID	`27bb070b564349f8a31cc60734cc36a5`
usage_plan_id required	string	Usage Plan ID	`27bb070b564349f8a31cc60734cc36a5`
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`
description optional	string	Description	`description`

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.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
api_key_id required	string	API Key ID	`27bb070b564349f8a31cc60734cc36a5`
usage_plan_id required	string	Usage Plan ID	`27bb070b564349f8a31cc60734cc36a5`
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`
description optional	string	Description	`description`

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.

Version	Not Before
1.1	20260430

Parameters

Name	Type	Description	Example
api_key_id required	string	API Key ID	`27bb070b564349f8a31cc60734cc36a5`
usage_plan_id required	string	Usage Plan ID	`27bb070b564349f8a31cc60734cc36a5`
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`
description optional	string	Description	`description`

39 - Set Auth

39.1 - 1.3

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

Description

Set auth

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
auth_id required	string	Auth ID	-
api_id required	string	Api ID	-
connected_stages required	array	Connected Stages	`dev,stg`

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.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
auth_id required	string	Auth ID	-
api_id required	string	Api ID	-
connected_stages required	array	Connected Stages	`dev,stg`

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.

Version	Not Before
1.1	20260430

Parameters

Name	Type	Description	Example
auth_id required	string	Auth ID	-
api_id required	string	Api ID	-
connected_stages required	array	Connected Stages	`dev,stg`

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.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
auth_id required	string	Auth ID	-
api_id required	string	Api ID	-
connected_stages required	array	Connected Stages	`dev,stg`

40 - Set Method

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)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
method_type required	****	Method Type	`GET`
resource_id required	string	Resource ID	`27bb070b564349f8a31cc60734cc36a5`
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`
request_headers required	dict	Method Request Headers	`{'test1' : True}`
query_strings required	dict	Method Query Strings	`{'param1': 'value1', 'param2': 'value2'}`
integration_type required	string	Method Integration Type	`HTTP`
iam_enabled required	boolean	IAM Enabled	`False`
api_key_required required	boolean	Api Key Required	`False`
endpoint_url optional	string	Method Endpoint URL	`https://127.0.0.1:8000`
function_id optional	string	Cloud Function ID	`27bb070b564349f8a31cc60734cc36a5`
privatelink_endpoint_id optional	string	PrivateLink Endpoint ID	`27bb070b564349f8a31cc60734cc36a5`

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.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
method_type required	****	Method Type	`GET`
resource_id required	string	Resource ID	`27bb070b564349f8a31cc60734cc36a5`
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`
request_headers required	dict	Method Request Headers	`{'test1' : True}`
query_strings required	dict	Method Query Strings	`{'param1': 'value1', 'param2': 'value2'}`
integration_type required	string	Method Integration Type	`HTTP`
api_key_required required	boolean	Api Key Required	`False`
endpoint_url optional	string	Method Endpoint URL	`https://127.0.0.1:8000`
function_id optional	string	Cloud Function ID	`27bb070b564349f8a31cc60734cc36a5`
privatelink_endpoint_id optional	string	PrivateLink Endpoint ID	`27bb070b564349f8a31cc60734cc36a5`

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.

Version	Not Before
1.1	20260430

Parameters

Name	Type	Description	Example
method_type required	****	Method Type	`GET`
resource_id required	string	Resource ID	`27bb070b564349f8a31cc60734cc36a5`
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`
request_headers required	dict	Method Request Headers	`{'test1' : True}`
query_strings required	dict	Method Query Strings	`{'param1': 'value1', 'param2': 'value2'}`
integration_type required	string	Method Integration Type	`HTTP`
api_key_required required	boolean	Api Key Required	`False`
endpoint_url optional	string	Method Endpoint URL	`https://127.0.0.1:8000`
function_id optional	string	Cloud Function ID	`27bb070b564349f8a31cc60734cc36a5`
privatelink_endpoint_id optional	string	PrivateLink Endpoint ID	`27bb070b564349f8a31cc60734cc36a5`

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.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
method_type required	****	Method Type	`GET`
resource_id required	string	Resource ID	`27bb070b564349f8a31cc60734cc36a5`
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`
request_headers required	dict	Method Request Headers	`{'test1' : True}`
query_strings required	dict	Method Query Strings	`{'param1': 'value1', 'param2': 'value2'}`

41 - Set PrivateLink Endpoint

41.1 - 1.3

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

Description

Set PrivateLink Endpoint

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
privatelink_endpoint_id required	string	PrivateLink Endpoint ID	`27bb070b564349f8a31cc60734cc36a5`
description optional	string	Description	`description`

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.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
privatelink_endpoint_id required	string	PrivateLink Endpoint ID	`27bb070b564349f8a31cc60734cc36a5`
description optional	string	Description	`description`

42 - Set Resource Policy

42.1 - 1.3

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

Description

Set Resource Policy

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`
version required	string	Version	`2024-07-01`
statement required	array	Statement	`'{"Action": ["iam:"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": [""], "Sid": "Statement1"}'`

43 - Set Stage Active Deployment

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)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`
stage_name required	string	Stage Name	`test-stage`
deployment_id required	string	Deployment ID	`27bb070b564349f8a31cc60734cc36a5`

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.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`
stage_name required	string	Stage Name	`test-stage`
deployment_id required	string	Deployment ID	`27bb070b564349f8a31cc60734cc36a5`

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.

Version	Not Before
1.1	20260430

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`
stage_name required	string	Stage Name	`test-stage`
deployment_id required	string	Deployment ID	`27bb070b564349f8a31cc60734cc36a5`

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.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`
stage_name required	string	Stage Name	`test-stage`
deployment_id required	string	Deployment ID	`27bb070b564349f8a31cc60734cc36a5`

44 - Set Stage Configuration

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)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`
stage_name required	string	Stage Name	`test-stage`
jwt_enabled required	boolean	JWT Enabled	`False`
cors_enabled required	boolean	Cors Enabled	`False`
allow_credentials optional	boolean	Allow Credentials	`True`
allow_headers optional	array	Allow Headers	`Content-Type`
allow_methods optional	array	Allow Methods	`'{}'`
allow_origins optional	array	Allow Origins	`*`
connected_api_keys optional	array	Connected API Keys	`key1`
description optional	string	Description	`description`
expose_headers optional	array	Expose Headers	`test1`
max_age optional	integer	Max Age	`3600`
usage_plan_id optional	string	Usage Plan ID	`27bb070b564349f8a31cc60734cc36a5`

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.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`
stage_name required	string	Stage Name	`test-stage`
jwt_enabled required	boolean	JWT Enabled	`False`
cors_enabled required	boolean	Cors Enabled	`False`
allow_credentials optional	boolean	Allow Credentials	`True`
allow_headers optional	array	Allow Headers	`Content-Type`
allow_methods optional	array	Allow Methods	`'{}'`
allow_origins optional	array	Allow Origins	`*`
connected_api_keys optional	array	Connected API Keys	`key1`
description optional	string	Description	`description`
expose_headers optional	array	Expose Headers	`test1`
max_age optional	integer	Max Age	`3600`
usage_plan_id optional	string	Usage Plan ID	`27bb070b564349f8a31cc60734cc36a5`

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.

Version	Not Before
1.1	20260430

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`
stage_name required	string	Stage Name	`test-stage`
jwt_enabled required	boolean	JWT Enabled	`False`
cors_enabled required	boolean	Cors Enabled	`False`
allow_credentials optional	boolean	Allow Credentials	`True`
allow_headers optional	array	Allow Headers	`Content-Type`
allow_methods optional	array	Allow Methods	`'{}'`
allow_origins optional	array	Allow Origins	`*`
connected_api_keys optional	array	Connected API Keys	`key1`
description optional	string	Description	`description`
expose_headers optional	array	Expose Headers	`test1`
max_age optional	integer	Max Age	`3600`
usage_plan_id optional	string	Usage Plan ID	`27bb070b564349f8a31cc60734cc36a5`

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.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`
stage_name required	string	Stage Name	`test-stage`
jwt_enabled required	boolean	JWT Enabled	`False`
ip_restriction_enabled required	boolean	IP Restriction Enabled	`False`
cors_enabled required	boolean	Cors Enabled	`False`
allow_credentials optional	boolean	Allow Credentials	`True`
allow_headers optional	array	Allow Headers	`Content-Type`
allow_methods optional	array	Allow Methods	`'{}'`
allow_origins optional	array	Allow Origins	`*`
expose_headers optional	array	Expose Headers	`test1`
max_age optional	integer	Max Age	`3600`

45 - Set Usage Plan Description

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)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
usage_plan_id required	string	Usage Plan ID	`27bb070b564349f8a31cc60734cc36a5`
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`
description optional	string	Description	`description`

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.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
usage_plan_id required	string	Usage Plan ID	`27bb070b564349f8a31cc60734cc36a5`
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`
description optional	string	Description	`description`

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.

Version	Not Before
1.1	20260430

Parameters

Name	Type	Description	Example
usage_plan_id required	string	Usage Plan ID	`27bb070b564349f8a31cc60734cc36a5`
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`
description optional	string	Description	`description`

46 - Set Usage Plan Quota

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)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
usage_plan_id required	string	Usage Plan ID	`27bb070b564349f8a31cc60734cc36a5`
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`
rate required	string	Usage Plan Rate	`day`
limit required	integer	Usage Plan Limit	`10`

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.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
usage_plan_id required	string	Usage Plan ID	`27bb070b564349f8a31cc60734cc36a5`
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`
rate required	string	Usage Plan Rate	`day`
limit required	integer	Usage Plan Limit	`10`

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.

Version	Not Before
1.1	20260430

Parameters

Name	Type	Description	Example
usage_plan_id required	string	Usage Plan ID	`27bb070b564349f8a31cc60734cc36a5`
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`
rate required	string	Usage Plan Rate	`day`
limit required	integer	Usage Plan Limit	`10`

47 - Show Access Control

47.1 - 1.3

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

Description

Show access control

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
access_control_id required	string	Access Control ID	-
api_id required	string	Api ID	-

Responses

Name	Description	Example
id	Access Control ID	27bb070b564349f8a31cc60734cc36a5
allowed_ip_addr	Allowed IP Address	[‘127.0.0.1/24,192.168.127.12’]
connected_stages	Connected Stages	[‘dev,stg’]
created_at	Creation Date	2024-05-19T00:23:17Z
description	Description
name	Access Control Name	DenyTest

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.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
access_control_id required	string	Access Control ID	-
api_id required	string	Api ID	-

Responses

Name	Description	Example
id	Access Control ID	27bb070b564349f8a31cc60734cc36a5
allowed_ip_addr	Allowed IP Address	[‘127.0.0.1/24,192.168.127.12’]
connected_stages	Connected Stages	[‘dev,stg’]
created_at	Creation Date	2024-05-19T00:23:17Z
description	Description
name	Access Control Name	DenyTest

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.

Version	Not Before
1.1	20260430

Parameters

Name	Type	Description	Example
access_control_id required	string	Access Control ID	-
api_id required	string	Api ID	-

Responses

Name	Description	Example
id	Access Control ID	27bb070b564349f8a31cc60734cc36a5
allowed_ip_addr	Allowed IP Address	[‘127.0.0.1/24,192.168.127.12’]
connected_stages	Connected Stages	[‘dev,stg’]
created_at	Creation Date	2024-05-19T00:23:17Z
description	Description
name	Access Control Name	DenyTest

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.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
access_control_id required	string	Access Control ID	-
api_id required	string	Api ID	-

Responses

Name	Description	Example
id	Access Control ID	27bb070b564349f8a31cc60734cc36a5
allowed_ip_addr	Allowed IP Address	[‘127.0.0.1/24,192.168.127.12’]
connected_stages	Connected Stages	[‘dev,stg’]
created_at	Creation Date	2024-05-19T00:23:17Z
description	Description
name	Access Control Name	DenyTest

48 - Show Api

48.1 - 1.3

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

Description

Show api

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	`31e749b7b260868f441e862b`

Responses

Name	Description	Example
id	Api ID	27bb070b564349f8a31cc60734cc36a5
account_id	Account ID	27bb070b564349f8a31cc60734cc36a5
created_at	Creation Date	2024-05-17T00:23:17Z
description	Description	Description
dns_record_status	DNS Record Status	Active
name	Name	test-api
status	Api Status	Active

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.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	`31e749b7b260868f441e862b`

Responses

Name	Description	Example
id	Api ID	27bb070b564349f8a31cc60734cc36a5
account_id	Account ID	27bb070b564349f8a31cc60734cc36a5
created_at	Creation Date	2024-05-17T00:23:17Z
description	Description	Description
dns_record_status	DNS Record Status	Active
name	Name	test-api
status	Api Status	Active

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.

Version	Not Before
1.1	20260430

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	`31e749b7b260868f441e862b`

Responses

Name	Description	Example
id	Api ID	27bb070b564349f8a31cc60734cc36a5
account_id	Account ID	27bb070b564349f8a31cc60734cc36a5
created_at	Creation Date	2024-05-17T00:23:17Z
description	Description	Description
dns_record_status	DNS Record Status	Active
name	Name	test-api
status	Api Status	Active

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.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	`31e749b7b260868f441e862b`

Responses

Name	Description	Example
id	Api ID	27bb070b564349f8a31cc60734cc36a5
account_id	Account ID	27bb070b564349f8a31cc60734cc36a5
created_at	Creation Date	2024-05-17T00:23:17Z
description	Description	Description
dns_record_status	DNS Record Status	Active
name	Name	test-api
status	Api Status	Active

49 - Show Auth

49.1 - 1.3

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

Description

Show auth

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
auth_id required	string	Auth ID	-
api_id required	string	Api ID	-

Responses

Name	Description	Example
id	Auth ID	27bb070b564349f8a31cc60734cc36a5
auth_method	AUTH Method	JWT(JSON WEB Token)
connected_stages	Connected Stages	[‘dev,stg’]
expired_at	Expiration Date	2024-05-17T00:23:17Z
name	Auth NAME	Token01

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.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
auth_id required	string	Auth ID	-
api_id required	string	Api ID	-

Responses

Name	Description	Example
id	Auth ID	27bb070b564349f8a31cc60734cc36a5
auth_method	AUTH Method	JWT(JSON WEB Token)
connected_stages	Connected Stages	[‘dev,stg’]
expired_at	Expiration Date	2024-05-17T00:23:17Z
name	Auth NAME	Token01

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.

Version	Not Before
1.1	20260430

Parameters

Name	Type	Description	Example
auth_id required	string	Auth ID	-
api_id required	string	Api ID	-

Responses

Name	Description	Example
id	Auth ID	27bb070b564349f8a31cc60734cc36a5
auth_method	AUTH Method	JWT(JSON WEB Token)
connected_stages	Connected Stages	[‘dev,stg’]
expired_at	Expiration Date	2024-05-17T00:23:17Z
name	Auth NAME	Token01

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.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
auth_id required	string	Auth ID	-
api_id required	string	Api ID	-

Responses

Name	Description	Example
id	Auth ID	27bb070b564349f8a31cc60734cc36a5
auth_method	AUTH Method	JWT(JSON WEB Token)
connected_stages	Connected Stages	[‘dev,stg’]
expired_at	Expiration Date	2024-05-17T00:23:17Z
name	Auth NAME	Token01

50 - Show Method

50.1 - 1.3

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

Description

Show method

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
method_type required	****	Method Type	`GET`
resource_id required	string	Resource ID	`27bb070b564349f8a31cc60734cc36a5`
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`

Responses

Name	Description	Example
api_key_required	Api Key Required	False
endpoint_url	Method Endpoint URL	https://127.0.0.1:8000
function_id	Cloud Function ID	27bb070b564349f8a31cc60734cc36a5
function_name	Cloud Function Name	test-function
iam_enabled	IAM Enabled	False
integration_type	Method Integration Type	HTTP
method_type	Method Type	GET
privatelink_endpoint_id	PrivateLink Endpoint ID	27bb070b564349f8a31cc60734cc36a5
query_strings	Method Query Strings	{‘param1’: ‘value1’, ‘param2’: ‘value2’}
request_headers	Method Request Headers	{’test1’ : True}
request_path	Method Request Path	{users}
srn	SRN	srn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test

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.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
method_type required	****	Method Type	`GET`
resource_id required	string	Resource ID	`27bb070b564349f8a31cc60734cc36a5`
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`

Responses

Name	Description	Example
api_key_required	Api Key Required	False
endpoint_url	Method Endpoint URL	https://127.0.0.1:8000
function_id	Cloud Function ID	27bb070b564349f8a31cc60734cc36a5
function_name	Cloud Function Name	test-function
integration_type	Method Integration Type	HTTP
method_type	Method Type	GET
privatelink_endpoint_id	PrivateLink Endpoint ID	27bb070b564349f8a31cc60734cc36a5
query_strings	Method Query Strings	{‘param1’: ‘value1’, ‘param2’: ‘value2’}
request_headers	Method Request Headers	{’test1’ : True}
request_path	Method Request Path	{users}
srn	SRN	srn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test

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.

Version	Not Before
1.1	20260430

Parameters

Name	Type	Description	Example
method_type required	****	Method Type	`GET`
resource_id required	string	Resource ID	`27bb070b564349f8a31cc60734cc36a5`
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`

Responses

Name	Description	Example
api_key_required	Api Key Required	False
endpoint_url	Method Endpoint URL	https://127.0.0.1:8000
function_id	Cloud Function ID	27bb070b564349f8a31cc60734cc36a5
function_name	Cloud Function Name	test-function
integration_type	Method Integration Type	HTTP
method_type	Method Type	GET
query_strings	Method Query Strings	{‘param1’: ‘value1’, ‘param2’: ‘value2’}
request_headers	Method Request Headers	{’test1’ : True}
request_path	Method Request Path	{users}
srn	SRN	srn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test

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.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
method_type required	****	Method Type	`GET`
resource_id required	string	Resource ID	`27bb070b564349f8a31cc60734cc36a5`
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`

Responses

Name	Description	Example
endpoint_url	Method Endpoint URL	https://127.0.0.1:8000
function_id	Cloud Function ID	27bb070b564349f8a31cc60734cc36a5
integration_type	Method Integration Type	HTTP
method_type	Method Type	GET
query_strings	Method Query Strings	{‘param1’: ‘value1’, ‘param2’: ‘value2’}
request_headers	Method Request Headers	{’test1’ : True}
request_path	Method Request Path	{users}
srn	SRN	srn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test

51 - Show PrivateLink Endpoint

51.1 - 1.3

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

Description

Show PrivateLink Endpoint

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
privatelink_endpoint_id required	string	PrivateLink Endpoint ID	`27bb070b564349f8a31cc60734cc36a5`

Responses

Name	Description	Example
id	PrivateLink Endpoint ID	27bb070b564349f8a31cc60734cc36a5
created_at	Creation Date	2024-05-17T00:23:17Z
description	Description	description
name	PrivateLink Endpoint Name	endpoint
privatelink_service_id	PrivateLink Service ID	27bb070b564349f8a31cc60734cc36a5
status	PrivateLink Endpoint Status	CANCELED

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.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
privatelink_endpoint_id required	string	PrivateLink Endpoint ID	`27bb070b564349f8a31cc60734cc36a5`

Responses

Name	Description	Example
id	PrivateLink Endpoint ID	27bb070b564349f8a31cc60734cc36a5
created_at	Creation Date	2024-05-17T00:23:17Z
description	Description	description
name	PrivateLink Endpoint Name	endpoint
privatelink_service_id	PrivateLink Service ID	27bb070b564349f8a31cc60734cc36a5
status	PrivateLink Endpoint Status	CANCELED

52 - Show Resource

52.1 - 1.3

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

Description

Show resource

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
resource_id required	string	Resource ID	`27bb070b564349f8a31cc60734cc36a5`
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`

Responses

Name	Description	Example
id	Resource ID	27bb070b564349f8a31cc60734cc36a5
methods
parent_id	Parent Resource ID	27bb070b564349f8a31cc60734cc36a5
path	Path	/test/test1
path_part	Path Part	test

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.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
resource_id required	string	Resource ID	`27bb070b564349f8a31cc60734cc36a5`
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`

Responses

Name	Description	Example
id	Resource ID	27bb070b564349f8a31cc60734cc36a5
methods
parent_id	Parent Resource ID	27bb070b564349f8a31cc60734cc36a5
path	Path	/test/test1
path_part	Path Part	test

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.

Version	Not Before
1.1	20260430

Parameters

Name	Type	Description	Example
resource_id required	string	Resource ID	`27bb070b564349f8a31cc60734cc36a5`
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`

Responses

Name	Description	Example
id	Resource ID	27bb070b564349f8a31cc60734cc36a5
methods
parent_id	Parent Resource ID	27bb070b564349f8a31cc60734cc36a5
path	Path	/test/test1
path_part	Path Part	test

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.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
resource_id required	string	Resource ID	`27bb070b564349f8a31cc60734cc36a5`
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`

Responses

Name	Description	Example
id	Resource ID	27bb070b564349f8a31cc60734cc36a5
methods
parent_id	Parent Resource ID	27bb070b564349f8a31cc60734cc36a5
path	Path	/test/test1
path_part	Path Part	test

53 - Show Resource Policy

53.1 - 1.3

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

Description

Show Resource Policy

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`

Responses

Name	Description	Example
policy_document	Policy 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’}

54 - Show Stage

54.1 - 1.3

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

Description

Show stage

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`
stage_name required	string	Stage Name	`test-stage`

Responses

Name	Description	Example
active_deployment	Active Deployment	2024-05-17T00:23:17Z
allow_credentials	Allow Credentials	True
allow_headers	Allow Headers	[‘Content-Type’, ‘Authorization’]
allow_methods	Allow Methods	[‘GET’, ‘POST’, ‘PUT’, ‘PATCH’]
allow_origins	Allow Origins	[’*’]
api_id	Api ID	27bb070b564349f8a31cc60734cc36a5
cors_enabled	Cors Enabled	False
created_at	Creation Date
deployment_id	Deployment ID	27bb070b564349f8a31cc60734cc36a5
description	Description	description
expose_headers	Expose Headers	[’test1’, ’test2’]
invoke_url	Invoke URL	http://test.com/stg
jwt_enabled	JWT Enabled	False
max_age	Max Age	3600
name	Stage Name	test-stage
usage_plan_api_keys	API Keys	[]
usage_plan_id	Usage Plan ID	27bb070b564349f8a31cc60734cc36a5
usage_plan_limit	Usage Plan Limit	10
usage_plan_name	Name	usage-plan-name
usage_plan_rate	Usage Plan Rate	day

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.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`
stage_name required	string	Stage Name	`test-stage`

Responses

Name	Description	Example
active_deployment	Active Deployment	2024-05-17T00:23:17Z
allow_credentials	Allow Credentials	True
allow_headers	Allow Headers	[‘Content-Type’, ‘Authorization’]
allow_methods	Allow Methods	[‘GET’, ‘POST’, ‘PUT’, ‘PATCH’]
allow_origins	Allow Origins	[’*’]
api_id	Api ID	27bb070b564349f8a31cc60734cc36a5
api_key_required	Api Key Required	False
cors_enabled	Cors Enabled	False
created_at	Creation Date
deployment_id	Deployment ID	27bb070b564349f8a31cc60734cc36a5
description	Description	description
expose_headers	Expose Headers	[’test1’, ’test2’]
invoke_url	Invoke URL	http://test.com/stg
jwt_enabled	JWT Enabled	False
max_age	Max Age	3600
name	Stage Name	test-stage
usage_plan_api_keys	API Keys	[]
usage_plan_id	Usage Plan ID	27bb070b564349f8a31cc60734cc36a5
usage_plan_limit	Usage Plan Limit	10
usage_plan_name	Name	usage-plan-name
usage_plan_rate	Usage Plan Rate	day

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.

Version	Not Before
1.1	20260430

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`
stage_name required	string	Stage Name	`test-stage`

Responses

Name	Description	Example
active_deployment	Active Deployment	2024-05-17T00:23:17Z
allow_credentials	Allow Credentials	True
allow_headers	Allow Headers	[‘Content-Type’, ‘Authorization’]
allow_methods	Allow Methods	[‘GET’, ‘POST’, ‘PUT’, ‘PATCH’]
allow_origins	Allow Origins	[’*’]
api_id	Api ID	27bb070b564349f8a31cc60734cc36a5
api_key_required	Api Key Required	False
cors_enabled	Cors Enabled	False
created_at	Creation Date
deployment_id	Deployment ID	27bb070b564349f8a31cc60734cc36a5
description	Description	description
expose_headers	Expose Headers	[’test1’, ’test2’]
invoke_url	Invoke URL	http://test.com/stg
jwt_enabled	JWT Enabled	False
max_age	Max Age	3600
name	Stage Name	test-stage
usage_plan_api_keys	API Keys	[]
usage_plan_id	Usage Plan ID	27bb070b564349f8a31cc60734cc36a5
usage_plan_limit	Usage Plan Limit	10
usage_plan_name	Name	usage-plan-name
usage_plan_rate	Usage Plan Rate	day

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.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`
stage_name required	string	Stage Name	`test-stage`

Responses

Name	Description	Example
active_deployment	Active Deployment	2024-05-17T00:23:17Z
allow_credentials	Allow Credentials	True
allow_headers	Allow Headers	[‘Content-Type’, ‘Authorization’]
allow_methods	Allow Methods	[‘GET’, ‘POST’, ‘PUT’, ‘PATCH’]
allow_origins	Allow Origins	[’*’]
api_id	Api ID	27bb070b564349f8a31cc60734cc36a5
cors_enabled	Cors Enabled	False
created_at	Creation Date
deployment_id	Deployment ID	27bb070b564349f8a31cc60734cc36a5
expose_headers	Expose Headers	[’test1’, ’test2’]
invoke_url	Invoke URL	http://test.com/stg
ip_restriction_enabled	IP Restriction Enabled	False
jwt_enabled	JWT Enabled	False
max_age	Max Age	3600
name	Stage Name	test-stage

55 - Show Usage Plan

55.1 - 1.3

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

Description

Show usage plan

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
usage_plan_id required	string	Usage Plan ID	`27bb070b564349f8a31cc60734cc36a5`
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`

Responses

Name	Description	Example
id	Usage Plan ID	27bb070b564349f8a31cc60734cc36a5
api_keys	API Keys	[]
created_at	Creation Date
created_by_id	Created by	27bb070b564349f8a31cc60734cc36a5
created_by_name	Created by	username
description	Description	description
limit	Usage Plan Limit	10
modified_at	Modified at
modified_by_id	Modified by	27bb070b564349f8a31cc60734cc36a5
modified_by_name	Modified by	username
name	Name	usage-plan-name
rate	Usage Plan Rate	day

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.

Version	Not Before
1.2	20260630

Parameters

Name	Type	Description	Example
usage_plan_id required	string	Usage Plan ID	`27bb070b564349f8a31cc60734cc36a5`
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`

Responses

Name	Description	Example
id	Usage Plan ID	27bb070b564349f8a31cc60734cc36a5
api_keys	API Keys	[]
created_at	Creation Date
created_by_id	Created by	27bb070b564349f8a31cc60734cc36a5
created_by_name	Created by	username
description	Description	description
limit	Usage Plan Limit	10
modified_at	Modified at
modified_by_id	Modified by	27bb070b564349f8a31cc60734cc36a5
modified_by_name	Modified by	username
name	Name	usage-plan-name
rate	Usage Plan Rate	day

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.

Version	Not Before
1.1	20260430

Parameters

Name	Type	Description	Example
usage_plan_id required	string	Usage Plan ID	`27bb070b564349f8a31cc60734cc36a5`
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`

Responses

Name	Description	Example
id	Usage Plan ID	27bb070b564349f8a31cc60734cc36a5
api_keys	API Keys	[]
created_at	Creation Date
created_by_id	Created by	27bb070b564349f8a31cc60734cc36a5
created_by_name	Created by	username
description	Description	description
limit	Usage Plan Limit	10
modified_at	Modified at
modified_by_id	Modified by	27bb070b564349f8a31cc60734cc36a5
modified_by_name	Modified by	username
name	Name	usage-plan-name
rate	Usage Plan Rate	day