OCI

List Artifacts

List multiple OCIArtifacts

An OCIArtifact is a single OCI Artifact (manifest) that describes an OCI Image or other OCI Artifact.

OCIArtifacts have a MediaType that informs you what the OCIArtifact contains. For OCIArtifacts with a MediaType of application/vnd.oci.image.manifest.v1+json or application/vnd.docker.container.image.v1+json, the Architecture field will show the compute architecture that the OCI Image was built for (e.g. “amd64”)

OCIArtifacts can be associated with zero or more ProjectReleases and PackageReleases.

GET

ociartifacts

{
  "results": [
    {
      "created_by": "<string>",
      "created_on": "2023-11-07T05:31:56Z",
      "digest": "<string>",
      "last_modified_by": "<string>",
      "last_modified_on": "2023-11-07T05:31:56Z",
      "media_type": "<string>",
      "package_releases": [
        "<string>"
      ],
      "project_releases": [
        "<string>"
      ],
      "size_bytes": 123,
      "tags": [
        "<string>"
      ],
      "$schema": "<string>",
      "architecture": "<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.digest

string

required

Digest is the SHA-256 hash of the OCI Artifact's content.

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.media_type

string

required

MediaType of the OCI Artifact.

results.package_releases

string[] | null

required

PackageReleases is the list of PackageRelease IDs that this OCI Artifact is associated with.

results.project_releases

string[] | null

required

ProjectReleases is the list of ProjectRelease IDs that this OCI Artifact is associated with.

results.size_bytes

integer<int64>

required

Size of the content in bytes.

results.tags

string[] | null

required

Tags is the list of OCITag IDs that this OCI Artifact is associated with.

results.$schema

string<uri>

A URL to the JSON Schema for this object.

results.architecture

string

Architecture is the string code for the architecture of the built OCI Artifact, if any.

$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 ArtifactCreate a new OCIArtifact An OCIArtifact is a single OCI Artifact (manifest) that describes an OCI Image or other OCI Artifact. OCIArtifacts have a MediaType that informs you what the OCIArtifact contains. For OCIArtifacts with a MediaType of application/vnd.oci.image.manifest.v1+json or application/vnd.docker.container.image.v1+json, the Architecture field will show the compute architecture that the OCI Image was built for (e.g. "amd64") OCIArtifacts can be associated with zero or more ProjectReleases and PackageReleases.

⌘I

{
  "results": [
    {
      "created_by": "<string>",
      "created_on": "2023-11-07T05:31:56Z",
      "digest": "<string>",
      "last_modified_by": "<string>",
      "last_modified_on": "2023-11-07T05:31:56Z",
      "media_type": "<string>",
      "package_releases": [
        "<string>"
      ],
      "project_releases": [
        "<string>"
      ],
      "size_bytes": 123,
      "tags": [
        "<string>"
      ],
      "$schema": "<string>",
      "architecture": "<string>"
    }
  ],
  "$schema": "<string>",
  "pagination": {
    "continue": "<string>"
  }
}

API Reference

Login

Risk

Account

KubeCluster

KubePlatform

OCI

Organization

Package

Project

List Artifacts

Query Parameters

Response