MENU
      API Keyの状態変更

        API Keyの状態変更


        記事の要約

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

        指定した API Keyの状態を変更します。

        リクエスト

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

        メソッドURI
        PATCH/products/{product-id}/api-keys/{api-key-id}

        リクエストヘッダ

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

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

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

        フィールドタイプ必須の有無説明
        product-idStringRequiredAPI Keyが属する Product ID
        api-key-idStringRequired状態を変更する対象の API Key ID

        リクエストボディ

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

        フィールドタイプ必須の有無説明
        statusStringRequired変更後の状態
        • ACCEPTED | REJECTED
          • ACCEPTED: 承認
          • REJECTED: 拒否

        リクエスト例

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

        curl --location --request PATCH 'https://apigateway.apigw.ntruss.com/api/v1/products/***ksk9***/api-keys/***fmy2***' \
        --header 'x-ncp-apigw-timestamp: {Timestamp}' \
        --header 'x-ncp-iam-access-key: {Access Key}' \
        --header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
        --header 'Content-Type: application/json' \
        --data '{
            "status" : "ACCEPTED"
        }'
        Curl

        レスポンス

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

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

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


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

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.