Files
docker-docs/apidocs/cloud-api-source/source/includes/registry.md
Misty Stanley-Jones a4f5e30249 Various copyedits to reduce future tense, wordiness, and use of 'please' (#5788)
* Reword lots of instances of 'will'

* Reword lots of instances of won't

* Reword lots of instances of we'll

* Eradicate you'll

* Eradicate 'be able to' type of phrases

* Eradicate 'unable to' type of phrases

* Eradicate 'has / have to' type of phrases

* Eradicate 'note that' type of phrases

* Eradicate 'in order to' type of phrases

* Redirect to official Chef and Puppet docs

* Eradicate gratuitous 'please'

* Reduce use of e.g.

* Reduce use of i.e.

* Reduce use of N.B.

* Get rid of 'sexagesimal' and correct some errors
2018-01-25 17:37:23 -08:00

88 lines
1.8 KiB
Markdown

# Registries
## Registry
> Example
```json
{
"host": "registry-1.docker.io",
"is_docker_registry": true,
"is_ssl": true,
"name": "Docker Hub",
"port": 443,
"resource_uri": "/api/repo/v1/user_namespace/registry/registry-1.docker.io/"
}
```
Represents a registry where repositories are hosted.
This is a [namespaced endpoint](#namespaced-endpoints).
### Attributes
Attribute | Description
--------- | -----------
resource_uri | A unique API endpoint that represents the registry
name | Human-readable name of the registry
host | FQDN of the registry, such as `registry-1.docker.io`
is_docker_registry | Whether this registry is run by Docker
is_ssl | Whether this registry has SSL activated or not
port | The port number where the registry is listening to
## List all registries
```http
GET /api/repo/v1/registry/ HTTP/1.1
Host: cloud.docker.com
Authorization: Basic dXNlcm5hbWU6YXBpa2V5
Accept: application/json
```
Lists all current registries. Returns a list of `Registry` objects.
### Endpoint Type
Available in Docker Cloud's **REST API**
### HTTP Request
`GET /api/repo/v1/[optional_namespace/]registry/`
### Query Parameters
Parameter | Description
--------- | -----------
uuid | Filter by UUID
name | Filter by registry name
host | Filter by registry host
is_docker_registry | Filter by whether the registry is run by Docker or not. Possible values: 'true' or 'false'
## Get an existing registry
```http
GET /api/repo/v1/registry/registry-1.docker.io/ HTTP/1.1
Host: cloud.docker.com
Authorization: Basic dXNlcm5hbWU6YXBpa2V5
Accept: application/json
```
Gets all the details of an specific registry
### Endpoint Type
Available in Docker Cloud's **REST API**
### HTTP Request
`GET /api/v1/[optional_namespace/]registry/(host)/`
### Path Parameters
Parameter | Description
--------- | -----------
host | The host of the registry to retrieve