MENU
      View API key subscription

        View API key subscription


        Article summary

        Available in Classic and VPC

        View information of the stage (subscribed stage) associated with an API key.

        Request

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

        MethodURI
        GET/api-keys/{api-key-id}/subscription-detail

        Request headers

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

        Request path parameters

        The following describes the parameters.

        FieldTypeRequiredDescription
        api-key-idStringRequiredAPI key ID to view subscription information

        Request query parameters

        The following describes the parameters.

        FieldTypeRequiredDescription
        offsetLongOptionalStarting point in the list of data to view
        • 0 - 9,223,372,036,854,775,807
        limitLongOptionalNumber of data to view at once
        • 1 - 9,223,372,036,854,775,807
        apiIdStringOptionalAPI ID that the stage belongs to
        stageIdStringOptionalStage ID associated with the API key
        productIdStringRequiredProduct ID associated with the API key

        Request example

        The following is a sample request.

        curl -X POST 'https://apigateway.apigw.ntruss.com/api/v1/api-keys/{api-key-id}/subscription-detail?productId=*****n0bk' \
        --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}'
        Curl

        Response

        The following describes the response format.

        Response syntax

        The syntax is as follows.

        {
            "apiKeyRelations": {
                "content": [
                    {
                        "apiId": "apiId",
                        "apiName": "apiName",
                        "stageId": "stageId",
                        "stageName": "stageName",
                        "apiKeyId": "apiKeyId",
                        "apiKeyName": "apiKeyName",
                        "usagePlanId": "usagePlanId",
                        "usagePlanName": "usagePlanName",
                        "regTime": "2024-05-07T08:34:37Z",
                        "modTime": "2024-05-07T08:34:37Z",
                        "dayCallCount": 0,
                        "monthCallCount": 0,
                        "domainCode": "domainCode"
                    }
                ],
                "total": 0
            }
        }
        JSON

        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.

        {
            "apiKeyRelations": {
                "content": [
                    {
                        "apiId": "*****uwtk",
                        "apiName": "api-***",
                        "stageId": "*****7mhdv",
                        "stageName": "v1",
                        "apiKeyId": "*****g079",
                        "apiKeyName": "apiKey-***",
                        "usagePlanId": "*****w2111",
                        "usagePlanName": "usagePlan-***",
                        "regTime": "2024-05-07T08:34:37Z",
                        "modTime": "2024-05-07T08:34:37Z",
                        "dayCallCount": 0,
                        "monthCallCount": 0,
                        "domainCode": "PUB"
                    }
                ],
                "total": 1
            }
        }
        JSON

        Was this article helpful?

        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.