Universal Broker
Creates a new Broker Deployment for an installation
Required permissions
-
View Tenant Details (tenant.read)
-
Edit Tenant Details (tenant.edit)
Tenant ID
Install ID
Requested API version
2021-06-04
Pattern: ^(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))?))$
POST /rest/tenants/{tenant_id}/brokers/installs/{install_id}/deployments 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)
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
10
Example: 10
Requested API version
2021-06-04
Pattern: ^(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))?))$
GET /rest/tenants/{tenant_id}/brokers/installs/{install_id}/deployments 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)
Tenant ID
Install ID
Deployment ID
Requested API version
2021-06-04
Pattern: ^(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))?))$
PATCH /rest/tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id} 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)
Tenant ID
Install ID
Deployment ID
Requested API version
2021-06-04
Pattern: ^(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))?))$
DELETE /rest/tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id} 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)
Tenant ID
Install ID
Deployment ID
Requested API version
2021-06-04
Pattern: ^(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))?))$
POST /rest/tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/credentials 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)
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
10
Example: 10
Requested API version
2021-06-04
Pattern: ^(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))?))$
GET /rest/tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/credentials 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)
Tenant ID
Install ID
Deployment ID
Credential ID
Requested API version
2021-06-04
Pattern: ^(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))?))$
PATCH /rest/tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/credentials/{credential_id} 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)
Tenant ID
Install ID
Deployment ID
Credential ID
Requested API version
2021-06-04
Pattern: ^(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
10
Example: 10
GET /rest/tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/credentials/{credential_id} 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)
Tenant ID
Install ID
Deployment ID
Credential ID
Requested API version
2021-06-04
Pattern: ^(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))?))$
DELETE /rest/tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/credentials/{credential_id} HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*
No content
Creates a new Broker Context
Required permissions
-
View Tenant Details (tenant.read)
-
Edit Tenant Details (tenant.edit)
Tenant ID
Install ID
Deployment ID
Requested API version
2021-06-04
Pattern: ^(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))?))$
POST /rest/tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/contexts HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 149
{
"data": {
"attributes": {
"connection_id": "123e4567-e89b-12d3-a456-426614174000",
"context": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"type": "broker_context"
}
}
{
"data": {
"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"
},
"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 contexts for a given deployment ID
Required permissions
View Tenant Details (tenant.read)
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
10
Example: 10
Requested API version
2021-06-04
Pattern: ^(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))?))$
GET /rest/tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/contexts HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*
{
"data": [
{
"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"
}
],
"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"
}
}
Creates a new Broker connection for an deployment
Required permissions
-
View Tenant Details (tenant.read)
-
Edit Tenant Details (tenant.edit)
Tenant ID
Install ID
Deployment ID
Requested API version
2021-06-04
Pattern: ^(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))?))$
POST /rest/tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/connections 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-06-25T19:01:42.986Z",
"nonce": "text"
},
"secondary": {
"encrypted": "text",
"expires_at": "2025-06-25T19:01:42.986Z",
"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-06-25T19:01:42.986Z",
"nonce": "text"
},
"secondary": {
"encrypted": "text",
"expires_at": "2025-06-25T19:01:42.986Z",
"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)
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
10
Example: 10
Requested API version
2021-06-04
Pattern: ^(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))?))$
GET /rest/tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/connections 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-06-25T19:01:42.986Z",
"nonce": "text"
},
"secondary": {
"encrypted": "text",
"expires_at": "2025-06-25T19:01:42.986Z",
"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)
Tenant ID
Install ID
Deployment ID
Requested API version
2021-06-04
Pattern: ^(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))?))$
DELETE /rest/tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/connections 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)
Tenant ID
Install ID
Deployment ID
Connection ID
Requested API version
2021-06-04
Pattern: ^(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))?))$
PATCH /rest/tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/connections/{connection_id} 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-06-25T19:01:42.986Z",
"nonce": "text"
},
"secondary": {
"encrypted": "text",
"expires_at": "2025-06-25T19:01:42.986Z",
"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-06-25T19:01:42.986Z",
"nonce": "text"
},
"secondary": {
"encrypted": "text",
"expires_at": "2025-06-25T19:01:42.986Z",
"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)
Tenant ID
Install ID
Deployment ID
Connection ID
Requested API version
2021-06-04
Pattern: ^(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
10
Example: 10
GET /rest/tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/connections/{connection_id} 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-06-25T19:01:42.986Z",
"nonce": "text"
},
"secondary": {
"encrypted": "text",
"expires_at": "2025-06-25T19:01:42.986Z",
"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)
Tenant ID
Install ID
Deployment ID
Connection ID
Requested API version
2021-06-04
Pattern: ^(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))?))$
DELETE /rest/tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/connections/{connection_id} 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)
Connection ID
Deployment ID
Install ID
Tenant ID
Requested API version
2021-06-04
Pattern: ^(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))?))$
POST /rest/tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/connections/{connection_id}/bulk_migration 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)
Connection ID
Deployment ID
Install ID
Tenant ID
Requested API version
2021-06-04
Pattern: ^(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
10
Example: 10
GET /rest/tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/connections/{connection_id}/bulk_migration 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"
}
}
Updates a Broker Context for an deployment
Required permissions
-
View Tenant Details (tenant.read)
-
Edit Tenant Details (tenant.edit)
Tenant ID
Install ID
Context ID
Requested API version
2021-06-04
Pattern: ^(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))?))$
PATCH /rest/tenants/{tenant_id}/brokers/installs/{install_id}/contexts/{context_id} HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 138
{
"data": {
"attributes": {
"context": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"id": "123e4567-e89b-12d3-a456-426614174000",
"type": "broker_context"
}
}
{
"data": {
"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"
},
"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 context for a given broker context ID
Required permissions
View Tenant Details (tenant.read)
Tenant ID
Install ID
Context 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
10
Example: 10
Requested API version
2021-06-04
Pattern: ^(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))?))$
GET /rest/tenants/{tenant_id}/brokers/installs/{install_id}/contexts/{context_id} HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*
{
"data": {
"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"
},
"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 context
Required permissions
-
View Tenant Details (tenant.read)
-
Edit Tenant Details (tenant.edit)
Tenant ID
Install ID
Context ID
Requested API version
2021-06-04
Pattern: ^(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))?))$
DELETE /rest/tenants/{tenant_id}/brokers/installs/{install_id}/contexts/{context_id} HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*
No content
Deletes an existing Broker context association for an integration
Required permissions
-
View Tenant Details (tenant.read)
-
Edit Tenant Details (tenant.edit)
Tenant ID
Install ID
Context ID
Integration ID
Requested API version
2021-06-04
Pattern: ^(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))?))$
DELETE /rest/tenants/{tenant_id}/brokers/installs/{install_id}/contexts/{context_id}/integrations/{integration_id} HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*
No content
Updates an integration to be associated with a Broker context
Required permissions
-
View Tenant Details (tenant.read)
-
Edit Tenant Details (tenant.edit)
Tenant ID
Install ID
Context ID
Requested API version
2021-06-04
Pattern: ^(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))?))$
PATCH /rest/tenants/{tenant_id}/brokers/installs/{install_id}/contexts/{context_id}/integration HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 145
{
"data": {
"attributes": {
"org_id": "123e4567-e89b-12d3-a456-426614174000"
},
"id": "123e4567-e89b-12d3-a456-426614174000",
"type": "broker_integration"
}
}
{
"data": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"relationships": {
"integrations_relationships": [
{
"data": {
"id": "text",
"integration_type": "text",
"org_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": "broker_context"
},
"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 contexts for a given broker connection ID
Required permissions
View Tenant Details (tenant.read)
Tenant ID
Install ID
Connection 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
10
Example: 10
Requested API version
2021-06-04
Pattern: ^(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))?))$
GET /rest/tenants/{tenant_id}/brokers/installs/{install_id}/connections/{connection_id}/contexts HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*
{
"data": [
{
"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"
}
],
"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)
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
10
Example: 10
Requested API version
2021-06-04
Pattern: ^(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))?))$
GET /rest/tenants/{tenant_id}/brokers/deployments 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)
-
Edit Tenant Details (tenant.edit)
Tenant ID
Connection ID
Org ID
Integration ID
Requested API version
2021-06-04
Pattern: ^(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))?))$
DELETE /rest/tenants/{tenant_id}/brokers/connections/{connection_id}/orgs/{org_id}/integrations/{integration_id} 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)
-
Edit Tenant Details (tenant.edit)
Tenant ID
Connection ID
Org ID
Requested API version
2021-06-04
Pattern: ^(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))?))$
POST /rest/tenants/{tenant_id}/brokers/connections/{connection_id}/orgs/{org_id}/integration HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 80
{
"data": {
"integration_id": "123e4567-e89b-12d3-a456-426614174000",
"type": "text"
}
}
{
"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)
Tenant ID
Connection ID
Requested API version
2021-06-04
Pattern: ^(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
10
Example: 10
GET /rest/tenants/{tenant_id}/brokers/connections/{connection_id}/integrations 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)
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
10
Example: 10
Requested API version
2021-06-04
Pattern: ^(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))?))$
GET /rest/orgs/{org_id}/brokers/connections 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?