Import an artifact from a registry, repository or URL

Scope: component:publish

Authorization

bearerAuth

AuthorizationBearer <token>

An API key, or an access token minted from one. Pass it in the Authorization header: Bearer admp_...

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

import_component.name_not_an_id // a component name cannot start with cmp-, which marks an id import_component.tags.tag_not_an_id // a tag cannot start with ver-, which marks a version id

name?name

Empty means the artifact's own name: the chart's, the module's, the repository's or directory's.

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

Lengthlength <= 63

source*||||

ImportSource names an artifact to import. One variant. The kind of the resulting component follows from it: a chart from OCI or a Helm repository, a module from a module registry, whatever inspection finds in a git tree or an archive.

credential_ids?array<>

The credentials this import may present, chosen by the caller. Each is presented only where its type fits and its allowed_hosts permit. A fetch that reaches a host none of them covers fails naming the host.

Itemsitems <= 16

tags?array<>

Tags to set on the resulting version. A chart's version and a module's version are applied as tags whether or not named.

Itemsitems <= 16

description?description

Applied when the import creates the component; ignored otherwise.

Lengthlength <= 1024

labels?

Propertiesproperties <= 64

baseline_values_json?baseline_values_json

The organization's defaults for this artifact, as a JSON object: values laid over the artifact's own defaults (a chart's values.yaml, a module's variable defaults) before any environment's values. Stored with the artifact as one version under one digest, so changing them is a new version, which environments move to like any other. Empty means the artifact's own defaults.

Lengthlength <= 1048576

Response Body

`application/json`

curl -X POST "https://example.com/v1/components/import" \  -H "Content-Type: application/json" \  -d '{    "source": {}  }'

{  "component": {    "id": "string",    "name": "string",    "description": "string",    "labels": {      "property1": "string",      "property2": "string"    },    "tags": [      {        "name": "string",        "digest": "string",        "immutable": true,        "created_at": "2023-01-15T01:30:15.01Z",        "updated_at": "2023-01-15T01:30:15.01Z"      }    ],    "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",    "status": "STATUS_UNSPECIFIED",    "status_reason": "string",    "status_changed_at": "2023-01-15T01:30:15.01Z",    "successor_component_id": "string"  },  "version": {    "id": "string",    "component_id": "string",    "digest": "string",    "kind": "COMPONENT_KIND_UNSPECIFIED",    "size_bytes": "string",    "contract": {      "inputs": [        {          "name": "string",          "type": "string",          "description": "string",          "required": true,          "default": null,          "sensitive": true,          "ephemeral": true,          "nullable": true,          "deprecated": "string",          "validations": [            {              "condition": "string",              "error_message": "string"            }          ],          "schema": {            "property1": null,            "property2": null          }        }      ],      "outputs": [        {          "name": "string",          "description": "string",          "sensitive": true        }      ]    },    "provenance": {      "kind": "KIND_UNSPECIFIED",      "uri": "string",      "ref": "string",      "commit": "string",      "path": "string",      "dependencies": [        {          "source": "string",          "constraint": "string",          "resolved": "string"        }      ],      "credentials": [        {          "id": "string",          "name": "string",          "hosts": [            "string"          ]        }      ],      "commit_message": "string",      "commit_author": "string"    },    "findings": [      {        "severity": "FINDING_SEVERITY_UNSPECIFIED",        "source": "string",        "code": "string",        "message": "string",        "path": "string"      }    ],    "status": "STATUS_UNSPECIFIED",    "status_changed_at": "2023-01-15T01:30:15.01Z",    "status_reason": "string",    "tags": [      "string"    ],    "created_by": {      "id": "string",      "display_name": "string",      "email": "string"    },    "created_at": "2023-01-15T01:30:15.01Z",    "providers": [      "string"    ],    "baseline_values_json": "string"  },  "unchanged": true}

Import an artifact from a registry, repository or URL

AuthorizationCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

Authorization

Request Body

Response Body

`application/json`