Copy API

Available in Classic and VPC

Copy an API to create a new API.

Request

This section describes the request format. The method and URI are as follows:

Request headers

For information about the headers common to all API Gateways, see API Gateway request headers.

Request path parameters

You can use the following path parameters with your request:

Request syntax

The request syntax is as follows:

{
  "apiName" : "apiName",
  "apiDescription" : "apiDescription",
  "originApiId" : "originApiId"
}

Request body

You can include the following data in the body of your request:

Request example

The request example is as follows:

curl -X POST 'https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/clone' \
--header 'Content-Type: application/json' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Sub Account Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
  "apiName" : "api-***",
  "apiDescription" : "api-*** Description",
  "originApiId" : "**********"
}

Response

This section describes the response format.

Response syntax

The syntax is as follows:

{
    "api": {
        "productId": "productId",
        "apiId": "apiId",
        "apiName": "apiName",
        "apiDescription": "apiDescription",
        "tenantId": "tenantId",
        "modifier": "modifier",
        "modTime": "2024-05-03T07:46:37Z",
        "isDeleted": false,
        "domainCode": "domainCode"
    }
}

Response status codes

For information about the HTTP status codes common to all API Gateway, see API Gateway response status codes.

Response example

The response example is as follows:

{
    "api": {
        "productId": "*****0bk",
        "apiId": "*****1r9cm",
        "apiName": "api_clone",
        "apiDescription": "api_clone Description",
        "tenantId": "*****02f55ae4436913a6e2c65bab47c",
        "modifier": "d12c9fd0-****-****-****-246e96591a38",
        "modTime": "2024-05-03T07:46:37Z",
        "isDeleted": false,
        "domainCode": "PUB"
    }
}