Search
Search
Chainguard Academy
Ask AI
Product Docs
Chainguard Containers
Overview
Network Requirements
About
Build Criteria
Shared Responsibility Model
Going Distroless
How We Test
Container Variants
Product Release Lifecycle
Container Categories
Compiled Programs
Selecting a Container
glibc vs. musl
Video: Low-to-No CVEs
Package Name Mappings
Can Anybody Build Containers
Video: Beyond Zero
Catalog Pricing
Catalog Starter
Features
Custom Assembly
Overview
FAQs
Manage in the Console
Manage with chainctl
Manage with GitOps
Manage with Chainguard's API
Custom Certificates
Packages
Package Repositories
Private APK Repositories
EOL Grace Period
STIGs
Requesting Resources
Tag History API
CVE Visualizations
Custom Certs with incert
Unique Tags
How to Use
Using Chainguard Containers
Using the Chainguard Console
Using Chainguard Notifications
Using the Chainguard Directory
Using Chainguard Helm Charts
Using Chainguard iamguarded Helm Charts
Proxy and Cache Helm Charts
Using With OpenShift
Retrieve SBOMs
Verifying Containers
Dev Containers
Using Init Containers
Using the Static Base Container
Digests
Reproducible Dockerfiles
Software Versions
Minimal Runtime Containers
Getting Started Guides
C/C++
Cilium
Go
Istio
Laravel
MariaDB
NeMo
nginx
Node
PHP
PostgreSQL
Python
PyTorch
MinIO
Ruby
WordPress
JRE + Minecraft
Registry
Registry Overview
Authenticate
Pull Through Guides
Google Artifact Registry
Amazon ECR
Artifactory
Harbor
Nexus
Cloudsmith
Staying Secure
Minimize CVE Risk
FedRAMP Considerations
Video: Reproducibility
Updating Containers
Container Update Considerations
EOL Vulnerabilities
Update Strategies and Tools
Using Renovate
Up-to-date Containers with Digestabot
Security Advisories
Using Advisories
Advisory Life Cycle
Managing Advisories
Working with Scanners
False Positives and Negatives
Grype
Trivy
Enforcement
OPA Gatekeeper
Kyverno
Troubleshooting
Debugging
Video: Debugging Distroless Containers
Video: Debugging with Kubectl and CDebug
Tooling
Jib
Ko
Vulnerability Comparisons
bash
busybox
curl
deno
dex
dotnet-runtime
dotnet-sdk
etcd
git
go
gradle
haproxy
jenkins
kube-state-metrics
mariadb
maven
memcached
minio
minio-client
nats
nginx
node
opensearch
php
postgres
python
r-base
rabbitmq
redis
ruby
rust
telegraf
traefik
wait-for-it
wolfi-base
zookeeper
FAQs
Chainguard Libraries
Libraries overview
Access
Network requirements
Verification
CVE remediation
Vulnerability scanners
Browsing
FAQ
Java
Java overview
Global configuration
Build configuration
Management
JavaScript
JavaScript overview
Global configuration
Build configuration
Python
Python overview
Global configuration
Build configuration
Management
Developer workflow
How Chainguard Libraries helps
Chainguard VMs
VMs Overview
Compliance
FAQ
Chainguard OS
Overview
Chainguard OS Packages
FAQs
Chainguard Repository
Overview
API Reference
API Unified Spec
API v1 Spec
API v2 Spec
API v2 Tutorial
Authentication
FIPS
Understanding FIPS
FIPS Containers
Getting Started
FIPS TLS Connectivity Requirements
FIPS and Non-Approved Algorithms
FIPS Verification
Kernel-Independent FIPS
FAQs
Factory
What is the Factory
Overview
FAQs
What the Factory Builds
Factory Tour
Future of the Factory
Inside the Chainguard Factory
Migration
Migration Overview
Migration Tips
Porting a Sample Application
Migrating Dockerfiles
The Guardener
Dockerfile Converter
Migration Checklist
Compatibility
Alpine
Debian
Ubuntu
Red Hat
Migration Guides
PHP
Node
Video: Node.js
Python
.NET
Video: Go
Video: Java
Administration
Terraform Provider
IAM & Organizations
IAM Overview
Manage IAM Organizations
Verified Organizations
Roles and Role-bindings
Roles and Role-bindings Overview
Built-in Roles & Capabilities
GitHub Team Role-binding
Events
Chainguard Events
Subscribe to Events
Mirror Containers to Artifact Registry
Assumable Identities
Assumable IDs Overview
Identity Examples
GitHub Actions
GitLab CI/CD
AWS
AWS (Legacy)
Kubernetes
Buildkite
Bitbucket
Jenkins with chainctl
Jenkins with Terraform
Keycloak
Custom Identity Providers
Authenticate with Custom IDPs
Identity Provider Examples
Okta
Ping Identity
Keycloak
Microsoft Entra ID
chainctl Usage
Install chainctl
Get Started with chainctl
chainctl vs Console
Manage Your chainctl Configuration
Find and Update Your chainctl Release Version
Compare Images with chainctl
Create, View, and Delete chainctl Events
Manage Identity and Access with chainctl
Manage Chainguard Container Images with chainctl
chainctl Reference
chainctl
chainctl auth
chainctl auth configure-docker
chainctl auth delete-account
chainctl auth login
chainctl auth logout
chainctl auth pull-token
chainctl auth pull-token create
chainctl auth pull-token list
chainctl auth status
chainctl auth token
chainctl auth token capabilities
chainctl config
chainctl config edit
chainctl config reset
chainctl config save
chainctl config set
chainctl config unset
chainctl config validate
chainctl config view
chainctl events
chainctl events subscriptions
chainctl events subscriptions create
chainctl events subscriptions delete
chainctl events subscriptions list
chainctl iam
chainctl iam account-associations
chainctl iam account-associations check
chainctl iam account-associations check aws
chainctl iam account-associations check azure
chainctl iam account-associations check gcp
chainctl iam account-associations describe
chainctl iam account-associations set
chainctl iam account-associations set aws
chainctl iam account-associations set azure
chainctl iam account-associations set gcp
chainctl iam account-associations unset
chainctl iam account-associations unset aws
chainctl iam account-associations unset azure
chainctl iam account-associations unset gcp
chainctl iam folders
chainctl iam folders delete
chainctl iam folders describe
chainctl iam folders list
chainctl iam folders update
chainctl iam identities
chainctl iam identities create
chainctl iam identities create aws
chainctl iam identities create aws role
chainctl iam identities create aws user
chainctl iam identities create github
chainctl iam identities create gitlab
chainctl iam identities delete
chainctl iam identities describe
chainctl iam identities list
chainctl iam identities update
chainctl iam identity-providers
chainctl iam identity-providers create
chainctl iam identity-providers delete
chainctl iam identity-providers list
chainctl iam identity-providers update
chainctl iam invites
chainctl iam invites create
chainctl iam invites delete
chainctl iam invites list
chainctl iam organizations
chainctl iam organizations delete
chainctl iam organizations describe
chainctl iam organizations list
chainctl iam role-bindings
chainctl iam role-bindings create
chainctl iam role-bindings delete
chainctl iam role-bindings list
chainctl iam role-bindings update
chainctl iam roles
chainctl iam roles capabilities
chainctl iam roles capabilities list
chainctl iam roles create
chainctl iam roles delete
chainctl iam roles list
chainctl iam roles update
chainctl images
chainctl images advisories
chainctl images advisories list
chainctl images changelog
chainctl images diff
chainctl images entitlements
chainctl images entitlements list
chainctl images helm
chainctl images helm values
chainctl images history
chainctl images list
chainctl images repos
chainctl images repos build
chainctl images repos build apply
chainctl images repos build edit
chainctl images repos build list
chainctl images repos build logs
chainctl images repos create
chainctl images repos delete
chainctl images repos list
chainctl images repos update
chainctl images tags
chainctl images tags list
chainctl images tags resolve
chainctl libraries
chainctl libraries verify
chainctl packages
chainctl packages versions
chainctl packages versions list
chainctl update
chainctl version
Open Source
Octo STS
Overview
FAQ
Renovate Video Tutorial
Build Tools
apko
apko Overview
apko FAQs
Getting Started with apko
Troubleshooting apko Builds
Bazel Rules
melange
melange Overview
Getting Started with melange
Troubleshooting Builds
melange FAQs
SBOMs
What is an SBOM?
OpenVEX and vexctl
What Makes a Good SBOM?
What is OpenVex?
SBOMs and Attestations
Wolfi
Wolfi Overview
Building a Wolfi Package
Wolfi FAQs
Why apk
Hello Wolfi Workshop
Wolfi Images with Dockerfiles
Package Version Selection
Open Container Initiative
What is the OCI?
What are OCI Artifacts?
Sigstore
Keyless Signing
Cosign
Introduction
Install
Sign a Container
Sign Blobs and Files
Sign an SBOM
Verify File Signatures
Cosign: The Manual Way
Policy Controller
Install
Policies
Enforce SBOM attestation with Policy Controller
Disallowing Non-Default Capabilities
Disallowing Privileged Pods
Disallowing Run as Root User
Maximum Container Image Age
Disallowing Unsafe sysctls
Verify Signed Chainguard Containers
Critical CVEs
Rego Policies
Example Policies
Fulcio
Introduction
Generate Fulcio Certificate
Inspect and Verify Certificates
Rekor
Introduction
Install
Query Rekor
Sign and Upload Metadata
Set Up Local Instance
Compliance
PCI DSS 4.0
Introduction to PCI DSS
PCI DSS Practices
PCI DSS at Chainguard
CMMC 2.0
Introduction to CMMC
CMMC Maturity Levels
CMMC 2.0 Practices
CMMC at Chainguard
SLSA 1.1
Introduction to SLSA
SLSA at Chainguard
CIS Benchmarks
Education
Containers
Selecting a Base Image
Software Supply Chain Security
Chainguard Glossary
Build Horizon
Trademark Use Policy
Learning Labs
Attacks and Chainguard Libraries
Safer Container Runtimes
Chainguard OS on Raspberry Pi
Chainguard Libraries for JavaScript
Static Chainguard Container Images
Dockerfile Converter
AI with Hardened Container Images
Chainguard Libraries for Python
Chainguard Libraries for Java
Comics
#1 - Fighting Vulnerabilities
CVEs
What Are Software Vulnerabilities and CVEs?
Why Care About Software Vulnerabilities?
Infamous Software Vulnerabilities
Software Vulnerability Remediation
Secure Software Recommendations
Self-Attestation Form
Table of NIST SSDF
Minimum Attestation References
AI Docs Bundle
Join Our Community Slack
Contact
Chainguard Academy
Ask AI
Product Docs
Chainguard Containers
Overview
Network Requirements
About
Build Criteria
Shared Responsibility Model
Going Distroless
How We Test
Container Variants
Product Release Lifecycle
Container Categories
Compiled Programs
Selecting a Container
glibc vs. musl
Video: Low-to-No CVEs
Package Name Mappings
Can Anybody Build Containers
Video: Beyond Zero
Catalog Pricing
Catalog Starter
Features
Custom Assembly
Overview
FAQs
Manage in the Console
Manage with chainctl
Manage with GitOps
Manage with Chainguard's API
Custom Certificates
Packages
Package Repositories
Private APK Repositories
EOL Grace Period
STIGs
Requesting Resources
Tag History API
CVE Visualizations
Custom Certs with incert
Unique Tags
How to Use
Using Chainguard Containers
Using the Chainguard Console
Using Chainguard Notifications
Using the Chainguard Directory
Using Chainguard Helm Charts
Using Chainguard iamguarded Helm Charts
Proxy and Cache Helm Charts
Using With OpenShift
Retrieve SBOMs
Verifying Containers
Dev Containers
Using Init Containers
Using the Static Base Container
Digests
Reproducible Dockerfiles
Software Versions
Minimal Runtime Containers
Getting Started Guides
C/C++
Cilium
Go
Istio
Laravel
MariaDB
NeMo
nginx
Node
PHP
PostgreSQL
Python
PyTorch
MinIO
Ruby
WordPress
JRE + Minecraft
Registry
Registry Overview
Authenticate
Pull Through Guides
Google Artifact Registry
Amazon ECR
Artifactory
Harbor
Nexus
Cloudsmith
Staying Secure
Minimize CVE Risk
FedRAMP Considerations
Video: Reproducibility
Updating Containers
Container Update Considerations
EOL Vulnerabilities
Update Strategies and Tools
Using Renovate
Up-to-date Containers with Digestabot
Security Advisories
Using Advisories
Advisory Life Cycle
Managing Advisories
Working with Scanners
False Positives and Negatives
Grype
Trivy
Enforcement
OPA Gatekeeper
Kyverno
Troubleshooting
Debugging
Video: Debugging Distroless Containers
Video: Debugging with Kubectl and CDebug
Tooling
Jib
Ko
Vulnerability Comparisons
bash
busybox
curl
deno
dex
dotnet-runtime
dotnet-sdk
etcd
git
go
gradle
haproxy
jenkins
kube-state-metrics
mariadb
maven
memcached
minio
minio-client
nats
nginx
node
opensearch
php
postgres
python
r-base
rabbitmq
redis
ruby
rust
telegraf
traefik
wait-for-it
wolfi-base
zookeeper
FAQs
Chainguard Libraries
Libraries overview
Access
Network requirements
Verification
CVE remediation
Vulnerability scanners
Browsing
FAQ
Java
Java overview
Global configuration
Build configuration
Management
JavaScript
JavaScript overview
Global configuration
Build configuration
Python
Python overview
Global configuration
Build configuration
Management
Developer workflow
How Chainguard Libraries helps
Chainguard VMs
VMs Overview
Compliance
FAQ
Chainguard OS
Overview
Chainguard OS Packages
FAQs
Chainguard Repository
Overview
API Reference
API Unified Spec
API v1 Spec
API v2 Spec
API v2 Tutorial
Authentication
FIPS
Understanding FIPS
FIPS Containers
Getting Started
FIPS TLS Connectivity Requirements
FIPS and Non-Approved Algorithms
FIPS Verification
Kernel-Independent FIPS
FAQs
Factory
What is the Factory
Overview
FAQs
What the Factory Builds
Factory Tour
Future of the Factory
Inside the Chainguard Factory
Migration
Migration Overview
Migration Tips
Porting a Sample Application
Migrating Dockerfiles
The Guardener
Dockerfile Converter
Migration Checklist
Compatibility
Alpine
Debian
Ubuntu
Red Hat
Migration Guides
PHP
Node
Video: Node.js
Python
.NET
Video: Go
Video: Java
Administration
Terraform Provider
IAM & Organizations
IAM Overview
Manage IAM Organizations
Verified Organizations
Roles and Role-bindings
Roles and Role-bindings Overview
Built-in Roles & Capabilities
GitHub Team Role-binding
Events
Chainguard Events
Subscribe to Events
Mirror Containers to Artifact Registry
Assumable Identities
Assumable IDs Overview
Identity Examples
GitHub Actions
GitLab CI/CD
AWS
AWS (Legacy)
Kubernetes
Buildkite
Bitbucket
Jenkins with chainctl
Jenkins with Terraform
Keycloak
Custom Identity Providers
Authenticate with Custom IDPs
Identity Provider Examples
Okta
Ping Identity
Keycloak
Microsoft Entra ID
chainctl Usage
Install chainctl
Get Started with chainctl
chainctl vs Console
Manage Your chainctl Configuration
Find and Update Your chainctl Release Version
Compare Images with chainctl
Create, View, and Delete chainctl Events
Manage Identity and Access with chainctl
Manage Chainguard Container Images with chainctl
chainctl Reference
chainctl
chainctl auth
chainctl auth configure-docker
chainctl auth delete-account
chainctl auth login
chainctl auth logout
chainctl auth pull-token
chainctl auth pull-token create
chainctl auth pull-token list
chainctl auth status
chainctl auth token
chainctl auth token capabilities
chainctl config
chainctl config edit
chainctl config reset
chainctl config save
chainctl config set
chainctl config unset
chainctl config validate
chainctl config view
chainctl events
chainctl events subscriptions
chainctl events subscriptions create
chainctl events subscriptions delete
chainctl events subscriptions list
chainctl iam
chainctl iam account-associations
chainctl iam account-associations check
chainctl iam account-associations check aws
chainctl iam account-associations check azure
chainctl iam account-associations check gcp
chainctl iam account-associations describe
chainctl iam account-associations set
chainctl iam account-associations set aws
chainctl iam account-associations set azure
chainctl iam account-associations set gcp
chainctl iam account-associations unset
chainctl iam account-associations unset aws
chainctl iam account-associations unset azure
chainctl iam account-associations unset gcp
chainctl iam folders
chainctl iam folders delete
chainctl iam folders describe
chainctl iam folders list
chainctl iam folders update
chainctl iam identities
chainctl iam identities create
chainctl iam identities create aws
chainctl iam identities create aws role
chainctl iam identities create aws user
chainctl iam identities create github
chainctl iam identities create gitlab
chainctl iam identities delete
chainctl iam identities describe
chainctl iam identities list
chainctl iam identities update
chainctl iam identity-providers
chainctl iam identity-providers create
chainctl iam identity-providers delete
chainctl iam identity-providers list
chainctl iam identity-providers update
chainctl iam invites
chainctl iam invites create
chainctl iam invites delete
chainctl iam invites list
chainctl iam organizations
chainctl iam organizations delete
chainctl iam organizations describe
chainctl iam organizations list
chainctl iam role-bindings
chainctl iam role-bindings create
chainctl iam role-bindings delete
chainctl iam role-bindings list
chainctl iam role-bindings update
chainctl iam roles
chainctl iam roles capabilities
chainctl iam roles capabilities list
chainctl iam roles create
chainctl iam roles delete
chainctl iam roles list
chainctl iam roles update
chainctl images
chainctl images advisories
chainctl images advisories list
chainctl images changelog
chainctl images diff
chainctl images entitlements
chainctl images entitlements list
chainctl images helm
chainctl images helm values
chainctl images history
chainctl images list
chainctl images repos
chainctl images repos build
chainctl images repos build apply
chainctl images repos build edit
chainctl images repos build list
chainctl images repos build logs
chainctl images repos create
chainctl images repos delete
chainctl images repos list
chainctl images repos update
chainctl images tags
chainctl images tags list
chainctl images tags resolve
chainctl libraries
chainctl libraries verify
chainctl packages
chainctl packages versions
chainctl packages versions list
chainctl update
chainctl version
Open Source
Octo STS
Overview
FAQ
Renovate Video Tutorial
Build Tools
apko
apko Overview
apko FAQs
Getting Started with apko
Troubleshooting apko Builds
Bazel Rules
melange
melange Overview
Getting Started with melange
Troubleshooting Builds
melange FAQs
SBOMs
What is an SBOM?
OpenVEX and vexctl
What Makes a Good SBOM?
What is OpenVex?
SBOMs and Attestations
Wolfi
Wolfi Overview
Building a Wolfi Package
Wolfi FAQs
Why apk
Hello Wolfi Workshop
Wolfi Images with Dockerfiles
Package Version Selection
Open Container Initiative
What is the OCI?
What are OCI Artifacts?
Sigstore
Keyless Signing
Cosign
Introduction
Install
Sign a Container
Sign Blobs and Files
Sign an SBOM
Verify File Signatures
Cosign: The Manual Way
Policy Controller
Install
Policies
Enforce SBOM attestation with Policy Controller
Disallowing Non-Default Capabilities
Disallowing Privileged Pods
Disallowing Run as Root User
Maximum Container Image Age
Disallowing Unsafe sysctls
Verify Signed Chainguard Containers
Critical CVEs
Rego Policies
Example Policies
Fulcio
Introduction
Generate Fulcio Certificate
Inspect and Verify Certificates
Rekor
Introduction
Install
Query Rekor
Sign and Upload Metadata
Set Up Local Instance
Compliance
PCI DSS 4.0
Introduction to PCI DSS
PCI DSS Practices
PCI DSS at Chainguard
CMMC 2.0
Introduction to CMMC
CMMC Maturity Levels
CMMC 2.0 Practices
CMMC at Chainguard
SLSA 1.1
Introduction to SLSA
SLSA at Chainguard
CIS Benchmarks
Education
Containers
Selecting a Base Image
Software Supply Chain Security
Chainguard Glossary
Build Horizon
Trademark Use Policy
Learning Labs
Attacks and Chainguard Libraries
Safer Container Runtimes
Chainguard OS on Raspberry Pi
Chainguard Libraries for JavaScript
Static Chainguard Container Images
Dockerfile Converter
AI with Hardened Container Images
Chainguard Libraries for Python
Chainguard Libraries for Java
Comics
#1 - Fighting Vulnerabilities
CVEs
What Are Software Vulnerabilities and CVEs?
Why Care About Software Vulnerabilities?
Infamous Software Vulnerabilities
Software Vulnerability Remediation
Secure Software Recommendations
Self-Attestation Form
Table of NIST SSDF
Minimum Attestation References
AI Docs Bundle
Join Our Community Slack
Contact
API Reference
Chainguard API v1 Specification
Copy Markdown for LLMs
Page copied!
Was this helpful?
Yes
No
Thanks for the feedback!
Tell us what could be improved:
0
/1000
Submit
Cancel
Last updated: 2026-04-06 08:48
Chainguard OpenAPI Specification
Prev
Chainguard API v2 Specification
Next