nova

Record Onboarding Plan Route

put/api/v1/nova/discovery/onboarding-plans/{agent_id}

Path parameters

agent_idstring uuid required

Headers

X-Review-Receiptstring nullable

Authorizationstring nullable

X-Request-IDstring nullable

Request body

summarystring required

intentstring required

scope_instructionsstring required

Instructions for a scope guardrail: permitted activities and boundaries.

Response

Successful Response

agent_idstring uuid required

repository_idstring uuid required

scan_job_idstring uuid nullable required

head_shastring nullable required

recorded_bystring required

recorded_by_refstring nullable required

observedobject required

statusstring required

planner_head_shastring nullable required

applied_resourcesobject nullable required

apply_completeboolean required

applied_atstring date-time nullable required

changed_since_onboardedboolean required

created_atstring date-time required

updated_atstring date-time required

Changes

Changed in 4 of the 13 revisions of this API.476

Sep 27, 2026b20a3bdd6219312See the full diff
- ▲
  added the new required request property
  new-required-request-property
- ▲
  removed the required property / from the response with the status
  response-required-property-removed
- ▲
  removed the required property // from the response with the status
  response-required-property-removed
- ●
  removed the request property
  request-property-removed
- ○
  added the required property / to the response with the status
  response-required-property-added
- ○
  added the required property // to the response with the status
  response-required-property-added
This revision also has 11 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Sep 22, 202666575c8854c1162See the full diff
- ▲
  added the new required request property
  new-required-request-property
- ●
  removed the request property
  request-property-removed
- ●
  removed the request property /
  request-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property // from the response with the status
  response-optional-property-removed
- ●
  removed the optional property // from the response with the status
  response-optional-property-removed
- ●
  removed the optional property /// from the response with the status
  response-optional-property-removed
- ○
  added the required property / to the response with the status
  response-required-property-added
- ○
  added the required property // to the response with the status
  response-required-property-added
This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Sep 19, 2026729390e1c2f01See the full diff
- ○
  added the new optional header request parameter X-Review-Receipt
  new-optional-request-parameter
Sep 11, 20263bf37c9d27841See the full diff
- ○
  endpoint added
  endpoint-added

Full history