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

이 페이지의 일반 화면으로 돌아가기.

API Gateway

Overview

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

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

Version

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

VersionStatusNot Before
1.3CURRENT-
1.2SUPPORTED20260630
1.1DEPRECATED20260430
1.0DEPRECATED20251231

OpenAPI URL

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

Environment and Region List

environmentregion
skr-west1
skr-east1
gkr-south1
gkr-south2
gkr-south3
ekr-west1
ekr-east1

API Version History

1.3

리소스 정책 기능이 추가되었습니다.
List Resources API의 응답이 변경되었습니다.
Get Resource API의 응답이 변경되었습니다.
List Methods API의 응답이 변경되었습니다.
Create Method API의 요청이 변경되었습니다.
Set Method API의 요청이 변경되었습니다.
Get Method API의 응답이 변경되었습니다.
List Stages API의 응답이 변경되었습니다.
Get Stage API의 응답이 변경되었습니다.

변경사항

  • [신규] GET /apis/{api_id}/resource-policies - Show Resource Policy API가 추가되었습니다.
  • [신규] PUT /apis/{api_id}/resource-policies - Set Resource Policy API가 추가되었습니다.
  • [신규] DELETE /apis/{api_id}/resource-policies - Delete Resource Policy API가 추가되었습니다.
  • [변경] GET /apis/{api_id}/resources - 응답 시, 아래와 같은 필드가 추가됩니다.
    • iam_enabled
  • [변경] GET /apis/{api_id}/resources/{resource_id} - 응답 시, 아래와 같은 필드가 추가됩니다.
    • iam_enabled
  • [변경] GET /apis/{api_id}/resources/{resource_id}/methods - 응답 시, 아래와 같은 필드가 추가됩니다.
    • iam_enabled
  • [변경] POST /apis/{api_id}/resources/{resource_id}/methods - 요청 시, 아래와 같은 필드가 추가됩니다.
    • iam_enabled
  • [변경] PUT /apis/{api_id}/resources/{resource_id}/methods/{method_type} - 요청 시, 아래와 같은 필드가 추가됩니다.
    • iam_enabled
  • [변경] GET /apis/{api_id}/resources/{resource_id}/methods/{method_type} - 응답 시, 아래와 같은 필드가 추가됩니다.
    • iam_enabled
  • [변경] GET /apis/{api_id}/stages - 응답 시, 아래와 같은 필드가 추가됩니다.
    • description
    • api_key_required
    • usage_plan_name
    • uesage_plan_id
    • usage_plan_rate
    • usage_plan_limit
    • usage_plan_api_keys
  • [변경] GET /apis/{api_id}/stages - 응답 시, 아래와 같은 필드가 삭제됩니다.
    • api_key_required
  • [변경] GET /apis/{api_id}/stages - 응답 시, methods 필드의 형태가 아래처럼 변경됩니다.
    • 기존 "methods": [{"type": GET", "api_key_required": true}]
    • 변경 "methods": [{"type": GET", "api_key_required": true, "iam_enabled": true}]
  • [변경] GET /apis/{api_id}/stages/{stage_name} - 응답 시, 아래와 같은 필드가 삭제됩니다.
    • api_key_required

1.2

PrivateLink 기능이 추가되었습니다.
List Apis API의 응답이 변경되었습니다.
Create Api API의 요청이 변경되었습니다.
Get Api API의 응답이 변경되었습니다.
List Resources API의 응답이 변경되었습니다.
Get Resource API의 응답이 변경되었습니다.
List Methods API의 응답이 변경되었습니다.
Create Method API의 요청이 변경되었습니다.
Set Method API의 요청이 변경되었습니다.
Get Method API의 응답이 변경되었습니다.

변경사항

  • [신규] GET /apis/{api_id}/connected-endpoints - List Connected PrivateLink Endpoints API가 추가되었습니다.
  • [신규] GET /privatelink-endpoints - List PrivateLink Endpoints API가 추가되었습니다.
  • [신규] POST /privatelink-endpoints - Create PrivateLink Endpoint API가 추가되었습니다.
  • [신규] DELETE /privatelink-endpoints/{privatelink_endpoint_id} - Delete PrivateLink Endpoint API가 추가되었습니다.
  • [신규] PUT /privatelink-endpoints/{privatelink_endpoint_id} - Set PrivateLink Endpoint API가 추가되었습니다.
  • [신규] PUT /privatelink-endpoints/{privatelink_endpoint_id}/approval - Approve PrivateLink Endpoint API가 추가되었습니다.
  • [신규] PUT /privatelink-endpoints/{privatelink_endpoint_id}/connection - Connect PrivateLink Endpoint API가 추가되었습니다.
  • [신규] PUT /privatelink-endpoints/{privatelink_endpoint_id}/request - Request PrivateLink Endpoint API가 추가되었습니다.
  • [신규] GET /privatelink-endpoints/{privatelink_endpoint_id} - Show PrivateLink Endpoint API가 추가되었습니다.
  • [변경] GET /apis - 응답 시, 아래와 같은 필드가 추가됩니다.
    • endpoint_type
  • [변경] POST /apis - 요청 시, 아래와 같은 필드가 추가됩니다.
    • endpoint_type
  • [변경] GET /apis/{api_id} - 응답 시, 아래와 같은 필드가 추가됩니다.
    • endpoint_type
    • privatelink_service_id
  • [변경] GET /apis/{api_id}/resources - 응답 시, 아래와 같은 필드가 추가됩니다.
    • privatelink_endpoint_id
  • [변경] GET /apis/{api_id}/resources/{resource_id} - 응답 시, 아래와 같은 필드가 추가됩니다.
    • privatelink_endpoint_id
  • [변경] GET /apis/{api_id}/resources/{resource_id}/methods - 응답 시, 아래와 같은 필드가 추가됩니다.
    • privatelink_endpoint_id
  • [변경] POST /apis/{api_id}/resources/{resource_id}/methods - 요청 시, 아래와 같은 필드가 추가됩니다.
    • privatelink_endpoint_id
  • [변경] PUT /apis/{api_id}/resources/{resource_id}/methods/{method_type} - 요청 시, 아래와 같은 필드가 추가됩니다.
    • privatelink_endpoint_id
  • [변경] GET /apis/{api_id}/resources/{resource_id}/methods/{method_type} - 응답 시, 아래와 같은 필드가 추가됩니다.
    • privatelink_endpoint_id

1.1

사용량 정책 기능이 추가되었습니다.
API Key 관리 기능이 추가되었습니다.
Report 기능이 추가되었습니다.
List Resources API의 응답이 변경되었습니다.
Get Resource API의 응답이 변경되었습니다.
List Methods API의 응답이 변경되었습니다.
Create Method API의 요청이 변경되었습니다.
Set Method API의 요청이 변경되었습니다.
Get Method API의 응답이 변경되었습니다.
List Stages API의 응답이 변경되었습니다.
Set Stage Configuration API의 요청이 변경되었습니다.
Get Stage API의 응답이 변경되었습니다.

변경사항

  • [신규] GET /apis/{api_id}/usage-palns - List Usage Plans API가 추가되었습니다.
  • [신규] POST /apis/{api_id}/usage-palns - Create Usage Plan API가 추가되었습니다.
  • [신규] PUT /apis/{api_id}/usage-plans/{usage_plan_id}/description - Set Usage Plan Description API가 추가되었습니다.
  • [신규] PUT /apis/{api_id}/usage-plans/{usage_plan_id}/quota - Set Usage Plan Quota API가 추가되었습니다.
  • [신규] DELETE /apis/{api_id}/usage-plans/{usage_plan_id} - Delete Usage Plan API가 추가되었습니다.
  • [신규] GET /apis/{api_id}/usage-plans/{usage_plan_id} - Show Usage Plan API가 추가되었습니다.
  • [신규] GET /apis/{api_id}/usage-palns/{usage_plan_id}/api-keys - List Api Keys API가 추가되었습니다.
  • [신규] POST /apis/{api_id}/usage-palns/{usage_plan_id}/api-keys - Create APi Key API가 추가되었습니다.
  • [신규] PUT /apis/{api_id}/usage-plans/{usage_plan_id}/api-keys/{api_key_id}/description - Set Api Key Description API가 추가되었습니다.
  • [신규] DELETE /apis/{api_id}/usage-plans/{usage_plan_id}/api-keys/{api_key_id} - Delete Api Key API가 추가되었습니다.
  • [신규] GET /apis/{api_id}/reports - List Reports API가 추가되었습니다.
  • [변경] GET /apis/{api_id}/resources - 응답 시, 아래와 같은 필드가 추가됩니다.
    • function_name
    • api_key_required
  • [변경] GET /apis/{api_id}/resources/{resource_id} - 응답 시, 아래와 같은 필드가 추가됩니다.
    • function_name
    • api_key_required
  • [변경] GET /apis/{api_id}/resources/{resource_id}/methods - 응답 시, 아래와 같은 필드가 추가됩니다.
    • function_name
    • api_key_required
  • [변경] POST /apis/{api_id}/resources/{resource_id}/methods - 요청 시, 아래와 같은 필드가 추가됩니다.
    • api_key_required
  • [변경] PUT /apis/{api_id}/resources/{resource_id}/methods/{method_type} - 요청 시, 아래와 같은 필드가 추가됩니다.
    • api_key_required
    • endpoint_url
    • function_id
    • integration_type
  • [변경] GET /apis/{api_id}/resources/{resource_id}/methods/{method_type} - 응답 시, 아래와 같은 필드가 추가됩니다.
    • function_name
    • api_key_required
  • [변경] GET /apis/{api_id}/stages - 응답 시, 아래와 같은 필드가 추가됩니다.
    • description
    • api_key_required
    • usage_plan_name
    • uesage_plan_id
    • usage_plan_rate
    • usage_plan_limit
    • usage_plan_api_keys
  • [변경] GET /apis/{api_id}/stages - 응답 시, 아래와 같은 필드가 삭제됩니다.
    • ip_restriction_enabled
  • [변경] GET /apis/{api_id}/stages - 응답 시, methods 필드의 형태가 아래처럼 변경됩니다.
    • 기존 "methods": ["GET", "POST"]
    • 변경 "methods": [{"type": GET", "api_key_required": true}]
  • [변경] PUT /apis/{api_id}/stages/{stage_name}/config - 요청 시, 아래와 같은 필드가 추가됩니다.
    • description
    • usage_plan_id
    • connected_api_keys
  • [변경] PUT /apis/{api_id}/stages/{stage_name}/config - 요청 시, 아래와 같은 필드가 삭제됩니다.
    • ip_restriction_enabled
  • [변경] GET /apis/{api_id}/stages/{stage_name} - 응답 시, 아래와 같은 필드가 추가됩니다.
    • description
    • api_key_required
    • usage_plan_name
    • uesage_plan_id
    • usage_plan_rate
    • usage_plan_limit
    • usage_plan_api_keys
  • [변경] GET /apis/{api_id}/stages/{stage_name} - 응답 시, 아래와 같은 필드가 삭제됩니다.
    • ip_restriction_enabled

1.0

API Gateway가 출시되었습니다.

변경사항

  • [신규] GET /apis - List APis API가 추가되었습니다.
  • [신규] POST /apis - Create Api API가 추가되었습니다.
  • [신규] PUT /apis/{api_id}/description - Set Api Description API가 추가되었습니다.
  • [신규] DELETE /apis/{api_id} - Delete Api API가 추가되었습니다.
  • [신규] GET /apis/{api_id} - Show Api API가 추가되었습니다.
  • [신규] GET /apis/{api_id}/deployments - List Api Deployments API가 추가되었습니다.
  • [신규] POST /apis/{api_id}/deployments - Create Api Deployment API가 추가되었습니다.
  • [신규] GET /apis/{api_id}/resources - List Resources API가 추가되었습니다.
  • [신규] POST /apis/{api_id}/resources/{parent_id} - Create Resource API가 추가되었습니다.
  • [신규] DELETE /apis/{api_id}/resources/{resource_id} - Delete Resource API가 추가되었습니다.
  • [신규] GET /apis/{api_id}/resources/{resource_id} - Show Resource API가 추가되었습니다.
  • [신규] GET /apis/{api_id}/resources/{resource_id}/methods - List Methods API가 추가되었습니다.
  • [신규] POST /apis/{api_id}/resources/{resource_id}/methods - Create Method API가 추가되었습니다.
  • [신규] PUT /apis/{api_id}/resources/{resource_id}/methods/{method_type} - Set Method API가 추가되었습니다.
  • [신규] DELETE /apis/{api_id}/resources/{resource_id}/methods/{method_type} - Delete Method API가 추가되었습니다.
  • [신규] GET /apis/{api_id}/resources/{resource_id}/methods/{method_type} - Show Method API가 추가되었습니다.
  • [신규] GET /apis/{api_id}/stages - List Stages API가 추가되었습니다.
  • [신규] POST /apis/{api_id}/stages - Create Stage API가 추가되었습니다.
  • [신규] DELETE /apis/{api_id}/stages/{stage_name} - Delete Stage API가 추가되었습니다.
  • [신규] GET /apis/{api_id}/stages/{stage_name} - Show Stage API가 추가되었습니다.
  • [신규] PUT /apis/{api_id}/stages/{stage_name}/deployment - Set Stage Active Deployment API가 추가되었습니다.
  • [신규] PUT /apis/{api_id}/stages/{stage_name}/config - Set Stage Configuration API가 추가되었습니다.
  • [신규] GET /apis/{api_id}/auths - List Auths API가 추가되었습니다.
  • [신규] POST /apis/{api_id}/auths - Create Auth API가 추가되었습니다.
  • [신규] PUT /apis/{api_id}/auths/{auth_id} - Set Auth API가 추가되었습니다.
  • [신규] DELETE /apis/{api_id}/auths/{auth_id} - Delete Auth API가 추가되었습니다.
  • [신규] GET /apis/{api_id}/auths/{auth_id} - Show Auth API가 추가되었습니다.
  • [신규] GET /apis/{api_id}/access-controls - List AccessControls API가 추가되었습니다.
  • [신규] POST /apis/{api_id}/access-controls - Create AccessControl API가 추가되었습니다.
  • [신규] PUT /apis/{api_id}/access-controls/{access_control_id} - Set AccessControl API가 추가되었습니다.
  • [신규] DELETE /apis/{api_id}/access-controls/{access_control_id} - Delete AccessControl API가 추가되었습니다.
  • [신규] GET /apis/{api_id}/access-controls/{access_control_id} - Show AccessControl API가 추가되었습니다.

1 - APIs

1.1 - Approve PrivateLink Endpoint

1.1.1 - 1.3

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

Description

PrivateLink 엔드포인트를 승인한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathprivatelink_endpoint_id
required		PrivateLink 엔드포인트 ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
bodybody
required
PrivateLinkEndpointApprovalRequest

Responses

HTTP CodeDescriptionSchema
200OKPrivateLinkEndpointSummaryShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.3"

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

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

Description

PrivateLink 엔드포인트를 승인한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

TypeNameDescriptionSchemaDefault
pathprivatelink_endpoint_id
required		PrivateLink 엔드포인트 ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
bodybody
required
PrivateLinkEndpointApprovalRequest

Responses

HTTP CodeDescriptionSchema
200OKPrivateLinkEndpointSummaryShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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

1.2.1 - 1.3

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

Description

PrivateLink 엔드포인트를 연결한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathprivatelink_endpoint_id
required		PrivateLink 엔드포인트 ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
bodybody
required
PrivateLinkEndpointConnectionRequest

Responses

HTTP CodeDescriptionSchema
200OKPrivateLinkEndpointSummaryShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.3"

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.2.2 - 1.2

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

Description

PrivateLink 엔드포인트를 연결한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

TypeNameDescriptionSchemaDefault
pathprivatelink_endpoint_id
required		PrivateLink 엔드포인트 ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
bodybody
required
PrivateLinkEndpointConnectionRequest

Responses

HTTP CodeDescriptionSchema
200OKPrivateLinkEndpointSummaryShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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

1.3.1 - 1.3

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

Description

접근제어를 생성한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example :
stringNone
bodybody
required
AccessControlCreateRequest

Responses

HTTP CodeDescriptionSchema
201CreatedAccessControlCreateResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.3"

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.3.2 - 1.2

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

Description

접근제어를 생성한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example :
stringNone
bodybody
required
AccessControlCreateRequest

Responses

HTTP CodeDescriptionSchema
201CreatedAccessControlCreateResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.3.3 - 1.1

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

Description

접근제어를 생성한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.120260430

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example :
stringNone
bodybody
required
AccessControlCreateRequest

Responses

HTTP CodeDescriptionSchema
201CreatedAccessControlCreateResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.3.4 - 1.0

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

Description

접근제어를 생성한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example :
stringNone
bodybody
required
AccessControlCreateRequest

Responses

HTTP CodeDescriptionSchema
201CreatedAccessControlCreateResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.4 - Create Api

1.4.1 - 1.3

post /v1/apis

Description

API를 생성한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required
ApiCreateRequestV1Dot2

Responses

HTTP CodeDescriptionSchema
202AcceptedApiCreateResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.3"

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.4.2 - 1.2

post /v1/apis

Description

API를 생성한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required
ApiCreateRequestV1Dot2

Responses

HTTP CodeDescriptionSchema
202AcceptedApiCreateResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.4.3 - 1.1

post /v1/apis

Description

API를 생성한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.120260430

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required
ApiCreateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedApiCreateResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.4.4 - 1.0

post /v1/apis

Description

API를 생성한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required
ApiCreateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedApiCreateResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.5 - Create Api Deployment

1.5.1 - 1.3

post /v1/apis/{api_id}/deployments

Description

API를 배포한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 31e749b7b260868f441e862b
stringNone
bodybody
required
ApiDeploymentRequest

Responses

HTTP CodeDescriptionSchema
200OKApiDeploymentResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.3"

Request body

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

Example HTTP response

Response 200

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

1.5.2 - 1.2

post /v1/apis/{api_id}/deployments

Description

API를 배포한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 31e749b7b260868f441e862b
stringNone
bodybody
required
ApiDeploymentRequest

Responses

HTTP CodeDescriptionSchema
200OKApiDeploymentResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.5.3 - 1.1

post /v1/apis/{api_id}/deployments

Description

API를 배포한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.120260430

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 31e749b7b260868f441e862b
stringNone
bodybody
required
ApiDeploymentRequest

Responses

HTTP CodeDescriptionSchema
200OKApiDeploymentResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.5.4 - 1.0

post /v1/apis/{api_id}/deployments

Description

API를 배포한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 31e749b7b260868f441e862b
stringNone
bodybody
required
ApiDeploymentRequest

Responses

HTTP CodeDescriptionSchema
200OKApiDeploymentResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.6 - Create Api Key

1.6.1 - 1.3

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

Description

API Key를 생성한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
pathusage_plan_id
required		사용량 정책 ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
bodybody
required
ApiKeyCreateRequest

Responses

HTTP CodeDescriptionSchema
200OKApiKeyShowResponse
400Bad RequestNone
403ForbiddenNone

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.3"

Request body

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

Example HTTP response

Response 200

{
    "api_key": {
        "created_at": "2024-01-15T10:30:00.000Z",
        "description": "description",
        "id": "27bb070b564349f8a31cc60734cc36a5",
        "key": "key",
        "name": "api-key-name"
    }
}

1.6.2 - 1.2

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

Description

API Key를 생성한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
pathusage_plan_id
required		사용량 정책 ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
bodybody
required
ApiKeyCreateRequest

Responses

HTTP CodeDescriptionSchema
200OKApiKeyShowResponse
400Bad RequestNone
403ForbiddenNone

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": "2024-01-15T10:30:00.000Z",
        "description": "description",
        "id": "27bb070b564349f8a31cc60734cc36a5",
        "key": "key",
        "name": "api-key-name"
    }
}

1.6.3 - 1.1

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

Description

API Key를 생성한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.120260430

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
pathusage_plan_id
required		사용량 정책 ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
bodybody
required
ApiKeyCreateRequest

Responses

HTTP CodeDescriptionSchema
200OKApiKeyShowResponse
400Bad RequestNone
403ForbiddenNone

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": "2024-01-15T10:30:00.000Z",
        "description": "description",
        "id": "27bb070b564349f8a31cc60734cc36a5",
        "key": "key",
        "name": "api-key-name"
    }
}

1.7 - Create Auth

1.7.1 - 1.3

post /v1/apis/{api_id}/auths

Description

인증을 생성한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example :
stringNone
bodybody
required
AuthCreateRequest

Responses

HTTP CodeDescriptionSchema
201CreatedAuthCreateResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.3"

Request body

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

Example HTTP response

Response 201

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

1.7.2 - 1.2

post /v1/apis/{api_id}/auths

Description

인증을 생성한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example :
stringNone
bodybody
required
AuthCreateRequest

Responses

HTTP CodeDescriptionSchema
201CreatedAuthCreateResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.7.3 - 1.1

post /v1/apis/{api_id}/auths

Description

인증을 생성한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.120260430

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example :
stringNone
bodybody
required
AuthCreateRequest

Responses

HTTP CodeDescriptionSchema
201CreatedAuthCreateResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.7.4 - 1.0

post /v1/apis/{api_id}/auths

Description

인증을 생성한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example :
stringNone
bodybody
required
AuthCreateRequest

Responses

HTTP CodeDescriptionSchema
201CreatedAuthCreateResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.8 - Create Method

1.8.1 - 1.3

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

Description

메서드를 생성한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
pathresource_id
required		리소스 ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
bodybody
required
MethodCreateRequestV1Dot3

Responses

HTTP CodeDescriptionSchema
200OKMethodListResponseV1Dot3
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.3"

Request body

{
    "api_key_required": false,
    "endpoint_url": "https://127.0.0.1:8000",
    "function_id": "27bb070b564349f8a31cc60734cc36a5",
    "iam_enabled": false,
    "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",
            "iam_enabled": false,
            "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.8.2 - 1.2

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

Description

메서드를 생성한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
pathresource_id
required		리소스 ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
bodybody
required
MethodCreateRequestV1Dot2

Responses

HTTP CodeDescriptionSchema
200OKMethodListResponseV1Dot2
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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",
    "iam_enabled": false,
    "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.8.3 - 1.1

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

Description

메서드를 생성한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.120260430

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
pathresource_id
required		리소스 ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
bodybody
required
MethodCreateRequestV1Dot1

Responses

HTTP CodeDescriptionSchema
200OKMethodListResponseV1Dot1
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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",
    "iam_enabled": false,
    "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.8.4 - 1.0

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

Description

메서드를 생성한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
pathresource_id
required		리소스 ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
bodybody
required
MethodCreateRequest

Responses

HTTP CodeDescriptionSchema
200OKMethodListResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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",
    "iam_enabled": false,
    "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.9 - Create PrivateLink Endpoint

1.9.1 - 1.3

post /v1/privatelink-endpoints

Description

PrivateLink 엔드포인트를 생성한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required
PrivateLinkEndpointCreateRequest

Responses

HTTP CodeDescriptionSchema
200OKPrivateLinkEndpointShowResponse
400Bad RequestNone
403ForbiddenNone

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.3"

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.9.2 - 1.2

post /v1/privatelink-endpoints

Description

PrivateLink 엔드포인트를 생성한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required
PrivateLinkEndpointCreateRequest

Responses

HTTP CodeDescriptionSchema
200OKPrivateLinkEndpointShowResponse
400Bad RequestNone
403ForbiddenNone

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.10 - Create Resource

1.10.1 - 1.3

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

Description

리소스를 생성한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
pathparent_id
required		리소스 ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
bodybody
required
ResourceCreateRequest

Responses

HTTP CodeDescriptionSchema
200OKResourceCreateResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.3"

Request body

{
    "path_part": "test"
}

Example HTTP response

Response 200

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

1.10.2 - 1.2

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

Description

리소스를 생성한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
pathparent_id
required		리소스 ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
bodybody
required
ResourceCreateRequest

Responses

HTTP CodeDescriptionSchema
200OKResourceCreateResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.10.3 - 1.1

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

Description

리소스를 생성한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.120260430

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
pathparent_id
required		리소스 ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
bodybody
required
ResourceCreateRequest

Responses

HTTP CodeDescriptionSchema
200OKResourceCreateResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.10.4 - 1.0

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

Description

리소스를 생성한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
pathparent_id
required		리소스 ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
bodybody
required
ResourceCreateRequest

Responses

HTTP CodeDescriptionSchema
200OKResourceCreateResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.11 - Create Stage

1.11.1 - 1.3

post /v1/apis/{api_id}/stages

Description

스테이지를 생성한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
bodybody
required
StageCreateRequest

Responses

HTTP CodeDescriptionSchema
200OKStageShowResponseV1Dot1
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.3"

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": "2024-01-15T10:30:00.000Z",
        "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.11.2 - 1.2

post /v1/apis/{api_id}/stages

Description

스테이지를 생성한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
bodybody
required
StageCreateRequest

Responses

HTTP CodeDescriptionSchema
200OKStageShowResponseV1Dot1
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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": "2024-01-15T10:30:00.000Z",
        "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.11.3 - 1.1

post /v1/apis/{api_id}/stages

Description

스테이지를 생성한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.120260430

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
bodybody
required
StageCreateRequest

Responses

HTTP CodeDescriptionSchema
200OKStageShowResponseV1Dot1
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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": "2024-01-15T10:30:00.000Z",
        "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.11.4 - 1.0

post /v1/apis/{api_id}/stages

Description

스테이지를 생성한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
bodybody
required
StageCreateRequest

Responses

HTTP CodeDescriptionSchema
200OKStageShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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": "2024-01-15T10:30:00.000Z",
        "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.12 - Create Usage Plans

1.12.1 - 1.3

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

Description

사용량 정책을 생성한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
bodybody
required
UsagePlanCreateRequest

Responses

HTTP CodeDescriptionSchema
200OKUsagePlanShowResponse
400Bad RequestNone
403ForbiddenNone

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.3"

Request body

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

Example HTTP response

Response 200

{
    "usage_plan": {
        "api_keys": [],
        "created_at": "2024-01-15T10:30:00.000Z",
        "created_by_id": "27bb070b564349f8a31cc60734cc36a5",
        "created_by_name": "username",
        "description": "description",
        "id": "27bb070b564349f8a31cc60734cc36a5",
        "limit": 10,
        "modified_at": "2024-01-15T10:30:00.000Z",
        "modified_by_id": "27bb070b564349f8a31cc60734cc36a5",
        "modified_by_name": "username",
        "name": "usage-plan-name",
        "rate": "day"
    }
}

1.12.2 - 1.2

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

Description

사용량 정책을 생성한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
bodybody
required
UsagePlanCreateRequest

Responses

HTTP CodeDescriptionSchema
200OKUsagePlanShowResponse
400Bad RequestNone
403ForbiddenNone

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": "2024-01-15T10:30:00.000Z",
        "created_by_id": "27bb070b564349f8a31cc60734cc36a5",
        "created_by_name": "username",
        "description": "description",
        "id": "27bb070b564349f8a31cc60734cc36a5",
        "limit": 10,
        "modified_at": "2024-01-15T10:30:00.000Z",
        "modified_by_id": "27bb070b564349f8a31cc60734cc36a5",
        "modified_by_name": "username",
        "name": "usage-plan-name",
        "rate": "day"
    }
}

1.12.3 - 1.1

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

Description

사용량 정책을 생성한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.120260430

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
bodybody
required
UsagePlanCreateRequest

Responses

HTTP CodeDescriptionSchema
200OKUsagePlanShowResponse
400Bad RequestNone
403ForbiddenNone

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": "2024-01-15T10:30:00.000Z",
        "created_by_id": "27bb070b564349f8a31cc60734cc36a5",
        "created_by_name": "username",
        "description": "description",
        "id": "27bb070b564349f8a31cc60734cc36a5",
        "limit": 10,
        "modified_at": "2024-01-15T10:30:00.000Z",
        "modified_by_id": "27bb070b564349f8a31cc60734cc36a5",
        "modified_by_name": "username",
        "name": "usage-plan-name",
        "rate": "day"
    }
}

1.13 - Delete Access Control

1.13.1 - 1.3

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

Description

접근제어를 삭제한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example :
stringNone
pathaccess_control_id
required		접근제어 ID
Example :
stringNone

Responses

HTTP CodeDescriptionSchema
204No ContentNone
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.3"

Example HTTP response

Response 204

1.13.2 - 1.2

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

Description

접근제어를 삭제한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example :
stringNone
pathaccess_control_id
required		접근제어 ID
Example :
stringNone

Responses

HTTP CodeDescriptionSchema
204No ContentNone
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.13.3 - 1.1

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

Description

접근제어를 삭제한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.120260430

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example :
stringNone
pathaccess_control_id
required		접근제어 ID
Example :
stringNone

Responses

HTTP CodeDescriptionSchema
204No ContentNone
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.13.4 - 1.0

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

Description

접근제어를 삭제한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example :
stringNone
pathaccess_control_id
required		접근제어 ID
Example :
stringNone

Responses

HTTP CodeDescriptionSchema
204No ContentNone
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.14 - Delete an API Key

1.14.1 - 1.3

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

Description

API Key를 삭제한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
pathusage_plan_id
required		사용량 정책 ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
pathapi_key_id
required		API Key ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone

Responses

HTTP CodeDescriptionSchema
204No ContentNone
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.3"

Example HTTP response

Response 204

1.14.2 - 1.2

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

Description

API Key를 삭제한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
pathusage_plan_id
required		사용량 정책 ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
pathapi_key_id
required		API Key ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone

Responses

HTTP CodeDescriptionSchema
204No ContentNone
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.14.3 - 1.1

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

Description

API Key를 삭제한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.120260430

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
pathusage_plan_id
required		사용량 정책 ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
pathapi_key_id
required		API Key ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone

Responses

HTTP CodeDescriptionSchema
204No ContentNone
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.15 - Delete Api

1.15.1 - 1.3

delete /v1/apis/{api_id}

Description

API를 삭제한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 31e749b7b260868f441e862b
stringNone

Responses

HTTP CodeDescriptionSchema
204No ContentNone
403ForbiddenNone
404Not FoundNone

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.3"

Example HTTP response

Response 204

1.15.2 - 1.2

delete /v1/apis/{api_id}

Description

API를 삭제한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 31e749b7b260868f441e862b
stringNone

Responses

HTTP CodeDescriptionSchema
204No ContentNone
403ForbiddenNone
404Not FoundNone

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.15.3 - 1.1

delete /v1/apis/{api_id}

Description

API를 삭제한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.120260430

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 31e749b7b260868f441e862b
stringNone

Responses

HTTP CodeDescriptionSchema
204No ContentNone
403ForbiddenNone
404Not FoundNone

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.15.4 - 1.0

delete /v1/apis/{api_id}

Description

API를 삭제한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 31e749b7b260868f441e862b
stringNone

Responses

HTTP CodeDescriptionSchema
204No ContentNone
403ForbiddenNone
404Not FoundNone

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.16 - Delete Auth

1.16.1 - 1.3

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

Description

인증을 삭제한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example :
stringNone
pathauth_id
required		인증 ID
Example :
stringNone

Responses

HTTP CodeDescriptionSchema
204No ContentNone
403ForbiddenNone
404Not FoundNone

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.3"

Example HTTP response

Response 204

1.16.2 - 1.2

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

Description

인증을 삭제한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example :
stringNone
pathauth_id
required		인증 ID
Example :
stringNone

Responses

HTTP CodeDescriptionSchema
204No ContentNone
403ForbiddenNone
404Not FoundNone

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.16.3 - 1.1

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

Description

인증을 삭제한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.120260430

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example :
stringNone
pathauth_id
required		인증 ID
Example :
stringNone

Responses

HTTP CodeDescriptionSchema
204No ContentNone
403ForbiddenNone
404Not FoundNone

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.16.4 - 1.0

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

Description

인증을 삭제한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example :
stringNone
pathauth_id
required		인증 ID
Example :
stringNone

Responses

HTTP CodeDescriptionSchema
204No ContentNone
403ForbiddenNone
404Not FoundNone

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.17 - Delete Method

1.17.1 - 1.3

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

Description

메서드를 삭제한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
pathresource_id
required		리소스 ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
pathmethod_type
required		메서드 유형
Example : GET
enum (CONNECT, DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT, TRACE)None

Responses

HTTP CodeDescriptionSchema
204No ContentNone
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.3"

Example HTTP response

Response 204

1.17.2 - 1.2

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

Description

메서드를 삭제한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
pathresource_id
required		리소스 ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
pathmethod_type
required		메서드 유형
Example : GET
enum (CONNECT, DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT, TRACE)None

Responses

HTTP CodeDescriptionSchema
204No ContentNone
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.17.3 - 1.1

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

Description

메서드를 삭제한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.120260430

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
pathresource_id
required		리소스 ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
pathmethod_type
required		메서드 유형
Example : GET
enum (CONNECT, DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT, TRACE)None

Responses

HTTP CodeDescriptionSchema
204No ContentNone
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.17.4 - 1.0

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

Description

메서드를 삭제한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
pathresource_id
required		리소스 ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
pathmethod_type
required		메서드 유형
Example : GET
enum (CONNECT, DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT, TRACE)None

Responses

HTTP CodeDescriptionSchema
204No ContentNone
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.18 - Delete PrivateLink Endpoint

1.18.1 - 1.3

delete /v1/privatelink-endpoints/{privatelink_endpoint_id}

Description

PrivateLink 엔드포인트를 삭제한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathprivatelink_endpoint_id
required		PrivateLink 엔드포인트 ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone

Responses

HTTP CodeDescriptionSchema
204No ContentNone
403ForbiddenNone
404Not FoundNone

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.3"

Example HTTP response

Response 204

1.18.2 - 1.2

delete /v1/privatelink-endpoints/{privatelink_endpoint_id}

Description

PrivateLink 엔드포인트를 삭제한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

TypeNameDescriptionSchemaDefault
pathprivatelink_endpoint_id
required		PrivateLink 엔드포인트 ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone

Responses

HTTP CodeDescriptionSchema
204No ContentNone
403ForbiddenNone
404Not FoundNone

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.19 - Delete Resource

1.19.1 - 1.3

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

Description

리소스를 삭제한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
pathresource_id
required		리소스 ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone

Responses

HTTP CodeDescriptionSchema
204No ContentNone
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.3"

Example HTTP response

Response 204

1.19.2 - 1.2

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

Description

리소스를 삭제한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
pathresource_id
required		리소스 ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone

Responses

HTTP CodeDescriptionSchema
204No ContentNone
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.19.3 - 1.1

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

Description

리소스를 삭제한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.120260430

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
pathresource_id
required		리소스 ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone

Responses

HTTP CodeDescriptionSchema
204No ContentNone
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.19.4 - 1.0

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

Description

리소스를 삭제한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
pathresource_id
required		리소스 ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone

Responses

HTTP CodeDescriptionSchema
204No ContentNone
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.20 - Delete Resource Policy

1.20.1 - 1.3

delete /v1/apis/{api_id}/resource-policies

Description

리소스 정책을 삭제한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone

Responses

HTTP CodeDescriptionSchema
204No ContentNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/apis/{api_id}/resource-policies

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.3"

Example HTTP response

Response 204

1.21 - Delete Stage

1.21.1 - 1.3

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

Description

스테이지를 삭제한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathstage_name
required		스테이지명
Example : test-stage
stringNone
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone

Responses

HTTP CodeDescriptionSchema
204No ContentNone
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.3"

Example HTTP response

Response 204

1.21.2 - 1.2

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

Description

스테이지를 삭제한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

TypeNameDescriptionSchemaDefault
pathstage_name
required		스테이지명
Example : test-stage
stringNone
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone

Responses

HTTP CodeDescriptionSchema
204No ContentNone
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.21.3 - 1.1

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

Description

스테이지를 삭제한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.120260430

Parameters

TypeNameDescriptionSchemaDefault
pathstage_name
required		스테이지명
Example : test-stage
stringNone
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone

Responses

HTTP CodeDescriptionSchema
204No ContentNone
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.21.4 - 1.0

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

Description

스테이지를 삭제한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathstage_name
required		스테이지명
Example : test-stage
stringNone
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone

Responses

HTTP CodeDescriptionSchema
204No ContentNone
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.22 - Delete Usage Plan

1.22.1 - 1.3

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

Description

사용량 정책을 삭제한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
pathusage_plan_id
required		사용량 정책 ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone

Responses

HTTP CodeDescriptionSchema
204No ContentNone
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.3"

Example HTTP response

Response 204

1.22.2 - 1.2

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

Description

사용량 정책을 삭제한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
pathusage_plan_id
required		사용량 정책 ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone

Responses

HTTP CodeDescriptionSchema
204No ContentNone
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.22.3 - 1.1

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

Description

사용량 정책을 삭제한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.120260430

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
pathusage_plan_id
required		사용량 정책 ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone

Responses

HTTP CodeDescriptionSchema
204No ContentNone
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.23 - List AccessControls

1.23.1 - 1.3

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

Description

접근제어 목록을 조회한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example :
stringNone
querysize
optional		size
Example : 20
any of [integer, null]20
querypage
optional		page
Example : 0
any of [integer, null]0
querysort
optional		sort
Example : created_at:desc
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKAccessControlListResponse
400Bad RequestNone
403ForbiddenNone

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.3"

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.23.2 - 1.2

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

Description

접근제어 목록을 조회한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example :
stringNone
querysize
optional		size
Example : 20
any of [integer, null]20
querypage
optional		page
Example : 0
any of [integer, null]0
querysort
optional		sort
Example : created_at:desc
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKAccessControlListResponse
400Bad RequestNone
403ForbiddenNone

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.23.3 - 1.1

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

Description

접근제어 목록을 조회한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.120260430

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example :
stringNone
querysize
optional		size
Example : 20
any of [integer, null]20
querypage
optional		page
Example : 0
any of [integer, null]0
querysort
optional		sort
Example : created_at:desc
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKAccessControlListResponse
400Bad RequestNone
403ForbiddenNone

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.23.4 - 1.0

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

Description

접근제어 목록을 조회한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example :
stringNone
querysize
optional		size
Example : 20
any of [integer, null]20
querypage
optional		page
Example : 0
any of [integer, null]0
querysort
optional		sort
Example : created_at:desc
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKAccessControlListResponse
400Bad RequestNone
403ForbiddenNone

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.24 - List Api Deployments

1.24.1 - 1.3

get /v1/apis/{api_id}/deployments

Description

API 배포 목록을 조회한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 31e749b7b260868f441e862b
stringNone
querysize
optional		size
Example : 20
any of [integer, null]20
querypage
optional		page
Example : 0
any of [integer, null]0
querysort
optional		sort
Example : created_at:desc
any of [string, null]None
querydeployment_id
optional		이름
Example : 27bb070b564349f8a31cc60734cc36a5
any of [string, null]None
querystage_name
optional		스테이지명
Example : test-stage
string

Responses

HTTP CodeDescriptionSchema
200OKApiDeploymentListResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.3"

Example HTTP response

Response 200

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

1.24.2 - 1.2

get /v1/apis/{api_id}/deployments

Description

API 배포 목록을 조회한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 31e749b7b260868f441e862b
stringNone
querysize
optional		size
Example : 20
any of [integer, null]20
querypage
optional		page
Example : 0
any of [integer, null]0
querysort
optional		sort
Example : created_at:desc
any of [string, null]None
querydeployment_id
optional		이름
Example : 27bb070b564349f8a31cc60734cc36a5
any of [string, null]None
querystage_name
optional		스테이지명
Example : test-stage
string

Responses

HTTP CodeDescriptionSchema
200OKApiDeploymentListResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.24.3 - 1.1

get /v1/apis/{api_id}/deployments

Description

API 배포 목록을 조회한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.120260430

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 31e749b7b260868f441e862b
stringNone
querysize
optional		size
Example : 20
any of [integer, null]20
querypage
optional		page
Example : 0
any of [integer, null]0
querysort
optional		sort
Example : created_at:desc
any of [string, null]None
querydeployment_id
optional		이름
Example : 27bb070b564349f8a31cc60734cc36a5
any of [string, null]None
querystage_name
optional		스테이지명
Example : test-stage
string

Responses

HTTP CodeDescriptionSchema
200OKApiDeploymentListResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.24.4 - 1.0

get /v1/apis/{api_id}/deployments

Description

API 배포 목록을 조회한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 31e749b7b260868f441e862b
stringNone
querysize
optional		size
Example : 20
any of [integer, null]20
querypage
optional		page
Example : 0
any of [integer, null]0
querysort
optional		sort
Example : created_at:desc
any of [string, null]None
querydeployment_id
optional		이름
Example : 27bb070b564349f8a31cc60734cc36a5
any of [string, null]None
querystage_name
optional		스테이지명
Example : test-stage
string

Responses

HTTP CodeDescriptionSchema
200OKApiDeploymentListResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.25 - List Api Keys

1.25.1 - 1.3

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

Description

API Key 목록을 조회한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
pathusage_plan_id
required		사용량 정책 ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
querysize
optional		size
Example : 20
any of [integer, null]20
querypage
optional		page
Example : 0
any of [integer, null]0
querysort
optional		sort
Example : created_at:desc
any of [string, null]None
queryname
optional		이름
Example : api-key-name
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKApiKeyListResponse
400Bad RequestNone
403ForbiddenNone

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.3"

Example HTTP response

Response 200

{
    "api_keys": [
        {
            "created_at": "2024-01-15T10:30:00.000Z",
            "description": "description",
            "id": "27bb070b564349f8a31cc60734cc36a5",
            "key": "key",
            "name": "api-key-name"
        }
    ],
    "count": 20
}

1.25.2 - 1.2

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

Description

API Key 목록을 조회한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
pathusage_plan_id
required		사용량 정책 ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
querysize
optional		size
Example : 20
any of [integer, null]20
querypage
optional		page
Example : 0
any of [integer, null]0
querysort
optional		sort
Example : created_at:desc
any of [string, null]None
queryname
optional		이름
Example : api-key-name
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKApiKeyListResponse
400Bad RequestNone
403ForbiddenNone

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": "2024-01-15T10:30:00.000Z",
            "description": "description",
            "id": "27bb070b564349f8a31cc60734cc36a5",
            "key": "key",
            "name": "api-key-name"
        }
    ],
    "count": 20
}

1.25.3 - 1.1

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

Description

API Key 목록을 조회한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.120260430

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
pathusage_plan_id
required		사용량 정책 ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
querysize
optional		size
Example : 20
any of [integer, null]20
querypage
optional		page
Example : 0
any of [integer, null]0
querysort
optional		sort
Example : created_at:desc
any of [string, null]None
queryname
optional		이름
Example : api-key-name
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKApiKeyListResponse
400Bad RequestNone
403ForbiddenNone

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": "2024-01-15T10:30:00.000Z",
            "description": "description",
            "id": "27bb070b564349f8a31cc60734cc36a5",
            "key": "key",
            "name": "api-key-name"
        }
    ],
    "count": 20
}

1.26 - List Apis

1.26.1 - 1.3

get /v1/apis

Description

API 목록을 조회한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
querysize
optional		size
Example : 20
any of [integer, null]20
querypage
optional		page
Example : 0
any of [integer, null]0
querysort
optional		sort
Example : created_at:desc
any of [string, null]None
queryname
optional		이름
Example : test-api
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKApiListResponse
400Bad RequestNone
403ForbiddenNone

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.3"

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.26.2 - 1.2

get /v1/apis

Description

API 목록을 조회한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

TypeNameDescriptionSchemaDefault
querysize
optional		size
Example : 20
any of [integer, null]20
querypage
optional		page
Example : 0
any of [integer, null]0
querysort
optional		sort
Example : created_at:desc
any of [string, null]None
queryname
optional		이름
Example : test-api
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKApiListResponse
400Bad RequestNone
403ForbiddenNone

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.26.3 - 1.1

get /v1/apis

Description

API 목록을 조회한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.120260430

Parameters

TypeNameDescriptionSchemaDefault
querysize
optional		size
Example : 20
any of [integer, null]20
querypage
optional		page
Example : 0
any of [integer, null]0
querysort
optional		sort
Example : created_at:desc
any of [string, null]None
queryname
optional		이름
Example : test-api
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKApiListResponse
400Bad RequestNone
403ForbiddenNone

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.26.4 - 1.0

get /v1/apis

Description

API 목록을 조회한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
querysize
optional		size
Example : 20
any of [integer, null]20
querypage
optional		page
Example : 0
any of [integer, null]0
querysort
optional		sort
Example : created_at:desc
any of [string, null]None
queryname
optional		이름
Example : test-api
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKApiListResponse
400Bad RequestNone
403ForbiddenNone

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.27 - List Auths

1.27.1 - 1.3

get /v1/apis/{api_id}/auths

Description

인증 목록을 조회한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example :
stringNone
querysize
optional		size
Example : 20
any of [integer, null]20
querypage
optional		page
Example : 0
any of [integer, null]0
querysort
optional		sort
Example : created_at:desc
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKAuthListResponse
400Bad RequestNone
403ForbiddenNone

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.3"

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.27.2 - 1.2

get /v1/apis/{api_id}/auths

Description

인증 목록을 조회한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example :
stringNone
querysize
optional		size
Example : 20
any of [integer, null]20
querypage
optional		page
Example : 0
any of [integer, null]0
querysort
optional		sort
Example : created_at:desc
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKAuthListResponse
400Bad RequestNone
403ForbiddenNone

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.27.3 - 1.1

get /v1/apis/{api_id}/auths

Description

인증 목록을 조회한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.120260430

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example :
stringNone
querysize
optional		size
Example : 20
any of [integer, null]20
querypage
optional		page
Example : 0
any of [integer, null]0
querysort
optional		sort
Example : created_at:desc
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKAuthListResponse
400Bad RequestNone
403ForbiddenNone

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.27.4 - 1.0

get /v1/apis/{api_id}/auths

Description

인증 목록을 조회한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example :
stringNone
querysize
optional		size
Example : 20
any of [integer, null]20
querypage
optional		page
Example : 0
any of [integer, null]0
querysort
optional		sort
Example : created_at:desc
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKAuthListResponse
400Bad RequestNone
403ForbiddenNone

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.28 - List Connected PrivateLink Endpoints

1.28.1 - 1.3

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

Description

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

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 31e749b7b260868f441e862b
stringNone
querysize
optional		size
Example : 20
any of [integer, null]20
querypage
optional		page
Example : 0
any of [integer, null]0
querysort
optional		sort
Example : created_at:desc
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKApiConnectedEndpointListResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.3"

Example HTTP response

Response 200

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

1.28.2 - 1.2

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

Description

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

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 31e749b7b260868f441e862b
stringNone
querysize
optional		size
Example : 20
any of [integer, null]20
querypage
optional		page
Example : 0
any of [integer, null]0
querysort
optional		sort
Example : created_at:desc
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKApiConnectedEndpointListResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.29 - List Methods

1.29.1 - 1.3

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

Description

메서드 목록을 조회한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
pathresource_id
required		리소스 ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone

Responses

HTTP CodeDescriptionSchema
200OKMethodListResponseV1Dot3
403ForbiddenNone

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.3"

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",
            "iam_enabled": false,
            "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.29.2 - 1.2

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

Description

메서드 목록을 조회한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
pathresource_id
required		리소스 ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone

Responses

HTTP CodeDescriptionSchema
200OKMethodListResponseV1Dot2
403ForbiddenNone

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.29.3 - 1.1

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

Description

메서드 목록을 조회한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.120260430

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
pathresource_id
required		리소스 ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone

Responses

HTTP CodeDescriptionSchema
200OKMethodListResponseV1Dot1
403ForbiddenNone

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.29.4 - 1.0

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

Description

메서드 목록을 조회한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
pathresource_id
required		리소스 ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone

Responses

HTTP CodeDescriptionSchema
200OKMethodListResponse
403ForbiddenNone

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.30 - List PrivateLink Endpoints

1.30.1 - 1.3

get /v1/privatelink-endpoints

Description

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

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
querysize
optional		size
Example : 20
any of [integer, null]20
querypage
optional		page
Example : 0
any of [integer, null]0
querysort
optional		sort
Example : created_at:desc
any of [string, null]None
queryname
optional		PrivateLink 엔드포인트명
Example : endpoint
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKPrivateLinkEndpointListResponse
400Bad RequestNone
403ForbiddenNone

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.3"

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.30.2 - 1.2

get /v1/privatelink-endpoints

Description

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

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

TypeNameDescriptionSchemaDefault
querysize
optional		size
Example : 20
any of [integer, null]20
querypage
optional		page
Example : 0
any of [integer, null]0
querysort
optional		sort
Example : created_at:desc
any of [string, null]None
queryname
optional		PrivateLink 엔드포인트명
Example : endpoint
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKPrivateLinkEndpointListResponse
400Bad RequestNone
403ForbiddenNone

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.31 - List Reports

1.31.1 - 1.3

get /v1/apis/{api_id}/reports

Description

Report 목록을 조회한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
querystage_name
required		스테이지명
Example : test-stage
stringNone
querystart_date
required		시작일자
Example : 2025-07-01
stringNone
queryend_date
required		종료일자
Example : 2025-07-30
stringNone

Responses

HTTP CodeDescriptionSchema
200OKReportListResponse
400Bad RequestNone
403ForbiddenNone

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.3"

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.31.2 - 1.2

get /v1/apis/{api_id}/reports

Description

Report 목록을 조회한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
querystage_name
required		스테이지명
Example : test-stage
stringNone
querystart_date
required		시작일자
Example : 2025-07-01
stringNone
queryend_date
required		종료일자
Example : 2025-07-30
stringNone

Responses

HTTP CodeDescriptionSchema
200OKReportListResponse
400Bad RequestNone
403ForbiddenNone

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.31.3 - 1.1

get /v1/apis/{api_id}/reports

Description

Report 목록을 조회한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.120260430

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
querystage_name
required		스테이지명
Example : test-stage
stringNone
querystart_date
required		시작일자
Example : 2025-07-01
stringNone
queryend_date
required		종료일자
Example : 2025-07-30
stringNone

Responses

HTTP CodeDescriptionSchema
200OKReportListResponse
400Bad RequestNone
403ForbiddenNone

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.32 - List Resources

1.32.1 - 1.3

get /v1/apis/{api_id}/resources

Description

리소스 목록을 조회한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone

Responses

HTTP CodeDescriptionSchema
200OKResourceListResponseV1Dot3
403ForbiddenNone

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.3"

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",
                    "iam_enabled": false,
                    "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.32.2 - 1.2

get /v1/apis/{api_id}/resources

Description

리소스 목록을 조회한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone

Responses

HTTP CodeDescriptionSchema
200OKResourceListResponseV1Dot2
403ForbiddenNone

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.32.3 - 1.1

get /v1/apis/{api_id}/resources

Description

리소스 목록을 조회한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.120260430

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone

Responses

HTTP CodeDescriptionSchema
200OKResourceListResponseV1Dot1
403ForbiddenNone

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.32.4 - 1.0

get /v1/apis/{api_id}/resources

Description

리소스 목록을 조회한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone

Responses

HTTP CodeDescriptionSchema
200OKResourceListResponse
403ForbiddenNone

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.33 - List Stages

1.33.1 - 1.3

get /v1/apis/{api_id}/stages

Description

스테이지 목록을 조회한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone

Responses

HTTP CodeDescriptionSchema
200OKStageListResponseV1Dot3
400Bad RequestNone
403ForbiddenNone

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.3"

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": [
                        {
                            "api_key_required": true,
                            "iam_enabled": true,
                            "type": "GET"
                        },
                        {
                            "api_key_required": false,
                            "iam_enabled": false,
                            "type": "POST"
                        }
                    ],
                    "path": "/"
                },
                {
                    "methods": [
                        {
                            "api_key_required": true,
                            "iam_enabled": true,
                            "type": "GET"
                        },
                        {
                            "api_key_required": false,
                            "iam_enabled": false,
                            "type": "POST"
                        }
                    ],
                    "path": "/test"
                }
            ],
            "cors_enabled": false,
            "created_at": "2024-01-15T10:30:00.000Z",
            "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.33.2 - 1.2

get /v1/apis/{api_id}/stages

Description

스테이지 목록을 조회한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone

Responses

HTTP CodeDescriptionSchema
200OKStageListResponseV1Dot1
400Bad RequestNone
403ForbiddenNone

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": "2024-01-15T10:30:00.000Z",
            "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.33.3 - 1.1

get /v1/apis/{api_id}/stages

Description

스테이지 목록을 조회한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.120260430

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone

Responses

HTTP CodeDescriptionSchema
200OKStageListResponseV1Dot1
400Bad RequestNone
403ForbiddenNone

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": "2024-01-15T10:30:00.000Z",
            "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.33.4 - 1.0

get /v1/apis/{api_id}/stages

Description

스테이지 목록을 조회한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone

Responses

HTTP CodeDescriptionSchema
200OKStageListResponse
400Bad RequestNone
403ForbiddenNone

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": "2024-01-15T10:30:00.000Z",
            "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.34 - List Usage Plans

1.34.1 - 1.3

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

Description

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

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
querysize
optional		size
Example : 20
any of [integer, null]20
querypage
optional		page
Example : 0
any of [integer, null]0
querysort
optional		sort
Example : created_at:desc
any of [string, null]None
queryname
optional		이름
Example : usage-plan-name
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKUsagePlanListResponse
400Bad RequestNone
403ForbiddenNone

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.3"

Example HTTP response

Response 200

{
    "count": 20,
    "usage_plans": [
        {
            "connected_api_keys": [
                "key1",
                "key2"
            ],
            "created_at": "2024-01-15T10:30:00.000Z",
            "description": "description",
            "id": "27bb070b564349f8a31cc60734cc36a5",
            "limit": 10,
            "name": "usage-plan-name",
            "rate": "day"
        }
    ]
}

1.34.2 - 1.2

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

Description

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

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
querysize
optional		size
Example : 20
any of [integer, null]20
querypage
optional		page
Example : 0
any of [integer, null]0
querysort
optional		sort
Example : created_at:desc
any of [string, null]None
queryname
optional		이름
Example : usage-plan-name
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKUsagePlanListResponse
400Bad RequestNone
403ForbiddenNone

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": "2024-01-15T10:30:00.000Z",
            "description": "description",
            "id": "27bb070b564349f8a31cc60734cc36a5",
            "limit": 10,
            "name": "usage-plan-name",
            "rate": "day"
        }
    ]
}

1.34.3 - 1.1

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

Description

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

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.120260430

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
querysize
optional		size
Example : 20
any of [integer, null]20
querypage
optional		page
Example : 0
any of [integer, null]0
querysort
optional		sort
Example : created_at:desc
any of [string, null]None
queryname
optional		이름
Example : usage-plan-name
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKUsagePlanListResponse
400Bad RequestNone
403ForbiddenNone

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": "2024-01-15T10:30:00.000Z",
            "description": "description",
            "id": "27bb070b564349f8a31cc60734cc36a5",
            "limit": 10,
            "name": "usage-plan-name",
            "rate": "day"
        }
    ]
}

1.35 - Request PrivateLink Endpoint

1.35.1 - 1.3

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

Description

PrivateLink 엔드포인트를 요청한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathprivatelink_endpoint_id
required		PrivateLink 엔드포인트 ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
bodybody
required
PrivateLinkEndpointRequestRequest

Responses

HTTP CodeDescriptionSchema
200OKPrivateLinkEndpointShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.3"

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.35.2 - 1.2

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

Description

PrivateLink 엔드포인트를 요청한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

TypeNameDescriptionSchemaDefault
pathprivatelink_endpoint_id
required		PrivateLink 엔드포인트 ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
bodybody
required
PrivateLinkEndpointRequestRequest

Responses

HTTP CodeDescriptionSchema
200OKPrivateLinkEndpointShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.36 - Set Access Control

1.36.1 - 1.3

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

Description

접근제어를 수정한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example :
stringNone
pathaccess_control_id
required		접근제어 ID
Example :
stringNone
bodybody
required
AccessControlSetRequest

Responses

HTTP CodeDescriptionSchema
200OKAccessControlShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.3"

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.36.2 - 1.2

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

Description

접근제어를 수정한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example :
stringNone
pathaccess_control_id
required		접근제어 ID
Example :
stringNone
bodybody
required
AccessControlSetRequest

Responses

HTTP CodeDescriptionSchema
200OKAccessControlShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.36.3 - 1.1

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

Description

접근제어를 수정한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.120260430

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example :
stringNone
pathaccess_control_id
required		접근제어 ID
Example :
stringNone
bodybody
required
AccessControlSetRequest

Responses

HTTP CodeDescriptionSchema
200OKAccessControlShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.36.4 - 1.0

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

Description

접근제어를 수정한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example :
stringNone
pathaccess_control_id
required		접근제어 ID
Example :
stringNone
bodybody
required
AccessControlSetRequest

Responses

HTTP CodeDescriptionSchema
200OKAccessControlShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.37 - Set Api Description

1.37.1 - 1.3

put /v1/apis/{api_id}/description

Description

API 설명을 수정한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 31e749b7b260868f441e862b
stringNone
bodybody
required
ApiSetDescriptionRequest

Responses

HTTP CodeDescriptionSchema
200OKApiShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.3"

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.37.2 - 1.2

put /v1/apis/{api_id}/description

Description

API 설명을 수정한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 31e749b7b260868f441e862b
stringNone
bodybody
required
ApiSetDescriptionRequest

Responses

HTTP CodeDescriptionSchema
200OKApiShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.37.3 - 1.1

put /v1/apis/{api_id}/description

Description

API 설명을 수정한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.120260430

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 31e749b7b260868f441e862b
stringNone
bodybody
required
ApiSetDescriptionRequest

Responses

HTTP CodeDescriptionSchema
200OKApiShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.37.4 - 1.0

put /v1/apis/{api_id}/description

Description

API 설명을 수정한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 31e749b7b260868f441e862b
stringNone
bodybody
required
ApiSetDescriptionRequest

Responses

HTTP CodeDescriptionSchema
200OKApiShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.38 - Set API Key Description

1.38.1 - 1.3

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

Description

API Key 설명을 수정한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
pathusage_plan_id
required		사용량 정책 ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
pathapi_key_id
required		API Key ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
bodybody
required
ApiKeySetDescriptionRequest

Responses

HTTP CodeDescriptionSchema
200OKApiKeyShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.3"

Request body

{
    "description": "description"
}

Example HTTP response

Response 200

{
    "api_key": {
        "created_at": "2024-01-15T10:30:00.000Z",
        "description": "description",
        "id": "27bb070b564349f8a31cc60734cc36a5",
        "key": "key",
        "name": "api-key-name"
    }
}

1.38.2 - 1.2

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

Description

API Key 설명을 수정한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
pathusage_plan_id
required		사용량 정책 ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
pathapi_key_id
required		API Key ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
bodybody
required
ApiKeySetDescriptionRequest

Responses

HTTP CodeDescriptionSchema
200OKApiKeyShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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": "2024-01-15T10:30:00.000Z",
        "description": "description",
        "id": "27bb070b564349f8a31cc60734cc36a5",
        "key": "key",
        "name": "api-key-name"
    }
}

1.38.3 - 1.1

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

Description

API Key 설명을 수정한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.120260430

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
pathusage_plan_id
required		사용량 정책 ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
pathapi_key_id
required		API Key ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
bodybody
required
ApiKeySetDescriptionRequest

Responses

HTTP CodeDescriptionSchema
200OKApiKeyShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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": "2024-01-15T10:30:00.000Z",
        "description": "description",
        "id": "27bb070b564349f8a31cc60734cc36a5",
        "key": "key",
        "name": "api-key-name"
    }
}

1.39 - Set Auth

1.39.1 - 1.3

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

Description

인증을 수정한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example :
stringNone
pathauth_id
required		인증 ID
Example :
stringNone
bodybody
required
AuthSetRequest

Responses

HTTP CodeDescriptionSchema
200OKAuthShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.3"

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.39.2 - 1.2

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

Description

인증을 수정한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example :
stringNone
pathauth_id
required		인증 ID
Example :
stringNone
bodybody
required
AuthSetRequest

Responses

HTTP CodeDescriptionSchema
200OKAuthShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.39.3 - 1.1

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

Description

인증을 수정한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.120260430

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example :
stringNone
pathauth_id
required		인증 ID
Example :
stringNone
bodybody
required
AuthSetRequest

Responses

HTTP CodeDescriptionSchema
200OKAuthShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.39.4 - 1.0

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

Description

인증을 수정한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example :
stringNone
pathauth_id
required		인증 ID
Example :
stringNone
bodybody
required
AuthSetRequest

Responses

HTTP CodeDescriptionSchema
200OKAuthShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.40 - Set Method

1.40.1 - 1.3

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

Description

메서드를 수정한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
pathresource_id
required		리소스 ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
pathmethod_type
required		메서드 유형
Example : GET
enum (CONNECT, DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT, TRACE)None
bodybody
required
MethodSetRequestV1Dot3

Responses

HTTP CodeDescriptionSchema
200OKMethodShowResponseV1Dot3
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.3"

Request body

{
    "api_key_required": false,
    "endpoint_url": "https://127.0.0.1:8000",
    "function_id": "27bb070b564349f8a31cc60734cc36a5",
    "iam_enabled": false,
    "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",
        "iam_enabled": false,
        "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.40.2 - 1.2

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

Description

메서드를 수정한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
pathresource_id
required		리소스 ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
pathmethod_type
required		메서드 유형
Example : GET
enum (CONNECT, DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT, TRACE)None
bodybody
required
MethodSetRequestV1Dot2

Responses

HTTP CodeDescriptionSchema
200OKMethodShowResponseV1Dot2
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.40.3 - 1.1

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

Description

메서드를 수정한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.120260430

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
pathresource_id
required		리소스 ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
pathmethod_type
required		메서드 유형
Example : GET
enum (CONNECT, DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT, TRACE)None
bodybody
required
MethodSetRequestV1Dot1

Responses

HTTP CodeDescriptionSchema
200OKMethodShowResponseV1Dot1
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.40.4 - 1.0

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

Description

메서드를 수정한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
pathresource_id
required		리소스 ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
pathmethod_type
required		메서드 유형
Example : GET
enum (CONNECT, DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT, TRACE)None
bodybody
required
MethodSetRequest

Responses

HTTP CodeDescriptionSchema
200OKMethodShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.41 - Set PrivateLink Endpoint

1.41.1 - 1.3

put /v1/privatelink-endpoints/{privatelink_endpoint_id}

Description

PrivateLink 엔드포인트를 수정한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathprivatelink_endpoint_id
required		PrivateLink 엔드포인트 ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
bodybody
required
PrivateLinkEndpointSetRequest

Responses

HTTP CodeDescriptionSchema
200OKPrivateLinkEndpointShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.3"

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.41.2 - 1.2

put /v1/privatelink-endpoints/{privatelink_endpoint_id}

Description

PrivateLink 엔드포인트를 수정한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

TypeNameDescriptionSchemaDefault
pathprivatelink_endpoint_id
required		PrivateLink 엔드포인트 ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
bodybody
required
PrivateLinkEndpointSetRequest

Responses

HTTP CodeDescriptionSchema
200OKPrivateLinkEndpointShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.42 - Set Resource Policy

1.42.1 - 1.3

put /v1/apis/{api_id}/resource-policies

Description

리소스 정책을 수정한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
bodybody
required
ResourcePolicySetRequest

Responses

HTTP CodeDescriptionSchema
200OKResourcePolicyShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/apis/{api_id}/resource-policies

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.3"

Request body

{
    "policy_document": {
        "Statement": [
            {
                "Action": [
                    "apigateway:InvokeApigatewayRegion"
                ],
                "Condition": {
                    "SrnLike": {
                        "scp:RequestAttribute/body['method-srn']": [
                            "srn:dev2::27bb070b564349f8a31cc60734cc36a5:kr-west1::apigateway:method/a4b19a70b596467fb010d3c3/*/GET/n-f"
                        ]
                    }
                },
                "Effect": "Allow",
                "Principal": "*",
                "Resource": [
                    "srn:dev2::27bb070b564349f8a31cc60734cc36a5:kr-west1::apigateway:api/a4b19a70b596467fb010d3c3"
                ],
                "Sid": "Statement1"
            }
        ],
        "Version": "2024-07-01"
    }
}

Example HTTP response

Response 200

{
    "policy_document": {
        "Statement": [
            {
                "Action": [
                    "apigateway:InvokeApigatewayRegion"
                ],
                "Condition": {
                    "SrnLike": {
                        "scp:RequestAttribute/body['method-srn']": [
                            "srn:dev2::27bb070b564349f8a31cc60734cc36a5:kr-west1::apigateway:method/a4b19a70b596467fb010d3c3/*/GET/n-f"
                        ]
                    }
                },
                "Effect": "Allow",
                "Principal": "*",
                "Resource": [
                    "srn:dev2::27bb070b564349f8a31cc60734cc36a5:kr-west1::apigateway:api/a4b19a70b596467fb010d3c3"
                ],
                "Sid": "Statement1"
            }
        ],
        "Version": "2024-07-01"
    }
}

1.43 - Set Stage Active Deployment

1.43.1 - 1.3

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

Description

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

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathstage_name
required		스테이지명
Example : test-stage
stringNone
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
bodybody
required
StageSetActiveDeploymentRequest

Responses

HTTP CodeDescriptionSchema
200OKStageShowResponseV1Dot1
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.3"

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": "2024-01-15T10:30:00.000Z",
        "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.43.2 - 1.2

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

Description

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

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

TypeNameDescriptionSchemaDefault
pathstage_name
required		스테이지명
Example : test-stage
stringNone
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
bodybody
required
StageSetActiveDeploymentRequest

Responses

HTTP CodeDescriptionSchema
200OKStageShowResponseV1Dot1
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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": "2024-01-15T10:30:00.000Z",
        "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.43.3 - 1.1

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

Description

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

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.120260430

Parameters

TypeNameDescriptionSchemaDefault
pathstage_name
required		스테이지명
Example : test-stage
stringNone
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
bodybody
required
StageSetActiveDeploymentRequest

Responses

HTTP CodeDescriptionSchema
200OKStageShowResponseV1Dot1
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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": "2024-01-15T10:30:00.000Z",
        "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.43.4 - 1.0

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

Description

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

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathstage_name
required		스테이지명
Example : test-stage
stringNone
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
bodybody
required
StageSetActiveDeploymentRequest

Responses

HTTP CodeDescriptionSchema
200OKStageShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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": "2024-01-15T10:30:00.000Z",
        "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.44 - Set Stage Configuration

1.44.1 - 1.3

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

Description

스테이지 설정을 수정한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathstage_name
required		스테이지명
Example : test-stage
stringNone
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
bodybody
required
StageSetConfigRequestV1Dot1

Responses

HTTP CodeDescriptionSchema
200OKStageShowResponseV1Dot1
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.3"

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": "2024-01-15T10:30:00.000Z",
        "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.44.2 - 1.2

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

Description

스테이지 설정을 수정한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

TypeNameDescriptionSchemaDefault
pathstage_name
required		스테이지명
Example : test-stage
stringNone
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
bodybody
required
StageSetConfigRequestV1Dot1

Responses

HTTP CodeDescriptionSchema
200OKStageShowResponseV1Dot1
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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": "2024-01-15T10:30:00.000Z",
        "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.44.3 - 1.1

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

Description

스테이지 설정을 수정한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.120260430

Parameters

TypeNameDescriptionSchemaDefault
pathstage_name
required		스테이지명
Example : test-stage
stringNone
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
bodybody
required
StageSetConfigRequestV1Dot1

Responses

HTTP CodeDescriptionSchema
200OKStageShowResponseV1Dot1
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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": "2024-01-15T10:30:00.000Z",
        "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.44.4 - 1.0

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

Description

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

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathstage_name
required		스테이지명
Example : test-stage
stringNone
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
bodybody
required
StageSetConfigRequest

Responses

HTTP CodeDescriptionSchema
200OKStageShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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": "2024-01-15T10:30:00.000Z",
        "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.45 - Set Usage Plan Description

1.45.1 - 1.3

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

Description

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

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
pathusage_plan_id
required		사용량 정책 ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
bodybody
required
UsagePlanSetDescriptionRequest

Responses

HTTP CodeDescriptionSchema
200OKUsagePlanShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.3"

Request body

{
    "description": "description"
}

Example HTTP response

Response 200

{
    "usage_plan": {
        "api_keys": [],
        "created_at": "2024-01-15T10:30:00.000Z",
        "created_by_id": "27bb070b564349f8a31cc60734cc36a5",
        "created_by_name": "username",
        "description": "description",
        "id": "27bb070b564349f8a31cc60734cc36a5",
        "limit": 10,
        "modified_at": "2024-01-15T10:30:00.000Z",
        "modified_by_id": "27bb070b564349f8a31cc60734cc36a5",
        "modified_by_name": "username",
        "name": "usage-plan-name",
        "rate": "day"
    }
}

1.45.2 - 1.2

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

Description

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

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
pathusage_plan_id
required		사용량 정책 ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
bodybody
required
UsagePlanSetDescriptionRequest

Responses

HTTP CodeDescriptionSchema
200OKUsagePlanShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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": "2024-01-15T10:30:00.000Z",
        "created_by_id": "27bb070b564349f8a31cc60734cc36a5",
        "created_by_name": "username",
        "description": "description",
        "id": "27bb070b564349f8a31cc60734cc36a5",
        "limit": 10,
        "modified_at": "2024-01-15T10:30:00.000Z",
        "modified_by_id": "27bb070b564349f8a31cc60734cc36a5",
        "modified_by_name": "username",
        "name": "usage-plan-name",
        "rate": "day"
    }
}

1.45.3 - 1.1

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

Description

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

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.120260430

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
pathusage_plan_id
required		사용량 정책 ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
bodybody
required
UsagePlanSetDescriptionRequest

Responses

HTTP CodeDescriptionSchema
200OKUsagePlanShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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": "2024-01-15T10:30:00.000Z",
        "created_by_id": "27bb070b564349f8a31cc60734cc36a5",
        "created_by_name": "username",
        "description": "description",
        "id": "27bb070b564349f8a31cc60734cc36a5",
        "limit": 10,
        "modified_at": "2024-01-15T10:30:00.000Z",
        "modified_by_id": "27bb070b564349f8a31cc60734cc36a5",
        "modified_by_name": "username",
        "name": "usage-plan-name",
        "rate": "day"
    }
}

1.46 - Set Usage Plan Quota

1.46.1 - 1.3

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

Description

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

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
pathusage_plan_id
required		사용량 정책 ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
bodybody
required
UsagePlanSetQuotaRequest

Responses

HTTP CodeDescriptionSchema
200OKUsagePlanShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.3"

Request body

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

Example HTTP response

Response 200

{
    "usage_plan": {
        "api_keys": [],
        "created_at": "2024-01-15T10:30:00.000Z",
        "created_by_id": "27bb070b564349f8a31cc60734cc36a5",
        "created_by_name": "username",
        "description": "description",
        "id": "27bb070b564349f8a31cc60734cc36a5",
        "limit": 10,
        "modified_at": "2024-01-15T10:30:00.000Z",
        "modified_by_id": "27bb070b564349f8a31cc60734cc36a5",
        "modified_by_name": "username",
        "name": "usage-plan-name",
        "rate": "day"
    }
}

1.46.2 - 1.2

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

Description

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

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
pathusage_plan_id
required		사용량 정책 ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
bodybody
required
UsagePlanSetQuotaRequest

Responses

HTTP CodeDescriptionSchema
200OKUsagePlanShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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": "2024-01-15T10:30:00.000Z",
        "created_by_id": "27bb070b564349f8a31cc60734cc36a5",
        "created_by_name": "username",
        "description": "description",
        "id": "27bb070b564349f8a31cc60734cc36a5",
        "limit": 10,
        "modified_at": "2024-01-15T10:30:00.000Z",
        "modified_by_id": "27bb070b564349f8a31cc60734cc36a5",
        "modified_by_name": "username",
        "name": "usage-plan-name",
        "rate": "day"
    }
}

1.46.3 - 1.1

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

Description

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

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.120260430

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
pathusage_plan_id
required		사용량 정책 ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
bodybody
required
UsagePlanSetQuotaRequest

Responses

HTTP CodeDescriptionSchema
200OKUsagePlanShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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": "2024-01-15T10:30:00.000Z",
        "created_by_id": "27bb070b564349f8a31cc60734cc36a5",
        "created_by_name": "username",
        "description": "description",
        "id": "27bb070b564349f8a31cc60734cc36a5",
        "limit": 10,
        "modified_at": "2024-01-15T10:30:00.000Z",
        "modified_by_id": "27bb070b564349f8a31cc60734cc36a5",
        "modified_by_name": "username",
        "name": "usage-plan-name",
        "rate": "day"
    }
}

1.47 - Show Access Control

1.47.1 - 1.3

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

Description

접근제어를 상세조회한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example :
stringNone
pathaccess_control_id
required		접근제어 ID
Example :
stringNone

Responses

HTTP CodeDescriptionSchema
200OKAccessControlShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.3"

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.47.2 - 1.2

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

Description

접근제어를 상세조회한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example :
stringNone
pathaccess_control_id
required		접근제어 ID
Example :
stringNone

Responses

HTTP CodeDescriptionSchema
200OKAccessControlShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.47.3 - 1.1

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

Description

접근제어를 상세조회한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.120260430

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example :
stringNone
pathaccess_control_id
required		접근제어 ID
Example :
stringNone

Responses

HTTP CodeDescriptionSchema
200OKAccessControlShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.47.4 - 1.0

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

Description

접근제어를 상세조회한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example :
stringNone
pathaccess_control_id
required		접근제어 ID
Example :
stringNone

Responses

HTTP CodeDescriptionSchema
200OKAccessControlShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.48 - Show Api

1.48.1 - 1.3

get /v1/apis/{api_id}

Description

API를 상세조회한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 31e749b7b260868f441e862b
stringNone

Responses

HTTP CodeDescriptionSchema
200OKApiShowResponse
403ForbiddenNone
404Not FoundNone

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.3"

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.48.2 - 1.2

get /v1/apis/{api_id}

Description

API를 상세조회한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 31e749b7b260868f441e862b
stringNone

Responses

HTTP CodeDescriptionSchema
200OKApiShowResponse
403ForbiddenNone
404Not FoundNone

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.48.3 - 1.1

get /v1/apis/{api_id}

Description

API를 상세조회한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.120260430

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 31e749b7b260868f441e862b
stringNone

Responses

HTTP CodeDescriptionSchema
200OKApiShowResponse
403ForbiddenNone
404Not FoundNone

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.48.4 - 1.0

get /v1/apis/{api_id}

Description

API를 상세조회한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 31e749b7b260868f441e862b
stringNone

Responses

HTTP CodeDescriptionSchema
200OKApiShowResponse
403ForbiddenNone
404Not FoundNone

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.49 - Show Auth

1.49.1 - 1.3

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

Description

인증을 상세조회한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example :
stringNone
pathauth_id
required		인증 ID
Example :
stringNone

Responses

HTTP CodeDescriptionSchema
200OKAuthShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.3"

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.49.2 - 1.2

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

Description

인증을 상세조회한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example :
stringNone
pathauth_id
required		인증 ID
Example :
stringNone

Responses

HTTP CodeDescriptionSchema
200OKAuthShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.49.3 - 1.1

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

Description

인증을 상세조회한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.120260430

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example :
stringNone
pathauth_id
required		인증 ID
Example :
stringNone

Responses

HTTP CodeDescriptionSchema
200OKAuthShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.49.4 - 1.0

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

Description

인증을 상세조회한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example :
stringNone
pathauth_id
required		인증 ID
Example :
stringNone

Responses

HTTP CodeDescriptionSchema
200OKAuthShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.50 - Show Method

1.50.1 - 1.3

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

Description

메서드를 상세조회한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
pathresource_id
required		리소스 ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
pathmethod_type
required		메서드 유형
Example : GET
enum (CONNECT, DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT, TRACE)None

Responses

HTTP CodeDescriptionSchema
200OKMethodShowResponseV1Dot3
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.3"

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",
        "iam_enabled": false,
        "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.50.2 - 1.2

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

Description

메서드를 상세조회한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
pathresource_id
required		리소스 ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
pathmethod_type
required		메서드 유형
Example : GET
enum (CONNECT, DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT, TRACE)None

Responses

HTTP CodeDescriptionSchema
200OKMethodShowResponseV1Dot2
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.50.3 - 1.1

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

Description

메서드를 상세조회한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.120260430

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
pathresource_id
required		리소스 ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
pathmethod_type
required		메서드 유형
Example : GET
enum (CONNECT, DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT, TRACE)None

Responses

HTTP CodeDescriptionSchema
200OKMethodShowResponseV1Dot1
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.50.4 - 1.0

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

Description

메서드를 상세조회한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
pathresource_id
required		리소스 ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
pathmethod_type
required		메서드 유형
Example : GET
enum (CONNECT, DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT, TRACE)None

Responses

HTTP CodeDescriptionSchema
200OKMethodShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.51 - Show PrivateLink Endpoint

1.51.1 - 1.3

get /v1/privatelink-endpoints/{privatelink_endpoint_id}

Description

PrivateLink 엔드포인트를 조회한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathprivatelink_endpoint_id
required		PrivateLink 엔드포인트 ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone

Responses

HTTP CodeDescriptionSchema
200OKPrivateLinkEndpointShowResponse
403ForbiddenNone
404Not FoundNone

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.3"

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.51.2 - 1.2

get /v1/privatelink-endpoints/{privatelink_endpoint_id}

Description

PrivateLink 엔드포인트를 조회한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

TypeNameDescriptionSchemaDefault
pathprivatelink_endpoint_id
required		PrivateLink 엔드포인트 ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone

Responses

HTTP CodeDescriptionSchema
200OKPrivateLinkEndpointShowResponse
403ForbiddenNone
404Not FoundNone

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.52 - Show Resource

1.52.1 - 1.3

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

Description

리소스를 상세조회한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
pathresource_id
required		리소스 ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone

Responses

HTTP CodeDescriptionSchema
200OKResourceShowResponseV1Dot3
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.3"

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",
                "iam_enabled": false,
                "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.52.2 - 1.2

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

Description

리소스를 상세조회한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
pathresource_id
required		리소스 ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone

Responses

HTTP CodeDescriptionSchema
200OKResourceShowResponseV1Dot2
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.52.3 - 1.1

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

Description

리소스를 상세조회한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.120260430

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
pathresource_id
required		리소스 ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone

Responses

HTTP CodeDescriptionSchema
200OKResourceShowResponseV1Dot1
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.52.4 - 1.0

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

Description

리소스를 상세조회한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
pathresource_id
required		리소스 ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone

Responses

HTTP CodeDescriptionSchema
200OKResourceShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.53 - Show Resource Policy

1.53.1 - 1.3

get /v1/apis/{api_id}/resource-policies

Description

리소스 정책을 상세조회한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone

Responses

HTTP CodeDescriptionSchema
200OKResourcePolicyShowResponse
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/apis/{api_id}/resource-policies

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.3"

Example HTTP response

Response 200

{
    "policy_document": {
        "Statement": [
            {
                "Action": [
                    "apigateway:InvokeApigatewayRegion"
                ],
                "Condition": {
                    "SrnLike": {
                        "scp:RequestAttribute/body['method-srn']": [
                            "srn:dev2::27bb070b564349f8a31cc60734cc36a5:kr-west1::apigateway:method/a4b19a70b596467fb010d3c3/*/GET/n-f"
                        ]
                    }
                },
                "Effect": "Allow",
                "Principal": "*",
                "Resource": [
                    "srn:dev2::27bb070b564349f8a31cc60734cc36a5:kr-west1::apigateway:api/a4b19a70b596467fb010d3c3"
                ],
                "Sid": "Statement1"
            }
        ],
        "Version": "2024-07-01"
    }
}

1.54 - Show Stage

1.54.1 - 1.3

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

Description

스테이지를 상세조회한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathstage_name
required		스테이지명
Example : test-stage
stringNone
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone

Responses

HTTP CodeDescriptionSchema
200OKStageShowResponseV1Dot3
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.3"

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": "2024-01-15T10:30:00.000Z",
        "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.54.2 - 1.2

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

Description

스테이지를 상세조회한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

TypeNameDescriptionSchemaDefault
pathstage_name
required		스테이지명
Example : test-stage
stringNone
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone

Responses

HTTP CodeDescriptionSchema
200OKStageShowResponseV1Dot1
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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": "2024-01-15T10:30:00.000Z",
        "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.54.3 - 1.1

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

Description

스테이지를 상세조회한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.120260430

Parameters

TypeNameDescriptionSchemaDefault
pathstage_name
required		스테이지명
Example : test-stage
stringNone
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone

Responses

HTTP CodeDescriptionSchema
200OKStageShowResponseV1Dot1
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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": "2024-01-15T10:30:00.000Z",
        "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.54.4 - 1.0

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

Description

스테이지를 상세조회한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathstage_name
required		스테이지명
Example : test-stage
stringNone
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone

Responses

HTTP CodeDescriptionSchema
200OKStageShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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": "2024-01-15T10:30:00.000Z",
        "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.55 - Show Usage Plan

1.55.1 - 1.3

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

Description

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

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
pathusage_plan_id
required		사용량 정책 ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone

Responses

HTTP CodeDescriptionSchema
200OKUsagePlanShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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.3"

Example HTTP response

Response 200

{
    "usage_plan": {
        "api_keys": [],
        "created_at": "2024-01-15T10:30:00.000Z",
        "created_by_id": "27bb070b564349f8a31cc60734cc36a5",
        "created_by_name": "username",
        "description": "description",
        "id": "27bb070b564349f8a31cc60734cc36a5",
        "limit": 10,
        "modified_at": "2024-01-15T10:30:00.000Z",
        "modified_by_id": "27bb070b564349f8a31cc60734cc36a5",
        "modified_by_name": "username",
        "name": "usage-plan-name",
        "rate": "day"
    }
}

1.55.2 - 1.2

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

Description

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

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
pathusage_plan_id
required		사용량 정책 ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone

Responses

HTTP CodeDescriptionSchema
200OKUsagePlanShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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": "2024-01-15T10:30:00.000Z",
        "created_by_id": "27bb070b564349f8a31cc60734cc36a5",
        "created_by_name": "username",
        "description": "description",
        "id": "27bb070b564349f8a31cc60734cc36a5",
        "limit": 10,
        "modified_at": "2024-01-15T10:30:00.000Z",
        "modified_by_id": "27bb070b564349f8a31cc60734cc36a5",
        "modified_by_name": "username",
        "name": "usage-plan-name",
        "rate": "day"
    }
}

1.55.3 - 1.1

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

Description

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

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

버전최소 지원 보장일
1.120260430

Parameters

TypeNameDescriptionSchemaDefault
pathapi_id
required		Api ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone
pathusage_plan_id
required		사용량 정책 ID
Example : 27bb070b564349f8a31cc60734cc36a5
stringNone

Responses

HTTP CodeDescriptionSchema
200OKUsagePlanShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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": "2024-01-15T10:30:00.000Z",
        "created_by_id": "27bb070b564349f8a31cc60734cc36a5",
        "created_by_name": "username",
        "description": "description",
        "id": "27bb070b564349f8a31cc60734cc36a5",
        "limit": 10,
        "modified_at": "2024-01-15T10:30:00.000Z",
        "modified_by_id": "27bb070b564349f8a31cc60734cc36a5",
        "modified_by_name": "username",
        "name": "usage-plan-name",
        "rate": "day"
    }
}

2 - Models

2.1 - AccessControl

NameDescriptionSchemaDefault
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

2.2 - AccessControlCreateRequest

NameDescriptionSchemaDefault
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

2.3 - AccessControlCreateResponse

NameDescriptionSchemaDefault
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

2.4 - AccessControlListResponse

NameDescriptionSchemaDefault
access_controls
required
array[AccessControl]
count
required		총 개수
Example : 20
integer

2.5 - AccessControlSetRequest

NameDescriptionSchemaDefault
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]

2.6 - AccessControlShowResponse

NameDescriptionSchemaDefault
access_control
required
AccessControl

2.7 - Api

NameDescriptionSchemaDefault
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

2.8 - ApiConnectedEndpoint

NameDescriptionSchemaDefault
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

2.9 - ApiConnectedEndpointListResponse

NameDescriptionSchemaDefault
connected_endpoints
required
array[ApiConnectedEndpoint]
count
required		총 개수
Example : 20
integer

2.10 - ApiCreateRequest

NameDescriptionSchemaDefault
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]

2.11 - ApiCreateRequestV1Dot2

NameDescriptionSchemaDefault
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]

2.12 - ApiCreateResponse

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

2.13 - ApiDeployment

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

2.14 - ApiDeploymentListResponse

NameDescriptionSchemaDefault
count
required		총 개수
Example : 20
integer
deployments
required
array[ApiDeployment]

2.15 - ApiDeploymentRequest

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

2.16 - ApiDeploymentResponse

NameDescriptionSchemaDefault
deployment_id
required		배포 ID
Example : 27bb070b564349f8a31cc60734cc36a5
string
description
optional		설명
Example : description
any of [string, null]

2.17 - ApiDetail

NameDescriptionSchemaDefault
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

2.18 - ApiKey

NameDescriptionSchemaDefault
created_at
required		생성 일시
Example : 2024-01-15T10:30:00.000Z
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

2.19 - ApiKeyCreateRequest

NameDescriptionSchemaDefault
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

2.20 - ApiKeyInStage

NameDescriptionSchemaDefault
id
required		API Key ID
Example : 27bb070b564349f8a31cc60734cc36a5
string
name
required		이름
Example : api-key-name
string

2.21 - ApiKeyListResponse

NameDescriptionSchemaDefault
api_keys
required
array[ApiKey]
count
required		총 개수
Example : 20
integer

2.22 - ApiKeySetDescriptionRequest

NameDescriptionSchemaDefault
description
optional		설명
Example : description
any of [string, null]

2.23 - ApiKeyShowResponse

NameDescriptionSchemaDefault
api_key
required
ApiKey

2.24 - ApiListResponse

NameDescriptionSchemaDefault
apis
required
array[Api]
count
required		총 개수
Example : 20
integer

2.25 - ApiSetDescriptionRequest

NameDescriptionSchemaDefault
description
optional		설명
Example : description
any of [string, null]

2.26 - ApiShowResponse

NameDescriptionSchemaDefault
api
required
ApiDetail

2.27 - Auth

NameDescriptionSchemaDefault
auth_method
optional		인증 수단
Example : JWT(JSON WEB Token)
stringJWT(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

2.28 - AuthCreateRequest

NameDescriptionSchemaDefault
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

2.29 - AuthCreateResponse

NameDescriptionSchemaDefault
access_token
required		액세스 토큰
Example : ***********************************************************
string

2.30 - AuthListResponse

NameDescriptionSchemaDefault
auths
required
array[Auth]
count
required		총 개수
Example : 20
integer

2.31 - AuthSetRequest

NameDescriptionSchemaDefault
connected_stages
required		연결된 스테이지
Example : ['dev,stg']
any of [array[string], null]

2.32 - AuthShowResponse

NameDescriptionSchemaDefault
auth
required
Auth

2.33 - Method

NameDescriptionSchemaDefault
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

2.34 - MethodCreateRequest

NameDescriptionSchemaDefault
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]
iam_enabled
optional		IAM 정책 적용여부
Example : False
boolean
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]

2.35 - MethodCreateRequestV1Dot1

NameDescriptionSchemaDefault
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]
iam_enabled
optional		IAM 정책 적용여부
Example : False
boolean
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]

2.36 - MethodCreateRequestV1Dot2

NameDescriptionSchemaDefault
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]
iam_enabled
optional		IAM 정책 적용여부
Example : False
boolean
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]

2.37 - MethodCreateRequestV1Dot3

NameDescriptionSchemaDefault
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]
iam_enabled
optional		IAM 정책 적용여부
Example : False
boolean
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]

2.38 - MethodInStage

NameDescriptionSchemaDefault
api_key_required
optional		API Key 사용여부
Example : False
boolean
type
required		메서드 유형
Example : GET
string

2.39 - MethodInStageV1Dot3

NameDescriptionSchemaDefault
api_key_required
optional		API Key 사용여부
Example : False
boolean
iam_enabled
optional		IAM 정책 적용여부
Example : False
boolean
type
required		메서드 유형
Example : GET
string

2.40 - MethodListResponse

NameDescriptionSchemaDefault
methods
required
array[Method]

2.41 - MethodListResponseV1Dot1

NameDescriptionSchemaDefault
methods
required
array[MethodV1Dot1]

2.42 - MethodListResponseV1Dot2

NameDescriptionSchemaDefault
methods
required
array[MethodV1Dot2]

2.43 - MethodListResponseV1Dot3

NameDescriptionSchemaDefault
methods
required
array[MethodV1Dot3]

2.44 - MethodSetRequest

NameDescriptionSchemaDefault
query_strings
required		메서드 쿼리 문자열
Example : {'param1': 'value1', 'param2': 'value2'}
object[boolean]
request_headers
required		메서드 요청 헤더
Example : {'test1' : True}
object[boolean]

2.45 - MethodSetRequestV1Dot1

NameDescriptionSchemaDefault
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]

2.46 - MethodSetRequestV1Dot2

NameDescriptionSchemaDefault
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]

2.47 - MethodSetRequestV1Dot3

NameDescriptionSchemaDefault
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]
iam_enabled
required		IAM 정책 적용여부
Example : False
boolean
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]

2.48 - MethodShowResponse

NameDescriptionSchemaDefault
method
required
Method

2.49 - MethodShowResponseV1Dot1

NameDescriptionSchemaDefault
method
required
MethodV1Dot1

2.50 - MethodShowResponseV1Dot2

NameDescriptionSchemaDefault
method
required
MethodV1Dot2

2.51 - MethodShowResponseV1Dot3

NameDescriptionSchemaDefault
method
required
MethodV1Dot3

2.52 - MethodV1Dot1

NameDescriptionSchemaDefault
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

2.53 - MethodV1Dot2

NameDescriptionSchemaDefault
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

2.54 - MethodV1Dot3

NameDescriptionSchemaDefault
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]
iam_enabled
optional		IAM 정책 적용여부
Example : False
boolean
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

2.55 - PolicyDocument

NameDescriptionSchemaDefault
Statement
required		Statement
Example : {'Statement': [{'Action': ['apigateway:InvokeApigatewayRegion'], 'Condition': {'SrnLike': {"scp:RequestAttribute/body['method-srn']": ['srn:dev2::27bb070b564349f8a31cc60734cc36a5:kr-west1::apigateway:method/a4b19a70b596467fb010d3c3/*/GET/n-f']}}, 'Effect': 'Allow', 'Principal': '*', 'Resource': ['srn:dev2::27bb070b564349f8a31cc60734cc36a5:kr-west1::apigateway:api/a4b19a70b596467fb010d3c3'], 'Sid': 'Statement1'}], 'Version': '2024-07-01'}
array[Statement]
Version
required		버전
Example : 2024-07-01
string

2.56 - PrivateLinkEndpoint

NameDescriptionSchemaDefault
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

2.57 - PrivateLinkEndpointApprovalRequest

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

2.58 - PrivateLinkEndpointConnectionRequest

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

2.59 - PrivateLinkEndpointCreateRequest

NameDescriptionSchemaDefault
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

2.60 - PrivateLinkEndpointDetail

NameDescriptionSchemaDefault
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

2.61 - PrivateLinkEndpointListResponse

NameDescriptionSchemaDefault
count
required		총 개수
Example : 20
integer
privatelink_endpoints
required
array[PrivateLinkEndpoint]

2.62 - PrivateLinkEndpointRequestRequest

NameDescriptionSchemaDefault
type
required		PrivateLink 엔드포인트 액션 유형
Example : CANCEL
enum (CANCEL, RE_REQUEST)

2.63 - PrivateLinkEndpointSetRequest

NameDescriptionSchemaDefault
description
optional		설명
Example : description
any of [string, null]

2.64 - PrivateLinkEndpointShowResponse

NameDescriptionSchemaDefault
privatelink_endpoint
required
PrivateLinkEndpointDetail

2.65 - PrivateLinkEndpointSummary

NameDescriptionSchemaDefault
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

2.66 - PrivateLinkEndpointSummaryShowResponse

NameDescriptionSchemaDefault
privatelink_endpoint
required
PrivateLinkEndpointSummary

2.67 - Report

NameDescriptionSchemaDefault
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

2.68 - ReportListResponse

NameDescriptionSchemaDefault
count
required		총 개수
Example : 20
integer
reports
required
array[Report]
top_resources
required
array[TopResource]

2.69 - Resource

NameDescriptionSchemaDefault
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

2.70 - ResourceCreateRequest

NameDescriptionSchemaDefault
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

2.71 - ResourceCreateResponse

NameDescriptionSchemaDefault
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

2.72 - ResourceListResponse

NameDescriptionSchemaDefault
resources
required
array[Resource]

2.73 - ResourceListResponseV1Dot1

NameDescriptionSchemaDefault
resources
required
array[ResourceV1Dot1]

2.74 - ResourceListResponseV1Dot2

NameDescriptionSchemaDefault
resources
required
array[ResourceV1Dot2]

2.75 - ResourceListResponseV1Dot3

NameDescriptionSchemaDefault
resources
required
array[ResourceV1Dot3]

2.76 - ResourcePolicySetRequest

NameDescriptionSchemaDefault
policy_document
required		Policy Document
Example : {'Statement': [{'Action': ['apigateway:InvokeApigatewayRegion'], 'Condition': {'SrnLike': {"scp:RequestAttribute/body['method-srn']": ['srn:dev2::27bb070b564349f8a31cc60734cc36a5:kr-west1::apigateway:method/a4b19a70b596467fb010d3c3/*/GET/n-f']}}, 'Effect': 'Allow', 'Principal': '*', 'Resource': ['srn:dev2::27bb070b564349f8a31cc60734cc36a5:kr-west1::apigateway:api/a4b19a70b596467fb010d3c3'], 'Sid': 'Statement1'}], 'Version': '2024-07-01'}
PolicyDocument

2.77 - ResourcePolicyShowResponse

NameDescriptionSchemaDefault
policy_document
required		Policy Document
Example : {'Statement': [{'Action': ['apigateway:InvokeApigatewayRegion'], 'Condition': {'SrnLike': {"scp:RequestAttribute/body['method-srn']": ['srn:dev2::27bb070b564349f8a31cc60734cc36a5:kr-west1::apigateway:method/a4b19a70b596467fb010d3c3/*/GET/n-f']}}, 'Effect': 'Allow', 'Principal': '*', 'Resource': ['srn:dev2::27bb070b564349f8a31cc60734cc36a5:kr-west1::apigateway:api/a4b19a70b596467fb010d3c3'], 'Sid': 'Statement1'}], 'Version': '2024-07-01'}
PolicyDocument

2.78 - ResourceShowResponse

NameDescriptionSchemaDefault
resource
required
Resource

2.79 - ResourceShowResponseV1Dot1

NameDescriptionSchemaDefault
resource
required
ResourceV1Dot1

2.80 - ResourceShowResponseV1Dot2

NameDescriptionSchemaDefault
resource
required
ResourceV1Dot2

2.81 - ResourceShowResponseV1Dot3

NameDescriptionSchemaDefault
resource
required
ResourceV1Dot3

2.82 - ResourceSummary

NameDescriptionSchemaDefault
methods
required		메서드 유형
Example : GET
array[string]
path
required		경로
Example : /test/test1
string

2.83 - ResourceSummaryV1Dot1

NameDescriptionSchemaDefault
methods
required
array[MethodInStage]
path
required		경로
Example : /test/test1
string

2.84 - ResourceSummaryV1Dot3

NameDescriptionSchemaDefault
methods
required
array[MethodInStageV1Dot3]
path
required		경로
Example : /test/test1
string

2.85 - ResourceV1Dot1

NameDescriptionSchemaDefault
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

2.86 - ResourceV1Dot2

NameDescriptionSchemaDefault
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

2.87 - ResourceV1Dot3

NameDescriptionSchemaDefault
id
required		리소스 ID
Example : 27bb070b564349f8a31cc60734cc36a5
string
methods
required
array[MethodV1Dot3]
parent_id
required		부모 리소스 ID
Example : 27bb070b564349f8a31cc60734cc36a5
string
path
required		경로
Example : /test/test1
string
path_part
required		경로명
Example : test
string

2.88 - Stage

NameDescriptionSchemaDefault
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 : 2024-01-15T10:30:00.000Z
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

2.89 - StageCreateRequest

NameDescriptionSchemaDefault
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

2.90 - StageDetail

NameDescriptionSchemaDefault
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 : 2024-01-15T10:30:00.000Z
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

2.91 - StageDetailV1Dot1

NameDescriptionSchemaDefault
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 : 2024-01-15T10:30:00.000Z
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]

2.92 - StageDetailV1Dot3

NameDescriptionSchemaDefault
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 : 2024-01-15T10:30:00.000Z
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]

2.93 - StageListResponse

NameDescriptionSchemaDefault
stages
required
array[Stage]

2.94 - StageListResponseV1Dot1

NameDescriptionSchemaDefault
stages
required
array[StageV1Dot1]

2.95 - StageListResponseV1Dot3

NameDescriptionSchemaDefault
stages
required
array[StageV1Dot3]

2.96 - StageSetActiveDeploymentRequest

NameDescriptionSchemaDefault
deployment_id
required		배포 ID
Example : 27bb070b564349f8a31cc60734cc36a5
string

2.97 - StageSetConfigRequest

NameDescriptionSchemaDefault
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]

2.98 - StageSetConfigRequestV1Dot1

NameDescriptionSchemaDefault
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]

2.99 - StageShowResponse

NameDescriptionSchemaDefault
stage
required
StageDetail

2.100 - StageShowResponseV1Dot1

NameDescriptionSchemaDefault
stage
required
StageDetailV1Dot1

2.101 - StageShowResponseV1Dot3

NameDescriptionSchemaDefault
stage
required
StageDetailV1Dot3

2.102 - StageV1Dot1

NameDescriptionSchemaDefault
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 : 2024-01-15T10:30:00.000Z
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]

2.103 - StageV1Dot3

NameDescriptionSchemaDefault
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': [{'api_key_required': True, 'iam_enabled': True, 'type': 'GET'}, {'api_key_required': False, 'iam_enabled': False, 'type': 'POST'}], 'path': '/'}, {'methods': [{'api_key_required': True, 'iam_enabled': True, 'type': 'GET'}, {'api_key_required': False, 'iam_enabled': False, 'type': 'POST'}], 'path': '/test'}]
array[ResourceSummaryV1Dot3]
cors_enabled
required		CORS 사용여부
Example : False
boolean
created_at
required		생성 일시
Example : 2024-01-15T10:30:00.000Z
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]

2.104 - Statement

NameDescriptionSchemaDefault
Action
optional		Action
Example : ['iam:*']
any of [array[string], null]
Condition
optional		Condition
Example : {'StringEquals': {'scp:RequestedRegion': ['kr-west1']}}
any of [object[object[array[object]]], null]
Effect
required		Effect
Example : Allow
enum (Allow, Deny)
NotAction
optional		Not Action
Example :
any of [array[string], null]
Principal
optional		Principal
Example :
any of [string, object[array[string]], null]
Resource
optional		Resource
Example : ['*']
array[string]
Sid
optional		Sid
Example : Statement1
stringstatement1

2.105 - Tag

NameDescriptionSchemaDefault
key
required		tag key
Example : key
string
value
required		tag value
Example : value
string

2.106 - TopResource

NameDescriptionSchemaDefault
call_count
required		호출 수
Example : 10
integer
name
required		리소스명
Example : test
string
path
required		리소스 경로
Example : /test/test1
string
type
required		메서드 유형
Example : GET
string

2.107 - UsagePlan

NameDescriptionSchemaDefault
connected_api_keys
required		연결된 API Key 목록
Example : ['key1', 'key2']
array[string]
created_at
required		생성 일시
Example : 2024-01-15T10:30:00.000Z
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)

2.108 - UsagePlanCreateRequest

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

2.109 - UsagePlanDetail

NameDescriptionSchemaDefault
api_keys
required		API Key
array[ApiKey]
created_at
required		생성 일시
Example : 2024-01-15T10:30:00.000Z
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 : 2024-01-15T10:30:00.000Z
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)

2.110 - UsagePlanListResponse

NameDescriptionSchemaDefault
count
required		총 개수
Example : 20
integer
usage_plans
required
array[UsagePlan]

2.111 - UsagePlanSetDescriptionRequest

NameDescriptionSchemaDefault
description
optional		설명
Example : description
any of [string, null]

2.112 - UsagePlanSetQuotaRequest

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

2.113 - UsagePlanShowResponse

NameDescriptionSchemaDefault
usage_plan
required
UsagePlanDetail