Universal Broker
Creates a new Broker Deployment for an installation
Required permissions
-
View Tenant Details (tenant.read) -
Edit Tenant Details (tenant.edit)
API key value must be prefixed with "Token ".
Tenant ID
Install ID
Requested API version
2021-06-04Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$Created broker deployment successfully
Bad Request: A parameter provided as a part of the request was invalid.
Unauthorized: the request requires an authentication token.
Not Found: The resource being operated on could not be found.
Internal Server Error: An error was encountered while attempting to process the request.
POST /rest/tenants/{tenant_id}/brokers/installs/{install_id}/deployments?version=2021-06-04 HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 138
{
"data": {
"attributes": {
"broker_app_installed_in_org_id": "123e4567-e89b-12d3-a456-426614174000",
"metadata": {}
},
"type": "broker_deployment"
}
}{
"data": {
"attributes": {
"broker_app_installed_in_org_id": "123e4567-e89b-12d3-a456-426614174000",
"install_id": "123e4567-e89b-12d3-a456-426614174000",
"metadata": {}
},
"id": "123e4567-e89b-12d3-a456-426614174000",
"type": "broker_deployment"
},
"jsonapi": {
"version": "1.0"
},
"links": {
"first": "https://example.com/api/resource?ending_before=v1.eyJpZCI6IjExIn0K",
"last": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjMwIn0K",
"next": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjEwIn0K"
}
}List Broker deployments for a given install ID
Required permissions
View Tenant Details (tenant.read)
API key value must be prefixed with "Token ".
Tenant ID
Install ID
Return the page of results immediately before this cursor
v1.eyJpZCI6IjExMDAifQo=Return the page of results immediately after this cursor
v1.eyJpZCI6IjEwMDAifQo=Number of results to return per page
10Example: 10Requested API version
2021-06-04Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$Returns the list of Broker deployments by install ID
Bad Request: A parameter provided as a part of the request was invalid.
Unauthorized: the request requires an authentication token.
Not Found: The resource being operated on could not be found.
Internal Server Error: An error was encountered while attempting to process the request.
GET /rest/tenants/{tenant_id}/brokers/installs/{install_id}/deployments?version=2021-06-04 HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*
{
"data": [
{
"attributes": {
"broker_app_installed_in_org_id": "123e4567-e89b-12d3-a456-426614174000",
"install_id": "123e4567-e89b-12d3-a456-426614174000",
"metadata": {}
},
"id": "123e4567-e89b-12d3-a456-426614174000",
"type": "broker_deployment"
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"first": "https://example.com/api/resource?ending_before=v1.eyJpZCI6IjExIn0K",
"last": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjMwIn0K",
"next": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjEwIn0K"
}
}Updates a Broker deployment for a given install ID
Required permissions
-
View Tenant Details (tenant.read) -
Edit Tenant Details (tenant.edit)
API key value must be prefixed with "Token ".
Tenant ID
Install ID
Deployment ID
Requested API version
2021-06-04Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$Updates an existing Broker deployment by install ID
Bad Request: A parameter provided as a part of the request was invalid.
Unauthorized: the request requires an authentication token.
Not Found: The resource being operated on could not be found.
Internal Server Error: An error was encountered while attempting to process the request.
PATCH /rest/tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}?version=2021-06-04 HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 190
{
"data": {
"attributes": {
"broker_app_installed_in_org_id": "123e4567-e89b-12d3-a456-426614174000",
"install_id": "123e4567-e89b-12d3-a456-426614174000",
"metadata": {}
},
"type": "broker_deployment"
}
}{
"data": {
"attributes": {
"broker_app_installed_in_org_id": "123e4567-e89b-12d3-a456-426614174000",
"install_id": "123e4567-e89b-12d3-a456-426614174000",
"metadata": {}
},
"id": "123e4567-e89b-12d3-a456-426614174000",
"type": "broker_deployment"
},
"jsonapi": {
"version": "1.0"
},
"links": {
"first": "https://example.com/api/resource?ending_before=v1.eyJpZCI6IjExIn0K",
"last": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjMwIn0K",
"next": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjEwIn0K"
}
}Delete a Broker deployment for a given install ID
Required permissions
-
View Tenant Details (tenant.read) -
Edit Tenant Details (tenant.edit)
API key value must be prefixed with "Token ".
Tenant ID
Install ID
Deployment ID
Requested API version
2021-06-04Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$Returns an empty response
Bad Request: A parameter provided as a part of the request was invalid.
Unauthorized: the request requires an authentication token.
Not Found: The resource being operated on could not be found.
Internal Server Error: An error was encountered while attempting to process the request.
DELETE /rest/tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}?version=2021-06-04 HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*
No content
Creates a new Deployment credential
Required permissions
-
View Tenant Details (tenant.read) -
Edit Tenant Details (tenant.edit)
API key value must be prefixed with "Token ".
Tenant ID
Install ID
Deployment ID
Requested API version
2021-06-04Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$Created Deployment credential successfully
Bad Request: A parameter provided as a part of the request was invalid.
Unauthorized: the request requires an authentication token.
Not Found: The resource being operated on could not be found.
Internal Server Error: An error was encountered while attempting to process the request.
POST /rest/tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/credentials?version=2021-06-04 HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 124
{
"data": {
"attributes": [
{
"comment": "text",
"environment_variable_name": "text",
"type": "text"
}
],
"type": "deployment_credential"
}
}{
"data": [
{
"attributes": {
"comment": "text",
"deployment_id": "123e4567-e89b-12d3-a456-426614174000",
"environment_variable_name": "text",
"type": "text"
},
"id": "123e4567-e89b-12d3-a456-426614174000",
"relationships": {
"broker_connections": [
{
"data": {
"id": "text",
"type": "text"
}
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"first": "https://example.com/api/resource?ending_before=v1.eyJpZCI6IjExIn0K",
"last": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjMwIn0K",
"next": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjEwIn0K"
}
},
"type": "deployment_credential"
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"first": "https://example.com/api/resource?ending_before=v1.eyJpZCI6IjExIn0K",
"last": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjMwIn0K",
"next": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjEwIn0K"
}
}List Deployment credentials for a given deployment ID
Required permissions
View Tenant Details (tenant.read)
API key value must be prefixed with "Token ".
Tenant ID
Install ID
Deployment ID
Return the page of results immediately before this cursor
v1.eyJpZCI6IjExMDAifQo=Return the page of results immediately after this cursor
v1.eyJpZCI6IjEwMDAifQo=Number of results to return per page
10Example: 10Requested API version
2021-06-04Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$Returns the list of deployment credentials by ID
Bad Request: A parameter provided as a part of the request was invalid.
Unauthorized: the request requires an authentication token.
Not Found: The resource being operated on could not be found.
Internal Server Error: An error was encountered while attempting to process the request.
GET /rest/tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/credentials?version=2021-06-04 HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*
{
"data": [
{
"attributes": {
"comment": "text",
"deployment_id": "123e4567-e89b-12d3-a456-426614174000",
"environment_variable_name": "text",
"type": "text"
},
"id": "123e4567-e89b-12d3-a456-426614174000",
"relationships": {
"broker_connections": [
{
"data": {
"id": "text",
"type": "text"
}
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"first": "https://example.com/api/resource?ending_before=v1.eyJpZCI6IjExIn0K",
"last": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjMwIn0K",
"next": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjEwIn0K"
}
},
"type": "deployment_credential"
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"first": "https://example.com/api/resource?ending_before=v1.eyJpZCI6IjExIn0K",
"last": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjMwIn0K",
"next": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjEwIn0K"
}
}Updates a Deployment credential for an deployment
Required permissions
-
View Tenant Details (tenant.read) -
Edit Tenant Details (tenant.edit)
API key value must be prefixed with "Token ".
Tenant ID
Install ID
Deployment ID
Credential ID
Requested API version
2021-06-04Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$Updates an existing Deployment credential for an deployment
Bad Request: A parameter provided as a part of the request was invalid.
Unauthorized: the request requires an authentication token.
Not Found: The resource being operated on could not be found.
Internal Server Error: An error was encountered while attempting to process the request.
PATCH /rest/tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/credentials/{credential_id}?version=2021-06-04 HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 469
{
"data": {
"attributes": {
"comment": "text",
"environment_variable_name": "text",
"type": "text"
},
"relationships": {
"broker_connections": [
{
"data": {
"id": "text",
"type": "text"
}
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"first": "https://example.com/api/resource?ending_before=v1.eyJpZCI6IjExIn0K",
"last": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjMwIn0K",
"next": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjEwIn0K"
}
},
"type": "deployment_credential"
}
}{
"data": {
"attributes": {
"comment": "text",
"deployment_id": "123e4567-e89b-12d3-a456-426614174000",
"environment_variable_name": "text",
"type": "text"
},
"id": "123e4567-e89b-12d3-a456-426614174000",
"relationships": {
"broker_connections": [
{
"data": {
"id": "text",
"type": "text"
}
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"first": "https://example.com/api/resource?ending_before=v1.eyJpZCI6IjExIn0K",
"last": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjMwIn0K",
"next": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjEwIn0K"
}
},
"type": "deployment_credential"
},
"jsonapi": {
"version": "1.0"
},
"links": {
"first": "https://example.com/api/resource?ending_before=v1.eyJpZCI6IjExIn0K",
"last": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjMwIn0K",
"next": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjEwIn0K"
}
}Get all Deployment credential data for an deployment
Required permissions
View Tenant Details (tenant.read)
API key value must be prefixed with "Token ".
Tenant ID
Install ID
Deployment ID
Credential ID
Requested API version
2021-06-04Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$Return the page of results immediately before this cursor
v1.eyJpZCI6IjExMDAifQo=Return the page of results immediately after this cursor
v1.eyJpZCI6IjEwMDAifQo=Number of results to return per page
10Example: 10Returns a Deployment credential
Bad Request: A parameter provided as a part of the request was invalid.
Unauthorized: the request requires an authentication token.
Not Found: The resource being operated on could not be found.
Internal Server Error: An error was encountered while attempting to process the request.
GET /rest/tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/credentials/{credential_id}?version=2021-06-04 HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*
{
"data": {
"attributes": {
"comment": "text",
"deployment_id": "123e4567-e89b-12d3-a456-426614174000",
"environment_variable_name": "text",
"type": "text"
},
"id": "123e4567-e89b-12d3-a456-426614174000",
"relationships": {
"broker_connections": [
{
"data": {
"id": "text",
"type": "text"
}
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"first": "https://example.com/api/resource?ending_before=v1.eyJpZCI6IjExIn0K",
"last": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjMwIn0K",
"next": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjEwIn0K"
}
},
"type": "deployment_credential"
},
"jsonapi": {
"version": "1.0"
},
"links": {
"first": "https://example.com/api/resource?ending_before=v1.eyJpZCI6IjExIn0K",
"last": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjMwIn0K",
"next": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjEwIn0K"
}
}Deletes an existing Deployment credential for an deployment
Required permissions
-
View Tenant Details (tenant.read) -
Edit Tenant Details (tenant.edit)
API key value must be prefixed with "Token ".
Tenant ID
Install ID
Deployment ID
Credential ID
Requested API version
2021-06-04Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$Deployment credential was deleted
Bad Request: A parameter provided as a part of the request was invalid.
Unauthorized: the request requires an authentication token.
Not Found: The resource being operated on could not be found.
Internal Server Error: An error was encountered while attempting to process the request.
DELETE /rest/tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/credentials/{credential_id}?version=2021-06-04 HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*
No content
Creates a new Broker connection for an deployment
Required permissions
-
View Tenant Details (tenant.read) -
Edit Tenant Details (tenant.edit)
API key value must be prefixed with "Token ".
Tenant ID
Install ID
Deployment ID
Requested API version
2021-06-04Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$Created broker connection successfully
Bad Request: one or more parameters are invalid. Check the input to match the expected format. See Snyk API
Unauthorized: the request requires an authentication token. See Revoke and regenerate a Snyk API token.
Not Found: The resource you are trying to access could not be found. Review the request and try again.
Internal Server Error: An unexpected error was encountered while attempting to process the request. Try again. If the error still occurs, contact support.
POST /rest/tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/connections?version=2021-06-04 HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 557
{
"data": {
"attributes": {
"deployment_id": "123e4567-e89b-12d3-a456-426614174000",
"identifier": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"secrets": {
"primary": {
"encrypted": "text",
"expires_at": "2025-11-15T15:28:16.778Z",
"nonce": "text"
},
"secondary": {
"encrypted": "text",
"expires_at": "2025-11-15T15:28:16.778Z",
"nonce": "text"
}
},
"configuration": {
"required": {
"checkmarx": "checkmarx.customer.com",
"checkmarx_password": "123e4567-e89b-12d3-a456-426614174000",
"checkmarx_username": "<username>"
},
"type": "apprisk",
"validations": [
{}
]
}
},
"type": "broker_connection"
}
}{
"data": {
"attributes": {
"deployment_id": "123e4567-e89b-12d3-a456-426614174000",
"identifier": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"secrets": {
"primary": {
"encrypted": "text",
"expires_at": "2025-11-15T15:28:16.778Z",
"nonce": "text"
},
"secondary": {
"encrypted": "text",
"expires_at": "2025-11-15T15:28:16.778Z",
"nonce": "text"
}
},
"configuration": {
"required": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"type": "text",
"validations": [
{}
]
}
},
"id": "123e4567-e89b-12d3-a456-426614174000",
"relationships": [
{
"attributes": {
"context": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"id": "123e4567-e89b-12d3-a456-426614174000",
"relationships": {
"broker_connections": [
{
"data": {
"id": "text",
"type": "text"
}
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"first": "https://example.com/api/resource?ending_before=v1.eyJpZCI6IjExIn0K",
"last": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjMwIn0K",
"next": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjEwIn0K"
},
"ANY_ADDITIONAL_PROPERTY": "anything",
"applied_integrations": [
{
"data": {
"id": "text",
"org_id": "text",
"type": "text"
}
}
]
},
"type": "broker_context",
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"type": "broker_connection"
},
"jsonapi": {
"version": "1.0"
},
"links": {
"first": "https://example.com/api/resource?ending_before=v1.eyJpZCI6IjExIn0K",
"last": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjMwIn0K",
"next": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjEwIn0K"
}
}List all Broker connections for a given deployment
Required permissions
View Tenant Details (tenant.read)
API key value must be prefixed with "Token ".
Tenant ID
Install ID
Deployment ID
Return the page of results immediately before this cursor
v1.eyJpZCI6IjExMDAifQo=Return the page of results immediately after this cursor
v1.eyJpZCI6IjEwMDAifQo=Number of results to return per page
10Example: 10Requested API version
2021-06-04Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$Returns the list of Broker connections by deployment ID
Bad Request: one or more parameters are invalid. Check the input to match the expected format. See Snyk API
Unauthorized: the request requires an authentication token. See Revoke and regenerate a Snyk API token.
Not Found: The resource you are trying to access could not be found. Review the request and try again.
Internal Server Error: An unexpected error was encountered while attempting to process the request. Try again. If the error still occurs, contact support.
GET /rest/tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/connections?version=2021-06-04 HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*
{
"data": [
{
"attributes": {
"deployment_id": "123e4567-e89b-12d3-a456-426614174000",
"identifier": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"secrets": {
"primary": {
"encrypted": "text",
"expires_at": "2025-11-15T15:28:16.778Z",
"nonce": "text"
},
"secondary": {
"encrypted": "text",
"expires_at": "2025-11-15T15:28:16.778Z",
"nonce": "text"
}
},
"configuration": {
"required": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"type": "text",
"validations": [
{}
]
}
},
"id": "123e4567-e89b-12d3-a456-426614174000",
"relationships": [
{
"attributes": {
"context": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"id": "123e4567-e89b-12d3-a456-426614174000",
"relationships": {
"broker_connections": [
{
"data": {
"id": "text",
"type": "text"
}
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"first": "https://example.com/api/resource?ending_before=v1.eyJpZCI6IjExIn0K",
"last": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjMwIn0K",
"next": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjEwIn0K"
},
"ANY_ADDITIONAL_PROPERTY": "anything",
"applied_integrations": [
{
"data": {
"id": "text",
"org_id": "text",
"type": "text"
}
}
]
},
"type": "broker_context",
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"type": "broker_connection"
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"first": "https://example.com/api/resource?ending_before=v1.eyJpZCI6IjExIn0K",
"last": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjMwIn0K",
"next": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjEwIn0K"
}
}Deletes all existing Broker connections for an deployment
Required permissions
-
View Tenant Details (tenant.read) -
Edit Tenant Details (tenant.edit)
API key value must be prefixed with "Token ".
Tenant ID
Install ID
Deployment ID
Requested API version
2021-06-04Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$All Broker connections were deleted
Bad Request: one or more parameters are invalid. Check the input to match the expected format. See Snyk API
Unauthorized: the request requires an authentication token. See Revoke and regenerate a Snyk API token.
Not Found: The resource you are trying to access could not be found. Review the request and try again.
Internal Server Error: An unexpected error was encountered while attempting to process the request. Try again. If the error still occurs, contact support.
DELETE /rest/tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/connections?version=2021-06-04 HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*
No content
Updates a Broker connection for an deployment
Required permissions
-
View Tenant Details (tenant.read) -
Edit Tenant Details (tenant.edit)
API key value must be prefixed with "Token ".
Tenant ID
Install ID
Deployment ID
Connection ID
Requested API version
2021-06-04Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$Updates an existing Broker connection for an deployment
Bad Request: one or more parameters are invalid. Check the input to match the expected format. See Snyk API
Unauthorized: the request requires an authentication token. See Revoke and regenerate a Snyk API token.
Not Found: The resource you are trying to access could not be found. Review the request and try again.
Internal Server Error: An unexpected error was encountered while attempting to process the request. Try again. If the error still occurs, contact support.
PATCH /rest/tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/connections/{connection_id}?version=2021-06-04 HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 557
{
"data": {
"attributes": {
"deployment_id": "123e4567-e89b-12d3-a456-426614174000",
"identifier": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"secrets": {
"primary": {
"encrypted": "text",
"expires_at": "2025-11-15T15:28:16.778Z",
"nonce": "text"
},
"secondary": {
"encrypted": "text",
"expires_at": "2025-11-15T15:28:16.778Z",
"nonce": "text"
}
},
"configuration": {
"required": {
"checkmarx": "checkmarx.customer.com",
"checkmarx_password": "123e4567-e89b-12d3-a456-426614174000",
"checkmarx_username": "<username>"
},
"type": "apprisk",
"validations": [
{}
]
}
},
"type": "broker_connection"
}
}{
"data": {
"attributes": {
"deployment_id": "123e4567-e89b-12d3-a456-426614174000",
"identifier": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"secrets": {
"primary": {
"encrypted": "text",
"expires_at": "2025-11-15T15:28:16.778Z",
"nonce": "text"
},
"secondary": {
"encrypted": "text",
"expires_at": "2025-11-15T15:28:16.778Z",
"nonce": "text"
}
},
"configuration": {
"required": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"type": "text",
"validations": [
{}
]
}
},
"id": "123e4567-e89b-12d3-a456-426614174000",
"relationships": [
{
"attributes": {
"context": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"id": "123e4567-e89b-12d3-a456-426614174000",
"relationships": {
"broker_connections": [
{
"data": {
"id": "text",
"type": "text"
}
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"first": "https://example.com/api/resource?ending_before=v1.eyJpZCI6IjExIn0K",
"last": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjMwIn0K",
"next": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjEwIn0K"
},
"ANY_ADDITIONAL_PROPERTY": "anything",
"applied_integrations": [
{
"data": {
"id": "text",
"org_id": "text",
"type": "text"
}
}
]
},
"type": "broker_context",
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"type": "broker_connection"
},
"jsonapi": {
"version": "1.0"
},
"links": {
"first": "https://example.com/api/resource?ending_before=v1.eyJpZCI6IjExIn0K",
"last": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjMwIn0K",
"next": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjEwIn0K"
}
}Get all Broker connection data for an deployment
Required permissions
View Tenant Details (tenant.read)
API key value must be prefixed with "Token ".
Tenant ID
Install ID
Deployment ID
Connection ID
Requested API version
2021-06-04Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$Return the page of results immediately before this cursor
v1.eyJpZCI6IjExMDAifQo=Return the page of results immediately after this cursor
v1.eyJpZCI6IjEwMDAifQo=Number of results to return per page
10Example: 10Returns a Broker connection
Bad Request: one or more parameters are invalid. Check the input to match the expected format. See Snyk API
Unauthorized: the request requires an authentication token. See Revoke and regenerate a Snyk API token.
Not Found: The resource you are trying to access could not be found. Review the request and try again.
Internal Server Error: An unexpected error was encountered while attempting to process the request. Try again. If the error still occurs, contact support.
GET /rest/tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/connections/{connection_id}?version=2021-06-04 HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*
{
"data": {
"attributes": {
"deployment_id": "123e4567-e89b-12d3-a456-426614174000",
"identifier": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"secrets": {
"primary": {
"encrypted": "text",
"expires_at": "2025-11-15T15:28:16.778Z",
"nonce": "text"
},
"secondary": {
"encrypted": "text",
"expires_at": "2025-11-15T15:28:16.778Z",
"nonce": "text"
}
},
"configuration": {
"required": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"type": "text",
"validations": [
{}
]
}
},
"id": "123e4567-e89b-12d3-a456-426614174000",
"relationships": [
{
"attributes": {
"context": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"id": "123e4567-e89b-12d3-a456-426614174000",
"relationships": {
"broker_connections": [
{
"data": {
"id": "text",
"type": "text"
}
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"first": "https://example.com/api/resource?ending_before=v1.eyJpZCI6IjExIn0K",
"last": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjMwIn0K",
"next": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjEwIn0K"
},
"ANY_ADDITIONAL_PROPERTY": "anything",
"applied_integrations": [
{
"data": {
"id": "text",
"org_id": "text",
"type": "text"
}
}
]
},
"type": "broker_context",
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"type": "broker_connection"
},
"jsonapi": {
"version": "1.0"
},
"links": {
"first": "https://example.com/api/resource?ending_before=v1.eyJpZCI6IjExIn0K",
"last": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjMwIn0K",
"next": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjEwIn0K"
}
}Deletes an existing Broker connection for an deployment
Required permissions
-
View Tenant Details (tenant.read) -
Edit Tenant Details (tenant.edit)
API key value must be prefixed with "Token ".
Tenant ID
Install ID
Deployment ID
Connection ID
Requested API version
2021-06-04Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$Broker connection was deleted
Bad Request: one or more parameters are invalid. Check the input to match the expected format. See Snyk API
Unauthorized: the request requires an authentication token. See Revoke and regenerate a Snyk API token.
Not Found: The resource you are trying to access could not be found. Review the request and try again.
Internal Server Error: An unexpected error was encountered while attempting to process the request. Try again. If the error still occurs, contact support.
DELETE /rest/tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/connections/{connection_id}?version=2021-06-04 HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*
No content
Performs bulk migration for integrations from legacy to universal broker
Required permissions
View Tenant Details (tenant.read)
API key value must be prefixed with "Token ".
Connection ID
Deployment ID
Install ID
Tenant ID
Requested API version
2021-06-04Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$The bulk migration process was started
Bad Request: one or more parameters are invalid. Check the input to match the expected format. See Snyk API
Not Found: The resource you are trying to access could not be found. Review the request and try again.
Internal Server Error: An unexpected error was encountered while attempting to process the request. Try again. If the error still occurs, contact support.
POST /rest/tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/connections/{connection_id}/bulk_migration?version=2021-06-04 HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 36
{
"data": {
"type": "broker_migration"
}
}{
"data": {
"attributes": {
"status": "text"
},
"id": "123e4567-e89b-12d3-a456-426614174000",
"type": "broker_migration"
},
"jsonapi": {
"version": "1.0"
},
"links": {
"first": "https://example.com/api/resource?ending_before=v1.eyJpZCI6IjExIn0K",
"last": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjMwIn0K",
"next": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjEwIn0K"
}
}Lists organization IDs associated with a connection type to be bulk migrated to universal broker
Required permissions
View Tenant Details (tenant.read)
API key value must be prefixed with "Token ".
Connection ID
Deployment ID
Install ID
Tenant ID
Requested API version
2021-06-04Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$Return the page of results immediately before this cursor
v1.eyJpZCI6IjExMDAifQo=Return the page of results immediately after this cursor
v1.eyJpZCI6IjEwMDAifQo=Number of results to return per page
10Example: 10Returns a list of organization IDs for the bulk migration
Bad Request: one or more parameters are invalid. Check the input to match the expected format. See Snyk API
Not Found: The resource you are trying to access could not be found. Review the request and try again.
Internal Server Error: An unexpected error was encountered while attempting to process the request. Try again. If the error still occurs, contact support.
GET /rest/tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/connections/{connection_id}/bulk_migration?version=2021-06-04 HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*
{
"data": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"type": "broker_organization"
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"first": "https://example.com/api/resource?ending_before=v1.eyJpZCI6IjExIn0K",
"last": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjMwIn0K",
"next": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjEwIn0K"
}
}List Broker deployments for the tenant
Required permissions
View Tenant Details (tenant.read)
API key value must be prefixed with "Token ".
Tenant ID
Return the page of results immediately before this cursor
v1.eyJpZCI6IjExMDAifQo=Return the page of results immediately after this cursor
v1.eyJpZCI6IjEwMDAifQo=Number of results to return per page
10Example: 10Requested API version
2021-06-04Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$Returns the list of Broker deployments by install ID
Bad Request: A parameter provided as a part of the request was invalid.
Unauthorized: the request requires an authentication token.
Not Found: The resource being operated on could not be found.
Internal Server Error: An error was encountered while attempting to process the request.
GET /rest/tenants/{tenant_id}/brokers/deployments?version=2021-06-04 HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*
{
"data": [
{
"attributes": {
"broker_app_installed_in_org_id": "123e4567-e89b-12d3-a456-426614174000",
"install_id": "123e4567-e89b-12d3-a456-426614174000",
"metadata": {}
},
"id": "123e4567-e89b-12d3-a456-426614174000",
"type": "broker_deployment"
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"first": "https://example.com/api/resource?ending_before=v1.eyJpZCI6IjExIn0K",
"last": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjMwIn0K",
"next": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjEwIn0K"
}
}Deletes an existing Broker connection for an deployment
Required permissions
View Tenant Details (tenant.read)
API key value must be prefixed with "Token ".
Tenant ID
Connection ID
Org ID
Integration ID
Requested API version
2021-06-04Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$Broker connection integration was deleted
Bad Request: one or more parameters are invalid. Check the input to match the expected format. See Snyk API
Not Found: The resource you are trying to access could not be found. Review the request and try again.
Internal Server Error: An unexpected error was encountered while attempting to process the request. Try again. If the error still occurs, contact support.
DELETE /rest/tenants/{tenant_id}/brokers/connections/{connection_id}/orgs/{org_id}/integrations/{integration_id}?version=2021-06-04 HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*
No content
Configures integrations to use the Broker connection for an deployment
Required permissions
View Tenant Details (tenant.read)
API key value must be prefixed with "Token ".
Tenant ID
Connection ID
Org ID
Requested API version
2021-06-04Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$Configured integrations to use broker connection successfully
Bad Request: one or more parameters are invalid. Check the input to match the expected format. See Snyk API
Not Found: The resource you are trying to access could not be found. Review the request and try again.
Internal Server Error: An unexpected error was encountered while attempting to process the request. Try again. If the error still occurs, contact support.
POST /rest/tenants/{tenant_id}/brokers/connections/{connection_id}/orgs/{org_id}/integration?version=2021-06-04 HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 82
{
"data": {
"integration_id": "123e4567-e89b-12d3-a456-426614174000",
"type": "github"
}
}{
"data": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"integration_type": "text",
"org_id": "123e4567-e89b-12d3-a456-426614174000",
"type": "text"
},
"jsonapi": {
"version": "1.0"
},
"links": {
"first": "https://example.com/api/resource?ending_before=v1.eyJpZCI6IjExIn0K",
"last": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjMwIn0K",
"next": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjEwIn0K"
}
}Get all integrations using the Broker connection
Required permissions
View Tenant Details (tenant.read)
API key value must be prefixed with "Token ".
Tenant ID
Connection ID
Requested API version
2021-06-04Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$Return the page of results immediately before this cursor
v1.eyJpZCI6IjExMDAifQo=Return the page of results immediately after this cursor
v1.eyJpZCI6IjEwMDAifQo=Number of results to return per page
10Example: 10Returns a list of Integration IDs
Bad Request: one or more parameters are invalid. Check the input to match the expected format. See Snyk API
Not Found: The resource you are trying to access could not be found. Review the request and try again.
Internal Server Error: An unexpected error was encountered while attempting to process the request. Try again. If the error still occurs, contact support.
GET /rest/tenants/{tenant_id}/brokers/connections/{connection_id}/integrations?version=2021-06-04 HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*
{
"data": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"integration_type": "text",
"org_id": "123e4567-e89b-12d3-a456-426614174000",
"type": "text"
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"first": "https://example.com/api/resource?ending_before=v1.eyJpZCI6IjExIn0K",
"last": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjMwIn0K",
"next": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjEwIn0K"
}
}List all Broker connections integrated with a given org
Required permissions
View Organization (org.read)
API key value must be prefixed with "Token ".
Org ID
Return the page of results immediately before this cursor
v1.eyJpZCI6IjExMDAifQo=Return the page of results immediately after this cursor
v1.eyJpZCI6IjEwMDAifQo=Number of results to return per page
10Example: 10Requested API version
2021-06-04Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$Returns the list of Broker connections by org ID
Bad Request: one or more parameters are invalid. Check the input to match the expected format. See Snyk API
Unauthorized: the request requires an authentication token. See Revoke and regenerate a Snyk API token.
Not Found: The resource you are trying to access could not be found. Review the request and try again.
Internal Server Error: An unexpected error was encountered while attempting to process the request. Try again. If the error still occurs, contact support.
GET /rest/orgs/{org_id}/brokers/connections?version=2021-06-04 HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*
{
"data": [
{
"attributes": {
"connection_type": "text",
"context": "123e4567-e89b-12d3-a456-426614174000",
"deployment_id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text"
},
"id": "123e4567-e89b-12d3-a456-426614174000",
"type": "broker_connection"
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"first": "https://example.com/api/resource?ending_before=v1.eyJpZCI6IjExIn0K",
"last": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjMwIn0K",
"next": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjEwIn0K"
}
}Last updated
Was this helpful?