Skip to navigation
Rest APIAPI ReferenceAgent Insights Jobs

Create Agent Insights job

View as Markdown

Creates the Agent Insights job for a project, disabled: the daily schedule stays off until the job is enabled with PATCH. 409 if one already exists.

Path parameters

projectIdstringRequiredformat: "uuid"

Response headers

LocationstringOptional
URI of the created job

Response

Job created
project_idstringRead-onlyformat: "uuid"
idstringOptionalRead-onlyformat: "uuid"
statusenumOptionalRead-only
Allowed values:
auto_first_run_enrolledbooleanOptionalRead-only
auto_first_run_atdatetimeOptionalRead-only
last_scan_atdatetimeOptionalRead-only
last_failure_reasonstringOptionalRead-only
last_failure_detailstringOptionalRead-only
last_failed_atdatetimeOptionalRead-only
guidancestringOptionalRead-only

Project guidance sent to every run; null when none

guidance_updated_bystringOptionalRead-only
Who last saved the guidance
guidance_updated_atdatetimeOptionalRead-only
When the guidance was last saved
guidance_versionintegerOptionalRead-only

Bumped each time the guidance text changes; 0 = never saved

results_guidance_versionintegerOptionalRead-only

Guidance version the current results were produced with; null = no run since guidance existed

created_atdatetimeOptionalRead-only
created_bystringOptionalRead-only
last_updated_atdatetimeOptionalRead-only
last_updated_bystringOptionalRead-only

Errors

404
Not Found Error
409
Conflict Error