Retrieve schedules

get

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

This operation returns an object containing a list all active schedules for assets the user has permission to access.

Query Params

name

string

Query by schedule name. Returns schedules with the given name.

start_date

string

Query by start date. The start date is the date the schedule was created. Format: YYYY-MM-DDThh:mm:ss. EXAMPLE: 2017-01-01T00:00:00 will find all schedules with a start_date of midnight on January 1, 2017.

duration

string

Query by the time duration in seconds.

timezone

string

Query by the time zone of schedule. EXAMPLE: America/New_York

job

int32

Query by the job ID of the schedule.

creator

int32

Query by the schedule creator's ID. Returns schedules created by the given user for assets the requester can access.

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.

500

GenericError generic error.

200Provides list of all active schedules.