Create a catalog item

The referenced source must exist. The item's ref, root, and path are optional and default to empty (meaning: the source's default ref, the repository root, and the root itself as working directory).

Scope: catalog:write

Authorization

bearerAuth

AuthorizationBearer <token>

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

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*name

URL-safe, human-readable identifier (e.g., "billing-vpc", "rds-standard"). Unique within the tenant. Lowercase alphanumeric and hyphens only, must start with a letter and end with an alphanumeric character (1-63 chars).

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

Length1 <= length <= 63

description?description

Optional description of the catalog item's purpose.

Lengthlength <= 1024

type*type

The content type: what this item contains and how it should be executed.

Value in

"CATALOG_ITEM_TYPE_UNSPECIFIED" | "CATALOG_ITEM_TYPE_TERRAFORM" | "CATALOG_ITEM_TYPE_HELM" | "CATALOG_ITEM_TYPE_KUSTOMIZE" | "CATALOG_ITEM_TYPE_MANIFEST"

source_id*source_id

Reference to the Source this catalog item fetches from (UUID).

Formatuuid

ref?ref

Git ref, registry version, chart version, or OCI tag to fetch. Optional. When empty, the backend uses its default (e.g., HEAD for Git, latest for registries). This is the default a component copies at create time; the component owns its ref thereafter.

Lengthlength <= 256

root?root

Subdirectory within the fetched tree to treat as the item root. Optional. When empty, the entire fetched tree is the root. Example: "modules/vpc" within a monorepo.

Lengthlength <= 512

path?path

Working directory within root for execution (e.g., "environments/prod"). Optional. When empty, defaults to root itself.

Lengthlength <= 512

labels?

Arbitrary key-value labels.

Propertiesproperties <= 64

Response Body

`application/json`

curl -X POST "https://api.admiral.io/api/v1/catalog-items" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "type": "CATALOG_ITEM_TYPE_UNSPECIFIED",    "source_id": "ae50a35c-df42-4eff-ba26-f8bc28d2af81"  }'

{  "catalog_item": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "name": "string",    "description": "string",    "type": "CATALOG_ITEM_TYPE_UNSPECIFIED",    "source_id": "ae50a35c-df42-4eff-ba26-f8bc28d2af81",    "ref": "string",    "root": "string",    "path": "string",    "labels": {      "property1": "string",      "property2": "string"    },    "source_name": "string",    "created_by": {      "id": "string",      "display_name": "string",      "email": "string"    },    "created_at": "2023-01-15T01:30:15.01Z",    "updated_at": "2023-01-15T01:30:15.01Z"  }}

Create a catalog item

Authorization

Request Body

Response Body

200application/json

`application/json`