API

Search properties or includes

post
https://{hostname}/papi/v1/search/find-by-value

This operation searches includes by name, or properties either by name, hostname, or edge hostname for which they're currently active. Specify a search request object with a single query member. The response lists the matching set of currently active property or include versions, and also the latest version if inactive. Each of the response's versions features additional context for the property or include in which it appears, or the account, contract, or group under which it's deployed. Note that to perform more complex searches for content within a rule tree, run Bulk search a set of properties or includes instead.

Query Params
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 query to search currently active properties or includes. You can only include one query member in the POST request.

string

Search for property versions active on a specific edge hostname.

string

Search for property versions active on a specific hostname.

string

Search for includes by name.

string

Search for properties by name.

Headers
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

Updated 4 months ago

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json

Updated 4 months ago