Synchronously bulk search a set of properties or includes

post

https://{hostname}/papi/v1/bulk/rules-search-requests-synch

Provides an alternative to the asynchronous Bulk search a set of properties or includes operation. It yields completed bulk search results directly, but with possibly high latency, making it more appropriate to target for small-batch searches. POST a bulk search object to search across all active property or include versions, specifying a JSONPath expression to match their rule trees. After gathering 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. 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.

Query Params

contractId

string

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

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

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Body Params

A bulk search job. The request specifies JSONPath search queries, and the response includes JSON path locations within matching rule trees. Check the searchTargetStatus of potentially long-running asynchronous jobs for when they're COMPLETE. See Bulk Search and Update for guidance on how to use this object.

bulkSearchQuery

object

required

Specifies the set of bulk search criteria.

propertyType

string

enum

Specifies the type of the property, either TRADITIONAL, INCLUDE, or HOSTNAME_BUCKET.

Allowed:

Headers

PAPI-Use-Prefixes

string

enum

required

Enum Sets whether to represent ID prefixes in response data. Set to false when exchanging PAPI data with other APIs.

Allowed:

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

202This delayed response shows the completed bulk search job. Unlike the asynchronous Bulk search a set of properties or includes operation, this response's searchTargetStatus is always COMPLETE.

400Bad request.

401Unauthorized.

403Forbidden.

404Not found.

405Method not allowed.

406Not acceptable.

415Unsupported media type.

429Too many requests.

500Internal server error.