---
title: "Get Jobs"
method: GET
path: "/connect/jobs/"
tags: ["Jobs"]
---

# Get Jobs

`GET /connect/jobs/`

Retrieves the list of jobs that match the given parameters.

## Query parameters

- `kind` string, required
- `parameters[artifact][id]` string

## Response `200`

The array of retrieved jobs

- ModelJob[]
  - `completeTime` string — The date and time when the job was completed
  - `createTime` string — The date and time when the job was created
  - `failCount` integer — The number of times the job was processed but failed
  - `failTime` string — The date and time when the job last failed and was marked incomplete
  - `failure` string — The failure reason
  - `fileExtension` string — The file extension for any attached job result/output data
  - `filter` ModelFilter — Optional filter for the job, typically used for packet filtering
    - `beginTime` string — The begin time for the packet filtering; only packets with timestamps between the BeginTime and EndTime will be included in this filter
    - `dstIp` string — The destintion IP to capture; Note that the PCAP job will allow destination and source data to be interchanged to ensure packets are not missed in certain capture scenarios"
    - `dstPort` integer — The destination port to capture; Note that the PCAP job will allow destination and source data to be interchanged to ensure packets are not missed in certain capture scenarios"
    - `endTime` string — The end time for the packet filtering; only packets with timestamps between the BeginTime and EndTime will be included in this filter
    - `importId` string — An optional import ID to use for locating related import packets
    - `parameters` object — Additional, untyped filter parameters; used by non-PCAP job processors
    - `protocol` string — Require the captured packets to be using this protocol"
    - `srcIp` string — The source IP to capture; Note that the PCAP job will allow destination and source data to be interchanged to ensure packets are not missed in certain capture scenarios"
    - `srcPort` integer — The source port to capture; Note that the PCAP job will allow destination and source data to be interchanged to ensure packets are not missed in certain capture scenarios"
  - `id` integer — The unique Job ID
  - `kind` string — The kind of job that this object represents; blank values represent pcap jobs
  - `nodeId` string — The unique node ID that is responsible for completing this job
  - `owner` string — Owner field [not actively used by the API]
  - `results` ModelJobResult[] — The array of job results; will be empty for jobs that only attach output streams
    - `data` unknown
    - `id` string — The ID or name of the result; varies depending on the job processor
    - `summary` string — Brief summarization of the job result
  - `sensorId` string — Legacy sensor ID field
  - `size` integer — The size of the job stream output, if a stream output was attached
  - `status` integer — The current state of the job. 0 = pending, 1 = complete, 2 = incomplete, 3 = deleted
  - `userId` string — The unique user ID that created this job

## Other responses

- `400` — The provided input object or parameters are malformed or invalid
- `401` — Request was not properly authenticated
- `500` — Internal SOC error; review SOC logs

---

[API](https://skmtc.net/security-onion-solutions/apis/security-onion-connect-api.md) · [All operations](https://skmtc.net/security-onion-solutions/apis/security-onion-connect-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/security-onion-solutions/security-onion-connect-api/versions/0576ce393f8d/schema)