1.2

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

Description

Set api key

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

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

Responses

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

Example HTTP request

Request path

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

Request header

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

Request body

{
    "description": "description"
}

Example HTTP response

Response 200

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