Aicscan Documentation
FrançaisEnglish

Versioning

The major version of the API is in the path: https://aicscan.io/v1/…. Every /v1 response also carries the header:

HTTP
Aicscan-Api-Version: 1

What can change in v1#

v1 only receives backward-compatible additions:

  • new endpoints;
  • new fields in responses;
  • new optional parameters;
  • new error codes, new enum values (rule kinds, event types, notification stages);
  • better wording of error messages (error.message).

Your integration must therefore ignore unknown fields, handle an unknown enum value without crashing, and rely on error.code rather than error.message.

What will not change in v1#

  • The name, type and meaning of an existing field.
  • Existing error codes and their HTTP status.
  • The signature format of webhooks and of the real-time stream.

A breaking change will open a new version (/v2), published alongside v1 and announced in the changelog.

OpenAPI document#

The v1 contract is described by an OpenAPI 3.1 document, served by the API itself and always in line with the running version:

Shell
curl -o aicscan-openapi.yaml https://aicscan.io/v1/openapi.yaml