MENU
      View stage deployment history

        View stage deployment history


        Article summary

        Available in Classic and VPC

        View the history of API deployments to a specified stage.

        Request

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

        MethodURI
        GET/products/{product-id}/apis/{api-id}/stages/{stage-id}/deployments

        Request headers

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

        Request path parameters

        The following describes the parameters.

        FieldTypeRequiredDescription
        product-idStringRequiredProduct ID that the stage belongs to
        api-idStringRequiredID of the API that the stage belongs to
        stage-idStringRequiredID of the stage to view deployment history for

        Request query parameters

        The following describes the parameters.

        FieldTypeRequiredDescription
        offsetLongOptionalStarting point of the response data
        • 0 - 9,223,372,036,854,775,807
        • It is used with limit to implement pagination
        limitLongOptionalMaximum number of response data
        • 1 - 9,223,372,036,854,775,807
        • It is used with offset to implement pagination

        Request example

        The following is a sample request.

        curl --location --request GET 'https://apigateway.apigw.ntruss.com/api/v1/products/***ksk9***/apis/***51hs***/stages/***5ei7***/deployments' \
        --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 response syntax is as follows.

        {
            "total" : 1,
            "content" : [ {
                "deployedTime" : "2000-01-23T04:56:07.000+00:00",
                "deploymentDescription" : "deploymentDescription",
                "stageDeploymentNo" : 0,
                "documentJson" : "documentJson",
                "stageId" : "stageId"
            } ],
            "defaultDeploymentNo" : 6
        }
        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.

        {
            "content": [
                {
                    "stageDeploymentNo": 251***,
                    "deploymentDescription": "",
                    "stageId": "***5ei7***",
                    "deployedTime": "2024-05-08T02:38:43Z"
                },
        // (Omitted)
            ],
            "total": 9,
            "defaultDeploymentNo": 251***
        }
        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.