Skip to main content

API Changelog Version 2.27.0

Released on May 21st

Written by Helyette Mehouelley

​Impact level : high

## API Changes

### GET /api/auth/assets/

- ⚠️ the `results/items/liveness` response's property type/format changed from `string`/`` to ``/`` for status `200`

- ⚠️ the `results/items/type` response's property type/format changed from `string`/`` to ``/`` for status `200`

- ⚠️ removed the optional property `results/items/is_active` from the response with the `200` status

- added the new optional `query` request parameter `related_domains`

- added the new optional `query` request parameter `related_ips`

- added the new optional `query` request parameter `related_subdomains`

- added the new optional `query` request parameter `top_domain`

- the response optional property `results/items/score` became read-only for the status `200`

- added `#/components/schemas/LivenessEnum` to the `results/items/liveness` response property `allOf` list for the response status `200`

- added `#/components/schemas/TypeEf5Enum` to the `results/items/type` response property `allOf` list for the response status `200`

- the response property `results/items/score` became required for the status `200`

- removed the `domain` enum value from the `results/items/type` response property for the response status `200`

- removed the `down` enum value from the `results/items/liveness` response property for the response status `200`

- removed the `fqdn` enum value from the `results/items/type` response property for the response status `200`

- removed the `ip` enum value from the `results/items/type` response property for the response status `200`

- removed the `ip-range` enum value from the `results/items/type` response property for the response status `200`

- removed the `ip-subnet` enum value from the `results/items/type` response property for the response status `200`

- removed the `keyword` enum value from the `results/items/type` response property for the response status `200`

- removed the `other` enum value from the `results/items/type` response property for the response status `200`

- removed the `unknown` enum value from the `results/items/liveness` response property for the response status `200`

- removed the `up` enum value from the `results/items/liveness` response property for the response status `200`

### POST /api/auth/assets/

- ⚠️ the `data/type` response's property type/format changed from `string`/`` to ``/`` for status `201`

- ⚠️ removed the required property `data/is_active` from the response with the `201` status

- added `#/components/schemas/TypeEf5Enum` to the `data/type` response property `allOf` list for the response status `201`

- removed the `domain` enum value from the `data/type` response property for the response status `201`

- removed the `fqdn` enum value from the `data/type` response property for the response status `201`

- removed the `ip` enum value from the `data/type` response property for the response status `201`

- removed the `ip-range` enum value from the `data/type` response property for the response status `201`

- removed the `ip-subnet` enum value from the `data/type` response property for the response status `201`

- removed the `keyword` enum value from the `data/type` response property for the response status `201`

- removed the `other` enum value from the `data/type` response property for the response status `201`

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

- ⚠️ the `results/items/type` response's property type/format changed from `string`/`` to ``/`` for status `200`

- added the new optional `query` request parameter `related_domains`

- added the new optional `query` request parameter `related_ips`

- added the new optional `query` request parameter `related_subdomains`

- added the new optional `query` request parameter `top_domain`

- added `#/components/schemas/TypeEf5Enum` to the `results/items/type` response property `allOf` list for the response status `200`

- removed the `domain` enum value from the `results/items/type` response property for the response status `200`

- removed the `fqdn` enum value from the `results/items/type` response property for the response status `200`

- removed the `ip` enum value from the `results/items/type` response property for the response status `200`

- removed the `ip-range` enum value from the `results/items/type` response property for the response status `200`

- removed the `ip-subnet` enum value from the `results/items/type` response property for the response status `200`

- removed the `keyword` enum value from the `results/items/type` response property for the response status `200`

- removed the `other` enum value from the `results/items/type` response property for the response status `200`

### GET /api/auth/assets/by-types

- ⚠️ removed the required property `status` from the response with the `200` status

- api operation id `assets_by_type` removed and replaced with `assets_by_types_retrieve`

- added the new optional `query` request parameter `accessible_by_users`

- added the new optional `query` request parameter `after`

- added the new optional `query` request parameter `asset_owners`

- added the new optional `query` request parameter `asset_tags`

- added the new optional `query` request parameter `before`

- added the new optional `query` request parameter `belong_to_a_team`

- added the new optional `query` request parameter `belong_to_an_asset_group`

- added the new optional `query` request parameter `campaign`

- added the new optional `query` request parameter `created_by`

- added the new optional `query` request parameter `criticality`

- added the new optional `query` request parameter `cve`

- added the new optional `query` request parameter `description__icontains`

- added the new optional `query` request parameter `group`

- added the new optional `query` request parameter `group_not`

- added the new optional `query` request parameter `groups_or`

- added the new optional `query` request parameter `groups_value`

- added the new optional `query` request parameter `ip_state`

- added the new optional `query` request parameter `ip_type`

- added the new optional `query` request parameter `liveness`

- added the new optional `query` request parameter `no_tags`

- added the new optional `query` request parameter `not_asset_owner`

- added the new optional `query` request parameter `org_id`

- added the new optional `query` request parameter `outside_business_hours`

- added the new optional `query` request parameter `ports_available`

- added the new optional `query` request parameter `protection`

- added the new optional `query` request parameter `related_domains`

- added the new optional `query` request parameter `related_ips`

- added the new optional `query` request parameter `related_subdomains`

- added the new optional `query` request parameter `score`

- added the new optional `query` request parameter `search`

- added the new optional `query` request parameter `sorted_by`

- added the new optional `query` request parameter `tags`

- added the new optional `query` request parameter `tags_value`

- added the new optional `query` request parameter `tags_value_union`

- added the new optional `query` request parameter `team`

- added the new optional `query` request parameter `team_not`

- added the new optional `query` request parameter `technology`

- added the new optional `query` request parameter `top_domain`

- added the new optional `query` request parameter `type`

- added the new optional `query` request parameter `user`

- added the new optional `query` request parameter `value`

- added the new optional `query` request parameter `value__icontains`

- added the required property `types` to the response with the `200` status

### GET /api/auth/assets/criticalities

- ⚠️ removed the required property `status` from the response with the `200` status

- api operation id `assets_by_criticality` removed and replaced with `assets_criticalities_retrieve`

- added the new optional `query` request parameter `accessible_by_users`

- added the new optional `query` request parameter `after`

- added the new optional `query` request parameter `asset_owners`

- added the new optional `query` request parameter `asset_tags`

- added the new optional `query` request parameter `before`

- added the new optional `query` request parameter `belong_to_a_team`

- added the new optional `query` request parameter `belong_to_an_asset_group`

- added the new optional `query` request parameter `campaign`

- added the new optional `query` request parameter `created_by`

- added the new optional `query` request parameter `criticality`

- added the new optional `query` request parameter `cve`

- added the new optional `query` request parameter `description__icontains`

- added the new optional `query` request parameter `group`

- added the new optional `query` request parameter `group_not`

- added the new optional `query` request parameter `groups_or`

- added the new optional `query` request parameter `groups_value`

- added the new optional `query` request parameter `ip_state`

- added the new optional `query` request parameter `ip_type`

- added the new optional `query` request parameter `liveness`

- added the new optional `query` request parameter `no_tags`

- added the new optional `query` request parameter `not_asset_owner`

- added the new optional `query` request parameter `org_id`

- added the new optional `query` request parameter `outside_business_hours`

- added the new optional `query` request parameter `ports_available`

- added the new optional `query` request parameter `protection`

- added the new optional `query` request parameter `related_domains`

- added the new optional `query` request parameter `related_ips`

- added the new optional `query` request parameter `related_subdomains`

- added the new optional `query` request parameter `score`

- added the new optional `query` request parameter `search`

- added the new optional `query` request parameter `sorted_by`

- added the new optional `query` request parameter `tags`

- added the new optional `query` request parameter `tags_value`

- added the new optional `query` request parameter `tags_value_union`

- added the new optional `query` request parameter `team`

- added the new optional `query` request parameter `team_not`

- added the new optional `query` request parameter `technology`

- added the new optional `query` request parameter `top_domain`

- added the new optional `query` request parameter `type`

- added the new optional `query` request parameter `user`

- added the new optional `query` request parameter `value`

- added the new optional `query` request parameter `value__icontains`

- added the required property `criticalities` to the response with the `200` status

### GET /api/auth/assets/export/json

- ⚠️ the `type` response's property type/format changed from `string`/`` to ``/`` for status `200`

- ⚠️ removed the required property `is_active` from the response with the `200` status

- added `#/components/schemas/TypeEf5Enum` to the `type` response property `allOf` list for the response status `200`

- removed the `domain` enum value from the `type` response property for the response status `200`

- removed the `fqdn` enum value from the `type` response property for the response status `200`

- removed the `ip` enum value from the `type` response property for the response status `200`

- removed the `ip-range` enum value from the `type` response property for the response status `200`

- removed the `ip-subnet` enum value from the `type` response property for the response status `200`

- removed the `keyword` enum value from the `type` response property for the response status `200`

- removed the `other` enum value from the `type` response property for the response status `200`

### POST /api/auth/assets/ports

- ⚠️ the `type` response's property type/format changed from `string`/`` to ``/`` for status `200`

- ⚠️ removed the required property `is_active` from the response with the `200` status

- added `#/components/schemas/TypeEf5Enum` to the `type` response property `allOf` list for the response status `200`

- removed the `domain` enum value from the `type` response property for the response status `200`

- removed the `fqdn` enum value from the `type` response property for the response status `200`

- removed the `ip` enum value from the `type` response property for the response status `200`

- removed the `ip-range` enum value from the `type` response property for the response status `200`

- removed the `ip-subnet` enum value from the `type` response property for the response status `200`

- removed the `keyword` enum value from the `type` response property for the response status `200`

- removed the `other` enum value from the `type` response property for the response status `200`

### GET /api/auth/assets/statistics

- api operation id `assets_stats` removed and replaced with `assets_statistics_retrieve`

- added the new optional `query` request parameter `accessible_by_users`

- added the new optional `query` request parameter `after`

- added the new optional `query` request parameter `asset_owners`

- added the new optional `query` request parameter `asset_tags`

- added the new optional `query` request parameter `before`

- added the new optional `query` request parameter `belong_to_a_team`

- added the new optional `query` request parameter `belong_to_an_asset_group`

- added the new optional `query` request parameter `campaign`

- added the new optional `query` request parameter `created_by`

- added the new optional `query` request parameter `criticality`

- added the new optional `query` request parameter `cve`

- added the new optional `query` request parameter `description__icontains`

- added the new optional `query` request parameter `group`

- added the new optional `query` request parameter `group_not`

- added the new optional `query` request parameter `groups_or`

- added the new optional `query` request parameter `groups_value`

- added the new optional `query` request parameter `ip_state`

- added the new optional `query` request parameter `ip_type`

- added the new optional `query` request parameter `liveness`

- added the new optional `query` request parameter `no_tags`

- added the new optional `query` request parameter `not_asset_owner`

- added the new optional `query` request parameter `outside_business_hours`

- added the new optional `query` request parameter `ports_available`

- added the new optional `query` request parameter `protection`

- added the new optional `query` request parameter `related_domains`

- added the new optional `query` request parameter `related_ips`

- added the new optional `query` request parameter `related_subdomains`

- added the new optional `query` request parameter `score`

- added the new optional `query` request parameter `search`

- added the new optional `query` request parameter `sorted_by`

- added the new optional `query` request parameter `tags`

- added the new optional `query` request parameter `tags_value`

- added the new optional `query` request parameter `tags_value_union`

- added the new optional `query` request parameter `team`

- added the new optional `query` request parameter `team_not`

- added the new optional `query` request parameter `technology`

- added the new optional `query` request parameter `top_domain`

- added the new optional `query` request parameter `type`

- added the new optional `query` request parameter `user`

- added the new optional `query` request parameter `value`

- added the new optional `query` request parameter `value__icontains`

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

- ⚠️ the `type` response's property type/format changed from `string`/`` to ``/`` for status `200`

- ⚠️ removed the required property `is_active` from the response with the `200` status

- added `#/components/schemas/TypeEf5Enum` to the `type` response property `allOf` list for the response status `200`

- removed the `domain` enum value from the `type` response property for the response status `200`

- removed the `fqdn` enum value from the `type` response property for the response status `200`

- removed the `ip` enum value from the `type` response property for the response status `200`

- removed the `ip-range` enum value from the `type` response property for the response status `200`

- removed the `ip-subnet` enum value from the `type` response property for the response status `200`

- removed the `keyword` enum value from the `type` response property for the response status `200`

- removed the `other` enum value from the `type` response property for the response status `200`

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

- ⚠️ added `#/components/schemas/TypeEf5Enum` to the `type` request property `allOf` list (media type: application/x-www-form-urlencoded)

- ⚠️ added `#/components/schemas/TypeEf5Enum` to the `type` request property `allOf` list (media type: multipart/form-data)

- ⚠️ added `#/components/schemas/TypeEf5Enum` to the `type` request property `allOf` list (media type: application/json)

- ⚠️ the request property `description` became not nullable (media type: application/x-www-form-urlencoded)

- ⚠️ the request property `description` became not nullable (media type: application/json)

- ⚠️ the request property `description` became not nullable (media type: multipart/form-data)

- ⚠️ removed the enum value `domain` of the request property `type` (media type: application/json)

- ⚠️ removed the enum value `domain` of the request property `type` (media type: multipart/form-data)

- ⚠️ removed the enum value `domain` of the request property `type` (media type: application/x-www-form-urlencoded)

- ⚠️ removed the enum value `fqdn` of the request property `type` (media type: application/x-www-form-urlencoded)

- ⚠️ removed the enum value `fqdn` of the request property `type` (media type: multipart/form-data)

- ⚠️ removed the enum value `fqdn` of the request property `type` (media type: application/json)

- ⚠️ removed the enum value `ip` of the request property `type` (media type: multipart/form-data)

- ⚠️ removed the enum value `ip` of the request property `type` (media type: application/json)

- ⚠️ removed the enum value `ip` of the request property `type` (media type: application/x-www-form-urlencoded)

- ⚠️ removed the enum value `ip-range` of the request property `type` (media type: multipart/form-data)

- ⚠️ removed the enum value `ip-range` of the request property `type` (media type: application/json)

- ⚠️ removed the enum value `ip-range` of the request property `type` (media type: application/x-www-form-urlencoded)

- ⚠️ removed the enum value `ip-subnet` of the request property `type` (media type: multipart/form-data)

- ⚠️ removed the enum value `ip-subnet` of the request property `type` (media type: application/x-www-form-urlencoded)

- ⚠️ removed the enum value `ip-subnet` of the request property `type` (media type: application/json)

- ⚠️ removed the enum value `keyword` of the request property `type` (media type: application/json)

- ⚠️ removed the enum value `keyword` of the request property `type` (media type: multipart/form-data)

- ⚠️ removed the enum value `keyword` of the request property `type` (media type: application/x-www-form-urlencoded)

- ⚠️ removed the enum value `other` of the request property `type` (media type: multipart/form-data)

- ⚠️ removed the enum value `other` of the request property `type` (media type: application/json)

- ⚠️ removed the enum value `other` of the request property `type` (media type: application/x-www-form-urlencoded)

- ⚠️ the `type` request property type/format changed from `string`/`` to ``/`` (media type: application/json)

- ⚠️ the `type` response's property type/format changed from `string`/`` to ``/`` for status `200`

- ⚠️ removed the required property `is_active` from the response with the `200` status

- the `type` request property type/format was generalized from `string`/`` to ``/`` (media type: application/x-www-form-urlencoded)

- the `type` request property type/format was generalized from `string`/`` to ``/`` (media type: multipart/form-data)

- added `#/components/schemas/TypeEf5Enum` to the `type` response property `allOf` list for the response status `200`

- removed the `domain` enum value from the `type` response property for the response status `200`

- removed the `fqdn` enum value from the `type` response property for the response status `200`

- removed the `ip` enum value from the `type` response property for the response status `200`

- removed the `ip-range` enum value from the `type` response property for the response status `200`

- removed the `ip-subnet` enum value from the `type` response property for the response status `200`

- removed the `keyword` enum value from the `type` response property for the response status `200`

- removed the `other` enum value from the `type` response property for the response status `200`

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

- ⚠️ added `#/components/schemas/TypeEf5Enum` to the `type` request property `allOf` list (media type: application/json)

- ⚠️ added `#/components/schemas/TypeEf5Enum` to the `type` request property `allOf` list (media type: multipart/form-data)

- ⚠️ added `#/components/schemas/TypeEf5Enum` to the `type` request property `allOf` list (media type: application/x-www-form-urlencoded)

- ⚠️ the request property `description` became not nullable (media type: multipart/form-data)

- ⚠️ the request property `description` became not nullable (media type: application/json)

- ⚠️ the request property `description` became not nullable (media type: application/x-www-form-urlencoded)

- ⚠️ removed the enum value `domain` of the request property `type` (media type: application/json)

- ⚠️ removed the enum value `domain` of the request property `type` (media type: multipart/form-data)

- ⚠️ removed the enum value `domain` of the request property `type` (media type: application/x-www-form-urlencoded)

- ⚠️ removed the enum value `fqdn` of the request property `type` (media type: multipart/form-data)

- ⚠️ removed the enum value `fqdn` of the request property `type` (media type: application/x-www-form-urlencoded)

- ⚠️ removed the enum value `fqdn` of the request property `type` (media type: application/json)

- ⚠️ removed the enum value `ip` of the request property `type` (media type: application/x-www-form-urlencoded)

- ⚠️ removed the enum value `ip` of the request property `type` (media type: multipart/form-data)

- ⚠️ removed the enum value `ip` of the request property `type` (media type: application/json)

- ⚠️ removed the enum value `ip-range` of the request property `type` (media type: application/x-www-form-urlencoded)

- ⚠️ removed the enum value `ip-range` of the request property `type` (media type: multipart/form-data)

- ⚠️ removed the enum value `ip-range` of the request property `type` (media type: application/json)

- ⚠️ removed the enum value `ip-subnet` of the request property `type` (media type: application/x-www-form-urlencoded)

- ⚠️ removed the enum value `ip-subnet` of the request property `type` (media type: multipart/form-data)

- ⚠️ removed the enum value `ip-subnet` of the request property `type` (media type: application/json)

- ⚠️ removed the enum value `keyword` of the request property `type` (media type: application/x-www-form-urlencoded)

- ⚠️ removed the enum value `keyword` of the request property `type` (media type: application/json)

- ⚠️ removed the enum value `keyword` of the request property `type` (media type: multipart/form-data)

- ⚠️ removed the enum value `other` of the request property `type` (media type: application/json)

- ⚠️ removed the enum value `other` of the request property `type` (media type: multipart/form-data)

- ⚠️ removed the enum value `other` of the request property `type` (media type: application/x-www-form-urlencoded)

- ⚠️ the `type` request property type/format changed from `string`/`` to ``/`` (media type: application/json)

- ⚠️ the `type` response's property type/format changed from `string`/`` to ``/`` for status `200`

- ⚠️ removed the required property `is_active` from the response with the `200` status

- the `type` request property type/format was generalized from `string`/`` to ``/`` (media type: multipart/form-data)

- the `type` request property type/format was generalized from `string`/`` to ``/`` (media type: application/x-www-form-urlencoded)

- added `#/components/schemas/TypeEf5Enum` to the `type` response property `allOf` list for the response status `200`

- removed the `domain` enum value from the `type` response property for the response status `200`

- removed the `fqdn` enum value from the `type` response property for the response status `200`

- removed the `ip` enum value from the `type` response property for the response status `200`

- removed the `ip-range` enum value from the `type` response property for the response status `200`

- removed the `ip-subnet` enum value from the `type` response property for the response status `200`

- removed the `keyword` enum value from the `type` response property for the response status `200`

- removed the `other` enum value from the `type` response property for the response status `200`

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

- ⚠️ added `#/components/schemas/TypeEf5Enum` to the `type` request property `allOf` list (media type: application/json)

- ⚠️ added `#/components/schemas/TypeEf5Enum` to the `type` request property `allOf` list (media type: application/x-www-form-urlencoded)

- ⚠️ added `#/components/schemas/TypeEf5Enum` to the `type` request property `allOf` list (media type: multipart/form-data)

- ⚠️ the request property `description` became not nullable (media type: application/json)

- ⚠️ the request property `description` became not nullable (media type: multipart/form-data)

- ⚠️ the request property `description` became not nullable (media type: application/x-www-form-urlencoded)

- ⚠️ removed the enum value `domain` of the request property `type` (media type: application/json)

- ⚠️ removed the enum value `domain` of the request property `type` (media type: application/x-www-form-urlencoded)

- ⚠️ removed the enum value `domain` of the request property `type` (media type: multipart/form-data)

- ⚠️ removed the enum value `fqdn` of the request property `type` (media type: application/json)

- ⚠️ removed the enum value `fqdn` of the request property `type` (media type: multipart/form-data)

- ⚠️ removed the enum value `fqdn` of the request property `type` (media type: application/x-www-form-urlencoded)

- ⚠️ removed the enum value `ip` of the request property `type` (media type: application/json)

- ⚠️ removed the enum value `ip` of the request property `type` (media type: multipart/form-data)

- ⚠️ removed the enum value `ip` of the request property `type` (media type: application/x-www-form-urlencoded)

- ⚠️ removed the enum value `ip-range` of the request property `type` (media type: application/json)

- ⚠️ removed the enum value `ip-range` of the request property `type` (media type: multipart/form-data)

- ⚠️ removed the enum value `ip-range` of the request property `type` (media type: application/x-www-form-urlencoded)

- ⚠️ removed the enum value `ip-subnet` of the request property `type` (media type: application/json)

- ⚠️ removed the enum value `ip-subnet` of the request property `type` (media type: multipart/form-data)

- ⚠️ removed the enum value `ip-subnet` of the request property `type` (media type: application/x-www-form-urlencoded)

- ⚠️ removed the enum value `keyword` of the request property `type` (media type: application/json)

- ⚠️ removed the enum value `keyword` of the request property `type` (media type: multipart/form-data)

- ⚠️ removed the enum value `keyword` of the request property `type` (media type: application/x-www-form-urlencoded)

- ⚠️ removed the enum value `other` of the request property `type` (media type: application/json)

- ⚠️ removed the enum value `other` of the request property `type` (media type: multipart/form-data)

- ⚠️ removed the enum value `other` of the request property `type` (media type: application/x-www-form-urlencoded)

- ⚠️ the `type` request property type/format changed from `string`/`` to ``/`` (media type: application/json)

- the `type` request property type/format was generalized from `string`/`` to ``/`` (media type: application/x-www-form-urlencoded)

- the `type` request property type/format was generalized from `string`/`` to ``/`` (media type: multipart/form-data)

### GET /api/auth/orgs/

- added the new optional `query` request parameter `user_not_in`

You can access the complete API documentation here.

Did this answer your question?