Project

List Components

List multiple ProjectComponents

A ProjectComponent is a separate binary, daemon, or subsystem of a Project.

NOTE: ProjectComponents that are associated with a PackageComponent for a Package with PackageSystem kube or helm can be thought of as roughly equivalent to OCI/Docker Images, since the ProjectComponent describes a container within a Resource described by that PackageComponent.

A ProjectComponent is uniquely identified by the combination of a ProjectVersionSet identifier and the Component name separated by a : character. The Component name is a simple name indicating the binary, daemon or subsystem.

Examples of ProjectComponent identifiers:

argo-workflows:1:workflow-controller: the workflow-controller binary of the first versionset of the Argo Workflows Project, using the argo-workflows Alias as the Project identifier.
proj_dda0b12f-9a76-43ff-a024-9839ed3ee57b:3:workflow-controller: the workflow-controller binary of the third ProjectVersionSet of the Argo Workflows Project, using the Argo Workflow Project’s UUID as the identifier.

GET

projects

{project}

versionsets

{number}

components

{
  "results": [
    {
      "created_by": "<string>",
      "created_on": "2023-11-07T05:31:56Z",
      "last_modified_by": "<string>",
      "last_modified_on": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "primary": true,
      "project": "<string>",
      "title": "<string>",
      "versionset_number": 1,
      "$schema": "<string>",
      "description": "<string>"
    }
  ],
  "$schema": "<string>",
  "pagination": {
    "continue": "<string>"
  }
}

Query Parameters

continue

string

Continuation token value (used when retrieving the next page of results). Continuation token value (used when retrieving the next page of results).

integer<int64>

Number of records to show per page of results. Number of records to show per page of results.

Required range: 0 <= x <= 100

filter

string

Record filter. Record filter.

Response

results

object[] | null

required

Show child attributes

results.created_by

string

required

user who created the record.

results.created_on

string<date-time>

required

timestamp of when the record was created.

results.last_modified_by

string

required

user who last modified the record.

results.last_modified_on

string<date-time>

required

timestamp of when the record was last modified.

results.name

string

required

String name of the ProjectComponent. Must be unique for the Project.

results.primary

boolean

required

Indicates this ProjectComponent is considered the primary component within the Project.

results.project

string

required

ID of the Project for this ProjectVersionSet.

results.title

string

required

Display name for the ProjectComponent.

results.versionset_number

integer<int64>

required

The sequence number of this ProjectVersionSet. Represents the number of times a change to the Project's configuration, component breakdown or architecture has been tracked.

Required range: x >= 0

results.$schema

string<uri>

A URL to the JSON Schema for this object.

results.description

string

Optional long-form description of the ProjectComponent.

$schema

string<uri>

A URL to the JSON Schema for this object.

pagination

object

Show child attributes

pagination.continue

string | null

required

Continuation token value (used when retrieving the next page of results). Empty when no more records can be retrieved.

Create ComponentCreate a new ProjectComponent A ProjectComponent is a separate binary, daemon, or subsystem of a Project. > **NOTE**: ProjectComponents that are associated with a PackageComponent for a > Package with PackageSystem kube or helm can be thought of as > roughly equivalent to OCI/Docker Images, since the ProjectComponent > describes a container within a Resource described by that > PackageComponent. A ProjectComponent is uniquely identified by the combination of a ProjectVersionSet identifier and the Component name separated by a : character. The Component name is a simple name indicating the binary, daemon or subsystem. Examples of ProjectComponent identifiers: * argo-workflows:1:workflow-controller: the workflow-controller binary of the first versionset of the Argo Workflows Project, using the argo-workflows Alias as the Project identifier. * proj_dda0b12f-9a76-43ff-a024-9839ed3ee57b:3:workflow-controller: the workflow-controller binary of the third ProjectVersionSet of the Argo Workflows Project, using the Argo Workflow Project's UUID as the identifier.

⌘I

{
  "results": [
    {
      "created_by": "<string>",
      "created_on": "2023-11-07T05:31:56Z",
      "last_modified_by": "<string>",
      "last_modified_on": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "primary": true,
      "project": "<string>",
      "title": "<string>",
      "versionset_number": 1,
      "$schema": "<string>",
      "description": "<string>"
    }
  ],
  "$schema": "<string>",
  "pagination": {
    "continue": "<string>"
  }
}

API Reference

Login

Risk

Account

KubeCluster

KubePlatform

OCI

Organization

Package

Project

List Components

Query Parameters

Response