Registries

>>>

GET /docker/api/v2/registries
List all docker registries

Params

Param Name Description
location_id
Optional

Scope by locations

Validations:

  • Must be a Integer
organization_id
Optional

Scope by organizations

Validations:

  • Must be a Integer
search
Optional

filter results

Validations:

  • Must be a String
order
Optional

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String
page
Optional

paginate results

Validations:

  • Must be a String
per_page
Optional

number of entries per request

Validations:

  • Must be a String
>>>

GET /docker/api/v2/registries/:id
Show a docker registry

Params

Param Name Description
location_id
Optional

Scope by locations

Validations:

  • Must be a Integer
organization_id
Optional

Scope by organizations

Validations:

  • Must be a Integer
id
Required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.
>>>

POST /docker/api/v2/registries
Create a docker registry

Params

Param Name Description
location_id
Optional

Scope by locations

Validations:

  • Must be a Integer
organization_id
Optional

Scope by organizations

Validations:

  • Must be a Integer
registry
Required

Validations:

  • Must be a Hash
registry[name]
Required

Validations:

  • Must be a String
registry[location_ids]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

REPLACE locations with given ids

Validations:

  • Must be an array of any type
registry[organization_ids]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

REPLACE organizations with given ids.

Validations:

  • Must be an array of any type
registry[url]
Required

Validations:

  • Must be a String
registry[description]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be a String
registry[username]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be a String
registry[password]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be a String
>>>

PUT /docker/api/v2/registries/:id
Update a docker registry

Params

Param Name Description
location_id
Optional

Scope by locations

Validations:

  • Must be a Integer
organization_id
Optional

Scope by organizations

Validations:

  • Must be a Integer
id
Required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.
registry
Required

Validations:

  • Must be a Hash
registry[name]
Optional

Validations:

  • Must be a String
registry[location_ids]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

REPLACE locations with given ids

Validations:

  • Must be an array of any type
registry[organization_ids]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

REPLACE organizations with given ids.

Validations:

  • Must be an array of any type
registry[url]
Optional

Validations:

  • Must be a String
registry[description]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be a String
registry[username]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be a String
registry[password]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be a String
>>>

DELETE /docker/api/v2/registries/:id
Delete a docker registry

Params

Param Name Description
location_id
Optional

Scope by locations

Validations:

  • Must be a Integer
organization_id
Optional

Scope by organizations

Validations:

  • Must be a Integer
id
Required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.