Sign in
latestOpenAPI 3.0.02026-08-10221235717.8 KB

e21ad140ec3c

public
Registry

Updates (patches) an existing registry record.

patch/orgs/{orgId}/registries/{regId}

Path parameters

orgIdstring required

Unique (alpha-numerical) organization identifier.

regIdstring required

Unique (alpha-numerical) registry identifier.

Request body

enable_ciboolean

Indicates if registry secrets and credentials should be exposed to CI agents.

idstring required

Registry ID, unique within the Organization.

registrystring required

Registry name, usually in a "{domain}" or "{domain}/{project}" format.

secretsClusterSecretsMapRequest

ClusterSecretsMap stores a list of Kuberenetes secret references for the target deployment clusters.

typestring required

Registry type, describes the registry authentication method, and defines the schema for the credentials.

Supported values:

  • public

  • basic

  • google_gcr

  • amazon_ecr

  • secret_ref

Example request

{
  "created_at": "2020-05-22T14:53:27Z",
  "created_by": "a.user@example.com",
  "enable_ci": false,
  "id": "humanitec",
  "registry": "registry.humanitec.io",
  "secrets": {
    "*": {
      "namespace": "dev-secrets",
      "secret": "custom-regcred"
    },
    "cluster-A": {
      "namespace": "prod-secrets",
      "secret": "custom-regcred"
    }
  },
  "type": "basic"
}

Response

Updated record details.

created_atstring nullable

The timestamp of when this record was created.

created_bystring

The user who created this record.

enable_ciboolean required

Indicates if registry secrets and credentials should be exposed to CI agents.

idstring required

Registry ID, unique within the Organization.

registrystring required

Registry name, usually in a "{domain}" or "{domain}/{project}" format.

secretsClusterSecretsMapResponse

ClusterSecretsMap stores a list of Kuberenetes secret references for the target deployment clusters.

typestring required

Registry type, describes the registry authentication method, and defines the schema for the credentials.

Supported values:

  • public

  • basic

  • google_gcr

  • amazon_ecr

  • secret_ref

Example response

{
  "created_at": "2020-05-22T14:53:27Z",
  "created_by": "a.user@example.com",
  "enable_ci": false,
  "id": "humanitec",
  "registry": "registry.humanitec.io",
  "secrets": {
    "*": {
      "namespace": "dev-secrets",
      "secret": "custom-regcred"
    },
    "cluster-A": {
      "namespace": "prod-secrets",
      "secret": "custom-regcred"
    }
  },
  "type": "basic"
}