Admiral
Components

Pull and publish an artifact from a registry, repository or URL

POST
/v1/components:pull

Scope: component:publish

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.

Response Body

application/json

curl -X POST "https://example.com/v1/components:pull" \  -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"  },  "revision": {    "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        }      ],      "outputs": [        {          "name": "string",          "description": "string",          "sensitive": true        }      ]    },    "provenance": {      "kind": "PROVENANCE_KIND_UNSPECIFIED",      "uri": "string",      "ref": "string",      "commit": "string",      "path": "string",      "dirty": true,      "pins": [        {          "source": "string",          "constraint": "string",          "resolved": "string"        }      ],      "credentials": [        {          "id": "string",          "name": "string",          "hosts": [            "string"          ]        }      ]    },    "findings": [      {        "severity": "FINDING_SEVERITY_UNSPECIFIED",        "source": "string",        "code": "string",        "message": "string",        "path": "string"      }    ],    "status": "REVISION_STATUS_UNSPECIFIED",    "deprecated_at": "2023-01-15T01:30:15.01Z",    "deprecation_reason": "string",    "tags": [      "string"    ],    "created_by": {      "id": "string",      "display_name": "string",      "email": "string"    },    "created_at": "2023-01-15T01:30:15.01Z"  },  "unchanged": true}