Skip to main content

API Changelog Version 2.29.0

Released on June 17th

Written by Helyette Mehouelley

Impact level : high

Deprecation note:

The following endpoints have been removed as part of the tag management API standardization:

  • GET /api/auth/assets/tags → Use GET /api/auth/tags to list tags.

  • PATCH /api/auth/assets/tags/{id} → Use PATCH /api/auth/tags/{id} to update a tag.

  • POST /api/auth/assets/tags/{id} → Use POST /api/auth/assets/tags to associate tags with assets.

  • DELETE /api/auth/assets/tags/{id} → Use DELETE /api/auth/tags/ to delete tags.

  • GET /api/auth/assets/tags/{id} has been removed and has no replacement.

API Changes

GET /api/auth/alerts/

  • ⚠️ Changed the type of the org_id query parameter from number to integer.

  • Changed the type of the level query parameter from number to string.

  • Changed the type of the type query parameter from number to string.

POST /api/auth/asm/cve/related-assets-count/

  • Added the optional asset_availability query parameter.

  • Added the optional teams query parameter.

GET /api/auth/assets/

  • ⚠️ Removed the team query parameter.

  • Added the optional teams query parameter.

GET /api/auth/assets/by-control-warning-impacted

  • ⚠️ Removed the team query parameter.

  • Added the optional teams query parameter.

GET /api/auth/assets/by-types

  • ⚠️ Removed the team query parameter.

  • Added the optional teams query parameter.

GET /api/auth/assets/criticalities

  • ⚠️ Removed the team query parameter.

  • Added the optional teams query parameter.

GET /api/auth/assets/group/

  • ⚠️ Removed the team query parameter.

  • Added the optional teams query parameter.

GET /api/auth/assets/statistics

  • ⚠️ Removed the team query parameter.

  • Added the optional teams query parameter.

GET /api/auth/assets/tags/

  • ⚠️ Endpoint removed without prior deprecation.

DELETE /api/auth/assets/tags/{id}/

  • ⚠️ Endpoint removed without prior deprecation.

GET /api/auth/assets/tags/{id}/

  • ⚠️ Endpoint removed without prior deprecation.

PATCH /api/auth/assets/tags/{id}/

  • ⚠️ Endpoint removed without prior deprecation.

POST /api/auth/assets/tags/{id}/

  • ⚠️ Endpoint removed without prior deprecation.

GET /api/auth/controls/

  • Added the optional id query parameter.

  • Added the optional teams query parameter.

  • Changed the type of the result query parameter from integer to string.

GET /api/auth/pentests/

  • ⚠️ Removed the team query parameter.

GET /api/auth/remediations

  • Added the optional teams query parameter.

GET /api/auth/remediations/{id}/comments

  • Added the optional teams query parameter.

GET /api/auth/risks/

  • ⚠️ Removed the team query parameter.

  • Added the optional teams query parameter.

GET /api/auth/risks/all-opened-count/

  • ⚠️ Removed the team query parameter.

  • Added the optional teams query parameter.

GET /api/auth/security-checks/

  • ⚠️ Set the minimum value of the org_id query parameter to 1.

  • The optional items/risk_insights response property is now read-only for HTTP 200 responses.

  • The items/risk_insights response property is now required for HTTP 200 responses.

  • Removed the default value [] from the risk_insights response property.

  • Removed enum values 0, 1, 2, 3, and 4 from items/risk_insights/items/severity.

  • Added the required items/latest_scans/items/finished_at response property.

  • Added the required items/vulnerabilities/items/count response property.

  • Added the required items/vulnerabilities/items/severity response property.

GET /api/auth/security-checks/asset/{asset_id}

  • ⚠️ Removed the required response property id.

  • ⚠️ Removed the required response property latest_scans.

  • ⚠️ Removed the required response property title.

  • ⚠️ Removed the required response property vulnerabilities.

  • ⚠️ Removed the required response property webservers_required.

  • ⚠️ Removed the optional response property description.

  • ⚠️ Removed the optional response property is_auto.

  • ⚠️ Removed the optional response property is_available.

  • ⚠️ Removed the optional response property risk_insights.

  • ⚠️ Removed the optional response property scan_type.

  • Replaced operation ID get_security_check_specific_asset with security_checks_asset_retrieve.

  • Added the required results response property.

  • Added the required status response property.

GET /api/auth/security-checks/scans

  • ⚠️ Changed the type of results/items/assets/additionalProperties from an unspecified type to an array.

GET /api/auth/typosquatted-domains

  • Added the optional teams query parameter.

GET /api/auth/typosquatted-domains/by-status

  • Added the optional teams query parameter.

GET /api/auth/typosquatted-domains/export

  • Added the optional teams query parameter.

GET /api/auth/users/

  • ⚠️ Removed the team query parameter.

  • Added the optional teams query parameter.

GET /api/auth/users/export/csv

  • ⚠️ Removed the team query parameter.

  • Added the optional teams query parameter.

GET /api/auth/vulns/

  • ⚠️ Removed the team query parameter.

  • Added the optional teams query parameter.

GET /api/auth/vulns/severities

  • ⚠️ Removed the required severities response property.

  • ⚠️ Removed the team query parameter.

  • Added the optional teams query parameter.

  • Added the required count response property.

  • Added the required severity response property.

GET /api/auth/vulns/severities/over-time

  • ⚠️ Removed the team query parameter.

  • Added the optional teams query parameter.

GET /api/auth/vulns/severities/statistics

  • ⚠️ Removed the team query parameter.

  • Added the optional teams query parameter.

GET /api/auth/vulns/{id}/events

  • ⚠️ Removed the team query parameter.

  • Added the optional teams query parameter.

GET /api/auth/vulns/{id}/retests

  • ⚠️ Removed the team query parameter.

  • Added the optional teams query parameter.

GET /api/auth/vulns/{id}/tickets

  • ⚠️ Removed the team query parameter.

  • Added the optional teams query parameter.

Components

  • Removed the AssetTagAddToAssetsSuccess schema.

  • Removed the CountBySeverity schema.

  • Removed the PaginatedAssetTagList schema.

  • Removed the PatchedAssetTag schema.

  • Removed the _Severities schema.

  • Removed the create_asset schema.

You can access the complete API documentation here.

Did this answer your question?