API Keyの再作成

Classic/VPC環境で利用できます。

API Keyの Primary Keyまたは Secondary Keyを再作成します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

リクエストヘッダ

API Gatewayで共通して使用されるヘッダの詳細は、API Gatewayのリクエストヘッダをご参照ください。

リクエストパスパラメータ

パラメータの説明は次の通りです。

リクエスト構文

リクエスト構文は次の通りです。

{
  "keyType" : "keyType"
}

リクエストボディ

リクエストボディの説明は次の通りです。

リクエスト例

リクエストのサンプルコードは次の通りです。

curl -X PATCH '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 '{
  "keyType" : "PRIMARY"
}'

レスポンス

レスポンス形式を説明します。

レスポンス構文

構文は次の通りです。

{
    "apiKey": {
        "apiKeyId": "apiKeyId",
        "tenantId": "tenantId",
        "apiKeyName": "apiKeyName",
        "apiKeyDescription": "apiKeyDescription",
        "primaryKey": "primaryKey",
        "secondaryKey": "secondaryKey",
        "modifier": "modifier",
        "isEnabled": false,
        "modTime": "2024-05-08T00:21:31Z",
        "domainCode": "domainCode"
    }
}

レスポンスステータスコード

API Gatewayで共通して使用されるレスポンスステータスコードの詳細は、API Gatewayのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "apiKey": {
        "apiKeyId": "*****bgro1",
        "tenantId": "*****02f55ae4436913a6e2c65bab47c",
        "apiKeyName": "apiKeyName",
        "apiKeyDescription": "apiKeyDescription",
        "primaryKey": "*****f7AOklrKqLQiZfLRUPnXsHHLQi4jhYURYSU",
        "secondaryKey": "*****a2121vr736Q7JlU2L3erP7Kkuryvu2iJRi8",
        "modifier": "d12c9fd0-****-****-****-246e96591a38",
        "isEnabled": false,
        "modTime": "2024-05-08T00:21:31Z",
        "domainCode": "PUB"
    }
}