1
0
mirror of https://github.com/docker/docs.git synced 2026-10-23 18:09:02 +03:00
Files
docs/content/reference/api/hub/deprecated.md
David Karlsson 9b1f7de05f docs: unify Hub, DVP, and Registry API references (#26048)
@netlify /reference/api/

[Preview the API
reference](https://deploy-preview-26048--docsdocker.netlify.app/reference/api/)

Adds a shared API reference experience for Hub, DVP, and Registry: a
catalog, operation navigation, linked schemas, request and response
examples, and matching HTML and Markdown output. A validation and
generation pipeline prepares the reference data for Hugo and runs as
part of Docker and Netlify builds.

Migrates the three specifications to OpenAPI 3.2, correcting response
shapes, nullable fields, and authentication and token examples. The Hub
migration also corrects SCIM contracts and CSV exports; DVP gains
complete report response schemas and examples. Registry keeps its
documented Hub-specific subset, with authentication and media
negotiation expressed through OpenAPI security and content fields.

Validation is strict for both checks and generation, with no exception
baseline or bypass flag. The build uses the migrated sources directly,
without migration scripts or records.

Page and specification URLs remain stable, including the DVP alias.
Operation and schema anchors change. Engine and Governance retain their
existing references.

Validated locally with Go tests, strict validation of all three
specifications (zero diagnostics), scoped formatting and lint, and a
full Hugo build checking all 176 HTML/Markdown page pairs, example
parity, reference links, and byte-identical published specifications. A
browser check confirmed raw CSV rendering and the generated request
header. No live API requests were made.
2026-09-17 16:56:32 +02:00

4.8 KiB

description, keywords, title, linkTitle, weight, aliases
description keywords title linkTitle weight aliases
Deprecated Docker Hub API endpoints deprecated Deprecated Docker Hub API endpoints Deprecated 3
/docker-hub/api/deprecated/

This page provides an overview of endpoints that are deprecated in Docker Hub API.

Endpoint deprecation policy

As changes are made to Docker there may be times when existing endpoints need to be removed or replaced with newer endpoints. Before an existing endpoint is removed it is labeled as "deprecated" within the documentation. After some time it may be removed.

Deprecated endpoints

The following table provides an overview of the current status of deprecated endpoints:

Deprecated: the endpoint is marked "deprecated" and should no longer be used.

The endpoint may be removed, disabled, or change behavior in a future release.

Removed: the endpoint was removed, disabled, or hidden.


Status Feature Date
Deprecated Deprecate undocumented create/get repository 2025-09-19
Deprecated Deprecate /v2/repositories/{namespace} 2025-06-27
Create deprecation log table 2025-06-27
Removed Docker Hub API v1 deprecation 2022-08-23

Deprecate legacy CreateRepository and GetRepository

Deprecate undocumented endpoints :

  • POST /v2/repositories and POST /v2/repositories/{namespace} replaced by Create repository.
  • GET /v2/repositories/{namespace}/{repository} replaced by Get repository.
  • HEAD /v2/repositories/{namespace}/{repository} replaced by Check repository.

Deprecate legacy ListNamespaceRepositories

Deprecate undocumented endpoint GET /v2/repositories/{namespace} replaced by List repositories.


Create deprecation log table

Reformat page


Docker Hub API v1 deprecation

Docker Hub API v1 has been deprecated. Use Docker Hub API v2 instead.

The following API routes within the v1 path will no longer work and will return a 410 status code:

  • /v1/repositories/{name}/images
  • /v1/repositories/{name}/tags
  • /v1/repositories/{name}/tags/{tag_name}
  • /v1/repositories/{namespace}/{name}/images
  • /v1/repositories/{namespace}/{name}/tags
  • /v1/repositories/{namespace}/{name}/tags/{tag_name}

If you want to continue using the Docker Hub API in your current applications, update your clients to use v2 endpoints.

OLD NEW
/v1/repositories/{name}/tags /v2/namespaces/{namespace}/repositories/{repository}/tags
/v1/repositories/{namespace}/{name}/tags /v2/namespaces/{namespace}/repositories/{repository}/tags
/v1/repositories/{namespace}/{name}/tags /v2/namespaces/{namespace}/repositories/{repository}/tags/{tag}
/v1/repositories/{namespace}/{name}/tags/{tag_name} /v2/namespaces/{namespace}/repositories/{repository}/tags/{tag}