Harthelm Docs
REST APIRegistries

Change a container registry

Team admins (`team.manage`). Absent fields stay; an absent `password` keeps the stored one, except that an `address` on another host needs the `password` again (422 at `/password`): the stored password only ever goes to the host it was entered for. The pull Secrets of running services follow at their workspace's next reconcile; the digests stay what their last Sync resolved.

Generated from openapi/harthelm.yaml at v1.5.0
PATCH
/teams/{team}/registries/{registry}

Authorization

cookie__Host-harthelm_session<token>

Browser session of the UI (12 h idle, 7 days absolute). State-changing requests also need the header Harthelm-CSRF: 1 and a matching Origin.

Path Parameters

team*integer

Numeric resource id.

Formatint64
Range1 <= value
registry*integer

Numeric resource id.

Formatint64
Range1 <= value

Request Body

application/json
  1. body
Properties1 <= properties
name?string
Length1 <= length <= 64
address?RegistryAddress

A registry host with an optional port and path prefix, lower case, without a scheme: ghcr.io, ghcr.io/acme, registry.example.org:5000/team. Docker Hub is docker.io. An image matches on whole path segments; the longest matching address of the team wins.

Match^[a-z0-9]([-a-z0-9.]*[a-z0-9])?(:[0-9]{1,5})?(/[a-z0-9]([-a-z0-9._]*[a-z0-9])?)*$
Lengthlength <= 255
username?string
Length1 <= length <= 255
password?string
Formatpassword
Length1 <= length <= 4096

Response Body

The registry.

application/json
  1. response
id*ID

Numeric resource id.

Formatint64
Range1 <= value
team_id*ID

Numeric resource id.

Formatint64
Range1 <= value
name*string
address*RegistryAddress

A registry host with an optional port and path prefix, lower case, without a scheme: ghcr.io, ghcr.io/acme, registry.example.org:5000/team. Docker Hub is docker.io. An image matches on whole path segments; the longest matching address of the team wins.

Match^[a-z0-9]([-a-z0-9.]*[a-z0-9])?(:[0-9]{1,5})?(/[a-z0-9]([-a-z0-9._]*[a-z0-9])?)*$
Lengthlength <= 255
username*string
created_at*string
Formatdate-time
updated_at*string
Formatdate-time
curl -X PATCH 'https://console.example.com/api/v1/teams/1/registries/1' \  -H 'Content-Type: application/json' \  -d '{}'
{  "id": 1,  "team_id": 1,  "name": "string",  "address": "string",  "username": "string",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}