HomeGuidesAPI Reference
API Reference
GuidesAPI ReferenceGitHubAirheads Developer Community
  1. Orchestrator REST APIs
  2. scheduledJobs2

Retrieve historical stats collector job records

get
http://127.0.0.1:8080/statsCollector/job/historical

Retrieves historical job execution records from the stats collector. Returns completed job entries with their execution details, status, and target appliance information. If no parameters are provided, returns up to 1000 most recent historical jobs.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
1 to 180

Filter jobs that ended within the specified number of days. Maximum allowed value is 180 days. Can be combined with scheduleId parameter.

integer

Filter historical jobs by the associated scheduled job ID (assocId). Returns jobs that were executed from the specified schedule.

string

When set to any non-empty value with scheduleId, returns only the most recent historical job for that schedule. Ignored if scheduleId is not provided.

int64

Start time filter in Unix epoch seconds. Must be used together with 'to' parameter to define a time range. Returns jobs with end_time within the specified range.

int64

End time filter in Unix epoch seconds. Must be used together with 'from' parameter to define a time range. Returns jobs with end_time within the specified range.

integer
enum

Filter by job category type. Valid values: 1=TestJob, 2=GMS Report, 3=GMS Backup, 4=Appliance Reboot/Shutdown, 5=Appliance QOS Scheduling, 6=IPsec Preshared Key Rotation, 7=IKEless Seed Rotation, 8=Auto MTU Discover, 14=IDS/IPS Signature Downloader, 16=Stats Collector Backup.

integer

Stats collector ID to filter results from a specific stats collector instance. When used with jobCategory, returns the latest historical job for that category from the specified stats collector.

Responses

Updated about 13 hours ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 13 hours ago

Did this page help you?