Compares a new catalog file with an existing catalog to identify differences and optionally updates the database. Supports generating detailed reports in different structures and applying updates directly.

post https://{baseUrl}/api/catalogues/compareAndUpdate/{existingCatalogId}

This method supports various operational modes, including flat and hierarchical structures for reports.
It allows the results to be returned in JSON or CSV format (the latter only for flat reports).
The 'applyUpdates' parameter controls whether updates are applied directly to the database. When the
'dataModelsReport' mode is selected, it primarily focuses on preparing data models for updates without
presenting them in a structured report format.

Responses

200

Returns a detailed report of the differences or confirms that updates have been applied, depending on the operation mode.

400

Indicates failure due to invalid parameters, unsupported format requests, or file processing issues.

401

Unauthorized access attempt, detailing required roles and permissions.

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url 'https://your-instance.regscale.co/api/catalogues/compareAndUpdate/existingCatalogId?format=json&structure=flatReport&applyUpdates=false' \
3
     --header 'content-type: multipart/form-data'

Click Try It! to start a request and see the response here!