Get edge list

Prev Next

The latest service changes have not yet been reflected in this content. We will update the content as soon as possible. Please refer to the Korean version for information on the latest updates.

Available in Classic and VPC

Get the list of edges in a profile.

Request

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

Method URI
GET /api/v1/profiles/{profileId}/cdn-edges

Request headers

For information about the headers common to all Global Edge APIs, see Global Edge request headers.

Request path parameters

You can use the following path parameters with your request:

Field Type Required Description
profileId Number Required Profile ID

Request example

The request example is as follows:

curl --location --request GET 'https://edge.apigw.ntruss.com/api/v1/profiles/1599/cdn-edges' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
code String - Response code
message String - Response message
result Array - Edge list

result

The following describes result.

Field Type Required Description
id Number - Edge ID
profileId Number - Profile ID
edgeName String - Edge name
statusType String - Edge status
  • PUBLISHING | RUNNING | STOPPING | STOPPED | ACTIVATING | DELETING | DELETED
    • PUBLISHING: Deploying
    • RUNNING: Operating
    • STOPPING: Stopping
    • STOPPED: Stopped
    • ACTIVATING: Restarting
    • DELETING: Deleting
    • DELETED: Deleted
serviceRegionType String - Service area
  • KOREA | JAPAN | GLOBAL
originalCopyDomain String - Origin domain
registrationDate String - Creation date and time
modifyDate String - Last settings change date and time
domainName String - Edge domain

Response status codes

For information about the HTTP status codes common to all Global Edge APIs, see Global Edge response status codes.

Response example

The response example is as follows:

{
    "code": "0000",
    "message": "Success",
    "result": [
        {
            "id": 5707,
            "profileId": 1599,
            "edgeName": "edge1",
            "statusType": "STOPPED",
            "serviceRegionType": "KOREA",
            "originalCopyDomain": "*********.kr.object.ncloudstorage.com",
            "registrationDate": "2025-07-15T00:15:05.833Z",
            "modifyDate": "2025-07-15T04:53:00.949Z",
            "domainName": "sd0t********.edge.naverncp.com"
        }
    ]
}