Viewing purge request
    • PDF

    Viewing purge request

    • PDF

    Article summary

    Overview

    View details about a purge request.

    Requests

    Request URL

    GET
    https://edge.apigw.ntruss.com/api/v1/purge/{profileId}/{edgeId}/{purgeRequestId}
    

    Request parameter

    Parameter nameRequirement statusTypeRestrictionsDescription
    profileIdYesLongProfile number
    edgeIdYesLongEdge number
    purgeRequestIdYesLongPurge request number

    Response

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

    HTTP status codeCode messageDescription
    200SuccessSearch succeeded
    401UnauthorizedAuthentication failed
    500Internal Server ErrorServer error

    PurgeHistory

    ItemTypeDescription
    clientIpStringPurge requester IP
    purgeIdLongPurge request number
    instanceNoLongEdge contract number
    requestDateTimeZonedDateTimePurge request date and time (UTC)
    serviceDomainStringPurge target domain
    statusPurgeResultPurge progress
    targetDirectoryStringList of directories to purge (serialized with commas)
    targetFileListList<String>Purge target list
    targetFileListStringStringPurge target list (serialized with comma)
    purgeTypePurgeTypePurge type
    workerTypeWorkerTypePurge requester account type
    ticketIdStringPurge ticket ID

    PurgeResult

    ValueDescription
    READYPurge ready for run
    RUNNINGPurge running
    SUCCESSPurge success
    FAILUREPurge failed

    PurgeType

    ValueDescription
    ALLPurge all contents
    DIRECTORYPurge by directory
    PATTERNPurge content by extension
    URLPurge designated content with URL

    WorkerType

    ValueDescription
    ACCOUNTRequested from main account
    SUBACCOUNTRequested from sub account

    Examples

    Request examples

    https://edge.apigw.ntruss.com/api/v1/purge/111/222/9999
    

    Response examples

    {
       "clientIp":"127.0.0.1",
       "purgeId":9999,
       "instanceNo":999999,
       "requestDateTime":"2022-11-24T07:54:13Z",
       "serviceDomain":"sample.mycustomdomain.com",
       "status":"READY",
       "purgeType":"ALL",
       "workerType":"ACCOUNT",
       "ticketId":"PT-00000000000000000000"
    }
    

    Errors

    Error codeDescription
    0032Unauthorized request
    0400Requested data format mismatch
    9999Server error occurred

    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.