Retrieve job collection

get

https://sentinel.whitehatsec.com/api/job

This operation returns an object containing information about job resources, which describe runnable configurations such as scans and vuln retests.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

target

string

Retrieve jobs that have a specific target ID. A 'target' is the site or application where the job runs, but the target ID is a separate identifier, not the site or application ID.

site

string

Retrieve jobs that have a target of type 'site' and the site ID given.

jobtype

string

enum

Defaults to scan

Retrieve jobs of the specified job type.

Allowed:

display_instances

string

enum

Defaults to 0

Display information on any instances for each job. An instance represents a specific run of a job at a point in time, so it is possible for a job to have many instances.

Allowed:

display_schedule

string

enum

Defaults to 0

Display information on the active schedule, if any, for each job.

Allowed:

format

string

enum

Defaults to xml

Format of results.

Allowed:

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

400

BadRequestResponse indicates a request with invalid parameters.

401

UnauthorizedResponse signals an unauthorized API access.

403

ForbiddenResponse signals a request for a resource that does not exist or is not authorized.

404

NotFound the requested resource could not be found.

500

GenericError generic error.

200Provides the list of jobs.