Run query

POST

/api/v1/queries/{env}

curl --request POST \
  --url https://osctrl.net/api/v1/queries/example \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "environment_list": [ "example" ], "exp_hours": 1, "hidden": true, "host_list": [ "example" ], "path": "example", "platform_list": [ "example" ], "query": "example", "tag_list": [ "example" ], "uuid_list": [ "example" ] }'

Starts a new distributed query.

Authorizations

• ApiKeyAuth

Parameters

Path Parameters

env

required

string

Environment name or UUID

Request Body^required

Request body

Media typeapplication/json

object

environment_list

Array<string>

exp_hours

integer

hidden

boolean

host_list

Array<string>

path

string

platform_list

Array<string>

query

string

tag_list

Array<string>

uuid_list

Array<string>

Example^generated

{
  "environment_list": [
    "example"
  ],
  "exp_hours": 1,
  "hidden": true,
  "host_list": [
    "example"
  ],
  "path": "example",
  "platform_list": [
    "example"
  ],
  "query": "example",
  "tag_list": [
    "example"
  ],
  "uuid_list": [
    "example"
  ]
}

Responses

200

OK

Media typeapplication/json

object

query_name

string

Example^generated

{
  "query_name": "example"
}

400

Bad request

Media typeapplication/json

object

code

string

error

string

Example^generated

{
  "code": "example",
  "error": "example"
}

401

Unauthorized

Media typeapplication/json

object

code

string

error

string

Example^generated

{
  "code": "example",
  "error": "example"
}

403

Forbidden

Media typeapplication/json

object

code

string

error

string

Example^generated

{
  "code": "example",
  "error": "example"
}

404

Not found

Media typeapplication/json

object

code

string

error

string

Example^generated

{
  "code": "example",
  "error": "example"
}

409

Conflict

Media typeapplication/json

object

code

string

error

string

Example^generated

{
  "code": "example",
  "error": "example"
}

429

Too many requests

Media typeapplication/json

object

code

string

error

string

Example^generated

{
  "code": "example",
  "error": "example"
}

500

Internal server error

Media typeapplication/json

object

code

string

error

string

Example^generated

{
  "code": "example",
  "error": "example"
}

503

Service unavailable

Media typeapplication/json

object

code

string

error

string

Example^generated

{
  "code": "example",
  "error": "example"
}