POST /blueprintactions/search

Search blueprint actions using request body with complex queries

Search blueprint actions using request body with complex queries
KeyTypeExampleDescription
productionoptionalboolean
true
Use production blueprint actions store
KeyTypeExampleDescription
authorizationrequiredstring
"Bearer access_token"
Access token
KeyTypeExampleDescription
_sourceoptionalstring
"example"
Fields to include/exclude in results
aggsoptionalobject
{}
Aggregations for analytics
booloptionalobject
{
  "filter": [
    {}
  ],
  "must": [
    {}
  ],
  "must_not": [
    {}
  ]
}
... and more
Boolean queries for complex logic
countoptionalboolean
false
Return only count instead of documents
existsoptionalobject
{
  "field": "description"
}
Check if field exists
fromoptionalinteger
0
Starting position for pagination
highlightoptionalobject
{}
Highlight matching text
include_hitsoptionalboolean
false
Include hit details in paginated results
matchoptionalobject
{
  "title": "blueprint automation"
}
Full-text match queries
rangeoptionalobject
{
  "created": {
    "gte": "2024-01-01",
    "lte": "2024-12-31"
  }
}
Range queries for dates, numbers
sizeoptionalinteger
10
Number of results to return
sortoptionalarray
[{"created":{"order":"desc"}}, ...]
Sort criteria
termoptionalobject
{
  "status.keyword": {
    "value": "active"
  }
}
Term queries for exact matches
termsoptionalobject
{
  "category.keyword": [
    "user",
    "admin"
  ]
}
Terms queries for multiple exact matches
wildcardoptionalobject
{
  "name.keyword": {
    "case_insensitive": true,
    "value": "user*"
  }
}
Wildcard pattern matching
{}
{
  "code": 401,
  "error": "INVALID_ACCESS_TOKEN"
}
StatusError CodeDescription
401INVALID_ACCESS_TOKENAuthentication required or invalid token
PermissionDescription
Bearer tokenAccess token required via Authorization header, x-authtoken, x-token, query param, or cookie
blueprintactions_viewRequired scope: blueprintactions_view

Back to Blueprint Actions Return to the Blueprint Actions category to view other endpoints All API Categories Browse all available API categories