Search API
Data Search
Important
In addition to the read
permission, you will need the policies.list
, quotes.list
, or accounts.list
permission to be able to execute a search on the respective entity type.
POST /search/{tenantLocator}/search
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
offset | query | int? | optional |
count | query | int? | optional |
Request:SearchRequest
Response:SearchServiceResponse
Security Group:search  Permission:read
GET /search/{tenantLocator}/search
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
offset | query | int? | optional |
count | query | int? | optional |
searchToken | query | string | required |
Response:SearchServiceResponse
Security Group:search  Permission:read
SearchRequest
¶requiredsearchEntityType Enum unspecified | account | quote | policy | fnolsearchString stringsearchTerms SearchTermRequest[]
SearchTermRequest
¶requiredfieldName stringabsolute Enum none | required | excludedmatch Enum fuzzy | exact | startsWithsearchTerm string
SearchServiceResponse
¶requiredcount intoffset intsearchToken stringresults SearchResultResponse[]
SearchResultResponse
¶requiredaccountLocator stringsearchEntityLocator stringproductName stringscore numbersearchEntityType Enum unspecified | account | quote | policy | fnolhighlights string[]searchSummary map<string,object>