Search properties or includes

POST https://{{host}}/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.

Request Params

KeyDatatypeRequiredDescription
accountSwitchKeystring(Optional) 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.

Request Body

{"propertyName"=>"www.example.com_pm"}

HEADERS

KeyDatatypeRequiredDescription
PAPI-Use-Prefixesstring(Required) Enum Sets whether to represent ID prefixes in response data. Set to false when exchanging PAPI data with other APIs.
Content-Typestring
Acceptstring

RESPONSES

status: OK

{"versions":{"items":[{"accountId":"act_A-CCT1234","assetId":"aid_10333526","contractId":"ctr_C-0N7RAC71","groupId":"grp_32145","productionStatus":"INACTIVE","propertyId":"prp_243865","propertyName":"fifi2","propertyVersion":6,"stagingStatus":"INACTIVE","updatedByUser":"jsmith","updatedDate":"2017-08-07T15:39:49Z"},{"accountId":"act_A-CCT7890","assetId":"aid_10333526","contractId":"ctr_K-0N7RAK7","groupId":"grp_12345","productionStatus":"ACTIVE","propertyId":"prp_243865","propertyName":"fifi2","propertyVersion":1,"stagingStatus":"INACTIVE","updatedByUser":"jsmith","updatedDate":"2015-06-27T20:37:16Z"}]}}