Bulk search a set of properties or includes
POST https://{{host}}/papi/v1/bulk/rules-search-requests
POST a bulk search object to search across all active property or include versions. Specify a JSONPath expression to match their rule trees. This operation launches an asynchronous process to gather search results. To check its progress, run the List bulk search results operation, whose link is available in the Location header or the bulkSearchLink member of this operation's response. After gathering completed results, you can create new property versions, bulk patch the rule trees, then activate them. See Bulk Search and Update for guidance on this feature. Run Synchronously bulk search a set of properties as an alternative to get completed search results directly. To perform simpler searches for an include's name or property's name or hostnames to which it applies, run the Search properties and includes operation instead.
Body
PARAM
| Key | Datatype | Required | Description |
contractId
|
string | (Optional) Optionally filters bulk searches to properties created under the specified contract. For bulk operations, you can specify `contractId` and `groupId` independently from each other. | |
groupId
|
string | (Optional) Optionally filters bulk searches to properties created under the specified group. For bulk operations, you can specify `contractId` and `groupId` independently from each other. | |
accountSwitchKey
|
string | (Optional) For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys). |
HEADERS
| Key | Datatype | Required | Description |
PAPI-Use-Prefixes
|
string | (Required) __Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to `false` when exchanging PAPI data with other APIs. | |
Content-Type
|
string | Curl curl -X POST 'https://host/papi/v1/bulk/rules-search-requests?contractId=&groupId=&accountSwitchKey=' -H 'PAPI-Use-Prefixes: PAPI-Use-Prefixes' -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{"bulkSearchQuery":{"bulkSearchQualifiers":["$.options[?(@.secure==\"true\")]","$..features[?(@.name==\"origin\")].options[?(@.hostname==\"old.origin.example.com\")]"],"match":"$..conditions[?(@.name == \"ext\" \u0026\u0026 \"mp3\" in @.options.value \u0026\u0026 \"mp4\" nin @.options.value)].options.value[?(@ == \"mp3\")]","syntax":"JSONPATH"}}' ENDPOINTS |