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

Return to the regular view of this page.

Application Service

1: API Gateway

1.1: CLIs

1.1.1: Approve PrivateLink Endpoint

1.1.1.1: 1.2

1.1.2: Connect PrivateLink Endpoint

1.1.2.1: 1.2

1.1.3: Create AccessControl

1.1.3.1: 1.2
1.1.3.2: 1.1
1.1.3.3: 1.0

1.1.4: Create Api

1.1.4.1: 1.2
1.1.4.2: 1.1
1.1.4.3: 1.0

1.1.5: Create Api Deployment

1.1.5.1: 1.2
1.1.5.2: 1.1
1.1.5.3: 1.0

1.1.6: Create Api Key

1.1.6.1: 1.2
1.1.6.2: 1.1

1.1.7: Create Auth

1.1.7.1: 1.2
1.1.7.2: 1.1
1.1.7.3: 1.0

1.1.8: Create Method

1.1.8.1: 1.2
1.1.8.2: 1.1
1.1.8.3: 1.0

1.1.9: Create PrivateLink Endpoint

1.1.9.1: 1.2

1.1.10: Create Resource

1.1.10.1: 1.2
1.1.10.2: 1.1
1.1.10.3: 1.0

1.1.11: Create Stage

1.1.11.1: 1.2
1.1.11.2: 1.1
1.1.11.3: 1.0

1.1.12: Create Usage Plans

1.1.12.1: 1.2
1.1.12.2: 1.1

1.1.13: Delete Access Control

1.1.13.1: 1.2
1.1.13.2: 1.1
1.1.13.3: 1.0

1.1.14: Delete an API Key

1.1.14.1: 1.2
1.1.14.2: 1.1

1.1.15: Delete Api

1.1.15.1: 1.2
1.1.15.2: 1.1
1.1.15.3: 1.0

1.1.16: Delete Auth

1.1.16.1: 1.2
1.1.16.2: 1.1
1.1.16.3: 1.0

1.1.17: Delete Method

1.1.17.1: 1.2
1.1.17.2: 1.1
1.1.17.3: 1.0

1.1.18: Delete PrivateLink Endpoint

1.1.18.1: 1.2

1.1.19: Delete Resource

1.1.19.1: 1.2
1.1.19.2: 1.1
1.1.19.3: 1.0

1.1.20: Delete Stage

1.1.20.1: 1.2
1.1.20.2: 1.1
1.1.20.3: 1.0

1.1.21: Delete Usage Plan

1.1.21.1: 1.2
1.1.21.2: 1.1

1.1.22: List AccessControls

1.1.22.1: 1.2
1.1.22.2: 1.1
1.1.22.3: 1.0

1.1.23: List Api Deployments

1.1.23.1: 1.2
1.1.23.2: 1.1
1.1.23.3: 1.0

1.1.24: List Api Keys

1.1.24.1: 1.2
1.1.24.2: 1.1

1.1.25: List Apis

1.1.25.1: 1.2
1.1.25.2: 1.1
1.1.25.3: 1.0

1.1.26: List Auths

1.1.26.1: 1.2
1.1.26.2: 1.1
1.1.26.3: 1.0

1.1.27: List Connected PrivateLink Endpoints

1.1.27.1: 1.2

1.1.28: List Methods

1.1.28.1: 1.2
1.1.28.2: 1.1
1.1.28.3: 1.0

1.1.29: List PrivateLink Endpoints

1.1.29.1: 1.2

1.1.30: List Reports

1.1.30.1: 1.2
1.1.30.2: 1.1

1.1.31: List Resources

1.1.31.1: 1.2
1.1.31.2: 1.1
1.1.31.3: 1.0

1.1.32: List Stages

1.1.32.1: 1.2
1.1.32.2: 1.1
1.1.32.3: 1.0

1.1.33: List Usage Plans

1.1.33.1: 1.2
1.1.33.2: 1.1

1.1.34: Request PrivateLink Endpoint

1.1.34.1: 1.2

1.1.35: Set Access Control

1.1.35.1: 1.2
1.1.35.2: 1.1
1.1.35.3: 1.0

1.1.36: Set Api Description

1.1.36.1: 1.2
1.1.36.2: 1.1
1.1.36.3: 1.0

1.1.37: Set API Key Description

1.1.37.1: 1.2
1.1.37.2: 1.1

1.1.38: Set Auth

1.1.38.1: 1.2
1.1.38.2: 1.1
1.1.38.3: 1.0

1.1.39: Set Method

1.1.39.1: 1.2
1.1.39.2: 1.1
1.1.39.3: 1.0

1.1.40: Set PrivateLink Endpoint

1.1.40.1: 1.2

1.1.41: Set Stage Active Deployment

1.1.41.1: 1.2
1.1.41.2: 1.1
1.1.41.3: 1.0

1.1.42: Set Stage Configuration

1.1.42.1: 1.2
1.1.42.2: 1.1
1.1.42.3: 1.0

1.1.43: Set Usage Plan Description

1.1.43.1: 1.2
1.1.43.2: 1.1

1.1.44: Set Usage Plan Quota

1.1.44.1: 1.2
1.1.44.2: 1.1

1.1.45: Show Access Control

1.1.45.1: 1.2
1.1.45.2: 1.1
1.1.45.3: 1.0

1.1.46: Show Api

1.1.46.1: 1.2
1.1.46.2: 1.1
1.1.46.3: 1.0

1.1.47: Show Auth

1.1.47.1: 1.2
1.1.47.2: 1.1
1.1.47.3: 1.0

1.1.48: Show Method

1.1.48.1: 1.2
1.1.48.2: 1.1
1.1.48.3: 1.0

1.1.49: Show PrivateLink Endpoint

1.1.49.1: 1.2

1.1.50: Show Resource

1.1.50.1: 1.2
1.1.50.2: 1.1
1.1.50.3: 1.0

1.1.51: Show Stage

1.1.51.1: 1.2
1.1.51.2: 1.1
1.1.51.3: 1.0

1.1.52: Show Usage Plan

1.1.52.1: 1.2
1.1.52.2: 1.1

2: Queue Service

2.1: CLIs

2.1.1: Check Queue Name Duplication

2.1.1.1: 1.0

2.1.2: Create Queue

2.1.2.1: 1.0

2.1.3: Delete Acl

2.1.3.1: 1.0

2.1.4: Delete Queue

2.1.4.1: 1.0

2.1.5: List Queue

2.1.5.1: 1.0

2.1.6: Set Acl

2.1.6.1: 1.0

2.1.7: Show Queue

2.1.7.1: 1.0

2.1.8: Update Queue Config

2.1.8.1: 1.0

2.1.9: Update Queue Description

2.1.9.1: 1.0

1 - API Gateway

Overview

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

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

Version

Version	Status	Supported Until
1.0	DEPRECATED	20251231
1.1	DEPRECATED	20260430
1.2	CURRENT	-

1.1 - CLIs

1.1.1 - Approve PrivateLink Endpoint

1.1.1.1 - 1.2

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

Description

Approve PrivateLink Endpoint

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

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.1.2 - Connect PrivateLink Endpoint

1.1.2.1 - 1.2

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

Description

Connect PrivateLink Endpoint

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

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.1.3 - Create AccessControl

1.1.3.1 - 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 (CURRENT)

Version	Supported Until
1.2	-

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

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

Version	Supported Until
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

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

Version	Supported Until
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

1.1.4 - Create Api

1.1.4.1 - 1.2

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

Description

Create api

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

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

1.1.4.2 - 1.1

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

Description

Create api

State ACTIVE (DEPRECATED)

Version	Supported Until
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

1.1.4.3 - 1.0

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

Description

Create api

State ACTIVE (DEPRECATED)

Version	Supported Until
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

1.1.5 - Create Api Deployment

1.1.5.1 - 1.2

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

Description

Create api deployment

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

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

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

Version	Supported Until
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

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

Version	Supported Until
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

1.1.6 - Create Api Key

1.1.6.1 - 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 (CURRENT)

Version	Supported Until
1.2	-

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

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

Version	Supported Until
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

1.1.7 - Create Auth

1.1.7.1 - 1.2

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

Description

Create auth

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

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	***********************************************************

1.1.7.2 - 1.1

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

Description

Create auth

State ACTIVE (DEPRECATED)

Version	Supported Until
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	***********************************************************

1.1.7.3 - 1.0

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

Description

Create auth

State ACTIVE (DEPRECATED)

Version	Supported Until
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	***********************************************************

1.1.8 - Create Method

1.1.8.1 - 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>]
[--privatelink_endpoint_id <value>]
[--query_strings <value>]
[--request_headers <value>]

Description

Create method

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

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`
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

1.1.8.2 - 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>]
[--privatelink_endpoint_id <value>]
[--query_strings <value>]
[--request_headers <value>]

Description

Create method

State ACTIVE (DEPRECATED)

Version	Supported Until
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`
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

1.1.8.3 - 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>]
[--privatelink_endpoint_id <value>]
[--query_strings <value>]
[--request_headers <value>]

Description

Create method

State ACTIVE (DEPRECATED)

Version	Supported Until
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`
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

1.1.9 - Create PrivateLink Endpoint

1.1.9.1 - 1.2

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

Description

Create PrivateLink Endpoint

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

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

1.1.10 - Create Resource

1.1.10.1 - 1.2

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

Description

Create resource

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

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

1.1.10.2 - 1.1

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

Description

Create resource

State ACTIVE (DEPRECATED)

Version	Supported Until
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

1.1.10.3 - 1.0

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

Description

Create resource

State ACTIVE (DEPRECATED)

Version	Supported Until
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

1.1.11 - Create Stage

1.1.11.1 - 1.2

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

Description

Create stage

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

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

1.1.11.2 - 1.1

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

Description

Create stage

State ACTIVE (DEPRECATED)

Version	Supported Until
1.1	20260430

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`
stage_name required	string	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

1.1.11.3 - 1.0

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

Description

Create stage

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
api_id required	string	Api ID	`27bb070b564349f8a31cc60734cc36a5`
stage_name required	string	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

1.1.12 - Create Usage Plans

1.1.12.1 - 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 (CURRENT)

Version	Supported Until
1.2	-

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

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

Version	Supported Until
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

1.1.13 - Delete Access Control

1.1.13.1 - 1.2

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

Description

Delete access control

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

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

1.1.13.2 - 1.1

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

Description

Delete access control

State ACTIVE (DEPRECATED)

Version	Supported Until
1.1	20260430

Parameters

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

1.1.13.3 - 1.0

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

Description

Delete access control

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

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

1.1.14 - Delete an API Key

1.1.14.1 - 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 (CURRENT)

Version	Supported Until
1.2	-

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`

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

Version	Supported Until
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`

1.1.15 - Delete Api

1.1.15.1 - 1.2

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

Description

Delete api

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

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

1.1.15.2 - 1.1

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

Description

Delete api

State ACTIVE (DEPRECATED)

Version	Supported Until
1.1	20260430

Parameters

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

1.1.15.3 - 1.0

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

Description

Delete api

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

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

1.1.16 - Delete Auth

1.1.16.1 - 1.2

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

Description

Delete auth

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

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

1.1.16.2 - 1.1

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

Description

Delete auth

State ACTIVE (DEPRECATED)

Version	Supported Until
1.1	20260430

Parameters

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

1.1.16.3 - 1.0

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

Description

Delete auth

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

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

1.1.17 - Delete Method

1.1.17.1 - 1.2

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

Description

Delete method

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

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`

1.1.17.2 - 1.1

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

Description

Delete method

State ACTIVE (DEPRECATED)

Version	Supported Until
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`

1.1.17.3 - 1.0

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

Description

Delete method

State ACTIVE (DEPRECATED)

Version	Supported Until
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`

1.1.18 - Delete PrivateLink Endpoint

1.1.18.1 - 1.2

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

Description

Delete PrivateLink Endpoint

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

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

1.1.19 - Delete Resource

1.1.19.1 - 1.2

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

Description

Delete resource

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

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

1.1.19.2 - 1.1

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

Description

Delete resource

State ACTIVE (DEPRECATED)

Version	Supported Until
1.1	20260430

Parameters

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

1.1.19.3 - 1.0

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

Description

Delete resource

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

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

1.1.20 - Delete Stage

1.1.20.1 - 1.2

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

Description

Delete stage

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

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

1.1.20.2 - 1.1

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

Description

Delete stage

State ACTIVE (DEPRECATED)

Version	Supported Until
1.1	20260430

Parameters

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

1.1.20.3 - 1.0

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

Description

Delete stage

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

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

1.1.21 - Delete Usage Plan

1.1.21.1 - 1.2

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

Description

Delete usage plan

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

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

1.1.21.2 - 1.1

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

Description

Delete usage plan

State ACTIVE (DEPRECATED)

Version	Supported Until
1.1	20260430

Parameters

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

1.1.22 - List AccessControls

1.1.22.1 - 1.2

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

Description

Get access controls list

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

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

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

Version	Supported Until
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

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

Version	Supported Until
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

1.1.23 - List Api Deployments

1.1.23.1 - 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 (CURRENT)

Version	Supported Until
1.2	-

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

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

Version	Supported Until
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

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

Version	Supported Until
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

1.1.24 - List Api Keys

1.1.24.1 - 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 (CURRENT)

Version	Supported Until
1.2	-

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

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

Version	Supported Until
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

1.1.25 - List Apis

1.1.25.1 - 1.2

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

Description

Get apis list

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

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

1.1.25.2 - 1.1

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

Description

Get apis list

State ACTIVE (DEPRECATED)

Version	Supported Until
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

1.1.25.3 - 1.0

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

Description

Get apis list

State ACTIVE (DEPRECATED)

Version	Supported Until
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

1.1.26 - List Auths

1.1.26.1 - 1.2

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

Description

Get auths list

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

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

1.1.26.2 - 1.1

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

Description

Get auths list

State ACTIVE (DEPRECATED)

Version	Supported Until
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

1.1.26.3 - 1.0

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

Description

Get auths list

State ACTIVE (DEPRECATED)

Version	Supported Until
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

1.1.27 - List Connected PrivateLink Endpoints

1.1.27.1 - 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 (CURRENT)

Version	Supported Until
1.2	-

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

1.1.28 - List Methods

1.1.28.1 - 1.2

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

Description

Get methods list

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

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

1.1.28.2 - 1.1

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

Description

Get methods list

State ACTIVE (DEPRECATED)

Version	Supported Until
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

1.1.28.3 - 1.0

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

Description

Get methods list

State ACTIVE (DEPRECATED)

Version	Supported Until
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

1.1.29 - List PrivateLink Endpoints

1.1.29.1 - 1.2

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

Description

Get PrivateLink Endpoints list

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

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

1.1.30 - List Reports

1.1.30.1 - 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 (CURRENT)

Version	Supported Until
1.2	-

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

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

Version	Supported Until
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

1.1.31 - List Resources

1.1.31.1 - 1.2

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

Description

Get resources list

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

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

1.1.31.2 - 1.1

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

Description

Get resources list

State ACTIVE (DEPRECATED)

Version	Supported Until
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

1.1.31.3 - 1.0

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

Description

Get resources list

State ACTIVE (DEPRECATED)

Version	Supported Until
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

1.1.32 - List Stages

1.1.32.1 - 1.2

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

Description

Get stages list

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

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

1.1.32.2 - 1.1

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

Description

Get stages list

State ACTIVE (DEPRECATED)

Version	Supported Until
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

1.1.32.3 - 1.0

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

Description

Get stages list

State ACTIVE (DEPRECATED)

Version	Supported Until
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

1.1.33 - List Usage Plans

1.1.33.1 - 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 (CURRENT)

Version	Supported Until
1.2	-

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

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

Version	Supported Until
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

1.1.34 - Request PrivateLink Endpoint

1.1.34.1 - 1.2

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

Description

Request PrivateLink Endpoint

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

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

1.1.35 - Set Access Control

1.1.35.1 - 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 (CURRENT)

Version	Supported Until
1.2	-

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`

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

Version	Supported Until
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`

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

Version	Supported Until
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`

1.1.36 - Set Api Description

1.1.36.1 - 1.2

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

Description

Set api description

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

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

1.1.36.2 - 1.1

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

Description

Set api description

State ACTIVE (DEPRECATED)

Version	Supported Until
1.1	20260430

Parameters

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

1.1.36.3 - 1.0

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

Description

Set api description

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

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

1.1.37 - Set API Key Description

1.1.37.1 - 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 (CURRENT)

Version	Supported Until
1.2	-

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`

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

Version	Supported Until
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`

1.1.38 - Set Auth

1.1.38.1 - 1.2

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

Description

Set auth

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

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`

1.1.38.2 - 1.1

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

Description

Set auth

State ACTIVE (DEPRECATED)

Version	Supported Until
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`

1.1.38.3 - 1.0

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

Description

Set auth

State ACTIVE (DEPRECATED)

Version	Supported Until
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`

1.1.39 - Set Method

1.1.39.1 - 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 (CURRENT)

Version	Supported Until
1.2	-

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`

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

Version	Supported Until
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`

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

Version	Supported Until
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'}`

1.1.40 - Set PrivateLink Endpoint

1.1.40.1 - 1.2

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

Description

Set PrivateLink Endpoint

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

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

1.1.41 - Set Stage Active Deployment

1.1.41.1 - 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 (CURRENT)

Version	Supported Until
1.2	-

Parameters

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

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

Version	Supported Until
1.1	20260430

Parameters

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

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

Version	Supported Until
1.0	20251231

Parameters

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

1.1.42 - Set Stage Configuration

1.1.42.1 - 1.2

scpcli application-apigateway stage set configuration
--api_id <value>
--stage_name <value>
--jwt_enabled <value>
--cors_enabled <value>
[--allow_credentials <value>]
[--allow_headers <value>]
[--allow_methods <value>]
[--allow_origins <value>]
[--connected_api_keys <value>]
[--description <value>]
[--expose_headers <value>]
[--max_age <value>]
[--usage_plan_id <value>]

Description

Set stage configuration

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

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

1.1.42.2 - 1.1

scpcli application-apigateway stage set configuration
--api_id <value>
--stage_name <value>
--jwt_enabled <value>
--cors_enabled <value>
[--allow_credentials <value>]
[--allow_headers <value>]
[--allow_methods <value>]
[--allow_origins <value>]
[--connected_api_keys <value>]
[--description <value>]
[--expose_headers <value>]
[--max_age <value>]
[--usage_plan_id <value>]

Description

Set stage configuration

State ACTIVE (DEPRECATED)

Version	Supported Until
1.1	20260430

Parameters

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

1.1.42.3 - 1.0

scpcli application-apigateway stage set configuration
--api_id <value>
--stage_name <value>
--jwt_enabled <value>
--ip_restriction_enabled <value>
--cors_enabled <value>
[--allow_credentials <value>]
[--allow_headers <value>]
[--allow_methods <value>]
[--allow_origins <value>]
[--expose_headers <value>]
[--max_age <value>]

Description

Set stage configuration(Modifying ip_restriction_enabled is no longer supported)

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

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

1.1.43 - Set Usage Plan Description

1.1.43.1 - 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 (CURRENT)

Version	Supported Until
1.2	-

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`

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

Version	Supported Until
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`

1.1.44 - Set Usage Plan Quota

1.1.44.1 - 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 (CURRENT)

Version	Supported Until
1.2	-

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`

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

Version	Supported Until
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`

1.1.45 - Show Access Control

1.1.45.1 - 1.2

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

Description

Show access control

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

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

1.1.45.2 - 1.1

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

Description

Show access control

State ACTIVE (DEPRECATED)

Version	Supported Until
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

1.1.45.3 - 1.0

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

Description

Show access control

State ACTIVE (DEPRECATED)

Version	Supported Until
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

1.1.46 - Show Api

1.1.46.1 - 1.2

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

Description

Show api

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

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

1.1.46.2 - 1.1

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

Description

Show api

State ACTIVE (DEPRECATED)

Version	Supported Until
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

1.1.46.3 - 1.0

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

Description

Show api

State ACTIVE (DEPRECATED)

Version	Supported Until
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

1.1.47 - Show Auth

1.1.47.1 - 1.2

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

Description

Show auth

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

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

1.1.47.2 - 1.1

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

Description

Show auth

State ACTIVE (DEPRECATED)

Version	Supported Until
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

1.1.47.3 - 1.0

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

Description

Show auth

State ACTIVE (DEPRECATED)

Version	Supported Until
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

1.1.48 - Show Method

1.1.48.1 - 1.2

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

Description

Show method

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

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

1.1.48.2 - 1.1

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

Description

Show method

State ACTIVE (DEPRECATED)

Version	Supported Until
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

1.1.48.3 - 1.0

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

Description

Show method

State ACTIVE (DEPRECATED)

Version	Supported Until
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

1.1.49 - Show PrivateLink Endpoint

1.1.49.1 - 1.2

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

Description

Show PrivateLink Endpoint

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

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

1.1.50 - Show Resource

1.1.50.1 - 1.2

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

Description

Show resource

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

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

1.1.50.2 - 1.1

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

Description

Show resource

State ACTIVE (DEPRECATED)

Version	Supported Until
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

1.1.50.3 - 1.0

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

Description

Show resource

State ACTIVE (DEPRECATED)

Version	Supported Until
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

1.1.51 - Show Stage

1.1.51.1 - 1.2

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

Description

Show stage

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

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

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

1.1.51.2 - 1.1

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

Description

Show stage

State ACTIVE (DEPRECATED)

Version	Supported Until
1.1	20260430

Parameters

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

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

1.1.51.3 - 1.0

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

Description

Show stage

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

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

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

1.1.52 - Show Usage Plan

1.1.52.1 - 1.2

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

Description

Show usage plan

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

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

1.1.52.2 - 1.1

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

Description

Show usage plan

State ACTIVE (DEPRECATED)

Version	Supported Until
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

2 - Queue Service

Overview

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

This guide provides a brief description of Queue Service service and how to call CLI.

Version

Version	Status	Supported Until
1.0	CURRENT	-

2.1 - CLIs

2.1.1 - Check Queue Name Duplication

2.1.1.1 - 1.0

scpcli queueservice check queue name duplication
--name <value>

Description

check queue name duplication

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

Parameters

Name	Type	Description	Example
name required	string	Queue name	`test-queue.fifo`

Responses

Name	Description	Example
result	Result	True

2.1.2 - Create Queue

2.1.2.1 - 1.0

scpcli queueservice queue create
--id <value>
--name <value>
--message_size <value>
--message_retention_period_unit <value>
--message_retention_period <value>
[--data_key_reuse_period <value>]
[--data_key_reuse_period_unit <value>]
[--description <value>]
[--tags <value>]

Description

create a queue

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

Parameters

Name	Type	Description	Example
id required	string	KMS ID	`8c9f6c1c928a45b4bbd1e4da5531d656`
name required	string	KMS name	`test-kms`
message_size required	integer	Message size	`256`
message_retention_period_unit required	string	Period unit	`minute`
message_retention_period required	integer	Message retention period	`40`
data_key_reuse_period optional	integer	Data key reuse period	`40`
data_key_reuse_period_unit optional	****	Period unit	`minute`
description optional	string	Description	`Queue description`
tags optional	array	Tag List	`'{"key": "key1", "value": "value1"}'`

Responses

Name	Description	Example
id	Queue ID	8c9f6c1c928a45b4bbd1e4da5531d656
messages	Description	Create Queue
state	Queue state	ACTIVE

2.1.3 - Delete Acl

2.1.3.1 - 1.0

scpcli queueservice queue delete acl
--queue_id <value>
--ip_address <value>

Description

delete an acl policy

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

Parameters

Name	Type	Description	Example
queue_id required	string	Queue ID	`8c9f6c1c928a45b4bbd1e4da5531d656`
ip_address required	array	Access Allowed IP List	`0.0.0.0`

2.1.4 - Delete Queue

2.1.4.1 - 1.0

scpcli queueservice queue delete
--queue_id <value>

Description

delete a specific queue

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

Parameters

Name	Type	Description	Example
queue_id required	string	Queue ID	`8c9f6c1c928a45b4bbd1e4da5531d656`

2.1.5 - List Queue

2.1.5.1 - 1.0

scpcli queueservice queue list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]

Description

list queue

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

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	Queue name	`test-queue.fifo`

Responses

Name	Description	Example
id	Queue ID	8c9f6c1c928a45b4bbd1e4da5531d656
account_id	Account ID	8c9f6c1c928a45b4bbd1e4da5531d656
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
encryption	Encryption
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Queue name	test-queue.fifo
number_wait_messages	Number of waiting messages	10
state	Queue state	ACTIVE
type	Queue Type	FIFO

2.1.6 - Set Acl

2.1.6.1 - 1.0

scpcli queueservice queue set acl
--queue_id <value>
--ip_address <value>

Description

update an acl policy

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

Parameters

Name	Type	Description	Example
queue_id required	string	Queue ID	`8c9f6c1c928a45b4bbd1e4da5531d656`
ip_address required	array	Access Allowed IP List	`0.0.0.0`

Responses

Name	Description	Example
id	Queue ID	8c9f6c1c928a45b4bbd1e4da5531d656

2.1.7 - Show Queue

2.1.7.1 - 1.0

scpcli queueservice queue show
--queue_id <value>

Description

show a specific queue

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

Parameters

Name	Type	Description	Example
queue_id required	string	Queue ID	`8c9f6c1c928a45b4bbd1e4da5531d656`

Responses

Name	Description	Example
ip_address	IP address	192.168.0.0

2.1.8 - Update Queue Config

2.1.8.1 - 1.0

scpcli queueservice queue set config
--queue_id <value>
--name <value>
--id <value>
--message_size <value>
--message_retention_period_unit <value>
--message_retention_period <value>
[--data_key_reuse_period <value>]
[--data_key_reuse_period_unit <value>]

Description

update queue config

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

Parameters

Name	Type	Description	Example
queue_id required	string	Queue ID	`8c9f6c1c928a45b4bbd1e4da5531d656`
name required	string	KMS name	`test-kms`
id required	string	KMS ID	`8c9f6c1c928a45b4bbd1e4da5531d656`
message_size required	integer	Message size	`256`
message_retention_period_unit required	string	Period unit	`minute`
message_retention_period required	integer	Message retention period	`40`
data_key_reuse_period optional	integer	Data key reuse period	`40`
data_key_reuse_period_unit optional	****	Period unit	`minute`

2.1.9 - Update Queue Description

2.1.9.1 - 1.0

scpcli queueservice queue set description
--queue_id <value>
--description <value>

Description

update queue description

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

Parameters

Name	Type	Description	Example
queue_id required	string	Queue ID	`8c9f6c1c928a45b4bbd1e4da5531d656`
description required	string	Description	`Queue description`