Skip to main content

API Changelog Version 2.28.0

Released on June 03rd

Written by Helyette Mehouelley

Impact level : high​

With the introduction of Tag Editor, several API endpoints have been deprecated or removed:

  • POST /api/auth/assets/{id}/tags/add has been removed. This endpoint previously allowed creating a tag and assigning it directly to an asset. Use POST /api/auth/tags/ instead, with the asset_ids field provided in the request body.

  • DELETE /api/auth/assets/{id}/tags/{pk_tag}/ has been removed. This endpoint previously allowed dissociating a single tag from an asset. Use DELETE /api/auth/assets/tags instead, which supports dissociating multiple tags from multiple assets.

Other tag-related endpoints may be removed in a future release:

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

  • GET /api/auth/assets/tags/{id} → Use GET /api/auth/tags/{id} to retrieve a tag.

  • 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/{id} to delete a tag.

GET /api/auth/asm/cve/

  • ⚠️ The asset_id query parameter type was changed from number to integer.

  • ⚠️ Removed the identifier query parameter.

  • Added the optional teams query parameter.

GET /api/auth/asm/cve/count/

  • ⚠️ The asset_id query parameter type was changed from number to integer.

  • ⚠️ Removed the identifier query parameter.

  • Added the optional teams query parameter.

GET /api/auth/asm/cve/v2/

  • ⚠️ The asset_id query parameter type was changed from number to integer.

  • ⚠️ Removed the identifier query parameter.

  • Added the optional teams query parameter.

GET /api/auth/asm/ip-address/

  • ⚠️ Added #/components/schemas/Type379Enum to the results/items/type response property's oneOf list for HTTP 200 responses.

  • Removed #/components/schemas/Type73cEnum from the results/items/type response property's oneOf list for HTTP 200 responses.

GET /api/auth/asm/ip-address/{id}/

  • ⚠️ Added #/components/schemas/Type379Enum to the type response property's oneOf list for HTTP 200 responses.

  • Removed #/components/schemas/Type73cEnum from the type response property's oneOf list for HTTP 200 responses.

GET /api/auth/assets/

  • Added #/components/schemas/TypeC0bEnum to the results/items/type response property's allOf list for HTTP 200 responses.

  • Removed #/components/schemas/TypeEf5Enum from the results/items/type response property's allOf list for HTTP 200 responses.

  • Added the required results/items/thumbnail_url response property.

POST /api/auth/assets/

  • Added #/components/schemas/TypeC0bEnum to the data/type response property's allOf list for HTTP 201 responses.

  • Removed #/components/schemas/TypeEf5Enum from the data/type response property's allOf list for HTTP 201 responses.

  • Added the required data/screenshot_url response property.

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

  • Added #/components/schemas/TypeC0bEnum to the results/items/type response property's allOf list for HTTP 200 responses.

  • Removed #/components/schemas/TypeEf5Enum from the results/items/type response property's allOf list for HTTP 200 responses.

GET /api/auth/assets/export/json

  • Added #/components/schemas/TypeC0bEnum to the type response property's allOf list for HTTP 200 responses.

  • Removed #/components/schemas/TypeEf5Enum from the type response property's allOf list for HTTP 200 responses.

  • Added the required screenshot_url response property.

POST /api/auth/assets/ports

  • Added #/components/schemas/TypeC0bEnum to the type response property's allOf list for HTTP 200 responses.

  • Removed #/components/schemas/TypeEf5Enum from the type response property's allOf list for HTTP 200 responses.

  • Added the required screenshot_url response property.

GET /api/auth/assets/tags/

  • Added the optional used query parameter.

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

  • Added #/components/schemas/TypeC0bEnum to the type response property's allOf list for HTTP 200 responses.

  • Removed #/components/schemas/TypeEf5Enum from the type response property's allOf list for HTTP 200 responses.

  • Added the required screenshot_url response property.

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

  • ⚠️ Added #/components/schemas/TypeC0bEnum to the type request property's allOf list.

  • ⚠️ Removed #/components/schemas/TypeEf5Enum from the type request property's allOf list.

  • Added #/components/schemas/TypeC0bEnum to the type response property's allOf list for HTTP 200 responses.

  • Removed #/components/schemas/TypeEf5Enum from the type response property's allOf list for HTTP 200 responses.

  • Added the required screenshot_url response property.

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

  • ⚠️ Added #/components/schemas/TypeC0bEnum to the type request property's allOf list.

  • ⚠️ Removed #/components/schemas/TypeEf5Enum from the type request property's allOf list.

  • Added #/components/schemas/TypeC0bEnum to the type response property's allOf list for HTTP 200 responses.

  • Removed #/components/schemas/TypeEf5Enum from the type response property's allOf list for HTTP 200 responses.

  • Added the required screenshot_url response property.

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

  • ⚠️ Added #/components/schemas/TypeC0bEnum to the type request property's allOf list.

  • ⚠️ Removed #/components/schemas/TypeEf5Enum from the type request property's allOf list.

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

  • ⚠️ Endpoint removed without prior deprecation.

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

  • ⚠️ Endpoint removed without prior deprecation.

GET /api/auth/pentests/

  • Added the optional teams query parameter.

  • The team query parameter type was generalized from integer to number.

  • The team_not query parameter type was generalized from integer to number.

  • The user query parameter type was generalized from integer to number.

GET /api/auth/security-checks/

  • Added the optional org_id query parameter.

  • Added the optional teams query parameter.

DELETE /api/auth/tags/

  • Added new endpoint.

GET /api/auth/tags/

  • Added new endpoint.

POST /api/auth/tags/

  • ⚠️ Increased the minimum length of the value request property from 0 to 1.

  • ⚠️ Set the maximum length of the value request property to 2048.

  • ⚠️ Removed the HTTP 200 success response.

  • Added the optional asset_ids request property.

  • Added the optional description request property.

  • Added the HTTP 201 success response.

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

  • Added new endpoint.

GET /api/auth/typosquatted-domains

  • Added #/components/schemas/Status756Enum to the results/items/status response property's allOf list for HTTP 200 responses.

  • Removed #/components/schemas/StatusC0bEnum from the results/items/status response property's allOf list for HTTP 200 responses.

GET /api/auth/typosquatted-domains/{id}

  • Added #/components/schemas/Status756Enum to the status response property's allOf list for HTTP 200 responses.

  • Removed #/components/schemas/StatusC0bEnum from the status response property's allOf list for HTTP 200 responses.

GET /api/auth/vulns/

  • ⚠️ Changed the not_vuln_owner query parameter type from string to array.

  • ⚠️ Changed the not_vuln_solution_owner query parameter type from string to array.

GET /api/auth/vulns/severities

  • ⚠️ The critical, high, medium, low, and info severity response properties became optional.

  • Updated operation ID from vulnerabilities_by_severity to vulns_severities_retrieve.

  • Added multiple new optional filtering query parameters.

  • Added a default value of 0.00 for all severity counters in HTTP 200 responses.

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

  • ⚠️ Changed the critical, high, medium, low, and info severity response properties from scalar values to arrays.

  • Updated operation ID from vulnerabilities_severities_over_time to vulns_severities_over_time_retrieve.

  • Added multiple new optional filtering query parameters.

GET /api/auth/vulns/severities/statistics

  • ⚠️ The open.total, open.since_last_week, close.total, and close.since_last_week response properties became optional.

  • Updated operation ID from vulnerabilities_statistics to vulns_severities_statistics_retrieve.

  • Added multiple new optional filtering query parameters.

  • Added default values of 0.00 for statistics counters in HTTP 200 responses.

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

  • ⚠️ Changed the not_vuln_owner query parameter type from string to array.

  • ⚠️ Changed the not_vuln_solution_owner query parameter type from string to array.

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

  • ⚠️ Changed the not_vuln_owner query parameter type from string to array.

  • ⚠️ Changed the not_vuln_solution_owner query parameter type from string to array.

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

  • ⚠️ Changed the not_vuln_owner query parameter type from string to array.

  • ⚠️ Changed the not_vuln_solution_owner query parameter type from string to array.


​

Related Articles
API Changelog Version 1.11.6
API Changelog Version 1.11.11
API Changelog Version 2.5.0
API Changelog version 2.25.0
API Changelog Version 2.27.0
Did this answer your question?