OpenSourceSettings

This document uses the REST API. For more details, see the Authentication for API page.

Update opensource private registry settings of ecosystem for organization

patch

Updates the publicly-accessible private registry settings of a specific Open Source Ecosystem for an Organization. This endpoint has JSON-PATCH semantics: only provided integrations are updated. Provide an empty value for urls to remove an integration.

Required permissions

• Edit Organization (org.edit)

Authorizations

APITokenBearerAuth

AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters

org_idstringRequired

Org ID

ecosystemstring · enumRequired

The ecosystem identifier

Possible values:

Query parameters

versionstringRequired

Requested API version

Example: 2026-03-25Pattern: ^(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))?))$

Body

application/vnd.api+json

Responses

200

Successfully updated private registry settings

application/vnd.api+json

400

Bad Request: A parameter provided as a part of the request was invalid.

application/vnd.api+json

401

Unauthorized: the request requires an authentication token.

application/vnd.api+json

403

Forbidden: the request requires an authentication token with more or different permissions.

application/vnd.api+json

404

Not Found: The resource being operated on could not be found.

application/vnd.api+json

500

Internal Server Error: An error was encountered while attempting to process the request.

application/vnd.api+json

patch

/orgs/{org_id}/settings/opensource/{ecosystem}/private-registries

HTTPcURLJavaScriptPython

PATCH /rest/orgs/{org_id}/settings/opensource/{ecosystem}/private-registries?version=2026-03-25 HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 140

{
  "data": {
    "integrations": [
      {
        "integration_type": "artifactory",
        "urls": [
          "https://artifactory.example.com/artifactory/api/go/team-go-modules"
        ]
      }
    ]
  }
}

Add a Go module proxy integrationEdit multiple integrations at onceRemove an integration by setting empty urls

{
  "data": {
    "integrations": [
      {
        "created_at": "2026-04-15T10:00:00.000Z",
        "id": "019e8802-d843-7b9f-a1dd-bd5c0bac373d",
        "integration_type": "artifactory",
        "urls": [
          "https://artifactory.example.com/artifactory/api/go/team-go-modules"
        ]
      }
    ]
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "/orgs/4f4fbf18-b2cd-4bf3-9b7e-323b8be249ea/settings/opensource/Golang/private-registries?version=2024-10-15"
  }
}

Get opensource private registry settings of ecosystem for organization

get

Retrieves the publicly-accessible private registry settings of a specific Open Source Ecosystem for an Organization. These are registries (e.g. JFrog Artifactory, Sonatype Nexus) hosted on a public URL and reached directly with credentials, without the Snyk Broker.

Required permissions

• View Organization (org.read)

Authorizations

APITokenBearerAuth

AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters

org_idstringRequired

Org ID

ecosystemstring · enumRequired

The ecosystem identifier

Possible values:

Query parameters

versionstringRequired

Requested API version

Example: 2026-03-25Pattern: ^(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))?))$

Responses

200

Successfully retrieved private registry settings

application/vnd.api+json

400

Bad Request: A parameter provided as a part of the request was invalid.

application/vnd.api+json

401

Unauthorized: the request requires an authentication token.

application/vnd.api+json

403

Forbidden: the request requires an authentication token with more or different permissions.

application/vnd.api+json

404

Not Found: The resource being operated on could not be found.

application/vnd.api+json

500

Internal Server Error: An error was encountered while attempting to process the request.

application/vnd.api+json

get

/orgs/{org_id}/settings/opensource/{ecosystem}/private-registries

HTTPcURLJavaScriptPython

GET /rest/orgs/{org_id}/settings/opensource/{ecosystem}/private-registries?version=2026-03-25 HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": {
    "integrations": []
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "/orgs/82b3efbb-4b32-4f96-8005-9444eceacec8/settings/opensource/Golang/private-registries?version=2024-10-15"
  }
}

Update opensource broker settings of ecosystem for organization

patch

Updates all Broker settings of a specific Open Source Ecosystem for an Organization. This endpoint has JSON-PATCH semantics: only provided Broker integrations are updated. Provide an empty value for urls to remove a Broker integration.

Required permissions

• Edit Organization (org.edit)

Authorizations

APITokenBearerAuth

AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters

org_idstringRequired

Org ID

ecosystemstring · enumRequired

The ecosystem identifier

Possible values:

Query parameters

versionstringRequired

Requested API version

Example: 2026-03-25Pattern: ^(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))?))$

Body

application/vnd.api+json

Responses

200

Successfully updated Broker settings

application/vnd.api+json

400

Bad Request: A parameter provided as a part of the request was invalid.

application/vnd.api+json

401

Unauthorized: the request requires an authentication token.

application/vnd.api+json

403

Forbidden: the request requires an authentication token with more or different permissions.

application/vnd.api+json

404

Not Found: The resource being operated on could not be found.

application/vnd.api+json

500

Internal Server Error: An error was encountered while attempting to process the request.

application/vnd.api+json

patch

/orgs/{org_id}/settings/opensource/{ecosystem}/broker

HTTPcURLJavaScriptPython

PATCH /rest/orgs/{org_id}/settings/opensource/{ecosystem}/broker?version=2026-03-25 HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 160

{
  "data": {
    "integrations": [
      {
        "integration_type": "artifactory",
        "urls": [
          "https://artifactory.internal-domain.com/artifactory/api/nuget/v3/team-nuget/index.json"
        ]
      }
    ]
  }
}

Add an integrationEdit multiple integrations at onceRemove an integration by setting empty urls

{
  "data": {
    "integrations": [
      {
        "created_at": "2024-01-15T10:00:00.000Z",
        "id": "019d7722-d843-7b9f-a1dd-bd5c0bac373d",
        "integration_type": "artifactory",
        "urls": [
          "https://artifactory.internal-domain.com/artifactory/api/nuget/v3/team-nuget/index.json"
        ]
      }
    ]
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "/orgs/4f4fbf18-b2cd-4bf3-9b7e-323b8be249ea/settings/opensource/Dotnet/broker?version=2024-10-15"
  }
}

Get opensource broker settings of ecosystem for organization

get

Retrieves all Broker settings of a specific Open Source Ecosystem for an Organization

Required permissions

• View Organization (org.read)

Authorizations

APITokenBearerAuth

AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters

org_idstringRequired

Org ID

ecosystemstring · enumRequired

The ecosystem identifier

Possible values:

Query parameters

versionstringRequired

Requested API version

Example: 2026-03-25Pattern: ^(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))?))$

Responses

200

Successfully retrieved Broker settings

application/vnd.api+json

400

Bad Request: A parameter provided as a part of the request was invalid.

application/vnd.api+json

401

Unauthorized: the request requires an authentication token.

application/vnd.api+json

403

Forbidden: the request requires an authentication token with more or different permissions.

application/vnd.api+json

404

Not Found: The resource being operated on could not be found.

application/vnd.api+json

500

Internal Server Error: An error was encountered while attempting to process the request.

application/vnd.api+json

get

/orgs/{org_id}/settings/opensource/{ecosystem}/broker

HTTPcURLJavaScriptPython

GET /rest/orgs/{org_id}/settings/opensource/{ecosystem}/broker?version=2026-03-25 HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": {
    "integrations": []
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "/orgs/82b3efbb-4b32-4f96-8005-9444eceacec8/settings/opensource/Dotnet/broker?version=2024-10-15"
  }
}

Enable opensource broker for organization

post

Enables the opensource broker setting for an organization by installing the Snyk App

Required permissions

• Install Apps (org.app.install)

Authorizations

APITokenBearerAuth

AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters

org_idstringRequired

Org ID

Query parameters

versionstringRequired

Requested API version

Example: 2026-03-25Pattern: ^(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))?))$

Body

application/vnd.api+json

dataobjectOptional

Responses

201

Enabled opensource broker successfully

application/vnd.api+json

400

Bad Request: A parameter provided as a part of the request was invalid.

application/vnd.api+json

401

Unauthorized: the request requires an authentication token.

application/vnd.api+json

403

Forbidden: the request requires an authentication token with more or different permissions.

application/vnd.api+json

404

Not Found: The resource being operated on could not be found.

application/vnd.api+json

500

Internal Server Error: An error was encountered while attempting to process the request.

application/vnd.api+json

post

/orgs/{org_id}/settings/opensource/broker

HTTPcURLJavaScriptPython

POST /rest/orgs/{org_id}/settings/opensource/broker?version=2026-03-25 HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 11

{
  "data": {}
}

{
  "data": {
    "status": "success"
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {}
}

Get opensource broker setting for organization

get

Returns whether the opensource broker setting is enabled for the organization

Required permissions

• View Organization (org.read)

Authorizations

APITokenBearerAuth

AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters

org_idstringRequired

Org ID

Query parameters

versionstringRequired

Requested API version

Example: 2026-03-25Pattern: ^(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))?))$

Responses

200

Successfully retrieved opensource broker setting

application/vnd.api+json

400

Bad Request: A parameter provided as a part of the request was invalid.

application/vnd.api+json

401

Unauthorized: the request requires an authentication token.

application/vnd.api+json

403

Forbidden: the request requires an authentication token with more or different permissions.

application/vnd.api+json

404

Not Found: The resource being operated on could not be found.

application/vnd.api+json

500

Internal Server Error: An error was encountered while attempting to process the request.

application/vnd.api+json

get

/orgs/{org_id}/settings/opensource/broker

HTTPcURLJavaScriptPython

GET /rest/orgs/{org_id}/settings/opensource/broker?version=2026-03-25 HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": {
    "enabled": true
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "https://example.com/api/this_resource"
  }
}

Delete opensource broker setting for organization

delete

Deletes the opensource broker setting for the organization by uninstalling the Snyk App

Required permissions

• Install Apps (org.app.install)

Authorizations

APITokenBearerAuth

AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters

org_idstringRequired

Org ID

Query parameters

versionstringRequired

Requested API version

Example: 2026-03-25Pattern: ^(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))?))$

Responses

204

Successfully deleted opensource broker setting

400

Bad Request: A parameter provided as a part of the request was invalid.

application/vnd.api+json

401

Unauthorized: the request requires an authentication token.

application/vnd.api+json

403

Forbidden: the request requires an authentication token with more or different permissions.

application/vnd.api+json

404

Not Found: The resource being operated on could not be found.

application/vnd.api+json

500

Internal Server Error: An error was encountered while attempting to process the request.

application/vnd.api+json

delete

/orgs/{org_id}/settings/opensource/broker

HTTPcURLJavaScriptPython

DELETE /rest/orgs/{org_id}/settings/opensource/broker?version=2026-03-25 HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*

No content

Enable opensource broker for group

post

Enables the opensource broker setting for a group by installing the Snyk App

Required permissions

• Install Apps (group.app.install)

Authorizations

APITokenBearerAuth

AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters

group_idstringRequired

Group ID

Query parameters

versionstringRequired

Requested API version

Example: 2026-03-25Pattern: ^(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))?))$

Body

application/vnd.api+json

dataobjectOptional

Responses

201

Enabled opensource broker successfully

application/vnd.api+json

400

Bad Request: A parameter provided as a part of the request was invalid.

application/vnd.api+json

401

Unauthorized: the request requires an authentication token.

application/vnd.api+json

403

Forbidden: the request requires an authentication token with more or different permissions.

application/vnd.api+json

404

Not Found: The resource being operated on could not be found.

application/vnd.api+json

500

Internal Server Error: An error was encountered while attempting to process the request.

application/vnd.api+json

post

/groups/{group_id}/settings/opensource/broker

HTTPcURLJavaScriptPython

POST /rest/groups/{group_id}/settings/opensource/broker?version=2026-03-25 HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 11

{
  "data": {}
}

{
  "data": {
    "status": "success"
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {}
}

Get opensource broker setting for group

get

Returns whether the opensource broker setting is enabled for the group

Required permissions

• View Groups (group.read)

Authorizations

APITokenBearerAuth

AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters

group_idstringRequired

Group ID

Query parameters

versionstringRequired

Requested API version

Example: 2026-03-25Pattern: ^(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))?))$

Responses

200

Successfully retrieved opensource broker setting

application/vnd.api+json

400

Bad Request: A parameter provided as a part of the request was invalid.

application/vnd.api+json

401

Unauthorized: the request requires an authentication token.

application/vnd.api+json

403

Forbidden: the request requires an authentication token with more or different permissions.

application/vnd.api+json

404

Not Found: The resource being operated on could not be found.

application/vnd.api+json

500

Internal Server Error: An error was encountered while attempting to process the request.

application/vnd.api+json

get

/groups/{group_id}/settings/opensource/broker

HTTPcURLJavaScriptPython

GET /rest/groups/{group_id}/settings/opensource/broker?version=2026-03-25 HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": {
    "enabled": true
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "https://example.com/api/this_resource"
  }
}

Delete opensource broker setting for group

delete

Deletes the opensource broker setting for the group by uninstalling the Snyk App

Required permissions

• Install Apps (group.app.install)

Authorizations

APITokenBearerAuth

AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters

group_idstringRequired

Group ID

Query parameters

versionstringRequired

Requested API version

Example: 2026-03-25Pattern: ^(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))?))$

Responses

204

Successfully deleted opensource broker setting

400

Bad Request: A parameter provided as a part of the request was invalid.

application/vnd.api+json

401

Unauthorized: the request requires an authentication token.

application/vnd.api+json

403

Forbidden: the request requires an authentication token with more or different permissions.

application/vnd.api+json

404

Not Found: The resource being operated on could not be found.

application/vnd.api+json

500

Internal Server Error: An error was encountered while attempting to process the request.

application/vnd.api+json

delete

/groups/{group_id}/settings/opensource/broker

HTTPcURLJavaScriptPython

DELETE /rest/groups/{group_id}/settings/opensource/broker?version=2026-03-25 HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*

No content