Akamai · Example Payload

Akamai Get Bulk Search Example

CDNCloudEdge ComputingNetworksPlatformSecurity

Akamai Get Bulk Search Example is an example object payload from Akamai, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

Raw ↑
{
  "operationId": "get-bulk-search",
  "method": "GET",
  "path": "/bulk/rules-search-requests/{bulkSearchId}",
  "summary": "Akamai List Bulk Search Results",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "bulkSearchId": 5,
        "searchSubmitDate": "2018-01-18T00:00:00Z",
        "searchTargetStatus": "COMPLETE",
        "searchUpdateDate": "2018-01-18T00:01:00Z",
        "bulkSearchQuery": {
          "match": "$..conditions[?(@.name == \"ext\" && \"mp3\" in @.options.value && \"mp4\" nin @.options.value)].options.value[?(@ == \"mp3\")]",
          "syntax": "JSONPATH",
          "bulkSearchQualifiers": [
            "$.options[?(@.secure==\"true\")]",
            "$..features[?(@.name==\"origin\")].options[?(@.hostname==\"old.origin.example.com\")]"
          ]
        },
        "results": [
          {
            "accountId": "act_A-CCT1234",
            "isLatest": true,
            "isLocked": true,
            "isSecure": true,
            "lastModifiedTime": "2018-01-18T00:00:00Z",
            "productionStatus": "INACTIVE",
            "propertyId": "prp_1",
            "propertyName": "example1.example.com",
            "propertyVersion": 1,
            "stagingStatus": "ACTIVE",
            "matchLocations": [
              "/rules/children/1/features/0",
              "/rules/children/1/features/3"
            ]
          },
          {
            "accountId": "act_A-CCT9012",
            "isLatest": false,
            "isLocked": false,
            "isSecure": true,
            "lastModifiedTime": "2018-01-18T00:00:00Z",
            "productionStatus": "INACTIVE",
            "propertyId": "prp_15",
            "propertyName": "example2.example.com",
            "propertyVersion": 2,
            "stagingStatus": "INACTIVE",
            "matchLocations": [
              "/rules/children/1/children/0/features/1"
            ]
          },
          {
            "accountId": "act_A-CCT3456",
            "isLatest": true,
            "isLocked": true,
            "isSecure": true,
            "lastModifiedTime": "2018-01-18T00:00:00Z",
            "productionStatus": "ACTIVE",
            "propertyId": "prp_3",
            "propertyName": "example3.example.com",
            "propertyVersion": 10,
            "stagingStatus": "INACTIVE",
            "matchLocations": [
              "/rules/children/0/children/1/children/2/features/1"
            ]
          }
        ]
      }
    },
    {
      "status": "400",
      "contentType": "application/problem+json",
      "example": {
        "detail": "The system cannot understand your request.  Please check the syntax and correct any problems.",
        "instance": "/papi/v1/properties?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7",
        "status": 400,
        "title": "Bad Request",
        "type": "https://problems.luna.akamaiapis.net/papi/v0/http/bad-request"
      }
    },
    {
      "status": "401",
      "contentType": "application/problem+json",
      "example": {
        "detail": "The request requires authentication.",
        "instance": "/papi/v1/properties?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7",
        "status": 401,
        "title": "Unauthorized",
        "type": "https://problems.luna.akamaiapis.net/papi/v0/http/unauthorized"
      }
    },
    {
      "status": "403",
      "contentType": "application/problem+json",
      "example": {
        "detail": "The authorization token you provided does not allow access to this resource.",
        "instance": "/papi/v1/properties?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7",
        "status": 403,
        "title": "Forbidden",
        "type": "https://problems.luna.akamaiapis.net/papi/v1/http/forbidden"
      }
    },
    {
      "status": "404",
      "contentType": "application/problem+json",
      "example": {
        "detail": "The system was unable to locate the requested resource.",
        "instance": "/papi/v1/properties?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7",
        "status": 404,
        "title": "Not Found",
        "type": "https://problems.luna.akamaiapis.net/papi/v1/http/not-found"
      }
    },
    {
      "status": "405",
      "contentType": "application/problem+json",
      "example": {
        "detail": "The system does not support the method you provided for this resource.",
        "instance": "/papi/v1/properties?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7",
        "status": 405,
        "title": "Method not allowed",
        "type": "https://problems.luna.akamaiapis.net/papi/v1/http/method-not-allowed"
      }
    },
    {
      "status": "406",
      "contentType": "application/problem+json",
      "example": {
        "detail": "The system does not support the content-type restrictions provided by your 'Accept' header.",
        "instance": "papi/v1/build#abc12345abcc02a7",
        "status": 406,
        "title": "Not Acceptable",
        "type": "https://problems.luna.akamaiapis.net/papi/v1/http/not-acceptable"
      }
    },
    {
      "status": "429",
      "contentType": "application/problem+json",
      "example": {
        "detail": "Too many includes exist on contract ctr_1-12345.  You must delete an include before continuing.",
        "instance": "/papi/v1/includes?contractId=ctr_C-0N7RAC7&groupId=grp_12345#abc12345abcc02a7",
        "instanceKey": "1-12345",
        "limit": 500,
        "limitKey": "INCLUDES_PER_CONTRACT",
        "remaining": 0,
        "status": 429,
        "title": "Too many includes",
        "type": "https://problems.luna.akamaiapis.net/papi/v1/limit-exceeded"
      }
    },
    {
      "status": "500",
      "contentType": "application/problem+json",
      "example": {
        "detail": "Our system is experiencing errors. We''ll get this fixed as soon as possible.",
        "instance": "/papi/v1/properties/12345/activations#abc12345abcc02a7",
        "status": 500,
        "title": "Internal Server Error",
        "type": "https://problems.luna.akamaiapis.net/papi/proxy/internal-server-error"
      }
    }
  ]
}