Exports a catalog along with security controls, parameters, objectives, tests, and CCIs.

get https://{baseUrl}/api/catalogues/export/{id}

By default, the catalog exported includes metadata.

Responses

400

Error exporting the catalog. The response body contains details about the error.

401

(1) The caller is not authenticated with RegScale.

        (2) The caller does not have the following roles: Administrator, GeneralUser, SecurityPlanUser,
        Maintainer, ReadOnly.

        (3) The caller does not have access rights.

404

Catalog ID not found. Indicates that a catalog with the specified ID does not exist.

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://your-instance.regscale.co/api/catalogues/export/id?excludeMetadata=false' \
3
     --header 'accept: application/json'


xxxxxxxxxx
 
1
string

200Catalog exported successfully. The response body contains the catalog in JSON format.