Snyk

Snyk Custom Base Images API

The Custom Base Images API from Snyk — 2 operation(s) for custom base images.

Documentation GitHub OpenAPI

Operations 5

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /custom_base_images List custom base images · Get a custom base image collection #

Ask an LLM

“Which custom base images are registered for my org or group?”

“Can I filter custom base images by repository and tag?”

Tell an agent

List custom base images for org {org_id}.

Show custom base images in group {group_id} for repository {repository}.

POST /custom_base_images Mark a container project as a custom base image · Create a Custom Base Image from an existing container project #

Ask an LLM

“How do I register my own base image so Snyk recommends upgrades to it?”

“Do I have to import the image into Snyk before marking it as a custom base image?”

Tell an agent

Mark imported container project {project} as a custom base image.

Register our golden image project as a custom base image for recommendations.

DELETE /custom_base_images/{custombaseimage_id} Delete a custom base image · Delete a custom base image #

Ask an LLM

“How do I stop treating an image as a custom base image?”

“Does deleting a custom base image also delete its container project?”

Tell an agent destructive · confirm first

Delete custom base image {custombaseimage_id}.

Unregister {custombaseimage_id} as a custom base image, keeping its project.

GET /custom_base_images/{custombaseimage_id} Get a custom base image · Get a custom base image #

Ask an LLM

“Where can I see one custom base image's settings?”

“Can I fetch a custom base image by ID?”

Tell an agent

Get custom base image {custombaseimage_id}.

Show the details of custom base image {custombaseimage_id}.

PATCH /custom_base_images/{custombaseimage_id} Update a custom base image · Update a custom base image #

Ask an LLM

“How do I exclude a custom base image from recommendations?”

“Can I change a custom base image's attributes after registering it?”

Tell an agent

Update custom base image {custombaseimage_id}.

Stop recommending custom base image {custombaseimage_id} as an upgrade target.

Documentation

https://apidocs.snyk.io/?version=2024-10-15

https://apidocs.snyk.io/?version=2024-10-15#tag/Orgs

https://apidocs.snyk.io/?version=2024-10-15#tag/Projects

https://apidocs.snyk.io/?version=2024-10-15#tag/Issues

https://apidocs.snyk.io/?version=2024-10-15#tag/Targets

https://apidocs.snyk.io/?version=2024-10-15#tag/Integrations

https://apidocs.snyk.io/?version=2024-10-15#tag/Audit-Logs

https://apidocs.snyk.io/?version=2024-10-15#tag/SBOM

https://apidocs.snyk.io/?version=2024-10-15#tag/Container-Images

https://apidocs.snyk.io/?version=2024-10-15#tag/Custom-Base-Images

https://apidocs.snyk.io/?version=2024-10-15#tag/Webhooks

https://apidocs.snyk.io/?version=2024-10-15#tag/Issues-Export

Specifications

https://raw.githubusercontent.com/api-evangelist/snyk/refs/heads/main/openapi/snyk-custom-base-images-api-openapi.yml

Schemas & Data

https://raw.githubusercontent.com/api-evangelist/snyk/refs/heads/main/json-schema/snyk-custom-base-image-patch-request-schema.json

https://raw.githubusercontent.com/api-evangelist/snyk/refs/heads/main/json-schema/snyk-custom-base-image-collection-response-schema.json

https://raw.githubusercontent.com/api-evangelist/snyk/refs/heads/main/json-schema/snyk-custom-base-image-post-request-schema.json

https://raw.githubusercontent.com/api-evangelist/snyk/refs/heads/main/json-schema/snyk-custom-base-image-response-schema.json

Other Resources

https://raw.githubusercontent.com/api-evangelist/snyk/refs/heads/main/overlays/snyk-custom-base-images-api-overlay.yaml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/snyk:snyk-custom-base-images-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Snyk Custom Base Images API
  version: REST
servers:
- description: Snyk REST API
  url: https://api.snyk.io/rest
security:
- APIToken: []
- BearerAuth: []
tags:


# --- truncated at 32 KB (34 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/snyk/refs/heads/main/openapi/snyk-custom-base-images-api-openapi.yml