How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Snyk BrokerConnections API

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

Snyk BrokerConnections API is one of 51 APIs that Snyk publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include BrokerConnections. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 12 operations across 7 paths, and defines 61 schemas. It is described by OpenAPI 3.2.0, at version REST.

Requests are made against a single base URL, https://api.snyk.io/rest.

12 operations 7 paths 61 schemas 3 DELETE5 GET1 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
REST
Base URL
https://api.snyk.io/rest
Authentication
API Key, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Snyk BrokerConnections API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (APIToken). It accepts HTTP bearer tokens (BearerAuth). By default, every request must be authenticated.

  • APIToken — API key value must be prefixed with \"Token \".

Paths & Operations 12

Across 7 paths, the API surfaces 12 operations — 3 DELETE, 5 GET, 1 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.

BrokerConnections 12
GET
/orgs/{org_id}/brokers/connections
List Broker connections for a given organization
listBrokerConnectionsForOrg 5 params → 200400401404500
GET
/tenants/{tenant_id}/brokers/connections/{connection_id}/integrations
Get Integrations using the current Broker connection
getBrokerConnectionIntegrations 6 params → 200400404500
POST
/tenants/{tenant_id}/brokers/connections/{connection_id}/orgs/{org_id}/integration
Creates Broker connection Integration Configuration
createBrokerConnectionIntegration 4 params body → 201400403404500
DELETE
/tenants/{tenant_id}/brokers/connections/{connection_id}/orgs/{org_id}/integrations/{integration_id}
Deletes an Integration for a Broker connection
deleteBrokerConnectionIntegration 5 params → 204400403404500
DELETE
/tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/connections
Deletes Broker connections
deleteBrokerConnections 4 params → 204400401404500
GET
/tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/connections
List Broker connections
listBrokerConnections 7 params → 200400401404500
POST
/tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/connections
Creates Broker connection
createBrokerConnection 4 params body → 201400401404500
DELETE
/tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/connections/{connection_id}
Deletes Broker connection
deleteBrokerConnection 5 params → 204400401404500
GET
/tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/connections/{connection_id}
Get Broker connection
getBrokerConnection 8 params → 200400401404500
PATCH
/tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/connections/{connection_id}
Updates Broker connection
updateBrokerConnection 5 params body → 200400401404500
GET
/tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/connections/{connection_id}/bulk_migration
List organizations for bulk migration
listBrokerOrgsForBulkMigration 8 params → 200400404500
POST
/tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/connections/{connection_id}/bulk_migration
Performs bulk migration integrations to universal broker
createBrokerOrgsForBulkMigration 5 params body → 201400404500

Schemas 61

The contract defines 61 schemas that model the data the API accepts and returns. The most detailed are PaginatedLinks (5 properties), ConnectionAttributes (4 properties), ConnectionSummaryAttributes (4 properties), BrokerConnectionResponseResource (4 properties). Each schema is shown below with its type and property counts.

BrokerConnectionSummaryResponseResource
object
3 properties 3 required
GetBrokerConnectionResponse
object
3 properties 1 required
BrokerConnectionResponseResource
object
4 properties 3 required
SonarqubeAttributes
object
2 properties 2 required
GitLabAttributes
object
3 properties 2 required
DigitalOceanCrAttributes
object
3 properties 2 required
ConnectionSummaryAttributes
object
4 properties 3 required
GitHubCloudAppAttributes
object
3 properties 2 required
BrokerContextResource
object
4 properties 3 required
GitHubServerAppAttributes
object
3 properties 2 required
OrgIntegrationResource
object
4 properties
GetBrokerConnectionIntegrationResponse
object
3 properties 1 required
CreateBrokerConnectionIntegration
object
1 property 1 required
JiraBearerAuth
object
2 properties 2 required
AppliedIntegrationsRelationships
object
3 properties 1 required
BrokerContextAttributes
object
1 property 1 required
Jira
object
3 properties 3 required
AcrAttributes
object
3 properties 2 required
JiraAttributes
object
3 properties 2 required
AllAppRiskAttributes
BulkMigrationCreateResponse
object
3 properties 1 required
HarborCrAttributes
object
3 properties 2 required
CommonConnectionAttributes
AppliedIntegrationRelationship
object
1 property 1 required
ListBrokerConnectionsResponse
object
3 properties 1 required
IntegrationResource
object
2 properties 1 required
NexusAttributes
object
3 properties 2 required
ConnectionRelationship
object
1 property 1 required
LinkProperty
GitHubAttributes
object
3 properties 2 required
GitlabCrAttributes
object
3 properties 2 required
GoogleArtifactCrAttributes
object
3 properties 2 required
ListBrokerConnectionsSummaryResponse
object
3 properties 1 required
AppRiskAttributes
object
3 properties 2 required
QuayCrAttributes
object
3 properties 2 required
CreateBulkMigrationRequest
object
1 property 1 required
OrganizationResource
object
2 properties
CommonConnectionResponseAttributes
PaginatedLinks
object
5 properties
BitbucketServer
object
4 properties 4 required
GetBrokerOrganizationsForBulkMigrationResponse
object
3 properties 1 required
SecretAttributes
object
3 properties 3 required
GitHubEnterpriseAttributes
object
3 properties 2 required
AzureReposAttributes
object
3 properties 2 required
ConnectionAttributes
object
4 properties 2 required
GetBrokerConnectionIntegrationsResponse
object
3 properties 1 required
ConfigurationResponseAttributes
GenericConfigurationAttributes
object
1 property 1 required
BitbucketServerBearerAuth
object
3 properties 3 required
WorkloadAttributes
object
3 properties 2 required
ArtifactoryCrAttributes
object
3 properties 2 required
BitbucketServerAttributes
object
3 properties 2 required
CheckmarxAttributes
object
3 properties 3 required
JsonApi
object
1 property 1 required
NexusCrAttributes
object
3 properties 2 required
GithubCrAttributes
object
3 properties 2 required
CreateBrokerConnectionRequest
object
1 property 1 required
ArtifactoryAttributes
object
3 properties 2 required
ConnectionRelationships__0
object
3 properties 1 required
ConfigurationAttributes
object
1 property 1 required
UpdateBrokerConnectionRequest
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

snyk-brokerconnections-api-openapi.yml Raw ↑

Other APIs Snyk publishes across the network.

Snyk REST API - Apps (OAuth)
Snyk V1 API (Legacy)
Snyk OAuth2 API - Authorize
Snyk OAuth2 API - Token
Snyk MCP Server (Snyk Studio)
Snyk AccessRequests API
Snyk AiBom API
Snyk Apps API
Snyk Asset API
Snyk Audit Logs API
Snyk BrokerContexts API
Snyk BrokerDeployments API
Where this information came from

This is an independent, third-party profile of Snyk BrokerConnections API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.