Edit API
    • PDF

    Edit API

    • PDF

    Article summary

    Available in Classic and VPC

    Edit the description of an API.

    Request

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

    MethodURI
    PATCH/products/{product-id}/apis/{api-id}

    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 associated with the API
    api-idStringRequiredAPI ID created on the product

    Request syntax

    The request syntax is as follows.

    {
      "apiDescription" : "apiDescription"
    }
    

    Request body

    The following describes the request body.

    FieldTypeRequiredDescription
    apiDescriptionStringRequiredDescription for the API to edit

    Request example

    The following is a sample request.

    curl -X PATCH 'https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-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 '{
      "apiDescription" : "api-*** Description"
    }'
    

    Response

    The following describes the response format.

    Response status codes

    For response status codes common to API Gateway, see API Gateway response status codes.


    Was this article helpful?

    What's Next
    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.