diff --git a/.htmltest.yml b/.htmltest.yml index 2af58c68c0fc..e7cb321e1bec 100644 --- a/.htmltest.yml +++ b/.htmltest.yml @@ -7,11 +7,9 @@ IgnoreAltEmpty: true IgnoreEmptyHref: true IgnoreDirectoryMissingTrailingSlash: true IgnoreURLs: -- "^/docker-hub/api/latest/.*$" -- "^/engine/api/v.+/#.*$" -- "^/glossary/.*$" +- "^/reference/api/hub/.*$" +- "^/reference/api/engine/v.+/#.*$" IgnoreDirs: -- "engine/api" - "registry/configuration" - "compose/compose-file" # temporarily ignore until upstream is fixed CacheExpires: "6h" diff --git a/content/desktop/faqs/general.md b/content/desktop/faqs/general.md index fce2a5a39174..33f2d3f60cde 100644 --- a/content/desktop/faqs/general.md +++ b/content/desktop/faqs/general.md @@ -49,7 +49,7 @@ $ export DOCKER_HOST=unix:///var/run/docker.sock Docker Desktop Windows users can connect to the Docker Engine through a **named pipe**: `npipe:////./pipe/docker_engine`, or **TCP socket** at this URL: `tcp://localhost:2375`. -For details, see [Docker Engine API](../../engine/api/index.md). +For details, see [Docker Engine API](/reference/api/engine/_index.md). ### How do I connect from a container to a service on the host? diff --git a/content/docker-hub/_index.md b/content/docker-hub/_index.md index 210300b3e07a..4307e5e2a805 100644 --- a/content/docker-hub/_index.md +++ b/content/docker-hub/_index.md @@ -40,7 +40,7 @@ GitHub and Bitbucket and push them to Docker Hub. * [Webhooks](webhooks.md): Trigger actions after a successful push to a repository to integrate Docker Hub with other services. * [Docker Hub CLI](https://github.com/docker/hub-tool#readme) tool (currently experimental) and an API that allows you to interact with Docker Hub. - * Browse through the [Docker Hub API](/docker-hub/api/latest/) documentation to explore the supported endpoints. + * Browse through the [Docker Hub API](/reference/api/hub/latest/) documentation to explore the supported endpoints. {{< /tab >}} {{< tab name="What administrative tasks can I perform in Docker Hub?" >}} * [Create and manage teams and organizations](orgs.md) diff --git a/content/docker-hub/release-notes.md b/content/docker-hub/release-notes.md index 27b5fd6757f6..1f699aa51ead 100644 --- a/content/docker-hub/release-notes.md +++ b/content/docker-hub/release-notes.md @@ -139,7 +139,7 @@ The updated [Docker Subscription Service Agreement](https://www.docker.com/legal When managing the content of your repositories, you can now filter the results based on the currentness of the tags and more easily identify your untagged images. -For Docker Hub API documentation, see [Docker Hub API Reference](api/latest.md#operation/GetNamespacesRepositoriesImages). +For Docker Hub API documentation, see [Docker Hub API Reference](/reference/api/hub/latest.md#operation/GetNamespacesRepositoriesImages). ## 2021-04-13 diff --git a/content/engine/_index.md b/content/engine/_index.md index b65ebff2514f..e5e9a0218b01 100644 --- a/content/engine/_index.md +++ b/content/engine/_index.md @@ -58,7 +58,7 @@ application with: - A command line interface (CLI) client [`docker`](/reference/cli/docker/). -The CLI uses [Docker APIs](api/index.md) to control or interact with the Docker +The CLI uses [Docker APIs](/reference/api/engine/_index.md) to control or interact with the Docker daemon through scripting or direct CLI commands. Many other Docker applications use the underlying API and CLI. The daemon creates and manages Docker objects, such as images, containers, networks, and volumes. diff --git a/content/engine/api/_index.md b/content/engine/api/_index.md deleted file mode 100644 index 4d47ca3fe0a0..000000000000 --- a/content/engine/api/_index.md +++ /dev/null @@ -1,166 +0,0 @@ ---- -title: Develop with Docker Engine API -description: Learn how you can use Docker Engine API and SDKs in the language of your choice. -keywords: developing, api, Docker Engine API, API versions, SDK versions -aliases: -- /engine/reference/api/ -- /engine/reference/api/docker_remote_api/ -- /reference/api/ -- /reference/api/docker_remote_api/ -- /reference/api/docker_remote_api_v1.0/ -- /reference/api/docker_remote_api_v1.1/ -- /reference/api/docker_remote_api_v1.2/ -- /reference/api/docker_remote_api_v1.3/ -- /reference/api/docker_remote_api_v1.4/ -- /reference/api/docker_remote_api_v1.5/ -- /reference/api/docker_remote_api_v1.6/ -- /reference/api/docker_remote_api_v1.7/ -- /reference/api/docker_remote_api_v1.8/ -- /reference/api/docker_remote_api_v1.9/ -- /reference/api/docker_remote_api_v1.10/ -- /reference/api/docker_remote_api_v1.11/ -- /reference/api/docker_remote_api_v1.12/ -- /reference/api/docker_remote_api_v1.13/ -- /reference/api/docker_remote_api_v1.14/ -- /reference/api/docker_remote_api_v1.15/ -- /reference/api/docker_remote_api_v1.16/ -- /reference/api/docker_remote_api_v1.17/ ---- - -Docker provides an API for interacting with the Docker daemon (called the Docker -Engine API), as well as SDKs for Go and Python. The SDKs allow you to efficiently build and -scale Docker apps and solutions. If Go or Python don't work -for you, you can use the Docker Engine API directly. - -For information about Docker Engine SDKs, see [Develop with Docker Engine SDKs](sdk/index.md). - -The Docker Engine API is a RESTful API accessed by an HTTP client such as `wget` or -`curl`, or the HTTP library which is part of most modern programming languages. - -## View the API reference - -You can -[view the reference for the latest version of the API](latest/index.html) -or [choose a specific version](/engine/api/version-history/). - -## Versioned API and SDK - -The version of the Docker Engine API you should use depends upon the version of -your Docker daemon and Docker client. - -A given version of the Docker Engine SDK supports a specific version of the -Docker Engine API, as well as all earlier versions. If breaking changes occur, -they are documented prominently. - -> [!NOTE] -> -> The Docker daemon and client don't necessarily need to be the same version -> at all times. However, keep the following in mind. -> -> - If the daemon is newer than the client, the client doesn't know about new -> features or deprecated API endpoints in the daemon. -> -> - If the client is newer than the daemon, the client can request API -> endpoints that the daemon doesn't know about. - -A new version of the API is released when new features are added. The Docker API -is backward-compatible, so you don't need to update code that uses the API -unless you need to take advantage of new features. - -To see the highest version of the API your Docker daemon and client support, use -`docker version`: - -```console -$ docker version -Client: Docker Engine - Community - Version: 27.1.2 - API version: 1.46 - Go version: go1.21.13 - Git commit: d01f264 - Built: Mon Aug 12 11:51:13 2024 - OS/Arch: linux/amd64 - Context: default - -Server: Docker Engine - Community - Engine: - Version: 27.1.2 - API version: 1.46 (minimum version 1.24) - Go version: go1.21.13 - Git commit: f9522e5 - Built: Mon Aug 12 11:51:13 2024 - OS/Arch: linux/amd64 - Experimental: false - ... -``` - -You can specify the API version to use in any of the following ways: - -- When using the SDK, use the latest version. At a minimum, use the version - that incorporates the API version with the features you need. -- When using `curl` directly, specify the version as the first part of the URL. - For instance, if the endpoint is `/containers/` you can use - `/v1.46/containers/`. -- To force the Docker CLI or the Docker Engine SDKs to use an older version - of the API than the version reported by `docker version`, set the - environment variable `DOCKER_API_VERSION` to the correct version. This works - on Linux, Windows, or macOS clients. - - ```console - $ DOCKER_API_VERSION='1.44' - ``` - - While the environment variable is set, that version of the API is used, even - if the Docker daemon supports a newer version. This environment variable - disables API version negotiation, so you should only use it if you must - use a specific version of the API, or for debugging purposes. - -- The Docker Go SDK allows you to enable API version negotiation, automatically - selects an API version that's supported by both the client and the Docker Engine - that's in use. -- For the SDKs, you can also specify the API version programmatically as a - parameter to the `client` object. See the - [Go constructor](https://pkg.go.dev/github.com/docker/docker/client#NewClientWithOpts) - or the - [Python SDK documentation for `client`](https://docker-py.readthedocs.io/en/stable/client.html). - -### API version matrix - -| Docker version | Maximum API version | Change log | -|:---------------|:---------------------------|:---------------------------------------------------------| -| 27.1 | [1.46](/engine/api/v1.46/) | [changes](/engine/api/version-history/#v146-api-changes) | -| 27.0 | [1.46](/engine/api/v1.46/) | [changes](/engine/api/version-history/#v146-api-changes) | -| 26.1 | [1.45](/engine/api/v1.45/) | [changes](/engine/api/version-history/#v145-api-changes) | -| 26.0 | [1.45](/engine/api/v1.45/) | [changes](/engine/api/version-history/#v145-api-changes) | -| 25.0 | [1.44](/engine/api/v1.44/) | [changes](/engine/api/version-history/#v144-api-changes) | -| 24.0 | [1.43](/engine/api/v1.43/) | [changes](/engine/api/version-history/#v143-api-changes) | -| 23.0 | [1.42](/engine/api/v1.42/) | [changes](/engine/api/version-history/#v142-api-changes) | -| 20.10 | [1.41](/engine/api/v1.41/) | [changes](/engine/api/version-history/#v141-api-changes) | -| 19.03 | [1.40](/engine/api/v1.40/) | [changes](/engine/api/version-history/#v140-api-changes) | -| 18.09 | [1.39](/engine/api/v1.39/) | [changes](/engine/api/version-history/#v139-api-changes) | -| 18.06 | [1.38](/engine/api/v1.38/) | [changes](/engine/api/version-history/#v138-api-changes) | -| 18.05 | [1.37](/engine/api/v1.37/) | [changes](/engine/api/version-history/#v137-api-changes) | -| 18.04 | [1.37](/engine/api/v1.37/) | [changes](/engine/api/version-history/#v137-api-changes) | -| 18.03 | [1.37](/engine/api/v1.37/) | [changes](/engine/api/version-history/#v137-api-changes) | -| 18.02 | [1.36](/engine/api/v1.36/) | [changes](/engine/api/version-history/#v136-api-changes) | -| 17.12 | [1.35](/engine/api/v1.35/) | [changes](/engine/api/version-history/#v135-api-changes) | -| 17.11 | [1.34](/engine/api/v1.34/) | [changes](/engine/api/version-history/#v134-api-changes) | -| 17.10 | [1.33](/engine/api/v1.33/) | [changes](/engine/api/version-history/#v133-api-changes) | -| 17.09 | [1.32](/engine/api/v1.32/) | [changes](/engine/api/version-history/#v132-api-changes) | -| 17.07 | [1.31](/engine/api/v1.31/) | [changes](/engine/api/version-history/#v131-api-changes) | -| 17.06 | [1.30](/engine/api/v1.30/) | [changes](/engine/api/version-history/#v130-api-changes) | -| 17.05 | [1.29](/engine/api/v1.29/) | [changes](/engine/api/version-history/#v129-api-changes) | -| 17.04 | [1.28](/engine/api/v1.28/) | [changes](/engine/api/version-history/#v128-api-changes) | -| 17.03.1 | [1.27](/engine/api/v1.27/) | [changes](/engine/api/version-history/#v127-api-changes) | -| 17.03 | [1.26](/engine/api/v1.27/) | [changes](/engine/api/version-history/#v126-api-changes) | -| 1.13.1 | [1.26](/engine/api/v1.26/) | [changes](/engine/api/version-history/#v126-api-changes) | -| 1.13 | [1.25](/engine/api/v1.26/) | [changes](/engine/api/version-history/#v125-api-changes) | -| 1.12 | [1.24](/engine/api/v1.24/) | [changes](/engine/api/version-history/#v124-api-changes) | - -### Deprecated API versions - -API versions before v1.24 are [deprecated](/engine/deprecated/#deprecate-legacy-api-versions). -You can find archived documentation for deprecated versions of the API in the -code repository on GitHub: - -- [Documentation for API versions 1.23 and before](https://github.com/moby/moby/tree/v25.0.0/docs/api). -- [Documentation for API versions 1.17 and before](https://github.com/moby/moby/tree/v1.9.1/docs/reference/api). diff --git a/content/engine/api/latest/index.html b/content/engine/api/latest/index.html deleted file mode 100644 index aa527f9c6967..000000000000 --- a/content/engine/api/latest/index.html +++ /dev/null @@ -1,6 +0,0 @@ ---- ---- - - -

Redirecting to the latest version of the Docker Engine API reference. - diff --git a/content/engine/api/v1.25.md b/content/engine/api/v1.25.md deleted file mode 100644 index 20fcf69eeda3..000000000000 --- a/content/engine/api/v1.25.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -layout: engine-api -aliases: -- /engine/reference/api/docker_remote_api_v1.25/ ---- diff --git a/content/engine/api/v1.26.md b/content/engine/api/v1.26.md deleted file mode 100644 index 870987488303..000000000000 --- a/content/engine/api/v1.26.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -layout: engine-api -aliases: -- /engine/reference/api/docker_remote_api_v1.26/ ---- diff --git a/content/engine/api/v1.27.md b/content/engine/api/v1.27.md deleted file mode 100644 index c6465489d6ba..000000000000 --- a/content/engine/api/v1.27.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -layout: engine-api -aliases: -- /engine/reference/api/docker_remote_api_v1.27/ ---- diff --git a/content/engine/api/v1.28.md b/content/engine/api/v1.28.md deleted file mode 100644 index 18a35b452615..000000000000 --- a/content/engine/api/v1.28.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -layout: engine-api -aliases: -- /engine/reference/api/docker_remote_api_v1.28/ ---- diff --git a/content/engine/api/v1.29.md b/content/engine/api/v1.29.md deleted file mode 100644 index 4b058956a86e..000000000000 --- a/content/engine/api/v1.29.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -layout: engine-api ---- diff --git a/content/engine/api/v1.30.md b/content/engine/api/v1.30.md deleted file mode 100644 index 4b058956a86e..000000000000 --- a/content/engine/api/v1.30.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -layout: engine-api ---- diff --git a/content/engine/api/v1.31.md b/content/engine/api/v1.31.md deleted file mode 100644 index 4b058956a86e..000000000000 --- a/content/engine/api/v1.31.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -layout: engine-api ---- diff --git a/content/engine/api/v1.32.md b/content/engine/api/v1.32.md deleted file mode 100644 index 4b058956a86e..000000000000 --- a/content/engine/api/v1.32.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -layout: engine-api ---- diff --git a/content/engine/api/v1.33.md b/content/engine/api/v1.33.md deleted file mode 100644 index 4b058956a86e..000000000000 --- a/content/engine/api/v1.33.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -layout: engine-api ---- diff --git a/content/engine/api/v1.34.md b/content/engine/api/v1.34.md deleted file mode 100644 index 4b058956a86e..000000000000 --- a/content/engine/api/v1.34.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -layout: engine-api ---- diff --git a/content/engine/api/v1.35.md b/content/engine/api/v1.35.md deleted file mode 100644 index 4b058956a86e..000000000000 --- a/content/engine/api/v1.35.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -layout: engine-api ---- diff --git a/content/engine/api/v1.36.md b/content/engine/api/v1.36.md deleted file mode 100644 index 4b058956a86e..000000000000 --- a/content/engine/api/v1.36.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -layout: engine-api ---- diff --git a/content/engine/api/v1.37.md b/content/engine/api/v1.37.md deleted file mode 100644 index 4b058956a86e..000000000000 --- a/content/engine/api/v1.37.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -layout: engine-api ---- diff --git a/content/engine/api/v1.38.md b/content/engine/api/v1.38.md deleted file mode 100644 index 4b058956a86e..000000000000 --- a/content/engine/api/v1.38.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -layout: engine-api ---- diff --git a/content/engine/api/v1.39.md b/content/engine/api/v1.39.md deleted file mode 100644 index 4b058956a86e..000000000000 --- a/content/engine/api/v1.39.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -layout: engine-api ---- diff --git a/content/engine/api/v1.40.md b/content/engine/api/v1.40.md deleted file mode 100644 index 4b058956a86e..000000000000 --- a/content/engine/api/v1.40.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -layout: engine-api ---- diff --git a/content/engine/api/v1.41.md b/content/engine/api/v1.41.md deleted file mode 100644 index 4b058956a86e..000000000000 --- a/content/engine/api/v1.41.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -layout: engine-api ---- diff --git a/content/engine/api/v1.42.md b/content/engine/api/v1.42.md deleted file mode 100644 index 4b058956a86e..000000000000 --- a/content/engine/api/v1.42.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -layout: engine-api ---- diff --git a/content/engine/api/v1.43.md b/content/engine/api/v1.43.md deleted file mode 100644 index 4b058956a86e..000000000000 --- a/content/engine/api/v1.43.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -layout: engine-api ---- diff --git a/content/engine/api/v1.44.md b/content/engine/api/v1.44.md deleted file mode 100644 index 4b058956a86e..000000000000 --- a/content/engine/api/v1.44.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -layout: engine-api ---- diff --git a/content/engine/api/v1.45.md b/content/engine/api/v1.45.md deleted file mode 100644 index 4b058956a86e..000000000000 --- a/content/engine/api/v1.45.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -layout: engine-api ---- diff --git a/content/engine/api/v1.46.md b/content/engine/api/v1.46.md deleted file mode 100644 index 4b058956a86e..000000000000 --- a/content/engine/api/v1.46.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -layout: engine-api ---- diff --git a/content/engine/release-notes/23.0.md b/content/engine/release-notes/23.0.md index 5570393a724a..4c339e84b22f 100644 --- a/content/engine/release-notes/23.0.md +++ b/content/engine/release-notes/23.0.md @@ -28,7 +28,7 @@ This page describes the latest changes, additions, known issues, and fixes for D For more information about: - Deprecated and removed features, see [Deprecated Engine Features](../deprecated.md). -- Changes to the Engine API, see [Engine API version history](../api/version-history.md). +- Changes to the Engine API, see [Engine API version history](/reference/api/engine/version-history.md). Starting with the 23.0.0 release, Docker Engine moves away from using CalVer versioning, and starts using the [SemVer versioning format](https://semver.org/). diff --git a/content/engine/release-notes/24.0.md b/content/engine/release-notes/24.0.md index 32a2b042876b..2dadaa07dda1 100644 --- a/content/engine/release-notes/24.0.md +++ b/content/engine/release-notes/24.0.md @@ -12,7 +12,7 @@ This page describes the latest changes, additions, known issues, and fixes for D For more information about: - Deprecated and removed features, see [Deprecated Engine Features](../deprecated.md). -- Changes to the Engine API, see [Engine API version history](../api/version-history.md). +- Changes to the Engine API, see [Engine API version history](/reference/api/engine/version-history.md). ## 24.0.9 diff --git a/content/engine/release-notes/25.0.md b/content/engine/release-notes/25.0.md index 4dd0d7f80189..1d6a2b8bd16b 100644 --- a/content/engine/release-notes/25.0.md +++ b/content/engine/release-notes/25.0.md @@ -11,7 +11,7 @@ This page describes the latest changes, additions, known issues, and fixes for D For more information about: - Deprecated and removed features, see [Deprecated Engine Features](../deprecated.md). -- Changes to the Engine API, see [Engine API version history](../api/version-history.md). +- Changes to the Engine API, see [Engine API version history](/reference/api/engine/version-history.md). ## 25.0.5 diff --git a/content/engine/release-notes/26.0.md b/content/engine/release-notes/26.0.md index 54c9996fa2ff..94ef33a98308 100644 --- a/content/engine/release-notes/26.0.md +++ b/content/engine/release-notes/26.0.md @@ -11,7 +11,7 @@ This page describes the latest changes, additions, known issues, and fixes for D For more information about: - Deprecated and removed features, see [Deprecated Engine Features](../deprecated.md). -- Changes to the Engine API, see [Engine API version history](../api/version-history.md). +- Changes to the Engine API, see [Engine API version history](/reference/api/engine/version-history.md). ## 26.0.2 diff --git a/content/engine/release-notes/26.1.md b/content/engine/release-notes/26.1.md index 2ce853b515ea..c7f45962b62b 100644 --- a/content/engine/release-notes/26.1.md +++ b/content/engine/release-notes/26.1.md @@ -11,7 +11,7 @@ This page describes the latest changes, additions, known issues, and fixes for D For more information about: - Deprecated and removed features, see [Deprecated Engine Features](../deprecated.md). -- Changes to the Engine API, see [Engine API version history](../api/version-history.md). +- Changes to the Engine API, see [Engine API version history](/reference/api/engine/version-history.md). ## 26.1.4 diff --git a/content/engine/release-notes/27.0.md b/content/engine/release-notes/27.0.md index 39cabba56916..5b648f56451a 100644 --- a/content/engine/release-notes/27.0.md +++ b/content/engine/release-notes/27.0.md @@ -11,7 +11,7 @@ This page describes the latest changes, additions, known issues, and fixes for D For more information about: - Deprecated and removed features, see [Deprecated Engine Features](../deprecated.md). -- Changes to the Engine API, see [Engine API version history](../api/version-history.md). +- Changes to the Engine API, see [Engine API version history](/reference/api/engine/version-history.md). ## 27.0.3 diff --git a/content/engine/release-notes/27.1.md b/content/engine/release-notes/27.1.md index cfd3896928cc..6934a88c64d8 100644 --- a/content/engine/release-notes/27.1.md +++ b/content/engine/release-notes/27.1.md @@ -18,7 +18,7 @@ This page describes the latest changes, additions, known issues, and fixes for D For more information about: - Deprecated and removed features, see [Deprecated Engine Features](../deprecated.md). -- Changes to the Engine API, see [Engine API version history](../api/version-history.md). +- Changes to the Engine API, see [Engine API version history](/reference/api/engine/version-history.md). ## 27.1.2 diff --git a/content/engine/swarm/admin_guide.md b/content/engine/swarm/admin_guide.md index e28b5de003dd..cec2e725c543 100644 --- a/content/engine/swarm/admin_guide.md +++ b/content/engine/swarm/admin_guide.md @@ -154,7 +154,7 @@ worker nodes that do not meet these requirements cannot run these tasks. You can monitor the health of manager nodes by querying the docker `nodes` API in JSON format through the `/nodes` HTTP endpoint. Refer to the -[nodes API documentation](/engine/api/v1.25/#tag/Node) +[nodes API documentation](/reference/api/engine/v1.25/#tag/Node) for more information. From the command line, run `docker node inspect ` to query the nodes. diff --git a/content/engine/swarm/how-swarm-mode-works/nodes.md b/content/engine/swarm/how-swarm-mode-works/nodes.md index 294b7b43f939..c7a90868f03f 100644 --- a/content/engine/swarm/how-swarm-mode-works/nodes.md +++ b/content/engine/swarm/how-swarm-mode-works/nodes.md @@ -26,7 +26,7 @@ Manager nodes handle cluster management tasks: * Maintaining cluster state * Scheduling services -* Serving Swarm mode [HTTP API endpoints](../../api/index.md) +* Serving Swarm mode [HTTP API endpoints](/reference/api/engine/_index.md) Using a [Raft](https://raft.github.io/raft.pdf) implementation, the managers maintain a consistent internal state of the entire swarm and all the services diff --git a/content/engine/swarm/manage-nodes.md b/content/engine/swarm/manage-nodes.md index f8ef32518c54..8b819158beb1 100644 --- a/content/engine/swarm/manage-nodes.md +++ b/content/engine/swarm/manage-nodes.md @@ -203,7 +203,7 @@ a `PluginSpec` instead of a `ContainerSpec`. The [`PluginSpec`](/engine/extend/plugin_api/#json-specification) is defined by the plugin developer. To add the plugin to all Docker nodes, use -the [`service/create`](/engine/api/v1.31/#operation/ServiceCreate) API, passing +the [`service/create`](/reference/api/engine/v1.31/#operation/ServiceCreate) API, passing the `PluginSpec` JSON defined in the `TaskTemplate`. ## Leave the swarm diff --git a/content/reference/_index.md b/content/reference/_index.md index dc8d1d007e8e..27dc69549ab3 100644 --- a/content/reference/_index.md +++ b/content/reference/_index.md @@ -29,7 +29,7 @@ grid_apis: - title: Engine API description: The main API for Docker, provides programmatic access to a daemon. icon: api - link: /engine/api/ + link: /reference/api/engine/ - title: Registry API description: Facilitates distribution of images to the engine. icon: storage @@ -37,11 +37,11 @@ grid_apis: - title: Docker Hub API description: API to interact with Docker Hub. icon: communities - link: /docker-hub/api/latest/ + link: /reference/api/hub/latest/ - title: DVP Data API description: API for Docker Verified Publishers to fetch analytics data. icon: area_chart - link: /docker-hub/api/dvp/ + link: /reference/api/hub/dvp/ --- This section includes the reference documentation for the Docker platform's diff --git a/content/reference/api/engine/_index.md b/content/reference/api/engine/_index.md new file mode 100644 index 000000000000..812ad084f0cd --- /dev/null +++ b/content/reference/api/engine/_index.md @@ -0,0 +1,166 @@ +--- +title: Develop with Docker Engine API +description: Learn how you can use Docker Engine API and SDKs in the language of your choice. +keywords: developing, api, Docker Engine API, API versions, SDK versions +aliases: + - /reference/api/docker_remote_api/ + - /reference/api/docker_remote_api_v1.0/ + - /reference/api/docker_remote_api_v1.1/ + - /reference/api/docker_remote_api_v1.2/ + - /reference/api/docker_remote_api_v1.3/ + - /reference/api/docker_remote_api_v1.4/ + - /reference/api/docker_remote_api_v1.5/ + - /reference/api/docker_remote_api_v1.6/ + - /reference/api/docker_remote_api_v1.7/ + - /reference/api/docker_remote_api_v1.8/ + - /reference/api/docker_remote_api_v1.9/ + - /reference/api/docker_remote_api_v1.10/ + - /reference/api/docker_remote_api_v1.11/ + - /reference/api/docker_remote_api_v1.12/ + - /reference/api/docker_remote_api_v1.13/ + - /reference/api/docker_remote_api_v1.14/ + - /reference/api/docker_remote_api_v1.15/ + - /reference/api/docker_remote_api_v1.16/ + - /reference/api/docker_remote_api_v1.17/ + - /engine/reference/api/ + - /engine/reference/api/docker_remote_api/ + - /engine/api/ +--- + +Docker provides an API for interacting with the Docker daemon (called the Docker +Engine API), as well as SDKs for Go and Python. The SDKs allow you to efficiently build and +scale Docker apps and solutions. If Go or Python don't work +for you, you can use the Docker Engine API directly. + +For information about Docker Engine SDKs, see [Develop with Docker Engine SDKs](sdk/index.md). + +The Docker Engine API is a RESTful API accessed by an HTTP client such as `wget` or +`curl`, or the HTTP library which is part of most modern programming languages. + +## View the API reference + +You can +[view the reference for the latest version of the API](latest/index.html) +or [choose a specific version](/reference/api/engine/version-history/). + +## Versioned API and SDK + +The version of the Docker Engine API you should use depends upon the version of +your Docker daemon and Docker client. + +A given version of the Docker Engine SDK supports a specific version of the +Docker Engine API, as well as all earlier versions. If breaking changes occur, +they are documented prominently. + +> [!NOTE] +> +> The Docker daemon and client don't necessarily need to be the same version +> at all times. However, keep the following in mind. +> +> - If the daemon is newer than the client, the client doesn't know about new +> features or deprecated API endpoints in the daemon. +> +> - If the client is newer than the daemon, the client can request API +> endpoints that the daemon doesn't know about. + +A new version of the API is released when new features are added. The Docker API +is backward-compatible, so you don't need to update code that uses the API +unless you need to take advantage of new features. + +To see the highest version of the API your Docker daemon and client support, use +`docker version`: + +```console +$ docker version +Client: Docker Engine - Community + Version: 27.1.2 + API version: 1.46 + Go version: go1.21.13 + Git commit: d01f264 + Built: Mon Aug 12 11:51:13 2024 + OS/Arch: linux/amd64 + Context: default + +Server: Docker Engine - Community + Engine: + Version: 27.1.2 + API version: 1.46 (minimum version 1.24) + Go version: go1.21.13 + Git commit: f9522e5 + Built: Mon Aug 12 11:51:13 2024 + OS/Arch: linux/amd64 + Experimental: false + ... +``` + +You can specify the API version to use in any of the following ways: + +- When using the SDK, use the latest version. At a minimum, use the version + that incorporates the API version with the features you need. +- When using `curl` directly, specify the version as the first part of the URL. + For instance, if the endpoint is `/containers/` you can use + `/v1.46/containers/`. +- To force the Docker CLI or the Docker Engine SDKs to use an older version + of the API than the version reported by `docker version`, set the + environment variable `DOCKER_API_VERSION` to the correct version. This works + on Linux, Windows, or macOS clients. + + ```console + $ DOCKER_API_VERSION='1.44' + ``` + + While the environment variable is set, that version of the API is used, even + if the Docker daemon supports a newer version. This environment variable + disables API version negotiation, so you should only use it if you must + use a specific version of the API, or for debugging purposes. + +- The Docker Go SDK allows you to enable API version negotiation, automatically + selects an API version that's supported by both the client and the Docker Engine + that's in use. +- For the SDKs, you can also specify the API version programmatically as a + parameter to the `client` object. See the + [Go constructor](https://pkg.go.dev/github.com/docker/docker/client#NewClientWithOpts) + or the + [Python SDK documentation for `client`](https://docker-py.readthedocs.io/en/stable/client.html). + +### API version matrix + +| Docker version | Maximum API version | Change log | +|:---------------|:---------------------------|:-----------------------------------------------------------------------------| +| 27.1 | [1.46](/reference/api/engine/v1.46/) | [changes](/reference/api/engine/version-history/#v146-api-changes) | +| 27.0 | [1.46](/reference/api/engine/v1.46/) | [changes](/reference/api/engine/version-history/#v146-api-changes) | +| 26.1 | [1.45](/reference/api/engine/v1.45/) | [changes](/reference/api/engine/version-history/#v145-api-changes) | +| 26.0 | [1.45](/reference/api/engine/v1.45/) | [changes](/reference/api/engine/version-history/#v145-api-changes) | +| 25.0 | [1.44](/reference/api/engine/v1.44/) | [changes](/reference/api/engine/version-history/#v144-api-changes) | +| 24.0 | [1.43](/reference/api/engine/v1.43/) | [changes](/reference/api/engine/version-history/#v143-api-changes) | +| 23.0 | [1.42](/reference/api/engine/v1.42/) | [changes](/reference/api/engine/version-history/#v142-api-changes) | +| 20.10 | [1.41](/reference/api/engine/v1.41/) | [changes](/reference/api/engine/version-history/#v141-api-changes) | +| 19.03 | [1.40](/reference/api/engine/v1.40/) | [changes](/reference/api/engine/version-history/#v140-api-changes) | +| 18.09 | [1.39](/reference/api/engine/v1.39/) | [changes](/reference/api/engine/version-history/#v139-api-changes) | +| 18.06 | [1.38](/reference/api/engine/v1.38/) | [changes](/reference/api/engine/version-history/#v138-api-changes) | +| 18.05 | [1.37](/reference/api/engine/v1.37/) | [changes](/reference/api/engine/version-history/#v137-api-changes) | +| 18.04 | [1.37](/reference/api/engine/v1.37/) | [changes](/reference/api/engine/version-history/#v137-api-changes) | +| 18.03 | [1.37](/reference/api/engine/v1.37/) | [changes](/reference/api/engine/version-history/#v137-api-changes) | +| 18.02 | [1.36](/reference/api/engine/v1.36/) | [changes](/reference/api/engine/version-history/#v136-api-changes) | +| 17.12 | [1.35](/reference/api/engine/v1.35/) | [changes](/reference/api/engine/version-history/#v135-api-changes) | +| 17.11 | [1.34](/reference/api/engine/v1.34/) | [changes](/reference/api/engine/version-history/#v134-api-changes) | +| 17.10 | [1.33](/reference/api/engine/v1.33/) | [changes](/reference/api/engine/version-history/#v133-api-changes) | +| 17.09 | [1.32](/reference/api/engine/v1.32/) | [changes](/reference/api/engine/version-history/#v132-api-changes) | +| 17.07 | [1.31](/reference/api/engine/v1.31/) | [changes](/reference/api/engine/version-history/#v131-api-changes) | +| 17.06 | [1.30](/reference/api/engine/v1.30/) | [changes](/reference/api/engine/version-history/#v130-api-changes) | +| 17.05 | [1.29](/reference/api/engine/v1.29/) | [changes](/reference/api/engine/version-history/#v129-api-changes) | +| 17.04 | [1.28](/reference/api/engine/v1.28/) | [changes](/reference/api/engine/version-history/#v128-api-changes) | +| 17.03.1 | [1.27](/reference/api/engine/v1.27/) | [changes](/reference/api/engine/version-history/#v127-api-changes) | +| 17.03 | [1.26](/reference/api/engine/v1.27/) | [changes](/reference/api/engine/version-history/#v126-api-changes) | +| 1.13.1 | [1.26](/reference/api/engine/v1.26/) | [changes](/reference/api/engine/version-history/#v126-api-changes) | +| 1.13 | [1.25](/reference/api/engine/v1.26/) | [changes](/reference/api/engine/version-history/#v125-api-changes) | +| 1.12 | [1.24](/reference/api/engine/v1.24/) | [changes](/reference/api/engine/version-history/#v124-api-changes) | + +### Deprecated API versions + +API versions before v1.24 are [deprecated](/engine/deprecated/#deprecate-legacy-api-versions). +You can find archived documentation for deprecated versions of the API in the +code repository on GitHub: + +- [Documentation for API versions 1.23 and before](https://github.com/moby/moby/tree/v25.0.0/docs/api). +- [Documentation for API versions 1.17 and before](https://github.com/moby/moby/tree/v1.9.1/docs/reference/api). diff --git a/content/reference/api/engine/latest/index.html b/content/reference/api/engine/latest/index.html new file mode 100644 index 000000000000..497ebfefc5a3 --- /dev/null +++ b/content/reference/api/engine/latest/index.html @@ -0,0 +1,6 @@ +--- +--- + + +

Redirecting to the latest version of the Docker Engine API reference. + diff --git a/content/engine/api/sdk/_index.md b/content/reference/api/engine/sdk/_index.md similarity index 95% rename from content/engine/api/sdk/_index.md rename to content/reference/api/engine/sdk/_index.md index 9828c25378d6..bfa83bc0a278 100644 --- a/content/engine/api/sdk/_index.md +++ b/content/reference/api/engine/sdk/_index.md @@ -3,8 +3,9 @@ title: Develop with Docker Engine SDKs description: Learn how to use Docker Engine SDKs to automate Docker tasks in your language of choice keywords: developing, sdk, Docker Engine SDKs, install SDKs, SDK versions aliases: -- /engine/api/sdks/ -- /develop/sdk/ + - /develop/sdk/ + - /engine/api/sdks/ + - /engine/api/sdk/ --- Docker provides an API for interacting with the Docker daemon (called the Docker @@ -46,13 +47,13 @@ For more information, see [Docker Engine Python SDK reference](https://docker-py ## View the API reference You can -[view the reference for the latest version of the API](/engine/api/latest/) -or [choose a specific version](/engine/api/version-history/). +[view the reference for the latest version of the API](/reference/api/engine/latest/) +or [choose a specific version](/reference/api/engine/version-history/). ## Versioned API and SDK The version of the Docker Engine API you should use depends on the version of -your Docker daemon and Docker client. See the [versioned API and SDK](/engine/api/#versioned-api-and-sdk) +your Docker daemon and Docker client. See the [versioned API and SDK](/reference/api/engine/#versioned-api-and-sdk) section in the API documentation for details. ## SDK and API quickstart @@ -60,7 +61,7 @@ section in the API documentation for details. Use the following guidelines to choose the SDK or API version to use in your code: -- If you're starting a new project, use the [latest version](/engine/api/latest/), +- If you're starting a new project, use the [latest version](/reference/api/engine/latest/), but use API version negotiation or specify the version you are using. This helps prevent surprises. - If you need a new feature, update your code to use at least the minimum version diff --git a/content/engine/api/sdk/examples.md b/content/reference/api/engine/sdk/examples.md similarity index 98% rename from content/engine/api/sdk/examples.md rename to content/reference/api/engine/sdk/examples.md index 76f802c9125c..e62782396ee3 100644 --- a/content/engine/api/sdk/examples.md +++ b/content/reference/api/engine/sdk/examples.md @@ -4,11 +4,12 @@ description: Examples on how to perform a given Docker operation using the Go an Python SDKs and the HTTP API using curl. keywords: developing, api, sdk, developers, rest, curl, python, go aliases: -- /engine/api/getting-started/ -- /engine/api/client-libraries/ -- /engine/reference/api/remote_api_client_libraries/ -- /reference/api/remote_api_client_libraries/ -- /develop/sdk/examples/ + - /engine/api/getting-started/ + - /engine/api/client-libraries/ + - /engine/reference/api/remote_api_client_libraries/ + - /reference/api/remote_api_client_libraries/ + - /develop/sdk/examples/ + - /engine/api/sdk/examples/ --- After you @@ -607,7 +608,7 @@ func main() { {{< tab name="Python" >}} The Python SDK retrieves authentication information from the [credentials -store](/reference/cli/docker/login/#credentials-store) file and +store](/reference/cli/docker/login/#credential-stores) file and integrates with [credential helpers](https://github.com/docker/docker-credential-helpers). It's possible to override these credentials, but that's out of scope for this example guide. After using `docker login`, the Python SDK diff --git a/content/reference/api/engine/v1.25.md b/content/reference/api/engine/v1.25.md new file mode 100644 index 000000000000..672286468a87 --- /dev/null +++ b/content/reference/api/engine/v1.25.md @@ -0,0 +1,5 @@ +--- +layout: engine-api +aliases: +- /engine/api/v1.25/ +--- diff --git a/content/reference/api/engine/v1.26.md b/content/reference/api/engine/v1.26.md new file mode 100644 index 000000000000..393b97341c6c --- /dev/null +++ b/content/reference/api/engine/v1.26.md @@ -0,0 +1,5 @@ +--- +layout: engine-api +aliases: +- /engine/api/v1.26/ +--- diff --git a/content/reference/api/engine/v1.27.md b/content/reference/api/engine/v1.27.md new file mode 100644 index 000000000000..1c5196888c7c --- /dev/null +++ b/content/reference/api/engine/v1.27.md @@ -0,0 +1,5 @@ +--- +layout: engine-api +aliases: +- /engine/api/v1.27/ +--- diff --git a/content/reference/api/engine/v1.28.md b/content/reference/api/engine/v1.28.md new file mode 100644 index 000000000000..808c3e007b17 --- /dev/null +++ b/content/reference/api/engine/v1.28.md @@ -0,0 +1,5 @@ +--- +layout: engine-api +aliases: +- /engine/api/v1.28/ +--- diff --git a/content/reference/api/engine/v1.29.md b/content/reference/api/engine/v1.29.md new file mode 100644 index 000000000000..c1ba7de56ece --- /dev/null +++ b/content/reference/api/engine/v1.29.md @@ -0,0 +1,5 @@ +--- +layout: engine-api +aliases: + - /engine/api/v1.29/ +--- diff --git a/content/reference/api/engine/v1.30.md b/content/reference/api/engine/v1.30.md new file mode 100644 index 000000000000..8a7ed3f018ab --- /dev/null +++ b/content/reference/api/engine/v1.30.md @@ -0,0 +1,5 @@ +--- +layout: engine-api +aliases: + - /engine/api/v1.30/ +--- diff --git a/content/reference/api/engine/v1.31.md b/content/reference/api/engine/v1.31.md new file mode 100644 index 000000000000..54dd7e1cf07b --- /dev/null +++ b/content/reference/api/engine/v1.31.md @@ -0,0 +1,5 @@ +--- +layout: engine-api +aliases: + - /engine/api/v1.31/ +--- diff --git a/content/reference/api/engine/v1.32.md b/content/reference/api/engine/v1.32.md new file mode 100644 index 000000000000..6bde83d91437 --- /dev/null +++ b/content/reference/api/engine/v1.32.md @@ -0,0 +1,5 @@ +--- +layout: engine-api +aliases: + - /engine/api/v1.32/ +--- diff --git a/content/reference/api/engine/v1.33.md b/content/reference/api/engine/v1.33.md new file mode 100644 index 000000000000..a112ca94c597 --- /dev/null +++ b/content/reference/api/engine/v1.33.md @@ -0,0 +1,5 @@ +--- +layout: engine-api +aliases: + - /engine/api/v1.33/ +--- diff --git a/content/reference/api/engine/v1.34.md b/content/reference/api/engine/v1.34.md new file mode 100644 index 000000000000..80fa86dee45e --- /dev/null +++ b/content/reference/api/engine/v1.34.md @@ -0,0 +1,5 @@ +--- +layout: engine-api +aliases: + - /engine/api/v1.34/ +--- diff --git a/content/reference/api/engine/v1.35.md b/content/reference/api/engine/v1.35.md new file mode 100644 index 000000000000..3cb20d1a23e5 --- /dev/null +++ b/content/reference/api/engine/v1.35.md @@ -0,0 +1,5 @@ +--- +layout: engine-api +aliases: + - /engine/api/v1.35/ +--- diff --git a/content/reference/api/engine/v1.36.md b/content/reference/api/engine/v1.36.md new file mode 100644 index 000000000000..f5f0aa074acc --- /dev/null +++ b/content/reference/api/engine/v1.36.md @@ -0,0 +1,5 @@ +--- +layout: engine-api +aliases: + - /engine/api/v1.36/ +--- diff --git a/content/reference/api/engine/v1.37.md b/content/reference/api/engine/v1.37.md new file mode 100644 index 000000000000..5f886a6989c5 --- /dev/null +++ b/content/reference/api/engine/v1.37.md @@ -0,0 +1,5 @@ +--- +layout: engine-api +aliases: + - /engine/api/v1.37/ +--- diff --git a/content/reference/api/engine/v1.38.md b/content/reference/api/engine/v1.38.md new file mode 100644 index 000000000000..d63b33271063 --- /dev/null +++ b/content/reference/api/engine/v1.38.md @@ -0,0 +1,5 @@ +--- +layout: engine-api +aliases: + - /engine/api/v1.38/ +--- diff --git a/content/reference/api/engine/v1.39.md b/content/reference/api/engine/v1.39.md new file mode 100644 index 000000000000..92100eeaeed3 --- /dev/null +++ b/content/reference/api/engine/v1.39.md @@ -0,0 +1,5 @@ +--- +layout: engine-api +aliases: + - /engine/api/v1.39/ +--- diff --git a/content/reference/api/engine/v1.40.md b/content/reference/api/engine/v1.40.md new file mode 100644 index 000000000000..b29d668dc2ce --- /dev/null +++ b/content/reference/api/engine/v1.40.md @@ -0,0 +1,5 @@ +--- +layout: engine-api +aliases: + - /engine/api/v1.40/ +--- diff --git a/content/reference/api/engine/v1.41.md b/content/reference/api/engine/v1.41.md new file mode 100644 index 000000000000..a08e1a4263cb --- /dev/null +++ b/content/reference/api/engine/v1.41.md @@ -0,0 +1,5 @@ +--- +layout: engine-api +aliases: + - /engine/api/v1.41/ +--- diff --git a/content/reference/api/engine/v1.42.md b/content/reference/api/engine/v1.42.md new file mode 100644 index 000000000000..81a12d0a72af --- /dev/null +++ b/content/reference/api/engine/v1.42.md @@ -0,0 +1,5 @@ +--- +layout: engine-api +aliases: + - /engine/api/v1.42/ +--- diff --git a/content/reference/api/engine/v1.43.md b/content/reference/api/engine/v1.43.md new file mode 100644 index 000000000000..d03bb2f04072 --- /dev/null +++ b/content/reference/api/engine/v1.43.md @@ -0,0 +1,5 @@ +--- +layout: engine-api +aliases: + - /engine/api/v1.43/ +--- diff --git a/content/reference/api/engine/v1.44.md b/content/reference/api/engine/v1.44.md new file mode 100644 index 000000000000..67a7e8398d16 --- /dev/null +++ b/content/reference/api/engine/v1.44.md @@ -0,0 +1,5 @@ +--- +layout: engine-api +aliases: + - /engine/api/v1.44/ +--- diff --git a/content/reference/api/engine/v1.45.md b/content/reference/api/engine/v1.45.md new file mode 100644 index 000000000000..10581b8dfb80 --- /dev/null +++ b/content/reference/api/engine/v1.45.md @@ -0,0 +1,5 @@ +--- +layout: engine-api +aliases: + - /engine/api/v1.45/ +--- diff --git a/content/reference/api/engine/v1.46.md b/content/reference/api/engine/v1.46.md new file mode 100644 index 000000000000..53cf04be7063 --- /dev/null +++ b/content/reference/api/engine/v1.46.md @@ -0,0 +1,5 @@ +--- +layout: engine-api +aliases: + - /engine/api/v1.46/ +--- diff --git a/content/docker-hub/api/deprecated.md b/content/reference/api/hub/deprecated.md similarity index 66% rename from content/docker-hub/api/deprecated.md rename to content/reference/api/hub/deprecated.md index 26cde3fe7969..97adcf67ae08 100644 --- a/content/docker-hub/api/deprecated.md +++ b/content/reference/api/hub/deprecated.md @@ -2,6 +2,8 @@ description: Docker Hub API v1 (deprecated) keywords: kitematic, deprecated title: Docker Hub API v1 (deprecated) +aliases: + - /docker-hub/api/deprecated/ --- > **Deprecated** @@ -18,11 +20,11 @@ The following API routes within the v1 path will no longer work and will return 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}/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](../../docker-hub/api/latest.md#tag/images/operation/GetNamespacesRepositoriesImages) | -| [/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](../../docker-hub/api/latest.md#tag/images/operation/GetNamespacesRepositoriesImages) | -| [/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](../../docker-hub/api/latest.md#tag/repositories/paths/~1v2~1namespaces~1%7Bnamespace%7D~1repositories~1%7Brepository%7D~1tags/get) | -| [/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](../../docker-hub/api/latest.md#tag/repositories/paths/~1v2~1namespaces~1%7Bnamespace%7D~1repositories~1%7Brepository%7D~1tags/get) | -| [/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}](../../docker-hub/api/latest.md#tag/repositories/paths/~1v2~1namespaces~1%7Bnamespace%7D~1repositories~1%7Brepository%7D~1tags~1%7Btag%7D/get) | -| [/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}](../../docker-hub/api/latest.md#tag/repositories/paths/~1v2~1namespaces~1%7Bnamespace%7D~1repositories~1%7Brepository%7D~1tags~1%7Btag%7D/get) | +| **OLD** | **NEW** | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [/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) | +| [/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) | +| [/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) | +| [/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) | +| [/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) | +| [/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) | diff --git a/content/docker-hub/api/dvp.md b/content/reference/api/hub/dvp.md similarity index 100% rename from content/docker-hub/api/dvp.md rename to content/reference/api/hub/dvp.md diff --git a/content/docker-hub/api/dvp.yaml b/content/reference/api/hub/dvp.yaml similarity index 99% rename from content/docker-hub/api/dvp.yaml rename to content/reference/api/hub/dvp.yaml index e30353aded6d..3b9becb0418b 100644 --- a/content/docker-hub/api/dvp.yaml +++ b/content/reference/api/hub/dvp.yaml @@ -690,5 +690,5 @@ components: description: | JWT Bearer Authentication is required to access the Docker DVP Data API. - This authentication documentation is duplicated from the [Hub API Authentication docs](https://docs.docker.com/docker-hub/api/latest/#tag/authentication) + This authentication documentation is duplicated from the [Hub API Authentication docs](https://docs.docker.com/reference/api/hub/#tag/authentication) x-displayName: Docker Hub Authentication diff --git a/content/docker-hub/api/latest.md b/content/reference/api/hub/latest.md similarity index 100% rename from content/docker-hub/api/latest.md rename to content/reference/api/hub/latest.md diff --git a/content/docker-hub/api/latest.yaml b/content/reference/api/hub/latest.yaml similarity index 100% rename from content/docker-hub/api/latest.yaml rename to content/reference/api/hub/latest.yaml diff --git a/content/glossary.md b/content/reference/glossary.md similarity index 93% rename from content/glossary.md rename to content/reference/glossary.md index 5b51b274c8a4..5f26de459e81 100644 --- a/content/glossary.md +++ b/content/reference/glossary.md @@ -6,7 +6,7 @@ layout: glossary notoc: true aliases: - /engine/reference/glossary/ -- /reference/glossary/ +- /glossary/ --- {{ partialCached "favicon.html" "favicon" }} - +