Skip to main content
API docs by Redocly

crul REST API (1.3.0)

Download OpenAPI specification:Download

API Support: hello@crul.com Terms of Service

About the API

The crul API allows for programatic access to core crul services and resources. This includes dispatching queries and results retrieval, as well as create, read, update, delete (CRUD) operations on core crul resources such as scheduled queries, credentials, domain policies, and more.

Authentication

Access to the crul API requires an API key, which can be created from the crul web application. See credentials for more. The API Key should be provided as a Authorization: crul {API KEY} header.

Examples

curl -X 'POST' \
  'http://localhost:1968/v1/sirp/query/runner/dispatch' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -H "Authorization: crul {token}" \
  -d '{ "query": "devices" }'

Query Processor (sirp)

Query processor and support

Restart service

Restarts the service.

Responses

Restart a specific service

Restarts the provided service.

path Parameters
type
required
string
Enum: "gonogo" "sirp" "secrets" "licorice" "workers" "jobs" "mentos" "screenshot" "krull" "almanac"

Responses

Retrieve service status

Status of the provided service.

path Parameters
service
required
string
Enum: "gonogo" "sirp" "secrets" "licorice" "workers" "jobs" "mentos" "screenshot" "krull" "almanac"

Responses

Retrieve all service statuses

Status of all services.

Responses

Retrieve all service license statuses

License status of all services.

Responses

Parse a query string

Parses a query string into a query plan.

query Parameters
parseOnly
boolean
Default: false
addFlags
boolean
Default: true
Request Body schema: application/json
query
required
string

The query string.

Responses

Request samples

Content type
application/json
{
  • "query": "string"
}

Retrieve all queries

Returns all queries.

Responses

Dispatch a query

Parses, validates and starts a query.

Request Body schema: application/json
query
required
string

The query string.

cleanup
boolean
summary
boolean
minutes
integer >= 0
ttl
integer >= 0
mode
string
Enum: "turbo" "comprehensive"
metadata
object

Responses

Request samples

Content type
application/json
{
  • "query": "string",
  • "cleanup": true,
  • "summary": true,
  • "minutes": 0,
  • "ttl": 0,
  • "mode": "turbo",
  • "metadata": { }
}

Dispatch a query and wait for completion

Parses, validates and dispatches a query. Will return once query is complete.

Request Body schema: application/json
query
required
string

The query string.

cleanup
boolean
summary
boolean
minutes
integer >= 0
ttl
integer >= 0
metadata
object

Responses

Request samples

Content type
application/json
{
  • "query": "string",
  • "cleanup": true,
  • "summary": true,
  • "minutes": 0,
  • "ttl": 0,
  • "metadata": { }
}

Retrieve a query

Returns a queries.

path Parameters
id
required
string <uuid>

The unique identifier for a stream. (A UUID specified by RFC4122).

Responses

Delete a query

Deletes the provided query.

path Parameters
id
required
string <uuid>

The unique identifier for a stream. (A UUID specified by RFC4122).

Responses

Retrieve query screenshots

Returns the screenshots associated with the provided query.

path Parameters
id
required
string <uuid>

The unique identifier for a stream. (A UUID specified by RFC4122).

Responses

Retrieve a query summary

Returns the summary of the provided query.

path Parameters
id
required
string <uuid>

The unique identifier for a stream. (A UUID specified by RFC4122).

Responses

Retrieve a query summary status

Returns the status of the provided query's summary.

path Parameters
id
required
string <uuid>

The unique identifier for a stream. (A UUID specified by RFC4122).

Responses

Cancel a query

Cancels the provided query.

path Parameters
id
required
string <uuid>

The unique identifier for a stream. (A UUID specified by RFC4122).

Responses

Retrieve a query status

Returns the status of the provided query.

path Parameters
id
required
string <uuid>

The unique identifier for a stream. (A UUID specified by RFC4122).

Responses

Retrieve all stages for a query

Returns all stages for provided query.

path Parameters
id
required
string <uuid>

The unique identifier for a stream. (A UUID specified by RFC4122).

Responses

Retrieve all commands for a query

Returns all commands for provided query.

path Parameters
id
required
string <uuid>

The unique identifier for a stream. (A UUID specified by RFC4122).

Responses

Retrieve a stage for a query

Returns the stage for provided query and stage.

path Parameters
id
required
string <uuid>

The unique identifier for a stream. (A UUID specified by RFC4122).

stage
required
string

Responses

Retrieve commands for a query stage

Returns all commands for provided query stage.

path Parameters
id
required
string <uuid>

The unique identifier for a stream. (A UUID specified by RFC4122).

stage
required
string

Responses

Retrieve results for a query stage

Returns results for provided query stage.

path Parameters
id
required
string <uuid>

The unique identifier for a stream. (A UUID specified by RFC4122).

stage
required
string

Responses

Retrieve query results

Retrieves the results of a completed query.

path Parameters
id
required
string <uuid>

The unique identifier for a stream. (A UUID specified by RFC4122).

query Parameters
mode
string
offset
integer
limit
integer
sort
boolean
sortKey
string
sortOrder
string

Responses

Browser Interaction (krull)

Browser cluster management and browser job execution

Restart service

Restarts the service.

Responses

List of devices

Devices and associated viewport properties that can be emulated.

Responses

System details

System health and active workers including error reporting.

Responses

Evaluate a JavaScript expression

Evaluate a JavaScript expression and return results.

Request Body schema: application/json
expression
required
string [ 1 .. 1048576 ] characters

A JavaScript expression to evaluate, NOTE: Functions must be in fat-arrow format.

jquery
boolean
Default: false

Import jQuery library. Passed to expression function in last argument (ie., (..args, { $ }) => {}). NOTE: When imported into a page it is NOT in the global window scope.

lodash
boolean
Default: false

Import lodash library. Passed to expression function in last argument (ie., (..args, { _ }) => {}). NOTE: When imported into a page it is NOT in the global window scope.

mathjs
boolean
Default: false

Import mathjs library. Passed to expression function in last argument (ie., (..args, { mathjs }) => {}). NOTE: When imported into a page it is NOT in the global window scope.

args
Array of strings or numbers or objects or arrays or booleans or null <= 100 items

Argument values to pass to an expression. Passed as leading argument or middle arguments if data is passed back to expression (ie., ([data], ...args, [options]) => {}).

Responses

Request samples

Content type
application/json
{
  • "expression": "string",
  • "jquery": false,
  • "lodash": false,
  • "mathjs": false,
  • "args": [
    ]
}

Capture all external requests

A summary of all external requests made from a url. NOTE: This is a slower operation as all requests are processed.

Request Body schema: application/json
url
required
string^https?://

A URL for a webpage.

expression
string [ 1 .. 1048576 ] characters

A JavaScript expression to evaluate, NOTE: Functions must be in fat-arrow format.

object

Cookie data to be set.

sessionStorage
object

sessionStorage data to be set.

localStorage
object

localStorage data to be set.

responseText
boolean
Default: false

Include the response text. NOTE: This can have performance implications.

session
boolean
Default: false

Capture the browser cookie, localStorage and sessionStorage object/values. Decorates the return value(s) with localStorage, sessionStorage and cookieStorage. NOTE: See cookieStorage, localStorage and sessionStorage for object serialization structure.

jquery
boolean
Default: false

Import jQuery library. Passed to expression function in last argument (ie., (..args, { $ }) => {}). NOTE: When imported into a page it is NOT in the global window scope.

lodash
boolean
Default: false

Import lodash library. Passed to expression function in last argument (ie., (..args, { _ }) => {}). NOTE: When imported into a page it is NOT in the global window scope.

mathjs
boolean
Default: false

Import mathjs library. Passed to expression function in last argument (ie., (..args, { mathjs }) => {}). NOTE: When imported into a page it is NOT in the global window scope.

args
Array of strings or numbers or objects or arrays or booleans or null <= 100 items

Argument values to pass to an expression. Passed as leading argument or middle arguments if data is passed back to expression (ie., ([data], ...args, [options]) => {}).

retry
number [ 0 .. 2 ]

The number of times to retry a failed browser transaction. NOTE: The total number of attempts is the sum of the first request plus the retry number (ie., retry of 2 will result in three attempts). Hey kid, three strikes you are out of here!

device
string
Default: "iPhone X"
Enum: "Desktop" "Blackberry PlayBook" "Blackberry PlayBook landscape" "BlackBerry Z30" "BlackBerry Z30 landscape" "Galaxy Note 3" "Galaxy Note 3 landscape" "Galaxy Note II" "Galaxy Note II landscape" "Galaxy S III" "Galaxy S III landscape" "Galaxy S5" "Galaxy S5 landscape" "Galaxy S8" "Galaxy S8 landscape" "Galaxy S9+" "Galaxy S9+ landscape" "Galaxy Tab S4" "Galaxy Tab S4 landscape" "iPad" "iPad landscape" "iPad (gen 6)" "iPad (gen 6) landscape" "iPad (gen 7)" "iPad (gen 7) landscape" "iPad Mini" "iPad Mini landscape" "iPad Pro" "iPad Pro landscape" "iPad Pro 11" "iPad Pro 11 landscape" "iPhone 4" "iPhone 4 landscape" "iPhone 5" "iPhone 5 landscape" "iPhone 6" "iPhone 6 landscape" "iPhone 6 Plus" "iPhone 6 Plus landscape" "iPhone 7" "iPhone 7 landscape" "iPhone 7 Plus" "iPhone 7 Plus landscape" "iPhone 8" "iPhone 8 landscape" "iPhone 8 Plus" "iPhone 8 Plus landscape" "iPhone SE" "iPhone SE landscape" "iPhone X" "iPhone X landscape" "iPhone XR" "iPhone XR landscape" "iPhone 11" "iPhone 11 landscape" "iPhone 11 Pro" "iPhone 11 Pro landscape" "iPhone 11 Pro Max" "iPhone 11 Pro Max landscape" "iPhone 12" "iPhone 12 landscape" "iPhone 12 Pro" "iPhone 12 Pro landscape" "iPhone 12 Pro Max" "iPhone 12 Pro Max landscape" "iPhone 12 Mini" "iPhone 12 Mini landscape" "iPhone 13" "iPhone 13 landscape" "iPhone 13 Pro" "iPhone 13 Pro landscape" "iPhone 13 Pro Max" "iPhone 13 Pro Max landscape" "iPhone 13 Mini" "iPhone 13 Mini landscape" "JioPhone 2" "JioPhone 2 landscape" "Kindle Fire HDX" "Kindle Fire HDX landscape" "LG Optimus L70" "LG Optimus L70 landscape" "Microsoft Lumia 550" "Microsoft Lumia 950" "Microsoft Lumia 950 landscape" "Nexus 10" "Nexus 10 landscape" "Nexus 4" "Nexus 4 landscape" "Nexus 5" "Nexus 5 landscape" "Nexus 5X" "Nexus 5X landscape" "Nexus 6" "Nexus 6 landscape" "Nexus 6P" "Nexus 6P landscape" "Nexus 7" "Nexus 7 landscape" "Nokia Lumia 520" "Nokia Lumia 520 landscape" "Nokia N9" "Nokia N9 landscape" "Pixel 2" "Pixel 2 landscape" "Pixel 2 XL" "Pixel 2 XL landscape" "Pixel 3" "Pixel 3 landscape" "Pixel 4" "Pixel 4 landscape" "Pixel 4a (5G)" "Pixel 4a (5G) landscape" "Pixel 5" "Pixel 5 landscape" "Moto G4" "Moto G4 landscape"

The device to emulate.

headers
object

HTTP headers to set before loading page.

string or integer or string or string

Wait criteria before resolving page load.

ready
string
Enum: "idle" "net2" "winload" "domload"

winload - consider navigation to be finished when the window load event is fired. domload - consider navigation to be finished when the DOMContentLoaded event is fired. idle - consider navigation to be finished when there are no more than 0 network connections for at least 500 ms. net2 - consider navigation to be finished when there are no more than 2 network connections for at least 500 ms.

visible
boolean

Wait for element to be present in DOM and to be visible, i.e. to not have display: none or visibility: hidden CSS properties. Defaults to false.

hidden
boolean

Wait for element to not be found in the DOM or to be hidden, i.e. have display: none or visibility: hidden CSS properties. Defaults to false.

integer or string

An interval at which the wait function/()=> is executed, defaults to raf. If polling is a number, then it is treated as an interval in milliseconds at which the function would be executed. If polling is a string, then it can be one of the following values: raf - to constantly execute function/()=> in requestAnimationFrame callback. This is the tightest polling mode which is suitable to observe styling changes. mutation - to execute function/()=> on every DOM mutation.

proxy
string

The URI for a http, https, socks(v5), socks5, socks4, or pac proxy.

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "expression": "string",
  • "cookieStorage": {
    },
  • "sessionStorage": { },
  • "localStorage": { },
  • "responseText": false,
  • "session": false,
  • "jquery": false,
  • "lodash": false,
  • "mathjs": false,
  • "args": [
    ],
  • "retry": 2,
  • "device": "Desktop",
  • "headers": { },
  • "wait": "idle",
  • "ready": "idle",
  • "visible": true,
  • "hidden": true,
  • "polling": 30000,
  • "proxy": "string"
}

Execute JavaScript within a page

The general swiss-army knife for execution of arbitrary JavaScript within a given url.

Request Body schema: application/json
url
required
string^https?://

A URL for a webpage.

expression
required
string [ 1 .. 1048576 ] characters

A JavaScript expression to evaluate, NOTE: Functions must be in fat-arrow format.

screenshot
boolean
Default: false

Take full page screenshot. NOTE: This can have performance implications.

session
boolean
Default: false

Capture the browser cookie, localStorage and sessionStorage object/values. Decorates the return value(s) with localStorage, sessionStorage and cookieStorage. NOTE: See cookieStorage, localStorage and sessionStorage for object serialization structure.

type
string
Default: "jpeg"
Enum: "png" "jpeg" "webp"

Specifies the image type.

quality
number [ 1 .. 100 ]
Default: 100

The quality of the image. NOTE: Only applicable to jpg images.

object

Cookie data to be set.

sessionStorage
object

sessionStorage data to be set.

localStorage
object

localStorage data to be set.

jquery
boolean
Default: false

Import jQuery library. Passed to expression function in last argument (ie., (..args, { $ }) => {}). NOTE: When imported into a page it is NOT in the global window scope.

lodash
boolean
Default: false

Import lodash library. Passed to expression function in last argument (ie., (..args, { _ }) => {}). NOTE: When imported into a page it is NOT in the global window scope.

mathjs
boolean
Default: false

Import mathjs library. Passed to expression function in last argument (ie., (..args, { mathjs }) => {}). NOTE: When imported into a page it is NOT in the global window scope.

args
Array of strings or numbers or objects or arrays or booleans or null <= 100 items

Argument values to pass to an expression. Passed as leading argument or middle arguments if data is passed back to expression (ie., ([data], ...args, [options]) => {}).

filter
Array of strings <= 1000 items

Hostname or path values to glob and block requests against (eg., *.doubleclick.net will block all requests to doubleclick.net). NOTE: Filtering rquests can result in longer page loads and execution time.

retry
number [ 0 .. 2 ]

The number of times to retry a failed browser transaction. NOTE: The total number of attempts is the sum of the first request plus the retry number (ie., retry of 2 will result in three attempts). Hey kid, three strikes you are out of here!

device
string
Default: "iPhone X"
Enum: "Desktop" "Blackberry PlayBook" "Blackberry PlayBook landscape" "BlackBerry Z30" "BlackBerry Z30 landscape" "Galaxy Note 3" "Galaxy Note 3 landscape" "Galaxy Note II" "Galaxy Note II landscape" "Galaxy S III" "Galaxy S III landscape" "Galaxy S5" "Galaxy S5 landscape" "Galaxy S8" "Galaxy S8 landscape" "Galaxy S9+" "Galaxy S9+ landscape" "Galaxy Tab S4" "Galaxy Tab S4 landscape" "iPad" "iPad landscape" "iPad (gen 6)" "iPad (gen 6) landscape" "iPad (gen 7)" "iPad (gen 7) landscape" "iPad Mini" "iPad Mini landscape" "iPad Pro" "iPad Pro landscape" "iPad Pro 11" "iPad Pro 11 landscape" "iPhone 4" "iPhone 4 landscape" "iPhone 5" "iPhone 5 landscape" "iPhone 6" "iPhone 6 landscape" "iPhone 6 Plus" "iPhone 6 Plus landscape" "iPhone 7" "iPhone 7 landscape" "iPhone 7 Plus" "iPhone 7 Plus landscape" "iPhone 8" "iPhone 8 landscape" "iPhone 8 Plus" "iPhone 8 Plus landscape" "iPhone SE" "iPhone SE landscape" "iPhone X" "iPhone X landscape" "iPhone XR" "iPhone XR landscape" "iPhone 11" "iPhone 11 landscape" "iPhone 11 Pro" "iPhone 11 Pro landscape" "iPhone 11 Pro Max" "iPhone 11 Pro Max landscape" "iPhone 12" "iPhone 12 landscape" "iPhone 12 Pro" "iPhone 12 Pro landscape" "iPhone 12 Pro Max" "iPhone 12 Pro Max landscape" "iPhone 12 Mini" "iPhone 12 Mini landscape" "iPhone 13" "iPhone 13 landscape" "iPhone 13 Pro" "iPhone 13 Pro landscape" "iPhone 13 Pro Max" "iPhone 13 Pro Max landscape" "iPhone 13 Mini" "iPhone 13 Mini landscape" "JioPhone 2" "JioPhone 2 landscape" "Kindle Fire HDX" "Kindle Fire HDX landscape" "LG Optimus L70" "LG Optimus L70 landscape" "Microsoft Lumia 550" "Microsoft Lumia 950" "Microsoft Lumia 950 landscape" "Nexus 10" "Nexus 10 landscape" "Nexus 4" "Nexus 4 landscape" "Nexus 5" "Nexus 5 landscape" "Nexus 5X" "Nexus 5X landscape" "Nexus 6" "Nexus 6 landscape" "Nexus 6P" "Nexus 6P landscape" "Nexus 7" "Nexus 7 landscape" "Nokia Lumia 520" "Nokia Lumia 520 landscape" "Nokia N9" "Nokia N9 landscape" "Pixel 2" "Pixel 2 landscape" "Pixel 2 XL" "Pixel 2 XL landscape" "Pixel 3" "Pixel 3 landscape" "Pixel 4" "Pixel 4 landscape" "Pixel 4a (5G)" "Pixel 4a (5G) landscape" "Pixel 5" "Pixel 5 landscape" "Moto G4" "Moto G4 landscape"

The device to emulate.

headers
object

HTTP headers to set before loading page.

string or integer or string or string

Wait criteria before resolving page load.

ready
string
Enum: "idle" "net2" "winload" "domload"

winload - consider navigation to be finished when the window load event is fired. domload - consider navigation to be finished when the DOMContentLoaded event is fired. idle - consider navigation to be finished when there are no more than 0 network connections for at least 500 ms. net2 - consider navigation to be finished when there are no more than 2 network connections for at least 500 ms.

visible
boolean

Wait for element to be present in DOM and to be visible, i.e. to not have display: none or visibility: hidden CSS properties. Defaults to false.

hidden
boolean

Wait for element to not be found in the DOM or to be hidden, i.e. have display: none or visibility: hidden CSS properties. Defaults to false.

integer or string

An interval at which the wait function/()=> is executed, defaults to raf. If polling is a number, then it is treated as an interval in milliseconds at which the function would be executed. If polling is a string, then it can be one of the following values: raf - to constantly execute function/()=> in requestAnimationFrame callback. This is the tightest polling mode which is suitable to observe styling changes. mutation - to execute function/()=> on every DOM mutation.

proxy
string

The URI for a http, https, socks(v5), socks5, socks4, or pac proxy.

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "expression": "string",
  • "screenshot": false,
  • "session": false,
  • "type": "png",
  • "quality": 100,
  • "cookieStorage": {
    },
  • "sessionStorage": { },
  • "localStorage": { },
  • "jquery": false,
  • "lodash": false,
  • "mathjs": false,
  • "args": [
    ],
  • "filter": [
    ],
  • "retry": 2,
  • "device": "Desktop",
  • "headers": { },
  • "wait": "idle",
  • "ready": "idle",
  • "visible": true,
  • "hidden": true,
  • "polling": 30000,
  • "proxy": "string"
}

Evaluate a CSS selector

Evaluate a CSS selector expression for a given url.

Request Body schema: application/json
url
required
string^https?://

A URL for a webpage.

selector
required
string [ 1 .. 1048576 ] characters

CSS selector expression.

screenshot
boolean
Default: false

Take full page screenshot. NOTE: This can have performance implications.

session
boolean
Default: false

Capture the browser cookie, localStorage and sessionStorage object/values. Decorates the return value(s) with localStorage, sessionStorage and cookieStorage. NOTE: See cookieStorage, localStorage and sessionStorage for object serialization structure.

type
string
Default: "jpeg"
Enum: "png" "jpeg" "webp"

Specifies the image type.

quality
number [ 1 .. 100 ]
Default: 100

The quality of the image. NOTE: Only applicable to jpg images.

engine
string
Enum: "dom" "jquery"

The selector engine to use. NOTE: dom uses querySelectorAll.

expression
string [ 1 .. 1048576 ] characters

A JavaScript expression to evaluate, NOTE: Functions must be in fat-arrow format.

object

Cookie data to be set.

sessionStorage
object

sessionStorage data to be set.

localStorage
object

localStorage data to be set.

jquery
boolean
Default: false

Import jQuery library. Passed to expression function in last argument (ie., (..args, { $ }) => {}). NOTE: When imported into a page it is NOT in the global window scope.

lodash
boolean
Default: false

Import lodash library. Passed to expression function in last argument (ie., (..args, { _ }) => {}). NOTE: When imported into a page it is NOT in the global window scope.

mathjs
boolean
Default: false

Import mathjs library. Passed to expression function in last argument (ie., (..args, { mathjs }) => {}). NOTE: When imported into a page it is NOT in the global window scope.

html
boolean
Default: true

Extract innerHTML and outerHTML. NOTE: This can have performance implications.

hashtml
boolean
Default: false

Extract innerHTML and outerHTML sha1 hash of respective values. NOTE: This can have performance implications.

dimension
boolean
Default: true

Extract DOM position attributes. NOTE: This can have performance implications due to repaints.

args
Array of strings or numbers or objects or arrays or booleans or null <= 100 items

Argument values to pass to an expression. Passed as leading argument or middle arguments if data is passed back to expression (ie., ([data], ...args, [options]) => {}).

retry
number [ 0 .. 2 ]

The number of times to retry a failed browser transaction. NOTE: The total number of attempts is the sum of the first request plus the retry number (ie., retry of 2 will result in three attempts). Hey kid, three strikes you are out of here!

device
string
Default: "iPhone X"
Enum: "Desktop" "Blackberry PlayBook" "Blackberry PlayBook landscape" "BlackBerry Z30" "BlackBerry Z30 landscape" "Galaxy Note 3" "Galaxy Note 3 landscape" "Galaxy Note II" "Galaxy Note II landscape" "Galaxy S III" "Galaxy S III landscape" "Galaxy S5" "Galaxy S5 landscape" "Galaxy S8" "Galaxy S8 landscape" "Galaxy S9+" "Galaxy S9+ landscape" "Galaxy Tab S4" "Galaxy Tab S4 landscape" "iPad" "iPad landscape" "iPad (gen 6)" "iPad (gen 6) landscape" "iPad (gen 7)" "iPad (gen 7) landscape" "iPad Mini" "iPad Mini landscape" "iPad Pro" "iPad Pro landscape" "iPad Pro 11" "iPad Pro 11 landscape" "iPhone 4" "iPhone 4 landscape" "iPhone 5" "iPhone 5 landscape" "iPhone 6" "iPhone 6 landscape" "iPhone 6 Plus" "iPhone 6 Plus landscape" "iPhone 7" "iPhone 7 landscape" "iPhone 7 Plus" "iPhone 7 Plus landscape" "iPhone 8" "iPhone 8 landscape" "iPhone 8 Plus" "iPhone 8 Plus landscape" "iPhone SE" "iPhone SE landscape" "iPhone X" "iPhone X landscape" "iPhone XR" "iPhone XR landscape" "iPhone 11" "iPhone 11 landscape" "iPhone 11 Pro" "iPhone 11 Pro landscape" "iPhone 11 Pro Max" "iPhone 11 Pro Max landscape" "iPhone 12" "iPhone 12 landscape" "iPhone 12 Pro" "iPhone 12 Pro landscape" "iPhone 12 Pro Max" "iPhone 12 Pro Max landscape" "iPhone 12 Mini" "iPhone 12 Mini landscape" "iPhone 13" "iPhone 13 landscape" "iPhone 13 Pro" "iPhone 13 Pro landscape" "iPhone 13 Pro Max" "iPhone 13 Pro Max landscape" "iPhone 13 Mini" "iPhone 13 Mini landscape" "JioPhone 2" "JioPhone 2 landscape" "Kindle Fire HDX" "Kindle Fire HDX landscape" "LG Optimus L70" "LG Optimus L70 landscape" "Microsoft Lumia 550" "Microsoft Lumia 950" "Microsoft Lumia 950 landscape" "Nexus 10" "Nexus 10 landscape" "Nexus 4" "Nexus 4 landscape" "Nexus 5" "Nexus 5 landscape" "Nexus 5X" "Nexus 5X landscape" "Nexus 6" "Nexus 6 landscape" "Nexus 6P" "Nexus 6P landscape" "Nexus 7" "Nexus 7 landscape" "Nokia Lumia 520" "Nokia Lumia 520 landscape" "Nokia N9" "Nokia N9 landscape" "Pixel 2" "Pixel 2 landscape" "Pixel 2 XL" "Pixel 2 XL landscape" "Pixel 3" "Pixel 3 landscape" "Pixel 4" "Pixel 4 landscape" "Pixel 4a (5G)" "Pixel 4a (5G) landscape" "Pixel 5" "Pixel 5 landscape" "Moto G4" "Moto G4 landscape"

The device to emulate.

headers
object

HTTP headers to set before loading page.

string or integer or string or string

Wait criteria before resolving page load.

ready
string
Enum: "idle" "net2" "winload" "domload"

winload - consider navigation to be finished when the window load event is fired. domload - consider navigation to be finished when the DOMContentLoaded event is fired. idle - consider navigation to be finished when there are no more than 0 network connections for at least 500 ms. net2 - consider navigation to be finished when there are no more than 2 network connections for at least 500 ms.

visible
boolean

Wait for element to be present in DOM and to be visible, i.e. to not have display: none or visibility: hidden CSS properties. Defaults to false.

hidden
boolean

Wait for element to not be found in the DOM or to be hidden, i.e. have display: none or visibility: hidden CSS properties. Defaults to false.

integer or string

An interval at which the wait function/()=> is executed, defaults to raf. If polling is a number, then it is treated as an interval in milliseconds at which the function would be executed. If polling is a string, then it can be one of the following values: raf - to constantly execute function/()=> in requestAnimationFrame callback. This is the tightest polling mode which is suitable to observe styling changes. mutation - to execute function/()=> on every DOM mutation.

proxy
string

The URI for a http, https, socks(v5), socks5, socks4, or pac proxy.

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "selector": "string",
  • "screenshot": false,
  • "session": false,
  • "type": "png",
  • "quality": 100,
  • "engine": "dom",
  • "expression": "string",
  • "cookieStorage": {
    },
  • "sessionStorage": { },
  • "localStorage": { },
  • "jquery": false,
  • "lodash": false,
  • "mathjs": false,
  • "html": true,
  • "hashtml": false,
  • "dimension": true,
  • "args": [
    ],
  • "retry": 2,
  • "device": "Desktop",
  • "headers": { },
  • "wait": "idle",
  • "ready": "idle",
  • "visible": true,
  • "hidden": true,
  • "polling": 30000,
  • "proxy": "string"
}

Navigate and capture a page session

Capture Cookie, localStorage and sessionStorage from page navigate lifecyle (load page, do something, load new page).

Request Body schema: application/json
url
required
string^https?://

A URL for a webpage.

expression
required
Array of strings or string [ 1 .. 1048576 ] characters <= 100 items

A JavaScript expression to evaluate, NOTE: Functions must be in fat-arrow format.

object

Cookie data to be set.

sessionStorage
object

sessionStorage data to be set.

localStorage
object

localStorage data to be set.

jquery
boolean
Default: false

Import jQuery library. Passed to expression function in last argument (ie., (..args, { $ }) => {}). NOTE: When imported into a page it is NOT in the global window scope.

lodash
boolean
Default: false

Import lodash library. Passed to expression function in last argument (ie., (..args, { _ }) => {}). NOTE: When imported into a page it is NOT in the global window scope.

mathjs
boolean
Default: false

Import mathjs library. Passed to expression function in last argument (ie., (..args, { mathjs }) => {}). NOTE: When imported into a page it is NOT in the global window scope.

args
Array of strings or numbers or objects or arrays or booleans or null <= 100 items

Argument values to pass to an expression. Passed as leading argument or middle arguments if data is passed back to expression (ie., ([data], ...args, [options]) => {}).

retry
number [ 0 .. 2 ]

The number of times to retry a failed browser transaction. NOTE: The total number of attempts is the sum of the first request plus the retry number (ie., retry of 2 will result in three attempts). Hey kid, three strikes you are out of here!

device
string
Default: "iPhone X"
Enum: "Desktop" "Blackberry PlayBook" "Blackberry PlayBook landscape" "BlackBerry Z30" "BlackBerry Z30 landscape" "Galaxy Note 3" "Galaxy Note 3 landscape" "Galaxy Note II" "Galaxy Note II landscape" "Galaxy S III" "Galaxy S III landscape" "Galaxy S5" "Galaxy S5 landscape" "Galaxy S8" "Galaxy S8 landscape" "Galaxy S9+" "Galaxy S9+ landscape" "Galaxy Tab S4" "Galaxy Tab S4 landscape" "iPad" "iPad landscape" "iPad (gen 6)" "iPad (gen 6) landscape" "iPad (gen 7)" "iPad (gen 7) landscape" "iPad Mini" "iPad Mini landscape" "iPad Pro" "iPad Pro landscape" "iPad Pro 11" "iPad Pro 11 landscape" "iPhone 4" "iPhone 4 landscape" "iPhone 5" "iPhone 5 landscape" "iPhone 6" "iPhone 6 landscape" "iPhone 6 Plus" "iPhone 6 Plus landscape" "iPhone 7" "iPhone 7 landscape" "iPhone 7 Plus" "iPhone 7 Plus landscape" "iPhone 8" "iPhone 8 landscape" "iPhone 8 Plus" "iPhone 8 Plus landscape" "iPhone SE" "iPhone SE landscape" "iPhone X" "iPhone X landscape" "iPhone XR" "iPhone XR landscape" "iPhone 11" "iPhone 11 landscape" "iPhone 11 Pro" "iPhone 11 Pro landscape" "iPhone 11 Pro Max" "iPhone 11 Pro Max landscape" "iPhone 12" "iPhone 12 landscape" "iPhone 12 Pro" "iPhone 12 Pro landscape" "iPhone 12 Pro Max" "iPhone 12 Pro Max landscape" "iPhone 12 Mini" "iPhone 12 Mini landscape" "iPhone 13" "iPhone 13 landscape" "iPhone 13 Pro" "iPhone 13 Pro landscape" "iPhone 13 Pro Max" "iPhone 13 Pro Max landscape" "iPhone 13 Mini" "iPhone 13 Mini landscape" "JioPhone 2" "JioPhone 2 landscape" "Kindle Fire HDX" "Kindle Fire HDX landscape" "LG Optimus L70" "LG Optimus L70 landscape" "Microsoft Lumia 550" "Microsoft Lumia 950" "Microsoft Lumia 950 landscape" "Nexus 10" "Nexus 10 landscape" "Nexus 4" "Nexus 4 landscape" "Nexus 5" "Nexus 5 landscape" "Nexus 5X" "Nexus 5X landscape" "Nexus 6" "Nexus 6 landscape" "Nexus 6P" "Nexus 6P landscape" "Nexus 7" "Nexus 7 landscape" "Nokia Lumia 520" "Nokia Lumia 520 landscape" "Nokia N9" "Nokia N9 landscape" "Pixel 2" "Pixel 2 landscape" "Pixel 2 XL" "Pixel 2 XL landscape" "Pixel 3" "Pixel 3 landscape" "Pixel 4" "Pixel 4 landscape" "Pixel 4a (5G)" "Pixel 4a (5G) landscape" "Pixel 5" "Pixel 5 landscape" "Moto G4" "Moto G4 landscape"

The device to emulate.

headers
object

HTTP headers to set before loading page.

string or integer or string or string

Wait criteria before resolving page load.

ready
string
Enum: "idle" "net2" "winload" "domload"

winload - consider navigation to be finished when the window load event is fired. domload - consider navigation to be finished when the DOMContentLoaded event is fired. idle - consider navigation to be finished when there are no more than 0 network connections for at least 500 ms. net2 - consider navigation to be finished when there are no more than 2 network connections for at least 500 ms.

visible
boolean

Wait for element to be present in DOM and to be visible, i.e. to not have display: none or visibility: hidden CSS properties. Defaults to false.

hidden
boolean

Wait for element to not be found in the DOM or to be hidden, i.e. have display: none or visibility: hidden CSS properties. Defaults to false.

integer or string

An interval at which the wait function/()=> is executed, defaults to raf. If polling is a number, then it is treated as an interval in milliseconds at which the function would be executed. If polling is a string, then it can be one of the following values: raf - to constantly execute function/()=> in requestAnimationFrame callback. This is the tightest polling mode which is suitable to observe styling changes. mutation - to execute function/()=> on every DOM mutation.

proxy
string

The URI for a http, https, socks(v5), socks5, socks4, or pac proxy.

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "expression": "string",
  • "cookieStorage": {
    },
  • "sessionStorage": { },
  • "localStorage": { },
  • "jquery": false,
  • "lodash": false,
  • "mathjs": false,
  • "args": [
    ],
  • "retry": 2,
  • "device": "Desktop",
  • "headers": { },
  • "wait": "idle",
  • "ready": "idle",
  • "visible": true,
  • "hidden": true,
  • "polling": 30000,
  • "proxy": "string"
}

Capture a screenshot

Capture a screenshot of the first matched element based on a specified css selector.

Request Body schema: application/json
url
required
string^https?://

A URL for a webpage.

selector
string [ 1 .. 1048576 ] characters

CSS selector expression.

type
string
Default: "jpeg"
Enum: "png" "jpeg" "webp"

Specifies the image type.

viewportWidth
number [ 1 .. 10000 ]

The rectangular area that is currently being viewed.

viewportHeight
number [ 1 .. 10000 ]

The rectangular area that is currently being viewed.

quality
number [ 1 .. 100 ]
Default: 100

The quality of the image. NOTE: Only applicable to jpg images.

background
string

Set the body background css style during image rasterization. For transparancy set value to transparent

engine
string
Enum: "dom" "jquery"

The selector engine to use. NOTE: dom uses querySelectorAll.

expression
string [ 1 .. 1048576 ] characters

A JavaScript expression to evaluate, NOTE: Functions must be in fat-arrow format.

object

Cookie data to be set.

sessionStorage
object

sessionStorage data to be set.

localStorage
object

localStorage data to be set.

session
boolean
Default: false

Capture the browser cookie, localStorage and sessionStorage object/values. Decorates the return value(s) with localStorage, sessionStorage and cookieStorage. NOTE: See cookieStorage, localStorage and sessionStorage for object serialization structure.

jquery
boolean
Default: false

Import jQuery library. Passed to expression function in last argument (ie., (..args, { $ }) => {}). NOTE: When imported into a page it is NOT in the global window scope.

lodash
boolean
Default: false

Import lodash library. Passed to expression function in last argument (ie., (..args, { _ }) => {}). NOTE: When imported into a page it is NOT in the global window scope.

mathjs
boolean
Default: false

Import mathjs library. Passed to expression function in last argument (ie., (..args, { mathjs }) => {}). NOTE: When imported into a page it is NOT in the global window scope.

args
Array of strings or numbers or objects or arrays or booleans or null <= 100 items

Argument values to pass to an expression. Passed as leading argument or middle arguments if data is passed back to expression (ie., ([data], ...args, [options]) => {}).

retry
number [ 0 .. 2 ]

The number of times to retry a failed browser transaction. NOTE: The total number of attempts is the sum of the first request plus the retry number (ie., retry of 2 will result in three attempts). Hey kid, three strikes you are out of here!

device
string
Default: "iPhone X"
Enum: "Desktop" "Blackberry PlayBook" "Blackberry PlayBook landscape" "BlackBerry Z30" "BlackBerry Z30 landscape" "Galaxy Note 3" "Galaxy Note 3 landscape" "Galaxy Note II" "Galaxy Note II landscape" "Galaxy S III" "Galaxy S III landscape" "Galaxy S5" "Galaxy S5 landscape" "Galaxy S8" "Galaxy S8 landscape" "Galaxy S9+" "Galaxy S9+ landscape" "Galaxy Tab S4" "Galaxy Tab S4 landscape" "iPad" "iPad landscape" "iPad (gen 6)" "iPad (gen 6) landscape" "iPad (gen 7)" "iPad (gen 7) landscape" "iPad Mini" "iPad Mini landscape" "iPad Pro" "iPad Pro landscape" "iPad Pro 11" "iPad Pro 11 landscape" "iPhone 4" "iPhone 4 landscape" "iPhone 5" "iPhone 5 landscape" "iPhone 6" "iPhone 6 landscape" "iPhone 6 Plus" "iPhone 6 Plus landscape" "iPhone 7" "iPhone 7 landscape" "iPhone 7 Plus" "iPhone 7 Plus landscape" "iPhone 8" "iPhone 8 landscape" "iPhone 8 Plus" "iPhone 8 Plus landscape" "iPhone SE" "iPhone SE landscape" "iPhone X" "iPhone X landscape" "iPhone XR" "iPhone XR landscape" "iPhone 11" "iPhone 11 landscape" "iPhone 11 Pro" "iPhone 11 Pro landscape" "iPhone 11 Pro Max" "iPhone 11 Pro Max landscape" "iPhone 12" "iPhone 12 landscape" "iPhone 12 Pro" "iPhone 12 Pro landscape" "iPhone 12 Pro Max" "iPhone 12 Pro Max landscape" "iPhone 12 Mini" "iPhone 12 Mini landscape" "iPhone 13" "iPhone 13 landscape" "iPhone 13 Pro" "iPhone 13 Pro landscape" "iPhone 13 Pro Max" "iPhone 13 Pro Max landscape" "iPhone 13 Mini" "iPhone 13 Mini landscape" "JioPhone 2" "JioPhone 2 landscape" "Kindle Fire HDX" "Kindle Fire HDX landscape" "LG Optimus L70" "LG Optimus L70 landscape" "Microsoft Lumia 550" "Microsoft Lumia 950" "Microsoft Lumia 950 landscape" "Nexus 10" "Nexus 10 landscape" "Nexus 4" "Nexus 4 landscape" "Nexus 5" "Nexus 5 landscape" "Nexus 5X" "Nexus 5X landscape" "Nexus 6" "Nexus 6 landscape" "Nexus 6P" "Nexus 6P landscape" "Nexus 7" "Nexus 7 landscape" "Nokia Lumia 520" "Nokia Lumia 520 landscape" "Nokia N9" "Nokia N9 landscape" "Pixel 2" "Pixel 2 landscape" "Pixel 2 XL" "Pixel 2 XL landscape" "Pixel 3" "Pixel 3 landscape" "Pixel 4" "Pixel 4 landscape" "Pixel 4a (5G)" "Pixel 4a (5G) landscape" "Pixel 5" "Pixel 5 landscape" "Moto G4" "Moto G4 landscape"

The device to emulate.

headers
object

HTTP headers to set before loading page.

string or integer or string or string

Wait criteria before resolving page load.

ready
string
Enum: "idle" "net2" "winload" "domload"

winload - consider navigation to be finished when the window load event is fired. domload - consider navigation to be finished when the DOMContentLoaded event is fired. idle - consider navigation to be finished when there are no more than 0 network connections for at least 500 ms. net2 - consider navigation to be finished when there are no more than 2 network connections for at least 500 ms.

visible
boolean

Wait for element to be present in DOM and to be visible, i.e. to not have display: none or visibility: hidden CSS properties. Defaults to false.

hidden
boolean

Wait for element to not be found in the DOM or to be hidden, i.e. have display: none or visibility: hidden CSS properties. Defaults to false.

integer or string

An interval at which the wait function/()=> is executed, defaults to raf. If polling is a number, then it is treated as an interval in milliseconds at which the function would be executed. If polling is a string, then it can be one of the following values: raf - to constantly execute function/()=> in requestAnimationFrame callback. This is the tightest polling mode which is suitable to observe styling changes. mutation - to execute function/()=> on every DOM mutation.

proxy
string

The URI for a http, https, socks(v5), socks5, socks4, or pac proxy.

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "selector": "string",
  • "type": "png",
  • "viewportWidth": 1,
  • "viewportHeight": 1,
  • "quality": 100,
  • "background": "string",
  • "engine": "dom",
  • "expression": "string",
  • "cookieStorage": {
    },
  • "sessionStorage": { },
  • "localStorage": { },
  • "session": false,
  • "jquery": false,
  • "lodash": false,
  • "mathjs": false,
  • "args": [
    ],
  • "retry": 2,
  • "device": "Desktop",
  • "headers": { },
  • "wait": "idle",
  • "ready": "idle",
  • "visible": true,
  • "hidden": true,
  • "polling": 30000,
  • "proxy": "string"
}

Populate and submit a form

Populate a form based on selector/value pairs and invoke a click submit button based on a selector and capture cookieStorage, localStorage, and sessionStorage.

Request Body schema: application/json
url
required
string^https?://

A URL for a webpage.

required
Array of items non-empty [ items = 2 items ]

An array of css selector/value pairs for input elements

submitSelector
required
string [ 1 .. 1048576 ] characters

CSS selector expression.

string or integer or string or string

Wait criteria before resolving page load.

ready
string
Enum: "idle" "net2" "winload" "domload"

winload - consider navigation to be finished when the window load event is fired. domload - consider navigation to be finished when the DOMContentLoaded event is fired. idle - consider navigation to be finished when there are no more than 0 network connections for at least 500 ms. net2 - consider navigation to be finished when there are no more than 2 network connections for at least 500 ms.

visible
boolean

Wait for element to be present in DOM and to be visible, i.e. to not have display: none or visibility: hidden CSS properties. Defaults to false.

hidden
boolean

Wait for element to not be found in the DOM or to be hidden, i.e. have display: none or visibility: hidden CSS properties. Defaults to false.

integer or string

An interval at which the wait function/()=> is executed, defaults to raf. If polling is a number, then it is treated as an interval in milliseconds at which the function would be executed. If polling is a string, then it can be one of the following values: raf - to constantly execute function/()=> in requestAnimationFrame callback. This is the tightest polling mode which is suitable to observe styling changes. mutation - to execute function/()=> on every DOM mutation.

proxy
string

The URI for a http, https, socks(v5), socks5, socks4, or pac proxy.

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "selectorValuePairs": [
    ],
  • "submitSelector": "string",
  • "wait": "idle",
  • "ready": "idle",
  • "visible": true,
  • "hidden": true,
  • "polling": 30000,
  • "proxy": "string"
}

Capture a screenshot from a selector

Capture an image binary stream of the first matched element based on a specified css selector.

query Parameters
url
required
string^https?://

A URL for a webpage.

selector
string [ 1 .. 1048576 ] characters

CSS selector expression.

viewportWidth
number [ 1 .. 10000 ]

The rectangular area that is currently being viewed.

viewportHeight
number [ 1 .. 10000 ]

The rectangular area that is currently being viewed.

quality
number [ 1 .. 100 ]
Default: 100

The quality of the image. NOTE: Only applicable to jpg images.

background
string

Set the body background css style during image rasterization. For transparancy set value to transparent

engine
string
Enum: "dom" "jquery"

The selector engine to use. NOTE: dom uses querySelectorAll.

device
string
Default: "iPhone X"
Enum: "Desktop" "Blackberry PlayBook" "Blackberry PlayBook landscape" "BlackBerry Z30" "BlackBerry Z30 landscape" "Galaxy Note 3" "Galaxy Note 3 landscape" "Galaxy Note II" "Galaxy Note II landscape" "Galaxy S III" "Galaxy S III landscape" "Galaxy S5" "Galaxy S5 landscape" "Galaxy S8" "Galaxy S8 landscape" "Galaxy S9+" "Galaxy S9+ landscape" "Galaxy Tab S4" "Galaxy Tab S4 landscape" "iPad" "iPad landscape" "iPad (gen 6)" "iPad (gen 6) landscape" "iPad (gen 7)" "iPad (gen 7) landscape" "iPad Mini" "iPad Mini landscape" "iPad Pro" "iPad Pro landscape" "iPad Pro 11" "iPad Pro 11 landscape" "iPhone 4" "iPhone 4 landscape" "iPhone 5" "iPhone 5 landscape" "iPhone 6" "iPhone 6 landscape" "iPhone 6 Plus" "iPhone 6 Plus landscape" "iPhone 7" "iPhone 7 landscape" "iPhone 7 Plus" "iPhone 7 Plus landscape" "iPhone 8" "iPhone 8 landscape" "iPhone 8 Plus" "iPhone 8 Plus landscape" "iPhone SE" "iPhone SE landscape" "iPhone X" "iPhone X landscape" "iPhone XR" "iPhone XR landscape" "iPhone 11" "iPhone 11 landscape" "iPhone 11 Pro" "iPhone 11 Pro landscape" "iPhone 11 Pro Max" "iPhone 11 Pro Max landscape" "iPhone 12" "iPhone 12 landscape" "iPhone 12 Pro" "iPhone 12 Pro landscape" "iPhone 12 Pro Max" "iPhone 12 Pro Max landscape" "iPhone 12 Mini" "iPhone 12 Mini landscape" "iPhone 13" "iPhone 13 landscape" "iPhone 13 Pro" "iPhone 13 Pro landscape" "iPhone 13 Pro Max" "iPhone 13 Pro Max landscape" "iPhone 13 Mini" "iPhone 13 Mini landscape" "JioPhone 2" "JioPhone 2 landscape" "Kindle Fire HDX" "Kindle Fire HDX landscape" "LG Optimus L70" "LG Optimus L70 landscape" "Microsoft Lumia 550" "Microsoft Lumia 950" "Microsoft Lumia 950 landscape" "Nexus 10" "Nexus 10 landscape" "Nexus 4" "Nexus 4 landscape" "Nexus 5" "Nexus 5 landscape" "Nexus 5X" "Nexus 5X landscape" "Nexus 6" "Nexus 6 landscape" "Nexus 6P" "Nexus 6P landscape" "Nexus 7" "Nexus 7 landscape" "Nokia Lumia 520" "Nokia Lumia 520 landscape" "Nokia N9" "Nokia N9 landscape" "Pixel 2" "Pixel 2 landscape" "Pixel 2 XL" "Pixel 2 XL landscape" "Pixel 3" "Pixel 3 landscape" "Pixel 4" "Pixel 4 landscape" "Pixel 4a (5G)" "Pixel 4a (5G) landscape" "Pixel 5" "Pixel 5 landscape" "Moto G4" "Moto G4 landscape"

The device to emulate.

Responses

Screenshots Manager (screenshot)

Screenshot management

Restart the service

Restarts the service.

Responses

Retrieve a screenshot

Retrieves a screenshot matching the specified hash.

path Parameters
hash
required
string = 64 characters

A hash value used for lookup of the image.

Responses

Domain Policy Manager (gonogo)

Domain policy management and enforcement

Retrieve environment variables

Returns service environment variables.

Responses

Restart service

Restarts the service.

Responses

Enforce a domain policy

Checks if a domain can be accessed.

path Parameters
domain
required
string [ 1 .. 1000 ] characters

The policy domain reference.

id
required
string <uuid>

The unique identifier for my object. (A UUID specified by RFC4122).

Responses

Check a domain policy

Checks if a domain can be accessed based on the domain and a domain dispatches history.

path Parameters
domain
required
string [ 1 .. 1000 ] characters

The policy domain reference.

Request Body schema: application/json
domainDispatches
required
Array of arrays
Default: []

Responses

Request samples

Content type
application/json
{
  • "domainDispatches": [ ]
}

Retrieve all domain policies

Returns all domain policies.

Responses

Create a domain policy

Creates a new domain policy.

Request Body schema: application/json
name
required
string [ 1 .. 1000 ] characters

The policy name/label reference.

domain
required
string [ 1 .. 1000 ] characters

The policy domain reference.

required
object

Policy for number of dispatches allowed to this domain (per second, per ten seconds, and per minute)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "domain": "string",
  • "policy": {
    }
}

Retrieve a domain policy

Retrieves the provided domain policy.

path Parameters
id
required
string <uuid>

The unique identifier for my object. (A UUID specified by RFC4122).

Responses

Update a domain policy

Updates the provided domain policy.

path Parameters
id
required
string <uuid>

The unique identifier for my object. (A UUID specified by RFC4122).

Request Body schema: application/json
name
required
string [ 1 .. 1000 ] characters

The policy name/label reference.

domain
required
string [ 1 .. 1000 ] characters

The policy domain reference.

required
object

Policy for number of dispatches allowed to this domain (per second, per ten seconds, and per minute)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "domain": "string",
  • "policy": {
    }
}

Delete a domain policy

Deletes the provided domain policy.

path Parameters
id
required
string <uuid>

The unique identifier for my object. (A UUID specified by RFC4122).

Responses

Cellar File Manager (sirp)

Manages files in the cellar

Export a cellar file

Export an uploaded file.

path Parameters
name
required
string [ 1 .. 1000 ] characters ^[A-Za-z0-9-_. ]+$

The file name.

mode
required
string
Enum: "csv" "ndjson"

The file export mode.

Responses

Retrieve all cellar files

List all uploaded files.

Responses

Upload a cellar file

Upload and store a new file.

Request Body schema: application/json
required
object
value
string [ 1 .. 1000 ] characters ^[A-Za-z0-9-_. ]+$

The file name.

Responses

Request samples

Content type
application/json
{
  • "name": {
    }
}

Retrieve a cellar file

Retrieve an uploaded file.

path Parameters
name
required
string [ 1 .. 1000 ] characters ^[A-Za-z0-9-_. ]+$

The file name.

Responses

Delete a cellar file

Delete an uploaded file.

path Parameters
name
required
string [ 1 .. 1000 ] characters ^[A-Za-z0-9-_. ]+$

The file name.

Responses

Retrieve all cellar manifests

Retrieve all cellar manifests.

Responses

Add a cellar manifest

Add a cellar manifest for stored content.

Request Body schema: application/json
name
required
string [ 1 .. 1000 ] characters ^[A-Za-z0-9-_. ]+$

The file name.

store
required
string [ 1 .. 1000 ] characters ^[A-Za-z0-9-_. ]+$

The store name.

type
required
string
Enum: "file" "gcpGCS" "awsS3" "azureBlob" "kafka" "splunk" "cribl" "influxdb" "elasticsearch" "gcpPubSub" "gcpBigQuery" "awsKinesis" "http" "awsKinesisFirehose" "awsDynamoDB" "awsSQS" "awsSNS" "azureTable" "azureQueue" "cassandra" "redisPubSub" "sftp" "nats" "pulsar" "mqtt" "sql" "localFile" "timeplus" "graphistry" "snowflake"

The store type.

screenshots
Array of arrays

An array of screenshot references to keep alive.

attributesContext
object

An object containing visible attributes and attribute renderers.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "store": "string",
  • "type": "file",
  • "screenshots": [ ],
  • "attributesContext": { }
}

Retrieve a cellar manifest

Retrieve a cellar manifest.

path Parameters
name
required
string [ 1 .. 1000 ] characters ^[A-Za-z0-9-_. ]+$

The file name.

Responses

Delete a cellar manifest

Deletes a cellar manifest.

path Parameters
name
required
string [ 1 .. 1000 ] characters ^[A-Za-z0-9-_. ]+$

The file name.

Responses

Touch a store manifest

Touches a cellar manifest.

path Parameters
name
required
string [ 1 .. 1000 ] characters ^[A-Za-z0-9-_. ]+$

The file name.

Responses

Touch a cellar manifest errors

Touches a cellar manifest errors.

path Parameters
name
required
string [ 1 .. 1000 ] characters ^[A-Za-z0-9-_. ]+$

The file name.

Responses

Scheduled Query Manager (sirp)

Scheduled query management

Retrieve all scheduled queries

Returns all scheduled queries.

Responses

Add a scheduled query

Parses, validates and schedules a query.

Request Body schema: application/json
query
required
string

The query string.

cleanup
boolean
summary
boolean
minutes
integer >= 0
ttl
integer >= 0
metadata
object

Responses

Request samples

Content type
application/json
{
  • "query": "string",
  • "cleanup": true,
  • "summary": true,
  • "minutes": 0,
  • "ttl": 0,
  • "metadata": { }
}

Retrieve a scheduled query

Returns the provided scheduled query.

path Parameters
id
required
string

The unique identifier for a scheduled artifact.

Responses

Delete a scheduled query

Deletes the provided scheduled query.

path Parameters
id
required
string

The unique identifier for a scheduled artifact.

Responses

Update a scheduled query

Updates a scheduled query.

Request Body schema: application/json
query
required
string

The query string.

cleanup
boolean
summary
boolean
minutes
integer >= 0
ttl
integer >= 0
metadata
object

Responses

Request samples

Content type
application/json
{
  • "query": "string",
  • "cleanup": true,
  • "summary": true,
  • "minutes": 0,
  • "ttl": 0,
  • "metadata": { }
}

Enable a scheduled query

Enables the provided scheduled query.

path Parameters
id
required
string

The unique identifier for a scheduled artifact.

Responses

Disable a scheduled query

Disables the provided scheduled query.

path Parameters
id
required
string

The unique identifier for a scheduled artifact.

Responses

Query Template Manager (sirp)

Query template management

List query templates

Lists all query templates.

query Parameters
name
string [ 1 .. 1000 ] characters

The query name/label reference.

sortBy
string [ 1 .. 1000 ] characters

A sorting key.

Responses

Create a new query template

Create a new query template.

Request Body schema: application/json
name
required
string [ 1 .. 1000 ] characters

The query name/label reference.

description
required
string [ 1 .. 100000 ] characters

The query description.

query
required
string [ 1 .. 1048576 ] characters

The crul query.

templateSchema
object

The template data schema; underlying inputs including properties and types.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "query": "string",
  • "templateSchema": { }
}

Retrieve a query template

Retrieve a query template.

path Parameters
id
required
string <uuid>

The unique identifier for my object. (A UUID specified by RFC4122).

Responses

Update a query template

Update a query template.

path Parameters
id
required
string <uuid>

The unique identifier for my object. (A UUID specified by RFC4122).

Request Body schema: application/json
name
string [ 1 .. 1000 ] characters

The query name/label reference.

description
string [ 1 .. 100000 ] characters

The query description.

query
string [ 1 .. 1048576 ] characters

The crul query.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "query": "string"
}

Delete a query template

Delete a query template.

path Parameters
id
required
string <uuid>

The unique identifier for my object. (A UUID specified by RFC4122).

Responses

Dispatch a query template and wait for completion

Parses, validates and dispatches a query template.

Request Body schema: application/json
query
required
string

The query string.

values
object
cleanup
boolean
summary
boolean
minutes
integer >= 0
ttl
integer >= 0
metadata
object

Responses

Request samples

Content type
application/json
{
  • "query": "string",
  • "values": { },
  • "cleanup": true,
  • "summary": true,
  • "minutes": 0,
  • "ttl": 0,
  • "metadata": { }
}

Parse a query template

Parses a query template.

Request Body schema: application/json
query
required
string [ 1 .. 1048576 ] characters

The crul query.

values
object

Responses

Request samples

Content type
application/json
{
  • "query": "string",
  • "values": { }
}

API Keys Manager (secrets)

API keys management

Generate an API key

Generate an API key value.

Responses

Verify an API key

Verify an API key value.

Request Body schema: application/json
key
required
string [ 1 .. 1000 ] characters

The api key.

Responses

Request samples

Content type
application/json
{
  • "key": "string"
}

Retrieve all API keys

Retrieve all API keys.

Responses

Retrieve an API key

Retrieve an API key.

path Parameters
id
required
string <uuid>

The unique identifier for my object. (A UUID specified by RFC4122).

Responses

Delete an API key

Delete an API key.

path Parameters
id
required
string <uuid>

The unique identifier for my object. (A UUID specified by RFC4122).

Responses

Checkpoints Manager (secrets)

Checkpoints management

Retrieve all checkpoints

Retrieve all checkpoints.

Responses

Create a new checkpoint

Create a new checkpoint.

Request Body schema: application/json
name
required
string [ 1 .. 1000 ] characters

The checkpoint name.

checkpoint
required
string [ 1 .. 10000 ] characters

The checkpoint value.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "checkpoint": "string"
}

Retrieve a checkpoint

Retrieve a checkpoint.

path Parameters
name
required
string [ 1 .. 1000 ] characters

The checkpoint name.

Responses

Update a checkpoint

Update a checkpoint.

path Parameters
name
required
string [ 1 .. 1000 ] characters

The checkpoint name.

Request Body schema: application/json
checkpoint
required
string [ 1 .. 10000 ] characters

The checkpoint value.

Responses

Request samples

Content type
application/json
{
  • "checkpoint": "string"
}

Delete a checkpoint

Delete a checkpoint.

path Parameters
name
required
string [ 1 .. 1000 ] characters

The checkpoint name.

Responses

Credentials Manager (secrets)

Credentials management

List credentials

Lists credentials.

Responses

Create a credential

Creates a new credential.

Request Body schema: application/json
One of
type
required
string
Enum: "aws4" "oauth" "splunk" "custom" "openai" "pinecone" "okta" "gcp"
object (aws4)

Amazon AWS Signature Version 4

Responses

Request samples

Content type
application/json
Example
{
  • "type": "aws4",
  • "config": {
    }
}

List OAuth mappings

Lists OAuth mappings.

Responses

Retrieve a credential

Gets the credential with the provided name.

path Parameters
name
required
string

Responses

Update a credential

Updates an existing credential.

path Parameters
name
required
string
Request Body schema: application/json
One of
type
required
string
Enum: "aws4" "oauth" "splunk" "custom" "openai" "pinecone" "okta" "gcp"
object (aws4)

Amazon AWS Signature Version 4

Responses

Request samples

Content type
application/json
Example
{
  • "type": "aws4",
  • "config": {
    }
}

Delete a credential

Deletes the credential with the provided name.

path Parameters
name
required
string

Responses

Get credential schema

Gets the credential schema with the provided credential type.

path Parameters
type
required
string

Responses

List credential schemas

Lists credential schemas.

Responses

Prompts Manager (secrets)

Prompts management

Retrieve all prompts

Retrieve all prompts.

Responses

Create a new prompt

Create a new prompt.

Request Body schema: application/json
name
required
string [ 1 .. 1000 ] characters

The prompt name.

prompt
required
string [ 1 .. 10000 ] characters

The prompt value.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "prompt": "string"
}

Retrieve a prompt

Retrieve a prompt.

path Parameters
name
required
string [ 1 .. 1000 ] characters

The prompt name.

Responses

Update a prompt

Update a prompt.

path Parameters
name
required
string [ 1 .. 1000 ] characters

The prompt name.

Request Body schema: application/json
prompt
required
string [ 1 .. 10000 ] characters

The prompt value.

Responses

Request samples

Content type
application/json
{
  • "prompt": "string"
}

Delete a prompt

Delete a prompt.

path Parameters
name
required
string [ 1 .. 1000 ] characters

The prompt name.

Responses

Stores Manager (secrets)

Stores management

Create a store

Creates a new store.

Request Body schema: application/json
One of
type
required
string
Enum: "graphistry" "gcpGCS" "gcpPubSub" "gcpBigQuery" "awsS3" "awsDynamoDB" "awsSNS" "awsSQS" "awsKinesis" "awsKinesisFirehose" "azureBlob" "azureTable" "azureQueue" "kafka" "splunk" "cribl" "influxdb" "elasticsearch" "hdfs" "http" "localFile" "mqtt" "amqp" "sql" "nats" "nsq" "redisPubSub" "cassandra" "pulsar" "sftp" "timeplus" "snowflake"
object (graphistry)

Graphistry Upload

Responses

Request samples

Content type
application/json
Example
{
  • "type": "graphistry",
  • "config": {
    }
}

Retrieve a store

Gets the store with the provided name.

path Parameters
name
required
string [ 1 .. 1000 ] characters ^[A-Za-z0-9-_. ]+$

The store name.

Responses

Update a store

Updates an existing store.

path Parameters
name
required
string [ 1 .. 1000 ] characters ^[A-Za-z0-9-_. ]+$

The store name.

Request Body schema: application/json
One of
type
required
string
Enum: "graphistry" "gcpGCS" "gcpPubSub" "gcpBigQuery" "awsS3" "awsDynamoDB" "awsSNS" "awsSQS" "awsKinesis" "awsKinesisFirehose" "azureBlob" "azureTable" "azureQueue" "kafka" "splunk" "cribl" "influxdb" "elasticsearch" "hdfs" "http" "localFile" "mqtt" "amqp" "sql" "nats" "nsq" "redisPubSub" "cassandra" "pulsar" "sftp" "timeplus" "snowflake"
object (graphistry)

Graphistry Upload

Responses

Request samples

Content type
application/json
Example
{
  • "type": "graphistry",
  • "config": {
    }
}

Delete a store

Deletes the store with the provided name.

path Parameters
name
required
string [ 1 .. 1000 ] characters ^[A-Za-z0-9-_. ]+$

The store name.

Responses

Retrieve all store schemas

Lists store schemas.

Responses

Retrieve a store schema

Gets the store schema with the provided store type.

path Parameters
type
required
string

Responses

Users Manager (secrets)

Users management

Retrieve all users

Retrieve all users.

Responses

Create a new user

Create a new user.

Request Body schema: application/json
required
object
username
required
string [ 1 .. 1000 ] characters

The username.

password
required
string [ 7 .. 1000 ] characters

The password.

Responses

Request samples

Content type
application/json
{
  • "credential": {
    }
}

Retrieve a user

Retrieve a user.

path Parameters
username
required
string [ 1 .. 1000 ] characters

The username.

Responses

Update a user

Update a user.

path Parameters
username
required
string [ 1 .. 1000 ] characters

The username.

Request Body schema: application/json
required
object
username
required
string [ 1 .. 1000 ] characters

The username.

password
required
string [ 7 .. 1000 ] characters

The password.

oldpassword
required
string [ 7 .. 1000 ] characters

The password.

Responses

Request samples

Content type
application/json
{
  • "credential": {
    }
}

Delete a user

Delete a user.

path Parameters
username
required
string [ 1 .. 1000 ] characters

The username.

Responses

Verify a user

Verify a user credential.

Request Body schema: application/json
required
object
username
required
string [ 1 .. 1000 ] characters

The username.

password
required
string [ 7 .. 1000 ] characters

The password.

Responses

Request samples

Content type
application/json
{
  • "credential": {
    }
}

Job Queue (jobs)

Jobs management and queue

Ping service

Ping service.

Responses

Scheduler (almanac)

General purpose scheduler

Retrieve environment variables

Returns instance environment variables.

Responses

Ping service

Pings service.

Responses

Restart service

Restarts the service.

Responses

Retrieve all scheduled queries

Lists scheduled queries.

Responses

Create a scheduled query

Creates a new scheduled query.

Request Body schema: application/json
sirpURL
string
query
required
string non-empty
ttl
integer >= 0
metadata
object
summary
boolean
cleanup
boolean
queryId
string
minutes
integer [ 0 .. 525600 ]

Responses

Request samples

Content type
application/json
{
  • "sirpURL": "string",
  • "query": "string",
  • "ttl": 0,
  • "metadata": { },
  • "summary": true,
  • "cleanup": true,
  • "queryId": "string",
  • "minutes": 525600
}

Retrieve a scheduled query

Gets the scheduled query with the provided id.

path Parameters
id
required
string

Responses

Create a scheduled query

Creates a new scheduled query.

Request Body schema: application/json
sirpURL
string
query
required
string non-empty
ttl
integer >= 0
metadata
object
summary
boolean
cleanup
boolean
queryId
string
minutes
integer [ 0 .. 525600 ]

Responses

Request samples

Content type
application/json
{
  • "sirpURL": "string",
  • "query": "string",
  • "ttl": 0,
  • "metadata": { },
  • "summary": true,
  • "cleanup": true,
  • "queryId": "string",
  • "minutes": 525600
}

Delete a scheduled query

Deletes the scheduled query with the provided id.

path Parameters
id
required
string

Responses

Disable a scheduled query

Disables the scheduled query with the provided id.

path Parameters
id
required
string

Responses

Enable a scheduled query

Enables the scheduled query with the provided id.

path Parameters
id
required
string

Responses

Workers Manager (workers)

Worker management and execution

Retrieve environment variables

Returns service environment variables.

Responses

Retrieve service status

Returns service status.

Responses

Restart the service

Restarts the service.

Responses

Retrieve all workers

Retrieves all workers

path Parameters
type
required
string
Default: "query"
Enum: "query" "command" "summary"

Responses

Add a worker

Adds a new workers

path Parameters
type
required
string
Default: "query"
Enum: "query" "command" "summary"

Responses

Retrieve a worker

Retrieves the provided worker.

path Parameters
type
required
string
Default: "query"
Enum: "query" "command" "summary"
pid
required
string

Responses

Delete a worker

Deletes the provided worker.

path Parameters
type
required
string
Default: "query"
Enum: "query" "command" "summary"
pid
required
string

Responses

License Manager (licorice)

License management and enforcement

Restart service

Restarts the service.

Responses

Validate the current license

Validates the current license.

Responses

Validate a license

Validates the provided license.

path Parameters
id
required
string

Responses

Retrieve all licenses

Retrieves all licenses.

Responses

Add a license

Adds a new license.

Request Body schema: application/json
required
object (#fileUploadSchema)
fieldname
string
encoding
string
filename
string
mimetype
string

Responses

Request samples

Content type
application/json
{
  • "licenseKey": {
    }
}

Retrieve a license

Retrieves the provided license.

path Parameters
id
required
string

Responses

Delete a license

Deletes the provided license.

path Parameters
id
required
string

Responses

Retrieve the current license

Retrieves the current license.

Responses

Upload a license

Upload a new license.

Request Body schema: application/json
required
object (#fileUploadSchema)
fieldname
string
encoding
string
filename
string
mimetype
string

Responses

Request samples

Content type
application/json
{
  • "licenseKey": {
    }
}

Secrets Manager (secrets)

General purpose secrets management

Restart the service

Restarts the service.

Responses

Retrieve all secrets

Lists secrets.

query Parameters
type
string
Enum: "store" "credential" "custom" "apikey" "user" "checkpoint" "prompt"

Responses

Create a secret

Creates a new secret.

Request Body schema: application/json
type
string
Enum: "store" "credential" "custom" "apikey" "user" "checkpoint" "prompt"
providerType
string
secret
string [ 1 .. 100000 ] characters
name
required
string [ 1 .. 250 ] characters
object

Responses

Request samples

Content type
application/json
{
  • "type": "store",
  • "providerType": "string",
  • "secret": "string",
  • "name": "string",
  • "metadata": {
    }
}

Create a secret

Creates a new secret.

Request Body schema: application/json
type
string
Enum: "store" "credential" "custom" "apikey" "user" "checkpoint" "prompt"
providerType
string
secret
string [ 1 .. 100000 ] characters
name
required
string [ 1 .. 250 ] characters
object

Responses

Request samples

Content type
application/json
{
  • "type": "store",
  • "providerType": "string",
  • "secret": "string",
  • "name": "string",
  • "metadata": {
    }
}

Retrieve a secret

Gets the secret with the provided name.

path Parameters
name
required
string
query Parameters
type
string
Enum: "store" "credential" "custom" "apikey" "user" "checkpoint" "prompt"

Responses

Delete a secret

Deletes the secret with the provided name.

path Parameters
name
required
string
query Parameters
type
string
Enum: "store" "credential" "custom" "apikey" "user" "checkpoint" "prompt"

Responses

Results Export (mentos)

Manages the export of results to configured stores

Retrieve environment variables

Returns instance environment variables.

Responses

Ping service

Pings service.

Responses

Restart service

Restarts the service.

Responses

Create a stream

Create a new stream.

Request Body schema: application/json
name
required
string [ 1 .. 1000 ] characters

The stream name/label reference.

streamConfig
required
object

A configuration object describing the desired stream.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "streamConfig": { }
}

Retrieve a stream

Returns the provided stream.

path Parameters
name
required
string [ 1 .. 1000 ] characters

The stream name/label reference.

Responses

Delete a stream

Deletes the provided stream.

path Parameters
name
required
string [ 1 .. 1000 ] characters

The stream name/label reference.

Responses

Write to an existing stream

Write content to an existing stream.

Request Body schema: application/json
content
required
object

An object to pass in as an input to a stream.

Responses

Request samples

Content type
application/json
{
  • "content": { }
}

Write to a stream

Write results using a stream.

Request Body schema: application/json
name
string [ 1 .. 1000 ] characters

The stream name/label reference.

config
required
object

A configuration object describing the desired write.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "config": { }
}

Query Processor Internals (sirp)

Query processor and support

Retrieve environment variables

Returns service environment variables.

Responses

Retrieve service status

Returns service status.

Responses

Retrieve query processor workers

Returns query processor workers.

Responses

Retrieve service diag file

Returns service diag file.

Responses

Retrieve service artifacts file

Returns service artifacts file.

query Parameters
secrets
boolean
Default: false

Responses

Sign in

Signs in to the service.

Request Body schema: application/json
required
object
username
required
string
password
required
string

Responses

Request samples

Content type
application/json
{
  • "credential": {
    }
}

Retrieve worker status

Status of the provided worker.

path Parameters
worker
required
string
Enum: "cacheReaper" "screenshotReaper" "queryJobRefresh" "queryJobReaper"

Responses

Retrieve all worker statuses

Status of all workers.

Responses

Disable worker

Disables the provided worker.

path Parameters
worker
required
string
Enum: "cacheReaper" "screenshotReaper" "queryJobRefresh" "queryJobReaper"

Responses

Enable worker

Enables the provided worker.

path Parameters
worker
required
string
Enum: "cacheReaper" "screenshotReaper" "queryJobRefresh" "queryJobReaper"

Responses

Retrieve all command metadata

All available query commands and related metadata (help text, flags, etc.).

query Parameters
name
string

Responses

Retrieve command metadata

All available query commands and related metadata (help text, flags, etc.).

path Parameters
command
required
string

Responses

Retrieve command flags

All available query commands and related metadata (help text, flags, etc.).

path Parameters
command
required
string
query Parameters
name
string

Responses

Retrieve all running commands

Returns all commands.

Responses

Dispatch a command

Dispatches a single command.

Request Body schema: application/json
command
required
string
args
Array of arrays
flags
object
prev
string
line
number
metadata
object
id
string

Responses

Request samples

Content type
application/json
{
  • "command": "string",
  • "args": [ ],
  • "flags": { },
  • "prev": "string",
  • "line": 0,
  • "metadata": { },
  • "id": "string"
}

Retrieve a command

Retrieves the provided command.

path Parameters
id
required
string

Responses

Delete a command

Deletes the provided command.

path Parameters
id
required
string

Responses

Cancel a command

Cancels the provided command.

path Parameters
id
required
string

Responses

Retrieve command results

Retrieves results for the provided command

path Parameters
id
required
string

Responses

Parse a query string and decorate with attributes

Parses a query string and returns the matched command decorators used to format single or multople attribute decorators.

path Parameters
type
required
string
Enum: "attribute" "multiattribute"
Request Body schema: application/json
query
required
string

The query string.

Responses

Request samples

Content type
application/json
{
  • "query": "string"
}

Autocomplete query string

Returns possible commands for a query string.

Request Body schema: application/json
query
required
string

The query string.

offset
number

Responses

Request samples

Content type
application/json
{
  • "query": "string",
  • "offset": 0
}

Retrieve visible attributes for a query

Returns the visible attributes for a provided query.

path Parameters
id
required
string <uuid>

The unique identifier for a stream. (A UUID specified by RFC4122).

Responses

Retrieve attribute renderers for a query

Returns the attributes renderers for a provided query.

path Parameters
id
required
string <uuid>

The unique identifier for a stream. (A UUID specified by RFC4122).

type
required
string
Enum: "attribute" "multiattribute"

Responses

Retrieve a query diag

Returns the diag of the provided query.

path Parameters
id
required
string <uuid>

The unique identifier for a stream. (A UUID specified by RFC4122).

Responses

Retrieve query stats

Returns the stats of the results of a completed query.

path Parameters
id
required
string <uuid>

The unique identifier for a stream. (A UUID specified by RFC4122).

Responses

Convert query results

Converts the results of a completed query to csv.

path Parameters
id
required
string <uuid>

The unique identifier for a stream. (A UUID specified by RFC4122).

Responses

Export query results

Exports a csv of the results of a completed query.

path Parameters
id
required
string <uuid>

The unique identifier for a stream. (A UUID specified by RFC4122).

mode
required
string
Enum: "csv" "ndjson"

Responses

Retrieve all library queries

List all library queries.

query Parameters
name
string [ 1 .. 1000 ] characters

The query name/label reference.

sortBy
string [ 1 .. 1000 ] characters

A sorting key.

Responses

Update check

Perform an in-product update check.

path Parameters
uuid
required
string <uuid>

The unique identifier for the user. (A UUID specified by RFC4122).

Responses

Retrieve server information

Server information including version and platform details.

Responses

Retrieve available licenses

Retrieves available licenses.

query Parameters
access_token
string

The access token for the user.

uuid
string <uuid>

The unique identifier for the user. (A UUID specified by RFC4122).

Responses

Retrieve all query tokens

Available query tokens including global, checkpoints, credentials and prompts.

Responses