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

Create Api Key

1: 1.2
2: 1.1

1 - 1.2

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

Description

API Key를 생성한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	usage_plan_id required	사용량 정책 ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
body	body required		ApiKeyCreateRequest

Responses

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

Example HTTP request

Request path

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

Request header

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

Request body

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

Example HTTP response

Response 200

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

2 - 1.1

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

Description

API Key를 생성한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260430

Parameters

Type	Name	Description	Schema	Default
path	api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
path	usage_plan_id required	사용량 정책 ID Example : `27bb070b564349f8a31cc60734cc36a5`	string	None
body	body required		ApiKeyCreateRequest

Responses

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

Example HTTP request

Request path

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

Request header

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

Request body

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

Example HTTP response

Response 200

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