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 BrokerDeployments API

The BrokerDeployments API from Snyk — 3 operation(s) for brokerdeployments.

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

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

This API exposes 5 operations across 3 paths, and defines 11 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.

5 operations 3 paths 11 schemas 1 DELETE2 GET1 PATCH1 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 BrokerDeployments 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 5

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

BrokerDeployments 5
GET
/tenants/{tenant_id}/brokers/deployments
List Broker deployments for tenant
listBrokerDeploymentsForTenant 5 params → 200400401404500
GET
/tenants/{tenant_id}/brokers/installs/{install_id}/deployments
List Broker deployments
listBrokerDeployments 6 params → 200400401404500
POST
/tenants/{tenant_id}/brokers/installs/{install_id}/deployments
Creates Broker Deployment
createBrokerDeployment 3 params body → 201400401404500
DELETE
/tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}
Deletes Broker deployment
deleteBrokerDeployment 4 params → 204400401404500
PATCH
/tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}
Updates Broker deployment
updateBrokerDeployment 4 params body → 200400401404500

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are PaginatedLinks (5 properties), ListBrokerDeploymentsResponse (3 properties), BrokerDeploymentAttributes (3 properties), GetBrokerDeploymentResponse (3 properties). Each schema is shown below with its type and property counts.

BrokerDeploymentResource
object
3 properties 3 required
BrokerDeploymentUpdateAttributes
object
3 properties 2 required
CreateBrokerDeploymentRequest
object
1 property 1 required
JsonApi
object
1 property 1 required
BrokerDeploymentUpdateResource
object
3 properties 3 required
PaginatedLinks
object
5 properties
UpdateBrokerDeploymentRequest
object
1 property 1 required
GetBrokerDeploymentResponse
object
3 properties 1 required
LinkProperty
ListBrokerDeploymentsResponse
object
3 properties 1 required
BrokerDeploymentAttributes
object
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

snyk-brokerdeployments-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 BrokerConnections API
Snyk BrokerContexts API
Where this information came from

This is an independent, third-party profile of Snyk BrokerDeployments 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.