1.0

put /v1/apis/{api_id}/description

Description

Set api description

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

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

Responses

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

Example HTTP request

Request path

/v1/apis/{api_id}/description

Request header

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

Request body

{
    "description": "description"
}

Example HTTP response

Response 200

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