Edit Edge

Overview

Change the created CDN Edge settings.

• Available to request only during operation or in the stopped state.
• You cannot change service area and service domain.

Requests

Request URL

PUT
https://edge.apigw.ntruss.com/api/v1/cdn-edges/{edgeId}

Request body

EdgeConfig

CdnDistributionConfig

ServiceDomain

Certificate

EdgeLogging

ObjectStorage

CdnOriginalCopyConfig

OriginalCopyLocation

ForwardHostHeader

OriginalCopyProtocol

OriginShield

OriginFailoverConfig

CdnCachingConfig

DefaultCaching

CacheRevalidateConfig

BypassQueryString

CacheKeyIgnoreQueryString

EdgeAuth

CachingRule

RuleBasedRoutingConfig

BrowserCache

CacheKeyQueryParameter

UrlRedirect

UrlRewrite

ManagedRule

HeaderPolicy

Header

OptimizationConfig

AccessControl

Responses

Every response returns success or failure with an HTTP status code.

Examples

Request Examples

https://edge.apigw.ntruss.com/api/v1/cdn-edges/123

{
    "profileId": 234,
    "edgeName": "sample-edge",
    "distributionConfig": {
        "protocolType": "ALL",
        "regionType": "KOREA",
        "serviceDomain": {
            "domainType": "NCP_DOMAIN_AUTO",
            "domainName": null,
            "certificate": null
        },
        "edgeLogging": {
            "enabled": true,
            "objectStorage": {
                "region": "KR",
                "bucketName": "sample-bucket"
            },
            "bucketPrefix": "log/sample"
        }
    },
    "originalCopyConfig": {
        "originalCopyLocation": {
            "type": "OBJECT_STORAGE",
            "region": "KR",
            "bucketName":"sample-bucket",
            "customLocation": null
        },
        "forwardHostHeader": {
            "type": "ORIGIN_HOSTNAME",
            "customHostHeader": null
        },
        "originalCopyProtocol": {
            "type": "HTTP",
            "port": 80
        },
        "originalCopyPath": null,
        "originShield": {
            "enabled": true,
            "region": "USWN"
        },
        "originFailoverConfig": null
    },
    "cachingConfig": {
        "defaultCaching": {
            "enabled": true,
            "ruleDefinitionType": "CACHING",
            "cacheRevalidateConfig": {
                "type": "IF_POSSIBLE",
                "ageType": "HOURS",
                "age": "10"
            }
        },
        "negativeTtl": true,
        "bypassQueryString": {
            "enabled": true,
            "queryStrings": ["aaa", "bbb", "ccc"]
        },
        "cacheKeyHostname": "INCOMING_HOST_HEADER",
        "cacheKeyIgnoreQueryString": {
            "type": "ALL_ALLOWED",
            "queryStrings": []
        },
        "removeVaryHeader": true,
        "edgeAuth": {
            "enabled": true,
            "type": "SIGNED_URL",
            "tokenName": "name",
            "tokenKey": "902bceb96b2139771716910ff0b9befb"
        },
        "cachingRules": [{
            "ruleName": "sample",
            "ruleType": "DIRECTORY",
            "ruleConditions": ["/sample/*"],
            "ruleDefinitionType": "CACHING",
            "cacheRevalidateConfig": {
                "type": "IF_POSSIBLE",
                "ageType": "SECONDS",
                "age": 100
            },
            "ruleBasedRoutingConfig": {
                "enabled": true,
                "originalCopyLocation": {
                    "type": "OBJECT_STORAGE",
                    "region": "KR",
                    "bucketName": "sample-bucket",
                    "customLocation": null
                }
            },
            "browserCache": {
                "enabled": true,
                "type": "ALLOW_CACHE",
                "age": 100,
                "ageType": "SECONDS"
            },
            "cacheKeyQueryParameter": {
                "enabled": true,
                "type": "IGNORE_SPECIFIC_STRING",
                "queryParameters": ["aaa", "bbb", "ccc"]
            },
            "accessDeny": false,
            "urlRedirect": {
                "enabled": true,
                "destinationProtocol": "HTTP",
                "destinationHostname": "ncloud.com",
                "destinationPath": "/home",
                "responseCode": "FOUND_302"
            },
            "urlRewrite": {
                "enabled": false,
                "rewriteTarget": null
            }
        }]
    },
    "managedRule": {
        "cors": true,
        "http2": true,
        "trueClientIpHeader": true,
        "hsts": false
    },
    "headerPolicies": [{
        "type": "ORIGIN_REQUEST",
        "ruleName": "Modify Origin Reqeust Header",
        "header": {
            "type": "ADD",
            "name": "name",
            "value": "value"
        }
    }, {
        "type": "CLIENT_RESPONSE",
        "ruleName": "Modify Client Response Header",
        "header": {
            "type": "MODIFY",
            "name": "name",
            "value": "value"
        }
    }],
    "optimizationConfig": {
        "httpCompression": true,
        "largeFileOptimization": true
    },
    "accessControl": {
        "type": "WHITELIST",
        "ipPolicies": ["1.1.1.1", "2.2.2.2", "3.3.3.3"],
        "geoPolicies": ["AL", "SK", "ZM"],
        "refererPolicies": ["ncloud.com", "naver.com"]
    }
}

Response examples

{
    "code": "0000",
    "message": "Success",
    "result": {
        "edgeId": 123
    }
}

Errors