Edit API key

Available in Classic and VPC

Edit API key information.

Request

The following describes the request format for the endpoint. The request format is as follows:

Method	URI
PUT	/api-keys/{api-key-id}

Request headers

For headers common to API Gateway, see API Gateway common request headers.

Request path parameters

The following describes the parameters.

Field	Type	Required	Description
`api-key-id`	String	Required	API key ID to edit

Request syntax

The request syntax is as follows.

{
  "isEnabled" : true,
  "apiKeyDescription" : "apiKeyDescription",
  "apiKeyName" : "apiKeyName"
}

Request body

The following describes the request body.

Field	Type	Required	Description
`isEnabled`	Boolean	Required	Whether the API key is enabled `true` \| `false` `true`: API key enabled `false`: API key disabled
`apiKeyDescription`	String	Optional	Description for the API key 0 - 50 characters
`apiName`	String	Required	API key name 1 - 20 characters

Request example

The following is a sample request.

curl -X PUT 'https://apigateway.apigw.ntruss.com/api/v1/api-keys/{api-key-id}' \
--header 'Content-Type: application/json' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
--data '{
  "isEnabled" : true,
  "apiKeyDescription" : "apiKey-*** Description",
  "apiKeyName" : "apiKey-***"
}'

Response

The following describes the response format.

Response syntax

The syntax is as follows.

{
    "apiKey": {
        "apiKeyId": "apiKeyId",
        "tenantId": "tenantId",
        "apiKeyName": "apiKeyName",
        "apiKeyDescription": "apiKeyDescription",
        "primaryKey": "primaryKey",
        "secondaryKey": "secondaryKey",
        "modifier": "modifier",
        "isEnabled": true,
        "modTime": "2024-05-08T05:56:26Z",
        "domainCode": "domainCode"
    }
}

Response status codes

For response status codes common to API Gateway, see API Gateway response status codes.

Response example

The following is a sample response.

{
    "apiKey": {
        "apiKeyId": "*****g079",
        "tenantId": "*****02f55ae4436913a6e2c65bab47c",
        "apiKeyName": "apiKey-***",
        "apiKeyDescription": "apiKey-*** Description",
        "primaryKey": "*****yVk37ZE39kJcZScH50cYsJiYf1EJUQ7haPj",
        "secondaryKey": "*****RWKmt1IVMAlXtg0yJ5jelwwiltuJBFKBDW9",
        "modifier": "d12c9fd0-****-****-****-246e96591a38",
        "isEnabled": true,
        "modTime": "2024-05-08T05:56:26Z",
        "domainCode": "PUB"
    }
}