mirror of
https://github.com/docker/cli.git
synced 2026-09-24 07:25:07 -05:00
Thatcher Peskens
0e4b996e2f
Upstream-commit: 7557af19d8cc3fba858b3ab67cef4875b6097c42 Component: engine
43 lines
941 B
ReStructuredText
43 lines
941 B
ReStructuredText
:title: Docker Index documentation
|
|
:description: Documentation for docker Index
|
|
:keywords: docker, index, api
|
|
|
|
|
|
=======================
|
|
Docker Index Search API
|
|
=======================
|
|
|
|
Search
|
|
------
|
|
|
|
.. http:get:: /v1/search
|
|
|
|
Search the Index given a search term. It accepts :http:method:`get` only.
|
|
|
|
**Example request**:
|
|
|
|
.. sourcecode:: http
|
|
|
|
GET /v1/search?q=search_term HTTP/1.1
|
|
Host: example.com
|
|
Accept: application/json
|
|
|
|
**Example response**:
|
|
|
|
.. sourcecode:: http
|
|
|
|
HTTP/1.1 200 OK
|
|
Vary: Accept
|
|
Content-Type: application/json
|
|
|
|
{"query":"search_term",
|
|
"num_results": 2,
|
|
"results" : [
|
|
{"name": "dotcloud/base", "description": "A base ubuntu64 image..."},
|
|
{"name": "base2", "description": "A base ubuntu64 image..."},
|
|
]
|
|
}
|
|
|
|
:query q: what you want to search for
|
|
:statuscode 200: no error
|
|
:statuscode 500: server error |