# Universal Broker

{% hint style="info" %}
This document uses the REST API. For more details, see the [Authentication for API](/snyk-api/authentication-for-api.md) page.
{% endhint %}

{% openapi src="/files/Fqh9CopmxS3viOCgwwhT" path="/tenants/{tenant\_id}/brokers/installs/{install\_id}/deployments" method="post" %}
[rest-spec.json](https://2533899886-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MdwVZ6HOZriajCf5nXH%2Fuploads%2Fgit-blob-2ca135d6eccec96b03d5c2a9525030e10522a87d%2Frest-spec.json?alt=media)
{% endopenapi %}

{% openapi src="/files/Fqh9CopmxS3viOCgwwhT" path="/tenants/{tenant\_id}/brokers/installs/{install\_id}/deployments" method="get" %}
[rest-spec.json](https://2533899886-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MdwVZ6HOZriajCf5nXH%2Fuploads%2Fgit-blob-2ca135d6eccec96b03d5c2a9525030e10522a87d%2Frest-spec.json?alt=media)
{% endopenapi %}

{% openapi src="/files/Fqh9CopmxS3viOCgwwhT" path="/tenants/{tenant\_id}/brokers/installs/{install\_id}/deployments/{deployment\_id}" method="patch" %}
[rest-spec.json](https://2533899886-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MdwVZ6HOZriajCf5nXH%2Fuploads%2Fgit-blob-2ca135d6eccec96b03d5c2a9525030e10522a87d%2Frest-spec.json?alt=media)
{% endopenapi %}

{% openapi src="/files/Fqh9CopmxS3viOCgwwhT" path="/tenants/{tenant\_id}/brokers/installs/{install\_id}/deployments/{deployment\_id}" method="delete" %}
[rest-spec.json](https://2533899886-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MdwVZ6HOZriajCf5nXH%2Fuploads%2Fgit-blob-2ca135d6eccec96b03d5c2a9525030e10522a87d%2Frest-spec.json?alt=media)
{% endopenapi %}

{% openapi src="/files/Fqh9CopmxS3viOCgwwhT" path="/tenants/{tenant\_id}/brokers/installs/{install\_id}/deployments/{deployment\_id}/credentials" method="post" %}
[rest-spec.json](https://2533899886-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MdwVZ6HOZriajCf5nXH%2Fuploads%2Fgit-blob-2ca135d6eccec96b03d5c2a9525030e10522a87d%2Frest-spec.json?alt=media)
{% endopenapi %}

{% openapi src="/files/Fqh9CopmxS3viOCgwwhT" path="/tenants/{tenant\_id}/brokers/installs/{install\_id}/deployments/{deployment\_id}/credentials" method="get" %}
[rest-spec.json](https://2533899886-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MdwVZ6HOZriajCf5nXH%2Fuploads%2Fgit-blob-2ca135d6eccec96b03d5c2a9525030e10522a87d%2Frest-spec.json?alt=media)
{% endopenapi %}

{% openapi src="/files/Fqh9CopmxS3viOCgwwhT" path="/tenants/{tenant\_id}/brokers/installs/{install\_id}/deployments/{deployment\_id}/credentials/{credential\_id}" method="patch" %}
[rest-spec.json](https://2533899886-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MdwVZ6HOZriajCf5nXH%2Fuploads%2Fgit-blob-2ca135d6eccec96b03d5c2a9525030e10522a87d%2Frest-spec.json?alt=media)
{% endopenapi %}

{% openapi src="/files/Fqh9CopmxS3viOCgwwhT" path="/tenants/{tenant\_id}/brokers/installs/{install\_id}/deployments/{deployment\_id}/credentials/{credential\_id}" method="get" %}
[rest-spec.json](https://2533899886-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MdwVZ6HOZriajCf5nXH%2Fuploads%2Fgit-blob-2ca135d6eccec96b03d5c2a9525030e10522a87d%2Frest-spec.json?alt=media)
{% endopenapi %}

{% openapi src="/files/Fqh9CopmxS3viOCgwwhT" path="/tenants/{tenant\_id}/brokers/installs/{install\_id}/deployments/{deployment\_id}/credentials/{credential\_id}" method="delete" %}
[rest-spec.json](https://2533899886-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MdwVZ6HOZriajCf5nXH%2Fuploads%2Fgit-blob-2ca135d6eccec96b03d5c2a9525030e10522a87d%2Frest-spec.json?alt=media)
{% endopenapi %}

{% openapi src="/files/Fqh9CopmxS3viOCgwwhT" path="/tenants/{tenant\_id}/brokers/installs/{install\_id}/deployments/{deployment\_id}/contexts" method="post" %}
[rest-spec.json](https://2533899886-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MdwVZ6HOZriajCf5nXH%2Fuploads%2Fgit-blob-2ca135d6eccec96b03d5c2a9525030e10522a87d%2Frest-spec.json?alt=media)
{% endopenapi %}

{% openapi src="/files/Fqh9CopmxS3viOCgwwhT" path="/tenants/{tenant\_id}/brokers/installs/{install\_id}/deployments/{deployment\_id}/contexts" method="get" %}
[rest-spec.json](https://2533899886-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MdwVZ6HOZriajCf5nXH%2Fuploads%2Fgit-blob-2ca135d6eccec96b03d5c2a9525030e10522a87d%2Frest-spec.json?alt=media)
{% endopenapi %}

{% openapi src="/files/Fqh9CopmxS3viOCgwwhT" path="/tenants/{tenant\_id}/brokers/installs/{install\_id}/deployments/{deployment\_id}/connections" method="post" %}
[rest-spec.json](https://2533899886-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MdwVZ6HOZriajCf5nXH%2Fuploads%2Fgit-blob-2ca135d6eccec96b03d5c2a9525030e10522a87d%2Frest-spec.json?alt=media)
{% endopenapi %}

{% openapi src="/files/Fqh9CopmxS3viOCgwwhT" path="/tenants/{tenant\_id}/brokers/installs/{install\_id}/deployments/{deployment\_id}/connections" method="get" %}
[rest-spec.json](https://2533899886-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MdwVZ6HOZriajCf5nXH%2Fuploads%2Fgit-blob-2ca135d6eccec96b03d5c2a9525030e10522a87d%2Frest-spec.json?alt=media)
{% endopenapi %}

{% openapi src="/files/Fqh9CopmxS3viOCgwwhT" path="/tenants/{tenant\_id}/brokers/installs/{install\_id}/deployments/{deployment\_id}/connections" method="delete" %}
[rest-spec.json](https://2533899886-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MdwVZ6HOZriajCf5nXH%2Fuploads%2Fgit-blob-2ca135d6eccec96b03d5c2a9525030e10522a87d%2Frest-spec.json?alt=media)
{% endopenapi %}

{% openapi src="/files/Fqh9CopmxS3viOCgwwhT" path="/tenants/{tenant\_id}/brokers/installs/{install\_id}/deployments/{deployment\_id}/connections/{connection\_id}" method="patch" %}
[rest-spec.json](https://2533899886-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MdwVZ6HOZriajCf5nXH%2Fuploads%2Fgit-blob-2ca135d6eccec96b03d5c2a9525030e10522a87d%2Frest-spec.json?alt=media)
{% endopenapi %}

{% openapi src="/files/Fqh9CopmxS3viOCgwwhT" path="/tenants/{tenant\_id}/brokers/installs/{install\_id}/deployments/{deployment\_id}/connections/{connection\_id}" method="get" %}
[rest-spec.json](https://2533899886-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MdwVZ6HOZriajCf5nXH%2Fuploads%2Fgit-blob-2ca135d6eccec96b03d5c2a9525030e10522a87d%2Frest-spec.json?alt=media)
{% endopenapi %}

{% openapi src="/files/Fqh9CopmxS3viOCgwwhT" path="/tenants/{tenant\_id}/brokers/installs/{install\_id}/deployments/{deployment\_id}/connections/{connection\_id}" method="delete" %}
[rest-spec.json](https://2533899886-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MdwVZ6HOZriajCf5nXH%2Fuploads%2Fgit-blob-2ca135d6eccec96b03d5c2a9525030e10522a87d%2Frest-spec.json?alt=media)
{% endopenapi %}

{% openapi src="/files/Fqh9CopmxS3viOCgwwhT" path="/tenants/{tenant\_id}/brokers/installs/{install\_id}/deployments/{deployment\_id}/connections/{connection\_id}/bulk\_migration" method="post" %}
[rest-spec.json](https://2533899886-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MdwVZ6HOZriajCf5nXH%2Fuploads%2Fgit-blob-2ca135d6eccec96b03d5c2a9525030e10522a87d%2Frest-spec.json?alt=media)
{% endopenapi %}

{% openapi src="/files/Fqh9CopmxS3viOCgwwhT" path="/tenants/{tenant\_id}/brokers/installs/{install\_id}/deployments/{deployment\_id}/connections/{connection\_id}/bulk\_migration" method="get" %}
[rest-spec.json](https://2533899886-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MdwVZ6HOZriajCf5nXH%2Fuploads%2Fgit-blob-2ca135d6eccec96b03d5c2a9525030e10522a87d%2Frest-spec.json?alt=media)
{% endopenapi %}

{% openapi src="/files/Fqh9CopmxS3viOCgwwhT" path="/tenants/{tenant\_id}/brokers/installs/{install\_id}/contexts/{context\_id}" method="patch" %}
[rest-spec.json](https://2533899886-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MdwVZ6HOZriajCf5nXH%2Fuploads%2Fgit-blob-2ca135d6eccec96b03d5c2a9525030e10522a87d%2Frest-spec.json?alt=media)
{% endopenapi %}

{% openapi src="/files/Fqh9CopmxS3viOCgwwhT" path="/tenants/{tenant\_id}/brokers/installs/{install\_id}/contexts/{context\_id}" method="get" %}
[rest-spec.json](https://2533899886-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MdwVZ6HOZriajCf5nXH%2Fuploads%2Fgit-blob-2ca135d6eccec96b03d5c2a9525030e10522a87d%2Frest-spec.json?alt=media)
{% endopenapi %}

{% openapi src="/files/Fqh9CopmxS3viOCgwwhT" path="/tenants/{tenant\_id}/brokers/installs/{install\_id}/contexts/{context\_id}" method="delete" %}
[rest-spec.json](https://2533899886-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MdwVZ6HOZriajCf5nXH%2Fuploads%2Fgit-blob-2ca135d6eccec96b03d5c2a9525030e10522a87d%2Frest-spec.json?alt=media)
{% endopenapi %}

{% openapi src="/files/Fqh9CopmxS3viOCgwwhT" path="/tenants/{tenant\_id}/brokers/installs/{install\_id}/contexts/{context\_id}/integrations/{integration\_id}" method="delete" %}
[rest-spec.json](https://2533899886-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MdwVZ6HOZriajCf5nXH%2Fuploads%2Fgit-blob-2ca135d6eccec96b03d5c2a9525030e10522a87d%2Frest-spec.json?alt=media)
{% endopenapi %}

{% openapi src="/files/Fqh9CopmxS3viOCgwwhT" path="/tenants/{tenant\_id}/brokers/installs/{install\_id}/contexts/{context\_id}/integration" method="patch" %}
[rest-spec.json](https://2533899886-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MdwVZ6HOZriajCf5nXH%2Fuploads%2Fgit-blob-2ca135d6eccec96b03d5c2a9525030e10522a87d%2Frest-spec.json?alt=media)
{% endopenapi %}

{% openapi src="/files/Fqh9CopmxS3viOCgwwhT" path="/tenants/{tenant\_id}/brokers/installs/{install\_id}/connections/{connection\_id}/contexts" method="get" %}
[rest-spec.json](https://2533899886-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MdwVZ6HOZriajCf5nXH%2Fuploads%2Fgit-blob-2ca135d6eccec96b03d5c2a9525030e10522a87d%2Frest-spec.json?alt=media)
{% endopenapi %}

{% openapi src="/files/Fqh9CopmxS3viOCgwwhT" path="/tenants/{tenant\_id}/brokers/deployments" method="get" %}
[rest-spec.json](https://2533899886-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MdwVZ6HOZriajCf5nXH%2Fuploads%2Fgit-blob-2ca135d6eccec96b03d5c2a9525030e10522a87d%2Frest-spec.json?alt=media)
{% endopenapi %}

{% openapi src="/files/Fqh9CopmxS3viOCgwwhT" path="/tenants/{tenant\_id}/brokers/connections/{connection\_id}/orgs/{org\_id}/integrations/{integration\_id}" method="delete" %}
[rest-spec.json](https://2533899886-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MdwVZ6HOZriajCf5nXH%2Fuploads%2Fgit-blob-2ca135d6eccec96b03d5c2a9525030e10522a87d%2Frest-spec.json?alt=media)
{% endopenapi %}

{% openapi src="/files/Fqh9CopmxS3viOCgwwhT" path="/tenants/{tenant\_id}/brokers/connections/{connection\_id}/orgs/{org\_id}/integration" method="post" %}
[rest-spec.json](https://2533899886-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MdwVZ6HOZriajCf5nXH%2Fuploads%2Fgit-blob-2ca135d6eccec96b03d5c2a9525030e10522a87d%2Frest-spec.json?alt=media)
{% endopenapi %}

{% openapi src="/files/Fqh9CopmxS3viOCgwwhT" path="/tenants/{tenant\_id}/brokers/connections/{connection\_id}/integrations" method="get" %}
[rest-spec.json](https://2533899886-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MdwVZ6HOZriajCf5nXH%2Fuploads%2Fgit-blob-2ca135d6eccec96b03d5c2a9525030e10522a87d%2Frest-spec.json?alt=media)
{% endopenapi %}

{% openapi src="/files/Fqh9CopmxS3viOCgwwhT" path="/orgs/{org\_id}/brokers/connections" method="get" %}
[rest-spec.json](https://2533899886-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MdwVZ6HOZriajCf5nXH%2Fuploads%2Fgit-blob-2ca135d6eccec96b03d5c2a9525030e10522a87d%2Frest-spec.json?alt=media)
{% endopenapi %}


---

# Agent Instructions: Querying This Documentation

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

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.snyk.io/snyk-api/reference/universal-broker.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.