Search images Run in API Explorer

GET /images/search

Search for an image on Docker Hub.

Query parameters

  • term string Required

    Term to search

  • limit integer

    Maximum number of results to return

  • filters string

    A JSON encoded value of the filters (a map[string][]string) to process on the images list. Available filters:

    • is-official=(true|false)
    • stars=<number> Matches images that has at least 'number' stars.

Responses

  • 200 application/json

    No error

    Hide response attributes Show response attributes object
    • description string
    • is_official boolean
    • is_automated boolean

      Whether this repository has automated builds enabled.


      Deprecated: This field is deprecated and will always be "false".

    • name string
    • star_count integer
  • 500 application/json

    Server error

    Hide response attribute Show response attribute object
    • message string Required

      The error message.
GET /images/search 
curl \
 --request GET 'http://api.example.com/v1.49/images/search?term=string'
Response examples (200) 
[
  {
    "name": "alpine",
    "star_count": 10093,
    "description": "A minimal Docker image based on Alpine Linux with a complete package index and only 5 MB in size!",
    "is_official": true,
    "is_automated": false
  },
  {
    "name": "Busybox base image.",
    "star_count": 3037,
    "description": "Busybox base image.",
    "is_official": true,
    "is_automated": false
  },
  {
    "name": "postgres",
    "star_count": 12408,
    "description": "The PostgreSQL object-relational database system provides reliability and data integrity.",
    "is_official": true,
    "is_automated": false
  }
]
Response examples (200) 
[
  {
    "description": "string",
    "is_official": true,
    "is_automated": false,
    "name": "string",
    "star_count": 42
  }
]
Response examples (500) 
{
  "message": "Something went wrong."
}
Response examples (500) 
{
  "message": "Something went wrong."
}