> ## Documentation Index
> Fetch the complete documentation index at: https://docs.vastdata.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Container Registry by ID

## OpenAPI

````json GET /container-registries/{guid}
{
  "openapi": "3.0.3",
  "info": {
    "title": "VAST DataEngine API",
    "description": "Combined OpenAPI specification for Document360: Provisioning, Telemetries Query, Telemetries Collector, and shared common components.",
    "version": "1.4.0"
  },
  "servers": [
    {
      "url": "http://localhost:3000",
      "description": "Provisioning Service (Local development server)"
    },
    {
      "url": "http://localhost:8080/query_telemetries",
      "description": "Telemetries Query Service (Local development server)"
    },
    {
      "url": "http://localhost:8080/telemetries",
      "description": "Telemetries Collector Service (Local development server)"
    }
  ],
  "tags": [
    {
      "name": "Provisioning Service v1.4.0",
      "description": "Provisioning Service API"
    },
    {
      "name": "Provisioning Service v1.4.0 > dataEngine",
      "description": "Data Engine lifecycle"
    },
    {
      "name": "Provisioning Service v1.4.0 > setup_provisioning",
      "description": "Deprecated provisioning setup"
    },
    {
      "name": "Provisioning Service v1.4.0 > pipelines",
      "description": "Pipelines"
    },
    {
      "name": "Provisioning Service v1.4.0 > pipelineRevisions",
      "description": "Pipeline revisions"
    },
    {
      "name": "Provisioning Service v1.4.0 > functions",
      "description": "Functions"
    },
    {
      "name": "Provisioning Service v1.4.0 > functionRevisions",
      "description": "Function revisions"
    },
    {
      "name": "Provisioning Service v1.4.0 > functionRevisionsDeprecated",
      "description": "Deprecated function revision endpoints"
    },
    {
      "name": "Provisioning Service v1.4.0 > triggers",
      "description": "Triggers"
    },
    {
      "name": "Provisioning Service v1.4.0 > topics",
      "description": "Topics"
    },
    {
      "name": "Provisioning Service v1.4.0 > containerRegistries",
      "description": "Container registries"
    },
    {
      "name": "Provisioning Service v1.4.0 > kubernetesClusters",
      "description": "Kubernetes clusters"
    },
    {
      "name": "Provisioning Service v1.4.0 > kubernetesSecrets",
      "description": "Kubernetes secrets"
    },
    {
      "name": "Provisioning Service v1.4.0 > mtlsAuthenticationCredentials",
      "description": "mTLS authentication credentials"
    },
    {
      "name": "Provisioning Service v1.4.0 > dashboard",
      "description": "Dashboard"
    },
    {
      "name": "Provisioning Service v1.4.0 > reports",
      "description": "Saved reports"
    },
    {
      "name": "Telemetries Collector Service v1.4.0",
      "description": "API for collecting OTEL signals (traces, logs and metrics)"
    },
    {
      "name": "Telemetries Collector Service v1.4.0 > collect_telemetries",
      "description": "Collect OTEL signals"
    },
    {
      "name": "Telemetries Query Service v1.4.0",
      "description": "API for querying traces, logs and metrics"
    },
    {
      "name": "Telemetries Query Service v1.4.0 > query_telemetries",
      "description": "Query traces and logs"
    },
    {
      "name": "Telemetries Query Service v1.4.0 > metrics",
      "description": "Query metrics"
    },
    {
      "name": "Telemetries Query Service v1.4.0 > reports",
      "description": "Saved reports"
    }
  ],
  "paths": {
    "/container-registries/{guid}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/GUID"
        }
      ],
      "get": {
        "summary": "Get Container Registry by ID",
        "operationId": "getContainerRegistriesById",
        "tags": [
          "Provisioning Service v1.4.0 > containerRegistries"
        ],
        "responses": {
          "200": {
            "description": "The Container Registry",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ContainerRegistry"
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/UnauthorizedError"
          },
          "403": {
            "$ref": "#/components/responses/ForbiddenError"
          },
          "404": {
            "$ref": "#/components/responses/NotFoundError"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          }
        }
      }
    }
  },
  "components": {
    "parameters": {
      "GUID": {
        "name": "guid",
        "in": "path",
        "required": true,
        "schema": {
          "type": "string"
        }
      }
    },
    "schemas": {
      "ContainerRegistry": {
        "allOf": [
          {
            "$ref": "#/components/schemas/Resource"
          },
          {
            "$ref": "#/components/schemas/ContainerRegistryBase"
          }
        ]
      },
      "Resource": {
        "allOf": [
          {
            "$ref": "#/components/schemas/ResourceCreate"
          },
          {
            "type": "object",
            "properties": {
              "id": {
                "$ref": "#/components/schemas/ReadOnlyID"
              },
              "guid": {
                "$ref": "#/components/schemas/ReadOnlyGUID"
              },
              "tenant_guid": {
                "$ref": "#/components/schemas/TenantID"
              },
              "owner": {
                "$ref": "#/components/schemas/UserID"
              },
              "created_at": {
                "type": "string",
                "readOnly": true,
                "format": "date-time",
                "description": "Timestamp when the resource was created.",
                "example": "2024-12-25 15:30:00+00:00"
              },
              "updated_at": {
                "type": "string",
                "readOnly": true,
                "format": "date-time",
                "description": "Timestamp when the resource was last updated.",
                "example": "2024-12-28 18:00:00+00:00"
              },
              "vrn": {
                "$ref": "#/components/schemas/VastRN"
              }
            }
          }
        ],
        "description": "Extends ResourceCreate with read-only fields."
      },
      "ContainerRegistryBase": {
        "allOf": [
          {
            "$ref": "#/components/schemas/ResourceCreate"
          },
          {
            "type": "object",
            "properties": {
              "url": {
                "type": "string",
                "description": "URL to the container registry."
              },
              "primary_kubernetes_cluster": {
                "$ref": "#/components/schemas/KubernetesNamespace"
              },
              "additional_kubernetes_clusters": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/KubernetesNamespace"
                },
                "description": "List of Kubernetes clusters and namespaces where the container registry is replicated."
              },
              "auth_type": {
                "type": "string",
                "enum": [
                  "password",
                  "secret",
                  "none"
                ],
                "default": "none",
                "description": "Flag indincating login to the container registry requires user and password, secret name, or none"
              },
              "secret": {
                "type": "string",
                "nullable": true,
                "description": "Secret name for logging in the container registry"
              },
              "is_accessible_to_data_engine": {
                "type": "boolean",
                "default": true,
                "description": "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)."
              }
            },
            "required": [
              "url",
              "primary_kubernetes_cluster"
            ]
          }
        ]
      },
      "ErrorResponse": {
        "type": "object",
        "properties": {
          "detail": {
            "type": "string"
          },
          "source": {
            "$ref": "#/components/schemas/ErrorSource"
          },
          "code": {
            "type": "string",
            "description": "Optional machine-readable error code for clients to branch on instead of parsing `detail`."
          }
        }
      },
      "ResourceCreate": {
        "allOf": [
          {
            "$ref": "#/components/schemas/ResourceUpdate"
          }
        ],
        "required": [
          "name"
        ]
      },
      "ReadOnlyID": {
        "type": "integer",
        "format": "int64",
        "readOnly": true,
        "description": "A globally unique identifier (ID) for the resource."
      },
      "ReadOnlyGUID": {
        "type": "string",
        "readOnly": true,
        "format": "uuid",
        "description": "A globally unique identifier (GUID) for the resource.",
        "example": "a7f4aa24-a00d-4dc5-a113-2031eb8c2c79"
      },
      "TenantID": {
        "$ref": "#/components/schemas/ReadOnlyGUID"
      },
      "UserID": {
        "type": "object",
        "readOnly": true,
        "properties": {
          "id": {
            "type": "string",
            "description": "The unique identifier for the owner."
          },
          "id_type": {
            "type": "string",
            "description": "The type of identifier for the owner.",
            "enum": [
              "uid",
              "vid",
              "sid",
              "access_key",
              "sid_str",
              "login_name",
              "username"
            ]
          },
          "name": {
            "type": "string",
            "description": "The presentable name of the owner"
          }
        },
        "required": [
          "id",
          "id_type"
        ],
        "description": "Represents the owner of the resource."
      },
      "VastRN": {
        "type": "string",
        "description": "A logical path for resource grouping and policy assignment. The structure of the logical path is: vast:dataengine:<resource type>:<custom structure per type>\nwhere resource type is one of: triggers / functions / pipelines / topics / kubernetes-clusters / container-registries / mtls-authentication-credentials.\n",
        "example": "vast:dataengine:functions:foo"
      },
      "KubernetesNamespace": {
        "type": "object",
        "properties": {
          "kubernetes_cluster_vrn": {
            "$ref": "#/components/schemas/VastRN"
          },
          "namespace": {
            "type": "string"
          }
        }
      },
      "ErrorSource": {
        "type": "object",
        "description": "Represents the underlying problem that made Data Engine raise the error",
        "properties": {
          "source_type": {
            "type": "string",
            "description": "The component where the error happened",
            "example": "kubernetes | vms | vdb | registry"
          },
          "source_name": {
            "type": "string",
            "description": "The name of the source compoenent",
            "example": "my-cluster"
          },
          "inner_error": {
            "type": "string",
            "description": "The error message from the source component",
            "example": "Failed to connect to the cluster"
          }
        }
      },
      "ResourceUpdate": {
        "additionalProperties": false,
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "A name for the resource.",
            "example": "naomis-resource"
          },
          "description": {
            "type": "string",
            "description": "A description of the resource.",
            "example": "A good and detailed description that makes everyone understand."
          },
          "tags": {
            "type": "array",
            "maxItems": 32,
            "description": "Custom tags for organizing and categorizing resources in the GUI.",
            "items": {
              "type": "string"
            },
            "example": [
              "tagA",
              "tagB",
              "tagC"
            ]
          }
        },
        "description": "Defines a shared group of attributes to be found in all API resources."
      }
    },
    "responses": {
      "UnauthorizedError": {
        "description": "Unauthorized",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            }
          }
        }
      },
      "ForbiddenError": {
        "description": "Forbidden",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            }
          }
        }
      },
      "NotFoundError": {
        "description": "Not Found",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            }
          }
        }
      },
      "InternalServerError": {
        "description": "Internal Server Error",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            }
          }
        }
      }
    }
  }
}
````