The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: https://docker.com/{version} https://hub.docker.com https://hub.docker.com/api/publisher/analytics/v1
auth: b e a r
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API use
| method | path | what the vendor says it does |
|---|---|---|
GET | /_ping | Ping This is a dummy endpoint you can use to test if the server is accessible. System |
POST | /auth | Check auth configuration Validate credentials for a registry and, if available, get an identity token for acce |
POST | /build | Build an image Build an image from a tar archive with a `Dockerfile` in it. The `Dockerfile` specifies how th |
POST | /build/prune | Delete builder cache Image |
POST | /commit | Create a new image from a container Image |
GET | /configs | List configs Config |
POST | /configs/create | Create a config Config |
GET | /configs/{id} | Inspect a config Config |
DELETE | /configs/{id} | Delete a config Config |
POST | /configs/{id}/update | Update a Config Config |
POST | /containers/create | Create a container Container |
GET | /containers/json | List containers Returns a list of containers. For details on the format, see [the inspect endpoint](#operation |
POST | /containers/prune | Delete stopped containers Container |
DELETE | /containers/{id} | Remove a container Container |
GET | /containers/{id}/archive | Get an archive of a filesystem resource in a container Get a tar archive of a resource in the filesystem of co |
PUT | /containers/{id}/archive | Extract an archive of files or folders to a directory in a container Upload a tar archive to be extracted to a |
POST | /containers/{id}/attach | Attach to a container Attach to a container to read its output or send it input. You can attach to the same co |
GET | /containers/{id}/attach/ws | Attach to a container via a websocket Container |
GET | /containers/{id}/changes | Get changes on a container’s filesystem Returns which files in a container's filesystem have been added, delet |
POST | /containers/{id}/exec | Create an exec instance Run a command inside a running container. Exec |
GET | /containers/{id}/export | Export a container Export the contents of a container as a tarball. Container |
GET | /containers/{id}/json | Inspect a container Return low-level information about a container. Container |
POST | /containers/{id}/kill | Kill a container Send a POSIX signal to a container, defaulting to killing to the container. Container |
GET | /containers/{id}/logs | Get container logs Get `stdout` and `stderr` logs from a container. Note: This endpoint works only for contai |
POST | /containers/{id}/pause | Pause a container Use the cgroups freezer to suspend all processes in a container. Traditionally, when suspen |
POST | /containers/{id}/rename | Rename a container Container |
POST | /containers/{id}/resize | Resize a container TTY Resize the TTY for a container. You must restart the container for the resize to take e |
POST | /containers/{id}/restart | Restart a container Container |
POST | /containers/{id}/start | Start a container Container |
GET | /containers/{id}/stats | Get container stats based on resource usage This endpoint returns a live stream of a container’s resource usag |
POST | /containers/{id}/stop | Stop a container Container |
GET | /containers/{id}/top | List processes running inside a container On Unix systems, this is done by running the `ps` command. This endp |
POST | /containers/{id}/unpause | Unpause a container Resume a container which has been paused. Container |
POST | /containers/{id}/update | Update a container Change various configuration options of a container without having to recreate it. Containe |
POST | /containers/{id}/wait | Wait for a container Block until a container stops, then returns the exit code. Container |
GET | /distribution/{name}/json | Get image information from the registry Return image digest and platform information by contacting the registr |
GET | /events | Monitor events Stream real-time events from the server. Various objects within Docker report events when some |
GET | /exec/{id}/json | Inspect an exec instance Return low-level information about an exec instance. Exec |
POST | /exec/{id}/resize | Resize an exec instance Resize the TTY session used by an exec instance. This endpoint only works if `tty` was |
POST | /exec/{id}/start | Start an exec instance Starts a previously set up exec instance. If detach is true, this endpoint returns imme |
and 64 more operation(s) in this specification, all searchable.
specification origin: https://raw.githubusercontent.com/docker/go-docker/master/api/swagger.yaml
Docker Hub is a service provided by Docker for finding and sharing container images with your team. It is the world's largest library and community for container images. In addition to the [Docker Hub UI](https://docs.docker.com/docker-hub/) and [Docker Hub CLI tool](https://github.com/docker/hub-tool#readme) (currently experimental), Docker provides an API that allows you to interact with Dock
| method | path | what the vendor says it does |
|---|---|---|
GET | /v2/access-tokens | Get a list of personal access tokens Returns a paginated list of personal access tokens. access-tokens |
POST | /v2/access-tokens | Create a personal access token Creates and returns a personal access token. access-tokens |
GET | /v2/access-tokens/{uuid} | Get a personal access token Returns a personal access token by UUID. access-tokens |
PATCH | /v2/access-tokens/{uuid} | Update a personal access token Updates a personal access token partially. You can either update the token's la |
DELETE | /v2/access-tokens/{uuid} | Delete a personal access token Deletes a personal access token permanently. This cannot be undone. access-toke |
GET | /v2/auditlogs/{account} | Returns list of audit log events. Get audit log events for a given namespace. audit-logs |
GET | /v2/auditlogs/{account}/actions | Returns list of audit log actions. Get audit log actions for a namespace to be used as a filter for querying a |
POST | /v2/namespaces/{namespace}/delete-images | Delete images Deletes one or more images within a namespace. This is currently limited to a single repository |
GET | /v2/namespaces/{namespace}/repositories/{repository}/images | Get details of repository's images Gets details on the images in a repository. images |
GET | /v2/namespaces/{namespace}/repositories/{repository}/images-summary | Get summary of repository's images Gets the number of images in a repository and the number of images counted |
GET | /v2/namespaces/{namespace}/repositories/{repository}/images/{digest}/tags | Get image's tags Gets current and historical tags for an image. images |
GET | /v2/namespaces/{namespace}/repositories/{repository}/tags | List repository tags repositories |
GET | /v2/namespaces/{namespace}/repositories/{repository}/tags/{tag} | Read repository tag repositories |
GET | /v2/orgs/{name}/settings | Get organization settings Returns organization settings by name. org-settings |
PUT | /v2/orgs/{name}/settings | Update organization settings Updates an organization's settings. Some settings are only used when the organiza |
GET | /v2/scim/2.0/ResourceTypes | List resource types Returns all resource types supported for the SCIM configuration. scim |
GET | /v2/scim/2.0/ResourceTypes/{name} | Get a resource type Returns a resource type by name. scim |
GET | /v2/scim/2.0/Schemas | List schemas Returns all schemas supported for the SCIM configuration. scim |
GET | /v2/scim/2.0/Schemas/{id} | Get a schema Returns a schema by ID. scim |
GET | /v2/scim/2.0/ServiceProviderConfig | Get service provider config Returns a service provider config for Docker's configuration. scim |
GET | /v2/scim/2.0/Users | List users List users, returns paginated users for an organization. Use `startIndex` and `count` query paramet |
POST | /v2/scim/2.0/Users | Create user Creates a user. If the user already exists by email, they are assigned to the organization on the |
GET | /v2/scim/2.0/Users/{id} | Get a user Returns a user by ID. scim |
PUT | /v2/scim/2.0/Users/{id} | Update a user Updates a user. Use this route to change the user's name, activate, and deactivate the user. sci |
POST | /v2/users/2fa-login | Second factor authentication. When user has 2FA enabled, this is the second call to perform after `/v2/users/l |
POST | /v2/users/login | Create an authentication token Creates and returns a bearer token in JWT format that you can use to authentica |
specification origin: https://raw.githubusercontent.com/docker/docs/main/docker-hub/api/latest.yaml
The Docker DVP Data API allows [Docker Verified Publishers](https://docs.docker.com/docker-hub/publish/) to view image pull analytics data for their namespaces. Analytics data can be retrieved as raw data, or in a summary format. #### Summary data In your summary data CSV, you will have access to the data points listed below. You can request summary data for a complete week (Monday through Sun
| method | path | what the vendor says it does |
|---|---|---|
GET | / | Get namespaces and repos Gets a list of your namespaces and repos which have data available discovery |
GET | /namespaces/{namespace} | Get namespace Gets metadata associated with specified namespace, including extra repos associated with the nam |
GET | /namespaces/{namespace}/pulls/exports/years | Get years with data Gets a list of years that have data for the given namespace namespaces |
GET | /namespaces/{namespace}/pulls/exports/years/{year}/{timespantype} | Get timespans with data Gets a list of timespans of the given type that have data for the given namespace and |
GET | /namespaces/{namespace}/pulls/exports/years/{year}/{timespantype}/{timespan} | Get namespace metadata for timespan Gets info about data for the given namespace and timespan namespaces |
GET | /namespaces/{namespace}/pulls/exports/years/{year}/{timespantype}/{timespan}/{dataview} | Get namespace data for timespan Gets a list of URLs that can be used to download the pull data for the given n |
POST | /v2/users/2fa-login | Second factor authentication. When a user has 2FA enabled, this is the second call to perform after `/v2/users |
POST | /v2/users/login | Create an authentication token Creates and returns a bearer token in JWT format that you can use to authentica |
specification origin: https://raw.githubusercontent.com/docker/docs/main/docker-hub/api/dvp.yaml
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.