Skip to content

Commit 2bc5728

Browse files
committed
Clarify deprecated API endpoints
1 parent 11f970e commit 2bc5728

File tree

1 file changed

+17
-12
lines changed

1 file changed

+17
-12
lines changed

content/reference/api/hub/deprecated.md

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,26 +6,31 @@ weight: 3
66
aliases:
77
- /docker-hub/api/deprecated/
88
---
9-
109
> **Deprecated**
11-
>
12-
> Docker Hub API v1 has been deprecated. Please use Docker Hub API v2 instead.
10+
11+
Docker Hub API v1 has been deprecated. Please use [Docker Hub API v2](reference/api/hub/latest.md) instead.
12+
13+
## Deprecated Routes
1314

1415
The following API routes within the v1 path will no longer work and will return a 410 status code:
16+
1517
* `/v1/repositories/{name}/images`
1618
* `/v1/repositories/{name}/tags`
1719
* `/v1/repositories/{name}/tags/{tag_name}`
1820
* `/v1/repositories/{namespace}/{name}/images`
1921
* `/v1/repositories/{namespace}/{name}/tags`
2022
* `/v1/repositories/{namespace}/{name}/tags/{tag_name}`
2123

22-
If you want to continue using the Docker Hub API in your current applications, update your clients to use v2 endpoints.
24+
### Images
25+
26+
Accessing images by repository is no longer possible through the Docker Hub API. but this functionality is [available through the Docker CLI](reference/cli/docker/image/ls/#list-images-by-name-and-tag).
27+
28+
### Tags
29+
30+
To continue using the Docker Hub API for tags, update your clients to use these v2 endpoints:
2331

24-
| **OLD** | **NEW** |
25-
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
26-
| [/v1/repositories/{name}/images](https://github.com/moby/moby/blob/v1.3.0/docs/sources/reference/api/docker-io_api.md#list-user-repository-images) | [/v2/namespaces/{namespace}/repositories/{repository}/images](/reference/api/hub/latest.md#tag/images/operation/GetNamespacesRepositoriesImages) |
27-
| [/v1/repositories/{namespace}/{name}/images](https://github.com/moby/moby/blob/v1.3.0/docs/sources/reference/api/docker-io_api.md#list-user-repository-images) | [/v2/namespaces/{namespace}/repositories/{repository}/images](/reference/api/hub/latest.md#tag/images/operation/GetNamespacesRepositoriesImages) |
28-
| [/v1/repositories/{name}/tags](https://github.com/moby/moby/blob/v1.8.3/docs/reference/api/registry_api.md#list-repository-tags) | [/v2/namespaces/{namespace}/repositories/{repository}/tags](/reference/api/hub/latest.md#tag/repositories/paths/~1v2~1namespaces~1%7Bnamespace%7D~1repositories~1%7Brepository%7D~1tags/get) |
29-
| [/v1/repositories/{namespace}/{name}/tags](https://github.com/moby/moby/blob/v1.8.3/docs/reference/api/registry_api.md#list-repository-tags) | [/v2/namespaces/{namespace}/repositories/{repository}/tags](/reference/api/hub/latest.md#tag/repositories/paths/~1v2~1namespaces~1%7Bnamespace%7D~1repositories~1%7Brepository%7D~1tags/get) |
30-
| [/v1/repositories/{namespace}/{name}/tags](https://github.com/moby/moby/blob/v1.8.3/docs/reference/api/registry_api.md#get-image-id-for-a-particular-tag) | [/v2/namespaces/{namespace}/repositories/{repository}/tags/{tag}](/reference/api/hub/latest.md#tag/repositories/paths/~1v2~1namespaces~1%7Bnamespace%7D~1repositories~1%7Brepository%7D~1tags~1%7Btag%7D/get) |
31-
| [/v1/repositories/{namespace}/{name}/tags/{tag_name}](https://github.com/moby/moby/blob/v1.8.3/docs/reference/api/registry_api.md#get-image-id-for-a-particular-tag) | [/v2/namespaces/{namespace}/repositories/{repository}/tags/{tag}](/reference/api/hub/latest.md#tag/repositories/paths/~1v2~1namespaces~1%7Bnamespace%7D~1repositories~1%7Brepository%7D~1tags~1%7Btag%7D/get) |
32+
| v1 (deprecated) | v2 |
33+
| --- | --- |
34+
| [/v1/repositories/{name}/tags](https://github.com/moby/moby/blob/v1.8.3/docs/reference/api/registry_api.md#list-repository-tags) | [/v2/namespaces/{namespace}/repositories/{repository}/tags](https://github.com/docker/docs/blob/main/reference/api/hub/latest.md#tag/repositories/paths/~1v2~1namespaces~1%7Bnamespace%7D~1repositories~1%7Brepository%7D~1tags/get) |
35+
| [/v1/repositories/{namespace}/{name}/tags](https://github.com/moby/moby/blob/v1.8.3/docs/reference/api/registry_api.md#list-repository-tags) | [/v2/namespaces/{namespace}/repositories/{repository}/tags](https://github.com/docker/docs/blob/main/reference/api/hub/latest.md#tag/repositories/paths/~1v2~1namespaces~1%7Bnamespace%7D~1repositories~1%7Brepository%7D~1tags/get) |
36+
| [/v1/repositories/{namespace}/{name}/tags/{tag_name}](https://github.com/moby/moby/blob/v1.8.3/docs/reference/api/registry_api.md#get-image-id-for-a-particular-tag) | [/v2/namespaces/{namespace}/repositories/{repository}/tags/{tag}](https://github.com/docker/docs/blob/main/reference/api/hub/latest.md#tag/repositories/paths/~1v2~1namespaces~1%7Bnamespace%7D~1repositories~1%7Brepository%7D~1tags~1%7Btag%7D/get) |

0 commit comments

Comments
 (0)