Skip to content

Versioning and changelog

The version is in the path: /v1.

Within v1 these changes can happen without notice, so build your client to tolerate them:

  • new endpoints, and new optional parameters;
  • new fields in responses;
  • new values in fields documented as open lists, such as webhook event types and scan types (other already covers unknown kinds);
  • new error details.

These changes need a new version, or a deprecation period announced in this changelog:

  • removing or renaming an endpoint, a parameter or a response field;
  • changing a field’s type or meaning;
  • making an optional parameter required.

Ignore fields you do not know, and branch on error code, never message.

  • First release of the public API: workspace, repositories, scans, issues, issue groups, exports, triage and exception requests, autofix, Kubernetes, DAST and pentest targets, teams, members, audit log, reports and webhooks.
  • API keys and OAuth client credentials with scopes.