MENU
      Get purge request
        • PDF

        Get purge request

        • PDF

        Article summary

        Overview

        Get details about a purge job request.

        Request

        Request URL

        GET
        https://edge.apigw.ntruss.com/api/v1/purge/{purgeRequestId}
        Plain text

        Request parameters

        Parameter nameRequiredTypeRestrictionsDescription
        purgeRequestIdYesLongPurge request number

        Response

        All responses return success or failure as an HTTP status code.

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

        PurgeHistory

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

        PurgeResult

        ValueDescription
        READYPurge pending execution
        RUNNINGPurge running
        SUCCESSCompleted
        FAILUREPurge failed

        PurgeType

        ValueDescription
        ALLPurge all content
        DIRECTORYPer-directory purge
        PATTERNPurge content by extension
        URLPurge content specified by URL

        WorkerType

        ValueDescription
        ACCOUNTRequested with main account
        SUBACCOUNTRequested from a sub account

        Examples

        Request example

        https://edge.apigw.ntruss.com/api/v1/purge/9999
        Plain text

        Response example

        {
           "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"
        }
        JSON

        Errors

        Error codeDescription
        0032Unauthorized request
        0400Request 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.