Create a source

The source type and source_config must match -- for example, a TERRAFORM_REGISTRY source requires a TerraformRegistryConfig.

Scope: source:write

Authorization

bearerAuth

AuthorizationBearer <token>

Personal Access Token (PAT) or Service Access Token (SAT). Pass the token in the Authorization header: Bearer adm_pat_...

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

archive*

ArchiveConfig provides additional parameters for archive sources (tar.gz, zip) fetched via HTTP, S3, or GCS.

name?name

URL-safe, human-readable identifier. Must be unique within the tenant.

Match^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$

Length1 <= length <= 63

description?description

Optional description of the source's purpose.

Lengthlength <= 1024

type?type

The kind of artifact and fetch protocol.

Value in

"SOURCE_TYPE_UNSPECIFIED" | "SOURCE_TYPE_TERRAFORM_REGISTRY" | "SOURCE_TYPE_TERRAFORM_GIT" | "SOURCE_TYPE_HELM_REPOSITORY" | "SOURCE_TYPE_HELM_OCI" | "SOURCE_TYPE_HELM_GIT" | "SOURCE_TYPE_KUSTOMIZE_GIT" | "SOURCE_TYPE_MANIFEST_GIT" | "SOURCE_TYPE_ARCHIVE"

url?url

Base URL for the source (see Source.url for per-type semantics).

Length1 <= length

connection_id?|

Reference to the connection providing credentials (UUID). Optional for public sources.

Formatuuid

catalog?catalog

Whether this is a curated catalog entry.

labels?

Arbitrary key-value labels.

Propertiesproperties <= 64

helm_git*

HelmGitConfig provides additional parameters for Helm charts sourced from Git repositories.

name?name

URL-safe, human-readable identifier. Must be unique within the tenant.

Match^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$

Length1 <= length <= 63

description?description

Optional description of the source's purpose.

Lengthlength <= 1024

type?type

The kind of artifact and fetch protocol.

Value in

"SOURCE_TYPE_UNSPECIFIED" | "SOURCE_TYPE_TERRAFORM_REGISTRY" | "SOURCE_TYPE_TERRAFORM_GIT" | "SOURCE_TYPE_HELM_REPOSITORY" | "SOURCE_TYPE_HELM_OCI" | "SOURCE_TYPE_HELM_GIT" | "SOURCE_TYPE_KUSTOMIZE_GIT" | "SOURCE_TYPE_MANIFEST_GIT" | "SOURCE_TYPE_ARCHIVE"

url?url

Base URL for the source (see Source.url for per-type semantics).

Length1 <= length

connection_id?|

Reference to the connection providing credentials (UUID). Optional for public sources.

Formatuuid

catalog?catalog

Whether this is a curated catalog entry.

labels?

Arbitrary key-value labels.

Propertiesproperties <= 64

helm_oci*

HelmOCIConfig provides additional parameters for Helm charts stored in OCI registries.

name?name

URL-safe, human-readable identifier. Must be unique within the tenant.

Match^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$

Length1 <= length <= 63

description?description

Optional description of the source's purpose.

Lengthlength <= 1024

type?type

The kind of artifact and fetch protocol.

Value in

"SOURCE_TYPE_UNSPECIFIED" | "SOURCE_TYPE_TERRAFORM_REGISTRY" | "SOURCE_TYPE_TERRAFORM_GIT" | "SOURCE_TYPE_HELM_REPOSITORY" | "SOURCE_TYPE_HELM_OCI" | "SOURCE_TYPE_HELM_GIT" | "SOURCE_TYPE_KUSTOMIZE_GIT" | "SOURCE_TYPE_MANIFEST_GIT" | "SOURCE_TYPE_ARCHIVE"

url?url

Base URL for the source (see Source.url for per-type semantics).

Length1 <= length

connection_id?|

Reference to the connection providing credentials (UUID). Optional for public sources.

Formatuuid

catalog?catalog

Whether this is a curated catalog entry.

labels?

Arbitrary key-value labels.

Propertiesproperties <= 64

helm_repository*

HelmRepositoryConfig provides additional parameters for Helm charts from classic HTTP/S chart repositories.

name?name

URL-safe, human-readable identifier. Must be unique within the tenant.

Match^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$

Length1 <= length <= 63

description?description

Optional description of the source's purpose.

Lengthlength <= 1024

type?type

The kind of artifact and fetch protocol.

Value in

"SOURCE_TYPE_UNSPECIFIED" | "SOURCE_TYPE_TERRAFORM_REGISTRY" | "SOURCE_TYPE_TERRAFORM_GIT" | "SOURCE_TYPE_HELM_REPOSITORY" | "SOURCE_TYPE_HELM_OCI" | "SOURCE_TYPE_HELM_GIT" | "SOURCE_TYPE_KUSTOMIZE_GIT" | "SOURCE_TYPE_MANIFEST_GIT" | "SOURCE_TYPE_ARCHIVE"

url?url

Base URL for the source (see Source.url for per-type semantics).

Length1 <= length

connection_id?|

Reference to the connection providing credentials (UUID). Optional for public sources.

Formatuuid

catalog?catalog

Whether this is a curated catalog entry.

labels?

Arbitrary key-value labels.

Propertiesproperties <= 64

kustomize_git*

KustomizeGitConfig provides additional parameters for Kustomize overlays sourced from Git repositories.

name?name

URL-safe, human-readable identifier. Must be unique within the tenant.

Match^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$

Length1 <= length <= 63

description?description

Optional description of the source's purpose.

Lengthlength <= 1024

type?type

The kind of artifact and fetch protocol.

Value in

"SOURCE_TYPE_UNSPECIFIED" | "SOURCE_TYPE_TERRAFORM_REGISTRY" | "SOURCE_TYPE_TERRAFORM_GIT" | "SOURCE_TYPE_HELM_REPOSITORY" | "SOURCE_TYPE_HELM_OCI" | "SOURCE_TYPE_HELM_GIT" | "SOURCE_TYPE_KUSTOMIZE_GIT" | "SOURCE_TYPE_MANIFEST_GIT" | "SOURCE_TYPE_ARCHIVE"

url?url

Base URL for the source (see Source.url for per-type semantics).

Length1 <= length

connection_id?|

Reference to the connection providing credentials (UUID). Optional for public sources.

Formatuuid

catalog?catalog

Whether this is a curated catalog entry.

labels?

Arbitrary key-value labels.

Propertiesproperties <= 64

manifest_git*

ManifestGitConfig provides additional parameters for raw Kubernetes manifests sourced from Git repositories.

name?name

URL-safe, human-readable identifier. Must be unique within the tenant.

Match^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$

Length1 <= length <= 63

description?description

Optional description of the source's purpose.

Lengthlength <= 1024

type?type

The kind of artifact and fetch protocol.

Value in

"SOURCE_TYPE_UNSPECIFIED" | "SOURCE_TYPE_TERRAFORM_REGISTRY" | "SOURCE_TYPE_TERRAFORM_GIT" | "SOURCE_TYPE_HELM_REPOSITORY" | "SOURCE_TYPE_HELM_OCI" | "SOURCE_TYPE_HELM_GIT" | "SOURCE_TYPE_KUSTOMIZE_GIT" | "SOURCE_TYPE_MANIFEST_GIT" | "SOURCE_TYPE_ARCHIVE"

url?url

Base URL for the source (see Source.url for per-type semantics).

Length1 <= length

connection_id?|

Reference to the connection providing credentials (UUID). Optional for public sources.

Formatuuid

catalog?catalog

Whether this is a curated catalog entry.

labels?

Arbitrary key-value labels.

Propertiesproperties <= 64

terraform_git*

TerraformGitConfig provides additional parameters for Terraform modules sourced from Git repositories.

name?name

URL-safe, human-readable identifier. Must be unique within the tenant.

Match^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$

Length1 <= length <= 63

description?description

Optional description of the source's purpose.

Lengthlength <= 1024

type?type

The kind of artifact and fetch protocol.

Value in

"SOURCE_TYPE_UNSPECIFIED" | "SOURCE_TYPE_TERRAFORM_REGISTRY" | "SOURCE_TYPE_TERRAFORM_GIT" | "SOURCE_TYPE_HELM_REPOSITORY" | "SOURCE_TYPE_HELM_OCI" | "SOURCE_TYPE_HELM_GIT" | "SOURCE_TYPE_KUSTOMIZE_GIT" | "SOURCE_TYPE_MANIFEST_GIT" | "SOURCE_TYPE_ARCHIVE"

url?url

Base URL for the source (see Source.url for per-type semantics).

Length1 <= length

connection_id?|

Reference to the connection providing credentials (UUID). Optional for public sources.

Formatuuid

catalog?catalog

Whether this is a curated catalog entry.

labels?

Arbitrary key-value labels.

Propertiesproperties <= 64

terraform_registry*

TerraformRegistryConfig provides additional parameters for Terraform module registry sources.

name?name

URL-safe, human-readable identifier. Must be unique within the tenant.

Match^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$

Length1 <= length <= 63

description?description

Optional description of the source's purpose.

Lengthlength <= 1024

type?type

The kind of artifact and fetch protocol.

Value in

"SOURCE_TYPE_UNSPECIFIED" | "SOURCE_TYPE_TERRAFORM_REGISTRY" | "SOURCE_TYPE_TERRAFORM_GIT" | "SOURCE_TYPE_HELM_REPOSITORY" | "SOURCE_TYPE_HELM_OCI" | "SOURCE_TYPE_HELM_GIT" | "SOURCE_TYPE_KUSTOMIZE_GIT" | "SOURCE_TYPE_MANIFEST_GIT" | "SOURCE_TYPE_ARCHIVE"

url?url

Base URL for the source (see Source.url for per-type semantics).

Length1 <= length

connection_id?|

Reference to the connection providing credentials (UUID). Optional for public sources.

Formatuuid

catalog?catalog

Whether this is a curated catalog entry.

labels?

Arbitrary key-value labels.

Propertiesproperties <= 64

Response Body

`application/json`

curl -X POST "https://admiral.example.com/api/v1/sources" \  -H "Content-Type: application/json" \  -d '{    "archive": {}  }'

{  "source": {    "id": "f6a7b8c9-0123-4def-5678-901234567890",    "name": "nginx-ingress",    "description": "NGINX Ingress Controller Helm chart from the official repository.",    "type": "SOURCE_TYPE_HELM_REPOSITORY",    "url": "https://kubernetes.github.io/ingress-nginx",    "catalog": true,    "labels": {      "category": "networking",      "team": "platform"    },    "created_by": "d290f1ee-6c54-4b01-90e6-d701748f0851",    "updated_by": "d290f1ee-6c54-4b01-90e6-d701748f0851",    "created_at": "2025-08-01T12:00:00Z",    "updated_at": "2025-10-20T09:00:00Z"  }}

Create a source

Authorization

Request Body

Response Body

200application/json

`application/json`