This guide provides a brief description of API Gateway service and how to call API. The API is provided as a RESTful API, and it responds in JSON format.

Version

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

OpenAPI URL

https://apigateway.{region}.{environment}.samsungsdscloud.com

Environment and Region List

environment	region
s	kr-west1
s	kr-east1
g	kr-south1
g	kr-south2
g	kr-south3
e	kr-west1
e	kr-east1

1.1 - APIs

1.1.1 - Approve PrivateLink Endpoint

1.1.1.1 - 1.2

put /v1/privatelink-endpoints/{privatelink_endpoint_id}/approval

Description

Approve PrivateLink Endpoint

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	privatelink_endpoint_id required	PrivateLink Endpoint ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
body	body required		PrivateLinkEndpointApprovalRequest

Responses

HTTP Code	Description	Schema
200	OK	PrivateLinkEndpointSummaryShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/privatelink-endpoints/{privatelink_endpoint_id}/approval

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.2"

Request body

{
    "api_id": "27bb070b564349f8a31cc60734cc36a5",
    "type": "CANCEL"
}

Example HTTP response

Response 200

{
    "privatelink_endpoint": {
        "created_at": "2024-05-17T00:23:17Z",
        "id": "27bb070b564349f8a31cc60734cc36a5",
        "status": "Active"
    }
}

1.1.2 - Connect PrivateLink Endpoint

1.1.2.1 - 1.2

put /v1/privatelink-endpoints/{privatelink_endpoint_id}/connection

Description

Connect PrivateLink Endpoint

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	privatelink_endpoint_id required	PrivateLink Endpoint ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
body	body required		PrivateLinkEndpointConnectionRequest

Responses

HTTP Code	Description	Schema
200	OK	PrivateLinkEndpointSummaryShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/privatelink-endpoints/{privatelink_endpoint_id}/connection

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.2"

Request body

{
    "api_id": "27bb070b564349f8a31cc60734cc36a5",
    "type": "CANCEL"
}

Example HTTP response

Response 200

{
    "privatelink_endpoint": {
        "created_at": "2024-05-17T00:23:17Z",
        "id": "27bb070b564349f8a31cc60734cc36a5",
        "status": "Active"
    }
}

1.1.3 - Create AccessControl

1.1.3.1 - 1.2

post /v1/apis/{api_id}/access-controls

Description

Create access control

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example :	string	None
body	body required		AccessControlCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	AccessControlCreateResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/access-controls

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.2"

Request body

{
    "allowed_ip_addr": [
        "127.0.0.1/24,192.168.127.12"
    ],
    "connected_stages": [
        "dev,stg"
    ],
    "description": "description",
    "name": "DenyTest"
}

Example HTTP response

Response 201

{
    "allowed_ip_addr": [
        "127.0.0.1/24,192.168.127.12"
    ],
    "connected_stages": [
        "dev,stg"
    ],
    "created_at": "2024-05-19T00:23:17Z",
    "description": "",
    "id": "27bb070b564349f8a31cc60734cc36a5",
    "name": "DenyTest"
}

1.1.3.2 - 1.1

post /v1/apis/{api_id}/access-controls

Description

Create access control

State ACTIVE (DEPRECATED)

Version	Supported Until
1.1	20260430

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example :	string	None
body	body required		AccessControlCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	AccessControlCreateResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/access-controls

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.1"

Request body

{
    "allowed_ip_addr": [
        "127.0.0.1/24,192.168.127.12"
    ],
    "connected_stages": [
        "dev,stg"
    ],
    "description": "description",
    "name": "DenyTest"
}

Example HTTP response

Response 201

{
    "allowed_ip_addr": [
        "127.0.0.1/24,192.168.127.12"
    ],
    "connected_stages": [
        "dev,stg"
    ],
    "created_at": "2024-05-19T00:23:17Z",
    "description": "",
    "id": "27bb070b564349f8a31cc60734cc36a5",
    "name": "DenyTest"
}

1.1.3.3 - 1.0

post /v1/apis/{api_id}/access-controls

Description

Create access control

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example :	string	None
body	body required		AccessControlCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	AccessControlCreateResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/access-controls

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.0"

Request body

{
    "allowed_ip_addr": [
        "127.0.0.1/24,192.168.127.12"
    ],
    "connected_stages": [
        "dev,stg"
    ],
    "description": "description",
    "name": "DenyTest"
}

Example HTTP response

Response 201

{
    "allowed_ip_addr": [
        "127.0.0.1/24,192.168.127.12"
    ],
    "connected_stages": [
        "dev,stg"
    ],
    "created_at": "2024-05-19T00:23:17Z",
    "description": "",
    "id": "27bb070b564349f8a31cc60734cc36a5",
    "name": "DenyTest"
}

1.1.4 - Create Api

1.1.4.1 - 1.2

post /v1/apis

Description

Create api

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

Type	Name	Description	Schema	Default
body	body required		ApiCreateRequestV1Dot2

Responses

HTTP Code	Description	Schema
202	Accepted	ApiCreateResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.2"

Request body

{
    "description": "description",
    "endpoint_type": "REGION",
    "id": "",
    "name": "test-api",
    "tags": [
        {
            "key": "key",
            "value": "value"
        }
    ]
}

Example HTTP response

Response 202

{
    "description": "Description",
    "id": "27bb070b564349f8a31cc60734cc36a5",
    "name": "test-api"
}

1.1.4.2 - 1.1

post /v1/apis

Description

Create api

State ACTIVE (DEPRECATED)

Version	Supported Until
1.1	20260430

Parameters

Type	Name	Description	Schema	Default
body	body required		ApiCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	ApiCreateResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.1"

Request body

{
    "description": "description",
    "id": "",
    "name": "test-api",
    "tags": [
        {
            "key": "key",
            "value": "value"
        }
    ]
}

Example HTTP response

Response 202

{
    "description": "Description",
    "id": "27bb070b564349f8a31cc60734cc36a5",
    "name": "test-api"
}

1.1.4.3 - 1.0

post /v1/apis

Description

Create api

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
body	body required		ApiCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	ApiCreateResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.0"

Request body

{
    "description": "description",
    "id": "",
    "name": "test-api",
    "tags": [
        {
            "key": "key",
            "value": "value"
        }
    ]
}

Example HTTP response

Response 202

{
    "description": "Description",
    "id": "27bb070b564349f8a31cc60734cc36a5",
    "name": "test-api"
}

1.1.5 - Create Api Deployment

1.1.5.1 - 1.2

post /v1/apis/{api_id}/deployments

Description

Create api deployment

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `31e749b7b260868f441e862b`	string	None
body	body required		ApiDeploymentRequest

Responses

HTTP Code	Description	Schema
200	OK	ApiDeploymentResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/deployments

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.2"

Request body

{
    "description": "description",
    "stage_name": "test-stage",
    "stage_type": "new"
}

Example HTTP response

Response 200

{
    "deployment_id": "27bb070b564349f8a31cc60734cc36a5",
    "description": "description"
}

1.1.5.2 - 1.1

post /v1/apis/{api_id}/deployments

Description

Create api deployment

State ACTIVE (DEPRECATED)

Version	Supported Until
1.1	20260430

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `31e749b7b260868f441e862b`	string	None
body	body required		ApiDeploymentRequest

Responses

HTTP Code	Description	Schema
200	OK	ApiDeploymentResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/deployments

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.1"

Request body

{
    "description": "description",
    "stage_name": "test-stage",
    "stage_type": "new"
}

Example HTTP response

Response 200

{
    "deployment_id": "27bb070b564349f8a31cc60734cc36a5",
    "description": "description"
}

1.1.5.3 - 1.0

post /v1/apis/{api_id}/deployments

Description

Create api deployment

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `31e749b7b260868f441e862b`	string	None
body	body required		ApiDeploymentRequest

Responses

HTTP Code	Description	Schema
200	OK	ApiDeploymentResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/deployments

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.0"

Request body

{
    "description": "description",
    "stage_name": "test-stage",
    "stage_type": "new"
}

Example HTTP response

Response 200

{
    "deployment_id": "27bb070b564349f8a31cc60734cc36a5",
    "description": "description"
}

1.1.6 - Create Api Key

1.1.6.1 - 1.2

post /v1/apis/{api_id}/usage-plans/{usage_plan_id}/api-keys

Description

Create api key

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	usage_plan_id required	Usage Plan ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
body	body required		ApiKeyCreateRequest

Responses

HTTP Code	Description	Schema
200	OK	ApiKeyShowResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/apis/{api_id}/usage-plans/{usage_plan_id}/api-keys

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.2"

Request body

{
    "description": "description",
    "name": "api-key-name"
}

Example HTTP response

Response 200

{
    "api_key": {
        "created_at": "2026-02-11T06:40:17.569Z",
        "description": "description",
        "id": "27bb070b564349f8a31cc60734cc36a5",
        "key": "key",
        "name": "api-key-name"
    }
}

1.1.6.2 - 1.1

post /v1/apis/{api_id}/usage-plans/{usage_plan_id}/api-keys

Description

Create api key

State ACTIVE (DEPRECATED)

Version	Supported Until
1.1	20260430

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	usage_plan_id required	Usage Plan ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
body	body required		ApiKeyCreateRequest

Responses

HTTP Code	Description	Schema
200	OK	ApiKeyShowResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/apis/{api_id}/usage-plans/{usage_plan_id}/api-keys

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.1"

Request body

{
    "description": "description",
    "name": "api-key-name"
}

Example HTTP response

Response 200

{
    "api_key": {
        "created_at": "2026-02-11T06:40:16.536Z",
        "description": "description",
        "id": "27bb070b564349f8a31cc60734cc36a5",
        "key": "key",
        "name": "api-key-name"
    }
}

1.1.7 - Create Auth

1.1.7.1 - 1.2

post /v1/apis/{api_id}/auths

Description

Create auth

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example :	string	None
body	body required		AuthCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	AuthCreateResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/auths

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.2"

Request body

{
    "connected_stages": [
        "dev,stg"
    ],
    "expiration_period": "90",
    "name": "Token01"
}

Example HTTP response

Response 201

{
    "access_token": "***********************************************************"
}

1.1.7.2 - 1.1

post /v1/apis/{api_id}/auths

Description

Create auth

State ACTIVE (DEPRECATED)

Version	Supported Until
1.1	20260430

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example :	string	None
body	body required		AuthCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	AuthCreateResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/auths

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.1"

Request body

{
    "connected_stages": [
        "dev,stg"
    ],
    "expiration_period": "90",
    "name": "Token01"
}

Example HTTP response

Response 201

{
    "access_token": "***********************************************************"
}

1.1.7.3 - 1.0

post /v1/apis/{api_id}/auths

Description

Create auth

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example :	string	None
body	body required		AuthCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	AuthCreateResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/auths

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.0"

Request body

{
    "connected_stages": [
        "dev,stg"
    ],
    "expiration_period": "90",
    "name": "Token01"
}

Example HTTP response

Response 201

{
    "access_token": "***********************************************************"
}

1.1.8 - Create Method

1.1.8.1 - 1.2

post /v1/apis/{api_id}/resources/{resource_id}/methods

Description

Create method

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	resource_id required	Resource ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
body	body required		MethodCreateRequestV1Dot1

Responses

HTTP Code	Description	Schema
200	OK	MethodListResponseV1Dot2
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/resources/{resource_id}/methods

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.2"

Request body

{
    "api_key_required": false,
    "endpoint_url": "https://127.0.0.1:8000",
    "function_id": "27bb070b564349f8a31cc60734cc36a5",
    "integration_type": "HTTP",
    "method_type": "GET",
    "privatelink_endpoint_id": "27bb070b564349f8a31cc60734cc36a5",
    "query_strings": "{'param1': 'value1', 'param2': 'value2'}",
    "request_headers": "{'test1' : True}"
}

Example HTTP response

Response 200

{
    "methods": [
        {
            "api_key_required": false,
            "endpoint_url": "https://127.0.0.1:8000",
            "function_id": "27bb070b564349f8a31cc60734cc36a5",
            "function_name": "test-function",
            "integration_type": "HTTP",
            "method_type": "GET",
            "privatelink_endpoint_id": "27bb070b564349f8a31cc60734cc36a5",
            "query_strings": "{'param1': 'value1', 'param2': 'value2'}",
            "request_headers": "{'test1' : True}",
            "request_path": "{users}",
            "srn": "srn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test"
        }
    ]
}

1.1.8.2 - 1.1

post /v1/apis/{api_id}/resources/{resource_id}/methods

Description

Create method

State ACTIVE (DEPRECATED)

Version	Supported Until
1.1	20260430

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	resource_id required	Resource ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
body	body required		MethodCreateRequestV1Dot1

Responses

HTTP Code	Description	Schema
200	OK	MethodListResponseV1Dot1
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/resources/{resource_id}/methods

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.1"

Request body

{
    "api_key_required": false,
    "endpoint_url": "https://127.0.0.1:8000",
    "function_id": "27bb070b564349f8a31cc60734cc36a5",
    "integration_type": "HTTP",
    "method_type": "GET",
    "privatelink_endpoint_id": "27bb070b564349f8a31cc60734cc36a5",
    "query_strings": "{'param1': 'value1', 'param2': 'value2'}",
    "request_headers": "{'test1' : True}"
}

Example HTTP response

Response 200

{
    "methods": [
        {
            "api_key_required": false,
            "endpoint_url": "https://127.0.0.1:8000",
            "function_id": "27bb070b564349f8a31cc60734cc36a5",
            "function_name": "test-function",
            "integration_type": "HTTP",
            "method_type": "GET",
            "query_strings": "{'param1': 'value1', 'param2': 'value2'}",
            "request_headers": "{'test1' : True}",
            "request_path": "{users}",
            "srn": "srn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test"
        }
    ]
}

1.1.8.3 - 1.0

post /v1/apis/{api_id}/resources/{resource_id}/methods

Description

Create method

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	resource_id required	Resource ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
body	body required		MethodCreateRequest

Responses

HTTP Code	Description	Schema
200	OK	MethodListResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/resources/{resource_id}/methods

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.0"

Request body

{
    "api_key_required": false,
    "endpoint_url": "https://127.0.0.1:8000",
    "function_id": "27bb070b564349f8a31cc60734cc36a5",
    "integration_type": "HTTP",
    "method_type": "GET",
    "privatelink_endpoint_id": "27bb070b564349f8a31cc60734cc36a5",
    "query_strings": "{'param1': 'value1', 'param2': 'value2'}",
    "request_headers": "{'test1' : True}"
}

Example HTTP response

Response 200

{
    "methods": [
        {
            "endpoint_url": "https://127.0.0.1:8000",
            "function_id": "27bb070b564349f8a31cc60734cc36a5",
            "integration_type": "HTTP",
            "method_type": "GET",
            "query_strings": "{'param1': 'value1', 'param2': 'value2'}",
            "request_headers": "{'test1' : True}",
            "request_path": "{users}",
            "srn": "srn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test"
        }
    ]
}

1.1.9 - Create PrivateLink Endpoint

1.1.9.1 - 1.2

post /v1/privatelink-endpoints

Description

Create PrivateLink Endpoint

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

Type	Name	Description	Schema	Default
body	body required		PrivateLinkEndpointCreateRequest

Responses

HTTP Code	Description	Schema
200	OK	PrivateLinkEndpointShowResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/privatelink-endpoints

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.2"

Request body

{
    "description": "description",
    "name": "endpoint",
    "privatelink_service_id": "27bb070b564349f8a31cc60734cc36a5"
}

Example HTTP response

Response 200

{
    "privatelink_endpoint": {
        "created_at": "2024-05-17T00:23:17Z",
        "description": "description",
        "id": "27bb070b564349f8a31cc60734cc36a5",
        "name": "endpoint",
        "privatelink_service_id": "27bb070b564349f8a31cc60734cc36a5",
        "status": "CANCELED"
    }
}

1.1.10 - Create Resource

1.1.10.1 - 1.2

post /v1/apis/{api_id}/resources/{parent_id}

Description

Create resource

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	parent_id required	Resource ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
body	body required		ResourceCreateRequest

Responses

HTTP Code	Description	Schema
200	OK	ResourceCreateResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/resources/{parent_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.2"

Request body

{
    "path_part": "test"
}

Example HTTP response

Response 200

{
    "api_id": "27bb070b564349f8a31cc60734cc36a5",
    "id": "27bb070b564349f8a31cc60734cc36a5",
    "parent_id": "27bb070b564349f8a31cc60734cc36a5",
    "path": ""
}

1.1.10.2 - 1.1

post /v1/apis/{api_id}/resources/{parent_id}

Description

Create resource

State ACTIVE (DEPRECATED)

Version	Supported Until
1.1	20260430

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	parent_id required	Resource ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
body	body required		ResourceCreateRequest

Responses

HTTP Code	Description	Schema
200	OK	ResourceCreateResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/resources/{parent_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.1"

Request body

{
    "path_part": "test"
}

Example HTTP response

Response 200

{
    "api_id": "27bb070b564349f8a31cc60734cc36a5",
    "id": "27bb070b564349f8a31cc60734cc36a5",
    "parent_id": "27bb070b564349f8a31cc60734cc36a5",
    "path": ""
}

1.1.10.3 - 1.0

post /v1/apis/{api_id}/resources/{parent_id}

Description

Create resource

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	parent_id required	Resource ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
body	body required		ResourceCreateRequest

Responses

HTTP Code	Description	Schema
200	OK	ResourceCreateResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/resources/{parent_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.0"

Request body

{
    "path_part": "test"
}

Example HTTP response

Response 200

{
    "api_id": "27bb070b564349f8a31cc60734cc36a5",
    "id": "27bb070b564349f8a31cc60734cc36a5",
    "parent_id": "27bb070b564349f8a31cc60734cc36a5",
    "path": ""
}

1.1.11 - Create Stage

1.1.11.1 - 1.2

post /v1/apis/{api_id}/stages

Description

Create stage

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
body	body required		StageCreateRequest

Responses

HTTP Code	Description	Schema
200	OK	StageShowResponseV1Dot1
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/stages

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.2"

Request body

{
    "deployment_id": "27bb070b564349f8a31cc60734cc36a5",
    "description": "description",
    "stage_name": "test-stage"
}

Example HTTP response

Response 200

{
    "stage": {
        "active_deployment": "2024-05-17T00:23:17Z",
        "allow_credentials": true,
        "allow_headers": [
            "Content-Type",
            "Authorization"
        ],
        "allow_methods": [
            "GET",
            "POST",
            "PUT",
            "PATCH"
        ],
        "allow_origins": [
            "*"
        ],
        "api_id": "27bb070b564349f8a31cc60734cc36a5",
        "api_key_required": false,
        "cors_enabled": false,
        "created_at": "2026-02-11T06:40:17.380Z",
        "deployment_id": "27bb070b564349f8a31cc60734cc36a5",
        "description": "description",
        "expose_headers": [
            "test1",
            "test2"
        ],
        "invoke_url": "http://test.com/stg",
        "jwt_enabled": false,
        "max_age": 3600,
        "name": "test-stage",
        "usage_plan_api_keys": [],
        "usage_plan_id": "27bb070b564349f8a31cc60734cc36a5",
        "usage_plan_limit": 10,
        "usage_plan_name": "usage-plan-name",
        "usage_plan_rate": "day"
    }
}

1.1.11.2 - 1.1

post /v1/apis/{api_id}/stages

Description

Create stage

State ACTIVE (DEPRECATED)

Version	Supported Until
1.1	20260430

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
body	body required		StageCreateRequest

Responses

HTTP Code	Description	Schema
200	OK	StageShowResponseV1Dot1
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/stages

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.1"

Request body

{
    "deployment_id": "27bb070b564349f8a31cc60734cc36a5",
    "description": "description",
    "stage_name": "test-stage"
}

Example HTTP response

Response 200

{
    "stage": {
        "active_deployment": "2024-05-17T00:23:17Z",
        "allow_credentials": true,
        "allow_headers": [
            "Content-Type",
            "Authorization"
        ],
        "allow_methods": [
            "GET",
            "POST",
            "PUT",
            "PATCH"
        ],
        "allow_origins": [
            "*"
        ],
        "api_id": "27bb070b564349f8a31cc60734cc36a5",
        "api_key_required": false,
        "cors_enabled": false,
        "created_at": "2026-02-11T06:40:16.344Z",
        "deployment_id": "27bb070b564349f8a31cc60734cc36a5",
        "description": "description",
        "expose_headers": [
            "test1",
            "test2"
        ],
        "invoke_url": "http://test.com/stg",
        "jwt_enabled": false,
        "max_age": 3600,
        "name": "test-stage",
        "usage_plan_api_keys": [],
        "usage_plan_id": "27bb070b564349f8a31cc60734cc36a5",
        "usage_plan_limit": 10,
        "usage_plan_name": "usage-plan-name",
        "usage_plan_rate": "day"
    }
}

1.1.11.3 - 1.0

post /v1/apis/{api_id}/stages

Description

Create stage

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
body	body required		StageCreateRequest

Responses

HTTP Code	Description	Schema
200	OK	StageShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/stages

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.0"

Request body

{
    "deployment_id": "27bb070b564349f8a31cc60734cc36a5",
    "description": "description",
    "stage_name": "test-stage"
}

Example HTTP response

Response 200

{
    "stage": {
        "active_deployment": "2024-05-17T00:23:17Z",
        "allow_credentials": true,
        "allow_headers": [
            "Content-Type",
            "Authorization"
        ],
        "allow_methods": [
            "GET",
            "POST",
            "PUT",
            "PATCH"
        ],
        "allow_origins": [
            "*"
        ],
        "api_id": "27bb070b564349f8a31cc60734cc36a5",
        "cors_enabled": false,
        "created_at": "2026-02-11T06:40:15.571Z",
        "deployment_id": "27bb070b564349f8a31cc60734cc36a5",
        "expose_headers": [
            "test1",
            "test2"
        ],
        "invoke_url": "http://test.com/stg",
        "ip_restriction_enabled": false,
        "jwt_enabled": false,
        "max_age": 3600,
        "name": "test-stage"
    }
}

1.1.12 - Create Usage Plans

1.1.12.1 - 1.2

post /v1/apis/{api_id}/usage-plans

Description

Create usage plan

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
body	body required		UsagePlanCreateRequest

Responses

HTTP Code	Description	Schema
200	OK	UsagePlanShowResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/apis/{api_id}/usage-plans

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.2"

Request body

{
    "description": "description",
    "limit": 10,
    "name": "usage-plan-name",
    "rate": "day"
}

Example HTTP response

Response 200

{
    "usage_plan": {
        "api_keys": [],
        "created_at": "2026-02-11T06:40:17.494Z",
        "created_by_id": "27bb070b564349f8a31cc60734cc36a5",
        "created_by_name": "username",
        "description": "description",
        "id": "27bb070b564349f8a31cc60734cc36a5",
        "limit": 10,
        "modified_at": "2026-02-11T06:40:17.494Z",
        "modified_by_id": "27bb070b564349f8a31cc60734cc36a5",
        "modified_by_name": "username",
        "name": "usage-plan-name",
        "rate": "day"
    }
}

1.1.12.2 - 1.1

post /v1/apis/{api_id}/usage-plans

Description

Create usage plan

State ACTIVE (DEPRECATED)

Version	Supported Until
1.1	20260430

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
body	body required		UsagePlanCreateRequest

Responses

HTTP Code	Description	Schema
200	OK	UsagePlanShowResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/apis/{api_id}/usage-plans

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.1"

Request body

{
    "description": "description",
    "limit": 10,
    "name": "usage-plan-name",
    "rate": "day"
}

Example HTTP response

Response 200

{
    "usage_plan": {
        "api_keys": [],
        "created_at": "2026-02-11T06:40:16.459Z",
        "created_by_id": "27bb070b564349f8a31cc60734cc36a5",
        "created_by_name": "username",
        "description": "description",
        "id": "27bb070b564349f8a31cc60734cc36a5",
        "limit": 10,
        "modified_at": "2026-02-11T06:40:16.459Z",
        "modified_by_id": "27bb070b564349f8a31cc60734cc36a5",
        "modified_by_name": "username",
        "name": "usage-plan-name",
        "rate": "day"
    }
}

1.1.13 - Delete Access Control

1.1.13.1 - 1.2

delete /v1/apis/{api_id}/access-controls/{access_control_id}

Description

Delete access control

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example :	string	None
path	access_control_id required	Access Control ID Example :	string	None

Responses

HTTP Code	Description	Schema
204	No Content	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/access-controls/{access_control_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.2"

Example HTTP response

Response 204

1.1.13.2 - 1.1

delete /v1/apis/{api_id}/access-controls/{access_control_id}

Description

Delete access control

State ACTIVE (DEPRECATED)

Version	Supported Until
1.1	20260430

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example :	string	None
path	access_control_id required	Access Control ID Example :	string	None

Responses

HTTP Code	Description	Schema
204	No Content	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/access-controls/{access_control_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.1"

Example HTTP response

Response 204

1.1.13.3 - 1.0

delete /v1/apis/{api_id}/access-controls/{access_control_id}

Description

Delete access control

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example :	string	None
path	access_control_id required	Access Control ID Example :	string	None

Responses

HTTP Code	Description	Schema
204	No Content	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/access-controls/{access_control_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.0"

Example HTTP response

Response 204

1.1.14 - Delete an API Key

1.1.14.1 - 1.2

delete /v1/apis/{api_id}/usage-plans/{usage_plan_id}/api-keys/{api_key_id}

Description

Delete api key

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	usage_plan_id required	Usage Plan ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	api_key_id required	API Key ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None

Responses

HTTP Code	Description	Schema
204	No Content	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/usage-plans/{usage_plan_id}/api-keys/{api_key_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.2"

Example HTTP response

Response 204

1.1.14.2 - 1.1

delete /v1/apis/{api_id}/usage-plans/{usage_plan_id}/api-keys/{api_key_id}

Description

Delete api key

State ACTIVE (DEPRECATED)

Version	Supported Until
1.1	20260430

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	usage_plan_id required	Usage Plan ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	api_key_id required	API Key ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None

Responses

HTTP Code	Description	Schema
204	No Content	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/usage-plans/{usage_plan_id}/api-keys/{api_key_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.1"

Example HTTP response

Response 204

1.1.15 - Delete Api

1.1.15.1 - 1.2

delete /v1/apis/{api_id}

Description

Delete api

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `31e749b7b260868f441e862b`	string	None

Responses

HTTP Code	Description	Schema
204	No Content	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.2"

Example HTTP response

Response 204

1.1.15.2 - 1.1

delete /v1/apis/{api_id}

Description

Delete api

State ACTIVE (DEPRECATED)

Version	Supported Until
1.1	20260430

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `31e749b7b260868f441e862b`	string	None

Responses

HTTP Code	Description	Schema
204	No Content	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.1"

Example HTTP response

Response 204

1.1.15.3 - 1.0

delete /v1/apis/{api_id}

Description

Delete api

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `31e749b7b260868f441e862b`	string	None

Responses

HTTP Code	Description	Schema
204	No Content	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.0"

Example HTTP response

Response 204

1.1.16 - Delete Auth

1.1.16.1 - 1.2

delete /v1/apis/{api_id}/auths/{auth_id}

Description

Delete auth

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example :	string	None
path	auth_id required	Auth ID Example :	string	None

Responses

HTTP Code	Description	Schema
204	No Content	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/auths/{auth_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.2"

Example HTTP response

Response 204

1.1.16.2 - 1.1

delete /v1/apis/{api_id}/auths/{auth_id}

Description

Delete auth

State ACTIVE (DEPRECATED)

Version	Supported Until
1.1	20260430

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example :	string	None
path	auth_id required	Auth ID Example :	string	None

Responses

HTTP Code	Description	Schema
204	No Content	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/auths/{auth_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.1"

Example HTTP response

Response 204

1.1.16.3 - 1.0

delete /v1/apis/{api_id}/auths/{auth_id}

Description

Delete auth

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example :	string	None
path	auth_id required	Auth ID Example :	string	None

Responses

HTTP Code	Description	Schema
204	No Content	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/auths/{auth_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.0"

Example HTTP response

Response 204

1.1.17 - Delete Method

1.1.17.1 - 1.2

delete /v1/apis/{api_id}/resources/{resource_id}/methods/{method_type}

Description

Delete method

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	resource_id required	Resource ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	method_type required	Method Type Example : `GET`	enum (GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS, TRACE, CONNECT)	None

Responses

HTTP Code	Description	Schema
204	No Content	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/resources/{resource_id}/methods/{method_type}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.2"

Example HTTP response

Response 204

1.1.17.2 - 1.1

delete /v1/apis/{api_id}/resources/{resource_id}/methods/{method_type}

Description

Delete method

State ACTIVE (DEPRECATED)

Version	Supported Until
1.1	20260430

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	resource_id required	Resource ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	method_type required	Method Type Example : `GET`	enum (GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS, TRACE, CONNECT)	None

Responses

HTTP Code	Description	Schema
204	No Content	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/resources/{resource_id}/methods/{method_type}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.1"

Example HTTP response

Response 204

1.1.17.3 - 1.0

delete /v1/apis/{api_id}/resources/{resource_id}/methods/{method_type}

Description

Delete method

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	resource_id required	Resource ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	method_type required	Method Type Example : `GET`	enum (GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS, TRACE, CONNECT)	None

Responses

HTTP Code	Description	Schema
204	No Content	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/resources/{resource_id}/methods/{method_type}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.0"

Example HTTP response

Response 204

1.1.18 - Delete PrivateLink Endpoint

1.1.18.1 - 1.2

delete /v1/privatelink-endpoints/{privatelink_endpoint_id}

Description

Delete PrivateLink Endpoint

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	privatelink_endpoint_id required	PrivateLink Endpoint ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None

Responses

HTTP Code	Description	Schema
204	No Content	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/privatelink-endpoints/{privatelink_endpoint_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.2"

Example HTTP response

Response 204

1.1.19 - Delete Resource

1.1.19.1 - 1.2

delete /v1/apis/{api_id}/resources/{resource_id}

Description

Delete resource

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	resource_id required	Resource ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None

Responses

HTTP Code	Description	Schema
204	No Content	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/resources/{resource_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.2"

Example HTTP response

Response 204

1.1.19.2 - 1.1

delete /v1/apis/{api_id}/resources/{resource_id}

Description

Delete resource

State ACTIVE (DEPRECATED)

Version	Supported Until
1.1	20260430

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	resource_id required	Resource ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None

Responses

HTTP Code	Description	Schema
204	No Content	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/resources/{resource_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.1"

Example HTTP response

Response 204

1.1.19.3 - 1.0

delete /v1/apis/{api_id}/resources/{resource_id}

Description

Delete resource

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	resource_id required	Resource ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None

Responses

HTTP Code	Description	Schema
204	No Content	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/resources/{resource_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.0"

Example HTTP response

Response 204

1.1.20 - Delete Stage

1.1.20.1 - 1.2

delete /v1/apis/{api_id}/stages/{stage_name}

Description

Delete stage

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	stage_name required	Stage Name Example : `test-stage`	string	None
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None

Responses

HTTP Code	Description	Schema
204	No Content	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/stages/{stage_name}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.2"

Example HTTP response

Response 204

1.1.20.2 - 1.1

delete /v1/apis/{api_id}/stages/{stage_name}

Description

Delete stage

State ACTIVE (DEPRECATED)

Version	Supported Until
1.1	20260430

Parameters

Type	Name	Description	Schema	Default
path	stage_name required	Stage Name Example : `test-stage`	string	None
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None

Responses

HTTP Code	Description	Schema
204	No Content	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/stages/{stage_name}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.1"

Example HTTP response

Response 204

1.1.20.3 - 1.0

delete /v1/apis/{api_id}/stages/{stage_name}

Description

Delete stage

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	stage_name required	Stage Name Example : `test-stage`	string	None
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None

Responses

HTTP Code	Description	Schema
204	No Content	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/stages/{stage_name}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.0"

Example HTTP response

Response 204

1.1.21 - Delete Usage Plan

1.1.21.1 - 1.2

delete /v1/apis/{api_id}/usage-plans/{usage_plan_id}

Description

Delete usage plan

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	usage_plan_id required	Usage Plan ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None

Responses

HTTP Code	Description	Schema
204	No Content	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/usage-plans/{usage_plan_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.2"

Example HTTP response

Response 204

1.1.21.2 - 1.1

delete /v1/apis/{api_id}/usage-plans/{usage_plan_id}

Description

Delete usage plan

State ACTIVE (DEPRECATED)

Version	Supported Until
1.1	20260430

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	usage_plan_id required	Usage Plan ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None

Responses

HTTP Code	Description	Schema
204	No Content	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/usage-plans/{usage_plan_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.1"

Example HTTP response

Response 204

1.1.22 - List AccessControls

1.1.22.1 - 1.2

get /v1/apis/{api_id}/access-controls

Description

Get access controls list

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example :	string	None
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	AccessControlListResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/access-controls

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.2"

Example HTTP response

Response 200

{
    "access_controls": [
        {
            "allowed_ip_addr": [
                "127.0.0.1/24,192.168.127.12"
            ],
            "connected_stages": [
                "dev,stg"
            ],
            "created_at": "2024-05-19T00:23:17Z",
            "description": "",
            "id": "27bb070b564349f8a31cc60734cc36a5",
            "name": "DenyTest"
        }
    ],
    "count": 20
}

1.1.22.2 - 1.1

get /v1/apis/{api_id}/access-controls

Description

Get access controls list

State ACTIVE (DEPRECATED)

Version	Supported Until
1.1	20260430

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example :	string	None
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	AccessControlListResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/access-controls

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.1"

Example HTTP response

Response 200

{
    "access_controls": [
        {
            "allowed_ip_addr": [
                "127.0.0.1/24,192.168.127.12"
            ],
            "connected_stages": [
                "dev,stg"
            ],
            "created_at": "2024-05-19T00:23:17Z",
            "description": "",
            "id": "27bb070b564349f8a31cc60734cc36a5",
            "name": "DenyTest"
        }
    ],
    "count": 20
}

1.1.22.3 - 1.0

get /v1/apis/{api_id}/access-controls

Description

Get access controls list

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example :	string	None
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	AccessControlListResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/access-controls

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.0"

Example HTTP response

Response 200

{
    "access_controls": [
        {
            "allowed_ip_addr": [
                "127.0.0.1/24,192.168.127.12"
            ],
            "connected_stages": [
                "dev,stg"
            ],
            "created_at": "2024-05-19T00:23:17Z",
            "description": "",
            "id": "27bb070b564349f8a31cc60734cc36a5",
            "name": "DenyTest"
        }
    ],
    "count": 20
}

1.1.23 - List Api Deployments

1.1.23.1 - 1.2

get /v1/apis/{api_id}/deployments

Description

Get api deployments list

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `31e749b7b260868f441e862b`	string	None
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	deployment_id optional	Name Example : `27bb070b564349f8a31cc60734cc36a5`	any of [string, null]	None
query	stage_name optional	Stage Name Example : `test-stage`	string

Responses

HTTP Code	Description	Schema
200	OK	ApiDeploymentListResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/deployments

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.2"

Example HTTP response

Response 200

{
    "count": 20,
    "deployments": [
        {
            "deployment_date": "2024-05-17T00:23:17Z",
            "deployment_id": "27bb070b564349f8a31cc60734cc36a5",
            "description": "description",
            "status": "Active"
        }
    ]
}

1.1.23.2 - 1.1

get /v1/apis/{api_id}/deployments

Description

Get api deployments list

State ACTIVE (DEPRECATED)

Version	Supported Until
1.1	20260430

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `31e749b7b260868f441e862b`	string	None
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	deployment_id optional	Name Example : `27bb070b564349f8a31cc60734cc36a5`	any of [string, null]	None
query	stage_name optional	Stage Name Example : `test-stage`	string

Responses

HTTP Code	Description	Schema
200	OK	ApiDeploymentListResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/deployments

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.1"

Example HTTP response

Response 200

{
    "count": 20,
    "deployments": [
        {
            "deployment_date": "2024-05-17T00:23:17Z",
            "deployment_id": "27bb070b564349f8a31cc60734cc36a5",
            "description": "description",
            "status": "Active"
        }
    ]
}

1.1.23.3 - 1.0

get /v1/apis/{api_id}/deployments

Description

Get api deployments list

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `31e749b7b260868f441e862b`	string	None
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	deployment_id optional	Name Example : `27bb070b564349f8a31cc60734cc36a5`	any of [string, null]	None
query	stage_name optional	Stage Name Example : `test-stage`	string

Responses

HTTP Code	Description	Schema
200	OK	ApiDeploymentListResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/deployments

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.0"

Example HTTP response

Response 200

{
    "count": 20,
    "deployments": [
        {
            "deployment_date": "2024-05-17T00:23:17Z",
            "deployment_id": "27bb070b564349f8a31cc60734cc36a5",
            "description": "description",
            "status": "Active"
        }
    ]
}

1.1.24 - List Api Keys

1.1.24.1 - 1.2

get /v1/apis/{api_id}/usage-plans/{usage_plan_id}/api-keys

Description

Get api key list

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	usage_plan_id required	Usage Plan ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	name optional	Name Example : `api-key-name`	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	ApiKeyListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/apis/{api_id}/usage-plans/{usage_plan_id}/api-keys

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.2"

Example HTTP response

Response 200

{
    "api_keys": [
        {
            "created_at": "2026-02-11T06:40:17.550Z",
            "description": "description",
            "id": "27bb070b564349f8a31cc60734cc36a5",
            "key": "key",
            "name": "api-key-name"
        }
    ],
    "count": 20
}

1.1.24.2 - 1.1

get /v1/apis/{api_id}/usage-plans/{usage_plan_id}/api-keys

Description

Get api key list

State ACTIVE (DEPRECATED)

Version	Supported Until
1.1	20260430

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	usage_plan_id required	Usage Plan ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	name optional	Name Example : `api-key-name`	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	ApiKeyListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/apis/{api_id}/usage-plans/{usage_plan_id}/api-keys

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.1"

Example HTTP response

Response 200

{
    "api_keys": [
        {
            "created_at": "2026-02-11T06:40:16.517Z",
            "description": "description",
            "id": "27bb070b564349f8a31cc60734cc36a5",
            "key": "key",
            "name": "api-key-name"
        }
    ],
    "count": 20
}

1.1.25 - List Apis

1.1.25.1 - 1.2

get /v1/apis

Description

Get apis list

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

Type	Name	Description	Schema	Default
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	name optional	Name Example : `test-api`	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	ApiListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/apis

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.2"

Example HTTP response

Response 200

{
    "apis": [
        {
            "account_id": "27bb070b564349f8a31cc60734cc36a5",
            "created_at": "2024-05-17T00:23:17Z",
            "description": "Description",
            "dns_record_status": "Active",
            "id": "27bb070b564349f8a31cc60734cc36a5",
            "name": "test-api",
            "status": "Active"
        }
    ],
    "count": 20
}

1.1.25.2 - 1.1

get /v1/apis

Description

Get apis list

State ACTIVE (DEPRECATED)

Version	Supported Until
1.1	20260430

Parameters

Type	Name	Description	Schema	Default
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	name optional	Name Example : `test-api`	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	ApiListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/apis

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.1"

Example HTTP response

Response 200

{
    "apis": [
        {
            "account_id": "27bb070b564349f8a31cc60734cc36a5",
            "created_at": "2024-05-17T00:23:17Z",
            "description": "Description",
            "dns_record_status": "Active",
            "id": "27bb070b564349f8a31cc60734cc36a5",
            "name": "test-api",
            "status": "Active"
        }
    ],
    "count": 20
}

1.1.25.3 - 1.0

get /v1/apis

Description

Get apis list

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	name optional	Name Example : `test-api`	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	ApiListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/apis

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.0"

Example HTTP response

Response 200

{
    "apis": [
        {
            "account_id": "27bb070b564349f8a31cc60734cc36a5",
            "created_at": "2024-05-17T00:23:17Z",
            "description": "Description",
            "dns_record_status": "Active",
            "id": "27bb070b564349f8a31cc60734cc36a5",
            "name": "test-api",
            "status": "Active"
        }
    ],
    "count": 20
}

1.1.26 - List Auths

1.1.26.1 - 1.2

get /v1/apis/{api_id}/auths

Description

Get auths list

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example :	string	None
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	AuthListResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/auths

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.2"

Example HTTP response

Response 200

{
    "auths": [
        {
            "auth_method": "JWT(JSON WEB Token)",
            "connected_stages": [
                "dev,stg"
            ],
            "expired_at": "2024-05-17T00:23:17Z",
            "id": "27bb070b564349f8a31cc60734cc36a5",
            "name": "Token01"
        }
    ],
    "count": 20
}

1.1.26.2 - 1.1

get /v1/apis/{api_id}/auths

Description

Get auths list

State ACTIVE (DEPRECATED)

Version	Supported Until
1.1	20260430

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example :	string	None
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	AuthListResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/auths

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.1"

Example HTTP response

Response 200

{
    "auths": [
        {
            "auth_method": "JWT(JSON WEB Token)",
            "connected_stages": [
                "dev,stg"
            ],
            "expired_at": "2024-05-17T00:23:17Z",
            "id": "27bb070b564349f8a31cc60734cc36a5",
            "name": "Token01"
        }
    ],
    "count": 20
}

1.1.26.3 - 1.0

get /v1/apis/{api_id}/auths

Description

Get auths list

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example :	string	None
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	AuthListResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/auths

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.0"

Example HTTP response

Response 200

{
    "auths": [
        {
            "auth_method": "JWT(JSON WEB Token)",
            "connected_stages": [
                "dev,stg"
            ],
            "expired_at": "2024-05-17T00:23:17Z",
            "id": "27bb070b564349f8a31cc60734cc36a5",
            "name": "Token01"
        }
    ],
    "count": 20
}

1.1.27 - List Connected PrivateLink Endpoints

1.1.27.1 - 1.2

get /v1/apis/{api_id}/connected-endpoints

Description

Get connected privatelink endpoints

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `31e749b7b260868f441e862b`	string	None
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	ApiConnectedEndpointListResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/connected-endpoints

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.2"

Example HTTP response

Response 200

{
    "connected_endpoints": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "id": "27bb070b564349f8a31cc60734cc36a5",
            "status": "Active"
        }
    ],
    "count": 20
}

1.1.28 - List Methods

1.1.28.1 - 1.2

get /v1/apis/{api_id}/resources/{resource_id}/methods

Description

Get methods list

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	resource_id required	Resource ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None

Responses

HTTP Code	Description	Schema
200	OK	MethodListResponseV1Dot2
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/resources/{resource_id}/methods

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.2"

Example HTTP response

Response 200

{
    "methods": [
        {
            "api_key_required": false,
            "endpoint_url": "https://127.0.0.1:8000",
            "function_id": "27bb070b564349f8a31cc60734cc36a5",
            "function_name": "test-function",
            "integration_type": "HTTP",
            "method_type": "GET",
            "privatelink_endpoint_id": "27bb070b564349f8a31cc60734cc36a5",
            "query_strings": "{'param1': 'value1', 'param2': 'value2'}",
            "request_headers": "{'test1' : True}",
            "request_path": "{users}",
            "srn": "srn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test"
        }
    ]
}

1.1.28.2 - 1.1

get /v1/apis/{api_id}/resources/{resource_id}/methods

Description

Get methods list

State ACTIVE (DEPRECATED)

Version	Supported Until
1.1	20260430

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	resource_id required	Resource ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None

Responses

HTTP Code	Description	Schema
200	OK	MethodListResponseV1Dot1
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/resources/{resource_id}/methods

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.1"

Example HTTP response

Response 200

{
    "methods": [
        {
            "api_key_required": false,
            "endpoint_url": "https://127.0.0.1:8000",
            "function_id": "27bb070b564349f8a31cc60734cc36a5",
            "function_name": "test-function",
            "integration_type": "HTTP",
            "method_type": "GET",
            "query_strings": "{'param1': 'value1', 'param2': 'value2'}",
            "request_headers": "{'test1' : True}",
            "request_path": "{users}",
            "srn": "srn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test"
        }
    ]
}

1.1.28.3 - 1.0

get /v1/apis/{api_id}/resources/{resource_id}/methods

Description

Get methods list

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	resource_id required	Resource ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None

Responses

HTTP Code	Description	Schema
200	OK	MethodListResponse
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/resources/{resource_id}/methods

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.0"

Example HTTP response

Response 200

{
    "methods": [
        {
            "endpoint_url": "https://127.0.0.1:8000",
            "function_id": "27bb070b564349f8a31cc60734cc36a5",
            "integration_type": "HTTP",
            "method_type": "GET",
            "query_strings": "{'param1': 'value1', 'param2': 'value2'}",
            "request_headers": "{'test1' : True}",
            "request_path": "{users}",
            "srn": "srn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test"
        }
    ]
}

1.1.29 - List PrivateLink Endpoints

1.1.29.1 - 1.2

get /v1/privatelink-endpoints

Description

Get PrivateLink Endpoints list

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

Type	Name	Description	Schema	Default
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	name optional	PrivateLink Endpoint Name Example : `endpoint`	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	PrivateLinkEndpointListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/privatelink-endpoints

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.2"

Example HTTP response

Response 200

{
    "count": 20,
    "privatelink_endpoints": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "id": "27bb070b564349f8a31cc60734cc36a5",
            "name": "endpoint",
            "privatelink_service_id": "27bb070b564349f8a31cc60734cc36a5",
            "status": "CANCELED"
        }
    ]
}

1.1.30 - List Reports

1.1.30.1 - 1.2

get /v1/apis/{api_id}/reports

Description

Get reports list

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

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

Responses

HTTP Code	Description	Schema
200	OK	ReportListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/apis/{api_id}/reports?stage_name={stage_name}&start_date={start_date}&end_date={end_date}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.2"

Example HTTP response

Response 200

{
    "count": 20,
    "reports": [
        {
            "call_count": "10",
            "date": "",
            "error_4xx_count": "10",
            "error_5xx_count": "10",
            "integration_latency": "10",
            "latency": "10"
        }
    ],
    "top_resources": [
        {
            "call_count": "10",
            "name": "test",
            "path": "/test/test1",
            "type": "GET"
        }
    ]
}

1.1.30.2 - 1.1

get /v1/apis/{api_id}/reports

Description

Get reports list

State ACTIVE (DEPRECATED)

Version	Supported Until
1.1	20260430

Parameters

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

Responses

HTTP Code	Description	Schema
200	OK	ReportListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/apis/{api_id}/reports?stage_name={stage_name}&start_date={start_date}&end_date={end_date}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.1"

Example HTTP response

Response 200

{
    "count": 20,
    "reports": [
        {
            "call_count": "10",
            "date": "",
            "error_4xx_count": "10",
            "error_5xx_count": "10",
            "integration_latency": "10",
            "latency": "10"
        }
    ],
    "top_resources": [
        {
            "call_count": "10",
            "name": "test",
            "path": "/test/test1",
            "type": "GET"
        }
    ]
}

1.1.31 - List Resources

1.1.31.1 - 1.2

get /v1/apis/{api_id}/resources

Description

Get resources list

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None

Responses

HTTP Code	Description	Schema
200	OK	ResourceListResponseV1Dot2
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/resources

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.2"

Example HTTP response

Response 200

{
    "resources": [
        {
            "id": "27bb070b564349f8a31cc60734cc36a5",
            "methods": [
                {
                    "api_key_required": false,
                    "endpoint_url": "https://127.0.0.1:8000",
                    "function_id": "27bb070b564349f8a31cc60734cc36a5",
                    "function_name": "test-function",
                    "integration_type": "HTTP",
                    "method_type": "GET",
                    "privatelink_endpoint_id": "27bb070b564349f8a31cc60734cc36a5",
                    "query_strings": "{'param1': 'value1', 'param2': 'value2'}",
                    "request_headers": "{'test1' : True}",
                    "request_path": "{users}",
                    "srn": "srn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test"
                }
            ],
            "parent_id": "27bb070b564349f8a31cc60734cc36a5",
            "path": "/test/test1",
            "path_part": "test"
        }
    ]
}

1.1.31.2 - 1.1

get /v1/apis/{api_id}/resources

Description

Get resources list

State ACTIVE (DEPRECATED)

Version	Supported Until
1.1	20260430

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None

Responses

HTTP Code	Description	Schema
200	OK	ResourceListResponseV1Dot1
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/resources

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.1"

Example HTTP response

Response 200

{
    "resources": [
        {
            "id": "27bb070b564349f8a31cc60734cc36a5",
            "methods": [
                {
                    "api_key_required": false,
                    "endpoint_url": "https://127.0.0.1:8000",
                    "function_id": "27bb070b564349f8a31cc60734cc36a5",
                    "function_name": "test-function",
                    "integration_type": "HTTP",
                    "method_type": "GET",
                    "query_strings": "{'param1': 'value1', 'param2': 'value2'}",
                    "request_headers": "{'test1' : True}",
                    "request_path": "{users}",
                    "srn": "srn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test"
                }
            ],
            "parent_id": "27bb070b564349f8a31cc60734cc36a5",
            "path": "/test/test1",
            "path_part": "test"
        }
    ]
}

1.1.31.3 - 1.0

get /v1/apis/{api_id}/resources

Description

Get resources list

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None

Responses

HTTP Code	Description	Schema
200	OK	ResourceListResponse
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/resources

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.0"

Example HTTP response

Response 200

{
    "resources": [
        {
            "id": "27bb070b564349f8a31cc60734cc36a5",
            "methods": [
                {
                    "endpoint_url": "https://127.0.0.1:8000",
                    "function_id": "27bb070b564349f8a31cc60734cc36a5",
                    "integration_type": "HTTP",
                    "method_type": "GET",
                    "query_strings": "{'param1': 'value1', 'param2': 'value2'}",
                    "request_headers": "{'test1' : True}",
                    "request_path": "{users}",
                    "srn": "srn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test"
                }
            ],
            "parent_id": "27bb070b564349f8a31cc60734cc36a5",
            "path": "/test/test1",
            "path_part": "test"
        }
    ]
}

1.1.32 - List Stages

1.1.32.1 - 1.2

get /v1/apis/{api_id}/stages

Description

Get stages list

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None

Responses

HTTP Code	Description	Schema
200	OK	StageListResponseV1Dot1
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/stages

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.2"

Example HTTP response

Response 200

{
    "stages": [
        {
            "active_deployment": "2024-05-17T00:23:17Z",
            "allow_credentials": true,
            "allow_headers": [
                "Content-Type",
                "Authorization"
            ],
            "allow_methods": [
                "GET",
                "POST",
                "PUT",
                "PATCH"
            ],
            "allow_origins": [
                "*"
            ],
            "api_id": "27bb070b564349f8a31cc60734cc36a5",
            "api_key_required": false,
            "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": false,
            "created_at": "2026-02-11T06:40:17.360Z",
            "deployment_id": "27bb070b564349f8a31cc60734cc36a5",
            "description": "description",
            "expose_headers": [
                "test1",
                "test2"
            ],
            "invoke_url": "http://test.com/stg",
            "jwt_enabled": false,
            "max_age": 3600,
            "name": "test-stage",
            "usage_plan_api_keys": [],
            "usage_plan_id": "27bb070b564349f8a31cc60734cc36a5",
            "usage_plan_limit": 10,
            "usage_plan_name": "usage-plan-name",
            "usage_plan_rate": "day"
        }
    ]
}

1.1.32.2 - 1.1

get /v1/apis/{api_id}/stages

Description

Get stages list

State ACTIVE (DEPRECATED)

Version	Supported Until
1.1	20260430

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None

Responses

HTTP Code	Description	Schema
200	OK	StageListResponseV1Dot1
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/stages

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.1"

Example HTTP response

Response 200

{
    "stages": [
        {
            "active_deployment": "2024-05-17T00:23:17Z",
            "allow_credentials": true,
            "allow_headers": [
                "Content-Type",
                "Authorization"
            ],
            "allow_methods": [
                "GET",
                "POST",
                "PUT",
                "PATCH"
            ],
            "allow_origins": [
                "*"
            ],
            "api_id": "27bb070b564349f8a31cc60734cc36a5",
            "api_key_required": false,
            "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": false,
            "created_at": "2026-02-11T06:40:16.324Z",
            "deployment_id": "27bb070b564349f8a31cc60734cc36a5",
            "description": "description",
            "expose_headers": [
                "test1",
                "test2"
            ],
            "invoke_url": "http://test.com/stg",
            "jwt_enabled": false,
            "max_age": 3600,
            "name": "test-stage",
            "usage_plan_api_keys": [],
            "usage_plan_id": "27bb070b564349f8a31cc60734cc36a5",
            "usage_plan_limit": 10,
            "usage_plan_name": "usage-plan-name",
            "usage_plan_rate": "day"
        }
    ]
}

1.1.32.3 - 1.0

get /v1/apis/{api_id}/stages

Description

Get stages list

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None

Responses

HTTP Code	Description	Schema
200	OK	StageListResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/stages

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.0"

Example HTTP response

Response 200

{
    "stages": [
        {
            "active_deployment": "2024-05-17T00:23:17Z",
            "allow_credentials": true,
            "allow_headers": [
                "Content-Type",
                "Authorization"
            ],
            "allow_methods": [
                "GET",
                "POST",
                "PUT",
                "PATCH"
            ],
            "allow_origins": [
                "*"
            ],
            "api_id": "27bb070b564349f8a31cc60734cc36a5",
            "api_summary": [
                {
                    "methods": [
                        "GET",
                        "POST"
                    ],
                    "path": "/"
                },
                {
                    "methods": [
                        "GET",
                        "POST"
                    ],
                    "path": "/test"
                }
            ],
            "cors_enabled": false,
            "created_at": "2026-02-11T06:40:15.551Z",
            "deployment_id": "27bb070b564349f8a31cc60734cc36a5",
            "expose_headers": [
                "test1",
                "test2"
            ],
            "invoke_url": "http://test.com/stg",
            "ip_restriction_enabled": false,
            "jwt_enabled": false,
            "max_age": 3600,
            "name": "test-stage"
        }
    ]
}

1.1.33 - List Usage Plans

1.1.33.1 - 1.2

get /v1/apis/{api_id}/usage-plans

Description

Get usage plans list

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	name optional	Name Example : `usage-plan-name`	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	UsagePlanListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/apis/{api_id}/usage-plans

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.2"

Example HTTP response

Response 200

{
    "count": 20,
    "usage_plans": [
        {
            "connected_api_keys": [
                "key1",
                "key2"
            ],
            "created_at": "2026-02-11T06:40:17.475Z",
            "description": "description",
            "id": "27bb070b564349f8a31cc60734cc36a5",
            "limit": 10,
            "name": "usage-plan-name",
            "rate": "day"
        }
    ]
}

1.1.33.2 - 1.1

get /v1/apis/{api_id}/usage-plans

Description

Get usage plans list

State ACTIVE (DEPRECATED)

Version	Supported Until
1.1	20260430

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	name optional	Name Example : `usage-plan-name`	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	UsagePlanListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/apis/{api_id}/usage-plans

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.1"

Example HTTP response

Response 200

{
    "count": 20,
    "usage_plans": [
        {
            "connected_api_keys": [
                "key1",
                "key2"
            ],
            "created_at": "2026-02-11T06:40:16.440Z",
            "description": "description",
            "id": "27bb070b564349f8a31cc60734cc36a5",
            "limit": 10,
            "name": "usage-plan-name",
            "rate": "day"
        }
    ]
}

1.1.34 - Request PrivateLink Endpoint

1.1.34.1 - 1.2

put /v1/privatelink-endpoints/{privatelink_endpoint_id}/request

Description

Request PrivateLink Endpoint

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	privatelink_endpoint_id required	PrivateLink Endpoint ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
body	body required		PrivateLinkEndpointRequestRequest

Responses

HTTP Code	Description	Schema
200	OK	PrivateLinkEndpointShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/privatelink-endpoints/{privatelink_endpoint_id}/request

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.2"

Request body

{
    "type": "CANCEL"
}

Example HTTP response

Response 200

{
    "privatelink_endpoint": {
        "created_at": "2024-05-17T00:23:17Z",
        "description": "description",
        "id": "27bb070b564349f8a31cc60734cc36a5",
        "name": "endpoint",
        "privatelink_service_id": "27bb070b564349f8a31cc60734cc36a5",
        "status": "CANCELED"
    }
}

1.1.35 - Set Access Control

1.1.35.1 - 1.2

put /v1/apis/{api_id}/access-controls/{access_control_id}

Description

Set access control

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example :	string	None
path	access_control_id required	Access Control ID Example :	string	None
body	body required		AccessControlSetRequest

Responses

HTTP Code	Description	Schema
200	OK	AccessControlShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/access-controls/{access_control_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.2"

Request body

{
    "allowed_ip_addr": [
        "127.0.0.1/24,192.168.127.12"
    ],
    "connected_stages": [
        "dev,stg"
    ],
    "description": "description"
}

Example HTTP response

Response 200

{
    "access_control": {
        "allowed_ip_addr": [
            "127.0.0.1/24,192.168.127.12"
        ],
        "connected_stages": [
            "dev,stg"
        ],
        "created_at": "2024-05-19T00:23:17Z",
        "description": "",
        "id": "27bb070b564349f8a31cc60734cc36a5",
        "name": "DenyTest"
    }
}

1.1.35.2 - 1.1

put /v1/apis/{api_id}/access-controls/{access_control_id}

Description

Set access control

State ACTIVE (DEPRECATED)

Version	Supported Until
1.1	20260430

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example :	string	None
path	access_control_id required	Access Control ID Example :	string	None
body	body required		AccessControlSetRequest

Responses

HTTP Code	Description	Schema
200	OK	AccessControlShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/access-controls/{access_control_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.1"

Request body

{
    "allowed_ip_addr": [
        "127.0.0.1/24,192.168.127.12"
    ],
    "connected_stages": [
        "dev,stg"
    ],
    "description": "description"
}

Example HTTP response

Response 200

{
    "access_control": {
        "allowed_ip_addr": [
            "127.0.0.1/24,192.168.127.12"
        ],
        "connected_stages": [
            "dev,stg"
        ],
        "created_at": "2024-05-19T00:23:17Z",
        "description": "",
        "id": "27bb070b564349f8a31cc60734cc36a5",
        "name": "DenyTest"
    }
}

1.1.35.3 - 1.0

put /v1/apis/{api_id}/access-controls/{access_control_id}

Description

Set access control

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example :	string	None
path	access_control_id required	Access Control ID Example :	string	None
body	body required		AccessControlSetRequest

Responses

HTTP Code	Description	Schema
200	OK	AccessControlShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/access-controls/{access_control_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.0"

Request body

{
    "allowed_ip_addr": [
        "127.0.0.1/24,192.168.127.12"
    ],
    "connected_stages": [
        "dev,stg"
    ],
    "description": "description"
}

Example HTTP response

Response 200

{
    "access_control": {
        "allowed_ip_addr": [
            "127.0.0.1/24,192.168.127.12"
        ],
        "connected_stages": [
            "dev,stg"
        ],
        "created_at": "2024-05-19T00:23:17Z",
        "description": "",
        "id": "27bb070b564349f8a31cc60734cc36a5",
        "name": "DenyTest"
    }
}

1.1.36 - Set Api Description

1.1.36.1 - 1.2

put /v1/apis/{api_id}/description

Description

Set api description

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `31e749b7b260868f441e862b`	string	None
body	body required		ApiSetDescriptionRequest

Responses

HTTP Code	Description	Schema
200	OK	ApiShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/description

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.2"

Request body

{
    "description": "description"
}

Example HTTP response

Response 200

{
    "api": {
        "account_id": "27bb070b564349f8a31cc60734cc36a5",
        "created_at": "2024-05-17T00:23:17Z",
        "description": "Description",
        "dns_record_status": "Active",
        "id": "27bb070b564349f8a31cc60734cc36a5",
        "name": "test-api",
        "status": "Active"
    }
}

1.1.36.2 - 1.1

put /v1/apis/{api_id}/description

Description

Set api description

State ACTIVE (DEPRECATED)

Version	Supported Until
1.1	20260430

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `31e749b7b260868f441e862b`	string	None
body	body required		ApiSetDescriptionRequest

Responses

HTTP Code	Description	Schema
200	OK	ApiShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/description

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.1"

Request body

{
    "description": "description"
}

Example HTTP response

Response 200

{
    "api": {
        "account_id": "27bb070b564349f8a31cc60734cc36a5",
        "created_at": "2024-05-17T00:23:17Z",
        "description": "Description",
        "dns_record_status": "Active",
        "id": "27bb070b564349f8a31cc60734cc36a5",
        "name": "test-api",
        "status": "Active"
    }
}

1.1.36.3 - 1.0

put /v1/apis/{api_id}/description

Description

Set api description

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `31e749b7b260868f441e862b`	string	None
body	body required		ApiSetDescriptionRequest

Responses

HTTP Code	Description	Schema
200	OK	ApiShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/description

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.0"

Request body

{
    "description": "description"
}

Example HTTP response

Response 200

{
    "api": {
        "account_id": "27bb070b564349f8a31cc60734cc36a5",
        "created_at": "2024-05-17T00:23:17Z",
        "description": "Description",
        "dns_record_status": "Active",
        "id": "27bb070b564349f8a31cc60734cc36a5",
        "name": "test-api",
        "status": "Active"
    }
}

1.1.37 - Set API Key Description

1.1.37.1 - 1.2

put /v1/apis/{api_id}/usage-plans/{usage_plan_id}/api-keys/{api_key_id}/description

Description

Set api key

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	usage_plan_id required	Usage Plan ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	api_key_id required	API Key ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
body	body required		ApiKeySetDescriptionRequest

Responses

HTTP Code	Description	Schema
200	OK	ApiKeyShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/usage-plans/{usage_plan_id}/api-keys/{api_key_id}/description

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.2"

Request body

{
    "description": "description"
}

Example HTTP response

Response 200

{
    "api_key": {
        "created_at": "2026-02-11T06:40:17.606Z",
        "description": "description",
        "id": "27bb070b564349f8a31cc60734cc36a5",
        "key": "key",
        "name": "api-key-name"
    }
}

1.1.37.2 - 1.1

put /v1/apis/{api_id}/usage-plans/{usage_plan_id}/api-keys/{api_key_id}/description

Description

Set api key

State ACTIVE (DEPRECATED)

Version	Supported Until
1.1	20260430

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	usage_plan_id required	Usage Plan ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	api_key_id required	API Key ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
body	body required		ApiKeySetDescriptionRequest

Responses

HTTP Code	Description	Schema
200	OK	ApiKeyShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/usage-plans/{usage_plan_id}/api-keys/{api_key_id}/description

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.1"

Request body

{
    "description": "description"
}

Example HTTP response

Response 200

{
    "api_key": {
        "created_at": "2026-02-11T06:40:16.574Z",
        "description": "description",
        "id": "27bb070b564349f8a31cc60734cc36a5",
        "key": "key",
        "name": "api-key-name"
    }
}

1.1.38 - Set Auth

1.1.38.1 - 1.2

put /v1/apis/{api_id}/auths/{auth_id}

Description

Set auth

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example :	string	None
path	auth_id required	Auth ID Example :	string	None
body	body required		AuthSetRequest

Responses

HTTP Code	Description	Schema
200	OK	AuthShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/auths/{auth_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.2"

Request body

{
    "connected_stages": [
        "dev,stg"
    ]
}

Example HTTP response

Response 200

{
    "auth": {
        "auth_method": "JWT(JSON WEB Token)",
        "connected_stages": [
            "dev,stg"
        ],
        "expired_at": "2024-05-17T00:23:17Z",
        "id": "27bb070b564349f8a31cc60734cc36a5",
        "name": "Token01"
    }
}

1.1.38.2 - 1.1

put /v1/apis/{api_id}/auths/{auth_id}

Description

Set auth

State ACTIVE (DEPRECATED)

Version	Supported Until
1.1	20260430

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example :	string	None
path	auth_id required	Auth ID Example :	string	None
body	body required		AuthSetRequest

Responses

HTTP Code	Description	Schema
200	OK	AuthShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/auths/{auth_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.1"

Request body

{
    "connected_stages": [
        "dev,stg"
    ]
}

Example HTTP response

Response 200

{
    "auth": {
        "auth_method": "JWT(JSON WEB Token)",
        "connected_stages": [
            "dev,stg"
        ],
        "expired_at": "2024-05-17T00:23:17Z",
        "id": "27bb070b564349f8a31cc60734cc36a5",
        "name": "Token01"
    }
}

1.1.38.3 - 1.0

put /v1/apis/{api_id}/auths/{auth_id}

Description

Set auth

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example :	string	None
path	auth_id required	Auth ID Example :	string	None
body	body required		AuthSetRequest

Responses

HTTP Code	Description	Schema
200	OK	AuthShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/auths/{auth_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.0"

Request body

{
    "connected_stages": [
        "dev,stg"
    ]
}

Example HTTP response

Response 200

{
    "auth": {
        "auth_method": "JWT(JSON WEB Token)",
        "connected_stages": [
            "dev,stg"
        ],
        "expired_at": "2024-05-17T00:23:17Z",
        "id": "27bb070b564349f8a31cc60734cc36a5",
        "name": "Token01"
    }
}

1.1.39 - Set Method

1.1.39.1 - 1.2

put /v1/apis/{api_id}/resources/{resource_id}/methods/{method_type}

Description

Set method

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	resource_id required	Resource ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	method_type required	Method Type Example : `GET`	enum (GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS, TRACE, CONNECT)	None
body	body required		MethodSetRequestV1Dot1

Responses

HTTP Code	Description	Schema
200	OK	MethodShowResponseV1Dot2
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/resources/{resource_id}/methods/{method_type}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.2"

Request body

{
    "api_key_required": false,
    "endpoint_url": "https://127.0.0.1:8000",
    "function_id": "27bb070b564349f8a31cc60734cc36a5",
    "integration_type": "HTTP",
    "privatelink_endpoint_id": "27bb070b564349f8a31cc60734cc36a5",
    "query_strings": "{'param1': 'value1', 'param2': 'value2'}",
    "request_headers": "{'test1' : True}"
}

Example HTTP response

Response 200

{
    "method": {
        "api_key_required": false,
        "endpoint_url": "https://127.0.0.1:8000",
        "function_id": "27bb070b564349f8a31cc60734cc36a5",
        "function_name": "test-function",
        "integration_type": "HTTP",
        "method_type": "GET",
        "privatelink_endpoint_id": "27bb070b564349f8a31cc60734cc36a5",
        "query_strings": "{'param1': 'value1', 'param2': 'value2'}",
        "request_headers": "{'test1' : True}",
        "request_path": "{users}",
        "srn": "srn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test"
    }
}

1.1.39.2 - 1.1

put /v1/apis/{api_id}/resources/{resource_id}/methods/{method_type}

Description

Set method

State ACTIVE (DEPRECATED)

Version	Supported Until
1.1	20260430

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	resource_id required	Resource ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	method_type required	Method Type Example : `GET`	enum (GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS, TRACE, CONNECT)	None
body	body required		MethodSetRequestV1Dot1

Responses

HTTP Code	Description	Schema
200	OK	MethodShowResponseV1Dot1
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/resources/{resource_id}/methods/{method_type}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.1"

Request body

{
    "api_key_required": false,
    "endpoint_url": "https://127.0.0.1:8000",
    "function_id": "27bb070b564349f8a31cc60734cc36a5",
    "integration_type": "HTTP",
    "privatelink_endpoint_id": "27bb070b564349f8a31cc60734cc36a5",
    "query_strings": "{'param1': 'value1', 'param2': 'value2'}",
    "request_headers": "{'test1' : True}"
}

Example HTTP response

Response 200

{
    "method": {
        "api_key_required": false,
        "endpoint_url": "https://127.0.0.1:8000",
        "function_id": "27bb070b564349f8a31cc60734cc36a5",
        "function_name": "test-function",
        "integration_type": "HTTP",
        "method_type": "GET",
        "query_strings": "{'param1': 'value1', 'param2': 'value2'}",
        "request_headers": "{'test1' : True}",
        "request_path": "{users}",
        "srn": "srn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test"
    }
}

1.1.39.3 - 1.0

put /v1/apis/{api_id}/resources/{resource_id}/methods/{method_type}

Description

Set method

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	resource_id required	Resource ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	method_type required	Method Type Example : `GET`	enum (GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS, TRACE, CONNECT)	None
body	body required		MethodSetRequest

Responses

HTTP Code	Description	Schema
200	OK	MethodShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/resources/{resource_id}/methods/{method_type}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.0"

Request body

{
    "query_strings": "{'param1': 'value1', 'param2': 'value2'}",
    "request_headers": "{'test1' : True}"
}

Example HTTP response

Response 200

{
    "method": {
        "endpoint_url": "https://127.0.0.1:8000",
        "function_id": "27bb070b564349f8a31cc60734cc36a5",
        "integration_type": "HTTP",
        "method_type": "GET",
        "query_strings": "{'param1': 'value1', 'param2': 'value2'}",
        "request_headers": "{'test1' : True}",
        "request_path": "{users}",
        "srn": "srn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test"
    }
}

1.1.40 - Set PrivateLink Endpoint

1.1.40.1 - 1.2

put /v1/privatelink-endpoints/{privatelink_endpoint_id}

Description

Set PrivateLink Endpoint

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	privatelink_endpoint_id required	PrivateLink Endpoint ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
body	body required		PrivateLinkEndpointSetRequest

Responses

HTTP Code	Description	Schema
200	OK	PrivateLinkEndpointShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/privatelink-endpoints/{privatelink_endpoint_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.2"

Request body

{
    "description": "description"
}

Example HTTP response

Response 200

{
    "privatelink_endpoint": {
        "created_at": "2024-05-17T00:23:17Z",
        "description": "description",
        "id": "27bb070b564349f8a31cc60734cc36a5",
        "name": "endpoint",
        "privatelink_service_id": "27bb070b564349f8a31cc60734cc36a5",
        "status": "CANCELED"
    }
}

1.1.41 - Set Stage Active Deployment

1.1.41.1 - 1.2

put /v1/apis/{api_id}/stages/{stage_name}/deployment

Description

Set stage active deployment

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	stage_name required	Stage Name Example : `test-stage`	string	None
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
body	body required		StageSetActiveDeploymentRequest

Responses

HTTP Code	Description	Schema
200	OK	StageShowResponseV1Dot1
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/stages/{stage_name}/deployment

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.2"

Request body

{
    "deployment_id": "27bb070b564349f8a31cc60734cc36a5"
}

Example HTTP response

Response 200

{
    "stage": {
        "active_deployment": "2024-05-17T00:23:17Z",
        "allow_credentials": true,
        "allow_headers": [
            "Content-Type",
            "Authorization"
        ],
        "allow_methods": [
            "GET",
            "POST",
            "PUT",
            "PATCH"
        ],
        "allow_origins": [
            "*"
        ],
        "api_id": "27bb070b564349f8a31cc60734cc36a5",
        "api_key_required": false,
        "cors_enabled": false,
        "created_at": "2026-02-11T06:40:17.456Z",
        "deployment_id": "27bb070b564349f8a31cc60734cc36a5",
        "description": "description",
        "expose_headers": [
            "test1",
            "test2"
        ],
        "invoke_url": "http://test.com/stg",
        "jwt_enabled": false,
        "max_age": 3600,
        "name": "test-stage",
        "usage_plan_api_keys": [],
        "usage_plan_id": "27bb070b564349f8a31cc60734cc36a5",
        "usage_plan_limit": 10,
        "usage_plan_name": "usage-plan-name",
        "usage_plan_rate": "day"
    }
}

1.1.41.2 - 1.1

put /v1/apis/{api_id}/stages/{stage_name}/deployment

Description

Set stage active deployment

State ACTIVE (DEPRECATED)

Version	Supported Until
1.1	20260430

Parameters

Type	Name	Description	Schema	Default
path	stage_name required	Stage Name Example : `test-stage`	string	None
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
body	body required		StageSetActiveDeploymentRequest

Responses

HTTP Code	Description	Schema
200	OK	StageShowResponseV1Dot1
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/stages/{stage_name}/deployment

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.1"

Request body

{
    "deployment_id": "27bb070b564349f8a31cc60734cc36a5"
}

Example HTTP response

Response 200

{
    "stage": {
        "active_deployment": "2024-05-17T00:23:17Z",
        "allow_credentials": true,
        "allow_headers": [
            "Content-Type",
            "Authorization"
        ],
        "allow_methods": [
            "GET",
            "POST",
            "PUT",
            "PATCH"
        ],
        "allow_origins": [
            "*"
        ],
        "api_id": "27bb070b564349f8a31cc60734cc36a5",
        "api_key_required": false,
        "cors_enabled": false,
        "created_at": "2026-02-11T06:40:16.421Z",
        "deployment_id": "27bb070b564349f8a31cc60734cc36a5",
        "description": "description",
        "expose_headers": [
            "test1",
            "test2"
        ],
        "invoke_url": "http://test.com/stg",
        "jwt_enabled": false,
        "max_age": 3600,
        "name": "test-stage",
        "usage_plan_api_keys": [],
        "usage_plan_id": "27bb070b564349f8a31cc60734cc36a5",
        "usage_plan_limit": 10,
        "usage_plan_name": "usage-plan-name",
        "usage_plan_rate": "day"
    }
}

1.1.41.3 - 1.0

put /v1/apis/{api_id}/stages/{stage_name}/deployment

Description

Set stage active deployment

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	stage_name required	Stage Name Example : `test-stage`	string	None
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
body	body required		StageSetActiveDeploymentRequest

Responses

HTTP Code	Description	Schema
200	OK	StageShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/stages/{stage_name}/deployment

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.0"

Request body

{
    "deployment_id": "27bb070b564349f8a31cc60734cc36a5"
}

Example HTTP response

Response 200

{
    "stage": {
        "active_deployment": "2024-05-17T00:23:17Z",
        "allow_credentials": true,
        "allow_headers": [
            "Content-Type",
            "Authorization"
        ],
        "allow_methods": [
            "GET",
            "POST",
            "PUT",
            "PATCH"
        ],
        "allow_origins": [
            "*"
        ],
        "api_id": "27bb070b564349f8a31cc60734cc36a5",
        "cors_enabled": false,
        "created_at": "2026-02-11T06:40:15.651Z",
        "deployment_id": "27bb070b564349f8a31cc60734cc36a5",
        "expose_headers": [
            "test1",
            "test2"
        ],
        "invoke_url": "http://test.com/stg",
        "ip_restriction_enabled": false,
        "jwt_enabled": false,
        "max_age": 3600,
        "name": "test-stage"
    }
}

1.1.42 - Set Stage Configuration

1.1.42.1 - 1.2

put /v1/apis/{api_id}/stages/{stage_name}/config

Description

Set stage configuration

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	stage_name required	Stage Name Example : `test-stage`	string	None
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
body	body required		StageSetConfigRequestV1Dot1

Responses

HTTP Code	Description	Schema
200	OK	StageShowResponseV1Dot1
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/stages/{stage_name}/config

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.2"

Request body

{
    "allow_credentials": true,
    "allow_headers": [
        "Content-Type",
        "Authorization"
    ],
    "allow_methods": [
        "GET",
        "POST",
        "PUT",
        "PATCH"
    ],
    "allow_origins": [
        "*"
    ],
    "connected_api_keys": [
        "key1",
        "key2"
    ],
    "cors_enabled": false,
    "description": "description",
    "expose_headers": [
        "test1",
        "test2"
    ],
    "jwt_enabled": false,
    "max_age": 3600,
    "usage_plan_id": "27bb070b564349f8a31cc60734cc36a5"
}

Example HTTP response

Response 200

{
    "stage": {
        "active_deployment": "2024-05-17T00:23:17Z",
        "allow_credentials": true,
        "allow_headers": [
            "Content-Type",
            "Authorization"
        ],
        "allow_methods": [
            "GET",
            "POST",
            "PUT",
            "PATCH"
        ],
        "allow_origins": [
            "*"
        ],
        "api_id": "27bb070b564349f8a31cc60734cc36a5",
        "api_key_required": false,
        "cors_enabled": false,
        "created_at": "2026-02-11T06:40:17.437Z",
        "deployment_id": "27bb070b564349f8a31cc60734cc36a5",
        "description": "description",
        "expose_headers": [
            "test1",
            "test2"
        ],
        "invoke_url": "http://test.com/stg",
        "jwt_enabled": false,
        "max_age": 3600,
        "name": "test-stage",
        "usage_plan_api_keys": [],
        "usage_plan_id": "27bb070b564349f8a31cc60734cc36a5",
        "usage_plan_limit": 10,
        "usage_plan_name": "usage-plan-name",
        "usage_plan_rate": "day"
    }
}

1.1.42.2 - 1.1

put /v1/apis/{api_id}/stages/{stage_name}/config

Description

Set stage configuration

State ACTIVE (DEPRECATED)

Version	Supported Until
1.1	20260430

Parameters

Type	Name	Description	Schema	Default
path	stage_name required	Stage Name Example : `test-stage`	string	None
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
body	body required		StageSetConfigRequestV1Dot1

Responses

HTTP Code	Description	Schema
200	OK	StageShowResponseV1Dot1
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/stages/{stage_name}/config

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.1"

Request body

{
    "allow_credentials": true,
    "allow_headers": [
        "Content-Type",
        "Authorization"
    ],
    "allow_methods": [
        "GET",
        "POST",
        "PUT",
        "PATCH"
    ],
    "allow_origins": [
        "*"
    ],
    "connected_api_keys": [
        "key1",
        "key2"
    ],
    "cors_enabled": false,
    "description": "description",
    "expose_headers": [
        "test1",
        "test2"
    ],
    "jwt_enabled": false,
    "max_age": 3600,
    "usage_plan_id": "27bb070b564349f8a31cc60734cc36a5"
}

Example HTTP response

Response 200

{
    "stage": {
        "active_deployment": "2024-05-17T00:23:17Z",
        "allow_credentials": true,
        "allow_headers": [
            "Content-Type",
            "Authorization"
        ],
        "allow_methods": [
            "GET",
            "POST",
            "PUT",
            "PATCH"
        ],
        "allow_origins": [
            "*"
        ],
        "api_id": "27bb070b564349f8a31cc60734cc36a5",
        "api_key_required": false,
        "cors_enabled": false,
        "created_at": "2026-02-11T06:40:16.401Z",
        "deployment_id": "27bb070b564349f8a31cc60734cc36a5",
        "description": "description",
        "expose_headers": [
            "test1",
            "test2"
        ],
        "invoke_url": "http://test.com/stg",
        "jwt_enabled": false,
        "max_age": 3600,
        "name": "test-stage",
        "usage_plan_api_keys": [],
        "usage_plan_id": "27bb070b564349f8a31cc60734cc36a5",
        "usage_plan_limit": 10,
        "usage_plan_name": "usage-plan-name",
        "usage_plan_rate": "day"
    }
}

1.1.42.3 - 1.0

put /v1/apis/{api_id}/stages/{stage_name}/config

Description

Set stage configuration(Modifying ip_restriction_enabled is no longer supported)

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	stage_name required	Stage Name Example : `test-stage`	string	None
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
body	body required		StageSetConfigRequest

Responses

HTTP Code	Description	Schema
200	OK	StageShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/stages/{stage_name}/config

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.0"

Request body

{
    "allow_credentials": true,
    "allow_headers": [
        "Content-Type",
        "Authorization"
    ],
    "allow_methods": [
        "GET",
        "POST",
        "PUT",
        "PATCH"
    ],
    "allow_origins": [
        "*"
    ],
    "cors_enabled": false,
    "expose_headers": [
        "test1",
        "test2"
    ],
    "ip_restriction_enabled": false,
    "jwt_enabled": false,
    "max_age": 3600
}

Example HTTP response

Response 200

{
    "stage": {
        "active_deployment": "2024-05-17T00:23:17Z",
        "allow_credentials": true,
        "allow_headers": [
            "Content-Type",
            "Authorization"
        ],
        "allow_methods": [
            "GET",
            "POST",
            "PUT",
            "PATCH"
        ],
        "allow_origins": [
            "*"
        ],
        "api_id": "27bb070b564349f8a31cc60734cc36a5",
        "cors_enabled": false,
        "created_at": "2026-02-11T06:40:15.631Z",
        "deployment_id": "27bb070b564349f8a31cc60734cc36a5",
        "expose_headers": [
            "test1",
            "test2"
        ],
        "invoke_url": "http://test.com/stg",
        "ip_restriction_enabled": false,
        "jwt_enabled": false,
        "max_age": 3600,
        "name": "test-stage"
    }
}

1.1.43 - Set Usage Plan Description

1.1.43.1 - 1.2

put /v1/apis/{api_id}/usage-plans/{usage_plan_id}/description

Description

Set usage plan description

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	usage_plan_id required	Usage Plan ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
body	body required		UsagePlanSetDescriptionRequest

Responses

HTTP Code	Description	Schema
200	OK	UsagePlanShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/usage-plans/{usage_plan_id}/description

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.2"

Request body

{
    "description": "description"
}

Example HTTP response

Response 200

{
    "usage_plan": {
        "api_keys": [],
        "created_at": "2026-02-11T06:40:17.625Z",
        "created_by_id": "27bb070b564349f8a31cc60734cc36a5",
        "created_by_name": "username",
        "description": "description",
        "id": "27bb070b564349f8a31cc60734cc36a5",
        "limit": 10,
        "modified_at": "2026-02-11T06:40:17.625Z",
        "modified_by_id": "27bb070b564349f8a31cc60734cc36a5",
        "modified_by_name": "username",
        "name": "usage-plan-name",
        "rate": "day"
    }
}

1.1.43.2 - 1.1

put /v1/apis/{api_id}/usage-plans/{usage_plan_id}/description

Description

Set usage plan description

State ACTIVE (DEPRECATED)

Version	Supported Until
1.1	20260430

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	usage_plan_id required	Usage Plan ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
body	body required		UsagePlanSetDescriptionRequest

Responses

HTTP Code	Description	Schema
200	OK	UsagePlanShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/usage-plans/{usage_plan_id}/description

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.1"

Request body

{
    "description": "description"
}

Example HTTP response

Response 200

{
    "usage_plan": {
        "api_keys": [],
        "created_at": "2026-02-11T06:40:16.593Z",
        "created_by_id": "27bb070b564349f8a31cc60734cc36a5",
        "created_by_name": "username",
        "description": "description",
        "id": "27bb070b564349f8a31cc60734cc36a5",
        "limit": 10,
        "modified_at": "2026-02-11T06:40:16.593Z",
        "modified_by_id": "27bb070b564349f8a31cc60734cc36a5",
        "modified_by_name": "username",
        "name": "usage-plan-name",
        "rate": "day"
    }
}

1.1.44 - Set Usage Plan Quota

1.1.44.1 - 1.2

put /v1/apis/{api_id}/usage-plans/{usage_plan_id}/quota

Description

Set usage plan quota

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	usage_plan_id required	Usage Plan ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
body	body required		UsagePlanSetQuotaRequest

Responses

HTTP Code	Description	Schema
200	OK	UsagePlanShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/usage-plans/{usage_plan_id}/quota

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.2"

Request body

{
    "limit": 10,
    "rate": "day"
}

Example HTTP response

Response 200

{
    "usage_plan": {
        "api_keys": [],
        "created_at": "2026-02-11T06:40:17.644Z",
        "created_by_id": "27bb070b564349f8a31cc60734cc36a5",
        "created_by_name": "username",
        "description": "description",
        "id": "27bb070b564349f8a31cc60734cc36a5",
        "limit": 10,
        "modified_at": "2026-02-11T06:40:17.644Z",
        "modified_by_id": "27bb070b564349f8a31cc60734cc36a5",
        "modified_by_name": "username",
        "name": "usage-plan-name",
        "rate": "day"
    }
}

1.1.44.2 - 1.1

put /v1/apis/{api_id}/usage-plans/{usage_plan_id}/quota

Description

Set usage plan quota

State ACTIVE (DEPRECATED)

Version	Supported Until
1.1	20260430

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	usage_plan_id required	Usage Plan ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
body	body required		UsagePlanSetQuotaRequest

Responses

HTTP Code	Description	Schema
200	OK	UsagePlanShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/usage-plans/{usage_plan_id}/quota

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.1"

Request body

{
    "limit": 10,
    "rate": "day"
}

Example HTTP response

Response 200

{
    "usage_plan": {
        "api_keys": [],
        "created_at": "2026-02-11T06:40:16.613Z",
        "created_by_id": "27bb070b564349f8a31cc60734cc36a5",
        "created_by_name": "username",
        "description": "description",
        "id": "27bb070b564349f8a31cc60734cc36a5",
        "limit": 10,
        "modified_at": "2026-02-11T06:40:16.613Z",
        "modified_by_id": "27bb070b564349f8a31cc60734cc36a5",
        "modified_by_name": "username",
        "name": "usage-plan-name",
        "rate": "day"
    }
}

1.1.45 - Show Access Control

1.1.45.1 - 1.2

get /v1/apis/{api_id}/access-controls/{access_control_id}

Description

Show access control

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example :	string	None
path	access_control_id required	Access Control ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	AccessControlShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/access-controls/{access_control_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.2"

Example HTTP response

Response 200

{
    "access_control": {
        "allowed_ip_addr": [
            "127.0.0.1/24,192.168.127.12"
        ],
        "connected_stages": [
            "dev,stg"
        ],
        "created_at": "2024-05-19T00:23:17Z",
        "description": "",
        "id": "27bb070b564349f8a31cc60734cc36a5",
        "name": "DenyTest"
    }
}

1.1.45.2 - 1.1

get /v1/apis/{api_id}/access-controls/{access_control_id}

Description

Show access control

State ACTIVE (DEPRECATED)

Version	Supported Until
1.1	20260430

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example :	string	None
path	access_control_id required	Access Control ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	AccessControlShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/access-controls/{access_control_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.1"

Example HTTP response

Response 200

{
    "access_control": {
        "allowed_ip_addr": [
            "127.0.0.1/24,192.168.127.12"
        ],
        "connected_stages": [
            "dev,stg"
        ],
        "created_at": "2024-05-19T00:23:17Z",
        "description": "",
        "id": "27bb070b564349f8a31cc60734cc36a5",
        "name": "DenyTest"
    }
}

1.1.45.3 - 1.0

get /v1/apis/{api_id}/access-controls/{access_control_id}

Description

Show access control

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example :	string	None
path	access_control_id required	Access Control ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	AccessControlShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/access-controls/{access_control_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.0"

Example HTTP response

Response 200

{
    "access_control": {
        "allowed_ip_addr": [
            "127.0.0.1/24,192.168.127.12"
        ],
        "connected_stages": [
            "dev,stg"
        ],
        "created_at": "2024-05-19T00:23:17Z",
        "description": "",
        "id": "27bb070b564349f8a31cc60734cc36a5",
        "name": "DenyTest"
    }
}

1.1.46 - Show Api

1.1.46.1 - 1.2

get /v1/apis/{api_id}

Description

Show api

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `31e749b7b260868f441e862b`	string	None

Responses

HTTP Code	Description	Schema
200	OK	ApiShowResponse
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.2"

Example HTTP response

Response 200

{
    "api": {
        "account_id": "27bb070b564349f8a31cc60734cc36a5",
        "created_at": "2024-05-17T00:23:17Z",
        "description": "Description",
        "dns_record_status": "Active",
        "id": "27bb070b564349f8a31cc60734cc36a5",
        "name": "test-api",
        "status": "Active"
    }
}

1.1.46.2 - 1.1

get /v1/apis/{api_id}

Description

Show api

State ACTIVE (DEPRECATED)

Version	Supported Until
1.1	20260430

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `31e749b7b260868f441e862b`	string	None

Responses

HTTP Code	Description	Schema
200	OK	ApiShowResponse
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.1"

Example HTTP response

Response 200

{
    "api": {
        "account_id": "27bb070b564349f8a31cc60734cc36a5",
        "created_at": "2024-05-17T00:23:17Z",
        "description": "Description",
        "dns_record_status": "Active",
        "id": "27bb070b564349f8a31cc60734cc36a5",
        "name": "test-api",
        "status": "Active"
    }
}

1.1.46.3 - 1.0

get /v1/apis/{api_id}

Description

Show api

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `31e749b7b260868f441e862b`	string	None

Responses

HTTP Code	Description	Schema
200	OK	ApiShowResponse
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.0"

Example HTTP response

Response 200

{
    "api": {
        "account_id": "27bb070b564349f8a31cc60734cc36a5",
        "created_at": "2024-05-17T00:23:17Z",
        "description": "Description",
        "dns_record_status": "Active",
        "id": "27bb070b564349f8a31cc60734cc36a5",
        "name": "test-api",
        "status": "Active"
    }
}

1.1.47 - Show Auth

1.1.47.1 - 1.2

get /v1/apis/{api_id}/auths/{auth_id}

Description

Show auth

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example :	string	None
path	auth_id required	Auth ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	AuthShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/auths/{auth_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.2"

Example HTTP response

Response 200

{
    "auth": {
        "auth_method": "JWT(JSON WEB Token)",
        "connected_stages": [
            "dev,stg"
        ],
        "expired_at": "2024-05-17T00:23:17Z",
        "id": "27bb070b564349f8a31cc60734cc36a5",
        "name": "Token01"
    }
}

1.1.47.2 - 1.1

get /v1/apis/{api_id}/auths/{auth_id}

Description

Show auth

State ACTIVE (DEPRECATED)

Version	Supported Until
1.1	20260430

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example :	string	None
path	auth_id required	Auth ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	AuthShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/auths/{auth_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.1"

Example HTTP response

Response 200

{
    "auth": {
        "auth_method": "JWT(JSON WEB Token)",
        "connected_stages": [
            "dev,stg"
        ],
        "expired_at": "2024-05-17T00:23:17Z",
        "id": "27bb070b564349f8a31cc60734cc36a5",
        "name": "Token01"
    }
}

1.1.47.3 - 1.0

get /v1/apis/{api_id}/auths/{auth_id}

Description

Show auth

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example :	string	None
path	auth_id required	Auth ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	AuthShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/auths/{auth_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.0"

Example HTTP response

Response 200

{
    "auth": {
        "auth_method": "JWT(JSON WEB Token)",
        "connected_stages": [
            "dev,stg"
        ],
        "expired_at": "2024-05-17T00:23:17Z",
        "id": "27bb070b564349f8a31cc60734cc36a5",
        "name": "Token01"
    }
}

1.1.48 - Show Method

1.1.48.1 - 1.2

get /v1/apis/{api_id}/resources/{resource_id}/methods/{method_type}

Description

Show method

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	resource_id required	Resource ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	method_type required	Method Type Example : `GET`	enum (GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS, TRACE, CONNECT)	None

Responses

HTTP Code	Description	Schema
200	OK	MethodShowResponseV1Dot2
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/resources/{resource_id}/methods/{method_type}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.2"

Example HTTP response

Response 200

{
    "method": {
        "api_key_required": false,
        "endpoint_url": "https://127.0.0.1:8000",
        "function_id": "27bb070b564349f8a31cc60734cc36a5",
        "function_name": "test-function",
        "integration_type": "HTTP",
        "method_type": "GET",
        "privatelink_endpoint_id": "27bb070b564349f8a31cc60734cc36a5",
        "query_strings": "{'param1': 'value1', 'param2': 'value2'}",
        "request_headers": "{'test1' : True}",
        "request_path": "{users}",
        "srn": "srn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test"
    }
}

1.1.48.2 - 1.1

get /v1/apis/{api_id}/resources/{resource_id}/methods/{method_type}

Description

Show method

State ACTIVE (DEPRECATED)

Version	Supported Until
1.1	20260430

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	resource_id required	Resource ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	method_type required	Method Type Example : `GET`	enum (GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS, TRACE, CONNECT)	None

Responses

HTTP Code	Description	Schema
200	OK	MethodShowResponseV1Dot1
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/resources/{resource_id}/methods/{method_type}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.1"

Example HTTP response

Response 200

{
    "method": {
        "api_key_required": false,
        "endpoint_url": "https://127.0.0.1:8000",
        "function_id": "27bb070b564349f8a31cc60734cc36a5",
        "function_name": "test-function",
        "integration_type": "HTTP",
        "method_type": "GET",
        "query_strings": "{'param1': 'value1', 'param2': 'value2'}",
        "request_headers": "{'test1' : True}",
        "request_path": "{users}",
        "srn": "srn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test"
    }
}

1.1.48.3 - 1.0

get /v1/apis/{api_id}/resources/{resource_id}/methods/{method_type}

Description

Show method

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	resource_id required	Resource ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	method_type required	Method Type Example : `GET`	enum (GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS, TRACE, CONNECT)	None

Responses

HTTP Code	Description	Schema
200	OK	MethodShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/resources/{resource_id}/methods/{method_type}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.0"

Example HTTP response

Response 200

{
    "method": {
        "endpoint_url": "https://127.0.0.1:8000",
        "function_id": "27bb070b564349f8a31cc60734cc36a5",
        "integration_type": "HTTP",
        "method_type": "GET",
        "query_strings": "{'param1': 'value1', 'param2': 'value2'}",
        "request_headers": "{'test1' : True}",
        "request_path": "{users}",
        "srn": "srn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test"
    }
}

1.1.49 - Show PrivateLink Endpoint

1.1.49.1 - 1.2

get /v1/privatelink-endpoints/{privatelink_endpoint_id}

Description

Show PrivateLink Endpoint

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	privatelink_endpoint_id required	PrivateLink Endpoint ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None

Responses

HTTP Code	Description	Schema
200	OK	PrivateLinkEndpointShowResponse
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/privatelink-endpoints/{privatelink_endpoint_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.2"

Example HTTP response

Response 200

{
    "privatelink_endpoint": {
        "created_at": "2024-05-17T00:23:17Z",
        "description": "description",
        "id": "27bb070b564349f8a31cc60734cc36a5",
        "name": "endpoint",
        "privatelink_service_id": "27bb070b564349f8a31cc60734cc36a5",
        "status": "CANCELED"
    }
}

1.1.50 - Show Resource

1.1.50.1 - 1.2

get /v1/apis/{api_id}/resources/{resource_id}

Description

Show resource

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	resource_id required	Resource ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None

Responses

HTTP Code	Description	Schema
200	OK	ResourceShowResponseV1Dot2
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/resources/{resource_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.2"

Example HTTP response

Response 200

{
    "resource": {
        "id": "27bb070b564349f8a31cc60734cc36a5",
        "methods": [
            {
                "api_key_required": false,
                "endpoint_url": "https://127.0.0.1:8000",
                "function_id": "27bb070b564349f8a31cc60734cc36a5",
                "function_name": "test-function",
                "integration_type": "HTTP",
                "method_type": "GET",
                "privatelink_endpoint_id": "27bb070b564349f8a31cc60734cc36a5",
                "query_strings": "{'param1': 'value1', 'param2': 'value2'}",
                "request_headers": "{'test1' : True}",
                "request_path": "{users}",
                "srn": "srn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test"
            }
        ],
        "parent_id": "27bb070b564349f8a31cc60734cc36a5",
        "path": "/test/test1",
        "path_part": "test"
    }
}

1.1.50.2 - 1.1

get /v1/apis/{api_id}/resources/{resource_id}

Description

Show resource

State ACTIVE (DEPRECATED)

Version	Supported Until
1.1	20260430

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	resource_id required	Resource ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None

Responses

HTTP Code	Description	Schema
200	OK	ResourceShowResponseV1Dot1
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/resources/{resource_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.1"

Example HTTP response

Response 200

{
    "resource": {
        "id": "27bb070b564349f8a31cc60734cc36a5",
        "methods": [
            {
                "api_key_required": false,
                "endpoint_url": "https://127.0.0.1:8000",
                "function_id": "27bb070b564349f8a31cc60734cc36a5",
                "function_name": "test-function",
                "integration_type": "HTTP",
                "method_type": "GET",
                "query_strings": "{'param1': 'value1', 'param2': 'value2'}",
                "request_headers": "{'test1' : True}",
                "request_path": "{users}",
                "srn": "srn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test"
            }
        ],
        "parent_id": "27bb070b564349f8a31cc60734cc36a5",
        "path": "/test/test1",
        "path_part": "test"
    }
}

1.1.50.3 - 1.0

get /v1/apis/{api_id}/resources/{resource_id}

Description

Show resource

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	resource_id required	Resource ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None

Responses

HTTP Code	Description	Schema
200	OK	ResourceShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/resources/{resource_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.0"

Example HTTP response

Response 200

{
    "resource": {
        "id": "27bb070b564349f8a31cc60734cc36a5",
        "methods": [
            {
                "endpoint_url": "https://127.0.0.1:8000",
                "function_id": "27bb070b564349f8a31cc60734cc36a5",
                "integration_type": "HTTP",
                "method_type": "GET",
                "query_strings": "{'param1': 'value1', 'param2': 'value2'}",
                "request_headers": "{'test1' : True}",
                "request_path": "{users}",
                "srn": "srn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test"
            }
        ],
        "parent_id": "27bb070b564349f8a31cc60734cc36a5",
        "path": "/test/test1",
        "path_part": "test"
    }
}

1.1.51 - Show Stage

1.1.51.1 - 1.2

get /v1/apis/{api_id}/stages/{stage_name}

Description

Show stage

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	stage_name required	Stage Name Example : `test-stage`	string	None
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None

Responses

HTTP Code	Description	Schema
200	OK	StageShowResponseV1Dot1
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/stages/{stage_name}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.2"

Example HTTP response

Response 200

{
    "stage": {
        "active_deployment": "2024-05-17T00:23:17Z",
        "allow_credentials": true,
        "allow_headers": [
            "Content-Type",
            "Authorization"
        ],
        "allow_methods": [
            "GET",
            "POST",
            "PUT",
            "PATCH"
        ],
        "allow_origins": [
            "*"
        ],
        "api_id": "27bb070b564349f8a31cc60734cc36a5",
        "api_key_required": false,
        "cors_enabled": false,
        "created_at": "2026-02-11T06:40:17.418Z",
        "deployment_id": "27bb070b564349f8a31cc60734cc36a5",
        "description": "description",
        "expose_headers": [
            "test1",
            "test2"
        ],
        "invoke_url": "http://test.com/stg",
        "jwt_enabled": false,
        "max_age": 3600,
        "name": "test-stage",
        "usage_plan_api_keys": [],
        "usage_plan_id": "27bb070b564349f8a31cc60734cc36a5",
        "usage_plan_limit": 10,
        "usage_plan_name": "usage-plan-name",
        "usage_plan_rate": "day"
    }
}

1.1.51.2 - 1.1

get /v1/apis/{api_id}/stages/{stage_name}

Description

Show stage

State ACTIVE (DEPRECATED)

Version	Supported Until
1.1	20260430

Parameters

Type	Name	Description	Schema	Default
path	stage_name required	Stage Name Example : `test-stage`	string	None
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None

Responses

HTTP Code	Description	Schema
200	OK	StageShowResponseV1Dot1
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/stages/{stage_name}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.1"

Example HTTP response

Response 200

{
    "stage": {
        "active_deployment": "2024-05-17T00:23:17Z",
        "allow_credentials": true,
        "allow_headers": [
            "Content-Type",
            "Authorization"
        ],
        "allow_methods": [
            "GET",
            "POST",
            "PUT",
            "PATCH"
        ],
        "allow_origins": [
            "*"
        ],
        "api_id": "27bb070b564349f8a31cc60734cc36a5",
        "api_key_required": false,
        "cors_enabled": false,
        "created_at": "2026-02-11T06:40:16.382Z",
        "deployment_id": "27bb070b564349f8a31cc60734cc36a5",
        "description": "description",
        "expose_headers": [
            "test1",
            "test2"
        ],
        "invoke_url": "http://test.com/stg",
        "jwt_enabled": false,
        "max_age": 3600,
        "name": "test-stage",
        "usage_plan_api_keys": [],
        "usage_plan_id": "27bb070b564349f8a31cc60734cc36a5",
        "usage_plan_limit": 10,
        "usage_plan_name": "usage-plan-name",
        "usage_plan_rate": "day"
    }
}

1.1.51.3 - 1.0

get /v1/apis/{api_id}/stages/{stage_name}

Description

Show stage

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	stage_name required	Stage Name Example : `test-stage`	string	None
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None

Responses

HTTP Code	Description	Schema
200	OK	StageShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/stages/{stage_name}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.0"

Example HTTP response

Response 200

{
    "stage": {
        "active_deployment": "2024-05-17T00:23:17Z",
        "allow_credentials": true,
        "allow_headers": [
            "Content-Type",
            "Authorization"
        ],
        "allow_methods": [
            "GET",
            "POST",
            "PUT",
            "PATCH"
        ],
        "allow_origins": [
            "*"
        ],
        "api_id": "27bb070b564349f8a31cc60734cc36a5",
        "cors_enabled": false,
        "created_at": "2026-02-11T06:40:15.611Z",
        "deployment_id": "27bb070b564349f8a31cc60734cc36a5",
        "expose_headers": [
            "test1",
            "test2"
        ],
        "invoke_url": "http://test.com/stg",
        "ip_restriction_enabled": false,
        "jwt_enabled": false,
        "max_age": 3600,
        "name": "test-stage"
    }
}

1.1.52 - Show Usage Plan

1.1.52.1 - 1.2

get /v1/apis/{api_id}/usage-plans/{usage_plan_id}

Description

Show usage plan

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	usage_plan_id required	Usage Plan ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None

Responses

HTTP Code	Description	Schema
200	OK	UsagePlanShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/usage-plans/{usage_plan_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.2"

Example HTTP response

Response 200

{
    "usage_plan": {
        "api_keys": [],
        "created_at": "2026-02-11T06:40:17.531Z",
        "created_by_id": "27bb070b564349f8a31cc60734cc36a5",
        "created_by_name": "username",
        "description": "description",
        "id": "27bb070b564349f8a31cc60734cc36a5",
        "limit": 10,
        "modified_at": "2026-02-11T06:40:17.531Z",
        "modified_by_id": "27bb070b564349f8a31cc60734cc36a5",
        "modified_by_name": "username",
        "name": "usage-plan-name",
        "rate": "day"
    }
}

1.1.52.2 - 1.1

get /v1/apis/{api_id}/usage-plans/{usage_plan_id}

Description

Show usage plan

State ACTIVE (DEPRECATED)

Version	Supported Until
1.1	20260430

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	usage_plan_id required	Usage Plan ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None

Responses

HTTP Code	Description	Schema
200	OK	UsagePlanShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/apis/{api_id}/usage-plans/{usage_plan_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = apigateway 1.1"

Example HTTP response

Response 200

{
    "usage_plan": {
        "api_keys": [],
        "created_at": "2026-02-11T06:40:16.497Z",
        "created_by_id": "27bb070b564349f8a31cc60734cc36a5",
        "created_by_name": "username",
        "description": "description",
        "id": "27bb070b564349f8a31cc60734cc36a5",
        "limit": 10,
        "modified_at": "2026-02-11T06:40:16.498Z",
        "modified_by_id": "27bb070b564349f8a31cc60734cc36a5",
        "modified_by_name": "username",
        "name": "usage-plan-name",
        "rate": "day"
    }
}

1.2 - Models

1.2.1 - AccessControl

Name	Description	Schema
allowed_ip_addr required	Allowed IP Address Example : `['127.0.0.1/24,192.168.127.12']`	array[string]
connected_stages required	Connected Stages Example : `['dev,stg']`	array[string]
created_at required	Creation Date Example : `2024-05-19T00:23:17Z`	string (date-time)
description required	Description Example :	string
id required	Access Control ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
name required	Access Control Name Example : `DenyTest`	string

1.2.2 - AccessControlCreateRequest

Name	Description	Schema
allowed_ip_addr required	Allowed IP Address Example : `['127.0.0.1/24,192.168.127.12']`	array[string]
connected_stages required	Connected Stages Example : `['dev,stg']`	any of [array[string], null]
description optional	Description Example : `description`	any of [string, null]
name required	Access Control Name Example : `DenyTest` Pattern : `^[a-z][a-z0-9\-]{1,48}[a-z0-9]$` Minimum length : `3` Maximum length : `50`	string

1.2.3 - AccessControlCreateResponse

Name	Description	Schema
allowed_ip_addr required	Allowed IP Address Example : `['127.0.0.1/24,192.168.127.12']`	array[string]
connected_stages required	Connected Stages Example : `['dev,stg']`	array[string]
created_at required	Creation Date Example : `2024-05-19T00:23:17Z`	string (date-time)
description required	Description Example :	string
id required	Access Control ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
name required	Access Control Name Example : `DenyTest`	string

1.2.4 - AccessControlListResponse

Name	Description	Schema	Default
access_controls required		array[AccessControl]
count required	Total Count Example : `20`	integer

1.2.5 - AccessControlSetRequest

Name	Description	Schema
allowed_ip_addr required	Allowed IP Address Example : `['127.0.0.1/24,192.168.127.12']`	array[string]
connected_stages required	Connected Stages Example : `['dev,stg']`	any of [array[string], null]
description optional	Description Example : `description`	any of [string, null]

1.2.6 - AccessControlShowResponse

Name	Description	Schema	Default
access_control required		AccessControl

1.2.7 - Api

Name	Description	Schema
account_id required	Account ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
created_at required	Creation Date Example : `2024-05-17T00:23:17Z`	string (date-time)
description required	Description Example : `Description`	string
dns_record_status optional	DNS Record Status Example : `Active`	any of [string, null]
id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
name required	Name Example : `test-api`	string
status required	Api Status Example : `Active`	string

1.2.8 - ApiConnectedEndpoint

Name	Description	Schema
created_at required	Creation Date Example : `2024-05-17T00:23:17Z`	string (date-time)
id required	PrivateLink Endpoint ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
status required	PrivateLink Endpoint Status Example : `Active`	string

1.2.9 - ApiConnectedEndpointListResponse

Name	Description	Schema	Default
connected_endpoints required		array[ApiConnectedEndpoint]
count required	Total Count Example : `20`	integer

1.2.10 - ApiCreateRequest

Name	Description	Schema
description optional	Description Example : `description`	any of [string, null]
id optional	Api ID Example :	any of [string, null]
name required	Name Example : `test-api` Pattern : `^[a-z][a-z0-9\-]{1,48}[a-z0-9]$` Minimum length : `3` Maximum length : `50`	string
tags optional	Tag List	any of [array[Tag], null]

1.2.11 - ApiCreateRequestV1Dot2

Name	Description	Schema	Default
description optional	Description Example : `description`	any of [string, null]
endpoint_type optional	Endpoint Type Example : `REGION`	enum (REGION, PRIVATE)	REGION
id optional	Api ID Example :	any of [string, null]
name required	Name Example : `test-api` Pattern : `^[a-z][a-z0-9\-]{1,48}[a-z0-9]$` Minimum length : `3` Maximum length : `50`	string
tags optional	Tag List	any of [array[Tag], null]

1.2.12 - ApiCreateResponse

Name	Description	Schema
description required	Description Example : `Description`	string
id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
name required	Name Example : `test-api`	string

1.2.13 - ApiDeployment

Name	Description	Schema	Default
deployment_date required	Deployment Date Example : `2024-05-17T00:23:17Z`	string (date-time)
deployment_id required	Deployment ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
description required	Description Example : `description`	string
status optional	Status Example : `Active`	string	-

1.2.14 - ApiDeploymentListResponse

Name	Description	Schema	Default
count required	Total Count Example : `20`	integer
deployments required		array[ApiDeployment]

1.2.15 - ApiDeploymentRequest

Name	Description	Schema
description optional	Description Example : `description`	any of [string, null]
stage_name optional	Stage Name Example : `test-stage`	any of [string, null]
stage_type required	Stage Type Example : `new`	enum (new, existing, none)

1.2.16 - ApiDeploymentResponse

Name	Description	Schema	Default
deployment_id required	Deployment ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
description optional	Description Example : `description`	any of [string, null]

1.2.17 - ApiDetail

Name	Description	Schema
account_id required	Account ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
created_at required	Creation Date Example : `2024-05-17T00:23:17Z`	string (date-time)
description required	Description Example : `Description`	string
dns_record_status optional	DNS Record Status Example : `Active`	any of [string, null]
id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
name required	Name Example : `test-api`	string
status required	Api Status Example : `Active`	string

1.2.18 - ApiKey

Name	Description	Schema
created_at required	Creation Date Example :	string (date-time)
description optional	Description Example : `description`	string
id required	API Key ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
key required	Key Example : `key`	string
name required	Name Example : `api-key-name`	string

1.2.19 - ApiKeyCreateRequest

Name	Description	Schema	Default
description optional	Description Example : `description`	any of [string, null]
name required	Name Example : `api-key-name` Pattern : `^[a-z][a-z0-9\-]{1,48}[a-z0-9]$` Minimum length : `3` Maximum length : `50`	string

1.2.20 - ApiKeyInStage

Name	Description	Schema	Default
id required	API Key ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
name required	Name Example : `api-key-name`	string

1.2.21 - ApiKeyListResponse

Name	Description	Schema	Default
api_keys required		array[ApiKey]
count required	Total Count Example : `20`	integer

1.2.22 - ApiKeySetDescriptionRequest

Name	Description	Schema	Default
description optional	Description Example : `description`	any of [string, null]

1.2.23 - ApiKeyShowResponse

Name	Description	Schema	Default
api_key required		ApiKey

1.2.24 - ApiListResponse

Name	Description	Schema	Default
apis required		array[Api]
count required	Total Count Example : `20`	integer

1.2.25 - ApiSetDescriptionRequest

Name	Description	Schema	Default
description optional	Description Example : `description`	any of [string, null]

1.2.26 - ApiShowResponse

Name	Description	Schema	Default
api required		ApiDetail

1.2.27 - Auth

Name	Description	Schema	Default
auth_method optional	AUTH Method Example : `JWT(JSON WEB Token)`	string	JWT(JSON WEB Token)
connected_stages required	Connected Stages Example : `['dev,stg']`	array[string]
expired_at required	Expiration Date Example : `2024-05-17T00:23:17Z`	string (date-time)
id required	Auth ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
name required	Auth NAME Example : `Token01`	string

1.2.28 - AuthCreateRequest

Name	Description	Schema
connected_stages required	Connected Stages Example : `['dev,stg']`	any of [array[string], null]
expiration_period required	Expiration Period Example : `90`	integer
name required	Auth NAME Example : `Token01` Pattern : `^[a-z][a-z0-9\-]{1,48}[a-z0-9]$` Minimum length : `3` Maximum length : `50`	string

1.2.29 - AuthCreateResponse

Name	Description	Schema	Default
access_token required	Access Token Example : `***********************************************************`	string

1.2.30 - AuthListResponse

Name	Description	Schema	Default
auths required		array[Auth]
count required	Total Count Example : `20`	integer

1.2.31 - AuthSetRequest

Name	Description	Schema	Default
connected_stages required	Connected Stages Example : `['dev,stg']`	any of [array[string], null]

1.2.32 - AuthShowResponse

Name	Description	Schema	Default
auth required		Auth

1.2.33 - Method

Name	Description	Schema
endpoint_url optional	Method Endpoint URL Example : `https://127.0.0.1:8000`	any of [string, null]
function_id optional	Cloud Function ID Example : `27bb070b564349f8a31cc60734cc36a5`	any of [string, null]
integration_type required	Method Integration Type Example : `HTTP`	string
method_type required	Method Type Example : `GET`	string
query_strings optional	Method Query Strings Example : `{'param1': 'value1', 'param2': 'value2'}`	any of [object[boolean], null]
request_headers optional	Method Request Headers Example : `{'test1' : True}`	any of [object[boolean], null]
request_path optional	Method Request Path Example : `{users}`	any of [array[object], null]
srn required	SRN Example : `srn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test`	string

1.2.34 - MethodCreateRequest

Name	Description	Schema
api_key_required optional	Api Key Required Example : `False`	any of [boolean, null]
endpoint_url optional	Method Endpoint URL Example : `https://127.0.0.1:8000`	any of [string, null]
function_id optional	Cloud Function ID Example : `27bb070b564349f8a31cc60734cc36a5`	any of [string, null]
integration_type required	Method Integration Type Example : `HTTP`	enum (HTTP, SCF, PRIVATELINK)
method_type required	Method Type Example : `GET`	enum (GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS, ANY)
privatelink_endpoint_id optional	PrivateLink Endpoint ID Example : `27bb070b564349f8a31cc60734cc36a5`	any of [string, null]
query_strings optional	Method Query Strings Example : `{'param1': 'value1', 'param2': 'value2'}`	any of [object[boolean], null]
request_headers optional	Method Request Headers Example : `{'test1' : True}`	any of [object[boolean], null]

1.2.35 - MethodCreateRequestV1Dot1

Name	Description	Schema
api_key_required optional	Api Key Required Example : `False`	any of [boolean, null]
endpoint_url optional	Method Endpoint URL Example : `https://127.0.0.1:8000`	any of [string, null]
function_id optional	Cloud Function ID Example : `27bb070b564349f8a31cc60734cc36a5`	any of [string, null]
integration_type required	Method Integration Type Example : `HTTP`	enum (HTTP, SCF, PRIVATELINK)
method_type required	Method Type Example : `GET`	enum (GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS, ANY)
privatelink_endpoint_id optional	PrivateLink Endpoint ID Example : `27bb070b564349f8a31cc60734cc36a5`	any of [string, null]
query_strings optional	Method Query Strings Example : `{'param1': 'value1', 'param2': 'value2'}`	any of [object[boolean], null]
request_headers optional	Method Request Headers Example : `{'test1' : True}`	any of [object[boolean], null]

1.2.36 - MethodInStage

Name	Description	Schema	Default
api_key_required optional	Api Key Required Example : `False`	boolean
type required	Method Type Example : `GET`	string

1.2.37 - MethodListResponse

Name	Description	Schema	Default
methods required		array[Method]

1.2.38 - MethodListResponseV1Dot1

Name	Description	Schema	Default
methods required		array[MethodV1Dot1]

1.2.39 - MethodListResponseV1Dot2

Name	Description	Schema	Default
methods required		array[MethodV1Dot2]

1.2.40 - MethodSetRequest

Name	Description	Schema	Default
query_strings required	Method Query Strings Example : `{'param1': 'value1', 'param2': 'value2'}`	object[boolean]
request_headers required	Method Request Headers Example : `{'test1' : True}`	object[boolean]

1.2.41 - MethodSetRequestV1Dot1

Name	Description	Schema
api_key_required required	Api Key Required Example : `False`	boolean
endpoint_url optional	Method Endpoint URL Example : `https://127.0.0.1:8000`	any of [string, null]
function_id optional	Cloud Function ID Example : `27bb070b564349f8a31cc60734cc36a5`	any of [string, null]
integration_type required	Method Integration Type Example : `HTTP`	enum (HTTP, SCF, PRIVATELINK)
privatelink_endpoint_id optional	PrivateLink Endpoint ID Example : `27bb070b564349f8a31cc60734cc36a5`	any of [string, null]
query_strings required	Method Query Strings Example : `{'param1': 'value1', 'param2': 'value2'}`	object[boolean]
request_headers required	Method Request Headers Example : `{'test1' : True}`	object[boolean]

1.2.42 - MethodShowResponse

Name	Description	Schema	Default
method required		Method

1.2.43 - MethodShowResponseV1Dot1

Name	Description	Schema	Default
method required		MethodV1Dot1

1.2.44 - MethodShowResponseV1Dot2

Name	Description	Schema	Default
method required		MethodV1Dot2

1.2.45 - MethodV1Dot1

Name	Description	Schema
api_key_required optional	Api Key Required Example : `False`	boolean
endpoint_url optional	Method Endpoint URL Example : `https://127.0.0.1:8000`	any of [string, null]
function_id optional	Cloud Function ID Example : `27bb070b564349f8a31cc60734cc36a5`	any of [string, null]
function_name optional	Cloud Function Name Example : `test-function`	any of [string, null]
integration_type required	Method Integration Type Example : `HTTP`	string
method_type required	Method Type Example : `GET`	string
query_strings optional	Method Query Strings Example : `{'param1': 'value1', 'param2': 'value2'}`	any of [object[boolean], null]
request_headers optional	Method Request Headers Example : `{'test1' : True}`	any of [object[boolean], null]
request_path optional	Method Request Path Example : `{users}`	any of [array[object], null]
srn required	SRN Example : `srn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test`	string

1.2.46 - MethodV1Dot2

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

1.2.47 - PrivateLinkEndpoint

Name	Description	Schema
created_at required	Creation Date Example : `2024-05-17T00:23:17Z`	string (date-time)
id required	PrivateLink Endpoint ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
name required	PrivateLink Endpoint Name Example : `endpoint`	string
privatelink_service_id required	PrivateLink Service ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
status required	PrivateLink Endpoint Status Example : `CANCELED`	string

1.2.48 - PrivateLinkEndpointApprovalRequest

Name	Description	Schema	Default
api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
type required	PrivateLink Endpoint Action Type Example : `CANCEL`	enum (APPROVE, REJECT)

1.2.49 - PrivateLinkEndpointConnectionRequest

Name	Description	Schema	Default
api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
type required	PrivateLink Endpoint Action Type Example : `CANCEL`	enum (DISCONNECT, RECONNECT)

1.2.50 - PrivateLinkEndpointCreateRequest

Name	Description	Schema
description optional	Description Example : `description`	any of [string, null]
name required	PrivateLink Endpoint Name Example : `endpoint` Pattern : `^[a-zA-Z0-9]$` Minimum length* : `3` Maximum length : `20`	string
privatelink_service_id required	PrivateLink Service ID Example : `27bb070b564349f8a31cc60734cc36a5`	string

1.2.51 - PrivateLinkEndpointDetail

Name	Description	Schema
created_at required	Creation Date Example : `2024-05-17T00:23:17Z`	string (date-time)
description optional	Description Example : `description`	string
id required	PrivateLink Endpoint ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
name required	PrivateLink Endpoint Name Example : `endpoint`	string
privatelink_service_id required	PrivateLink Service ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
status required	PrivateLink Endpoint Status Example : `CANCELED`	string

1.2.52 - PrivateLinkEndpointListResponse

Name	Description	Schema	Default
count required	Total Count Example : `20`	integer
privatelink_endpoints required		array[PrivateLinkEndpoint]

1.2.53 - PrivateLinkEndpointRequestRequest

Name	Description	Schema	Default
type required	PrivateLink Endpoint Action Type Example : `CANCEL`	enum (CANCEL, RE_REQUEST)

1.2.54 - PrivateLinkEndpointSetRequest

Name	Description	Schema	Default
description optional	Description Example : `description`	any of [string, null]

1.2.55 - PrivateLinkEndpointShowResponse

Name	Description	Schema	Default
privatelink_endpoint required		PrivateLinkEndpointDetail

1.2.56 - PrivateLinkEndpointSummary

Name	Description	Schema
created_at required	Creation Date Example : `2024-05-17T00:23:17Z`	string (date-time)
id required	PrivateLink Endpoint ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
status required	PrivateLink Endpoint Status Example : `Active`	string

1.2.57 - PrivateLinkEndpointSummaryShowResponse

Name	Description	Schema	Default
privatelink_endpoint required		PrivateLinkEndpointSummary

1.2.58 - Report

Name	Description	Schema
call_count required	Call Count Example : `10`	integer
date required	Date Example :	string
error_4xx_count required	Error 4xx Count Example : `10`	integer
error_5xx_count optional	Error 5xx Count Example : `10`	integer
integration_latency required	Integration Latency Example : `10`	object
latency required	Latency Example : `10`	object

1.2.59 - ReportListResponse

Name	Description	Schema
count required	Total Count Example : `20`	integer
reports required		array[Report]
top_resources required		array[TopResource]

1.2.60 - Resource

Name	Description	Schema
id required	Resource ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
methods required		array[Method]
parent_id required	Parent Resource ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
path required	Path Example : `/test/test1`	string
path_part required	Path Part Example : `test`	string

1.2.61 - ResourceCreateRequest

Name	Description	Schema	Default
path_part required	Path Part Example : `test` Pattern : `^(\{[a-z][a-z0-9\-]{1,46}[a-z0-9]\}\|[a-z][a-z0-9\-]{1,48}[a-z0-9])$` Minimum length : `3` Maximum length : `50`	string

1.2.62 - ResourceCreateResponse

Name	Description	Schema
api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
id required	Resource ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
parent_id required	Parent Resource ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
path required	Path Example :	string

1.2.63 - ResourceListResponse

Name	Description	Schema	Default
resources required		array[Resource]

1.2.64 - ResourceListResponseV1Dot1

Name	Description	Schema	Default
resources required		array[ResourceV1Dot1]

1.2.65 - ResourceListResponseV1Dot2

Name	Description	Schema	Default
resources required		array[ResourceV1Dot2]

1.2.66 - ResourceShowResponse

Name	Description	Schema	Default
resource required		Resource

1.2.67 - ResourceShowResponseV1Dot1

Name	Description	Schema	Default
resource required		ResourceV1Dot1

1.2.68 - ResourceShowResponseV1Dot2

Name	Description	Schema	Default
resource required		ResourceV1Dot2

1.2.69 - ResourceSummary

Name	Description	Schema	Default
methods required	Method Type Example : `GET`	array[string]
path required	Path Example : `/test/test1`	string

1.2.70 - ResourceSummaryV1Dot1

Name	Description	Schema	Default
methods required		array[MethodInStage]
path required	Path Example : `/test/test1`	string

1.2.71 - ResourceV1Dot1

Name	Description	Schema
id required	Resource ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
methods required		array[MethodV1Dot1]
parent_id required	Parent Resource ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
path required	Path Example : `/test/test1`	string
path_part required	Path Part Example : `test`	string

1.2.72 - ResourceV1Dot2

Name	Description	Schema
id required	Resource ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
methods required		array[MethodV1Dot2]
parent_id required	Parent Resource ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
path required	Path Example : `/test/test1`	string
path_part required	Path Part Example : `test`	string

1.2.73 - Stage

Name	Description	Schema
active_deployment required	Active Deployment Example : `2024-05-17T00:23:17Z`	string (date-time)
allow_credentials optional	Allow Credentials Example : `True`	any of [boolean, null]
allow_headers optional	Allow Headers Example : `['Content-Type', 'Authorization']`	any of [array[string], null]
allow_methods optional	Allow Methods Example : `['GET', 'POST', 'PUT', 'PATCH']`	any of [array[enum (GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS, ANY)], null]
allow_origins optional	Allow Origins Example : `['*']`	any of [array[string], null]
api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
api_summary required	API Summary Example : `[{'methods': ['GET', 'POST'], 'path': '/'}, {'methods': ['GET', 'POST'], 'path': '/test'}]`	array[ResourceSummary]
cors_enabled required	Cors Enabled Example : `False`	boolean
created_at required	Creation Date Example :	string (date-time)
deployment_id required	Deployment ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
expose_headers optional	Expose Headers Example : `['test1', 'test2']`	any of [array[string], null]
invoke_url required	Invoke URL Example : `http://test.com/stg`	string
ip_restriction_enabled required	IP Restriction Enabled Example : `False`	boolean
jwt_enabled required	JWT Enabled Example : `False`	boolean
max_age optional	Max Age Example : `3600`	any of [integer, null]
name required	Stage Name Example : `test-stage`	string

1.2.74 - StageCreateRequest

Name	Description	Schema
deployment_id required	Deployment ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
description optional	Description Example : `description`	any of [string, null]
stage_name required	Name Example : `test-stage` Pattern : `^[a-z][a-z0-9\-]{1,48}[a-z0-9]$` Minimum length : `3` Maximum length : `50`	string

1.2.75 - StageDetail

Name	Description	Schema
active_deployment required	Active Deployment Example : `2024-05-17T00:23:17Z`	string (date-time)
allow_credentials optional	Allow Credentials Example : `True`	any of [boolean, null]
allow_headers optional	Allow Headers Example : `['Content-Type', 'Authorization']`	any of [array[string], null]
allow_methods optional	Allow Methods Example : `['GET', 'POST', 'PUT', 'PATCH']`	any of [array[enum (GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS, ANY)], null]
allow_origins optional	Allow Origins Example : `['*']`	any of [array[string], null]
api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
cors_enabled required	Cors Enabled Example : `False`	boolean
created_at required	Creation Date Example :	string (date-time)
deployment_id required	Deployment ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
expose_headers optional	Expose Headers Example : `['test1', 'test2']`	any of [array[string], null]
invoke_url required	Invoke URL Example : `http://test.com/stg`	string
ip_restriction_enabled required	IP Restriction Enabled Example : `False`	boolean
jwt_enabled required	JWT Enabled Example : `False`	boolean
max_age optional	Max Age Example : `3600`	any of [integer, null]
name required	Stage Name Example : `test-stage`	string

1.2.76 - StageDetailV1Dot1

Name	Description	Schema
active_deployment required	Active Deployment Example : `2024-05-17T00:23:17Z`	string (date-time)
allow_credentials optional	Allow Credentials Example : `True`	any of [boolean, null]
allow_headers optional	Allow Headers Example : `['Content-Type', 'Authorization']`	any of [array[string], null]
allow_methods optional	Allow Methods Example : `['GET', 'POST', 'PUT', 'PATCH']`	any of [array[enum (GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS, ANY)], null]
allow_origins optional	Allow Origins Example : `['*']`	any of [array[string], null]
api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
api_key_required required	Api Key Required Example : `False`	boolean
cors_enabled required	Cors Enabled Example : `False`	boolean
created_at required	Creation Date Example :	string (date-time)
deployment_id required	Deployment ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
description optional	Description Example : `description`	any of [string, null]
expose_headers optional	Expose Headers Example : `['test1', 'test2']`	any of [array[string], null]
invoke_url required	Invoke URL Example : `http://test.com/stg`	string
jwt_enabled required	JWT Enabled Example : `False`	boolean
max_age optional	Max Age Example : `3600`	any of [integer, null]
name required	Stage Name Example : `test-stage`	string
usage_plan_api_keys optional	API Keys	any of [array[ApiKeyInStage], null]
usage_plan_id optional	Usage Plan ID Example : `27bb070b564349f8a31cc60734cc36a5`	any of [string, null]
usage_plan_limit optional	Usage Plan Limit Example : `10`	any of [integer, null]
usage_plan_name optional	Name Example : `usage-plan-name`	any of [string, null]
usage_plan_rate optional	Usage Plan Rate Example : `day`	any of [enum (hour, day, month), null]

1.2.77 - StageListResponse

Name	Description	Schema	Default
stages required		array[Stage]

1.2.78 - StageListResponseV1Dot1

Name	Description	Schema	Default
stages required		array[StageV1Dot1]

1.2.79 - StageSetActiveDeploymentRequest

Name	Description	Schema	Default
deployment_id required	Deployment ID Example : `27bb070b564349f8a31cc60734cc36a5`	string

1.2.80 - StageSetConfigRequest

Name	Description	Schema
allow_credentials optional	Allow Credentials Example : `True`	any of [boolean, null]
allow_headers optional	Allow Headers Example : `['Content-Type', 'Authorization']`	any of [array[string], null]
allow_methods optional	Allow Methods Example : `['GET', 'POST', 'PUT', 'PATCH']`	any of [array[enum (GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS, ANY)], null]
allow_origins optional	Allow Origins Example : `['*']`	any of [array[string], null]
cors_enabled required	Cors Enabled Example : `False`	boolean
expose_headers optional	Expose Headers Example : `['test1', 'test2']`	any of [array[string], null]
ip_restriction_enabled required	IP Restriction Enabled Example : `False`	boolean
jwt_enabled required	JWT Enabled Example : `False`	boolean
max_age optional	Max Age Example : `3600`	any of [integer, null]

1.2.81 - StageSetConfigRequestV1Dot1

Name	Description	Schema
allow_credentials optional	Allow Credentials Example : `True`	any of [boolean, null]
allow_headers optional	Allow Headers Example : `['Content-Type', 'Authorization']`	any of [array[string], null]
allow_methods optional	Allow Methods Example : `['GET', 'POST', 'PUT', 'PATCH']`	any of [array[enum (GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS, ANY)], null]
allow_origins optional	Allow Origins Example : `['*']`	any of [array[string], null]
connected_api_keys optional	Connected API Keys Example : `['key1', 'key2']`	any of [array[string], null]
cors_enabled required	Cors Enabled Example : `False`	boolean
description optional	Description Example : `description`	any of [string, null]
expose_headers optional	Expose Headers Example : `['test1', 'test2']`	any of [array[string], null]
jwt_enabled required	JWT Enabled Example : `False`	boolean
max_age optional	Max Age Example : `3600`	any of [integer, null]
usage_plan_id optional	Usage Plan ID Example : `27bb070b564349f8a31cc60734cc36a5`	any of [string, null]

1.2.82 - StageShowResponse

Name	Description	Schema	Default
stage required		StageDetail

1.2.83 - StageShowResponseV1Dot1

Name	Description	Schema	Default
stage required		StageDetailV1Dot1

1.2.84 - StageV1Dot1

Name	Description	Schema
active_deployment required	Active Deployment Example : `2024-05-17T00:23:17Z`	string (date-time)
allow_credentials optional	Allow Credentials Example : `True`	any of [boolean, null]
allow_headers optional	Allow Headers Example : `['Content-Type', 'Authorization']`	any of [array[string], null]
allow_methods optional	Allow Methods Example : `['GET', 'POST', 'PUT', 'PATCH']`	any of [array[enum (GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS, ANY)], null]
allow_origins optional	Allow Origins Example : `['*']`	any of [array[string], null]
api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
api_key_required required	Api Key Required Example : `False`	boolean
api_summary required	API Summary Example : `[{'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'}]`	array[ResourceSummaryV1Dot1]
cors_enabled required	Cors Enabled Example : `False`	boolean
created_at required	Creation Date Example :	string (date-time)
deployment_id required	Deployment ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
description optional	Description Example : `description`	any of [string, null]
expose_headers optional	Expose Headers Example : `['test1', 'test2']`	any of [array[string], null]
invoke_url required	Invoke URL Example : `http://test.com/stg`	string
jwt_enabled required	JWT Enabled Example : `False`	boolean
max_age optional	Max Age Example : `3600`	any of [integer, null]
name required	Stage Name Example : `test-stage`	string
usage_plan_api_keys optional	API Keys	any of [array[ApiKeyInStage], null]
usage_plan_id optional	Usage Plan ID Example : `27bb070b564349f8a31cc60734cc36a5`	any of [string, null]
usage_plan_limit optional	Usage Plan Limit Example : `10`	any of [integer, null]
usage_plan_name optional	Name Example : `usage-plan-name`	any of [string, null]
usage_plan_rate optional	Usage Plan Rate Example : `day`	any of [enum (hour, day, month), null]

1.2.85 - Tag

Name	Description	Schema	Default
key required	tag key Example : `key`	string
value required	tag value Example : `value`	string

1.2.86 - TopResource

Name	Description	Schema
call_count required	Call Count Example : `10`	integer
name required	Resource Name Example : `test`	string
path required	Resource Path Example : `/test/test1`	string
type required	Method Type Example : `GET`	string

1.2.87 - UsagePlan

Name	Description	Schema
connected_api_keys required	Connected API Keys Example : `['key1', 'key2']`	array[string]
created_at required	Creation Date Example :	string (date-time)
description optional	Description Example : `description`	string
id required	Usage Plan ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
limit required	Usage Plan Limit Example : `10`	integer
name required	Name Example : `usage-plan-name`	string
rate required	Usage Plan Rate Example : `day`	enum (hour, day, month)

1.2.88 - UsagePlanCreateRequest

Name	Description	Schema
description optional	Description Example : `description`	any of [string, null]
limit required	Usage Plan Limit Example : `10` Minimum : `1` Maximum : `2000000000`	integer
name required	Name Example : `usage-plan-name` Pattern : `^[a-z][a-z0-9\-]{1,48}[a-z0-9]$` Minimum length : `3` Maximum length : `50`	string
rate required	Usage Plan Rate Example : `day`	enum (hour, day, month)

1.2.89 - UsagePlanDetail

Name	Description	Schema
api_keys required	API Keys	array[ApiKey]
created_at required	Creation Date Example :	string (date-time)
created_by_id required	Created by Example : `27bb070b564349f8a31cc60734cc36a5`	string
created_by_name required	Created by Example : `username`	string
description optional	Description Example : `description`	string
id required	Usage Plan ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
limit required	Usage Plan Limit Example : `10`	integer
modified_at required	Modified at Example :	string (date-time)
modified_by_id required	Modified by Example : `27bb070b564349f8a31cc60734cc36a5`	string
modified_by_name required	Modified by Example : `username`	string
name required	Name Example : `usage-plan-name`	string
rate required	Usage Plan Rate Example : `day`	enum (hour, day, month)

1.2.90 - UsagePlanListResponse

Name	Description	Schema	Default
count required	Total Count Example : `20`	integer
usage_plans required		array[UsagePlan]

1.2.91 - UsagePlanSetDescriptionRequest

Name	Description	Schema	Default
description optional	Description Example : `description`	any of [string, null]

1.2.92 - UsagePlanSetQuotaRequest

Name	Description	Schema	Default
limit required	Usage Plan Limit Example : `10` Minimum : `1` Maximum : `2000000000`	integer
rate required	Usage Plan Rate Example : `day`	enum (hour, day, month)

1.2.93 - UsagePlanShowResponse

Name	Description	Schema	Default
usage_plan required		UsagePlanDetail

2 - Queue Service

Overview

Provides an Application Programming Interface (API) 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 API. The API is provided as a RESTful API, and it responds in JSON format.

Version

Version	Status	Supported Until
1.0	CURRENT	-

OpenAPI URL

https://queueservice.{region}.{environment}.samsungsdscloud.com

Environment and Region List

environment	region
s	kr-west1
s	kr-east1
g	kr-south1
g	kr-south2
g	kr-south3
e	kr-west1
e	kr-east1

2.1 - APIs

2.1.1 - Check Queue Name Duplication

2.1.1.1 - 1.0

get /v1/queues/check-duplication

Description

check queue name duplication

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

Parameters

Type	Name	Description	Schema	Default
query	name required	Queue name Example : `test-queue.fifo`	string	None

Responses

HTTP Code	Description	Schema
200	OK	CheckDuplicationResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/queues/check-duplication?name={name}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = queueservice 1.0"

Example HTTP response

Response 200

{
    "result": true
}

2.1.2 - Create Queue

2.1.2.1 - 1.0

post /v1/queues

Description

create a queue

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

Parameters

Type	Name	Description	Schema	Default
body	body required		QueueCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	QueueCreateResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/queues

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = queueservice 1.0"

Request body

{
    "data_key_reuse_period": 40,
    "data_key_reuse_period_unit": "minute",
    "description": "Queue description",
    "encryption": {
        "id": "8c9f6c1c928a45b4bbd1e4da5531d656",
        "name": "test-kms"
    },
    "message_retention_period": 40,
    "message_retention_period_unit": "minute",
    "message_size": 256,
    "name": "test-queue.fifo",
    "tags": [
        {
            "key": "key1",
            "value": "value1"
        }
    ]
}

Example HTTP response

Response 201

{
    "id": "8c9f6c1c928a45b4bbd1e4da5531d656",
    "messages": "Create Queue",
    "state": "ACTIVE"
}

2.1.3 - Delete Acl

2.1.3.1 - 1.0

delete /v1/queues/{queue_id}/acl

Description

delete an acl policy

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	queue_id required	Queue ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string	None
body	body required		AclRequest

Responses

HTTP Code	Description	Schema
200	OK	AclResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/queues/{queue_id}/acl

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = queueservice 1.0"

Request body

{
    "ip_address": [
        "0.0.0.0",
        "192.168.0.0"
    ]
}

Example HTTP response

Response 200

{
    "id": "8c9f6c1c928a45b4bbd1e4da5531d656"
}

2.1.4 - Delete Queue

2.1.4.1 - 1.0

delete /v1/queues/{queue_id}

Description

delete a specific queue

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	queue_id required	Queue ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string	None

Responses

HTTP Code	Description	Schema
204	No Content	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/queues/{queue_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = queueservice 1.0"

Example HTTP response

Response 204

2.1.5 - List Queue

2.1.5.1 - 1.0

get /v1/queues

Description

list queue

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

Parameters

Type	Name	Description	Schema	Default
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	name optional	Queue name Example : `test-queue.fifo`	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	QueueListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/queues

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = queueservice 1.0"

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "queues": [
        {
            "account_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "encryption": {
                "id": "8c9f6c1c928a45b4bbd1e4da5531d656",
                "name": "test-kms"
            },
            "id": "8c9f6c1c928a45b4bbd1e4da5531d656",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "test-queue.fifo",
            "number_wait_messages": 10,
            "state": "ACTIVE",
            "type": "FIFO"
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

2.1.6 - Set Acl

2.1.6.1 - 1.0

post /v1/queues/{queue_id}/acl

Description

update an acl policy

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	queue_id required	Queue ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string	None
body	body required		AclRequest

Responses

HTTP Code	Description	Schema
200	OK	AclResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/queues/{queue_id}/acl

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = queueservice 1.0"

Request body

{
    "ip_address": [
        "0.0.0.0",
        "192.168.0.0"
    ]
}

Example HTTP response

Response 200

{
    "id": "8c9f6c1c928a45b4bbd1e4da5531d656"
}

2.1.7 - Show Queue

2.1.7.1 - 1.0

get /v1/queues/{queue_id}

Description

show a specific queue

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	queue_id required	Queue ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string	None

Responses

HTTP Code	Description	Schema
200	OK	QueueShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/queues/{queue_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = queueservice 1.0"

Example HTTP response

Response 200

{
    "account_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
    "allow_ip_access": [
        "0.0.0.0",
        "192.168.0.0"
    ],
    "console_polling_count": 10,
    "created_at": "2024-05-17T00:23:17Z",
    "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "data_key_reuse_period": 40,
    "data_key_reuse_period_unit": "minute",
    "description": "Queue description",
    "encryption": {
        "id": "8c9f6c1c928a45b4bbd1e4da5531d656",
        "name": "test-kms"
    },
    "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
    "message_retention_period": 40,
    "message_retention_period_unit": "minute",
    "message_size": 256,
    "modified_at": "2024-05-17T00:23:17Z",
    "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "name": "test-queue.fifo",
    "number_wait_messages": 10,
    "state": "ACTIVE",
    "type": "FIFO"
}

2.1.8 - Update Queue Config

2.1.8.1 - 1.0

put /v1/queues/{queue_id}/config

Description

update queue config

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	queue_id required	Queue ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string	None
body	body required		ConfigSetRequest

Responses

HTTP Code	Description	Schema
200	OK	QueueShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/queues/{queue_id}/config

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = queueservice 1.0"

Request body

{
    "data_key_reuse_period": 40,
    "data_key_reuse_period_unit": "minute",
    "encryption": {
        "id": "8c9f6c1c928a45b4bbd1e4da5531d656",
        "name": "test-kms"
    },
    "message_retention_period": 40,
    "message_retention_period_unit": "minute",
    "message_size": 256
}

Example HTTP response

Response 200

{
    "account_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
    "allow_ip_access": [
        "0.0.0.0",
        "192.168.0.0"
    ],
    "console_polling_count": 10,
    "created_at": "2024-05-17T00:23:17Z",
    "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "data_key_reuse_period": 40,
    "data_key_reuse_period_unit": "minute",
    "description": "Queue description",
    "encryption": {
        "id": "8c9f6c1c928a45b4bbd1e4da5531d656",
        "name": "test-kms"
    },
    "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
    "message_retention_period": 40,
    "message_retention_period_unit": "minute",
    "message_size": 256,
    "modified_at": "2024-05-17T00:23:17Z",
    "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "name": "test-queue.fifo",
    "number_wait_messages": 10,
    "state": "ACTIVE",
    "type": "FIFO"
}

2.1.9 - Update Queue Description

2.1.9.1 - 1.0

put /v1/queues/{queue_id}/description

Description

update queue description

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	queue_id required	Queue ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string	None
body	body required		DescriptionSetRequest

Responses

HTTP Code	Description	Schema
200	OK	DescriptionSetResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/queues/{queue_id}/description

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = queueservice 1.0"

Request body

{
    "description": "Queue description"
}

Example HTTP response

Response 200

{
    "id": "8c9f6c1c928a45b4bbd1e4da5531d656"
}

2.2 - Models

2.2.1 - Acl

Name	Description	Schema	Default
ip_address required	IP address Example : `192.168.0.0`	string

2.2.2 - AclRequest

Name	Description	Schema	Default
ip_address required	Access Allowed IP List Example : `['0.0.0.0', '192.168.0.0']`	array[string]

2.2.3 - AclResponse

Name	Description	Schema	Default
id required	Queue ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string

2.2.4 - CheckDuplicationResponse

Name	Description	Schema	Default
result required	Result Example : `True`	boolean

2.2.5 - ConfigSetRequest

Name	Description	Schema
data_key_reuse_period optional	Data key reuse period Example : `40`	any of [integer, null]
data_key_reuse_period_unit optional	Period unit Example : `minute`	any of [enum (minute, hour), null]
encryption optional	Encryption	any of [Encryption, null]
message_retention_period required	Message retention period Example : `40` Minimum : `1` Maximum : `1209600`	integer
message_retention_period_unit required	Period unit Example : `minute`	enum (second, minute, hour, day)
message_size required	Message size Example : `256` Minimum : `1` Maximum : `256`	integer

2.2.6 - DescriptionSetRequest

Name	Description	Schema	Default
description required	Description Example : `Queue description` Maximum length : `100`	string

2.2.7 - DescriptionSetResponse

Name	Description	Schema	Default
id required	Queue ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string

2.2.8 - Encryption

Name	Description	Schema	Default
id required	KMS ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	any of [string, null]
name required	KMS name Example : `test-kms`	any of [string, null]

2.2.9 - Queue

Name	Description	Schema
account_id required	Account ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string
created_at required	Created At Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	Created By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
encryption optional	Encryption	any of [Encryption, null]
id required	Queue ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	Queue name Example : `test-queue.fifo`	string
number_wait_messages required	Number of waiting messages Example : `10`	integer
state required	Queue state Example : `ACTIVE`	string
type required	Queue Type Example : `FIFO`	string

2.2.10 - QueueCreateRequest

Name	Description	Schema
data_key_reuse_period optional	Data key reuse period Example : `40`	any of [integer, null]
data_key_reuse_period_unit optional	Period unit Example : `minute`	any of [enum (minute, hour), null]
description optional	Description Example : `Queue description`	any of [string, null]
encryption optional	Encryption	any of [Encryption, null]
message_retention_period required	Message retention period Example : `40` Minimum : `1` Maximum : `1209600`	integer
message_retention_period_unit required	Period unit Example : `minute`	enum (second, minute, hour, day)
message_size required	Message size Example : `256` Minimum : `1` Maximum : `256`	integer
name required	Queue name Example : `test-queue.fifo` Pattern : `^[a-z][a-z0-9-]$\|^[a-z][a-z0-9-]\.fifo$` Minimum length : `3` Maximum length : `64`	string
tags optional	Tag List	any of [array[Tag], null]

2.2.11 - QueueCreateResponse

Name	Description	Schema
id required	Queue ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string
messages required	Description Example : `Create Queue`	string
state required	Queue state Example : `ACTIVE`	string

2.2.12 - QueueListResponse

Name	Description	Schema
count required	count Example : `20`	integer
page required	page Example : `0`	integer
queues required	Queue List	array[Queue]
size required	size Example : `20`	integer
sort optional	sort Example : `['created_at:asc']`	any of [array[string], null]

2.2.13 - QueueShowResponse

Name	Description	Schema
account_id required	Account ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string
allow_ip_access optional	Access Allowed IP List Example : `['0.0.0.0', '192.168.0.0']`	any of [array[Acl], null]
console_polling_count required	Polling count Example : `10`	integer
created_at required	Created At Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	Created By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
data_key_reuse_period optional	Data key reuse period Example : `40`	any of [integer, null]
data_key_reuse_period_unit optional	Period unit Example : `minute`	any of [enum (minute, hour), null]
description optional	Description Example : `Queue description`	any of [string, null]
encryption optional	Encryption	any of [Encryption, null]
id required	ID Example : `0fdd87aab8cb46f59b7c1f81ed03fb3e`	string
message_retention_period required	Message retention period Example : `40`	integer
message_retention_period_unit required	Period unit Example : `minute`	enum (second, minute, hour, day)
message_size required	Message size Example : `256`	integer
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	Queue name Example : `test-queue.fifo`	string
number_wait_messages required	Number of waiting messages Example : `10`	integer
state required	Queue state Example : `ACTIVE`	string
type required	Queue Type Example : `FIFO`	string

2.2.14 - Tag

Name	Description	Schema	Default
key required	Tag Key Example : `key1`	string
value required	Tag Value Example : `value1`	any of [string, null]