NOTE: this API is only available to Griffin View & ASM Edition subscribers. Contact us for details.

ASD Pivot Query APIv1

Using curl

Call with default parameters:

curl -H 'Content-Type: application/json' -H 'X-Api-Key: YOUR_APIKEY' -XPOST 'https://www.onyphe.io/api/v1/asd/pivot/query' -d '{ "query":"category:datascan domain:DOMAIN.TLD","field":"subject.organization" }'

Call with some custom parameters:

curl -H 'Content-Type: application/json' -H 'X-Api-Key: YOUR_APIKEY' -XPOST 'https://www.onyphe.io/api/v1/asd/pivot/query' -d '{ "query":"category:datascan domain:DOMAIN.TLD","field":"subject.organization","aslines":"true" }'

Available parameters

• query: OQL query to execute. Mandatory parameter.
• field: field to pivot on. Mandatory parameter.
• aslines: render results with context information (false) or one JSON per line (true). Default to false.
• astask: create a background task for later processing (true). Default to false.
• includep: one or more patterns to grep into result values and only keep matches.
• excludep: one or more patterns to grep into result values and exclude matches.

Using ONYPHE CLI

onyphe -asd-pivot-query 'category:datascan domain:DOMAIN.TLD' -field subject.organization

Error codes

error: 0, text: 'Success'
error: 1, text: 'Error not found'
error: 2, text: 'Unknown error'
error: 3, text: 'Request timed out'
error: 1000, text: 'API not found'
error: 1001, text: 'API access denied'
error: 1002, text: 'API key not given'
error: 1003, text: 'API key is not valid'
error: 1004, text: 'Parameter error: <custom message>'
error: 1005, text: 'User not found'
error: 1006, text: 'User get failed'
error: 1007, text: 'Search failed: <custom message>'
error: 1008, text: 'Getting result failed: <custom message>'
error: 1009, text: 'Task not found: <custom message>'
error: 1010, text: 'Creating task failed: <custom message>'
error: 1011, text: 'Getting task result failed: <custom message>'
error: 1012, text: 'Unable to kill task: <custom message>'
error: 1013, text: 'Task in progress: <custom message>'
error: 1014, text: 'Resolver failed: <custom message>'