Update Agent Insights project guidance

PUT

/v1/private/agent-insights/jobs/:projectId/guidance

PUT

/api/v1/private/agent-insights/jobs/:projectId/guidance

curl -X PUT http://localhost:5173/api/v1/private/agent-insights/jobs/projectId/guidance \
     -H "Content-Type: application/json" \
     -d '{
  "guidance": "string"
}'

{
  "project_id": "string",
  "id": "string",
  "status": "enabled",
  "auto_first_run_enrolled": true,
  "auto_first_run_at": "2024-01-15T09:30:00Z",
  "last_scan_at": "2024-01-15T09:30:00Z",
  "last_failure_reason": "string",
  "last_failure_detail": "string",
  "last_failed_at": "2024-01-15T09:30:00Z",
  "guidance": "string",
  "guidance_updated_by": "string",
  "guidance_updated_at": "2024-01-15T09:30:00Z",
  "guidance_version": 1,
  "results_guidance_version": 1,
  "created_at": "2024-01-15T09:30:00Z",
  "created_by": "string",
  "last_updated_at": "2024-01-15T09:30:00Z",
  "last_updated_by": "string"
}

Saves the project guidance sent to every Agent Insights run, creating the job (disabled) if the project has none. Empty or whitespace-only clears it. The guidance version is bumped only when the text changes. 404 while guidance is not enabled.

Path parameters

projectIdstringRequiredformat: "uuid"

Request

This endpoint expects an object.

guidancestringRequired0-5000 characters

Project guidance for Agent Insights runs. Empty or whitespace-only clears it

Response

Job with the saved guidance

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

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error