{"openapi":"3.1.0","info":{"title":"Snyk Settings (BYOK) API","version":"0.1.0","description":"Snyk Settings (BYOK) lets an AI assistant read your own Snyk Settings data through the Snyk Settings API with a key you supply (personal access token or service account token). Read-only: 12 tools (list_groups, get_group, list_group_orgs, list_tenants, get_iac_settings, get_sast_settings, get_secrets_settings, get_open_source_settings, list_collections, get_collection, list_container_images,...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-snyk-settings.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-snyk-settings/docs"},"termsOfService":"https://connectorbay.com/byok-snyk-settings/terms"},"servers":[{"url":"https://byok-snyk-settings.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-snyk-settings/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/list_groups":{"post":{"operationId":"list_groups","summary":"List the Snyk groups (collections of organizations) the token can access with their name. Early Access endpoint. Use for","description":"List the Snyk groups (collections of organizations) the token can access with their name. Early Access endpoint. Use for \"Which Snyk groups can I access\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"version":{"anyOf":[{"const":"2026-03-25","type":"string"},{"type":"null"}],"default":"2026-03-25","description":"Snyk REST API version; only 2026-03-25 is supported here.","title":"Version"},"limit":{"anyOf":[{"maximum":100,"minimum":10,"type":"integer"},{"type":"null"}],"default":10,"description":"How many results to return: a multiple of 10 from 10 to 100.","title":"Limit"},"starting_after":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Paging cursor: the starting_after value inside links.next of the previous answer. Leave out for the first page.","title":"Starting After"}},"title":"list_groupsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_group":{"post":{"operationId":"get_group","summary":"Get one Snyk group: name, slug, creation and update times and the tenant it belongs to. Early Access endpoint. Use for \"","description":"Get one Snyk group: name, slug, creation and update times and the tenant it belongs to. Early Access endpoint. Use for \"Show my Snyk group\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"group_id":{"description":"Snyk group id (UUID), as returned by list_groups.","maxLength":60,"title":"Group Id","type":"string"},"version":{"anyOf":[{"const":"2026-03-25","type":"string"},{"type":"null"}],"default":"2026-03-25","description":"Snyk REST API version; only 2026-03-25 is supported here.","title":"Version"}},"required":["group_id"],"title":"get_groupArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_group_orgs":{"post":{"operationId":"list_group_orgs","summary":"List the organizations inside a Snyk group with name, slug, personal flag and dates; the total count is in meta. Use for","description":"List the organizations inside a Snyk group with name, slug, personal flag and dates; the total count is in meta. Use for \"Which organizations are in my Snyk group\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"group_id":{"description":"Snyk group id (UUID), as returned by list_groups.","maxLength":60,"title":"Group Id","type":"string"},"version":{"anyOf":[{"const":"2026-03-25","type":"string"},{"type":"null"}],"default":"2026-03-25","description":"Snyk REST API version; only 2026-03-25 is supported here.","title":"Version"},"limit":{"anyOf":[{"maximum":100,"minimum":10,"type":"integer"},{"type":"null"}],"default":10,"description":"How many results to return: a multiple of 10 from 10 to 100.","title":"Limit"},"starting_after":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Paging cursor: the starting_after value inside links.next of the previous answer. Leave out for the first page.","title":"Starting After"},"name":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only organizations whose name contains this text (case insensitive).","title":"Name"},"slug":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only the organization with exactly this slug.","title":"Slug"}},"required":["group_id"],"title":"list_group_orgsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_tenants":{"post":{"operationId":"list_tenants","summary":"List the Snyk tenants the token can access with name, slug and dates. Early Access endpoint. Use for \"Which Snyk tenant ","description":"List the Snyk tenants the token can access with name, slug and dates. Early Access endpoint. Use for \"Which Snyk tenant am I in\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"version":{"anyOf":[{"const":"2026-03-25","type":"string"},{"type":"null"}],"default":"2026-03-25","description":"Snyk REST API version; only 2026-03-25 is supported here.","title":"Version"},"limit":{"anyOf":[{"maximum":100,"minimum":10,"type":"integer"},{"type":"null"}],"default":10,"description":"How many results to return: a multiple of 10 from 10 to 100.","title":"Limit"},"starting_after":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Paging cursor: the starting_after value inside links.next of the previous answer. Leave out for the first page.","title":"Starting After"},"name":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only tenants whose name contains this text.","title":"Name"}},"title":"list_tenantsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_iac_settings":{"post":{"operationId":"get_iac_settings","summary":"Get an organization's Infrastructure as Code settings, mainly whether custom rules are enabled and from which OCI regist","description":"Get an organization's Infrastructure as Code settings, mainly whether custom rules are enabled and from which OCI registry and tag they load. Use for \"Are custom IaC rules enabled for my Snyk organization\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"org_id":{"description":"Snyk organization id (UUID), as returned by list_organizations in the Snyk connector.","maxLength":60,"title":"Org Id","type":"string"},"version":{"anyOf":[{"const":"2026-03-25","type":"string"},{"type":"null"}],"default":"2026-03-25","description":"Snyk REST API version; only 2026-03-25 is supported here.","title":"Version"}},"required":["org_id"],"title":"get_iac_settingsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_sast_settings":{"post":{"operationId":"get_sast_settings","summary":"Get an organization's Snyk Code settings: whether code analysis and autofix are enabled. Use for \"Is Snyk Code enabled f","description":"Get an organization's Snyk Code settings: whether code analysis and autofix are enabled. Use for \"Is Snyk Code enabled for my organization\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"org_id":{"description":"Snyk organization id (UUID), as returned by list_organizations in the Snyk connector.","maxLength":60,"title":"Org Id","type":"string"},"version":{"anyOf":[{"const":"2026-03-25","type":"string"},{"type":"null"}],"default":"2026-03-25","description":"Snyk REST API version; only 2026-03-25 is supported here.","title":"Version"}},"required":["org_id"],"title":"get_sast_settingsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_secrets_settings":{"post":{"operationId":"get_secrets_settings","summary":"Get an organization's secrets scanning setting: whether it is enabled. Early Access endpoint. Use for \"Is Snyk secrets s","description":"Get an organization's secrets scanning setting: whether it is enabled. Early Access endpoint. Use for \"Is Snyk secrets scanning enabled for my organization\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"org_id":{"description":"Snyk organization id (UUID), as returned by list_organizations in the Snyk connector.","maxLength":60,"title":"Org Id","type":"string"},"version":{"anyOf":[{"const":"2026-03-25","type":"string"},{"type":"null"}],"default":"2026-03-25","description":"Snyk REST API version; only 2026-03-25 is supported here.","title":"Version"}},"required":["org_id"],"title":"get_secrets_settingsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_open_source_settings":{"post":{"operationId":"get_open_source_settings","summary":"Get an organization's open source scanning settings: whether reachability analysis is enabled. Early Access endpoint. Us","description":"Get an organization's open source scanning settings: whether reachability analysis is enabled. Early Access endpoint. Use for \"Is reachability analysis enabled for my Snyk organization\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"org_id":{"description":"Snyk organization id (UUID), as returned by list_organizations in the Snyk connector.","maxLength":60,"title":"Org Id","type":"string"},"version":{"anyOf":[{"const":"2026-03-25","type":"string"},{"type":"null"}],"default":"2026-03-25","description":"Snyk REST API version; only 2026-03-25 is supported here.","title":"Version"}},"required":["org_id"],"title":"get_open_source_settingsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_collections":{"post":{"operationId":"list_collections","summary":"List an organization's project collections with name, whether Snyk generated it, issue counts by severity and project co","description":"List an organization's project collections with name, whether Snyk generated it, issue counts by severity and project count. Use for \"Which Snyk project collections do I have and how many critical issues do they hold\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"org_id":{"description":"Snyk organization id (UUID), as returned by list_organizations in the Snyk connector.","maxLength":60,"title":"Org Id","type":"string"},"version":{"anyOf":[{"const":"2026-03-25","type":"string"},{"type":"null"}],"default":"2026-03-25","description":"Snyk REST API version; only 2026-03-25 is supported here.","title":"Version"},"limit":{"anyOf":[{"maximum":100,"minimum":10,"type":"integer"},{"type":"null"}],"default":10,"description":"How many results to return: a multiple of 10 from 10 to 100.","title":"Limit"},"starting_after":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Paging cursor: the starting_after value inside links.next of the previous answer. Leave out for the first page.","title":"Starting After"},"name":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only collections whose name contains this text.","title":"Name"},"sort":{"anyOf":[{"enum":["name","projectsCount","issues"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort by name, projectsCount or issues.","title":"Sort"},"direction":{"anyOf":[{"enum":["ASC","DESC"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort direction.","title":"Direction"},"is_generated":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True for only Snyk-generated collections, false for only manual ones.","title":"Is Generated"}},"required":["org_id"],"title":"list_collectionsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_collection":{"post":{"operationId":"get_collection","summary":"Get one project collection: name and whether Snyk generated it. Use for \"Show Snyk collection c1\".","description":"Get one project collection: name and whether Snyk generated it. Use for \"Show Snyk collection c1\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"org_id":{"description":"Snyk organization id (UUID), as returned by list_organizations in the Snyk connector.","maxLength":60,"title":"Org Id","type":"string"},"collection_id":{"description":"Collection id (UUID), as returned by list_collections.","maxLength":60,"title":"Collection Id","type":"string"},"version":{"anyOf":[{"const":"2026-03-25","type":"string"},{"type":"null"}],"default":"2026-03-25","description":"Snyk REST API version; only 2026-03-25 is supported here.","title":"Version"}},"required":["org_id","collection_id"],"title":"get_collectionArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_container_images":{"post":{"operationId":"list_container_images","summary":"List container image instances known to an organization with registry names, platform and layer digests. Filter by platf","description":"List container image instances known to an organization with registry names, platform and layer digests. Filter by platform or name. Use for \"Which container images does my Snyk organization know about\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"org_id":{"description":"Snyk organization id (UUID), as returned by list_organizations in the Snyk connector.","maxLength":60,"title":"Org Id","type":"string"},"version":{"anyOf":[{"const":"2026-03-25","type":"string"},{"type":"null"}],"default":"2026-03-25","description":"Snyk REST API version; only 2026-03-25 is supported here.","title":"Version"},"limit":{"anyOf":[{"maximum":100,"minimum":10,"type":"integer"},{"type":"null"}],"default":10,"description":"How many results to return: a multiple of 10 from 10 to 100.","title":"Limit"},"starting_after":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Paging cursor: the starting_after value inside links.next of the previous answer. Leave out for the first page.","title":"Starting After"},"platform":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only images for this platform, for example linux/amd64 or linux/arm64.","title":"Platform"},"names":{"anyOf":[{"maxLength":300,"type":"string"},{"type":"null"}],"default":null,"description":"Comma-separated container registry image names to match.","title":"Names"}},"required":["org_id"],"title":"list_container_imagesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_custom_base_images":{"post":{"operationId":"list_custom_base_images","summary":"List custom base images registered for recommendations, with repository, tag and whether they are recommended. Filter by","description":"List custom base images registered for recommendations, with repository, tag and whether they are recommended. Filter by org, group, repository or tag. Use for \"Which custom base images does my Snyk group recommend\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"version":{"anyOf":[{"const":"2026-03-25","type":"string"},{"type":"null"}],"default":"2026-03-25","description":"Snyk REST API version; only 2026-03-25 is supported here.","title":"Version"},"limit":{"anyOf":[{"maximum":100,"minimum":10,"type":"integer"},{"type":"null"}],"default":10,"description":"How many results to return: a multiple of 10 from 10 to 100.","title":"Limit"},"starting_after":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Paging cursor: the starting_after value inside links.next of the previous answer. Leave out for the first page.","title":"Starting After"},"org_id":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Only images of this organization id.","title":"Org Id"},"group_id":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Only images of this group id.","title":"Group Id"},"repository":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only this image repository.","title":"Repository"},"tag":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only this image tag.","title":"Tag"},"include_in_recommendations":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True for only images used in recommendations.","title":"Include In Recommendations"}},"title":"list_custom_base_imagesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}