API changes - BlueCat Integrity

New API endpoints

CDV 26.1 introduces the following endpoints to support the new pre-flight check functionality.

New API endpoints

API endpoint	Description	Scope
`GET /preflight-check/reports/{manager_id}`	Generate the pre-flight check permissions report.	General
`POST /preflight-check/reports/{manager_id}/download`	Download the pre-flight check permissions report in JSON format.	General

Fields for GET /preflight-check/reports/{manager_id}

Parameter	Type	Description	Note
`manager_id`	`integer`	Schedule / visibility manager ID	Required
`scope`	`string`	Type of manager	Required
`sort`	`string`	Indicates how the results should be sorted	Optional

Fields for POST /preflight-check/reports/{manager_id}/download

Parameter	Type	Description	Note
`manager_id`	`integer`	Schedule / visibility manager ID	Required
`scope`	`string`	Type of manager	Required

Updated API endpoints

The following endpoints have been updated in CDV 26.1 for all cloud platforms to support the new pre-flight check functionality.

Updated API endpoints

API endpoint	Description	Scope
`PUT /schedule/{schedule_ids}`	Stop or start schedule managers.	AWS, Azure, GCP
`PUT /visibility-manager/{visibility_manager_ids}`	Stop or start visibility managers.	AWS, Azure, GCP
`POST /discovery`	Start discovery of cloud resources.	AWS, Azure, GCP

Fields for PUT /schedule/{schedule_ids}

Field name	Type	Description	Note
`schedule_ids`	`string`	A list of schedule manager IDs	Required
`action`	`string`	The action to be performed: `start` or `stop`	Required
`force_start`	`boolean`	An option to force-start the schedule even if the permission check fails (allowed only when `action` is `start`)	Optional

Fields for PUT /visibility-manager/{visibility_manager_ids}

Field name	Type	Description	Note
`visibility_manager_ids`	`string`	A list of visibility manager IDs	Required
`action`	`string`	The action to be performed: `start` or `stop`	Required
`force_start`	`boolean`	An option to force-start the schedule even if the permission check fails (allowed only when `action` is `start`)	Optional

Fields for POST /discovery

Field name	Type	Description	Note
`preflight_check`	`boolean`	An option to determine whether the pre-flight check should be executed or not	Optional

Updated API endpoints (removed fields)

In previous versions of CDV, when importing a CDV database, an Overwrite Mode option was available to indicate whether to overwrite existing data. In CDV 26.1, the default behaviour when importing a new database is now to overwrite the existing database. As such, the overwrite field has been removed from the POST /importer/database endpoint.

Consolidated API endpoints (AWS)

Removed API endpoints (AWS)

The following AWS endpoints have been removed from CDV 26.1. The functionality of these endpoints has been consolidated into PUT /schedule/{schedule_id}/options and

PUT
                /visibility-manager

.

PUT /schedule/{schedule_id}/credential
PUT /schedule/account-filter/{schedule_id}
PUT /schedule/{schedule_id}/tag-filter
PUT /schedule/additional-user-defined-tags/{schedule_id}
PUT /visibility-manager/account-filter/{visibility_manager_id}
PUT /visibility-manager/{visibility_manager_id}/credentials
PUT /visibility-manager/{visibility_manager_id}/tag-filter
PUT /visibility-manager/{visibility_manager_id}/additional-user-defined-tags

Replacement API endpoints (AWS)

API endpoint	Description
`PUT /schedule/{schedule_id}/options`	Update options for a schedule manager, including: service options, authentication credentials, additional user-defined tags, CIDR exclusion ranges, the AWS account filter, the VPC tag filter, and pre-flight check settings.
`PUT /visibility-manager`	Update options for a visibility manager, including: service options, authentication credentials, additional user-defined tags, CIDR exclusion ranges, the AWS account filter, the VPC tag filter, and pre-flight check settings.

Fields for PUT /schedule/{schedule_id}/options (AWS)

Field name	Type	Description	Note
`tag_filter`	`object`	AWS tag key/value pairs for the VPC exclusion filter	Optional
`additional_user_defined_tags`	`object`	AWS resource tags mapped to Address Manager UDF names	Optional
`authentication`	`object`	AWS authentication credentials	Optional
`aws_account_filter`	`object`	Tags for filtering AWS accounts during organization-wide discovery	Optional
`options`	`object`	Service options for CD&V to discover corresponding cloud resources	Optional
`exclude_cidrs`	`array`	List of CIDRs to be excluded during the discovery process	Optional
`preflight_check`	`boolean`	An option to determine whether to run a pre-flight check	Optional

Fields for PUT /visibility-manager (AWS)

Field name	Type	Description	Note
`tag_filter`	`object`	AWS tag key/value pairs for the VPC exclusion filter	Optional
`additional_user_defined_tags`	`object`	AWS resource tags mapped to Address Manager UDF names	Optional
`authentication`	`object`	AWS authentication credentials	Optional
`aws_account_filter`	`object`	Tags for filtering AWS accounts during organization-wide discovery	Optional
`options`	`object`	Service options for CD&V to discover corresponding cloud resources	Optional
`exclude_cidrs`	`array`	List of CIDRs to be excluded during the discovery process	Optional
`preflight_check`	`boolean`	An option to determine whether to run a pre-flight check	Optional

Consolidated API endpoints (Azure)

Removed API endpoints (Azure)

The following Azure endpoints have been removed from CDV 26.1. The functionality of these endpoints has been consolidated into PUT /schedule/{schedule_id}/options and

PUT
                /visibility-manager

.

PUT /schedule/{schedule_id}/credential
PUT /schedule/{schedule_id}/tag-filter
PUT /visibility-manager/{visibility_manager_id}/tag-filter
PUT /visibility-manager/{visibility_manager_id}/credentials

Replacement API endpoints (Azure)

API endpoint	Description
`PUT /schedule/{schedule_id}/options`	Update options for a schedule manager, including: service options, authentication credentials, CIDR exclusion ranges, the virtual network tag filter, and pre-flight check settings.
`PUT /visibility-manager`	Update options for a visibility manager, including: service options, authentication credentials, CIDR exclusion ranges, the virtual network tag filter, and pre-flight check settings.

Fields for PUT /schedule/{schedule_id}/options (Azure)

Field name	Type	Description	Note
`tag_filter`	`object`	Azure tag key/value pairs for the virtual network exclusion filter	Optional
`authentication`	`object`	Azure authentication credentials	Optional
`options`	`object`	Service options for CD&V to discover corresponding cloud resources	Optional
`exclude_cidrs`	`array`	List of CIDRs to be excluded during the discovery process	Optional
`preflight_check`	`boolean`	An option to determine whether to run a pre-flight check	Optional

Fields for PUT /visibility-manager (Azure)

Field name	Type	Description	Note
`tag_filter`	`object`	Azure tag key/value pairs for the virtual network exclusion filter	Optional
`authentication`	`object`	Azure authentication credentials	Optional
`options`	`object`	Service options for CD&V to discover corresponding cloud resources	Optional
`exclude_cidrs`	`array`	List of CIDRs to be excluded during the discovery process	Optional
`preflight_check`	`boolean`	An option to determine whether to run a pre-flight check	Optional

Consolidated API endpoints (GCP)

Removed API endpoints (GCP)

The following GCP endpoints have been removed from CDV 26.1. The functionality of these endpoints has been consolidated into PUT /schedule/{schedule_id}/options and

PUT
                /visibility-manager

.

PUT /schedule/{schedule_id}/credential
PUT /visibility-manager/{visibility_manager_id}/credentials

Replacement API endpoints (GCP)

API endpoint	Description
`PUT /schedule/{schedule_id}/options`	Update options for a schedule manager, including: service options, authentication credentials, and pre-flight check settings.
`PUT /visibility-manager`	Update options for a visibility manager, including: service options, authentication credentials, and pre-flight check settings.

Fields for PUT /schedule/{schedule_id}/options (GCP)

Field name	Type	Description	Note
`authentication`	`object`	GCP authentication credentials	Optional
`options`	`object`	Service options for CD&V to discover corresponding cloud resources	Optional
`preflight_check`	`boolean`	An option to determine whether to run a pre-flight check	Optional

Fields for PUT /visibility-manager (GCP)

Field name	Type	Description	Note
`authentication`	`object`	GCP authentication credentials	Optional
`options`	`object`	Service options for CD&V to discover corresponding cloud resources	Optional
`preflight_check`	`boolean`	An option to determine whether to run a pre-flight check	Optional