リクエスト

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

メソッド	URI
PUT	/api-keys/{api-key-id}

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`api-key-id`	String	Required	変更対象の API Key ID

リクエスト構文

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

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

リクエストボディ

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

フィールド	タイプ	必須の有無	説明
`isEnabled`	Boolean	Required	API Key有効化の有無 `true` \| `false` `true`: API Key有効化 `false`: API Key無効化
`apiKeyDescription`	String	Optional	API Keyの説明 0~50文字
`apiName`	String	Required	API Keyの名前 1~20文字

リクエスト例

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

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-***"
}'

レスポンス

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

レスポンス構文

構文は次の通りです。

{
    "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"
    }
}

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

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

レスポンス例

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

{
    "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"
    }
}

この記事は役に立ちましたか?

リクエスト
レスポンス