이 섹션의 다중 페이지 출력 화면임. 여기를 클릭하여 프린트.

Application Service

1: API Gateway

1.1: APIs

1.1.1: Approve PrivateLink Endpoint

1.1.1.1: 1.2

1.1.2: Connect PrivateLink Endpoint

1.1.2.1: 1.2

1.1.3: Create AccessControl

1.1.3.1: 1.2
1.1.3.2: 1.1
1.1.3.3: 1.0

1.1.4: Create Api

1.1.4.1: 1.2
1.1.4.2: 1.1
1.1.4.3: 1.0

1.1.5: Create Api Deployment

1.1.5.1: 1.2
1.1.5.2: 1.1
1.1.5.3: 1.0

1.1.6: Create Api Key

1.1.6.1: 1.2
1.1.6.2: 1.1

1.1.7: Create Auth

1.1.7.1: 1.2
1.1.7.2: 1.1
1.1.7.3: 1.0

1.1.8: Create Method

1.1.8.1: 1.2
1.1.8.2: 1.1
1.1.8.3: 1.0

1.1.9: Create PrivateLink Endpoint

1.1.9.1: 1.2

1.1.10: Create Resource

1.1.10.1: 1.2
1.1.10.2: 1.1
1.1.10.3: 1.0

1.1.11: Create Stage

1.1.11.1: 1.2
1.1.11.2: 1.1
1.1.11.3: 1.0

1.1.12: Create Usage Plans

1.1.12.1: 1.2
1.1.12.2: 1.1

1.1.13: Delete Access Control

1.1.13.1: 1.2
1.1.13.2: 1.1
1.1.13.3: 1.0

1.1.14: Delete an API Key

1.1.14.1: 1.2
1.1.14.2: 1.1

1.1.15: Delete Api

1.1.15.1: 1.2
1.1.15.2: 1.1
1.1.15.3: 1.0

1.1.16: Delete Auth

1.1.16.1: 1.2
1.1.16.2: 1.1
1.1.16.3: 1.0

1.1.17: Delete Method

1.1.17.1: 1.2
1.1.17.2: 1.1
1.1.17.3: 1.0

1.1.18: Delete PrivateLink Endpoint

1.1.18.1: 1.2

1.1.19: Delete Resource

1.1.19.1: 1.2
1.1.19.2: 1.1
1.1.19.3: 1.0

1.1.20: Delete Stage

1.1.20.1: 1.2
1.1.20.2: 1.1
1.1.20.3: 1.0

1.1.21: Delete Usage Plan

1.1.21.1: 1.2
1.1.21.2: 1.1

1.1.22: List AccessControls

1.1.22.1: 1.2
1.1.22.2: 1.1
1.1.22.3: 1.0

1.1.23: List Api Deployments

1.1.23.1: 1.2
1.1.23.2: 1.1
1.1.23.3: 1.0

1.1.24: List Api Keys

1.1.24.1: 1.2
1.1.24.2: 1.1

1.1.25: List Apis

1.1.25.1: 1.2
1.1.25.2: 1.1
1.1.25.3: 1.0

1.1.26: List Auths

1.1.26.1: 1.2
1.1.26.2: 1.1
1.1.26.3: 1.0

1.1.27: List Connected PrivateLink Endpoints

1.1.27.1: 1.2

1.1.28: List Methods

1.1.28.1: 1.2
1.1.28.2: 1.1
1.1.28.3: 1.0

1.1.29: List PrivateLink Endpoints

1.1.29.1: 1.2

1.1.30: List Reports

1.1.30.1: 1.2
1.1.30.2: 1.1

1.1.31: List Resources

1.1.31.1: 1.2
1.1.31.2: 1.1
1.1.31.3: 1.0

1.1.32: List Stages

1.1.32.1: 1.2
1.1.32.2: 1.1
1.1.32.3: 1.0

1.1.33: List Usage Plans

1.1.33.1: 1.2
1.1.33.2: 1.1

1.1.34: Request PrivateLink Endpoint

1.1.34.1: 1.2

1.1.35: Set Access Control

1.1.35.1: 1.2
1.1.35.2: 1.1
1.1.35.3: 1.0

1.1.36: Set Api Description

1.1.36.1: 1.2
1.1.36.2: 1.1
1.1.36.3: 1.0

1.1.37: Set API Key Description

1.1.37.1: 1.2
1.1.37.2: 1.1

1.1.38: Set Auth

1.1.38.1: 1.2
1.1.38.2: 1.1
1.1.38.3: 1.0

1.1.39: Set Method

1.1.39.1: 1.2
1.1.39.2: 1.1
1.1.39.3: 1.0

1.1.40: Set PrivateLink Endpoint

1.1.40.1: 1.2

1.1.41: Set Stage Active Deployment

1.1.41.1: 1.2
1.1.41.2: 1.1
1.1.41.3: 1.0

1.1.42: Set Stage Configuration

1.1.42.1: 1.2
1.1.42.2: 1.1
1.1.42.3: 1.0

1.1.43: Set Usage Plan Description

1.1.43.1: 1.2
1.1.43.2: 1.1

1.1.44: Set Usage Plan Quota

1.1.44.1: 1.2
1.1.44.2: 1.1

1.1.45: Show Access Control

1.1.45.1: 1.2
1.1.45.2: 1.1
1.1.45.3: 1.0

1.1.46: Show Api

1.1.46.1: 1.2
1.1.46.2: 1.1
1.1.46.3: 1.0

1.1.47: Show Auth

1.1.47.1: 1.2
1.1.47.2: 1.1
1.1.47.3: 1.0

1.1.48: Show Method

1.1.48.1: 1.2
1.1.48.2: 1.1
1.1.48.3: 1.0

1.1.49: Show PrivateLink Endpoint

1.1.49.1: 1.2

1.1.50: Show Resource

1.1.50.1: 1.2
1.1.50.2: 1.1
1.1.50.3: 1.0

1.1.51: Show Stage

1.1.51.1: 1.2
1.1.51.2: 1.1
1.1.51.3: 1.0

1.1.52: Show Usage Plan

1.1.52.1: 1.2
1.1.52.2: 1.1

1.2: Models

1.2.1: AccessControl
1.2.2: AccessControlCreateRequest
1.2.3: AccessControlCreateResponse
1.2.4: AccessControlListResponse
1.2.5: AccessControlSetRequest
1.2.6: AccessControlShowResponse
1.2.7: Api
1.2.8: ApiConnectedEndpoint
1.2.9: ApiConnectedEndpointListResponse
1.2.10: ApiCreateRequest
1.2.11: ApiCreateRequestV1Dot2
1.2.12: ApiCreateResponse
1.2.13: ApiDeployment
1.2.14: ApiDeploymentListResponse
1.2.15: ApiDeploymentRequest
1.2.16: ApiDeploymentResponse
1.2.17: ApiDetail
1.2.18: ApiKey
1.2.19: ApiKeyCreateRequest
1.2.20: ApiKeyInStage
1.2.21: ApiKeyListResponse
1.2.22: ApiKeySetDescriptionRequest
1.2.23: ApiKeyShowResponse
1.2.24: ApiListResponse
1.2.25: ApiSetDescriptionRequest
1.2.26: ApiShowResponse
1.2.27: Auth
1.2.28: AuthCreateRequest
1.2.29: AuthCreateResponse
1.2.30: AuthListResponse
1.2.31: AuthSetRequest
1.2.32: AuthShowResponse
1.2.33: Method
1.2.34: MethodCreateRequest
1.2.35: MethodCreateRequestV1Dot1
1.2.36: MethodInStage
1.2.37: MethodListResponse
1.2.38: MethodListResponseV1Dot1
1.2.39: MethodListResponseV1Dot2
1.2.40: MethodSetRequest
1.2.41: MethodSetRequestV1Dot1
1.2.42: MethodShowResponse
1.2.43: MethodShowResponseV1Dot1
1.2.44: MethodShowResponseV1Dot2
1.2.45: MethodV1Dot1
1.2.46: MethodV1Dot2
1.2.47: PrivateLinkEndpoint
1.2.48: PrivateLinkEndpointApprovalRequest
1.2.49: PrivateLinkEndpointConnectionRequest
1.2.50: PrivateLinkEndpointCreateRequest
1.2.51: PrivateLinkEndpointDetail
1.2.52: PrivateLinkEndpointListResponse
1.2.53: PrivateLinkEndpointRequestRequest
1.2.54: PrivateLinkEndpointSetRequest
1.2.55: PrivateLinkEndpointShowResponse
1.2.56: PrivateLinkEndpointSummary
1.2.57: PrivateLinkEndpointSummaryShowResponse
1.2.58: Report
1.2.59: ReportListResponse
1.2.60: Resource
1.2.61: ResourceCreateRequest
1.2.62: ResourceCreateResponse
1.2.63: ResourceListResponse
1.2.64: ResourceListResponseV1Dot1
1.2.65: ResourceListResponseV1Dot2
1.2.66: ResourceShowResponse
1.2.67: ResourceShowResponseV1Dot1
1.2.68: ResourceShowResponseV1Dot2
1.2.69: ResourceSummary
1.2.70: ResourceSummaryV1Dot1
1.2.71: ResourceV1Dot1
1.2.72: ResourceV1Dot2
1.2.73: Stage
1.2.74: StageCreateRequest
1.2.75: StageDetail
1.2.76: StageDetailV1Dot1
1.2.77: StageListResponse
1.2.78: StageListResponseV1Dot1
1.2.79: StageSetActiveDeploymentRequest
1.2.80: StageSetConfigRequest
1.2.81: StageSetConfigRequestV1Dot1
1.2.82: StageShowResponse
1.2.83: StageShowResponseV1Dot1
1.2.84: StageV1Dot1
1.2.85: Tag
1.2.86: TopResource
1.2.87: UsagePlan
1.2.88: UsagePlanCreateRequest
1.2.89: UsagePlanDetail
1.2.90: UsagePlanListResponse
1.2.91: UsagePlanSetDescriptionRequest
1.2.92: UsagePlanSetQuotaRequest
1.2.93: UsagePlanShowResponse

2: Queue Service

2.1: APIs

2.1.1: Check Queue Name Duplication

2.1.1.1: 1.0

2.1.2: Create Queue

2.1.2.1: 1.0

2.1.3: Delete Acl

2.1.3.1: 1.0

2.1.4: Delete Queue

2.1.4.1: 1.0

2.1.5: List Queue

2.1.5.1: 1.0

2.1.6: Set Acl

2.1.6.1: 1.0

2.1.7: Show Queue

2.1.7.1: 1.0

2.1.8: Update Queue Config

2.1.8.1: 1.0

2.1.9: Update Queue Description

2.1.9.1: 1.0

2.2: Models

2.2.1: Acl
2.2.2: AclRequest
2.2.3: AclResponse
2.2.4: CheckDuplicationResponse
2.2.5: ConfigSetRequest
2.2.6: DescriptionSetRequest
2.2.7: DescriptionSetResponse
2.2.8: Encryption
2.2.9: Queue
2.2.10: QueueCreateRequest
2.2.11: QueueCreateResponse
2.2.12: QueueListResponse
2.2.13: QueueShowResponse
2.2.14: Tag

1 - API Gateway

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 응용 프로그램 인터페이스(Application Programming Interface, API)를 제공합니다.

본 가이드는 API Gateway 서비스에 대한 간략한 설명 및 API를 호출하는 방법을 제공합니다. API는 RESTful API 방식으로 제공되며, JSON 형식으로 응답합니다.

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

PrivateLink 엔드포인트를 승인한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	privatelink_endpoint_id required	PrivateLink 엔드포인트 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 = ko-KR",
"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

PrivateLink 엔드포인트를 연결한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	privatelink_endpoint_id required	PrivateLink 엔드포인트 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 = ko-KR",
"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

접근제어를 생성한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
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 = ko-KR",
"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

접근제어를 생성한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
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 = ko-KR",
"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

접근제어를 생성한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
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 = ko-KR",
"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

API를 생성한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
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 = ko-KR",
"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

API를 생성한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
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 = ko-KR",
"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

API를 생성한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
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 = ko-KR",
"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

API를 배포한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
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 = ko-KR",
"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

API를 배포한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
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 = ko-KR",
"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

API를 배포한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
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 = ko-KR",
"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

API Key를 생성한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	usage_plan_id required	사용량 정책 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 = ko-KR",
"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:19.438Z",
        "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

API Key를 생성한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260430

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	usage_plan_id required	사용량 정책 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 = ko-KR",
"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:19.438Z",
        "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

인증을 생성한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
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 = ko-KR",
"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

인증을 생성한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
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 = ko-KR",
"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

인증을 생성한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
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 = ko-KR",
"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

메서드를 생성한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	resource_id required	리소스 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 = ko-KR",
"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

메서드를 생성한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260430

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	resource_id required	리소스 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 = ko-KR",
"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

메서드를 생성한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	resource_id required	리소스 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 = ko-KR",
"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

PrivateLink 엔드포인트를 생성한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
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 = ko-KR",
"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

리소스를 생성한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	parent_id required	리소스 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 = ko-KR",
"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

리소스를 생성한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260430

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	parent_id required	리소스 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 = ko-KR",
"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

리소스를 생성한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	parent_id required	리소스 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 = ko-KR",
"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

스테이지를 생성한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
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 = ko-KR",
"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:19.189Z",
        "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

스테이지를 생성한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
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 = ko-KR",
"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:19.189Z",
        "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

스테이지를 생성한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
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 = ko-KR",
"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:18.683Z",
        "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

사용량 정책을 생성한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
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 = ko-KR",
"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:19.405Z",
        "created_by_id": "27bb070b564349f8a31cc60734cc36a5",
        "created_by_name": "username",
        "description": "description",
        "id": "27bb070b564349f8a31cc60734cc36a5",
        "limit": 10,
        "modified_at": "2026-02-11T06:40:19.405Z",
        "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

사용량 정책을 생성한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
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 = ko-KR",
"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:19.405Z",
        "created_by_id": "27bb070b564349f8a31cc60734cc36a5",
        "created_by_name": "username",
        "description": "description",
        "id": "27bb070b564349f8a31cc60734cc36a5",
        "limit": 10,
        "modified_at": "2026-02-11T06:40:19.405Z",
        "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

접근제어를 삭제한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example :	string	None
path	access_control_id required	접근제어 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 = ko-KR",
"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

접근제어를 삭제한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260430

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example :	string	None
path	access_control_id required	접근제어 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 = ko-KR",
"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

접근제어를 삭제한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example :	string	None
path	access_control_id required	접근제어 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 = ko-KR",
"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

API Key를 삭제한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	usage_plan_id required	사용량 정책 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 = ko-KR",
"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

API Key를 삭제한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260430

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	usage_plan_id required	사용량 정책 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 = ko-KR",
"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

API를 삭제한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
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 = ko-KR",
"Scp-Api-Version = apigateway 1.2"

Example HTTP response

Response 204

1.1.15.2 - 1.1

delete /v1/apis/{api_id}

Description

API를 삭제한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
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 = ko-KR",
"Scp-Api-Version = apigateway 1.1"

Example HTTP response

Response 204

1.1.15.3 - 1.0

delete /v1/apis/{api_id}

Description

API를 삭제한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
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 = ko-KR",
"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

인증을 삭제한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example :	string	None
path	auth_id required	인증 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 = ko-KR",
"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

인증을 삭제한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260430

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example :	string	None
path	auth_id required	인증 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 = ko-KR",
"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

인증을 삭제한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example :	string	None
path	auth_id required	인증 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 = ko-KR",
"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

메서드를 삭제한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	resource_id required	리소스 ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	method_type required	메서드 유형 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 = ko-KR",
"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

메서드를 삭제한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260430

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	resource_id required	리소스 ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	method_type required	메서드 유형 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 = ko-KR",
"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

메서드를 삭제한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	resource_id required	리소스 ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	method_type required	메서드 유형 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 = ko-KR",
"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

PrivateLink 엔드포인트를 삭제한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	privatelink_endpoint_id required	PrivateLink 엔드포인트 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 = ko-KR",
"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

리소스를 삭제한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	resource_id required	리소스 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 = ko-KR",
"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

리소스를 삭제한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260430

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	resource_id required	리소스 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 = ko-KR",
"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

리소스를 삭제한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	resource_id required	리소스 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 = ko-KR",
"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

스테이지를 삭제한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	stage_name required	스테이지명 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 = ko-KR",
"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

스테이지를 삭제한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260430

Parameters

Type	Name	Description	Schema	Default
path	stage_name required	스테이지명 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 = ko-KR",
"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

스테이지를 삭제한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	stage_name required	스테이지명 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 = ko-KR",
"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

사용량 정책을 삭제한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	usage_plan_id required	사용량 정책 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 = ko-KR",
"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

사용량 정책을 삭제한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260430

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	usage_plan_id required	사용량 정책 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 = ko-KR",
"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

접근제어 목록을 조회한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
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 = ko-KR",
"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

접근제어 목록을 조회한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
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 = ko-KR",
"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

접근제어 목록을 조회한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
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 = ko-KR",
"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

API 배포 목록을 조회한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
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	이름 Example : `27bb070b564349f8a31cc60734cc36a5`	any of [string, null]	None
query	stage_name optional	스테이지명 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 = ko-KR",
"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

API 배포 목록을 조회한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
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	이름 Example : `27bb070b564349f8a31cc60734cc36a5`	any of [string, null]	None
query	stage_name optional	스테이지명 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 = ko-KR",
"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

API 배포 목록을 조회한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
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	이름 Example : `27bb070b564349f8a31cc60734cc36a5`	any of [string, null]	None
query	stage_name optional	스테이지명 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 = ko-KR",
"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

API Key 목록을 조회한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	usage_plan_id required	사용량 정책 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	이름 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 = ko-KR",
"Scp-Api-Version = apigateway 1.2"

Example HTTP response

Response 200

{
    "api_keys": [
        {
            "created_at": "2026-02-11T06:40:19.438Z",
            "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

API Key 목록을 조회한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260430

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	usage_plan_id required	사용량 정책 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	이름 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 = ko-KR",
"Scp-Api-Version = apigateway 1.1"

Example HTTP response

Response 200

{
    "api_keys": [
        {
            "created_at": "2026-02-11T06:40:19.438Z",
            "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

API 목록을 조회한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
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	이름 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 = ko-KR",
"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

API 목록을 조회한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
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	이름 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 = ko-KR",
"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

API 목록을 조회한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
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	이름 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 = ko-KR",
"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

인증 목록을 조회한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
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 = ko-KR",
"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

인증 목록을 조회한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
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 = ko-KR",
"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

인증 목록을 조회한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
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 = ko-KR",
"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

연결요청된 PrivateLink 엔드포인트를 조회한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
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 = ko-KR",
"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

메서드 목록을 조회한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	resource_id required	리소스 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 = ko-KR",
"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

메서드 목록을 조회한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260430

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	resource_id required	리소스 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 = ko-KR",
"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

메서드 목록을 조회한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	resource_id required	리소스 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 = ko-KR",
"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

PrivateLink 엔드포인트 목록을 조회한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
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 엔드포인트명 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 = ko-KR",
"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

Report 목록을 조회한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
query	stage_name required	스테이지명 Example : `test-stage`	string	None
query	start_date required	시작일자 Example : `2025-07-01`	string	None
query	end_date required	종료일자 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 = ko-KR",
"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

Report 목록을 조회한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260430

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
query	stage_name required	스테이지명 Example : `test-stage`	string	None
query	start_date required	시작일자 Example : `2025-07-01`	string	None
query	end_date required	종료일자 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 = ko-KR",
"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

리소스 목록을 조회한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
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 = ko-KR",
"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

리소스 목록을 조회한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
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 = ko-KR",
"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

리소스 목록을 조회한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
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 = ko-KR",
"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

스테이지 목록을 조회한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
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 = ko-KR",
"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:19.082Z",
            "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

스테이지 목록을 조회한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
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 = ko-KR",
"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:19.082Z",
            "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

스테이지 목록을 조회한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
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 = ko-KR",
"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:18.594Z",
            "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

사용량 정책 목록을 조회한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
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	이름 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 = ko-KR",
"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:19.345Z",
            "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

사용량 정책 목록을 조회한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
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	이름 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 = ko-KR",
"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:19.345Z",
            "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

PrivateLink 엔드포인트를 요청한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	privatelink_endpoint_id required	PrivateLink 엔드포인트 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 = ko-KR",
"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

접근제어를 수정한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example :	string	None
path	access_control_id required	접근제어 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 = ko-KR",
"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

접근제어를 수정한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260430

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example :	string	None
path	access_control_id required	접근제어 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 = ko-KR",
"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

접근제어를 수정한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example :	string	None
path	access_control_id required	접근제어 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 = ko-KR",
"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

API 설명을 수정한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
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 = ko-KR",
"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

API 설명을 수정한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
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 = ko-KR",
"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

API 설명을 수정한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
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 = ko-KR",
"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

API Key 설명을 수정한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	usage_plan_id required	사용량 정책 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 = ko-KR",
"Scp-Api-Version = apigateway 1.2"

Request body

{
    "description": "description"
}

Example HTTP response

Response 200

{
    "api_key": {
        "created_at": "2026-02-11T06:40:19.438Z",
        "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

API Key 설명을 수정한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260430

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	usage_plan_id required	사용량 정책 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 = ko-KR",
"Scp-Api-Version = apigateway 1.1"

Request body

{
    "description": "description"
}

Example HTTP response

Response 200

{
    "api_key": {
        "created_at": "2026-02-11T06:40:19.438Z",
        "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

인증을 수정한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example :	string	None
path	auth_id required	인증 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 = ko-KR",
"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

인증을 수정한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260430

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example :	string	None
path	auth_id required	인증 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 = ko-KR",
"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

인증을 수정한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example :	string	None
path	auth_id required	인증 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 = ko-KR",
"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

메서드를 수정한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	resource_id required	리소스 ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	method_type required	메서드 유형 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 = ko-KR",
"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

메서드를 수정한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260430

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	resource_id required	리소스 ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	method_type required	메서드 유형 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 = ko-KR",
"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

메서드를 수정한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	resource_id required	리소스 ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	method_type required	메서드 유형 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 = ko-KR",
"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

PrivateLink 엔드포인트를 수정한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	privatelink_endpoint_id required	PrivateLink 엔드포인트 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 = ko-KR",
"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

스테이지 활성화 배포를 수정한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	stage_name required	스테이지명 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 = ko-KR",
"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:19.189Z",
        "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

스테이지 활성화 배포를 수정한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260430

Parameters

Type	Name	Description	Schema	Default
path	stage_name required	스테이지명 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 = ko-KR",
"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:19.189Z",
        "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

스테이지 활성화 배포를 수정한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	stage_name required	스테이지명 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 = ko-KR",
"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:18.683Z",
        "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

스테이지 설정을 수정한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	stage_name required	스테이지명 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 = ko-KR",
"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:19.189Z",
        "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

스테이지 설정을 수정한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260430

Parameters

Type	Name	Description	Schema	Default
path	stage_name required	스테이지명 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 = ko-KR",
"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:19.189Z",
        "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

스테이지 설정을 수정한다(ip_restriction_enabled 수정은 더 이상 지원되지 않음)

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	stage_name required	스테이지명 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 = ko-KR",
"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:18.683Z",
        "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

사용량 정책 설명을 수정한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	usage_plan_id required	사용량 정책 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 = ko-KR",
"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:19.405Z",
        "created_by_id": "27bb070b564349f8a31cc60734cc36a5",
        "created_by_name": "username",
        "description": "description",
        "id": "27bb070b564349f8a31cc60734cc36a5",
        "limit": 10,
        "modified_at": "2026-02-11T06:40:19.405Z",
        "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

사용량 정책 설명을 수정한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260430

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	usage_plan_id required	사용량 정책 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 = ko-KR",
"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:19.405Z",
        "created_by_id": "27bb070b564349f8a31cc60734cc36a5",
        "created_by_name": "username",
        "description": "description",
        "id": "27bb070b564349f8a31cc60734cc36a5",
        "limit": 10,
        "modified_at": "2026-02-11T06:40:19.405Z",
        "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

사용량 정책 할당량을 수정한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	usage_plan_id required	사용량 정책 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 = ko-KR",
"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:19.405Z",
        "created_by_id": "27bb070b564349f8a31cc60734cc36a5",
        "created_by_name": "username",
        "description": "description",
        "id": "27bb070b564349f8a31cc60734cc36a5",
        "limit": 10,
        "modified_at": "2026-02-11T06:40:19.405Z",
        "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

사용량 정책 할당량을 수정한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260430

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	usage_plan_id required	사용량 정책 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 = ko-KR",
"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:19.405Z",
        "created_by_id": "27bb070b564349f8a31cc60734cc36a5",
        "created_by_name": "username",
        "description": "description",
        "id": "27bb070b564349f8a31cc60734cc36a5",
        "limit": 10,
        "modified_at": "2026-02-11T06:40:19.405Z",
        "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

접근제어를 상세조회한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example :	string	None
path	access_control_id required	접근제어 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 = ko-KR",
"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

접근제어를 상세조회한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260430

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example :	string	None
path	access_control_id required	접근제어 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 = ko-KR",
"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

접근제어를 상세조회한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example :	string	None
path	access_control_id required	접근제어 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 = ko-KR",
"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

API를 상세조회한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
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 = ko-KR",
"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

API를 상세조회한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
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 = ko-KR",
"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

API를 상세조회한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
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 = ko-KR",
"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

인증을 상세조회한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example :	string	None
path	auth_id required	인증 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 = ko-KR",
"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

인증을 상세조회한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260430

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example :	string	None
path	auth_id required	인증 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 = ko-KR",
"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

인증을 상세조회한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example :	string	None
path	auth_id required	인증 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 = ko-KR",
"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

메서드를 상세조회한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	resource_id required	리소스 ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	method_type required	메서드 유형 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 = ko-KR",
"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

메서드를 상세조회한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260430

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	resource_id required	리소스 ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	method_type required	메서드 유형 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 = ko-KR",
"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

메서드를 상세조회한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	resource_id required	리소스 ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	method_type required	메서드 유형 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 = ko-KR",
"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

PrivateLink 엔드포인트를 조회한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	privatelink_endpoint_id required	PrivateLink 엔드포인트 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 = ko-KR",
"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

리소스를 상세조회한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	resource_id required	리소스 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 = ko-KR",
"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

리소스를 상세조회한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260430

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	resource_id required	리소스 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 = ko-KR",
"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

리소스를 상세조회한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	resource_id required	리소스 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 = ko-KR",
"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

스테이지를 상세조회한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	stage_name required	스테이지명 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 = ko-KR",
"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:19.189Z",
        "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

스테이지를 상세조회한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260430

Parameters

Type	Name	Description	Schema	Default
path	stage_name required	스테이지명 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 = ko-KR",
"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:19.189Z",
        "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

스테이지를 상세조회한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	stage_name required	스테이지명 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 = ko-KR",
"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:18.683Z",
        "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

사용량 정책을 상세조회한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	usage_plan_id required	사용량 정책 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 = ko-KR",
"Scp-Api-Version = apigateway 1.2"

Example HTTP response

Response 200

{
    "usage_plan": {
        "api_keys": [],
        "created_at": "2026-02-11T06:40:19.405Z",
        "created_by_id": "27bb070b564349f8a31cc60734cc36a5",
        "created_by_name": "username",
        "description": "description",
        "id": "27bb070b564349f8a31cc60734cc36a5",
        "limit": 10,
        "modified_at": "2026-02-11T06:40:19.405Z",
        "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

사용량 정책을 상세조회한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260430

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	usage_plan_id required	사용량 정책 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 = ko-KR",
"Scp-Api-Version = apigateway 1.1"

Example HTTP response

Response 200

{
    "usage_plan": {
        "api_keys": [],
        "created_at": "2026-02-11T06:40:19.405Z",
        "created_by_id": "27bb070b564349f8a31cc60734cc36a5",
        "created_by_name": "username",
        "description": "description",
        "id": "27bb070b564349f8a31cc60734cc36a5",
        "limit": 10,
        "modified_at": "2026-02-11T06:40:19.405Z",
        "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	허용 IP 주소 Example : `['127.0.0.1/24,192.168.127.12']`	array[string]
connected_stages required	연결된 스테이지 Example : `['dev,stg']`	array[string]
created_at required	생성 일시 Example : `2024-05-19T00:23:17Z`	string (date-time)
description required	설명 Example :	string
id required	접근제어 ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
name required	접근제어명 Example : `DenyTest`	string

1.2.2 - AccessControlCreateRequest

Name	Description	Schema
allowed_ip_addr required	허용 IP 주소 Example : `['127.0.0.1/24,192.168.127.12']`	array[string]
connected_stages required	연결된 스테이지 Example : `['dev,stg']`	any of [array[string], null]
description optional	설명 Example : `description`	any of [string, null]
name required	접근제어명 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	허용 IP 주소 Example : `['127.0.0.1/24,192.168.127.12']`	array[string]
connected_stages required	연결된 스테이지 Example : `['dev,stg']`	array[string]
created_at required	생성 일시 Example : `2024-05-19T00:23:17Z`	string (date-time)
description required	설명 Example :	string
id required	접근제어 ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
name required	접근제어명 Example : `DenyTest`	string

1.2.4 - AccessControlListResponse

Name	Description	Schema	Default
access_controls required		array[AccessControl]
count required	총 개수 Example : `20`	integer

1.2.5 - AccessControlSetRequest

Name	Description	Schema
allowed_ip_addr required	허용 IP 주소 Example : `['127.0.0.1/24,192.168.127.12']`	array[string]
connected_stages required	연결된 스테이지 Example : `['dev,stg']`	any of [array[string], null]
description optional	설명 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	계정 ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
created_at required	생성 일시 Example : `2024-05-17T00:23:17Z`	string (date-time)
description required	설명 Example : `Description`	string
dns_record_status optional	DNS 레코드 상태 Example : `Active`	any of [string, null]
id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
name required	이름 Example : `test-api`	string
status required	API 상태 Example : `Active`	string

1.2.8 - ApiConnectedEndpoint

Name	Description	Schema
created_at required	생성 일시 Example : `2024-05-17T00:23:17Z`	string (date-time)
id required	PrivateLink 엔드포인트 ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
status required	PrivateLink 엔드포인트 상태 Example : `Active`	string

1.2.9 - ApiConnectedEndpointListResponse

Name	Description	Schema	Default
connected_endpoints required		array[ApiConnectedEndpoint]
count required	총 개수 Example : `20`	integer

1.2.10 - ApiCreateRequest

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

1.2.11 - ApiCreateRequestV1Dot2

Name	Description	Schema	Default
description optional	설명 Example : `description`	any of [string, null]
endpoint_type optional	엔드포인트 유형 Example : `REGION`	enum (REGION, PRIVATE)	REGION
id optional	Api ID Example :	any of [string, null]
name required	이름 Example : `test-api` Pattern : `^[a-z][a-z0-9\-]{1,48}[a-z0-9]$` Minimum length : `3` Maximum length : `50`	string
tags optional	태그 목록	any of [array[Tag], null]

1.2.12 - ApiCreateResponse

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

1.2.13 - ApiDeployment

Name	Description	Schema	Default
deployment_date required	배포 일시 Example : `2024-05-17T00:23:17Z`	string (date-time)
deployment_id required	배포 ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
description required	설명 Example : `description`	string
status optional	상태 Example : `Active`	string	-

1.2.14 - ApiDeploymentListResponse

Name	Description	Schema	Default
count required	총 개수 Example : `20`	integer
deployments required		array[ApiDeployment]

1.2.15 - ApiDeploymentRequest

Name	Description	Schema
description optional	설명 Example : `description`	any of [string, null]
stage_name optional	스테이지명 Example : `test-stage`	any of [string, null]
stage_type required	스테이지 유형 Example : `new`	enum (new, existing, none)

1.2.16 - ApiDeploymentResponse

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

1.2.17 - ApiDetail

Name	Description	Schema
account_id required	계정 ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
created_at required	생성 일시 Example : `2024-05-17T00:23:17Z`	string (date-time)
description required	설명 Example : `Description`	string
dns_record_status optional	DNS 레코드 상태 Example : `Active`	any of [string, null]
id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
name required	이름 Example : `test-api`	string
status required	API 상태 Example : `Active`	string

1.2.18 - ApiKey

Name	Description	Schema
created_at required	생성 일시 Example : `2026-02-11T06:40:19.438Z`	string (date-time)
description optional	설명 Example : `description`	string
id required	API Key ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
key required	Key Example : `key`	string
name required	이름 Example : `api-key-name`	string

1.2.19 - ApiKeyCreateRequest

Name	Description	Schema	Default
description optional	설명 Example : `description`	any of [string, null]
name required	이름 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	이름 Example : `api-key-name`	string

1.2.21 - ApiKeyListResponse

Name	Description	Schema	Default
api_keys required		array[ApiKey]
count required	총 개수 Example : `20`	integer

1.2.22 - ApiKeySetDescriptionRequest

Name	Description	Schema	Default
description optional	설명 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	총 개수 Example : `20`	integer

1.2.25 - ApiSetDescriptionRequest

Name	Description	Schema	Default
description optional	설명 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	인증 수단 Example : `JWT(JSON WEB Token)`	string	JWT(JSON WEB Token)
connected_stages required	연결된 스테이지 Example : `['dev,stg']`	array[string]
expired_at required	만료 예정 일시 Example : `2024-05-17T00:23:17Z`	string (date-time)
id required	인증 ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
name required	인증명 Example : `Token01`	string

1.2.28 - AuthCreateRequest

Name	Description	Schema
connected_stages required	연결된 스테이지 Example : `['dev,stg']`	any of [array[string], null]
expiration_period required	만료 기간 Example : `90`	integer
name required	인증명 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	액세스 토큰 Example : `***********************************************************`	string

1.2.30 - AuthListResponse

Name	Description	Schema	Default
auths required		array[Auth]
count required	총 개수 Example : `20`	integer

1.2.31 - AuthSetRequest

Name	Description	Schema	Default
connected_stages required	연결된 스테이지 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	메서드 엔드포인트 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	메서드 통합 유형 Example : `HTTP`	string
method_type required	메서드 유형 Example : `GET`	string
query_strings optional	메서드 쿼리 문자열 Example : `{'param1': 'value1', 'param2': 'value2'}`	any of [object[boolean], null]
request_headers optional	메서드 요청 헤더 Example : `{'test1' : True}`	any of [object[boolean], null]
request_path optional	메서드 요청 경로 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 사용여부 Example : `False`	any of [boolean, null]
endpoint_url optional	메서드 엔드포인트 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	메서드 통합 유형 Example : `HTTP`	enum (HTTP, SCF, PRIVATELINK)
method_type required	메서드 유형 Example : `GET`	enum (GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS, ANY)
privatelink_endpoint_id optional	PrivateLink 엔드포인트 ID Example : `27bb070b564349f8a31cc60734cc36a5`	any of [string, null]
query_strings optional	메서드 쿼리 문자열 Example : `{'param1': 'value1', 'param2': 'value2'}`	any of [object[boolean], null]
request_headers optional	메서드 요청 헤더 Example : `{'test1' : True}`	any of [object[boolean], null]

1.2.35 - MethodCreateRequestV1Dot1

Name	Description	Schema
api_key_required optional	API Key 사용여부 Example : `False`	any of [boolean, null]
endpoint_url optional	메서드 엔드포인트 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	메서드 통합 유형 Example : `HTTP`	enum (HTTP, SCF, PRIVATELINK)
method_type required	메서드 유형 Example : `GET`	enum (GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS, ANY)
privatelink_endpoint_id optional	PrivateLink 엔드포인트 ID Example : `27bb070b564349f8a31cc60734cc36a5`	any of [string, null]
query_strings optional	메서드 쿼리 문자열 Example : `{'param1': 'value1', 'param2': 'value2'}`	any of [object[boolean], null]
request_headers optional	메서드 요청 헤더 Example : `{'test1' : True}`	any of [object[boolean], null]

1.2.36 - MethodInStage

Name	Description	Schema	Default
api_key_required optional	API Key 사용여부 Example : `False`	boolean
type required	메서드 유형 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	메서드 쿼리 문자열 Example : `{'param1': 'value1', 'param2': 'value2'}`	object[boolean]
request_headers required	메서드 요청 헤더 Example : `{'test1' : True}`	object[boolean]

1.2.41 - MethodSetRequestV1Dot1

Name	Description	Schema
api_key_required required	API Key 사용여부 Example : `False`	boolean
endpoint_url optional	메서드 엔드포인트 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	메서드 통합 유형 Example : `HTTP`	enum (HTTP, SCF, PRIVATELINK)
privatelink_endpoint_id optional	PrivateLink 엔드포인트 ID Example : `27bb070b564349f8a31cc60734cc36a5`	any of [string, null]
query_strings required	메서드 쿼리 문자열 Example : `{'param1': 'value1', 'param2': 'value2'}`	object[boolean]
request_headers required	메서드 요청 헤더 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 사용여부 Example : `False`	boolean
endpoint_url optional	메서드 엔드포인트 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	메서드 통합 유형 Example : `HTTP`	string
method_type required	메서드 유형 Example : `GET`	string
query_strings optional	메서드 쿼리 문자열 Example : `{'param1': 'value1', 'param2': 'value2'}`	any of [object[boolean], null]
request_headers optional	메서드 요청 헤더 Example : `{'test1' : True}`	any of [object[boolean], null]
request_path optional	메서드 요청 경로 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 사용여부 Example : `False`	boolean
endpoint_url optional	메서드 엔드포인트 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	메서드 통합 유형 Example : `HTTP`	string
method_type required	메서드 유형 Example : `GET`	string
privatelink_endpoint_id optional	PrivateLink 엔드포인트 ID Example : `27bb070b564349f8a31cc60734cc36a5`	any of [string, null]
query_strings optional	메서드 쿼리 문자열 Example : `{'param1': 'value1', 'param2': 'value2'}`	any of [object[boolean], null]
request_headers optional	메서드 요청 헤더 Example : `{'test1' : True}`	any of [object[boolean], null]
request_path optional	메서드 요청 경로 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	생성 일시 Example : `2024-05-17T00:23:17Z`	string (date-time)
id required	PrivateLink 엔드포인트 ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
name required	PrivateLink 엔드포인트명 Example : `endpoint`	string
privatelink_service_id required	PrivateLink 서비스 ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
status required	PrivateLink 엔드포인트 상태 Example : `CANCELED`	string

1.2.48 - PrivateLinkEndpointApprovalRequest

Name	Description	Schema	Default
api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
type required	PrivateLink 엔드포인트 액션 유형 Example : `CANCEL`	enum (APPROVE, REJECT)

1.2.49 - PrivateLinkEndpointConnectionRequest

Name	Description	Schema	Default
api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
type required	PrivateLink 엔드포인트 액션 유형 Example : `CANCEL`	enum (DISCONNECT, RECONNECT)

1.2.50 - PrivateLinkEndpointCreateRequest

Name	Description	Schema
description optional	설명 Example : `description`	any of [string, null]
name required	PrivateLink 엔드포인트명 Example : `endpoint` Pattern : `^[a-zA-Z0-9]$` Minimum length* : `3` Maximum length : `20`	string
privatelink_service_id required	PrivateLink 서비스 ID Example : `27bb070b564349f8a31cc60734cc36a5`	string

1.2.51 - PrivateLinkEndpointDetail

Name	Description	Schema
created_at required	생성 일시 Example : `2024-05-17T00:23:17Z`	string (date-time)
description optional	설명 Example : `description`	string
id required	PrivateLink 엔드포인트 ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
name required	PrivateLink 엔드포인트명 Example : `endpoint`	string
privatelink_service_id required	PrivateLink 서비스 ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
status required	PrivateLink 엔드포인트 상태 Example : `CANCELED`	string

1.2.52 - PrivateLinkEndpointListResponse

Name	Description	Schema	Default
count required	총 개수 Example : `20`	integer
privatelink_endpoints required		array[PrivateLinkEndpoint]

1.2.53 - PrivateLinkEndpointRequestRequest

Name	Description	Schema	Default
type required	PrivateLink 엔드포인트 액션 유형 Example : `CANCEL`	enum (CANCEL, RE_REQUEST)

1.2.54 - PrivateLinkEndpointSetRequest

Name	Description	Schema	Default
description optional	설명 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	생성 일시 Example : `2024-05-17T00:23:17Z`	string (date-time)
id required	PrivateLink 엔드포인트 ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
status required	PrivateLink 엔드포인트 상태 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	호출 수 Example : `10`	integer
date required	날짜 Example :	string
error_4xx_count required	4xx 에러 수 Example : `10`	integer
error_5xx_count optional	5xx 에러 수 Example : `10`	integer
integration_latency required	통합 지연시간 Example : `10`	object
latency required	지연시간 Example : `10`	object

1.2.59 - ReportListResponse

Name	Description	Schema
count required	총 개수 Example : `20`	integer
reports required		array[Report]
top_resources required		array[TopResource]

1.2.60 - Resource

Name	Description	Schema
id required	리소스 ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
methods required		array[Method]
parent_id required	부모 리소스 ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
path required	경로 Example : `/test/test1`	string
path_part required	경로명 Example : `test`	string

1.2.61 - ResourceCreateRequest

Name	Description	Schema	Default
path_part required	경로명 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	리소스 ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
parent_id required	부모 리소스 ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
path required	경로 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	메서드 유형 Example : `GET`	array[string]
path required	경로 Example : `/test/test1`	string

1.2.70 - ResourceSummaryV1Dot1

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

1.2.71 - ResourceV1Dot1

Name	Description	Schema
id required	리소스 ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
methods required		array[MethodV1Dot1]
parent_id required	부모 리소스 ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
path required	경로 Example : `/test/test1`	string
path_part required	경로명 Example : `test`	string

1.2.72 - ResourceV1Dot2

Name	Description	Schema
id required	리소스 ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
methods required		array[MethodV1Dot2]
parent_id required	부모 리소스 ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
path required	경로 Example : `/test/test1`	string
path_part required	경로명 Example : `test`	string

1.2.73 - Stage

Name	Description	Schema
active_deployment required	활성화 배포 Example : `2024-05-17T00:23:17Z`	string (date-time)
allow_credentials optional	허용 인증 Example : `True`	any of [boolean, null]
allow_headers optional	허용 헤더 Example : `['Content-Type', 'Authorization']`	any of [array[string], null]
allow_methods optional	허용 메서드 Example : `['GET', 'POST', 'PUT', 'PATCH']`	any of [array[enum (GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS, ANY)], null]
allow_origins optional	허용 원본 Example : `['*']`	any of [array[string], null]
api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
api_summary required	API 요약 Example : `[{'methods': ['GET', 'POST'], 'path': '/'}, {'methods': ['GET', 'POST'], 'path': '/test'}]`	array[ResourceSummary]
cors_enabled required	CORS 사용여부 Example : `False`	boolean
created_at required	생성 일시 Example : `2026-02-11T06:40:18.594Z`	string (date-time)
deployment_id required	배포 ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
expose_headers optional	노출 헤더 Example : `['test1', 'test2']`	any of [array[string], null]
invoke_url required	호출 URL Example : `http://test.com/stg`	string
ip_restriction_enabled required	IP 접근제어 사용여부 Example : `False`	boolean
jwt_enabled required	JWT 사용여부 Example : `False`	boolean
max_age optional	최대 캐시 기간 Example : `3600`	any of [integer, null]
name required	스테이지명 Example : `test-stage`	string

1.2.74 - StageCreateRequest

Name	Description	Schema
deployment_id required	배포 ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
description optional	설명 Example : `description`	any of [string, null]
stage_name required	이름 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	활성화 배포 Example : `2024-05-17T00:23:17Z`	string (date-time)
allow_credentials optional	허용 인증 Example : `True`	any of [boolean, null]
allow_headers optional	허용 헤더 Example : `['Content-Type', 'Authorization']`	any of [array[string], null]
allow_methods optional	허용 메서드 Example : `['GET', 'POST', 'PUT', 'PATCH']`	any of [array[enum (GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS, ANY)], null]
allow_origins optional	허용 원본 Example : `['*']`	any of [array[string], null]
api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
cors_enabled required	CORS 사용여부 Example : `False`	boolean
created_at required	생성 일시 Example : `2026-02-11T06:40:18.683Z`	string (date-time)
deployment_id required	배포 ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
expose_headers optional	노출 헤더 Example : `['test1', 'test2']`	any of [array[string], null]
invoke_url required	호출 URL Example : `http://test.com/stg`	string
ip_restriction_enabled required	IP 접근제어 사용여부 Example : `False`	boolean
jwt_enabled required	JWT 사용여부 Example : `False`	boolean
max_age optional	최대 캐시 기간 Example : `3600`	any of [integer, null]
name required	스테이지명 Example : `test-stage`	string

1.2.76 - StageDetailV1Dot1

Name	Description	Schema
active_deployment required	활성화 배포 Example : `2024-05-17T00:23:17Z`	string (date-time)
allow_credentials optional	허용 인증 Example : `True`	any of [boolean, null]
allow_headers optional	허용 헤더 Example : `['Content-Type', 'Authorization']`	any of [array[string], null]
allow_methods optional	허용 메서드 Example : `['GET', 'POST', 'PUT', 'PATCH']`	any of [array[enum (GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS, ANY)], null]
allow_origins optional	허용 원본 Example : `['*']`	any of [array[string], null]
api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
api_key_required required	API Key 사용여부 Example : `False`	boolean
cors_enabled required	CORS 사용여부 Example : `False`	boolean
created_at required	생성 일시 Example : `2026-02-11T06:40:19.189Z`	string (date-time)
deployment_id required	배포 ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
description optional	설명 Example : `description`	any of [string, null]
expose_headers optional	노출 헤더 Example : `['test1', 'test2']`	any of [array[string], null]
invoke_url required	호출 URL Example : `http://test.com/stg`	string
jwt_enabled required	JWT 사용여부 Example : `False`	boolean
max_age optional	최대 캐시 기간 Example : `3600`	any of [integer, null]
name required	스테이지명 Example : `test-stage`	string
usage_plan_api_keys optional	API Key	any of [array[ApiKeyInStage], null]
usage_plan_id optional	사용량 정책 ID Example : `27bb070b564349f8a31cc60734cc36a5`	any of [string, null]
usage_plan_limit optional	사용량 정책 할당량 Example : `10`	any of [integer, null]
usage_plan_name optional	이름 Example : `usage-plan-name`	any of [string, null]
usage_plan_rate optional	사용량 정책 주기 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	배포 ID Example : `27bb070b564349f8a31cc60734cc36a5`	string

1.2.80 - StageSetConfigRequest

Name	Description	Schema
allow_credentials optional	허용 인증 Example : `True`	any of [boolean, null]
allow_headers optional	허용 헤더 Example : `['Content-Type', 'Authorization']`	any of [array[string], null]
allow_methods optional	허용 메서드 Example : `['GET', 'POST', 'PUT', 'PATCH']`	any of [array[enum (GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS, ANY)], null]
allow_origins optional	허용 원본 Example : `['*']`	any of [array[string], null]
cors_enabled required	CORS 사용여부 Example : `False`	boolean
expose_headers optional	노출 헤더 Example : `['test1', 'test2']`	any of [array[string], null]
ip_restriction_enabled required	IP 접근제어 사용여부 Example : `False`	boolean
jwt_enabled required	JWT 사용여부 Example : `False`	boolean
max_age optional	최대 캐시 기간 Example : `3600`	any of [integer, null]

1.2.81 - StageSetConfigRequestV1Dot1

Name	Description	Schema
allow_credentials optional	허용 인증 Example : `True`	any of [boolean, null]
allow_headers optional	허용 헤더 Example : `['Content-Type', 'Authorization']`	any of [array[string], null]
allow_methods optional	허용 메서드 Example : `['GET', 'POST', 'PUT', 'PATCH']`	any of [array[enum (GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS, ANY)], null]
allow_origins optional	허용 원본 Example : `['*']`	any of [array[string], null]
connected_api_keys optional	연결된 API Key 목록 Example : `['key1', 'key2']`	any of [array[string], null]
cors_enabled required	CORS 사용여부 Example : `False`	boolean
description optional	설명 Example : `description`	any of [string, null]
expose_headers optional	노출 헤더 Example : `['test1', 'test2']`	any of [array[string], null]
jwt_enabled required	JWT 사용여부 Example : `False`	boolean
max_age optional	최대 캐시 기간 Example : `3600`	any of [integer, null]
usage_plan_id optional	사용량 정책 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	활성화 배포 Example : `2024-05-17T00:23:17Z`	string (date-time)
allow_credentials optional	허용 인증 Example : `True`	any of [boolean, null]
allow_headers optional	허용 헤더 Example : `['Content-Type', 'Authorization']`	any of [array[string], null]
allow_methods optional	허용 메서드 Example : `['GET', 'POST', 'PUT', 'PATCH']`	any of [array[enum (GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS, ANY)], null]
allow_origins optional	허용 원본 Example : `['*']`	any of [array[string], null]
api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
api_key_required required	API Key 사용여부 Example : `False`	boolean
api_summary required	API 요약 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 사용여부 Example : `False`	boolean
created_at required	생성 일시 Example : `2026-02-11T06:40:19.082Z`	string (date-time)
deployment_id required	배포 ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
description optional	설명 Example : `description`	any of [string, null]
expose_headers optional	노출 헤더 Example : `['test1', 'test2']`	any of [array[string], null]
invoke_url required	호출 URL Example : `http://test.com/stg`	string
jwt_enabled required	JWT 사용여부 Example : `False`	boolean
max_age optional	최대 캐시 기간 Example : `3600`	any of [integer, null]
name required	스테이지명 Example : `test-stage`	string
usage_plan_api_keys optional	API Key	any of [array[ApiKeyInStage], null]
usage_plan_id optional	사용량 정책 ID Example : `27bb070b564349f8a31cc60734cc36a5`	any of [string, null]
usage_plan_limit optional	사용량 정책 할당량 Example : `10`	any of [integer, null]
usage_plan_name optional	이름 Example : `usage-plan-name`	any of [string, null]
usage_plan_rate optional	사용량 정책 주기 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	호출 수 Example : `10`	integer
name required	리소스명 Example : `test`	string
path required	리소스 경로 Example : `/test/test1`	string
type required	메서드 유형 Example : `GET`	string

1.2.87 - UsagePlan

Name	Description	Schema
connected_api_keys required	연결된 API Key 목록 Example : `['key1', 'key2']`	array[string]
created_at required	생성 일시 Example : `2026-02-11T06:40:19.345Z`	string (date-time)
description optional	설명 Example : `description`	string
id required	사용량 정책 ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
limit required	사용량 정책 할당량 Example : `10`	integer
name required	이름 Example : `usage-plan-name`	string
rate required	사용량 정책 주기 Example : `day`	enum (hour, day, month)

1.2.88 - UsagePlanCreateRequest

Name	Description	Schema
description optional	설명 Example : `description`	any of [string, null]
limit required	사용량 정책 할당량 Example : `10` Minimum : `1` Maximum : `2000000000`	integer
name required	이름 Example : `usage-plan-name` Pattern : `^[a-z][a-z0-9\-]{1,48}[a-z0-9]$` Minimum length : `3` Maximum length : `50`	string
rate required	사용량 정책 주기 Example : `day`	enum (hour, day, month)

1.2.89 - UsagePlanDetail

Name	Description	Schema
api_keys required	API Key	array[ApiKey]
created_at required	생성 일시 Example : `2026-02-11T06:40:19.405Z`	string (date-time)
created_by_id required	생성자 Example : `27bb070b564349f8a31cc60734cc36a5`	string
created_by_name required	생성자 Example : `username`	string
description optional	설명 Example : `description`	string
id required	사용량 정책 ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
limit required	사용량 정책 할당량 Example : `10`	integer
modified_at required	수정시간 Example : `2026-02-11T06:40:19.405Z`	string (date-time)
modified_by_id required	수정자 Example : `27bb070b564349f8a31cc60734cc36a5`	string
modified_by_name required	수정자 Example : `username`	string
name required	이름 Example : `usage-plan-name`	string
rate required	사용량 정책 주기 Example : `day`	enum (hour, day, month)

1.2.90 - UsagePlanListResponse

Name	Description	Schema	Default
count required	총 개수 Example : `20`	integer
usage_plans required		array[UsagePlan]

1.2.91 - UsagePlanSetDescriptionRequest

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

1.2.92 - UsagePlanSetQuotaRequest

Name	Description	Schema	Default
limit required	사용량 정책 할당량 Example : `10` Minimum : `1` Maximum : `2000000000`	integer
rate required	사용량 정책 주기 Example : `day`	enum (hour, day, month)

1.2.93 - UsagePlanShowResponse

Name	Description	Schema	Default
usage_plan required		UsagePlanDetail

2 - Queue Service

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 응용 프로그램 인터페이스(Application Programming Interface, API)를 제공합니다.

본 가이드는 Queue Service 서비스에 대한 간략한 설명 및 API를 호출하는 방법을 제공합니다. API는 RESTful API 방식으로 제공되며, JSON 형식으로 응답합니다.

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

Queue명 중복 체크

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
query	name required	Queue명 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 = ko-KR",
"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

Queue 생성

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
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 = ko-KR",
"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

접근 허용 IP 삭제

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
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 = ko-KR",
"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

Queue 삭제

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
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 = ko-KR",
"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

Queue 조회

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
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명 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 = ko-KR",
"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

접근 허용 IP 추가

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
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 = ko-KR",
"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

Queue 상세 조회

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
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 = ko-KR",
"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

Queue 구성 설정 수정

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
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 = ko-KR",
"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

Queue 설명 수정

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
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 = ko-KR",
"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 주소 Example : `192.168.0.0`	string

2.2.2 - AclRequest

Name	Description	Schema	Default
ip_address required	접근 허용 IP 목록 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	결과 Example : `True`	boolean

2.2.5 - ConfigSetRequest

Name	Description	Schema
data_key_reuse_period optional	데이터 키 재사용 기간 Example : `40`	any of [integer, null]
data_key_reuse_period_unit optional	기간 단위 Example : `minute`	any of [enum (minute, hour), null]
encryption optional	암호화	any of [Encryption, null]
message_retention_period required	메시지 보존 기간 Example : `40` Minimum : `1` Maximum : `1209600`	integer
message_retention_period_unit required	기간 단위 Example : `minute`	enum (second, minute, hour, day)
message_size required	메시지 크기 Example : `256` Minimum : `1` Maximum : `256`	integer

2.2.6 - DescriptionSetRequest

Name	Description	Schema	Default
description required	설명 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명 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	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
encryption optional	암호화	any of [Encryption, null]
id required	Queue ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	Queue명 Example : `test-queue.fifo`	string
number_wait_messages required	대기 메시지 수 Example : `10`	integer
state required	Queue 상태 Example : `ACTIVE`	string
type required	Queue 유형 Example : `FIFO`	string

2.2.10 - QueueCreateRequest

Name	Description	Schema
data_key_reuse_period optional	데이터 키 재사용 기간 Example : `40`	any of [integer, null]
data_key_reuse_period_unit optional	기간 단위 Example : `minute`	any of [enum (minute, hour), null]
description optional	설명 Example : `Queue description`	any of [string, null]
encryption optional	암호화	any of [Encryption, null]
message_retention_period required	메시지 보존 기간 Example : `40` Minimum : `1` Maximum : `1209600`	integer
message_retention_period_unit required	기간 단위 Example : `minute`	enum (second, minute, hour, day)
message_size required	메시지 크기 Example : `256` Minimum : `1` Maximum : `256`	integer
name required	Queue명 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	태그 목록	any of [array[Tag], null]

2.2.11 - QueueCreateResponse

Name	Description	Schema
id required	Queue ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string
messages required	설명 Example : `Create Queue`	string
state required	Queue 상태 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 목록	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	접근 허용 IP 목록 Example : `['0.0.0.0', '192.168.0.0']`	any of [array[Acl], null]
console_polling_count required	폴링 개수 Example : `10`	integer
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
data_key_reuse_period optional	데이터 키 재사용 기간 Example : `40`	any of [integer, null]
data_key_reuse_period_unit optional	기간 단위 Example : `minute`	any of [enum (minute, hour), null]
description optional	설명 Example : `Queue description`	any of [string, null]
encryption optional	암호화	any of [Encryption, null]
id required	ID Example : `0fdd87aab8cb46f59b7c1f81ed03fb3e`	string
message_retention_period required	메시지 보존 기간 Example : `40`	integer
message_retention_period_unit required	기간 단위 Example : `minute`	enum (second, minute, hour, day)
message_size required	메시지 크기 Example : `256`	integer
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	Queue명 Example : `test-queue.fifo`	string
number_wait_messages required	대기 메시지 수 Example : `10`	integer
state required	Queue 상태 Example : `ACTIVE`	string
type required	Queue 유형 Example : `FIFO`	string

2.2.14 - Tag

Name	Description	Schema	Default
key required	태그키 Example : `key1`	string
value required	태그값 Example : `value1`	any of [string, null]