Skip to content

DOCS-38: Update API reference - #414

Merged
jeff-matthews merged 1 commit into
release/v9.7.0from
DOCS-38-api-reference
Sep 1, 2026
Merged

DOCS-38: Update API reference#414
jeff-matthews merged 1 commit into
release/v9.7.0from
DOCS-38-api-reference

Conversation

@jeff-matthews

Copy link
Copy Markdown
Contributor

Summary

This pull request (PR) updates the OpenAPI spec that we use to generate the REST API reference for the v9.7.0 release.

Aside from updates to request and response properties for existing paths, the following significant updates were made.

New endpoints

Mostly related to the collector support bundles, notification system, and protected asset scores:

  • GET /api/v2/alert-attempts
  • POST /api/v2/alert-attempts/retry
  • GET /api/v2/alert-event-types
  • GET /api/v2/alert-events
  • GET /api/v2/alert-events/{alert_event_id}
  • GET /api/v2/alert-webhooks
  • POST /api/v2/alert-webhooks
  • DELETE /api/v2/alert-webhooks/{alert_webhook_id}
  • GET /api/v2/alert-webhooks/{alert_webhook_id}
  • PATCH /api/v2/alert-webhooks/{alert_webhook_id}
  • POST /api/v2/alert-webhooks/{alert_webhook_id}/rotate-secret
  • POST /api/v2/alert-webhooks/{alert_webhook_id}/test
  • GET /api/v2/alerts
  • POST /api/v2/alerts
  • DELETE /api/v2/alerts/{alert_id}
  • GET /api/v2/alerts/{alert_id}
  • PATCH /api/v2/alerts/{alert_id}
  • GET /api/v2/asset-scores/zone-protected-asset-score
  • POST /api/v2/clients/management/artifacts
  • GET /api/v2/clients/management/artifacts/{artifact_id}
  • POST /api/v2/clients/management/artifacts/{artifact_id}/complete
  • POST /api/v2/clients/management/artifacts/{artifact_id}/parts/{part_number}
  • GET /api/v2/clients/management/available
  • POST /api/v2/clients/management/end
  • POST /api/v2/clients/management/start
  • DELETE /api/v2/clients/{client_id}/artifacts/{artifact_id}
  • GET /api/v2/clients/{client_id}/artifacts/{artifact_id}
  • GET /api/v2/clients/{client_id}/artifacts/{artifact_id}/download
  • POST /api/v2/clients/{client_id}/artifacts/{artifact_id}/download-url
  • POST /api/v2/clients/{client_id}/management

See attachment for oasdiff:
openapi_change.log

@coderabbitai

coderabbitai Bot commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Essentials

Run ID: a5761615-aaf7-442b-8e60-06e79148eda6

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

Comment @coderabbitai help to get the list of available commands.

@jeff-matthews
jeff-matthews merged commit 71c5e2c into release/v9.7.0 Sep 1, 2026
3 checks passed
@jeff-matthews
jeff-matthews deleted the DOCS-38-api-reference branch September 1, 2026 19:38
@github-actions github-actions Bot locked and limited conversation to collaborators Sep 1, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants