Docker Engine API
  1. Image
Docker Engine API
  • System
    • Ping
      GET
    • Check auth configuration
      POST
    • Monitor events
      GET
    • Get system information
      GET
    • Get data usage information
      GET
    • Get version
      GET
  • Image
    • Build an image
      POST
    • Delete builder cache
      POST
    • Create a new image from a container
      POST
    • Create an image
      POST
    • Export several images
      GET
    • List Images
      GET
    • Import images
      POST
    • Delete unused images
      POST
    • Search images
      GET
    • Remove an image
      DELETE
    • Export an image
      GET
    • Get the history of an image
      GET
    • Inspect an image
      GET
    • Push an image
      POST
    • Tag an image
      POST
  • Config
    • List configs
      GET
    • Create a config
      POST
    • Delete a config
      DELETE
    • Inspect a config
      GET
    • Update a Config
      POST
  • Container
    • Create a container
    • List containers
    • Delete stopped containers
    • Remove a container
    • Get an archive of a filesystem resource in a container
    • Get information about files in a container
    • Extract an archive of files or folders to a directory in a container
    • Attach to a container
    • Attach to a container via a websocket
    • Get changes on a container’s filesystem
    • Export a container
    • Inspect a container
    • Kill a container
    • Get container logs
    • Pause a container
    • Rename a container
    • Resize a container TTY
    • Restart a container
    • Start a container
    • Get container stats based on resource usage
    • Stop a container
    • List processes running inside a container
    • Unpause a container
    • Update a container
    • Wait for a container
  • Exec
    • Create an exec instance
    • Inspect an exec instance
    • Resize an exec instance
    • Start an exec instance
  • Distribution
    • Get image information from the registry
  • Network
    • List networks
    • Create a network
    • Delete unused networks
    • Remove a network
    • Inspect a network
    • Connect a container to a network
    • Disconnect a container from a network
  • Node
    • List nodes
    • Delete a node
    • Inspect a node
    • Update a node
  • Plugin
    • List plugins
    • Create a plugin
    • Get plugin privileges
    • Install a plugin
    • Remove a plugin
    • Disable a plugin
    • Enable a plugin
    • Inspect a plugin
    • Push a plugin
    • Configure a plugin
    • Upgrade a plugin
  • Secret
    • List secrets
    • Create a secret
    • Delete a secret
    • Inspect a secret
    • Update a Secret
  • Service
    • List services
    • Create a service
    • Delete a service
    • Inspect a service
    • Get service logs
    • Update a service
  • Session (experimental)
    • Initialize interactive session
  • Swarm
    • Inspect swarm
    • Initialize a new swarm
    • Join an existing swarm
    • Leave a swarm
    • Unlock a locked manager
    • Get the unlock key
    • Update a swarm
  • Task
    • List tasks
    • Inspect a task
  • Volume
    • List volumes
    • Create a volume
    • Delete unused volumes
    • Remove a volume
    • Inspect a volume
  • Get task logs
    GET
  1. Image

Search images

/v1.33
/v1.33
/v1.33
/v1.33
GET
/images/search
Image
Search for an image on Docker Hub.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/v1.33/images/search?term='
Response Response Example
200 - response
[
    {
        "description": "",
        "is_automated": false,
        "is_official": false,
        "name": "wma55/u1210sshd",
        "star_count": 0
    },
    {
        "description": "",
        "is_automated": false,
        "is_official": false,
        "name": "jdswinbank/sshd",
        "star_count": 0
    },
    {
        "description": "",
        "is_automated": false,
        "is_official": false,
        "name": "vgauthier/sshd",
        "star_count": 0
    }
]

Request

Query Params
term
string 
required
Term to search
limit
integer 
optional
Maximum number of results to return
filters
string 
optional
A JSON encoded value of the filters (a map[string][]string) to process on the images list. Available filters:
is-automated=(true|false)
is-official=(true|false)
stars=<number> Matches images that has at least 'number' stars.

Responses

🟢200No error
application/json
Body
array of:
description
string 
optional
is_automated
boolean 
optional
is_official
boolean 
optional
name
string 
optional
star_count
integer 
optional
🔴500Server error
Modified at 2022-09-10 17:56:06
Previous
Delete unused images
Next
Remove an image
Built with