Put

/container-registries/{guid}

Path parameters

guid

stringRequired

Body parameters

Expand All

object

name

string

A name for the resource.

Examplenaomis-resource

description

string

A description of the resource.

ExampleA good and detailed description that makes everyone understand.

tags

Array of string

Custom tags for organizing and categorizing resources in the GUI.

Max items32

Example[ "tagA", "tagB", "tagC" ]

string

url

string Required

URL to the container registry.

primary_kubernetes_cluster

object (KubernetesNamespace) Required

kubernetes_cluster_vrn

string

A logical path for resource grouping and policy assignment. The structure of the logical path is: vast:dataengine:: where resource type is one of: triggers / functions / pipelines / topics / kubernetes-clusters / container-registries / mtls-authentication-credentials.

Examplevast:dataengine:functions:foo

namespace

string

additional_kubernetes_clusters

Array of object (KubernetesNamespace)

List of Kubernetes clusters and namespaces where the container registry is replicated.

object

kubernetes_cluster_vrn

string

A logical path for resource grouping and policy assignment. The structure of the logical path is: vast:dataengine:: where resource type is one of: triggers / functions / pipelines / topics / kubernetes-clusters / container-registries / mtls-authentication-credentials.

Examplevast:dataengine:functions:foo

namespace

string

auth_type

string

Flag indincating login to the container registry requires user and password, secret name, or none

Valid values[ "password", "secret", "none" ]

Default"none"

secret

string | null

Secret name for logging in the container registry

is_accessible_to_data_engine

boolean

When true (default), the Data Engine will periodically validate that the container registry and its images are accessible. Set to false if the registry is not reachable from the Data Engine (e.g., ECR with IRSA).

Defaulttrue

username

string | null

Username for logging in the container registry

password

string | null

Password for logging in the container registry

email

string | null

User email for logging in the container registry

Responses

200

The updated Container Registry

Expand All

object

name

string

A name for the resource.

Examplenaomis-resource

description

string

A description of the resource.

ExampleA good and detailed description that makes everyone understand.

tags

Array of string

Custom tags for organizing and categorizing resources in the GUI.

Max items32

Example[ "tagA", "tagB", "tagC" ]

string

id

integer (int64)

A globally unique identifier (ID) for the resource.

guid

string (uuid)

A globally unique identifier (GUID) for the resource.

Examplea7f4aa24-a00d-4dc5-a113-2031eb8c2c79

tenant_guid

string (uuid)

A globally unique identifier (GUID) for the resource.

Examplea7f4aa24-a00d-4dc5-a113-2031eb8c2c79

owner

object (UserID)

Represents the owner of the resource.

id

string

The unique identifier for the owner.

id_type

string

The type of identifier for the owner.

Valid values[ "uid", "vid", "sid", "access_key", "sid_str", "login_name", "username" ]

name

string

The presentable name of the owner

created_at

string (date-time)

Timestamp when the resource was created.

Example2024-12-25T15:30:00Z

updated_at

string (date-time)

Timestamp when the resource was last updated.

Example2024-12-28T18:00:00Z

vrn

string

A logical path for resource grouping and policy assignment. The structure of the logical path is: vast:dataengine:: where resource type is one of: triggers / functions / pipelines / topics / kubernetes-clusters / container-registries / mtls-authentication-credentials.

Examplevast:dataengine:functions:foo

url

string

URL to the container registry.

primary_kubernetes_cluster

object (KubernetesNamespace)

kubernetes_cluster_vrn

string

A logical path for resource grouping and policy assignment. The structure of the logical path is: vast:dataengine:: where resource type is one of: triggers / functions / pipelines / topics / kubernetes-clusters / container-registries / mtls-authentication-credentials.

Examplevast:dataengine:functions:foo

namespace

string

additional_kubernetes_clusters

Array of object (KubernetesNamespace)

List of Kubernetes clusters and namespaces where the container registry is replicated.

object

kubernetes_cluster_vrn

string

A logical path for resource grouping and policy assignment. The structure of the logical path is: vast:dataengine:: where resource type is one of: triggers / functions / pipelines / topics / kubernetes-clusters / container-registries / mtls-authentication-credentials.

Examplevast:dataengine:functions:foo

namespace

string

auth_type

string

Flag indincating login to the container registry requires user and password, secret name, or none

Valid values[ "password", "secret", "none" ]

Default"none"

secret

string | null

Secret name for logging in the container registry

is_accessible_to_data_engine

boolean

When true (default), the Data Engine will periodically validate that the container registry and its images are accessible. Set to false if the registry is not reachable from the Data Engine (e.g., ECR with IRSA).

Defaulttrue

400

Bad Request

Expand All

object

detail

string

source

object (ErrorSource)

Represents the underlying problem that made Data Engine raise the error

source_type

string

The component where the error happened

Examplekubernetes | vms | vdb | registry

source_name

string

The name of the source compoenent

Examplemy-cluster

inner_error

string

The error message from the source component

ExampleFailed to connect to the cluster

code

string

Optional machine-readable error code for clients to branch on instead of parsing detail.

401

Unauthorized

Expand All

object

detail

string

source

object (ErrorSource)

Represents the underlying problem that made Data Engine raise the error

source_type

string

The component where the error happened

Examplekubernetes | vms | vdb | registry

source_name

string

The name of the source compoenent

Examplemy-cluster

inner_error

string

The error message from the source component

ExampleFailed to connect to the cluster

code

string

Optional machine-readable error code for clients to branch on instead of parsing detail.

403

Forbidden

Expand All

object

detail

string

source

object (ErrorSource)

Represents the underlying problem that made Data Engine raise the error

source_type

string

The component where the error happened

Examplekubernetes | vms | vdb | registry

source_name

string

The name of the source compoenent

Examplemy-cluster

inner_error

string

The error message from the source component

ExampleFailed to connect to the cluster

code

string

Optional machine-readable error code for clients to branch on instead of parsing detail.

404

Not Found

Expand All

object

detail

string

source

object (ErrorSource)

Represents the underlying problem that made Data Engine raise the error

source_type

string

The component where the error happened

Examplekubernetes | vms | vdb | registry

source_name

string

The name of the source compoenent

Examplemy-cluster

inner_error

string

The error message from the source component

ExampleFailed to connect to the cluster

code

string

Optional machine-readable error code for clients to branch on instead of parsing detail.

409

Conflict

Expand All

object

detail

string

source

object (ErrorSource)

Represents the underlying problem that made Data Engine raise the error

source_type

string

The component where the error happened

Examplekubernetes | vms | vdb | registry

source_name

string

The name of the source compoenent

Examplemy-cluster

inner_error

string

The error message from the source component

ExampleFailed to connect to the cluster

code

string

Optional machine-readable error code for clients to branch on instead of parsing detail.

422

Validation Error

object

detail

string

String representation of a mapping between field names and error messages

Example{"url": "URL must include a protocol", "port": "Port must be an integer"}

500

Internal Server Error

Expand All

object

detail

string

source

object (ErrorSource)

Represents the underlying problem that made Data Engine raise the error

source_type

string

The component where the error happened

Examplekubernetes | vms | vdb | registry

source_name

string

The name of the source compoenent

Examplemy-cluster

inner_error

string

The error message from the source component

ExampleFailed to connect to the cluster

code

string

Optional machine-readable error code for clients to branch on instead of parsing detail.

Update Container Registry by ID