API Reference on

Chainguard OpenAPI Specification

Tue, 06 Oct 2020 08:48:23 +0000

Chainguard API v1 Specification

Tue, 06 Oct 2020 08:48:23 +0000

Chainguard API v2 Specification

Tue, 06 Oct 2020 08:48:23 +0000

Chainguard API v2 Tutorial

Mon, 30 Mar 2026 08:49:31 +0000

The Chainguard API v2 is currently in a limited beta release for testing. It introduces cursor-based pagination, server-side ordering, consistent resource patterns, and structured error responses across all endpoints.

This guide walks through the v2 API using real curl commands.

Note: The example output in this guide was captured from a development environment. Your organization’s resource names, UIDs, timestamps, and counts will differ. The response structure and field names are the same across all environments.

Authenticating with the Chainguard SDK

Wed, 04 Jun 2025 08:49:31 +0000

There are several ways for users to interact with the Chainguard platform, with chainctl (Chainguard’s command-line tool) and the Chainguard Console (Chainguard’s web interface) being the two most commonly-used methods. However, both of these require a human user to authenticate, and aren’t useful for working with Chainguard resources programmatically.

The Chainguard SDK serves to ease programmatic integration with the Chainguard platform. This guide highlights two examples from the SDK repository that show how to authenticate to the Chainguard registry using the chainguard.dev/sdk/auth and chainguard.dev/sdk/auth/ggcr packages. The first has you authenticate as a local user, while the second has you authenticate as an assumed identity.