redocly logoAPI docs by Redocly

Capture Orchestration (24.9.15)

Download OpenAPI specification:Download

Management service for capture sensors in Skylight Analytics

application

Get latest application definition

Get definitions of applications.

query Parameters
from_version
integer (From Version)
Default: 0

From which version to fetch the configuration, if no argument has been set, it will fetch the configuration since the beginning.

to_version
integer (To Version)

Until which version to fetch the configuration, if no argument has been set, it will fetch until the latest configuration.

include_deleted
boolean (Include Deleted)
Default: false

Include deleted applications.

Responses

Response samples

Content type
application/json
{
  • "version": {
    },
  • "entries": [
    ],
  • "can_undo": true,
  • "can_redo": true
}

Create multiple applications

Create multiple applications.

query Parameters
tag_check_enabled
boolean (Tag Check Enabled)
Default: true
Request Body schema: application/json
required
object (Version)

Current version of the configuration.

required
Array of objects (Entries) non-empty

List of changes to apply.

Responses

Request samples

Content type
application/json
{
  • "version": {
    },
  • "entries": [
    ]
}

Response samples

Content type
application/json
{
  • "version": {
    },
  • "entries": [
    ],
  • "can_undo": true,
  • "can_redo": true
}

Delete multiple applications

Delete multiple applications.

Request Body schema: application/json
required
object (Version)

Current version of the configuration.

required
Array of objects (Entries) non-empty

List of applications to delete.

Responses

Request samples

Content type
application/json
{
  • "version": {
    },
  • "entries": [
    ]
}

Response samples

Content type
application/json
{
  • "version": {
    },
  • "entries": [
    ],
  • "can_undo": true,
  • "can_redo": true
}

Update multiple applications

Update multiple applications.

query Parameters
tag_check_enabled
boolean (Tag Check Enabled)
Default: true
Request Body schema: application/json
required
object (Version)

Current version of the configuration.

required
Array of objects (Entries) non-empty

List of changes to apply.

Responses

Request samples

Content type
application/json
{
  • "version": {
    },
  • "entries": [
    ]
}

Response samples

Content type
application/json
{
  • "version": {
    },
  • "entries": [
    ],
  • "can_undo": true,
  • "can_redo": true
}

Export current configuration into a JSON or CSV file

Export application configuration.

query Parameters
format
string (ApplicationsFormat)
Default: "json"
Enum: "csv" "json"

An enumeration.

Responses

Response samples

Content type
{
  • "version": {
    },
  • "entries": [
    ],
  • "can_undo": true,
  • "can_redo": true
}

Import multiple applications into Pyloth

Import application configuration.

query Parameters
tag_check_enabled
boolean (Tag Check Enabled)
Default: true
Request Body schema: multipart/form-data
file
required
string <binary> (File)
format
string (ApplicationsFormat)
Default: "json"
Enum: "csv" "json"

An enumeration.

Responses

Response samples

Content type
application/json
{
  • "version": {
    },
  • "entries": [
    ],
  • "can_undo": true,
  • "can_redo": true
}

Import multiple applications from nevrax into Pyloth

Import multiple applications.

query Parameters
encoding
string (NevraxEncodingCSV)
Default: "utf-8"
Enum: "utf-8" "utf-16" "mac-roman" "cp1252" "iso-8859-15"

An enumeration.

tag_check_enabled
boolean (Tag Check Enabled)
Default: true
Request Body schema: multipart/form-data
file
required
string <binary> (File)

Responses

Response samples

Content type
application/json
{
  • "version": {
    },
  • "entries": [
    ],
  • "can_undo": true,
  • "can_redo": true
}

Preview an undo of an application change

Preview an undo of an application change.

Responses

Response samples

Content type
application/json
{
  • "version": {
    },
  • "entries": [
    ],
  • "can_undo": true,
  • "can_redo": true
}

Undo an application change

Undo an application change.

Request Body schema: application/json
required
object (Version)

Latest version fetched by the user.

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "version": {
    },
  • "entries": [
    ],
  • "can_undo": true,
  • "can_redo": true
}

Preview a redo of an application change

Preview a redo of an application change.

Responses

Response samples

Content type
application/json
{
  • "version": {
    },
  • "entries": [
    ],
  • "can_undo": true,
  • "can_redo": true
}

Redo an application change

Redo an application change.

Request Body schema: application/json
required
object (Version)

Latest version fetched by the user.

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "version": {
    },
  • "entries": [
    ],
  • "can_undo": true,
  • "can_redo": true
}

Get latest application configuration version

Get latest application configuration version.

Responses

Response samples

Content type
application/json
{
  • "id": 2147483647
}

Get latest version of the list of autodetected applications

Responses

Response samples

Content type
application/json
{
  • "id": 2147483647
}

Get all applications categories

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns the list of autodetected applications

Responses

Response samples

Content type
application/json
{
  • "entries": [
    ],
  • "version": {
    }
}

capture

List of pcap in captures

List pcap.

query Parameters
filter[capture.id][contains]
Array of integers (Filter[Capture.Id][Contains]) [ items [ 0 .. 2147483647 ] ]

Contains operator for field capture.id

filter[capture.id][notContains]
Array of integers (Filter[Capture.Id][Notcontains]) [ items [ 0 .. 2147483647 ] ]

Not Contains operator for field capture.id

filter[order.id][contains]
Array of integers (Filter[Order.Id][Contains]) [ items [ 0 .. 2147483647 ] ]

Contains operator for field order.id

filter[order.id][notContains]
Array of integers (Filter[Order.Id][Notcontains]) [ items [ 0 .. 2147483647 ] ]

Not Contains operator for field order.id

filter[capture.status][contains]
Array of strings (CaptureState)
Items Enum: "online" "offline" "unregistered"

Contains operator for field capture.status

filter[capture.status][notContains]
Array of strings (CaptureState)
Items Enum: "online" "offline" "unregistered"

Not Contains operator for field capture.status

offset
integer (Offset)
Default: 0
limit
integer (Limit)
Default: 50
sort
string (Sort) ^(\-?((pcap\.created_at)))(,\-?((pcap\.create...
Default: "-pcap.created_at"

Responses

Response samples

Content type
application/json
{
  • "entries": [
    ],
  • "total": 0,
  • "offset": 0,
  • "limit": 0
}

Download a pcap from a capture.

path Parameters
job_id
required
string <uuid> (Job Id)

Responses

Response samples

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

List captures

List registered captures.

query Parameters
filter[capture.id][contains]
Array of integers (Filter[Capture.Id][Contains]) [ items [ 0 .. 2147483647 ] ]

Contains operator for field capture.id

filter[capture.id][notContains]
Array of integers (Filter[Capture.Id][Notcontains]) [ items [ 0 .. 2147483647 ] ]

Not Contains operator for field capture.id

filter[capture.serial][contains]
Array of strings (Filter[Capture.Serial][Contains])
Example: filter[capture.serial][contains]=example*

Contains operator for field capture.serial (Fuzzy matching)

filter[capture.serial][notContains]
Array of strings (Filter[Capture.Serial][Notcontains])
Example: filter[capture.serial][notContains]=example*

Not Contains operator for field capture.serial (Fuzzy matching)

filter[capture.ip][contains]
Array of strings (Filter[Capture.Ip][Contains])

Contains operator for field capture.ip (Fuzzy matching)

filter[capture.ip][notContains]
Array of strings (Filter[Capture.Ip][Notcontains])

Not Contains operator for field capture.ip (Fuzzy matching)

filter[capture.version][contains]
Array of strings (Filter[Capture.Version][Contains])
Example: filter[capture.version][contains]=example*

Contains operator for field capture.version (Fuzzy matching)

filter[capture.version][notContains]
Array of strings (Filter[Capture.Version][Notcontains])
Example: filter[capture.version][notContains]=example*

Not Contains operator for field capture.version (Fuzzy matching)

filter[capture.version.major][contains]
Array of integers (Filter[Capture.Version.Major][Contains])

Contains operator for field capture.version.major

filter[capture.version.major][notContains]
Array of integers (Filter[Capture.Version.Major][Notcontains])

Not Contains operator for field capture.version.major

filter[capture.version.major][le]
integer (Filter[Capture.Version.Major][Le])

Less or Equal operator for field capture.version.major

filter[capture.version.major][lt]
integer (Filter[Capture.Version.Major][Lt])

Less Than operator for field capture.version.major

filter[capture.version.major][ge]
integer (Filter[Capture.Version.Major][Ge])

Greater or Equal operator for field capture.version.major

filter[capture.version.major][gt]
integer (Filter[Capture.Version.Major][Gt])

Greater Than operator for field capture.version.major

filter[capture.version.minor][contains]
Array of integers (Filter[Capture.Version.Minor][Contains])

Contains operator for field capture.version.minor

filter[capture.version.minor][notContains]
Array of integers (Filter[Capture.Version.Minor][Notcontains])

Not Contains operator for field capture.version.minor

filter[capture.version.minor][le]
integer (Filter[Capture.Version.Minor][Le])

Less or Equal operator for field capture.version.minor

filter[capture.version.minor][lt]
integer (Filter[Capture.Version.Minor][Lt])

Less Than operator for field capture.version.minor

filter[capture.version.minor][ge]
integer (Filter[Capture.Version.Minor][Ge])

Greater or Equal operator for field capture.version.minor

filter[capture.version.minor][gt]
integer (Filter[Capture.Version.Minor][Gt])

Greater Than operator for field capture.version.minor

filter[capture.version.micro][contains]
Array of integers (Filter[Capture.Version.Micro][Contains])

Contains operator for field capture.version.micro

filter[capture.version.micro][notContains]
Array of integers (Filter[Capture.Version.Micro][Notcontains])

Not Contains operator for field capture.version.micro

filter[capture.version.micro][le]
integer (Filter[Capture.Version.Micro][Le])

Less or Equal operator for field capture.version.micro

filter[capture.version.micro][lt]
integer (Filter[Capture.Version.Micro][Lt])

Less Than operator for field capture.version.micro

filter[capture.version.micro][ge]
integer (Filter[Capture.Version.Micro][Ge])

Greater or Equal operator for field capture.version.micro

filter[capture.version.micro][gt]
integer (Filter[Capture.Version.Micro][Gt])

Greater Than operator for field capture.version.micro

filter[capture.version.release][contains]
Array of integers (Filter[Capture.Version.Release][Contains])

Contains operator for field capture.version.release

filter[capture.version.release][notContains]
Array of integers (Filter[Capture.Version.Release][Notcontains])

Not Contains operator for field capture.version.release

filter[capture.version.release][le]
integer (Filter[Capture.Version.Release][Le])

Less or Equal operator for field capture.version.release

filter[capture.version.release][lt]
integer (Filter[Capture.Version.Release][Lt])

Less Than operator for field capture.version.release

filter[capture.version.release][ge]
integer (Filter[Capture.Version.Release][Ge])

Greater or Equal operator for field capture.version.release

filter[capture.version.release][gt]
integer (Filter[Capture.Version.Release][Gt])

Greater Than operator for field capture.version.release

filter[capture.vpn.ip][contains]
Array of strings (Filter[Capture.Vpn.Ip][Contains])

Contains operator for field capture.vpn.ip (Fuzzy matching)

filter[capture.vpn.ip][notContains]
Array of strings (Filter[Capture.Vpn.Ip][Notcontains])

Not Contains operator for field capture.vpn.ip (Fuzzy matching)

filter[capture.hostname][contains]
Array of strings (Filter[Capture.Hostname][Contains])
Example: filter[capture.hostname][contains]=example*

Contains operator for field capture.hostname (Fuzzy matching)

filter[capture.hostname][notContains]
Array of strings (Filter[Capture.Hostname][Notcontains])
Example: filter[capture.hostname][notContains]=example*

Not Contains operator for field capture.hostname (Fuzzy matching)

filter[capture.groups][contains]
Array of integers (Filter[Capture.Groups][Contains])

Contains operator for field capture.groups

filter[capture.groups][notContains]
Array of integers (Filter[Capture.Groups][Notcontains])

Not Contains operator for field capture.groups

filter[capture.groups][le]
integer (Filter[Capture.Groups][Le])

Less or Equal operator for field capture.groups

filter[capture.groups][lt]
integer (Filter[Capture.Groups][Lt])

Less Than operator for field capture.groups

filter[capture.groups][ge]
integer (Filter[Capture.Groups][Ge])

Greater or Equal operator for field capture.groups

filter[capture.groups][gt]
integer (Filter[Capture.Groups][Gt])

Greater Than operator for field capture.groups

filter[capture.status][contains]
Array of strings (CaptureState)
Items Enum: "online" "offline" "unregistered"

Contains operator for field capture.status

filter[capture.status][notContains]
Array of strings (CaptureState)
Items Enum: "online" "offline" "unregistered"

Not Contains operator for field capture.status

filter[capture.is_active][eq]
boolean (Filter[Capture.Is Active][Eq])

Equal operator for field capture.is_active

filter[capture.need_reboot][eq]
boolean (Filter[Capture.Need Reboot][Eq])

Equal operator for field capture.need_reboot

filter[capture.metadata]
Array of strings (Filter[Capture.Metadata])

Filters captures using metadata (tag=value pairs). To filter out captures with specific value of tag, use tag=value syntax. For captures having any value, use only tag name.

offset
integer (Offset)
Default: 0
limit
integer (Limit)
Default: 50
sort
string (Sort) ^(\-?((capture\.hostname)|(capture\.ip)|(capt...

Responses

Response samples

Content type
application/json
{
  • "entries": [
    ],
  • "total": 0,
  • "offset": 0,
  • "limit": 0
}

Get capture

Retrieve information about a registered capture.

path Parameters
capture_id
required
integer (Capture Id) [ 0 .. 2147483647 ]

ID of the capture.

Responses

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "serial": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "version": "string",
  • "hostname": "string",
  • "is_active": true,
  • "is_deleted": true,
  • "state": "online",
  • "last_seen": "2019-08-24T14:15:22Z",
  • "boot_at": "2019-08-24T14:15:22Z",
  • "need_reboot": true,
  • "upgraded_at": "2019-08-24T14:15:22Z",
  • "management_ip": "192.168.0.1",
  • "vpn": {
    },
  • "partitions": [
    ],
  • "interfaces": [
    ],
  • "configuration_states": {
    },
  • "profile": {
    },
  • "groups": [
    ],
  • "metadata": [
    ]
}

Get metadata for specific capture

path Parameters
capture_id
required
integer (Capture Id) [ 0 .. 2147483647 ]

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete capture metadata

path Parameters
capture_id
required
integer (Capture Id) [ 0 .. 2147483647 ]

ID of capture.

query Parameters
key
required
string (Key) <= 32 characters ^[a-zA-Z][a-zA-Z0-9-]+$

Responses

Response samples

Content type
application/json
null

Add metadata to capture

Request Body schema: application/json
capture_id
required
integer (Capture Id)
key
required
string (Key) <= 32 characters ^[a-zA-Z][a-zA-Z0-9-]+$
value
required
string (Value) <= 256 characters

Responses

Request samples

Content type
application/json
{
  • "capture_id": 0,
  • "key": "string",
  • "value": "string"
}

Response samples

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

Update metadata of a capture

Request Body schema: application/json
capture_id
required
integer (Capture Id)
key
required
string (Key) <= 32 characters ^[a-zA-Z][a-zA-Z0-9-]+$
value
required
string (Value) <= 256 characters

Responses

Request samples

Content type
application/json
{
  • "capture_id": 0,
  • "key": "string",
  • "value": "string"
}

Response samples

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

Fetch all existing metadata keys and their values.

Responses

Response samples

Content type
application/json
null

Update metadata for many captures. If any key assigned to some capture doesn't exist in input, assignment is removed.

Request Body schema: application/json
required
Array of objects (Captures Metadata)

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "property1": [
    ],
  • "property2": [
    ]
}

Delete multiple tags for different captures

Request Body schema: application/json
required
Array of objects (Bulk Metadata Delete)

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "property1": [
    ],
  • "property2": [
    ]
}

Update metadata for many captures. If any key already assigned to capture does not appear in input, it is left unmodified.

Request Body schema: application/json
required
Array of objects (Captures Metadata)

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "property1": [
    ],
  • "property2": [
    ]
}

Fetch metadata for captures ids given in payload.

Request Body schema: application/json
ids
required
Array of integers (Ids)

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "property1": [
    ],
  • "property2": [
    ]
}

Get authorized orders for capture

Retrieve list of available orders for a capture.

path Parameters
capture_id
required
integer (Capture Id) [ 0 .. 2147483647 ]

ID of the capture.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get recent events from capture sensor

path Parameters
capture_id
required
integer (Capture Id) [ 0 .. 2147483647 ]

ID of the capture.

query Parameters
offset
integer (Offset)
Default: 0
limit
integer (Limit)
Default: 50

Responses

Response samples

Content type
application/json
{
  • "entries": [
    ],
  • "total": 0,
  • "offset": 0,
  • "limit": 0
}

List capture groups

Retrieve all the groups for a capture.

path Parameters
capture_id
required
integer (Capture Id) [ 0 .. 2147483647 ]

Responses

Response samples

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

Get latest system config definition

Get definitions of systems config.

query Parameters
filter[capture.id][contains]
Array of integers (Filter[Capture.Id][Contains]) [ items [ 0 .. 2147483647 ] ]

Contains operator for field capture.id

filter[capture.id][notContains]
Array of integers (Filter[Capture.Id][Notcontains]) [ items [ 0 .. 2147483647 ] ]

Not Contains operator for field capture.id

offset
integer (Offset) >= 0
Default: 0
limit
integer (Limit) >= 0
Default: 50

Responses

Response samples

Content type
application/json
{
  • "entries": [
    ],
  • "total": 0,
  • "offset": 0,
  • "limit": 0
}

Get a system configuration from capture

Get a system configuration from capture.

path Parameters
capture_id
required
integer (Capture Id) [ 0 .. 2147483647 ]

Responses

Response samples

Content type
application/json
{
  • "capture": {
    },
  • "config": {
    },
  • "sources": {
    },
  • "version": 0
}

Update a system configuration

Update a system configuration.

path Parameters
capture_id
required
integer (Capture Id) [ 0 .. 2147483647 ]
Request Body schema: application/json
required
object (pykouze__bin__pyloth__leader__api__models__system__v4__APISystemConfigModel)
required
object (pykouze__bin__pyloth__leader__api__models__system__v4__APISystemConfigModelOverride)
version
required
integer (Version)

Responses

Request samples

Content type
application/json
{
  • "config": {
    },
  • "sources": {
    },
  • "version": 0
}

Response samples

Content type
application/json
{
  • "capture": {
    },
  • "config": {
    },
  • "sources": {
    },
  • "version": 0
}

Get latest system config definition

Get definitions of systems config.

query Parameters
filter[capture.id][contains]
Array of integers (Filter[Capture.Id][Contains]) [ items [ 0 .. 2147483647 ] ]

Contains operator for field capture.id

filter[capture.id][notContains]
Array of integers (Filter[Capture.Id][Notcontains]) [ items [ 0 .. 2147483647 ] ]

Not Contains operator for field capture.id

offset
integer (Offset) >= 0
Default: 0
limit
integer (Limit) >= 0
Default: 50

Responses

Response samples

Content type
application/json
{
  • "entries": [
    ],
  • "total": 0,
  • "offset": 0,
  • "limit": 0
}

Get a system configuration from capture

Get a system configuration from capture.

path Parameters
capture_id
required
integer (Capture Id) [ 0 .. 2147483647 ]

Responses

Response samples

Content type
application/json
{
  • "capture": {
    },
  • "config": {
    },
  • "sources": {
    },
  • "version": 0
}

Update a system configuration

Update a system configuration.

path Parameters
capture_id
required
integer (Capture Id) [ 0 .. 2147483647 ]
Request Body schema: application/json
required
object (pykouze__bin__pyloth__leader__api__models__system__v5__APISystemConfigModel)
required
object (pykouze__bin__pyloth__leader__api__models__system__v5__APISystemConfigModelOverride)
version
required
integer (Version)

Responses

Request samples

Content type
application/json
{
  • "config": {
    },
  • "sources": {
    },
  • "version": 0
}

Response samples

Content type
application/json
{
  • "capture": {
    },
  • "config": {
    },
  • "sources": {
    },
  • "version": 0
}

Get latest system config definition

Get definitions of systems config.

query Parameters
filter[capture.id][contains]
Array of integers (Filter[Capture.Id][Contains]) [ items [ 0 .. 2147483647 ] ]

Contains operator for field capture.id

filter[capture.id][notContains]
Array of integers (Filter[Capture.Id][Notcontains]) [ items [ 0 .. 2147483647 ] ]

Not Contains operator for field capture.id

offset
integer (Offset) >= 0
Default: 0
limit
integer (Limit) >= 0
Default: 50

Responses

Response samples

Content type
application/json
{
  • "entries": [
    ],
  • "total": 0,
  • "offset": 0,
  • "limit": 0
}

Get a system configuration from capture

Get a system configuration from capture.

path Parameters
capture_id
required
integer (Capture Id) [ 0 .. 2147483647 ]

Responses

Response samples

Content type
application/json
{
  • "capture": {
    },
  • "config": {
    },
  • "sources": {
    },
  • "version": 0
}

Update a system configuration

Update a system configuration.

path Parameters
capture_id
required
integer (Capture Id) [ 0 .. 2147483647 ]
Request Body schema: application/json
required
object (pykouze__bin__pyloth__leader__api__models__system__v6__APISystemConfigModel)
required
object (pykouze__bin__pyloth__leader__api__models__system__v6__APISystemConfigModelOverride)
version
required
integer (Version)

Responses

Request samples

Content type
application/json
{
  • "config": {
    },
  • "sources": {
    },
  • "version": 0
}

Response samples

Content type
application/json
{
  • "capture": {
    },
  • "config": {
    },
  • "sources": {
    },
  • "version": 0
}

pcap

List of pcap in captures

List pcap.

query Parameters
filter[capture.id][contains]
Array of integers (Filter[Capture.Id][Contains]) [ items [ 0 .. 2147483647 ] ]

Contains operator for field capture.id

filter[capture.id][notContains]
Array of integers (Filter[Capture.Id][Notcontains]) [ items [ 0 .. 2147483647 ] ]

Not Contains operator for field capture.id

filter[order.id][contains]
Array of integers (Filter[Order.Id][Contains]) [ items [ 0 .. 2147483647 ] ]

Contains operator for field order.id

filter[order.id][notContains]
Array of integers (Filter[Order.Id][Notcontains]) [ items [ 0 .. 2147483647 ] ]

Not Contains operator for field order.id

filter[capture.status][contains]
Array of strings (CaptureState)
Items Enum: "online" "offline" "unregistered"

Contains operator for field capture.status

filter[capture.status][notContains]
Array of strings (CaptureState)
Items Enum: "online" "offline" "unregistered"

Not Contains operator for field capture.status

offset
integer (Offset)
Default: 0
limit
integer (Limit)
Default: 50
sort
string (Sort) ^(\-?((pcap\.created_at)))(,\-?((pcap\.create...
Default: "-pcap.created_at"

Responses

Response samples

Content type
application/json
{
  • "entries": [
    ],
  • "total": 0,
  • "offset": 0,
  • "limit": 0
}

Download a pcap from a capture.

path Parameters
job_id
required
string <uuid> (Job Id)

Responses

Response samples

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

categories_metadata

Get all categories metadata assigned to Captures, Zones or couples (Capture, Interface)

Responses

Response samples

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

Create/Update metadata to Captures, Zones or couples (Capture, Interface)

Request Body schema: application/json
required
Array of CategoryCaptureMetadataBase (object) or CategoryZoneMetadataBase (object) or CategoryInterfaceMetadataBase (object) (Categories)

Responses

Request samples

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

Response samples

Content type
application/json
null

Delete metadata assigned to Captures, Zones or couples (Capture, Interface) by ID

Request Body schema: application/json
Array
integer

Responses

Request samples

Content type
application/json
[
  • 0
]

Response samples

Content type
application/json
null

Export all categories metadata assigned to Captures, Zones or couples (Capture, Interface)

Responses

Response samples

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

Import metadata to Captures, Zones or couples (Capture, Interface)

Import multiple applications.

Request Body schema: multipart/form-data
file
required
string <binary> (File)

Responses

Response samples

Content type
application/json
null

group

List groups

List groups.

query Parameters
offset
integer (Offset)
Default: 0
limit
integer (Limit)
Default: 50

Responses

Response samples

Content type
application/json
{
  • "entries": [
    ],
  • "total": 0,
  • "offset": 0,
  • "limit": 0
}

Create group

Register a group.

Request Body schema: application/json
name
required
string (Name)

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "name": "string",
  • "kind": "system"
}

Get group

Retrieves information about a capture group.

path Parameters
group_id
required
integer (Group Id) [ 0 .. 2147483647 ]

Responses

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "name": "string",
  • "kind": "system"
}

Update group

Update a capture group.

path Parameters
group_id
required
integer (Group Id) [ 0 .. 2147483647 ]
Request Body schema: application/json
name
required
string (Name)

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "name": "string",
  • "kind": "system"
}

Delete group

Unregister a group.

path Parameters
group_id
required
integer (Group Id) [ 0 .. 2147483647 ]

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "resource": "string",
  • "params": { }
}

List group members

Retrieve all the captures for a group.

path Parameters
group_id
required
integer (Group Id) [ 0 .. 2147483647 ]

Responses

Response samples

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

listing

Get IP protocols

Responses

Response samples

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

Get Ethernet protocols

Responses

Response samples

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

Get DCE/RPC services

Responses

Response samples

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

membership

List capture groups

Retrieve all the groups for a capture.

path Parameters
capture_id
required
integer (Capture Id) [ 0 .. 2147483647 ]

Responses

Response samples

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

List group members

Retrieve all the captures for a group.

path Parameters
group_id
required
integer (Group Id) [ 0 .. 2147483647 ]

Responses

Response samples

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

Get group membership

Retrieve a specific group membership.

path Parameters
membership_id
required
integer (Membership Id) [ 0 .. 2147483647 ]

Responses

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "capture": {
    },
  • "group": {
    }
}

Remove capture from group

Delete a specific group membership.

path Parameters
membership_id
required
integer (Membership Id) [ 0 .. 2147483647 ]

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "resource": "string",
  • "params": { }
}

Add captures to different groups.

Create group memberships.

Request Body schema: application/json
required
Array of objects (Entries) non-empty

Responses

Request samples

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

Response samples

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

order

Get shutdown orders

query Parameters
filter[order.name][contains]
Array of strings (Filter[Order.Name][Contains])
Example: filter[order.name][contains]=example*

Contains operator for field order.name (Fuzzy matching)

filter[order.name][notContains]
Array of strings (Filter[Order.Name][Notcontains])
Example: filter[order.name][notContains]=example*

Not Contains operator for field order.name (Fuzzy matching)

filter[order.kind][contains]
Array of strings (OrderKind)
Items Enum: "ONE_SHOT" "SCHEDULE"

Contains operator for field order.kind

filter[order.kind][notContains]
Array of strings (OrderKind)
Items Enum: "ONE_SHOT" "SCHEDULE"

Not Contains operator for field order.kind

filter[order.active][eq]
boolean (Filter[Order.Active][Eq])

Equal operator for field order.active

filter[order.created_by][contains]
Array of integers (Filter[Order.Created By][Contains]) [ items [ 0 .. 2147483647 ] ]

Contains operator for field order.created_by

filter[order.created_by][notContains]
Array of integers (Filter[Order.Created By][Notcontains]) [ items [ 0 .. 2147483647 ] ]

Not Contains operator for field order.created_by

filter[order.created_at][le]
string <date-time> (Filter[Order.Created At][Le])

Less or Equal operator for field order.created_at

filter[order.created_at][lt]
string <date-time> (Filter[Order.Created At][Lt])

Less Than operator for field order.created_at

filter[order.created_at][ge]
string <date-time> (Filter[Order.Created At][Ge])

Greater or Equal operator for field order.created_at

filter[order.created_at][gt]
string <date-time> (Filter[Order.Created At][Gt])

Greater Than operator for field order.created_at

filter[order.job.last_status][any]
Array of strings (JobStatus)
Items Enum: "in_progress" "cancelled" "success" "failure" "system_error"

Any operator for field order.job.last_status

filter[order.job.last_status][notAny]
Array of strings (JobStatus)
Items Enum: "in_progress" "cancelled" "success" "failure" "system_error"

Not any operator for field order.job.last_status

filter[order.start_at][le]
string <date-time> (Filter[Order.Start At][Le])

Less or Equal operator for field order.start_at

filter[order.start_at][lt]
string <date-time> (Filter[Order.Start At][Lt])

Less Than operator for field order.start_at

filter[order.start_at][ge]
string <date-time> (Filter[Order.Start At][Ge])

Greater or Equal operator for field order.start_at

filter[order.start_at][gt]
string <date-time> (Filter[Order.Start At][Gt])

Greater Than operator for field order.start_at

sort
string (Sort) ^(\-?((order\.kind)|(order\.action)|(order\.a...
Default: "-order.start_at,order.job.last_status"
offset
integer (Offset)
Default: 0
limit
integer (Limit)
Default: 50

Responses

Response samples

Content type
application/json
{
  • "entries": [
    ],
  • "total": 0,
  • "offset": 0,
  • "limit": 0
}

Shutdown a list of sensors.

Request Body schema: application/json
name
required
string (Name)
required
object (ShutdownAction)
required
OneShotOrder (object) or ScheduledOrder (object) (On)
required
Array of objects (Captures) non-empty

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "action": {
    },
  • "on": {
    },
  • "captures": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "name": "string",
  • "action": {
    },
  • "on": {
    },
  • "active": true,
  • "issued_by": 2147483647,
  • "issued_at": "2019-08-24T14:15:22Z",
  • "updated_by": 2147483647,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "tasks": [
    ]
}

Get shutdown order by ID

path Parameters
order_id
required
integer (Order Id) [ 0 .. 2147483647 ]

Responses

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "name": "string",
  • "action": {
    },
  • "on": {
    },
  • "active": true,
  • "issued_by": 2147483647,
  • "issued_at": "2019-08-24T14:15:22Z",
  • "updated_by": 2147483647,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "tasks": [
    ]
}

Get reboot orders

query Parameters
filter[order.name][contains]
Array of strings (Filter[Order.Name][Contains])
Example: filter[order.name][contains]=example*

Contains operator for field order.name (Fuzzy matching)

filter[order.name][notContains]
Array of strings (Filter[Order.Name][Notcontains])
Example: filter[order.name][notContains]=example*

Not Contains operator for field order.name (Fuzzy matching)

filter[order.kind][contains]
Array of strings (OrderKind)
Items Enum: "ONE_SHOT" "SCHEDULE"

Contains operator for field order.kind

filter[order.kind][notContains]
Array of strings (OrderKind)
Items Enum: "ONE_SHOT" "SCHEDULE"

Not Contains operator for field order.kind

filter[order.active][eq]
boolean (Filter[Order.Active][Eq])

Equal operator for field order.active

filter[order.created_by][contains]
Array of integers (Filter[Order.Created By][Contains]) [ items [ 0 .. 2147483647 ] ]

Contains operator for field order.created_by

filter[order.created_by][notContains]
Array of integers (Filter[Order.Created By][Notcontains]) [ items [ 0 .. 2147483647 ] ]

Not Contains operator for field order.created_by

filter[order.created_at][le]
string <date-time> (Filter[Order.Created At][Le])

Less or Equal operator for field order.created_at

filter[order.created_at][lt]
string <date-time> (Filter[Order.Created At][Lt])

Less Than operator for field order.created_at

filter[order.created_at][ge]
string <date-time> (Filter[Order.Created At][Ge])

Greater or Equal operator for field order.created_at

filter[order.created_at][gt]
string <date-time> (Filter[Order.Created At][Gt])

Greater Than operator for field order.created_at

filter[order.job.last_status][any]
Array of strings (JobStatus)
Items Enum: "in_progress" "cancelled" "success" "failure" "system_error"

Any operator for field order.job.last_status

filter[order.job.last_status][notAny]
Array of strings (JobStatus)
Items Enum: "in_progress" "cancelled" "success" "failure" "system_error"

Not any operator for field order.job.last_status

filter[order.start_at][le]
string <date-time> (Filter[Order.Start At][Le])

Less or Equal operator for field order.start_at

filter[order.start_at][lt]
string <date-time> (Filter[Order.Start At][Lt])

Less Than operator for field order.start_at

filter[order.start_at][ge]
string <date-time> (Filter[Order.Start At][Ge])

Greater or Equal operator for field order.start_at

filter[order.start_at][gt]
string <date-time> (Filter[Order.Start At][Gt])

Greater Than operator for field order.start_at

sort
string (Sort) ^(\-?((order\.kind)|(order\.action)|(order\.a...
Default: "-order.start_at,order.job.last_status"
offset
integer (Offset)
Default: 0
limit
integer (Limit)
Default: 50

Responses

Response samples

Content type
application/json
{
  • "entries": [
    ],
  • "total": 0,
  • "offset": 0,
  • "limit": 0
}

Reboot a list of sensors.

Request Body schema: application/json
name
required
string (Name)
required
object (RebootAction)
required
OneShotOrder (object) or ScheduledOrder (object) (On)
required
Array of objects (Captures) non-empty

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "action": {
    },
  • "on": {
    },
  • "captures": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "name": "string",
  • "action": {
    },
  • "on": {
    },
  • "active": true,
  • "issued_by": 2147483647,
  • "issued_at": "2019-08-24T14:15:22Z",
  • "updated_by": 2147483647,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "tasks": [
    ]
}

Get reboot order by ID

path Parameters
order_id
required
integer (Order Id) [ 0 .. 2147483647 ]

Responses

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "name": "string",
  • "action": {
    },
  • "on": {
    },
  • "active": true,
  • "issued_by": 2147483647,
  • "issued_at": "2019-08-24T14:15:22Z",
  • "updated_by": 2147483647,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "tasks": [
    ]
}

Get start capture orders

query Parameters
filter[order.name][contains]
Array of strings (Filter[Order.Name][Contains])
Example: filter[order.name][contains]=example*

Contains operator for field order.name (Fuzzy matching)

filter[order.name][notContains]
Array of strings (Filter[Order.Name][Notcontains])
Example: filter[order.name][notContains]=example*

Not Contains operator for field order.name (Fuzzy matching)

filter[order.kind][contains]
Array of strings (OrderKind)
Items Enum: "ONE_SHOT" "SCHEDULE"

Contains operator for field order.kind

filter[order.kind][notContains]
Array of strings (OrderKind)
Items Enum: "ONE_SHOT" "SCHEDULE"

Not Contains operator for field order.kind

filter[order.active][eq]
boolean (Filter[Order.Active][Eq])

Equal operator for field order.active

filter[order.created_by][contains]
Array of integers (Filter[Order.Created By][Contains]) [ items [ 0 .. 2147483647 ] ]

Contains operator for field order.created_by

filter[order.created_by][notContains]
Array of integers (Filter[Order.Created By][Notcontains]) [ items [ 0 .. 2147483647 ] ]

Not Contains operator for field order.created_by

filter[order.created_at][le]
string <date-time> (Filter[Order.Created At][Le])

Less or Equal operator for field order.created_at

filter[order.created_at][lt]
string <date-time> (Filter[Order.Created At][Lt])

Less Than operator for field order.created_at

filter[order.created_at][ge]
string <date-time> (Filter[Order.Created At][Ge])

Greater or Equal operator for field order.created_at

filter[order.created_at][gt]
string <date-time> (Filter[Order.Created At][Gt])

Greater Than operator for field order.created_at

filter[order.job.last_status][any]
Array of strings (JobStatus)
Items Enum: "in_progress" "cancelled" "success" "failure" "system_error"

Any operator for field order.job.last_status

filter[order.job.last_status][notAny]
Array of strings (JobStatus)
Items Enum: "in_progress" "cancelled" "success" "failure" "system_error"

Not any operator for field order.job.last_status

filter[order.start_at][le]
string <date-time> (Filter[Order.Start At][Le])

Less or Equal operator for field order.start_at

filter[order.start_at][lt]
string <date-time> (Filter[Order.Start At][Lt])

Less Than operator for field order.start_at

filter[order.start_at][ge]
string <date-time> (Filter[Order.Start At][Ge])

Greater or Equal operator for field order.start_at

filter[order.start_at][gt]
string <date-time> (Filter[Order.Start At][Gt])

Greater Than operator for field order.start_at

sort
string (Sort) ^(\-?((order\.kind)|(order\.action)|(order\.a...
Default: "-order.start_at,order.job.last_status"
offset
integer (Offset)
Default: 0
limit
integer (Limit)
Default: 50

Responses

Response samples

Content type
application/json
{
  • "entries": [
    ],
  • "total": 0,
  • "offset": 0,
  • "limit": 0
}

Start sending traffic data from a list of sensors.

Request Body schema: application/json
name
required
string (Name)
required
object (StartCaptureAction)
required
OneShotOrder (object) or ScheduledOrder (object) (On)
required
Array of objects (Captures) non-empty

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "action": {
    },
  • "on": {
    },
  • "captures": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "name": "string",
  • "action": {
    },
  • "on": {
    },
  • "active": true,
  • "issued_by": 2147483647,
  • "issued_at": "2019-08-24T14:15:22Z",
  • "updated_by": 2147483647,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "tasks": [
    ]
}

Get start capture order by ID

path Parameters
order_id
required
integer (Order Id) [ 0 .. 2147483647 ]

Responses

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "name": "string",
  • "action": {
    },
  • "on": {
    },
  • "active": true,
  • "issued_by": 2147483647,
  • "issued_at": "2019-08-24T14:15:22Z",
  • "updated_by": 2147483647,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "tasks": [
    ]
}

Get pause capture orders

query Parameters
filter[order.name][contains]
Array of strings (Filter[Order.Name][Contains])
Example: filter[order.name][contains]=example*

Contains operator for field order.name (Fuzzy matching)

filter[order.name][notContains]
Array of strings (Filter[Order.Name][Notcontains])
Example: filter[order.name][notContains]=example*

Not Contains operator for field order.name (Fuzzy matching)

filter[order.kind][contains]
Array of strings (OrderKind)
Items Enum: "ONE_SHOT" "SCHEDULE"

Contains operator for field order.kind

filter[order.kind][notContains]
Array of strings (OrderKind)
Items Enum: "ONE_SHOT" "SCHEDULE"

Not Contains operator for field order.kind

filter[order.active][eq]
boolean (Filter[Order.Active][Eq])

Equal operator for field order.active

filter[order.created_by][contains]
Array of integers (Filter[Order.Created By][Contains]) [ items [ 0 .. 2147483647 ] ]

Contains operator for field order.created_by

filter[order.created_by][notContains]
Array of integers (Filter[Order.Created By][Notcontains]) [ items [ 0 .. 2147483647 ] ]

Not Contains operator for field order.created_by

filter[order.created_at][le]
string <date-time> (Filter[Order.Created At][Le])

Less or Equal operator for field order.created_at

filter[order.created_at][lt]
string <date-time> (Filter[Order.Created At][Lt])

Less Than operator for field order.created_at

filter[order.created_at][ge]
string <date-time> (Filter[Order.Created At][Ge])

Greater or Equal operator for field order.created_at

filter[order.created_at][gt]
string <date-time> (Filter[Order.Created At][Gt])

Greater Than operator for field order.created_at

filter[order.job.last_status][any]
Array of strings (JobStatus)
Items Enum: "in_progress" "cancelled" "success" "failure" "system_error"

Any operator for field order.job.last_status

filter[order.job.last_status][notAny]
Array of strings (JobStatus)
Items Enum: "in_progress" "cancelled" "success" "failure" "system_error"

Not any operator for field order.job.last_status

filter[order.start_at][le]
string <date-time> (Filter[Order.Start At][Le])

Less or Equal operator for field order.start_at

filter[order.start_at][lt]
string <date-time> (Filter[Order.Start At][Lt])

Less Than operator for field order.start_at

filter[order.start_at][ge]
string <date-time> (Filter[Order.Start At][Ge])

Greater or Equal operator for field order.start_at

filter[order.start_at][gt]
string <date-time> (Filter[Order.Start At][Gt])

Greater Than operator for field order.start_at

sort
string (Sort) ^(\-?((order\.kind)|(order\.action)|(order\.a...
Default: "-order.start_at,order.job.last_status"
offset
integer (Offset)
Default: 0
limit
integer (Limit)
Default: 50

Responses

Response samples

Content type
application/json
{
  • "entries": [
    ],
  • "total": 0,
  • "offset": 0,
  • "limit": 0
}

Stop sending traffic data from a list of sensors.

Request Body schema: application/json
name
required
string (Name)
required
object (PauseCaptureAction)
required
OneShotOrder (object) or ScheduledOrder (object) (On)
required
Array of objects (Captures) non-empty

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "action": {
    },
  • "on": {
    },
  • "captures": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "name": "string",
  • "action": {
    },
  • "on": {
    },
  • "active": true,
  • "issued_by": 2147483647,
  • "issued_at": "2019-08-24T14:15:22Z",
  • "updated_by": 2147483647,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "tasks": [
    ]
}

Get pause capture order by ID

path Parameters
order_id
required
integer (Order Id) [ 0 .. 2147483647 ]

Responses

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "name": "string",
  • "action": {
    },
  • "on": {
    },
  • "active": true,
  • "issued_by": 2147483647,
  • "issued_at": "2019-08-24T14:15:22Z",
  • "updated_by": 2147483647,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "tasks": [
    ]
}

Get upgrade capture orders

query Parameters
filter[order.name][contains]
Array of strings (Filter[Order.Name][Contains])
Example: filter[order.name][contains]=example*

Contains operator for field order.name (Fuzzy matching)

filter[order.name][notContains]
Array of strings (Filter[Order.Name][Notcontains])
Example: filter[order.name][notContains]=example*

Not Contains operator for field order.name (Fuzzy matching)

filter[order.kind][contains]
Array of strings (OrderKind)
Items Enum: "ONE_SHOT" "SCHEDULE"

Contains operator for field order.kind

filter[order.kind][notContains]
Array of strings (OrderKind)
Items Enum: "ONE_SHOT" "SCHEDULE"

Not Contains operator for field order.kind

filter[order.active][eq]
boolean (Filter[Order.Active][Eq])

Equal operator for field order.active

filter[order.created_by][contains]
Array of integers (Filter[Order.Created By][Contains]) [ items [ 0 .. 2147483647 ] ]

Contains operator for field order.created_by

filter[order.created_by][notContains]
Array of integers (Filter[Order.Created By][Notcontains]) [ items [ 0 .. 2147483647 ] ]

Not Contains operator for field order.created_by

filter[order.created_at][le]
string <date-time> (Filter[Order.Created At][Le])

Less or Equal operator for field order.created_at

filter[order.created_at][lt]
string <date-time> (Filter[Order.Created At][Lt])

Less Than operator for field order.created_at

filter[order.created_at][ge]
string <date-time> (Filter[Order.Created At][Ge])

Greater or Equal operator for field order.created_at

filter[order.created_at][gt]
string <date-time> (Filter[Order.Created At][Gt])

Greater Than operator for field order.created_at

filter[order.job.last_status][any]
Array of strings (JobStatus)
Items Enum: "in_progress" "cancelled" "success" "failure" "system_error"

Any operator for field order.job.last_status

filter[order.job.last_status][notAny]
Array of strings (JobStatus)
Items Enum: "in_progress" "cancelled" "success" "failure" "system_error"

Not any operator for field order.job.last_status

filter[order.start_at][le]
string <date-time> (Filter[Order.Start At][Le])

Less or Equal operator for field order.start_at

filter[order.start_at][lt]
string <date-time> (Filter[Order.Start At][Lt])

Less Than operator for field order.start_at

filter[order.start_at][ge]
string <date-time> (Filter[Order.Start At][Ge])

Greater or Equal operator for field order.start_at

filter[order.start_at][gt]
string <date-time> (Filter[Order.Start At][Gt])

Greater Than operator for field order.start_at

sort
string (Sort) ^(\-?((order\.kind)|(order\.action)|(order\.a...
Default: "-order.start_at,order.job.last_status"
offset
integer (Offset)
Default: 0
limit
integer (Limit)
Default: 50

Responses

Response samples

Content type
application/json
{
  • "entries": [
    ],
  • "total": 0,
  • "offset": 0,
  • "limit": 0
}

Upgrade a list of sensors.

Request Body schema: application/json
name
required
string (Name)
required
object (UpgradeCaptureAction)
required
object (OneShotOrder)
required
Array of objects (Captures) non-empty

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "action": {
    },
  • "on": {
    },
  • "captures": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "name": "string",
  • "action": {
    },
  • "on": {
    },
  • "active": true,
  • "issued_by": 2147483647,
  • "issued_at": "2019-08-24T14:15:22Z",
  • "updated_by": 2147483647,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "tasks": [
    ]
}

Get upgrade capture order by ID

path Parameters
order_id
required
integer (Order Id) [ 0 .. 2147483647 ]

Responses

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "name": "string",
  • "action": {
    },
  • "on": {
    },
  • "active": true,
  • "issued_by": 2147483647,
  • "issued_at": "2019-08-24T14:15:22Z",
  • "updated_by": 2147483647,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "tasks": [
    ]
}

Get scheduled pcap orders

query Parameters
filter[order.name][contains]
Array of strings (Filter[Order.Name][Contains])
Example: filter[order.name][contains]=example*

Contains operator for field order.name (Fuzzy matching)

filter[order.name][notContains]
Array of strings (Filter[Order.Name][Notcontains])
Example: filter[order.name][notContains]=example*

Not Contains operator for field order.name (Fuzzy matching)

filter[order.kind][contains]
Array of strings (OrderKind)
Items Enum: "ONE_SHOT" "SCHEDULE"

Contains operator for field order.kind

filter[order.kind][notContains]
Array of strings (OrderKind)
Items Enum: "ONE_SHOT" "SCHEDULE"

Not Contains operator for field order.kind

filter[order.active][eq]
boolean (Filter[Order.Active][Eq])

Equal operator for field order.active

filter[order.created_by][contains]
Array of integers (Filter[Order.Created By][Contains]) [ items [ 0 .. 2147483647 ] ]

Contains operator for field order.created_by

filter[order.created_by][notContains]
Array of integers (Filter[Order.Created By][Notcontains]) [ items [ 0 .. 2147483647 ] ]

Not Contains operator for field order.created_by

filter[order.created_at][le]
string <date-time> (Filter[Order.Created At][Le])

Less or Equal operator for field order.created_at

filter[order.created_at][lt]
string <date-time> (Filter[Order.Created At][Lt])

Less Than operator for field order.created_at

filter[order.created_at][ge]
string <date-time> (Filter[Order.Created At][Ge])

Greater or Equal operator for field order.created_at

filter[order.created_at][gt]
string <date-time> (Filter[Order.Created At][Gt])

Greater Than operator for field order.created_at

filter[order.job.last_status][any]
Array of strings (JobStatus)
Items Enum: "in_progress" "cancelled" "success" "failure" "system_error"

Any operator for field order.job.last_status

filter[order.job.last_status][notAny]
Array of strings (JobStatus)
Items Enum: "in_progress" "cancelled" "success" "failure" "system_error"

Not any operator for field order.job.last_status

filter[order.start_at][le]
string <date-time> (Filter[Order.Start At][Le])

Less or Equal operator for field order.start_at

filter[order.start_at][lt]
string <date-time> (Filter[Order.Start At][Lt])

Less Than operator for field order.start_at

filter[order.start_at][ge]
string <date-time> (Filter[Order.Start At][Ge])

Greater or Equal operator for field order.start_at

filter[order.start_at][gt]
string <date-time> (Filter[Order.Start At][Gt])

Greater Than operator for field order.start_at

sort
string (Sort) ^(\-?((order\.kind)|(order\.action)|(order\.a...
Default: "-order.start_at,order.job.last_status"
offset
integer (Offset)
Default: 0
limit
integer (Limit)
Default: 50
filter[order.pcap.protocol][contains]
Array of strings (Metrics)
Items Enum: "tcp" "udp" "icmp"

Contains operator for field order.pcap.protocol

filter[order.pcap.protocol][notContains]
Array of strings (Metrics)
Items Enum: "tcp" "udp" "icmp"

Not Contains operator for field order.pcap.protocol

Responses

Response samples

Content type
application/json
{
  • "entries": [
    ],
  • "total": 0,
  • "offset": 0,
  • "limit": 0
}

Create pcap files on a list of sensors.

Request Body schema: application/json
name
required
string (Name)
required
object (PcapAction)
required
OneShotOrder (object) or ScheduledOrder (object) (On)
required
Array of objects (Captures) non-empty

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "action": {
    },
  • "on": {
    },
  • "captures": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "name": "string",
  • "action": {
    },
  • "on": {
    },
  • "active": true,
  • "issued_by": 2147483647,
  • "issued_at": "2019-08-24T14:15:22Z",
  • "updated_by": 2147483647,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "tasks": [
    ]
}

Get scheduled pcap order by ID

path Parameters
order_id
required
integer (Order Id) [ 0 .. 2147483647 ]

Responses

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "name": "string",
  • "action": {
    },
  • "on": {
    },
  • "active": true,
  • "issued_by": 2147483647,
  • "issued_at": "2019-08-24T14:15:22Z",
  • "updated_by": 2147483647,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "tasks": [
    ]
}

Get delete a pcap orders

query Parameters
filter[order.name][contains]
Array of strings (Filter[Order.Name][Contains])
Example: filter[order.name][contains]=example*

Contains operator for field order.name (Fuzzy matching)

filter[order.name][notContains]
Array of strings (Filter[Order.Name][Notcontains])
Example: filter[order.name][notContains]=example*

Not Contains operator for field order.name (Fuzzy matching)

filter[order.kind][contains]
Array of strings (OrderKind)
Items Enum: "ONE_SHOT" "SCHEDULE"

Contains operator for field order.kind

filter[order.kind][notContains]
Array of strings (OrderKind)
Items Enum: "ONE_SHOT" "SCHEDULE"

Not Contains operator for field order.kind

filter[order.active][eq]
boolean (Filter[Order.Active][Eq])

Equal operator for field order.active

filter[order.created_by][contains]
Array of integers (Filter[Order.Created By][Contains]) [ items [ 0 .. 2147483647 ] ]

Contains operator for field order.created_by

filter[order.created_by][notContains]
Array of integers (Filter[Order.Created By][Notcontains]) [ items [ 0 .. 2147483647 ] ]

Not Contains operator for field order.created_by

filter[order.created_at][le]
string <date-time> (Filter[Order.Created At][Le])

Less or Equal operator for field order.created_at

filter[order.created_at][lt]
string <date-time> (Filter[Order.Created At][Lt])

Less Than operator for field order.created_at

filter[order.created_at][ge]
string <date-time> (Filter[Order.Created At][Ge])

Greater or Equal operator for field order.created_at

filter[order.created_at][gt]
string <date-time> (Filter[Order.Created At][Gt])

Greater Than operator for field order.created_at

filter[order.job.last_status][any]
Array of strings (JobStatus)
Items Enum: "in_progress" "cancelled" "success" "failure" "system_error"

Any operator for field order.job.last_status

filter[order.job.last_status][notAny]
Array of strings (JobStatus)
Items Enum: "in_progress" "cancelled" "success" "failure" "system_error"

Not any operator for field order.job.last_status

filter[order.start_at][le]
string <date-time> (Filter[Order.Start At][Le])

Less or Equal operator for field order.start_at

filter[order.start_at][lt]
string <date-time> (Filter[Order.Start At][Lt])

Less Than operator for field order.start_at

filter[order.start_at][ge]
string <date-time> (Filter[Order.Start At][Ge])

Greater or Equal operator for field order.start_at

filter[order.start_at][gt]
string <date-time> (Filter[Order.Start At][Gt])

Greater Than operator for field order.start_at

sort
string (Sort) ^(\-?((order\.kind)|(order\.action)|(order\.a...
Default: "-order.start_at,order.job.last_status"
offset
integer (Offset)
Default: 0
limit
integer (Limit)
Default: 50
filter[pcap.order.id][contains]
Array of integers (Filter[Pcap.Order.Id][Contains]) [ items [ 0 .. 2147483647 ] ]

Contains operator for field pcap.order.id

filter[pcap.order.id][notContains]
Array of integers (Filter[Pcap.Order.Id][Notcontains]) [ items [ 0 .. 2147483647 ] ]

Not Contains operator for field pcap.order.id

filter[pcap.job.id][contains]
Array of strings <uuid> (Filter[Pcap.Job.Id][Contains])

Contains operator for field pcap.job.id

filter[pcap.job.id][notContains]
Array of strings <uuid> (Filter[Pcap.Job.Id][Notcontains])

Not Contains operator for field pcap.job.id

Responses

Response samples

Content type
application/json
{
  • "entries": [
    ],
  • "total": 0,
  • "offset": 0,
  • "limit": 0
}

Delete pcap files on a list of sensors.

Request Body schema: application/json
name
required
string (Name)
required
object (DeletePcapAction)
required
OneShotOrder (object) or ScheduledOrder (object) (On)
required
Array of objects (Captures) non-empty

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "action": {
    },
  • "on": {
    },
  • "captures": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "name": "string",
  • "action": {
    },
  • "on": {
    },
  • "active": true,
  • "issued_by": 2147483647,
  • "issued_at": "2019-08-24T14:15:22Z",
  • "updated_by": 2147483647,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "tasks": [
    ]
}

Get delete a pcap order by ID

path Parameters
order_id
required
integer (Order Id) [ 0 .. 2147483647 ]

Responses

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "name": "string",
  • "action": {
    },
  • "on": {
    },
  • "active": true,
  • "issued_by": 2147483647,
  • "issued_at": "2019-08-24T14:15:22Z",
  • "updated_by": 2147483647,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "tasks": [
    ]
}

Get delete a capture orders

query Parameters
filter[order.name][contains]
Array of strings (Filter[Order.Name][Contains])
Example: filter[order.name][contains]=example*

Contains operator for field order.name (Fuzzy matching)

filter[order.name][notContains]
Array of strings (Filter[Order.Name][Notcontains])
Example: filter[order.name][notContains]=example*

Not Contains operator for field order.name (Fuzzy matching)

filter[order.kind][contains]
Array of strings (OrderKind)
Items Enum: "ONE_SHOT" "SCHEDULE"

Contains operator for field order.kind

filter[order.kind][notContains]
Array of strings (OrderKind)
Items Enum: "ONE_SHOT" "SCHEDULE"

Not Contains operator for field order.kind

filter[order.active][eq]
boolean (Filter[Order.Active][Eq])

Equal operator for field order.active

filter[order.created_by][contains]
Array of integers (Filter[Order.Created By][Contains]) [ items [ 0 .. 2147483647 ] ]

Contains operator for field order.created_by

filter[order.created_by][notContains]
Array of integers (Filter[Order.Created By][Notcontains]) [ items [ 0 .. 2147483647 ] ]

Not Contains operator for field order.created_by

filter[order.created_at][le]
string <date-time> (Filter[Order.Created At][Le])

Less or Equal operator for field order.created_at

filter[order.created_at][lt]
string <date-time> (Filter[Order.Created At][Lt])

Less Than operator for field order.created_at

filter[order.created_at][ge]
string <date-time> (Filter[Order.Created At][Ge])

Greater or Equal operator for field order.created_at

filter[order.created_at][gt]
string <date-time> (Filter[Order.Created At][Gt])

Greater Than operator for field order.created_at

filter[order.job.last_status][any]
Array of strings (JobStatus)
Items Enum: "in_progress" "cancelled" "success" "failure" "system_error"

Any operator for field order.job.last_status

filter[order.job.last_status][notAny]
Array of strings (JobStatus)
Items Enum: "in_progress" "cancelled" "success" "failure" "system_error"

Not any operator for field order.job.last_status

filter[order.start_at][le]
string <date-time> (Filter[Order.Start At][Le])

Less or Equal operator for field order.start_at

filter[order.start_at][lt]
string <date-time> (Filter[Order.Start At][Lt])

Less Than operator for field order.start_at

filter[order.start_at][ge]
string <date-time> (Filter[Order.Start At][Ge])

Greater or Equal operator for field order.start_at

filter[order.start_at][gt]
string <date-time> (Filter[Order.Start At][Gt])

Greater Than operator for field order.start_at

sort
string (Sort) ^(\-?((order\.kind)|(order\.action)|(order\.a...
Default: "-order.start_at,order.job.last_status"
offset
integer (Offset)
Default: 0
limit
integer (Limit)
Default: 50

Responses

Response samples

Content type
application/json
{
  • "entries": [
    ],
  • "total": 0,
  • "offset": 0,
  • "limit": 0
}

Create an order delete a capture on sensor

Request Body schema: application/json
name
required
string (Name)
required
object (DeleteCaptureAction)
required
object (OneShotOrder)
required
Array of objects (Captures) non-empty

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "action": {
    },
  • "on": {
    },
  • "captures": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "name": "string",
  • "action": {
    },
  • "on": {
    },
  • "active": true,
  • "issued_by": 2147483647,
  • "issued_at": "2019-08-24T14:15:22Z",
  • "updated_by": 2147483647,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "tasks": [
    ]
}

Get delete a capture order by ID

path Parameters
order_id
required
integer (Order Id) [ 0 .. 2147483647 ]

Responses

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "name": "string",
  • "action": {
    },
  • "on": {
    },
  • "active": true,
  • "issued_by": 2147483647,
  • "issued_at": "2019-08-24T14:15:22Z",
  • "updated_by": 2147483647,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "tasks": [
    ]
}

Get start vpn orders

query Parameters
filter[order.name][contains]
Array of strings (Filter[Order.Name][Contains])
Example: filter[order.name][contains]=example*

Contains operator for field order.name (Fuzzy matching)

filter[order.name][notContains]
Array of strings (Filter[Order.Name][Notcontains])
Example: filter[order.name][notContains]=example*

Not Contains operator for field order.name (Fuzzy matching)

filter[order.kind][contains]
Array of strings (OrderKind)
Items Enum: "ONE_SHOT" "SCHEDULE"

Contains operator for field order.kind

filter[order.kind][notContains]
Array of strings (OrderKind)
Items Enum: "ONE_SHOT" "SCHEDULE"

Not Contains operator for field order.kind

filter[order.active][eq]
boolean (Filter[Order.Active][Eq])

Equal operator for field order.active

filter[order.created_by][contains]
Array of integers (Filter[Order.Created By][Contains]) [ items [ 0 .. 2147483647 ] ]

Contains operator for field order.created_by

filter[order.created_by][notContains]
Array of integers (Filter[Order.Created By][Notcontains]) [ items [ 0 .. 2147483647 ] ]

Not Contains operator for field order.created_by

filter[order.created_at][le]
string <date-time> (Filter[Order.Created At][Le])

Less or Equal operator for field order.created_at

filter[order.created_at][lt]
string <date-time> (Filter[Order.Created At][Lt])

Less Than operator for field order.created_at

filter[order.created_at][ge]
string <date-time> (Filter[Order.Created At][Ge])

Greater or Equal operator for field order.created_at

filter[order.created_at][gt]
string <date-time> (Filter[Order.Created At][Gt])

Greater Than operator for field order.created_at

filter[order.job.last_status][any]
Array of strings (JobStatus)
Items Enum: "in_progress" "cancelled" "success" "failure" "system_error"

Any operator for field order.job.last_status

filter[order.job.last_status][notAny]
Array of strings (JobStatus)
Items Enum: "in_progress" "cancelled" "success" "failure" "system_error"

Not any operator for field order.job.last_status

filter[order.start_at][le]
string <date-time> (Filter[Order.Start At][Le])

Less or Equal operator for field order.start_at

filter[order.start_at][lt]
string <date-time> (Filter[Order.Start At][Lt])

Less Than operator for field order.start_at

filter[order.start_at][ge]
string <date-time> (Filter[Order.Start At][Ge])

Greater or Equal operator for field order.start_at

filter[order.start_at][gt]
string <date-time> (Filter[Order.Start At][Gt])

Greater Than operator for field order.start_at

sort
string (Sort) ^(\-?((order\.kind)|(order\.action)|(order\.a...
Default: "-order.start_at,order.job.last_status"
offset
integer (Offset)
Default: 0
limit
integer (Limit)
Default: 50

Responses

Response samples

Content type
application/json
{
  • "entries": [
    ],
  • "total": 0,
  • "offset": 0,
  • "limit": 0
}

Enable VPN on a list of sensors.

Request Body schema: application/json
name
required
string (Name)
required
object (StartVPNAction)
required
object (OneShotOrder)
required
Array of objects (Captures) non-empty

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "action": {
    },
  • "on": {
    },
  • "captures": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "name": "string",
  • "action": {
    },
  • "on": {
    },
  • "active": true,
  • "issued_by": 2147483647,
  • "issued_at": "2019-08-24T14:15:22Z",
  • "updated_by": 2147483647,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "tasks": [
    ]
}

Get start vpn order by ID

path Parameters
order_id
required
integer (Order Id) [ 0 .. 2147483647 ]

Responses

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "name": "string",
  • "action": {
    },
  • "on": {
    },
  • "active": true,
  • "issued_by": 2147483647,
  • "issued_at": "2019-08-24T14:15:22Z",
  • "updated_by": 2147483647,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "tasks": [
    ]
}

Get stop vpn orders

query Parameters
filter[order.name][contains]
Array of strings (Filter[Order.Name][Contains])
Example: filter[order.name][contains]=example*

Contains operator for field order.name (Fuzzy matching)

filter[order.name][notContains]
Array of strings (Filter[Order.Name][Notcontains])
Example: filter[order.name][notContains]=example*

Not Contains operator for field order.name (Fuzzy matching)

filter[order.kind][contains]
Array of strings (OrderKind)
Items Enum: "ONE_SHOT" "SCHEDULE"

Contains operator for field order.kind

filter[order.kind][notContains]
Array of strings (OrderKind)
Items Enum: "ONE_SHOT" "SCHEDULE"

Not Contains operator for field order.kind

filter[order.active][eq]
boolean (Filter[Order.Active][Eq])

Equal operator for field order.active

filter[order.created_by][contains]
Array of integers (Filter[Order.Created By][Contains]) [ items [ 0 .. 2147483647 ] ]

Contains operator for field order.created_by

filter[order.created_by][notContains]
Array of integers (Filter[Order.Created By][Notcontains]) [ items [ 0 .. 2147483647 ] ]

Not Contains operator for field order.created_by

filter[order.created_at][le]
string <date-time> (Filter[Order.Created At][Le])

Less or Equal operator for field order.created_at

filter[order.created_at][lt]
string <date-time> (Filter[Order.Created At][Lt])

Less Than operator for field order.created_at

filter[order.created_at][ge]
string <date-time> (Filter[Order.Created At][Ge])

Greater or Equal operator for field order.created_at

filter[order.created_at][gt]
string <date-time> (Filter[Order.Created At][Gt])

Greater Than operator for field order.created_at

filter[order.job.last_status][any]
Array of strings (JobStatus)
Items Enum: "in_progress" "cancelled" "success" "failure" "system_error"

Any operator for field order.job.last_status

filter[order.job.last_status][notAny]
Array of strings (JobStatus)
Items Enum: "in_progress" "cancelled" "success" "failure" "system_error"

Not any operator for field order.job.last_status

filter[order.start_at][le]
string <date-time> (Filter[Order.Start At][Le])

Less or Equal operator for field order.start_at

filter[order.start_at][lt]
string <date-time> (Filter[Order.Start At][Lt])

Less Than operator for field order.start_at

filter[order.start_at][ge]
string <date-time> (Filter[Order.Start At][Ge])

Greater or Equal operator for field order.start_at

filter[order.start_at][gt]
string <date-time> (Filter[Order.Start At][Gt])

Greater Than operator for field order.start_at

sort
string (Sort) ^(\-?((order\.kind)|(order\.action)|(order\.a...
Default: "-order.start_at,order.job.last_status"
offset
integer (Offset)
Default: 0
limit
integer (Limit)
Default: 50

Responses

Response samples

Content type
application/json
{
  • "entries": [
    ],
  • "total": 0,
  • "offset": 0,
  • "limit": 0
}

Disable VPN on a list of sensors.

Request Body schema: application/json
name
required
string (Name)
required
object (StopVPNAction)
required
object (OneShotOrder)
required
Array of objects (Captures) non-empty

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "action": {
    },
  • "on": {
    },
  • "captures": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "name": "string",
  • "action": {
    },
  • "on": {
    },
  • "active": true,
  • "issued_by": 2147483647,
  • "issued_at": "2019-08-24T14:15:22Z",
  • "updated_by": 2147483647,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "tasks": [
    ]
}

Get stop vpn order by ID

path Parameters
order_id
required
integer (Order Id) [ 0 .. 2147483647 ]

Responses

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "name": "string",
  • "action": {
    },
  • "on": {
    },
  • "active": true,
  • "issued_by": 2147483647,
  • "issued_at": "2019-08-24T14:15:22Z",
  • "updated_by": 2147483647,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "tasks": [
    ]
}

Get a list of orders

query Parameters
filter[order.name][contains]
Array of strings (Filter[Order.Name][Contains])
Example: filter[order.name][contains]=example*

Contains operator for field order.name (Fuzzy matching)

filter[order.name][notContains]
Array of strings (Filter[Order.Name][Notcontains])
Example: filter[order.name][notContains]=example*

Not Contains operator for field order.name (Fuzzy matching)

filter[order.kind][contains]
Array of strings (OrderKind)
Items Enum: "ONE_SHOT" "SCHEDULE"

Contains operator for field order.kind

filter[order.kind][notContains]
Array of strings (OrderKind)
Items Enum: "ONE_SHOT" "SCHEDULE"

Not Contains operator for field order.kind

filter[order.active][eq]
boolean (Filter[Order.Active][Eq])

Equal operator for field order.active

filter[order.created_by][contains]
Array of integers (Filter[Order.Created By][Contains]) [ items [ 0 .. 2147483647 ] ]

Contains operator for field order.created_by

filter[order.created_by][notContains]
Array of integers (Filter[Order.Created By][Notcontains]) [ items [ 0 .. 2147483647 ] ]

Not Contains operator for field order.created_by

filter[order.created_at][le]
string <date-time> (Filter[Order.Created At][Le])

Less or Equal operator for field order.created_at

filter[order.created_at][lt]
string <date-time> (Filter[Order.Created At][Lt])

Less Than operator for field order.created_at

filter[order.created_at][ge]
string <date-time> (Filter[Order.Created At][Ge])

Greater or Equal operator for field order.created_at

filter[order.created_at][gt]
string <date-time> (Filter[Order.Created At][Gt])

Greater Than operator for field order.created_at

filter[order.job.last_status][any]
Array of strings (JobStatus)
Items Enum: "in_progress" "cancelled" "success" "failure" "system_error"

Any operator for field order.job.last_status

filter[order.job.last_status][notAny]
Array of strings (JobStatus)
Items Enum: "in_progress" "cancelled" "success" "failure" "system_error"

Not any operator for field order.job.last_status

filter[order.start_at][le]
string <date-time> (Filter[Order.Start At][Le])

Less or Equal operator for field order.start_at

filter[order.start_at][lt]
string <date-time> (Filter[Order.Start At][Lt])

Less Than operator for field order.start_at

filter[order.start_at][ge]
string <date-time> (Filter[Order.Start At][Ge])

Greater or Equal operator for field order.start_at

filter[order.start_at][gt]
string <date-time> (Filter[Order.Start At][Gt])

Greater Than operator for field order.start_at

sort
string (Sort) ^(\-?((order\.kind)|(order\.action)|(order\.a...
Default: "-order.start_at,order.job.last_status"
offset
integer (Offset)
Default: 0
limit
integer (Limit)
Default: 50
filter[order.action][contains]
Array of strings (OrderActionKind)
Items Enum: "SHUTDOWN" "REBOOT" "START_CAPTURE" "PAUSE_CAPTURE" "UPGRADE_CAPTURE" "START_VPN" "STOP_VPN" "PCAP" "DELETE_PCAP" "DELETE_CAPTURE"

Contains operator for field order.action

filter[order.action][notContains]
Array of strings (OrderActionKind)
Items Enum: "SHUTDOWN" "REBOOT" "START_CAPTURE" "PAUSE_CAPTURE" "UPGRADE_CAPTURE" "START_VPN" "STOP_VPN" "PCAP" "DELETE_PCAP" "DELETE_CAPTURE"

Not Contains operator for field order.action

Responses

Response samples

Content type
application/json
{
  • "entries": [
    ],
  • "total": 0,
  • "offset": 0,
  • "limit": 0
}

Update an order

Request Body schema: application/json
id
required
integer (Id) [ 0 .. 2147483647 ]

ID of the order.

active
required
boolean (Active)

Activate or deactivate an order to be run on a sensor.

Responses

Request samples

Content type
application/json
{
  • "id": 2147483647,
  • "active": true
}

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "name": "string",
  • "action": {
    },
  • "on": {
    },
  • "active": true,
  • "issued_by": 2147483647,
  • "issued_at": "2019-08-24T14:15:22Z",
  • "updated_by": 2147483647,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "tasks": [
    ]
}

Get an order

path Parameters
id
required
integer (Id) [ 0 .. 2147483647 ]

Responses

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "name": "string",
  • "action": {
    },
  • "on": {
    },
  • "active": true,
  • "issued_by": 2147483647,
  • "issued_at": "2019-08-24T14:15:22Z",
  • "updated_by": 2147483647,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "tasks": [
    ]
}

Get available orders for releases

Retrieve list of available orders for a capture.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

task

Get shutdown tasks

query Parameters
filter[order.kind][contains]
Array of strings (OrderKind)
Items Enum: "ONE_SHOT" "SCHEDULE"

Contains operator for field order.kind

filter[order.kind][notContains]
Array of strings (OrderKind)
Items Enum: "ONE_SHOT" "SCHEDULE"

Not Contains operator for field order.kind

filter[order.active][eq]
boolean (Filter[Order.Active][Eq])

Equal operator for field order.active

filter[order.created_at][le]
string <date-time> (Filter[Order.Created At][Le])

Less or Equal operator for field order.created_at

filter[order.created_at][lt]
string <date-time> (Filter[Order.Created At][Lt])

Less Than operator for field order.created_at

filter[order.created_at][ge]
string <date-time> (Filter[Order.Created At][Ge])

Greater or Equal operator for field order.created_at

filter[order.created_at][gt]
string <date-time> (Filter[Order.Created At][Gt])

Greater Than operator for field order.created_at

filter[task.capture.id][contains]
Array of integers (Filter[Task.Capture.Id][Contains])

Contains operator for field task.capture.id

filter[task.capture.id][notContains]
Array of integers (Filter[Task.Capture.Id][Notcontains])

Not Contains operator for field task.capture.id

filter[task.capture.id][le]
integer (Filter[Task.Capture.Id][Le])

Less or Equal operator for field task.capture.id

filter[task.capture.id][lt]
integer (Filter[Task.Capture.Id][Lt])

Less Than operator for field task.capture.id

filter[task.capture.id][ge]
integer (Filter[Task.Capture.Id][Ge])

Greater or Equal operator for field task.capture.id

filter[task.capture.id][gt]
integer (Filter[Task.Capture.Id][Gt])

Greater Than operator for field task.capture.id

sort
string (Sort) ^(\-?((order\.kind)|(order\.action)|(order\.a...
Default: "-order.created_at"
offset
integer (Offset)
Default: 0
limit
integer (Limit)
Default: 50

Responses

Response samples

Content type
application/json
{
  • "entries": [
    ],
  • "total": 0,
  • "offset": 0,
  • "limit": 0
}

Get reboot tasks

query Parameters
filter[order.kind][contains]
Array of strings (OrderKind)
Items Enum: "ONE_SHOT" "SCHEDULE"

Contains operator for field order.kind

filter[order.kind][notContains]
Array of strings (OrderKind)
Items Enum: "ONE_SHOT" "SCHEDULE"

Not Contains operator for field order.kind

filter[order.active][eq]
boolean (Filter[Order.Active][Eq])

Equal operator for field order.active

filter[order.created_at][le]
string <date-time> (Filter[Order.Created At][Le])

Less or Equal operator for field order.created_at

filter[order.created_at][lt]
string <date-time> (Filter[Order.Created At][Lt])

Less Than operator for field order.created_at

filter[order.created_at][ge]
string <date-time> (Filter[Order.Created At][Ge])

Greater or Equal operator for field order.created_at

filter[order.created_at][gt]
string <date-time> (Filter[Order.Created At][Gt])

Greater Than operator for field order.created_at

filter[task.capture.id][contains]
Array of integers (Filter[Task.Capture.Id][Contains])

Contains operator for field task.capture.id

filter[task.capture.id][notContains]
Array of integers (Filter[Task.Capture.Id][Notcontains])

Not Contains operator for field task.capture.id

filter[task.capture.id][le]
integer (Filter[Task.Capture.Id][Le])

Less or Equal operator for field task.capture.id

filter[task.capture.id][lt]
integer (Filter[Task.Capture.Id][Lt])

Less Than operator for field task.capture.id

filter[task.capture.id][ge]
integer (Filter[Task.Capture.Id][Ge])

Greater or Equal operator for field task.capture.id

filter[task.capture.id][gt]
integer (Filter[Task.Capture.Id][Gt])

Greater Than operator for field task.capture.id

sort
string (Sort) ^(\-?((order\.kind)|(order\.action)|(order\.a...
Default: "-order.created_at"
offset
integer (Offset)
Default: 0
limit
integer (Limit)
Default: 50

Responses

Response samples

Content type
application/json
{
  • "entries": [
    ],
  • "total": 0,
  • "offset": 0,
  • "limit": 0
}

Get start capture tasks

query Parameters
filter[order.kind][contains]
Array of strings (OrderKind)
Items Enum: "ONE_SHOT" "SCHEDULE"

Contains operator for field order.kind

filter[order.kind][notContains]
Array of strings (OrderKind)
Items Enum: "ONE_SHOT" "SCHEDULE"

Not Contains operator for field order.kind

filter[order.active][eq]
boolean (Filter[Order.Active][Eq])

Equal operator for field order.active

filter[order.created_at][le]
string <date-time> (Filter[Order.Created At][Le])

Less or Equal operator for field order.created_at

filter[order.created_at][lt]
string <date-time> (Filter[Order.Created At][Lt])

Less Than operator for field order.created_at

filter[order.created_at][ge]
string <date-time> (Filter[Order.Created At][Ge])

Greater or Equal operator for field order.created_at

filter[order.created_at][gt]
string <date-time> (Filter[Order.Created At][Gt])

Greater Than operator for field order.created_at

filter[task.capture.id][contains]
Array of integers (Filter[Task.Capture.Id][Contains])

Contains operator for field task.capture.id

filter[task.capture.id][notContains]
Array of integers (Filter[Task.Capture.Id][Notcontains])

Not Contains operator for field task.capture.id

filter[task.capture.id][le]
integer (Filter[Task.Capture.Id][Le])

Less or Equal operator for field task.capture.id

filter[task.capture.id][lt]
integer (Filter[Task.Capture.Id][Lt])

Less Than operator for field task.capture.id

filter[task.capture.id][ge]
integer (Filter[Task.Capture.Id][Ge])

Greater or Equal operator for field task.capture.id

filter[task.capture.id][gt]
integer (Filter[Task.Capture.Id][Gt])

Greater Than operator for field task.capture.id

sort
string (Sort) ^(\-?((order\.kind)|(order\.action)|(order\.a...
Default: "-order.created_at"
offset
integer (Offset)
Default: 0
limit
integer (Limit)
Default: 50

Responses

Response samples

Content type
application/json
{
  • "entries": [
    ],
  • "total": 0,
  • "offset": 0,
  • "limit": 0
}

Get pause capture tasks

query Parameters
filter[order.kind][contains]
Array of strings (OrderKind)
Items Enum: "ONE_SHOT" "SCHEDULE"

Contains operator for field order.kind

filter[order.kind][notContains]
Array of strings (OrderKind)
Items Enum: "ONE_SHOT" "SCHEDULE"

Not Contains operator for field order.kind

filter[order.active][eq]
boolean (Filter[Order.Active][Eq])

Equal operator for field order.active

filter[order.created_at][le]
string <date-time> (Filter[Order.Created At][Le])

Less or Equal operator for field order.created_at

filter[order.created_at][lt]
string <date-time> (Filter[Order.Created At][Lt])

Less Than operator for field order.created_at

filter[order.created_at][ge]
string <date-time> (Filter[Order.Created At][Ge])

Greater or Equal operator for field order.created_at

filter[order.created_at][gt]
string <date-time> (Filter[Order.Created At][Gt])

Greater Than operator for field order.created_at

filter[task.capture.id][contains]
Array of integers (Filter[Task.Capture.Id][Contains])

Contains operator for field task.capture.id

filter[task.capture.id][notContains]
Array of integers (Filter[Task.Capture.Id][Notcontains])

Not Contains operator for field task.capture.id

filter[task.capture.id][le]
integer (Filter[Task.Capture.Id][Le])

Less or Equal operator for field task.capture.id

filter[task.capture.id][lt]
integer (Filter[Task.Capture.Id][Lt])

Less Than operator for field task.capture.id

filter[task.capture.id][ge]
integer (Filter[Task.Capture.Id][Ge])

Greater or Equal operator for field task.capture.id

filter[task.capture.id][gt]
integer (Filter[Task.Capture.Id][Gt])

Greater Than operator for field task.capture.id

sort
string (Sort) ^(\-?((order\.kind)|(order\.action)|(order\.a...
Default: "-order.created_at"
offset
integer (Offset)
Default: 0
limit
integer (Limit)
Default: 50

Responses

Response samples

Content type
application/json
{
  • "entries": [
    ],
  • "total": 0,
  • "offset": 0,
  • "limit": 0
}

Get upgrade capture tasks

query Parameters
filter[order.kind][contains]
Array of strings (OrderKind)
Items Enum: "ONE_SHOT" "SCHEDULE"

Contains operator for field order.kind

filter[order.kind][notContains]
Array of strings (OrderKind)
Items Enum: "ONE_SHOT" "SCHEDULE"

Not Contains operator for field order.kind

filter[order.active][eq]
boolean (Filter[Order.Active][Eq])

Equal operator for field order.active

filter[order.created_at][le]
string <date-time> (Filter[Order.Created At][Le])

Less or Equal operator for field order.created_at

filter[order.created_at][lt]
string <date-time> (Filter[Order.Created At][Lt])

Less Than operator for field order.created_at

filter[order.created_at][ge]
string <date-time> (Filter[Order.Created At][Ge])

Greater or Equal operator for field order.created_at

filter[order.created_at][gt]
string <date-time> (Filter[Order.Created At][Gt])

Greater Than operator for field order.created_at

filter[task.capture.id][contains]
Array of integers (Filter[Task.Capture.Id][Contains])

Contains operator for field task.capture.id

filter[task.capture.id][notContains]
Array of integers (Filter[Task.Capture.Id][Notcontains])

Not Contains operator for field task.capture.id

filter[task.capture.id][le]
integer (Filter[Task.Capture.Id][Le])

Less or Equal operator for field task.capture.id

filter[task.capture.id][lt]
integer (Filter[Task.Capture.Id][Lt])

Less Than operator for field task.capture.id

filter[task.capture.id][ge]
integer (Filter[Task.Capture.Id][Ge])

Greater or Equal operator for field task.capture.id

filter[task.capture.id][gt]
integer (Filter[Task.Capture.Id][Gt])

Greater Than operator for field task.capture.id

sort
string (Sort) ^(\-?((order\.kind)|(order\.action)|(order\.a...
Default: "-order.created_at"
offset
integer (Offset)
Default: 0
limit
integer (Limit)
Default: 50

Responses

Response samples

Content type
application/json
{
  • "entries": [
    ],
  • "total": 0,
  • "offset": 0,
  • "limit": 0
}

Get scheduled pcap tasks

query Parameters
filter[order.kind][contains]
Array of strings (OrderKind)
Items Enum: "ONE_SHOT" "SCHEDULE"

Contains operator for field order.kind

filter[order.kind][notContains]
Array of strings (OrderKind)
Items Enum: "ONE_SHOT" "SCHEDULE"

Not Contains operator for field order.kind

filter[order.active][eq]
boolean (Filter[Order.Active][Eq])

Equal operator for field order.active

filter[order.created_at][le]
string <date-time> (Filter[Order.Created At][Le])

Less or Equal operator for field order.created_at

filter[order.created_at][lt]
string <date-time> (Filter[Order.Created At][Lt])

Less Than operator for field order.created_at

filter[order.created_at][ge]
string <date-time> (Filter[Order.Created At][Ge])

Greater or Equal operator for field order.created_at

filter[order.created_at][gt]
string <date-time> (Filter[Order.Created At][Gt])

Greater Than operator for field order.created_at

filter[task.capture.id][contains]
Array of integers (Filter[Task.Capture.Id][Contains])

Contains operator for field task.capture.id

filter[task.capture.id][notContains]
Array of integers (Filter[Task.Capture.Id][Notcontains])

Not Contains operator for field task.capture.id

filter[task.capture.id][le]
integer (Filter[Task.Capture.Id][Le])

Less or Equal operator for field task.capture.id

filter[task.capture.id][lt]
integer (Filter[Task.Capture.Id][Lt])

Less Than operator for field task.capture.id

filter[task.capture.id][ge]
integer (Filter[Task.Capture.Id][Ge])

Greater or Equal operator for field task.capture.id

filter[task.capture.id][gt]
integer (Filter[Task.Capture.Id][Gt])

Greater Than operator for field task.capture.id

sort
string (Sort) ^(\-?((order\.kind)|(order\.action)|(order\.a...
Default: "-order.created_at"
offset
integer (Offset)
Default: 0
limit
integer (Limit)
Default: 50

Responses

Response samples

Content type
application/json
{
  • "entries": [
    ],
  • "total": 0,
  • "offset": 0,
  • "limit": 0
}

Get delete a pcap tasks

query Parameters
filter[order.kind][contains]
Array of strings (OrderKind)
Items Enum: "ONE_SHOT" "SCHEDULE"

Contains operator for field order.kind

filter[order.kind][notContains]
Array of strings (OrderKind)
Items Enum: "ONE_SHOT" "SCHEDULE"

Not Contains operator for field order.kind

filter[order.active][eq]
boolean (Filter[Order.Active][Eq])

Equal operator for field order.active

filter[order.created_at][le]
string <date-time> (Filter[Order.Created At][Le])

Less or Equal operator for field order.created_at

filter[order.created_at][lt]
string <date-time> (Filter[Order.Created At][Lt])

Less Than operator for field order.created_at

filter[order.created_at][ge]
string <date-time> (Filter[Order.Created At][Ge])

Greater or Equal operator for field order.created_at

filter[order.created_at][gt]
string <date-time> (Filter[Order.Created At][Gt])

Greater Than operator for field order.created_at

filter[task.capture.id][contains]
Array of integers (Filter[Task.Capture.Id][Contains])

Contains operator for field task.capture.id

filter[task.capture.id][notContains]
Array of integers (Filter[Task.Capture.Id][Notcontains])

Not Contains operator for field task.capture.id

filter[task.capture.id][le]
integer (Filter[Task.Capture.Id][Le])

Less or Equal operator for field task.capture.id

filter[task.capture.id][lt]
integer (Filter[Task.Capture.Id][Lt])

Less Than operator for field task.capture.id

filter[task.capture.id][ge]
integer (Filter[Task.Capture.Id][Ge])

Greater or Equal operator for field task.capture.id

filter[task.capture.id][gt]
integer (Filter[Task.Capture.Id][Gt])

Greater Than operator for field task.capture.id

sort
string (Sort) ^(\-?((order\.kind)|(order\.action)|(order\.a...
Default: "-order.created_at"
offset
integer (Offset)
Default: 0
limit
integer (Limit)
Default: 50

Responses

Response samples

Content type
application/json
{
  • "entries": [
    ],
  • "total": 0,
  • "offset": 0,
  • "limit": 0
}

Get delete a capture tasks

query Parameters
filter[order.kind][contains]
Array of strings (OrderKind)
Items Enum: "ONE_SHOT" "SCHEDULE"

Contains operator for field order.kind

filter[order.kind][notContains]
Array of strings (OrderKind)
Items Enum: "ONE_SHOT" "SCHEDULE"

Not Contains operator for field order.kind

filter[order.active][eq]
boolean (Filter[Order.Active][Eq])

Equal operator for field order.active

filter[order.created_at][le]
string <date-time> (Filter[Order.Created At][Le])

Less or Equal operator for field order.created_at

filter[order.created_at][lt]
string <date-time> (Filter[Order.Created At][Lt])

Less Than operator for field order.created_at

filter[order.created_at][ge]
string <date-time> (Filter[Order.Created At][Ge])

Greater or Equal operator for field order.created_at

filter[order.created_at][gt]
string <date-time> (Filter[Order.Created At][Gt])

Greater Than operator for field order.created_at

filter[task.capture.id][contains]
Array of integers (Filter[Task.Capture.Id][Contains])

Contains operator for field task.capture.id

filter[task.capture.id][notContains]
Array of integers (Filter[Task.Capture.Id][Notcontains])

Not Contains operator for field task.capture.id

filter[task.capture.id][le]
integer (Filter[Task.Capture.Id][Le])

Less or Equal operator for field task.capture.id

filter[task.capture.id][lt]
integer (Filter[Task.Capture.Id][Lt])

Less Than operator for field task.capture.id

filter[task.capture.id][ge]
integer (Filter[Task.Capture.Id][Ge])

Greater or Equal operator for field task.capture.id

filter[task.capture.id][gt]
integer (Filter[Task.Capture.Id][Gt])

Greater Than operator for field task.capture.id

sort
string (Sort) ^(\-?((order\.kind)|(order\.action)|(order\.a...
Default: "-order.created_at"
offset
integer (Offset)
Default: 0
limit
integer (Limit)
Default: 50

Responses

Response samples

Content type
application/json
{
  • "entries": [
    ],
  • "total": 0,
  • "offset": 0,
  • "limit": 0
}

Get start vpn tasks

query Parameters
filter[order.kind][contains]
Array of strings (OrderKind)
Items Enum: "ONE_SHOT" "SCHEDULE"

Contains operator for field order.kind

filter[order.kind][notContains]
Array of strings (OrderKind)
Items Enum: "ONE_SHOT" "SCHEDULE"

Not Contains operator for field order.kind

filter[order.active][eq]
boolean (Filter[Order.Active][Eq])

Equal operator for field order.active

filter[order.created_at][le]
string <date-time> (Filter[Order.Created At][Le])

Less or Equal operator for field order.created_at

filter[order.created_at][lt]
string <date-time> (Filter[Order.Created At][Lt])

Less Than operator for field order.created_at

filter[order.created_at][ge]
string <date-time> (Filter[Order.Created At][Ge])

Greater or Equal operator for field order.created_at

filter[order.created_at][gt]
string <date-time> (Filter[Order.Created At][Gt])

Greater Than operator for field order.created_at

filter[task.capture.id][contains]
Array of integers (Filter[Task.Capture.Id][Contains])

Contains operator for field task.capture.id

filter[task.capture.id][notContains]
Array of integers (Filter[Task.Capture.Id][Notcontains])

Not Contains operator for field task.capture.id

filter[task.capture.id][le]
integer (Filter[Task.Capture.Id][Le])

Less or Equal operator for field task.capture.id

filter[task.capture.id][lt]
integer (Filter[Task.Capture.Id][Lt])

Less Than operator for field task.capture.id

filter[task.capture.id][ge]
integer (Filter[Task.Capture.Id][Ge])

Greater or Equal operator for field task.capture.id

filter[task.capture.id][gt]
integer (Filter[Task.Capture.Id][Gt])

Greater Than operator for field task.capture.id

sort
string (Sort) ^(\-?((order\.kind)|(order\.action)|(order\.a...
Default: "-order.created_at"
offset
integer (Offset)
Default: 0
limit
integer (Limit)
Default: 50

Responses

Response samples

Content type
application/json
{
  • "entries": [
    ],
  • "total": 0,
  • "offset": 0,
  • "limit": 0
}

Get stop vpn tasks

query Parameters
filter[order.kind][contains]
Array of strings (OrderKind)
Items Enum: "ONE_SHOT" "SCHEDULE"

Contains operator for field order.kind

filter[order.kind][notContains]
Array of strings (OrderKind)
Items Enum: "ONE_SHOT" "SCHEDULE"

Not Contains operator for field order.kind

filter[order.active][eq]
boolean (Filter[Order.Active][Eq])

Equal operator for field order.active

filter[order.created_at][le]
string <date-time> (Filter[Order.Created At][Le])

Less or Equal operator for field order.created_at

filter[order.created_at][lt]
string <date-time> (Filter[Order.Created At][Lt])

Less Than operator for field order.created_at

filter[order.created_at][ge]
string <date-time> (Filter[Order.Created At][Ge])

Greater or Equal operator for field order.created_at

filter[order.created_at][gt]
string <date-time> (Filter[Order.Created At][Gt])

Greater Than operator for field order.created_at

filter[task.capture.id][contains]
Array of integers (Filter[Task.Capture.Id][Contains])

Contains operator for field task.capture.id

filter[task.capture.id][notContains]
Array of integers (Filter[Task.Capture.Id][Notcontains])

Not Contains operator for field task.capture.id

filter[task.capture.id][le]
integer (Filter[Task.Capture.Id][Le])

Less or Equal operator for field task.capture.id

filter[task.capture.id][lt]
integer (Filter[Task.Capture.Id][Lt])

Less Than operator for field task.capture.id

filter[task.capture.id][ge]
integer (Filter[Task.Capture.Id][Ge])

Greater or Equal operator for field task.capture.id

filter[task.capture.id][gt]
integer (Filter[Task.Capture.Id][Gt])

Greater Than operator for field task.capture.id

sort
string (Sort) ^(\-?((order\.kind)|(order\.action)|(order\.a...
Default: "-order.created_at"
offset
integer (Offset)
Default: 0
limit
integer (Limit)
Default: 50

Responses

Response samples

Content type
application/json
{
  • "entries": [
    ],
  • "total": 0,
  • "offset": 0,
  • "limit": 0
}

Get a list of tasks

query Parameters
filter[order.action][contains]
Array of strings (OrderActionKind)
Items Enum: "SHUTDOWN" "REBOOT" "START_CAPTURE" "PAUSE_CAPTURE" "UPGRADE_CAPTURE" "START_VPN" "STOP_VPN" "PCAP" "DELETE_PCAP" "DELETE_CAPTURE"

Contains operator for field order.action

filter[order.action][notContains]
Array of strings (OrderActionKind)
Items Enum: "SHUTDOWN" "REBOOT" "START_CAPTURE" "PAUSE_CAPTURE" "UPGRADE_CAPTURE" "START_VPN" "STOP_VPN" "PCAP" "DELETE_PCAP" "DELETE_CAPTURE"

Not Contains operator for field order.action

filter[order.kind][contains]
Array of strings (OrderKind)
Items Enum: "ONE_SHOT" "SCHEDULE"

Contains operator for field order.kind

filter[order.kind][notContains]
Array of strings (OrderKind)
Items Enum: "ONE_SHOT" "SCHEDULE"

Not Contains operator for field order.kind

filter[order.active][eq]
boolean (Filter[Order.Active][Eq])

Equal operator for field order.active

filter[order.created_at][le]
string <date-time> (Filter[Order.Created At][Le])

Less or Equal operator for field order.created_at

filter[order.created_at][lt]
string <date-time> (Filter[Order.Created At][Lt])

Less Than operator for field order.created_at

filter[order.created_at][ge]
string <date-time> (Filter[Order.Created At][Ge])

Greater or Equal operator for field order.created_at

filter[order.created_at][gt]
string <date-time> (Filter[Order.Created At][Gt])

Greater Than operator for field order.created_at

filter[task.capture.id][contains]
Array of integers (Filter[Task.Capture.Id][Contains])

Contains operator for field task.capture.id

filter[task.capture.id][notContains]
Array of integers (Filter[Task.Capture.Id][Notcontains])

Not Contains operator for field task.capture.id

filter[task.capture.id][le]
integer (Filter[Task.Capture.Id][Le])

Less or Equal operator for field task.capture.id

filter[task.capture.id][lt]
integer (Filter[Task.Capture.Id][Lt])

Less Than operator for field task.capture.id

filter[task.capture.id][ge]
integer (Filter[Task.Capture.Id][Ge])

Greater or Equal operator for field task.capture.id

filter[task.capture.id][gt]
integer (Filter[Task.Capture.Id][Gt])

Greater Than operator for field task.capture.id

sort
string (Sort) ^(\-?((order\.kind)|(order\.action)|(order\.a...
Default: "-order.created_at"
offset
integer (Offset)
Default: 0
limit
integer (Limit)
Default: 50

Responses

Response samples

Content type
application/json
{
  • "entries": [
    ],
  • "total": 0,
  • "offset": 0,
  • "limit": 0
}

Get a task

path Parameters
id
required
integer (Id) [ 0 .. 2147483647 ]

Responses

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "capture_id": 2147483647,
  • "acknowledged_at": "2019-08-24T14:15:22Z",
  • "order": {
    },
  • "last_jobs": [
    ]
}

job

Get the history on when a sensor has been shut down.

query Parameters
filter[task.id][contains]
Array of integers (Filter[Task.Id][Contains])

Contains operator for field task.id

filter[task.id][notContains]
Array of integers (Filter[Task.Id][Notcontains])

Not Contains operator for field task.id

filter[task.id][le]
integer (Filter[Task.Id][Le])

Less or Equal operator for field task.id

filter[task.id][lt]
integer (Filter[Task.Id][Lt])

Less Than operator for field task.id

filter[task.id][ge]
integer (Filter[Task.Id][Ge])

Greater or Equal operator for field task.id

filter[task.id][gt]
integer (Filter[Task.Id][Gt])

Greater Than operator for field task.id

filter[order.id][contains]
Array of integers (Filter[Order.Id][Contains])

Contains operator for field order.id

filter[order.id][notContains]
Array of integers (Filter[Order.Id][Notcontains])

Not Contains operator for field order.id

filter[order.id][le]
integer (Filter[Order.Id][Le])

Less or Equal operator for field order.id

filter[order.id][lt]
integer (Filter[Order.Id][Lt])

Less Than operator for field order.id

filter[order.id][ge]
integer (Filter[Order.Id][Ge])

Greater or Equal operator for field order.id

filter[order.id][gt]
integer (Filter[Order.Id][Gt])

Greater Than operator for field order.id

filter[task.capture.id][contains]
Array of integers (Filter[Task.Capture.Id][Contains])

Contains operator for field task.capture.id

filter[task.capture.id][notContains]
Array of integers (Filter[Task.Capture.Id][Notcontains])

Not Contains operator for field task.capture.id

filter[task.capture.id][le]
integer (Filter[Task.Capture.Id][Le])

Less or Equal operator for field task.capture.id

filter[task.capture.id][lt]
integer (Filter[Task.Capture.Id][Lt])

Less Than operator for field task.capture.id

filter[task.capture.id][ge]
integer (Filter[Task.Capture.Id][Ge])

Greater or Equal operator for field task.capture.id

filter[task.capture.id][gt]
integer (Filter[Task.Capture.Id][Gt])

Greater Than operator for field task.capture.id

filter[job.created_at][le]
string <date-time> (Filter[Job.Created At][Le])

Less or Equal operator for field job.created_at

filter[job.created_at][lt]
string <date-time> (Filter[Job.Created At][Lt])

Less Than operator for field job.created_at

filter[job.created_at][ge]
string <date-time> (Filter[Job.Created At][Ge])

Greater or Equal operator for field job.created_at

filter[job.created_at][gt]
string <date-time> (Filter[Job.Created At][Gt])

Greater Than operator for field job.created_at

filter[job.last_status][contains]
Array of strings (JobStatus)
Items Enum: "in_progress" "cancelled" "success" "failure" "system_error"

Contains operator for field job.last_status

filter[job.last_status][notContains]
Array of strings (JobStatus)
Items Enum: "in_progress" "cancelled" "success" "failure" "system_error"

Not Contains operator for field job.last_status

sort
string (Sort) ^(\-?((order\.action)|(task\.capture\.id)|(jo...
Default: "-job.created_at"
offset
integer (Offset)
Default: 0
limit
integer (Limit)
Default: 50

Responses

Response samples

Content type
application/json
{
  • "entries": [
    ],
  • "total": 0,
  • "offset": 0,
  • "limit": 0
}

Get the history on when a sensor has been reboot.

query Parameters
filter[task.id][contains]
Array of integers (Filter[Task.Id][Contains])

Contains operator for field task.id

filter[task.id][notContains]
Array of integers (Filter[Task.Id][Notcontains])

Not Contains operator for field task.id

filter[task.id][le]
integer (Filter[Task.Id][Le])

Less or Equal operator for field task.id

filter[task.id][lt]
integer (Filter[Task.Id][Lt])

Less Than operator for field task.id

filter[task.id][ge]
integer (Filter[Task.Id][Ge])

Greater or Equal operator for field task.id

filter[task.id][gt]
integer (Filter[Task.Id][Gt])

Greater Than operator for field task.id

filter[order.id][contains]
Array of integers (Filter[Order.Id][Contains])

Contains operator for field order.id

filter[order.id][notContains]
Array of integers (Filter[Order.Id][Notcontains])

Not Contains operator for field order.id

filter[order.id][le]
integer (Filter[Order.Id][Le])

Less or Equal operator for field order.id

filter[order.id][lt]
integer (Filter[Order.Id][Lt])

Less Than operator for field order.id

filter[order.id][ge]
integer (Filter[Order.Id][Ge])

Greater or Equal operator for field order.id

filter[order.id][gt]
integer (Filter[Order.Id][Gt])

Greater Than operator for field order.id

filter[task.capture.id][contains]
Array of integers (Filter[Task.Capture.Id][Contains])

Contains operator for field task.capture.id

filter[task.capture.id][notContains]
Array of integers (Filter[Task.Capture.Id][Notcontains])

Not Contains operator for field task.capture.id

filter[task.capture.id][le]
integer (Filter[Task.Capture.Id][Le])

Less or Equal operator for field task.capture.id

filter[task.capture.id][lt]
integer (Filter[Task.Capture.Id][Lt])

Less Than operator for field task.capture.id

filter[task.capture.id][ge]
integer (Filter[Task.Capture.Id][Ge])

Greater or Equal operator for field task.capture.id

filter[task.capture.id][gt]
integer (Filter[Task.Capture.Id][Gt])

Greater Than operator for field task.capture.id

filter[job.created_at][le]
string <date-time> (Filter[Job.Created At][Le])

Less or Equal operator for field job.created_at

filter[job.created_at][lt]
string <date-time> (Filter[Job.Created At][Lt])

Less Than operator for field job.created_at

filter[job.created_at][ge]
string <date-time> (Filter[Job.Created At][Ge])

Greater or Equal operator for field job.created_at

filter[job.created_at][gt]
string <date-time> (Filter[Job.Created At][Gt])

Greater Than operator for field job.created_at

filter[job.last_status][contains]
Array of strings (JobStatus)
Items Enum: "in_progress" "cancelled" "success" "failure" "system_error"

Contains operator for field job.last_status

filter[job.last_status][notContains]
Array of strings (JobStatus)
Items Enum: "in_progress" "cancelled" "success" "failure" "system_error"

Not Contains operator for field job.last_status

sort
string (Sort) ^(\-?((order\.action)|(task\.capture\.id)|(jo...
Default: "-job.created_at"
offset
integer (Offset)
Default: 0
limit
integer (Limit)
Default: 50

Responses

Response samples

Content type
application/json
{
  • "entries": [
    ],
  • "total": 0,
  • "offset": 0,
  • "limit": 0
}

Get the history on when a sensor has started sending traffic data.

query Parameters
filter[task.id][contains]
Array of integers (Filter[Task.Id][Contains])

Contains operator for field task.id

filter[task.id][notContains]
Array of integers (Filter[Task.Id][Notcontains])

Not Contains operator for field task.id

filter[task.id][le]
integer (Filter[Task.Id][Le])

Less or Equal operator for field task.id

filter[task.id][lt]
integer (Filter[Task.Id][Lt])

Less Than operator for field task.id

filter[task.id][ge]
integer (Filter[Task.Id][Ge])

Greater or Equal operator for field task.id

filter[task.id][gt]
integer (Filter[Task.Id][Gt])

Greater Than operator for field task.id

filter[order.id][contains]
Array of integers (Filter[Order.Id][Contains])

Contains operator for field order.id

filter[order.id][notContains]
Array of integers (Filter[Order.Id][Notcontains])

Not Contains operator for field order.id

filter[order.id][le]
integer (Filter[Order.Id][Le])

Less or Equal operator for field order.id

filter[order.id][lt]
integer (Filter[Order.Id][Lt])

Less Than operator for field order.id

filter[order.id][ge]
integer (Filter[Order.Id][Ge])

Greater or Equal operator for field order.id

filter[order.id][gt]
integer (Filter[Order.Id][Gt])

Greater Than operator for field order.id

filter[task.capture.id][contains]
Array of integers (Filter[Task.Capture.Id][Contains])

Contains operator for field task.capture.id

filter[task.capture.id][notContains]
Array of integers (Filter[Task.Capture.Id][Notcontains])

Not Contains operator for field task.capture.id

filter[task.capture.id][le]
integer (Filter[Task.Capture.Id][Le])

Less or Equal operator for field task.capture.id

filter[task.capture.id][lt]
integer (Filter[Task.Capture.Id][Lt])

Less Than operator for field task.capture.id

filter[task.capture.id][ge]
integer (Filter[Task.Capture.Id][Ge])

Greater or Equal operator for field task.capture.id

filter[task.capture.id][gt]
integer (Filter[Task.Capture.Id][Gt])

Greater Than operator for field task.capture.id

filter[job.created_at][le]
string <date-time> (Filter[Job.Created At][Le])

Less or Equal operator for field job.created_at

filter[job.created_at][lt]
string <date-time> (Filter[Job.Created At][Lt])

Less Than operator for field job.created_at

filter[job.created_at][ge]
string <date-time> (Filter[Job.Created At][Ge])

Greater or Equal operator for field job.created_at

filter[job.created_at][gt]
string <date-time> (Filter[Job.Created At][Gt])

Greater Than operator for field job.created_at

filter[job.last_status][contains]
Array of strings (JobStatus)
Items Enum: "in_progress" "cancelled" "success" "failure" "system_error"

Contains operator for field job.last_status

filter[job.last_status][notContains]
Array of strings (JobStatus)
Items Enum: "in_progress" "cancelled" "success" "failure" "system_error"

Not Contains operator for field job.last_status

sort
string (Sort) ^(\-?((order\.action)|(task\.capture\.id)|(jo...
Default: "-job.created_at"
offset
integer (Offset)
Default: 0
limit
integer (Limit)
Default: 50

Responses

Response samples

Content type
application/json
{
  • "entries": [
    ],
  • "total": 0,
  • "offset": 0,
  • "limit": 0
}

Get the history on when a sensor has stopped sending traffic data.

query Parameters
filter[task.id][contains]
Array of integers (Filter[Task.Id][Contains])

Contains operator for field task.id

filter[task.id][notContains]
Array of integers (Filter[Task.Id][Notcontains])

Not Contains operator for field task.id

filter[task.id][le]
integer (Filter[Task.Id][Le])

Less or Equal operator for field task.id

filter[task.id][lt]
integer (Filter[Task.Id][Lt])

Less Than operator for field task.id

filter[task.id][ge]
integer (Filter[Task.Id][Ge])

Greater or Equal operator for field task.id

filter[task.id][gt]
integer (Filter[Task.Id][Gt])

Greater Than operator for field task.id

filter[order.id][contains]
Array of integers (Filter[Order.Id][Contains])

Contains operator for field order.id

filter[order.id][notContains]
Array of integers (Filter[Order.Id][Notcontains])

Not Contains operator for field order.id

filter[order.id][le]
integer (Filter[Order.Id][Le])

Less or Equal operator for field order.id

filter[order.id][lt]
integer (Filter[Order.Id][Lt])

Less Than operator for field order.id

filter[order.id][ge]
integer (Filter[Order.Id][Ge])

Greater or Equal operator for field order.id

filter[order.id][gt]
integer (Filter[Order.Id][Gt])

Greater Than operator for field order.id

filter[task.capture.id][contains]
Array of integers (Filter[Task.Capture.Id][Contains])

Contains operator for field task.capture.id

filter[task.capture.id][notContains]
Array of integers (Filter[Task.Capture.Id][Notcontains])

Not Contains operator for field task.capture.id

filter[task.capture.id][le]
integer (Filter[Task.Capture.Id][Le])

Less or Equal operator for field task.capture.id

filter[task.capture.id][lt]
integer (Filter[Task.Capture.Id][Lt])

Less Than operator for field task.capture.id

filter[task.capture.id][ge]
integer (Filter[Task.Capture.Id][Ge])

Greater or Equal operator for field task.capture.id

filter[task.capture.id][gt]
integer (Filter[Task.Capture.Id][Gt])

Greater Than operator for field task.capture.id

filter[job.created_at][le]
string <date-time> (Filter[Job.Created At][Le])

Less or Equal operator for field job.created_at

filter[job.created_at][lt]
string <date-time> (Filter[Job.Created At][Lt])

Less Than operator for field job.created_at

filter[job.created_at][ge]
string <date-time> (Filter[Job.Created At][Ge])

Greater or Equal operator for field job.created_at

filter[job.created_at][gt]
string <date-time> (Filter[Job.Created At][Gt])

Greater Than operator for field job.created_at

filter[job.last_status][contains]
Array of strings (JobStatus)
Items Enum: "in_progress" "cancelled" "success" "failure" "system_error"

Contains operator for field job.last_status

filter[job.last_status][notContains]
Array of strings (JobStatus)
Items Enum: "in_progress" "cancelled" "success" "failure" "system_error"

Not Contains operator for field job.last_status

sort
string (Sort) ^(\-?((order\.action)|(task\.capture\.id)|(jo...
Default: "-job.created_at"
offset
integer (Offset)
Default: 0
limit
integer (Limit)
Default: 50

Responses

Response samples

Content type
application/json
{
  • "entries": [
    ],
  • "total": 0,
  • "offset": 0,
  • "limit": 0
}

Get the history on when a sensor has been upgraded.

query Parameters
filter[task.id][contains]
Array of integers (Filter[Task.Id][Contains])

Contains operator for field task.id

filter[task.id][notContains]
Array of integers (Filter[Task.Id][Notcontains])

Not Contains operator for field task.id

filter[task.id][le]
integer (Filter[Task.Id][Le])

Less or Equal operator for field task.id

filter[task.id][lt]
integer (Filter[Task.Id][Lt])

Less Than operator for field task.id

filter[task.id][ge]
integer (Filter[Task.Id][Ge])

Greater or Equal operator for field task.id

filter[task.id][gt]
integer (Filter[Task.Id][Gt])

Greater Than operator for field task.id

filter[order.id][contains]
Array of integers (Filter[Order.Id][Contains])

Contains operator for field order.id

filter[order.id][notContains]
Array of integers (Filter[Order.Id][Notcontains])

Not Contains operator for field order.id

filter[order.id][le]
integer (Filter[Order.Id][Le])

Less or Equal operator for field order.id

filter[order.id][lt]
integer (Filter[Order.Id][Lt])

Less Than operator for field order.id

filter[order.id][ge]
integer (Filter[Order.Id][Ge])

Greater or Equal operator for field order.id

filter[order.id][gt]
integer (Filter[Order.Id][Gt])

Greater Than operator for field order.id

filter[task.capture.id][contains]
Array of integers (Filter[Task.Capture.Id][Contains])

Contains operator for field task.capture.id

filter[task.capture.id][notContains]
Array of integers (Filter[Task.Capture.Id][Notcontains])

Not Contains operator for field task.capture.id

filter[task.capture.id][le]
integer (Filter[Task.Capture.Id][Le])

Less or Equal operator for field task.capture.id

filter[task.capture.id][lt]
integer (Filter[Task.Capture.Id][Lt])

Less Than operator for field task.capture.id

filter[task.capture.id][ge]
integer (Filter[Task.Capture.Id][Ge])

Greater or Equal operator for field task.capture.id

filter[task.capture.id][gt]
integer (Filter[Task.Capture.Id][Gt])

Greater Than operator for field task.capture.id

filter[job.created_at][le]
string <date-time> (Filter[Job.Created At][Le])

Less or Equal operator for field job.created_at

filter[job.created_at][lt]
string <date-time> (Filter[Job.Created At][Lt])

Less Than operator for field job.created_at

filter[job.created_at][ge]
string <date-time> (Filter[Job.Created At][Ge])

Greater or Equal operator for field job.created_at

filter[job.created_at][gt]
string <date-time> (Filter[Job.Created At][Gt])

Greater Than operator for field job.created_at

filter[job.last_status][contains]
Array of strings (JobStatus)
Items Enum: "in_progress" "cancelled" "success" "failure" "system_error"

Contains operator for field job.last_status

filter[job.last_status][notContains]
Array of strings (JobStatus)
Items Enum: "in_progress" "cancelled" "success" "failure" "system_error"

Not Contains operator for field job.last_status

sort
string (Sort) ^(\-?((order\.action)|(task\.capture\.id)|(jo...
Default: "-job.created_at"
offset
integer (Offset)
Default: 0
limit
integer (Limit)
Default: 50

Responses

Response samples

Content type
application/json
{
  • "entries": [
    ],
  • "total": 0,
  • "offset": 0,
  • "limit": 0
}

Get the history on when pcap files have been created on a sensor.

query Parameters
filter[task.id][contains]
Array of integers (Filter[Task.Id][Contains])

Contains operator for field task.id

filter[task.id][notContains]
Array of integers (Filter[Task.Id][Notcontains])

Not Contains operator for field task.id

filter[task.id][le]
integer (Filter[Task.Id][Le])

Less or Equal operator for field task.id

filter[task.id][lt]
integer (Filter[Task.Id][Lt])

Less Than operator for field task.id

filter[task.id][ge]
integer (Filter[Task.Id][Ge])

Greater or Equal operator for field task.id

filter[task.id][gt]
integer (Filter[Task.Id][Gt])

Greater Than operator for field task.id

filter[order.id][contains]
Array of integers (Filter[Order.Id][Contains])

Contains operator for field order.id

filter[order.id][notContains]
Array of integers (Filter[Order.Id][Notcontains])

Not Contains operator for field order.id

filter[order.id][le]
integer (Filter[Order.Id][Le])

Less or Equal operator for field order.id

filter[order.id][lt]
integer (Filter[Order.Id][Lt])

Less Than operator for field order.id

filter[order.id][ge]
integer (Filter[Order.Id][Ge])

Greater or Equal operator for field order.id

filter[order.id][gt]
integer (Filter[Order.Id][Gt])

Greater Than operator for field order.id

filter[task.capture.id][contains]
Array of integers (Filter[Task.Capture.Id][Contains])

Contains operator for field task.capture.id

filter[task.capture.id][notContains]
Array of integers (Filter[Task.Capture.Id][Notcontains])

Not Contains operator for field task.capture.id

filter[task.capture.id][le]
integer (Filter[Task.Capture.Id][Le])

Less or Equal operator for field task.capture.id

filter[task.capture.id][lt]
integer (Filter[Task.Capture.Id][Lt])

Less Than operator for field task.capture.id

filter[task.capture.id][ge]
integer (Filter[Task.Capture.Id][Ge])

Greater or Equal operator for field task.capture.id

filter[task.capture.id][gt]
integer (Filter[Task.Capture.Id][Gt])

Greater Than operator for field task.capture.id

filter[job.created_at][le]
string <date-time> (Filter[Job.Created At][Le])

Less or Equal operator for field job.created_at

filter[job.created_at][lt]
string <date-time> (Filter[Job.Created At][Lt])

Less Than operator for field job.created_at

filter[job.created_at][ge]
string <date-time> (Filter[Job.Created At][Ge])

Greater or Equal operator for field job.created_at

filter[job.created_at][gt]
string <date-time> (Filter[Job.Created At][Gt])

Greater Than operator for field job.created_at

filter[job.last_status][contains]
Array of strings (JobStatus)
Items Enum: "in_progress" "cancelled" "success" "failure" "system_error"

Contains operator for field job.last_status

filter[job.last_status][notContains]
Array of strings (JobStatus)
Items Enum: "in_progress" "cancelled" "success" "failure" "system_error"

Not Contains operator for field job.last_status

sort
string (Sort) ^(\-?((order\.action)|(task\.capture\.id)|(jo...
Default: "-job.created_at"
offset
integer (Offset)
Default: 0
limit
integer (Limit)
Default: 50

Responses

Response samples

Content type
application/json
{
  • "entries": [
    ],
  • "total": 0,
  • "offset": 0,
  • "limit": 0
}

Get the history on when a pcap file has been deleted on a sensor.

query Parameters
filter[task.id][contains]
Array of integers (Filter[Task.Id][Contains])

Contains operator for field task.id

filter[task.id][notContains]
Array of integers (Filter[Task.Id][Notcontains])

Not Contains operator for field task.id

filter[task.id][le]
integer (Filter[Task.Id][Le])

Less or Equal operator for field task.id

filter[task.id][lt]
integer (Filter[Task.Id][Lt])

Less Than operator for field task.id

filter[task.id][ge]
integer (Filter[Task.Id][Ge])

Greater or Equal operator for field task.id

filter[task.id][gt]
integer (Filter[Task.Id][Gt])

Greater Than operator for field task.id

filter[order.id][contains]
Array of integers (Filter[Order.Id][Contains])

Contains operator for field order.id

filter[order.id][notContains]
Array of integers (Filter[Order.Id][Notcontains])

Not Contains operator for field order.id

filter[order.id][le]
integer (Filter[Order.Id][Le])

Less or Equal operator for field order.id

filter[order.id][lt]
integer (Filter[Order.Id][Lt])

Less Than operator for field order.id

filter[order.id][ge]
integer (Filter[Order.Id][Ge])

Greater or Equal operator for field order.id

filter[order.id][gt]
integer (Filter[Order.Id][Gt])

Greater Than operator for field order.id

filter[task.capture.id][contains]
Array of integers (Filter[Task.Capture.Id][Contains])

Contains operator for field task.capture.id

filter[task.capture.id][notContains]
Array of integers (Filter[Task.Capture.Id][Notcontains])

Not Contains operator for field task.capture.id

filter[task.capture.id][le]
integer (Filter[Task.Capture.Id][Le])

Less or Equal operator for field task.capture.id

filter[task.capture.id][lt]
integer (Filter[Task.Capture.Id][Lt])

Less Than operator for field task.capture.id

filter[task.capture.id][ge]
integer (Filter[Task.Capture.Id][Ge])

Greater or Equal operator for field task.capture.id

filter[task.capture.id][gt]
integer (Filter[Task.Capture.Id][Gt])

Greater Than operator for field task.capture.id

filter[job.created_at][le]
string <date-time> (Filter[Job.Created At][Le])

Less or Equal operator for field job.created_at

filter[job.created_at][lt]
string <date-time> (Filter[Job.Created At][Lt])

Less Than operator for field job.created_at

filter[job.created_at][ge]
string <date-time> (Filter[Job.Created At][Ge])

Greater or Equal operator for field job.created_at

filter[job.created_at][gt]
string <date-time> (Filter[Job.Created At][Gt])

Greater Than operator for field job.created_at

filter[job.last_status][contains]
Array of strings (JobStatus)
Items Enum: "in_progress" "cancelled" "success" "failure" "system_error"

Contains operator for field job.last_status

filter[job.last_status][notContains]
Array of strings (JobStatus)
Items Enum: "in_progress" "cancelled" "success" "failure" "system_error"

Not Contains operator for field job.last_status

sort
string (Sort) ^(\-?((order\.action)|(task\.capture\.id)|(jo...
Default: "-job.created_at"
offset
integer (Offset)
Default: 0
limit
integer (Limit)
Default: 50

Responses

Response samples

Content type
application/json
{
  • "entries": [
    ],
  • "total": 0,
  • "offset": 0,
  • "limit": 0
}

Get a list of jobs for delete a capture order

query Parameters
filter[task.id][contains]
Array of integers (Filter[Task.Id][Contains])

Contains operator for field task.id

filter[task.id][notContains]
Array of integers (Filter[Task.Id][Notcontains])

Not Contains operator for field task.id

filter[task.id][le]
integer (Filter[Task.Id][Le])

Less or Equal operator for field task.id

filter[task.id][lt]
integer (Filter[Task.Id][Lt])

Less Than operator for field task.id

filter[task.id][ge]
integer (Filter[Task.Id][Ge])

Greater or Equal operator for field task.id

filter[task.id][gt]
integer (Filter[Task.Id][Gt])

Greater Than operator for field task.id

filter[order.id][contains]
Array of integers (Filter[Order.Id][Contains])

Contains operator for field order.id

filter[order.id][notContains]
Array of integers (Filter[Order.Id][Notcontains])

Not Contains operator for field order.id

filter[order.id][le]
integer (Filter[Order.Id][Le])

Less or Equal operator for field order.id

filter[order.id][lt]
integer (Filter[Order.Id][Lt])

Less Than operator for field order.id

filter[order.id][ge]
integer (Filter[Order.Id][Ge])

Greater or Equal operator for field order.id

filter[order.id][gt]
integer (Filter[Order.Id][Gt])

Greater Than operator for field order.id

filter[task.capture.id][contains]
Array of integers (Filter[Task.Capture.Id][Contains])

Contains operator for field task.capture.id

filter[task.capture.id][notContains]
Array of integers (Filter[Task.Capture.Id][Notcontains])

Not Contains operator for field task.capture.id

filter[task.capture.id][le]
integer (Filter[Task.Capture.Id][Le])

Less or Equal operator for field task.capture.id

filter[task.capture.id][lt]
integer (Filter[Task.Capture.Id][Lt])

Less Than operator for field task.capture.id

filter[task.capture.id][ge]
integer (Filter[Task.Capture.Id][Ge])

Greater or Equal operator for field task.capture.id

filter[task.capture.id][gt]
integer (Filter[Task.Capture.Id][Gt])

Greater Than operator for field task.capture.id

filter[job.created_at][le]
string <date-time> (Filter[Job.Created At][Le])

Less or Equal operator for field job.created_at

filter[job.created_at][lt]
string <date-time> (Filter[Job.Created At][Lt])

Less Than operator for field job.created_at

filter[job.created_at][ge]
string <date-time> (Filter[Job.Created At][Ge])

Greater or Equal operator for field job.created_at

filter[job.created_at][gt]
string <date-time> (Filter[Job.Created At][Gt])

Greater Than operator for field job.created_at

filter[job.last_status][contains]
Array of strings (JobStatus)
Items Enum: "in_progress" "cancelled" "success" "failure" "system_error"

Contains operator for field job.last_status

filter[job.last_status][notContains]
Array of strings (JobStatus)
Items Enum: "in_progress" "cancelled" "success" "failure" "system_error"

Not Contains operator for field job.last_status

sort
string (Sort) ^(\-?((order\.action)|(task\.capture\.id)|(jo...
Default: "-job.created_at"
offset
integer (Offset)
Default: 0
limit
integer (Limit)
Default: 50

Responses

Response samples

Content type
application/json
{
  • "entries": [
    ],
  • "total": 0,
  • "offset": 0,
  • "limit": 0
}

Get the history on when the VPN has been started on a sensor.

query Parameters
filter[task.id][contains]
Array of integers (Filter[Task.Id][Contains])

Contains operator for field task.id

filter[task.id][notContains]
Array of integers (Filter[Task.Id][Notcontains])

Not Contains operator for field task.id

filter[task.id][le]
integer (Filter[Task.Id][Le])

Less or Equal operator for field task.id

filter[task.id][lt]
integer (Filter[Task.Id][Lt])

Less Than operator for field task.id

filter[task.id][ge]
integer (Filter[Task.Id][Ge])

Greater or Equal operator for field task.id

filter[task.id][gt]
integer (Filter[Task.Id][Gt])

Greater Than operator for field task.id

filter[order.id][contains]
Array of integers (Filter[Order.Id][Contains])

Contains operator for field order.id

filter[order.id][notContains]
Array of integers (Filter[Order.Id][Notcontains])

Not Contains operator for field order.id

filter[order.id][le]
integer (Filter[Order.Id][Le])

Less or Equal operator for field order.id

filter[order.id][lt]
integer (Filter[Order.Id][Lt])

Less Than operator for field order.id

filter[order.id][ge]
integer (Filter[Order.Id][Ge])

Greater or Equal operator for field order.id

filter[order.id][gt]
integer (Filter[Order.Id][Gt])

Greater Than operator for field order.id

filter[task.capture.id][contains]
Array of integers (Filter[Task.Capture.Id][Contains])

Contains operator for field task.capture.id

filter[task.capture.id][notContains]
Array of integers (Filter[Task.Capture.Id][Notcontains])

Not Contains operator for field task.capture.id

filter[task.capture.id][le]
integer (Filter[Task.Capture.Id][Le])

Less or Equal operator for field task.capture.id

filter[task.capture.id][lt]
integer (Filter[Task.Capture.Id][Lt])

Less Than operator for field task.capture.id

filter[task.capture.id][ge]
integer (Filter[Task.Capture.Id][Ge])

Greater or Equal operator for field task.capture.id

filter[task.capture.id][gt]
integer (Filter[Task.Capture.Id][Gt])

Greater Than operator for field task.capture.id

filter[job.created_at][le]
string <date-time> (Filter[Job.Created At][Le])

Less or Equal operator for field job.created_at

filter[job.created_at][lt]
string <date-time> (Filter[Job.Created At][Lt])

Less Than operator for field job.created_at

filter[job.created_at][ge]
string <date-time> (Filter[Job.Created At][Ge])

Greater or Equal operator for field job.created_at

filter[job.created_at][gt]
string <date-time> (Filter[Job.Created At][Gt])

Greater Than operator for field job.created_at

filter[job.last_status][contains]
Array of strings (JobStatus)
Items Enum: "in_progress" "cancelled" "success" "failure" "system_error"

Contains operator for field job.last_status

filter[job.last_status][notContains]
Array of strings (JobStatus)
Items Enum: "in_progress" "cancelled" "success" "failure" "system_error"

Not Contains operator for field job.last_status

sort
string (Sort) ^(\-?((order\.action)|(task\.capture\.id)|(jo...
Default: "-job.created_at"
offset
integer (Offset)
Default: 0
limit
integer (Limit)
Default: 50

Responses

Response samples

Content type
application/json
{
  • "entries": [
    ],
  • "total": 0,
  • "offset": 0,
  • "limit": 0
}

Get the history on when the VPN has been stoped on a sensor.

query Parameters
filter[task.id][contains]
Array of integers (Filter[Task.Id][Contains])

Contains operator for field task.id

filter[task.id][notContains]
Array of integers (Filter[Task.Id][Notcontains])

Not Contains operator for field task.id

filter[task.id][le]
integer (Filter[Task.Id][Le])

Less or Equal operator for field task.id

filter[task.id][lt]
integer (Filter[Task.Id][Lt])

Less Than operator for field task.id

filter[task.id][ge]
integer (Filter[Task.Id][Ge])

Greater or Equal operator for field task.id

filter[task.id][gt]
integer (Filter[Task.Id][Gt])

Greater Than operator for field task.id

filter[order.id][contains]
Array of integers (Filter[Order.Id][Contains])

Contains operator for field order.id

filter[order.id][notContains]
Array of integers (Filter[Order.Id][Notcontains])

Not Contains operator for field order.id

filter[order.id][le]
integer (Filter[Order.Id][Le])

Less or Equal operator for field order.id

filter[order.id][lt]
integer (Filter[Order.Id][Lt])

Less Than operator for field order.id

filter[order.id][ge]
integer (Filter[Order.Id][Ge])

Greater or Equal operator for field order.id

filter[order.id][gt]
integer (Filter[Order.Id][Gt])

Greater Than operator for field order.id

filter[task.capture.id][contains]
Array of integers (Filter[Task.Capture.Id][Contains])

Contains operator for field task.capture.id

filter[task.capture.id][notContains]
Array of integers (Filter[Task.Capture.Id][Notcontains])

Not Contains operator for field task.capture.id

filter[task.capture.id][le]
integer (Filter[Task.Capture.Id][Le])

Less or Equal operator for field task.capture.id

filter[task.capture.id][lt]
integer (Filter[Task.Capture.Id][Lt])

Less Than operator for field task.capture.id

filter[task.capture.id][ge]
integer (Filter[Task.Capture.Id][Ge])

Greater or Equal operator for field task.capture.id

filter[task.capture.id][gt]
integer (Filter[Task.Capture.Id][Gt])

Greater Than operator for field task.capture.id

filter[job.created_at][le]
string <date-time> (Filter[Job.Created At][Le])

Less or Equal operator for field job.created_at

filter[job.created_at][lt]
string <date-time> (Filter[Job.Created At][Lt])

Less Than operator for field job.created_at

filter[job.created_at][ge]
string <date-time> (Filter[Job.Created At][Ge])

Greater or Equal operator for field job.created_at

filter[job.created_at][gt]
string <date-time> (Filter[Job.Created At][Gt])

Greater Than operator for field job.created_at

filter[job.last_status][contains]
Array of strings (JobStatus)
Items Enum: "in_progress" "cancelled" "success" "failure" "system_error"

Contains operator for field job.last_status

filter[job.last_status][notContains]
Array of strings (JobStatus)
Items Enum: "in_progress" "cancelled" "success" "failure" "system_error"

Not Contains operator for field job.last_status

sort
string (Sort) ^(\-?((order\.action)|(task\.capture\.id)|(jo...
Default: "-job.created_at"
offset
integer (Offset)
Default: 0
limit
integer (Limit)
Default: 50

Responses

Response samples

Content type
application/json
{
  • "entries": [
    ],
  • "total": 0,
  • "offset": 0,
  • "limit": 0
}

Get the history of all orders that have been made.

query Parameters
filter[order.action][contains]
Array of strings (OrderActionKind)
Items Enum: "SHUTDOWN" "REBOOT" "START_CAPTURE" "PAUSE_CAPTURE" "UPGRADE_CAPTURE" "START_VPN" "STOP_VPN" "PCAP" "DELETE_PCAP" "DELETE_CAPTURE"

Contains operator for field order.action

filter[order.action][notContains]
Array of strings (OrderActionKind)
Items Enum: "SHUTDOWN" "REBOOT" "START_CAPTURE" "PAUSE_CAPTURE" "UPGRADE_CAPTURE" "START_VPN" "STOP_VPN" "PCAP" "DELETE_PCAP" "DELETE_CAPTURE"

Not Contains operator for field order.action

filter[task.id][contains]
Array of integers (Filter[Task.Id][Contains])

Contains operator for field task.id

filter[task.id][notContains]
Array of integers (Filter[Task.Id][Notcontains])

Not Contains operator for field task.id

filter[task.id][le]
integer (Filter[Task.Id][Le])

Less or Equal operator for field task.id

filter[task.id][lt]
integer (Filter[Task.Id][Lt])

Less Than operator for field task.id

filter[task.id][ge]
integer (Filter[Task.Id][Ge])

Greater or Equal operator for field task.id

filter[task.id][gt]
integer (Filter[Task.Id][Gt])

Greater Than operator for field task.id

filter[order.id][contains]
Array of integers (Filter[Order.Id][Contains])

Contains operator for field order.id

filter[order.id][notContains]
Array of integers (Filter[Order.Id][Notcontains])

Not Contains operator for field order.id

filter[order.id][le]
integer (Filter[Order.Id][Le])

Less or Equal operator for field order.id

filter[order.id][lt]
integer (Filter[Order.Id][Lt])

Less Than operator for field order.id

filter[order.id][ge]
integer (Filter[Order.Id][Ge])

Greater or Equal operator for field order.id

filter[order.id][gt]
integer (Filter[Order.Id][Gt])

Greater Than operator for field order.id

filter[task.capture.id][contains]
Array of integers (Filter[Task.Capture.Id][Contains])

Contains operator for field task.capture.id

filter[task.capture.id][notContains]
Array of integers (Filter[Task.Capture.Id][Notcontains])

Not Contains operator for field task.capture.id

filter[task.capture.id][le]
integer (Filter[Task.Capture.Id][Le])

Less or Equal operator for field task.capture.id

filter[task.capture.id][lt]
integer (Filter[Task.Capture.Id][Lt])

Less Than operator for field task.capture.id

filter[task.capture.id][ge]
integer (Filter[Task.Capture.Id][Ge])

Greater or Equal operator for field task.capture.id

filter[task.capture.id][gt]
integer (Filter[Task.Capture.Id][Gt])

Greater Than operator for field task.capture.id

filter[job.created_at][le]
string <date-time> (Filter[Job.Created At][Le])

Less or Equal operator for field job.created_at

filter[job.created_at][lt]
string <date-time> (Filter[Job.Created At][Lt])

Less Than operator for field job.created_at

filter[job.created_at][ge]
string <date-time> (Filter[Job.Created At][Ge])

Greater or Equal operator for field job.created_at

filter[job.created_at][gt]
string <date-time> (Filter[Job.Created At][Gt])

Greater Than operator for field job.created_at

filter[job.last_status][contains]
Array of strings (JobStatus)
Items Enum: "in_progress" "cancelled" "success" "failure" "system_error"

Contains operator for field job.last_status

filter[job.last_status][notContains]
Array of strings (JobStatus)
Items Enum: "in_progress" "cancelled" "success" "failure" "system_error"

Not Contains operator for field job.last_status

sort
string (Sort) ^(\-?((order\.action)|(task\.capture\.id)|(jo...
Default: "-job.created_at"
offset
integer (Offset)
Default: 0
limit
integer (Limit)
Default: 50

Responses

Response samples

Content type
application/json
{
  • "entries": [
    ],
  • "total": 0,
  • "offset": 0,
  • "limit": 0
}

Get the description of a specific job.

path Parameters
id
required
string <uuid> (Id)

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "task": {
    },
  • "steps": [
    ]
}

profile

Get a profile configuration

Get a profile configuration.

path Parameters
id
required
integer (Id) [ 0 .. 2147483647 ]

Responses

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "name": "string",
  • "config": {
    },
  • "created_by": 2147483647,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_by": 2147483647,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "can_undo": true,
  • "can_redo": true,
  • "version": 0,
  • "is_deleted": true
}

Remove a profile

Remove a profile.

path Parameters
id
required
integer (Id) [ 0 .. 2147483647 ]
Request Body schema: application/json
version
required
integer (Version) [ 0 .. 2147483647 ]

Responses

Request samples

Content type
application/json
{
  • "version": 2147483647
}

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "name": "string",
  • "config": {
    },
  • "created_by": 2147483647,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_by": 2147483647,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "can_undo": true,
  • "can_redo": true,
  • "version": 0,
  • "is_deleted": true
}

Update a profile

Update a profile.

path Parameters
id
required
integer (Id) [ 0 .. 2147483647 ]
Request Body schema: application/json
name
required
string (Name) non-empty
required
object (pykouze__bin__pyloth__leader__api__routers__profiles__v4__APIProfileModel)
version
required
integer (Version) [ 0 .. 2147483647 ]

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "name": "string",
  • "config": {
    },
  • "created_by": 2147483647,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_by": 2147483647,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "can_undo": true,
  • "can_redo": true,
  • "version": 0,
  • "is_deleted": true
}

Get profiles associated capture ids

Get profiles associated capture ids.

Responses

Response samples

Content type
application/json
{
  • "entries": [
    ],
  • "version": 2147483647
}

Update profile associated capture ids

Update profile associated capture ids.

Request Body schema: application/json
required
Array of objects (Entries)
version
required
integer (Version) [ 0 .. 2147483647 ]

Responses

Request samples

Content type
application/json
{
  • "entries": [
    ],
  • "version": 2147483647
}

Response samples

Content type
application/json
{
  • "entries": [
    ],
  • "version": 2147483647
}

Get all profiles

Get all profiles.

query Parameters
filter[profile.id][contains]
Array of integers (Filter[Profile.Id][Contains]) [ items [ 0 .. 2147483647 ] ]

Contains operator for field profile.id

filter[profile.id][notContains]
Array of integers (Filter[Profile.Id][Notcontains]) [ items [ 0 .. 2147483647 ] ]

Not Contains operator for field profile.id

filter[profile.is_deleted][eq]
boolean (Filter[Profile.Is Deleted][Eq])

Equal operator for field profile.is_deleted

Responses

Response samples

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

Create a profile

Create a profile.

Request Body schema: application/json
name
required
string (Name) non-empty
required
object (pykouze__bin__pyloth__leader__api__routers__profiles__v4__APIProfileModel)

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "name": "string",
  • "config": {
    },
  • "created_by": 2147483647,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_by": 2147483647,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "can_undo": true,
  • "can_redo": true,
  • "version": 0,
  • "is_deleted": true
}

Peview an undo of a profile definition

Preview an undo of a profile definition.

path Parameters
id
required
integer (Id) [ 0 .. 2147483647 ]

Responses

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "name": "string",
  • "config": {
    },
  • "created_by": 2147483647,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_by": 2147483647,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "can_undo": true,
  • "can_redo": true,
  • "version": 0,
  • "is_deleted": true
}

Undo a profile definition

Undo a profile definition.

path Parameters
id
required
integer (Id) [ 0 .. 2147483647 ]
Request Body schema: application/json
version
required
integer (Version) [ 0 .. 2147483647 ]

Responses

Request samples

Content type
application/json
{
  • "version": 2147483647
}

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "name": "string",
  • "config": {
    },
  • "created_by": 2147483647,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_by": 2147483647,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "can_undo": true,
  • "can_redo": true,
  • "version": 0,
  • "is_deleted": true
}

Perview an undo of a profile definition

Preview an undo of a profile definition.

path Parameters
id
required
integer (Id) [ 0 .. 2147483647 ]

Responses

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "name": "string",
  • "config": {
    },
  • "created_by": 2147483647,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_by": 2147483647,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "can_undo": true,
  • "can_redo": true,
  • "version": 0,
  • "is_deleted": true
}

Redo a profile definition

Redo a profile definition.

path Parameters
id
required
integer (Id) [ 0 .. 2147483647 ]
Request Body schema: application/json
version
required
integer (Version) [ 0 .. 2147483647 ]

Responses

Request samples

Content type
application/json
{
  • "version": 2147483647
}

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "name": "string",
  • "config": {
    },
  • "created_by": 2147483647,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_by": 2147483647,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "can_undo": true,
  • "can_redo": true,
  • "version": 0,
  • "is_deleted": true
}

Get a profile configuration

Get a profile configuration.

path Parameters
id
required
integer (Id) [ 0 .. 2147483647 ]

Responses

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "name": "string",
  • "config": {
    },
  • "created_by": 2147483647,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_by": 2147483647,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "can_undo": true,
  • "can_redo": true,
  • "version": 0,
  • "is_deleted": true
}

Remove a profile

Remove a profile.

path Parameters
id
required
integer (Id) [ 0 .. 2147483647 ]
Request Body schema: application/json
version
required
integer (Version) [ 0 .. 2147483647 ]

Responses

Request samples

Content type
application/json
{
  • "version": 2147483647
}

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "name": "string",
  • "config": {
    },
  • "created_by": 2147483647,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_by": 2147483647,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "can_undo": true,
  • "can_redo": true,
  • "version": 0,
  • "is_deleted": true
}

Update a profile

Update a profile.

path Parameters
id
required
integer (Id) [ 0 .. 2147483647 ]
Request Body schema: application/json
name
required
string (Name) non-empty
required
object (pykouze__bin__pyloth__leader__api__routers__profiles__v3__APIProfileModel)
version
required
integer (Version) [ 0 .. 2147483647 ]

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "name": "string",
  • "config": {
    },
  • "created_by": 2147483647,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_by": 2147483647,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "can_undo": true,
  • "can_redo": true,
  • "version": 0,
  • "is_deleted": true
}

Get profiles associated capture ids

Get profiles associated capture ids.

Responses

Response samples

Content type
application/json
{
  • "entries": [
    ],
  • "version": 2147483647
}

Update profile associated capture ids

Update profile associated capture ids.

Request Body schema: application/json
required
Array of objects (Entries)
version
required
integer (Version) [ 0 .. 2147483647 ]

Responses

Request samples

Content type
application/json
{
  • "entries": [
    ],
  • "version": 2147483647
}

Response samples

Content type
application/json
{
  • "entries": [
    ],
  • "version": 2147483647
}

Get all profiles

Get all profiles.

query Parameters
filter[profile.id][contains]
Array of integers (Filter[Profile.Id][Contains]) [ items [ 0 .. 2147483647 ] ]

Contains operator for field profile.id

filter[profile.id][notContains]
Array of integers (Filter[Profile.Id][Notcontains]) [ items [ 0 .. 2147483647 ] ]

Not Contains operator for field profile.id

filter[profile.is_deleted][eq]
boolean (Filter[Profile.Is Deleted][Eq])

Equal operator for field profile.is_deleted

Responses

Response samples

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

Create a profile

Create a profile.

Request Body schema: application/json
name
required
string (Name) non-empty
required
object (pykouze__bin__pyloth__leader__api__routers__profiles__v3__APIProfileModel)

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "name": "string",
  • "config": {
    },
  • "created_by": 2147483647,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_by": 2147483647,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "can_undo": true,
  • "can_redo": true,
  • "version": 0,
  • "is_deleted": true
}

Peview an undo of a profile definition

Preview an undo of a profile definition.

path Parameters
id
required
integer (Id) [ 0 .. 2147483647 ]

Responses

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "name": "string",
  • "config": {
    },
  • "created_by": 2147483647,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_by": 2147483647,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "can_undo": true,
  • "can_redo": true,
  • "version": 0,
  • "is_deleted": true
}

Undo a profile definition

Undo a profile definition.

path Parameters
id
required
integer (Id) [ 0 .. 2147483647 ]
Request Body schema: application/json
version
required
integer (Version) [ 0 .. 2147483647 ]

Responses

Request samples

Content type
application/json
{
  • "version": 2147483647
}

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "name": "string",
  • "config": {
    },
  • "created_by": 2147483647,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_by": 2147483647,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "can_undo": true,
  • "can_redo": true,
  • "version": 0,
  • "is_deleted": true
}

Perview an undo of a profile definition

Preview an undo of a profile definition.

path Parameters
id
required
integer (Id) [ 0 .. 2147483647 ]

Responses

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "name": "string",
  • "config": {
    },
  • "created_by": 2147483647,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_by": 2147483647,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "can_undo": true,
  • "can_redo": true,
  • "version": 0,
  • "is_deleted": true
}

Redo a profile definition

Redo a profile definition.

path Parameters
id
required
integer (Id) [ 0 .. 2147483647 ]
Request Body schema: application/json
version
required
integer (Version) [ 0 .. 2147483647 ]

Responses

Request samples

Content type
application/json
{
  • "version": 2147483647
}

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "name": "string",
  • "config": {
    },
  • "created_by": 2147483647,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_by": 2147483647,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "can_undo": true,
  • "can_redo": true,
  • "version": 0,
  • "is_deleted": true
}

Get a profile configuration

Get a profile configuration.

path Parameters
id
required
integer (Id) [ 0 .. 2147483647 ]

Responses

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "name": "string",
  • "config": {
    },
  • "created_by": 2147483647,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_by": 2147483647,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "can_undo": true,
  • "can_redo": true,
  • "version": 0,
  • "is_deleted": true
}

Remove a profile

Remove a profile.

path Parameters
id
required
integer (Id) [ 0 .. 2147483647 ]
Request Body schema: application/json
version
required
integer (Version) [ 0 .. 2147483647 ]

Responses

Request samples

Content type
application/json
{
  • "version": 2147483647
}

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "name": "string",
  • "config": {
    },
  • "created_by": 2147483647,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_by": 2147483647,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "can_undo": true,
  • "can_redo": true,
  • "version": 0,
  • "is_deleted": true
}

Update a profile

Update a profile.

path Parameters
id
required
integer (Id) [ 0 .. 2147483647 ]
Request Body schema: application/json
name
required
string (Name) non-empty
required
object (pykouze__bin__pyloth__leader__api__routers__profiles__v6__APIProfileModel)
version
required
integer (Version) [ 0 .. 2147483647 ]

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "name": "string",
  • "config": {
    },
  • "created_by": 2147483647,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_by": 2147483647,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "can_undo": true,
  • "can_redo": true,
  • "version": 0,
  • "is_deleted": true
}

Get profiles associated capture ids

Get profiles associated capture ids.

Responses

Response samples

Content type
application/json
{
  • "entries": [
    ],
  • "version": 2147483647
}

Update profile associated capture ids

Update profile associated capture ids.

Request Body schema: application/json
required
Array of objects (Entries)
version
required
integer (Version) [ 0 .. 2147483647 ]

Responses

Request samples

Content type
application/json

Move capture 1 from profile 0 to 3.Capture 1 needs to be assigned to profile 0 else an error will be returned.

{
  • "entries": [
    ],
  • "version": 1
}

Response samples

Content type
application/json
{
  • "entries": [
    ],
  • "version": 2147483647
}

Get all profiles

Get all profiles.

query Parameters
filter[profile.id][contains]
Array of integers (Filter[Profile.Id][Contains]) [ items [ 0 .. 2147483647 ] ]

Contains operator for field profile.id

filter[profile.id][notContains]
Array of integers (Filter[Profile.Id][Notcontains]) [ items [ 0 .. 2147483647 ] ]

Not Contains operator for field profile.id

filter[profile.is_deleted][eq]
boolean (Filter[Profile.Is Deleted][Eq])

Equal operator for field profile.is_deleted

Responses

Response samples

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

Create a profile

Create a profile.

Request Body schema: application/json
name
required
string (Name) non-empty
required
object (pykouze__bin__pyloth__leader__api__routers__profiles__v6__APIProfileModel)

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "name": "string",
  • "config": {
    },
  • "created_by": 2147483647,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_by": 2147483647,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "can_undo": true,
  • "can_redo": true,
  • "version": 0,
  • "is_deleted": true
}

Peview an undo of a profile definition

Preview an undo of a profile definition.

path Parameters
id
required
integer (Id) [ 0 .. 2147483647 ]

Responses

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "name": "string",
  • "config": {
    },
  • "created_by": 2147483647,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_by": 2147483647,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "can_undo": true,
  • "can_redo": true,
  • "version": 0,
  • "is_deleted": true
}

Undo a profile definition

Undo a profile definition.

path Parameters
id
required
integer (Id) [ 0 .. 2147483647 ]
Request Body schema: application/json
version
required
integer (Version) [ 0 .. 2147483647 ]

Responses

Request samples

Content type
application/json
{
  • "version": 2147483647
}

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "name": "string",
  • "config": {
    },
  • "created_by": 2147483647,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_by": 2147483647,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "can_undo": true,
  • "can_redo": true,
  • "version": 0,
  • "is_deleted": true
}

Perview an undo of a profile definition

Preview an undo of a profile definition.

path Parameters
id
required
integer (Id) [ 0 .. 2147483647 ]

Responses

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "name": "string",
  • "config": {
    },
  • "created_by": 2147483647,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_by": 2147483647,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "can_undo": true,
  • "can_redo": true,
  • "version": 0,
  • "is_deleted": true
}

Redo a profile definition

Redo a profile definition.

path Parameters
id
required
integer (Id) [ 0 .. 2147483647 ]
Request Body schema: application/json
version
required
integer (Version) [ 0 .. 2147483647 ]

Responses

Request samples

Content type
application/json
{
  • "version": 2147483647
}

Response samples

Content type
application/json
{
  • "id": 2147483647,
  • "name": "string",
  • "config": {
    },
  • "created_by": 2147483647,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_by": 2147483647,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "can_undo": true,
  • "can_redo": true,
  • "version": 0,
  • "is_deleted": true
}

zone

Get latest zone definition

Get definitions of zones.

query Parameters
from_version
integer (From Version)
Default: 0

From which version to fetch the configuration, if no argument has been set, it will fetch the configuration since the beginning.

to_version
integer (To Version)

Until which version to fetch the configuration, if no argument has been set, it will fetch until the latest configuration.

include_deleted
boolean (Include Deleted)
Default: false

Include deleted zones.

Responses

Response samples

Content type
application/json
{
  • "version": {
    },
  • "entries": [
    ],
  • "can_undo": true,
  • "can_redo": true
}

Create multiple zones

Create multiple zones.

query Parameters
tag_check_enabled
boolean (Tag Check Enabled)
Default: true
Request Body schema: application/json
required
object (Version)

Current version of the configuration.

required
Array of objects (Entries) non-empty

List of changes to apply.

Responses

Request samples

Content type
application/json
{
  • "version": {
    },
  • "entries": [
    ]
}

Response samples

Content type
application/json
{
  • "version": {
    },
  • "entries": [
    ],
  • "can_undo": true,
  • "can_redo": true
}

Delete multiple zones

Delete multiple zones.

query Parameters
recursive
boolean (Recursive)
Default: false

Delete any related sub-zone if the option is enabled.

Request Body schema: application/json
required
object (Version)

Current version of the configuration.

required
Array of objects (Entries) non-empty

List of zones to delete.

Responses

Request samples

Content type
application/json
{
  • "version": {
    },
  • "entries": [
    ]
}

Response samples

Content type
application/json
{
  • "version": {
    },
  • "entries": [
    ],
  • "can_undo": true,
  • "can_redo": true
}

Update multiple zones

Update multiple zones.

query Parameters
tag_check_enabled
boolean (Tag Check Enabled)
Default: true
Request Body schema: application/json
required
object (Version)

Current version of the configuration.

required
Array of objects (Entries) non-empty

List of changes to apply.

Responses

Request samples

Content type
application/json
{
  • "version": {
    },
  • "entries": [
    ]
}

Response samples

Content type
application/json
{
  • "version": {
    },
  • "entries": [
    ],
  • "can_undo": true,
  • "can_redo": true
}

Export current zones into a JSON or CSV file

Export zone configuration.

query Parameters
format
string (ZonesFormat)
Default: "json"
Enum: "csv" "json"

An enumeration.

Responses

Response samples

Content type
{
  • "entries": [
    ]
}

Import multiple zones into Pyloth

Import zone configuration.

query Parameters
tag_check_enabled
boolean (Tag Check Enabled)
Default: true
Request Body schema: multipart/form-data
file
required
string <binary> (File)
format
string (ZonesFormat)
Default: "json"
Enum: "csv" "json"

An enumeration.

Responses

Response samples

Content type
application/json
{
  • "version": {
    },
  • "entries": [
    ],
  • "can_undo": true,
  • "can_redo": true
}

run tag_check Deprecated

query Parameters
ip
string (Ip)
mac
string (Mac)
vlan
integer (Vlan)
keep_temporary_files
boolean (Keep Temporary Files)
Default: true

Responses

Response samples

Content type
application/json
{
  • "zone_id": 0,
  • "rule_id": 0
}

run tag_check Deprecated

query Parameters
keep_temporary_files
boolean (Keep Temporary Files)
Default: true
Request Body schema: application/json
ip
string (Ip)
mac
string (Mac)
vlan
integer (Vlan)

Responses

Request samples

Content type
application/json
{
  • "ip": "string",
  • "mac": "string",
  • "vlan": 0
}

Response samples

Content type
application/json
{
  • "zone_id": 0,
  • "rule_id": 0
}

Import multiple zones from nevrax into Pyloth

Import multiple applications.

query Parameters
encoding
string (NevraxEncodingCSV)
Default: "utf-8"
Enum: "utf-8" "utf-16" "mac-roman" "cp1252" "iso-8859-15"

An enumeration.

Request Body schema: multipart/form-data
file
required
string <binary> (File)

Responses

Response samples

Content type
application/json
{
  • "version": {
    },
  • "entries": [
    ],
  • "can_undo": true,
  • "can_redo": true
}

Preview an undo of a zone change

Preview an undo of a zone change.

Responses

Response samples

Content type
application/json
{
  • "version": {
    },
  • "entries": [
    ],
  • "can_undo": true,
  • "can_redo": true
}

Undo a zone change

Undo a zone change.

Request Body schema: application/json
required
object (Version)

Latest version fetched by the user.

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "version": {
    },
  • "entries": [
    ],
  • "can_undo": true,
  • "can_redo": true
}

Preview a redo of a zone change

Preview a redo of a zone change.

Responses

Response samples

Content type
application/json
{
  • "version": {
    },
  • "entries": [
    ],
  • "can_undo": true,
  • "can_redo": true
}

Redo a zone change

Redo a zone change.

Request Body schema: application/json
required
object (Version)

Latest version fetched by the user.

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "version": {
    },
  • "entries": [
    ],
  • "can_undo": true,
  • "can_redo": true
}

Get latest zone configuration version

Get latest zone configuration version.

Responses

Response samples

Content type
application/json
{
  • "id": 2147483647
}

gpg

Get the current GPG public key of the current user

Responses

Response samples

Content type
application/json
{
  • "version": {
    },
  • "key_id": "string",
  • "issued_at": "2019-08-24T14:15:22Z",
  • "expire_at": "2019-08-24T14:15:22Z",
  • "user_ids": [
    ],
  • "fingerprint": "string",
  • "created_by": 2147483647,
  • "created_at": "2019-08-24T14:15:22Z"
}

Get all GPG public keys of the current user

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get the current GPG public key for all users

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get full history of used GPG keys

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Set the GPG public key for file encryption

Request Body schema: multipart/form-data
file
required
string <binary> (File)

Responses

Response samples

Content type
application/json
{
  • "version": {
    },
  • "key_id": "string",
  • "issued_at": "2019-08-24T14:15:22Z",
  • "expire_at": "2019-08-24T14:15:22Z",
  • "user_ids": [
    ],
  • "fingerprint": "string",
  • "created_by": 2147483647,
  • "created_at": "2019-08-24T14:15:22Z"
}

system

Get the current GPG public key of the current user

Responses

Response samples

Content type
application/json
{
  • "version": {
    },
  • "key_id": "string",
  • "issued_at": "2019-08-24T14:15:22Z",
  • "expire_at": "2019-08-24T14:15:22Z",
  • "user_ids": [
    ],
  • "fingerprint": "string",
  • "created_by": 2147483647,
  • "created_at": "2019-08-24T14:15:22Z"
}

Get all GPG public keys of the current user

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get the current GPG public key for all users

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get full history of used GPG keys

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Set the GPG public key for file encryption

Request Body schema: multipart/form-data
file
required
string <binary> (File)

Responses

Response samples

Content type
application/json
{
  • "version": {
    },
  • "key_id": "string",
  • "issued_at": "2019-08-24T14:15:22Z",
  • "expire_at": "2019-08-24T14:15:22Z",
  • "user_ids": [
    ],
  • "fingerprint": "string",
  • "created_by": 2147483647,
  • "created_at": "2019-08-24T14:15:22Z"
}

Get latest system config definition

Get definitions of systems config.

query Parameters
filter[capture.id][contains]
Array of integers (Filter[Capture.Id][Contains]) [ items [ 0 .. 2147483647 ] ]

Contains operator for field capture.id

filter[capture.id][notContains]
Array of integers (Filter[Capture.Id][Notcontains]) [ items [ 0 .. 2147483647 ] ]

Not Contains operator for field capture.id

offset
integer (Offset) >= 0
Default: 0
limit
integer (Limit) >= 0
Default: 50

Responses

Response samples

Content type
application/json
{
  • "entries": [
    ],
  • "total": 0,
  • "offset": 0,
  • "limit": 0
}

Get a system configuration from capture

Get a system configuration from capture.

path Parameters
capture_id
required
integer (Capture Id) [ 0 .. 2147483647 ]

Responses

Response samples

Content type
application/json
{
  • "capture": {
    },
  • "config": {
    },
  • "sources": {
    },
  • "version": 0
}

Update a system configuration

Update a system configuration.

path Parameters
capture_id
required
integer (Capture Id) [ 0 .. 2147483647 ]
Request Body schema: application/json
required
object (pykouze__bin__pyloth__leader__api__models__system__v4__APISystemConfigModel)
required
object (pykouze__bin__pyloth__leader__api__models__system__v4__APISystemConfigModelOverride)
version
required
integer (Version)

Responses

Request samples

Content type
application/json
{
  • "config": {
    },
  • "sources": {
    },
  • "version": 0
}

Response samples

Content type
application/json
{
  • "capture": {
    },
  • "config": {
    },
  • "sources": {
    },
  • "version": 0
}

Get latest system config definition

Get definitions of systems config.

query Parameters
filter[capture.id][contains]
Array of integers (Filter[Capture.Id][Contains]) [ items [ 0 .. 2147483647 ] ]

Contains operator for field capture.id

filter[capture.id][notContains]
Array of integers (Filter[Capture.Id][Notcontains]) [ items [ 0 .. 2147483647 ] ]

Not Contains operator for field capture.id

offset
integer (Offset) >= 0
Default: 0
limit
integer (Limit) >= 0
Default: 50

Responses

Response samples

Content type
application/json
{
  • "entries": [
    ],
  • "total": 0,
  • "offset": 0,
  • "limit": 0
}

Get a system configuration from capture

Get a system configuration from capture.

path Parameters
capture_id
required
integer (Capture Id) [ 0 .. 2147483647 ]

Responses

Response samples

Content type
application/json
{
  • "capture": {
    },
  • "config": {
    },
  • "sources": {
    },
  • "version": 0
}

Update a system configuration

Update a system configuration.

path Parameters
capture_id
required
integer (Capture Id) [ 0 .. 2147483647 ]
Request Body schema: application/json
required
object (pykouze__bin__pyloth__leader__api__models__system__v5__APISystemConfigModel)
required
object (pykouze__bin__pyloth__leader__api__models__system__v5__APISystemConfigModelOverride)
version
required
integer (Version)

Responses

Request samples

Content type
application/json
{
  • "config": {
    },
  • "sources": {
    },
  • "version": 0
}

Response samples

Content type
application/json
{
  • "capture": {
    },
  • "config": {
    },
  • "sources": {
    },
  • "version": 0
}

Get latest system config definition

Get definitions of systems config.

query Parameters
filter[capture.id][contains]
Array of integers (Filter[Capture.Id][Contains]) [ items [ 0 .. 2147483647 ] ]

Contains operator for field capture.id

filter[capture.id][notContains]
Array of integers (Filter[Capture.Id][Notcontains]) [ items [ 0 .. 2147483647 ] ]

Not Contains operator for field capture.id

offset
integer (Offset) >= 0
Default: 0
limit
integer (Limit) >= 0
Default: 50

Responses

Response samples

Content type
application/json
{
  • "entries": [
    ],
  • "total": 0,
  • "offset": 0,
  • "limit": 0
}

Get a system configuration from capture

Get a system configuration from capture.

path Parameters
capture_id
required
integer (Capture Id) [ 0 .. 2147483647 ]

Responses

Response samples

Content type
application/json
{
  • "capture": {
    },
  • "config": {
    },
  • "sources": {
    },
  • "version": 0
}

Update a system configuration

Update a system configuration.

path Parameters
capture_id
required
integer (Capture Id) [ 0 .. 2147483647 ]
Request Body schema: application/json
required
object (pykouze__bin__pyloth__leader__api__models__system__v6__APISystemConfigModel)
required
object (pykouze__bin__pyloth__leader__api__models__system__v6__APISystemConfigModelOverride)
version
required
integer (Version)

Responses

Request samples

Content type
application/json
{
  • "config": {
    },
  • "sources": {
    },
  • "version": 0
}

Response samples

Content type
application/json
{
  • "capture": {
    },
  • "config": {
    },
  • "sources": {
    },
  • "version": 0
}