Snyk

Snyk BrokerConnections API

The BrokerConnections API from Snyk — 7 operation(s) for brokerconnections.

GitHub OpenAPI

Operations 12

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /orgs/{org_id}/brokers/connections List Broker connections used by an organization · List Broker connections for a given organization #
Ask an LLM
“Which Broker connections are wired into my Snyk organization?”
“Can I see the Broker connections an org is integrated with?”
Tell an agent
List the Broker connections for org {org_id}.
Show which brokered connections organization {org_id} uses.
GET /tenants/{tenant_id}/brokers/connections/{connection_id}/integrations List integrations using a Broker connection · Get Integrations using the current Broker connection #
Ask an LLM
“Which integrations depend on a particular Broker connection?”
“Before I remove a Broker connection, can I see what integrations use it?”
Tell an agent
List integrations using Broker connection {connection_id} in tenant {tenant_id}.
Show every integration that routes through connection {connection_id} for tenant {tenant_id}.
POST /tenants/{tenant_id}/brokers/connections/{connection_id}/orgs/{org_id}/integration Point an org's integration at a Broker connection · Creates Broker connection Integration Configuration #
Ask an LLM
“How do I make an organization's integration use a specific Broker connection?”
“Can I attach a Broker connection to one org's integration configuration?”
Tell an agent
Configure org {org_id} to use Broker connection {connection_id} in tenant {tenant_id}.
Create the integration configuration linking connection {connection_id} to organization {org_id} under tenant {tenant_id}.
DELETE /tenants/{tenant_id}/brokers/connections/{connection_id}/orgs/{org_id}/integrations/{integration_id} Detach an integration from a Broker connection · Deletes an Integration for a Broker connection #
Ask an LLM
“How do I stop one org integration from using a Broker connection?”
“Can I unlink a single integration without deleting the whole connection?”
Tell an agent destructive · confirm first
Remove integration {integration_id} of org {org_id} from Broker connection {connection_id} in tenant {tenant_id}.
Unlink integration {integration_id} from connection {connection_id} for org {org_id}, tenant {tenant_id}.
DELETE /tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/connections Delete all Broker connections on a deployment · Deletes Broker connections #
Ask an LLM
“How do I wipe every Broker connection from a deployment at once?”
“Can I clear all connections on a deployment in one call?”
Tell an agent destructive · confirm first
Delete all Broker connections on deployment {deployment_id}, install {install_id}, tenant {tenant_id}.
Remove every connection from Broker deployment {deployment_id} under install {install_id} in tenant {tenant_id}.
GET /tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/connections List Broker connections in a deployment · List Broker connections #
Ask an LLM
“What Broker connections are configured on a given Broker deployment?”
“Can I list all connections under one Universal Broker deployment?”
Tell an agent
List connections in deployment {deployment_id} of install {install_id}, tenant {tenant_id}.
Show the Broker connections for deployment {deployment_id} (install {install_id}, tenant {tenant_id}).
POST /tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/connections Create a Broker connection on a deployment · Creates Broker connection #
Ask an LLM
“How do I add a new Broker connection to a deployment?”
“Can I create a connection for a Universal Broker deployment through the API?”
Tell an agent
Create a Broker connection on deployment {deployment_id} for install {install_id} in tenant {tenant_id}.
Add a new connection to Broker deployment {deployment_id} (tenant {tenant_id}, install {install_id}).
DELETE /tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/connections/{connection_id} Delete a single Broker connection · Deletes Broker connection #
Ask an LLM
“How do I delete just one Broker connection from a deployment?”
“Can I remove a specific connection by ID and keep the others?”
Tell an agent destructive · confirm first
Delete Broker connection {connection_id} from deployment {deployment_id}, install {install_id}, tenant {tenant_id}.
Remove only connection {connection_id} on deployment {deployment_id} (tenant {tenant_id}, install {install_id}).
GET /tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/connections/{connection_id} Get one Broker connection's details · Get Broker connection #
Ask an LLM
“Where can I see the configuration of a single Broker connection?”
“Can I fetch one connection's data by its connection ID?”
Tell an agent
Get Broker connection {connection_id} on deployment {deployment_id}, install {install_id}, tenant {tenant_id}.
Show connection {connection_id} details for deployment {deployment_id} in tenant {tenant_id}, install {install_id}.
PATCH /tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/connections/{connection_id} Update a Broker connection's configuration · Updates Broker connection #
Ask an LLM
“How do I change the configuration of an existing Broker connection?”
“Can I edit a connection in place instead of recreating it?”
Tell an agent
Update Broker connection {connection_id} on deployment {deployment_id}, install {install_id}, tenant {tenant_id}.
Edit the settings of connection {connection_id} in deployment {deployment_id} for tenant {tenant_id}, install {install_id}.
GET /tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/connections/{connection_id}/bulk_migration List orgs eligible for bulk Universal Broker migration · List organizations for bulk migration #
Ask an LLM
“Which organizations would be moved if I bulk migrate to Universal Broker?”
“Can I preview the org IDs tied to a connection type before migrating?”
Tell an agent
List orgs to bulk migrate for connection {connection_id} on deployment {deployment_id}, install {install_id}, tenant {tenant_id}.
Show migration candidates for connection {connection_id} (tenant {tenant_id}, install {install_id}, deployment {deployment_id}).
POST /tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/connections/{connection_id}/bulk_migration Bulk migrate integrations to Universal Broker · Performs bulk migration integrations to universal broker #
Ask an LLM
“How do I move legacy brokered integrations onto Universal Broker in bulk?”
“Can I migrate many orgs' integrations to a Universal Broker connection at once?”
Tell an agent
Bulk migrate integrations to Universal Broker connection {connection_id} on deployment {deployment_id}, install {install_id}, tenant {tenant_id}.
Run the legacy-to-universal migration for connection {connection_id} in tenant {tenant_id} (install {install_id}, deployment {deployment_id}).

Documentation

📖
Documentation
https://apidocs.snyk.io/?version=2024-10-15
📖
Documentation
https://apidocs.snyk.io/?version=2024-10-15#tag/Orgs
📖
Documentation
https://apidocs.snyk.io/?version=2024-10-15#tag/Projects
📖
Documentation
https://apidocs.snyk.io/?version=2024-10-15#tag/Issues
📖
Documentation
https://apidocs.snyk.io/?version=2024-10-15#tag/Targets
📖
Documentation
https://apidocs.snyk.io/?version=2024-10-15#tag/Integrations
📖
Documentation
https://apidocs.snyk.io/?version=2024-10-15#tag/Audit-Logs
📖
Documentation
https://apidocs.snyk.io/?version=2024-10-15#tag/SBOM
📖
Documentation
https://apidocs.snyk.io/?version=2024-10-15#tag/Container-Images
📖
Documentation
https://apidocs.snyk.io/?version=2024-10-15#tag/Custom-Base-Images
📖
Documentation
https://apidocs.snyk.io/?version=2024-10-15#tag/Webhooks
📖
Documentation
https://apidocs.snyk.io/?version=2024-10-15#tag/Issues-Export

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/snyk/refs/heads/main/openapi/snyk-brokerconnections-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/snyk/refs/heads/main/json-schema/snyk-bulk-migration-create-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/snyk/refs/heads/main/json-schema/snyk-update-broker-connection-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/snyk/refs/heads/main/json-schema/snyk-list-broker-connections-summary-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/snyk/refs/heads/main/json-schema/snyk-create-broker-connection-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/snyk/refs/heads/main/json-schema/snyk-list-broker-connections-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/snyk/refs/heads/main/json-schema/snyk-get-broker-connection-integrations-response-schema.json

Other Resources

🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/snyk/refs/heads/main/overlays/snyk-brokerconnections-api-overlay.yaml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/snyk:snyk-brokerconnections-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

snyk-brokerconnections-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Snyk Broker Connections API
  version: REST
servers:
- description: Snyk REST API
  url: https://api.snyk.io/rest
security:
- APIToken: []
- BearerAuth: []
tags:


# --- truncated at 32 KB (461 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/snyk/refs/heads/main/openapi/snyk-brokerconnections-api-openapi.yml