> For the complete documentation index, see [llms.txt](https://developer.collibra.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.collibra.com/api/references/control-tower/out-of-the-box-controls.md).

# Out Of The Box Controls

List and import pre-built control definitions (OOTB Controls). Use these endpoints to check which OOTB Controls are available and import them as Managed Controls in your environment.

## List OOTB Controls

> Returns a list of available OOTB Controls with their import status relative to this environment.

```json
{"openapi":"3.1.0","info":{"title":"Collibra Control Tower Management API","version":"1.0.0"},"tags":[{"name":"Out of the Box Controls","description":"List and import pre-built control definitions (OOTB Controls). Use these endpoints to check which\nOOTB Controls are available and import them as Managed Controls in your environment.\n"}],"servers":[{"url":"/rest/controlManagement/v1"}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"description":"This API requires Basic HTTP authentication.","type":"http","scheme":"basic"}},"responses":{"OotbControlListResponse":{"description":"Response containing the list of available OOTB Controls with their import status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OotbControlList"}}}},"Forbidden":{"description":"The user is forbidden to execute the requested action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StandardErrorResponse"}}}}},"schemas":{"OotbControlList":{"description":"Response containing the list of available OOTB Controls.","type":"object","required":["results"],"properties":{"results":{"description":"List of OOTB Controls.","type":"array","items":{"$ref":"#/components/schemas/OotbControlSummary"}}}},"OotbControlSummary":{"description":"Summary representation of an OOTB Control, including its import status relative to this instance.","type":"object","required":["publicId","category","name","description","importStatus"],"properties":{"publicId":{"type":"string","description":"Human-readable identifier for the OOTB Control. Uses PascalCase with no spaces or special characters."},"assetId":{"type":"string","format":"uuid","description":"The ID of the Managed `Control` asset in the `Knowledge Graph` that was created when this OOTB Control was imported. Only present if the OOTB Control has been imported before (i.e. `importStatus` is not `NEW`)."},"category":{"$ref":"#/components/schemas/ControlCategory"},"name":{"$ref":"#/components/schemas/ControlName"},"description":{"$ref":"#/components/schemas/ControlDescription"},"importStatus":{"type":"string","description":"The import status of the OOTB Control relative to this tenant. Determined by comparing the OOTB Control with the Managed Control currently defined.  Possible values:\n- `NEW`: The OOTB Control has not been imported\n  into this tenant yet. No corresponding Managed\n  Control exists.\n\n- `EXISTS_NOT_CHANGED`: A Managed Control was\n  previously created from this OOTB Control and\n  the template has not changed since (version\n  hashes match).\n\n- `EXISTS_CHANGED`: A Managed Control was\n  previously created from this OOTB Control but\n  the template has been updated since (version\n  hashes differ). The user may want to re-import\n  to pick up the latest changes.\n\nThis is not an enum because new values may be added in the future."},"importStatusDetails":{"$ref":"#/components/schemas/ImportStatusDetails"}}},"ControlCategory":{"description":"The category of the control.","type":"string","maxLength":255},"ControlName":{"description":"The name of the control.","type":"string","maxLength":255},"ControlDescription":{"description":"A brief description of the control.","type":"string","maxLength":2000},"ImportStatusDetails":{"description":"Per-field comparison between an OOTB Control and the Managed Control previously imported from it.\nThis object is **optional**. It is only returned when **both** of the following are true:\n  - the OOTB Control identified by `publicId` exists in this\n    system (i.e. a Managed Control was previously imported\n    from it), AND\n  - at least one match flag is `false` (i.e. the Managed\n    Control diverges from the current OOTB Control template\n    on at least one field).\n\nWhen omitted, callers should interpret it as \"no divergence worth reporting\": either the OOTB Control was never imported here, or every comparable field still matches the template. This lets the UI highlight exactly which fields would be overwritten on a re-import.\nEach individual flag is also optional. An omitted flag means the comparison was not evaluated for that field (typically because an exception short-circuited the check) and should be treated as \"unknown\", not as a match.","type":"object","properties":{"nameMatches":{"description":"Whether the `name` of the Managed Control matches the OOTB Control's `name`.","type":"boolean"},"descriptionMatches":{"description":"Whether the `description` of the Managed Control matches the OOTB Control's `description`.","type":"boolean"},"severityMatches":{"description":"Whether the `severity` of the Managed Control matches the OOTB Control's `severity`.","type":"boolean"},"controlTypeMatches":{"description":"Whether the `controlType` of the Managed Control matches the OOTB Control's `controlType`.","type":"boolean"},"categoryMatches":{"description":"Whether the `category` of the Managed Control matches the OOTB Control's `category`.","type":"boolean"},"queryMatches":{"description":"Whether the `query` of the Managed Control matches the OOTB Control's `query`.","type":"boolean"},"executionScheduleMatches":{"description":"Whether the `executionSchedule` of the Managed Control matches the OOTB Control's `executionSchedule`.","type":"boolean"},"notificationSettingsMatches":{"description":"Whether the `notificationSettings` of the Managed Control matches the OOTB Control's `notificationSettings`.","type":"boolean"}}},"StandardErrorResponse":{"description":"A standard error response object.","type":"object","properties":{"statusCode":{"description":"HTTP response code.","type":"integer"},"titleMessage":{"description":"The title of the error message.","type":"string"},"helpMessage":{"description":"A message containing actions you can take regarding the error.","type":"string"},"userMessage":{"description":"A user friendly error message.","type":"string"},"errorCode":{"description":"An error code identifier.","type":"string"},"query":{"description":"The rejected control query, with each issue attached to the part of the query it applies to\nand `isValid` set to `false`.\n\nOnly present when the request was refused because of its query.\n","allOf":[{"$ref":"#/components/schemas/ControlQuery"}]}},"required":["statusCode","errorCode","userMessage"]},"ControlQuery":{"description":"The query that defines the logic for finding non-compliant assets.\n\nThe shape of this object is defined by the `Collibra Control Tower Query Model`, which is versioned\nseparately from this API. Its specification is published on https://developer.collibra.com/, both as an\nOpenAPI document and as a JSON Schema you can validate a query against.","type":"object","additionalProperties":true}}},"paths":{"/ootbControls":{"get":{"tags":["Out of the Box Controls"],"summary":"List OOTB Controls","description":"Returns a list of available OOTB Controls with their import status relative to this environment.","operationId":"listOotbControls","responses":{"200":{"$ref":"#/components/responses/OotbControlListResponse"},"403":{"$ref":"#/components/responses/Forbidden"}}}}}}
```

## Import OOTB Controls

> Imports one or more OOTB Controls into this instance as Managed Controls. This creates new controls or updates existing ones. Newly created controls are disabled by default.\
> Partial success is possible: each control is processed independently. A \`200 OK\` response does NOT mean all controls were imported successfully. Callers MUST inspect the \`outcome\` field on each result to detect failures.

```json
{"openapi":"3.1.0","info":{"title":"Collibra Control Tower Management API","version":"1.0.0"},"tags":[{"name":"Out of the Box Controls","description":"List and import pre-built control definitions (OOTB Controls). Use these endpoints to check which\nOOTB Controls are available and import them as Managed Controls in your environment.\n"}],"servers":[{"url":"/rest/controlManagement/v1"}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"description":"This API requires Basic HTTP authentication.","type":"http","scheme":"basic"}},"requestBodies":{"ImportOotbControlsRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportOotbControls"}}},"required":true}},"schemas":{"ImportOotbControls":{"description":"Request to import one or more OOTB Controls into this instance as Managed Controls.","type":"object","required":["publicIds"],"properties":{"publicIds":{"description":"List of OOTB Control public IDs to import.","type":"array","minItems":1,"maxItems":500,"items":{"type":"string","maxLength":255}}}},"ImportOotbControlsResult":{"description":"Response for importing OOTB Controls. Includes per-control outcomes.","type":"object","required":["results"],"properties":{"results":{"description":"Per-control import outcomes.","type":"array","items":{"$ref":"#/components/schemas/ImportOotbControlResult"}}}},"ImportOotbControlResult":{"description":"The outcome of importing a single OOTB Control.","type":"object","required":["publicId","outcome"],"properties":{"publicId":{"type":"string","description":"The public identifier of the requested OOTB Control."},"assetId":{"type":"string","format":"uuid","description":"The ID of the relevant Managed Control. Present for `ADDED`, `UPDATED`, and `IGNORED` outcomes, and for `FAILED` re-imports of an existing Managed Control. Absent for `FAILED` creations (nothing was created) and for `NOT_FOUND`."},"name":{"$ref":"#/components/schemas/ControlName"},"description":{"$ref":"#/components/schemas/ControlDescription"},"outcome":{"type":"string","description":"The outcome of the import operation for this OOTB Control. Possible values:\n- `ADDED`: The OOTB Control was successfully imported\n  as a new Managed Control.\n\n- `UPDATED`: A Managed Control previously created from\n  this OOTB Control was updated with the latest template.\n\n- `IGNORED`: The OOTB Control was already imported and\n  unchanged. No action was taken.\n\n- `FAILED`: The import failed. See `errorMessage` for\n  details.\n\n- `NOT_FOUND`: no OOTB Control with this `publicId`\n  exists upstream. See `errorMessage` for details. No\n  action was taken.\n\nThis is not an enum because new values may be added in the future."},"errorMessage":{"type":"string","description":"Error details. Present when the outcome is `FAILED` or `NOT_FOUND`."}}},"ControlName":{"description":"The name of the control.","type":"string","maxLength":255},"ControlDescription":{"description":"A brief description of the control.","type":"string","maxLength":2000},"StandardErrorResponse":{"description":"A standard error response object.","type":"object","properties":{"statusCode":{"description":"HTTP response code.","type":"integer"},"titleMessage":{"description":"The title of the error message.","type":"string"},"helpMessage":{"description":"A message containing actions you can take regarding the error.","type":"string"},"userMessage":{"description":"A user friendly error message.","type":"string"},"errorCode":{"description":"An error code identifier.","type":"string"},"query":{"description":"The rejected control query, with each issue attached to the part of the query it applies to\nand `isValid` set to `false`.\n\nOnly present when the request was refused because of its query.\n","allOf":[{"$ref":"#/components/schemas/ControlQuery"}]}},"required":["statusCode","errorCode","userMessage"]},"ControlQuery":{"description":"The query that defines the logic for finding non-compliant assets.\n\nThe shape of this object is defined by the `Collibra Control Tower Query Model`, which is versioned\nseparately from this API. Its specification is published on https://developer.collibra.com/, both as an\nOpenAPI document and as a JSON Schema you can validate a query against.","type":"object","additionalProperties":true}},"responses":{"ImportOotbControlsResultResponse":{"description":"Response for importing OOTB Controls. Includes per-control outcomes.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportOotbControlsResult"}}}},"BadRequest":{"description":"The request is not valid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StandardErrorResponse"}}}},"Forbidden":{"description":"The user is forbidden to execute the requested action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StandardErrorResponse"}}}}}},"paths":{"/ootbControls/import":{"post":{"tags":["Out of the Box Controls"],"summary":"Import OOTB Controls","description":"Imports one or more OOTB Controls into this instance as Managed Controls. This creates new controls or updates existing ones. Newly created controls are disabled by default.\nPartial success is possible: each control is processed independently. A `200 OK` response does NOT mean all controls were imported successfully. Callers MUST inspect the `outcome` field on each result to detect failures.","operationId":"importOotbControls","requestBody":{"$ref":"#/components/requestBodies/ImportOotbControlsRequest"},"responses":{"200":{"$ref":"#/components/responses/ImportOotbControlsResultResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"403":{"$ref":"#/components/responses/Forbidden"}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://developer.collibra.com/api/references/control-tower/out-of-the-box-controls.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
