Docker Artifacts

APIs to get details of docker artifacts

Describe Docker Artifact Detail

get

Get Docker Artifact Details

Path parameters

registry_refstringRequired

Reference to the scope in which the registry exists.

Format depends on the scope:

• Account-level: account_id/registry_name/+
• Organization-level: account_id/org_id/registry_name/+
• Project-level: account_id/org_id/project_id/registry_name/+

The /+ suffix is used internally to route scoped requests. It must be included exactly as shown in the URL.

Example: {"description":"Only account ID, scoped at account level","summary":"Account-level registry","value":"acc123/registry123/+"}

artifactstringRequired

Name of the artifact.

The value depends on whether the name contains a slash (/):

• If the artifact name contains /, append a trailing /+ at the end.
  • Example: mygroup/myartifact/+
• If the artifact name does not contain /, use the plain name.
  • Example: myartifact

This is used internally to distinguish between namespaced and flat artifact names.

Example: {"summary":"Flat artifact name","value":"myartifact"}

versionstringRequired

Name of Artifact Version.

Query parameters

digeststringRequired

Digest.

version_typestring · enumOptional

Version Type.

Possible values:

Responses

200

response to get docker artifact detail

application/json

statusstring · enumRequired

Request processing status indicator

Possible values:

400

The request was invalid or malformed

application/json

401

Authentication failed or missing credentials

application/json

403

Access denied due to insufficient permissions

application/json

404

The requested resource was not found

application/json

500

An unexpected server error occurred

application/json

get/v1/registry/{registry_ref}/artifact/{artifact}/version/{version}/docker/details

GET /api/v1/registry/{registry_ref}/artifact/{artifact}/version/{version}/docker/details?digest=text HTTP/1.1
Accept: */*

{
  "data": {
    "createdAt": "text",
    "downloadsCount": 1,
    "imageName": "text",
    "isQuarantined": true,
    "metadata": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "modifiedAt": "text",
    "packageType": "DOCKER",
    "pullCommand": "text",
    "pullCommandByDigest": "text",
    "pushedBy": {
      "display_name": "text",
      "email": "text",
      "type": "text",
      "uid": "text"
    },
    "quarantineReason": "text",
    "registryPath": "text",
    "size": "text",
    "url": "text",
    "version": "text"
  },
  "status": "SUCCESS"
}

Describe Docker Artifact Integration Detail

get

Get Docker Artifact Integration Details

Path parameters

registry_refstringRequired

Reference to the scope in which the registry exists.

Format depends on the scope:

• Account-level: account_id/registry_name/+
• Organization-level: account_id/org_id/registry_name/+
• Project-level: account_id/org_id/project_id/registry_name/+

The /+ suffix is used internally to route scoped requests. It must be included exactly as shown in the URL.

Example: {"description":"Only account ID, scoped at account level","summary":"Account-level registry","value":"acc123/registry123/+"}

artifactstringRequired

Name of the artifact.

The value depends on whether the name contains a slash (/):

• If the artifact name contains /, append a trailing /+ at the end.
  • Example: mygroup/myartifact/+
• If the artifact name does not contain /, use the plain name.
  • Example: myartifact

This is used internally to distinguish between namespaced and flat artifact names.

Example: {"summary":"Flat artifact name","value":"myartifact"}

versionstringRequired

Name of Artifact Version.

Query parameters

digeststringRequired

Digest.

version_typestring · enumOptional

Version Type.

Possible values:

Responses

200

response to get docker artifact integration detail

application/json

statusstring · enumRequired

Request processing status indicator

Possible values:

400

The request was invalid or malformed

application/json

401

Authentication failed or missing credentials

application/json

403

Access denied due to insufficient permissions

application/json

404

The requested resource was not found

application/json

500

An unexpected server error occurred

application/json

get/v1/registry/{registry_ref}/artifact/{artifact}/version/{version}/docker/integrationdetails

GET /api/v1/registry/{registry_ref}/artifact/{artifact}/version/{version}/docker/integrationdetails?digest=text HTTP/1.1
Accept: */*

{
  "data": {
    "buildDetails": {
      "orgIdentifier": "text",
      "pipelineDisplayName": "text",
      "pipelineExecutionId": "text",
      "pipelineIdentifier": "text",
      "projectIdentifier": "text",
      "stageExecutionId": "text",
      "stepExecutionId": "text"
    },
    "deploymentsDetails": {
      "nonProdDeployment": 1,
      "prodDeployment": 1,
      "totalDeployment": 1
    },
    "sbomDetails": {
      "allowListViolations": 1,
      "artifactId": "text",
      "artifactSourceId": "text",
      "avgScore": "text",
      "componentsCount": 1,
      "denyListViolations": 1,
      "maxScore": "text",
      "orchestrationId": "text",
      "orgId": "text",
      "projectId": "text"
    },
    "slsaDetails": {
      "provenanceId": "text",
      "status": "text"
    },
    "stoDetails": {
      "critical": 1,
      "executionId": "text",
      "high": 1,
      "ignored": 1,
      "info": 1,
      "lastScanned": "text",
      "low": 1,
      "medium": 1,
      "pipelineId": "text",
      "total": 1
    }
  },
  "status": "SUCCESS"
}

Describe Docker Artifact Layers

get

Get Docker Artifact Layers

Path parameters

registry_refstringRequired

Reference to the scope in which the registry exists.

Format depends on the scope:

• Account-level: account_id/registry_name/+
• Organization-level: account_id/org_id/registry_name/+
• Project-level: account_id/org_id/project_id/registry_name/+

The /+ suffix is used internally to route scoped requests. It must be included exactly as shown in the URL.

Example: {"description":"Only account ID, scoped at account level","summary":"Account-level registry","value":"acc123/registry123/+"}

artifactstringRequired

Name of the artifact.

The value depends on whether the name contains a slash (/):

• If the artifact name contains /, append a trailing /+ at the end.
  • Example: mygroup/myartifact/+
• If the artifact name does not contain /, use the plain name.
  • Example: myartifact

This is used internally to distinguish between namespaced and flat artifact names.

Example: {"summary":"Flat artifact name","value":"myartifact"}

versionstringRequired

Name of Artifact Version.

Query parameters

digeststringRequired

Digest.

Responses

200

response to get artifact layers

application/json

statusstring · enumRequired

Request processing status indicator

Possible values:

400

The request was invalid or malformed

application/json

401

Authentication failed or missing credentials

application/json

403

Access denied due to insufficient permissions

application/json

404

The requested resource was not found

application/json

500

An unexpected server error occurred

application/json

get/v1/registry/{registry_ref}/artifact/{artifact}/version/{version}/docker/layers

GET /api/v1/registry/{registry_ref}/artifact/{artifact}/version/{version}/docker/layers?digest=text HTTP/1.1
Accept: */*

{
  "data": {
    "digest": "text",
    "layers": [
      {
        "command": "text",
        "size": "text"
      }
    ],
    "osArch": "text"
  },
  "status": "SUCCESS"
}

Describe Docker Artifact Manifest

get

Get Docker Artifact Manifest

Path parameters

registry_refstringRequired

Reference to the scope in which the registry exists.

Format depends on the scope:

• Account-level: account_id/registry_name/+
• Organization-level: account_id/org_id/registry_name/+
• Project-level: account_id/org_id/project_id/registry_name/+

The /+ suffix is used internally to route scoped requests. It must be included exactly as shown in the URL.

Example: {"description":"Only account ID, scoped at account level","summary":"Account-level registry","value":"acc123/registry123/+"}

artifactstringRequired

Name of the artifact.

The value depends on whether the name contains a slash (/):

• If the artifact name contains /, append a trailing /+ at the end.
  • Example: mygroup/myartifact/+
• If the artifact name does not contain /, use the plain name.
  • Example: myartifact

This is used internally to distinguish between namespaced and flat artifact names.

Example: {"summary":"Flat artifact name","value":"myartifact"}

versionstringRequired

Name of Artifact Version.

Query parameters

digeststringRequired

Digest.

Responses

200

response to get docker artifact manifest

application/json

statusstring · enumRequired

Request processing status indicator

Possible values:

400

The request was invalid or malformed

application/json

401

Authentication failed or missing credentials

application/json

403

Access denied due to insufficient permissions

application/json

404

The requested resource was not found

application/json

500

An unexpected server error occurred

application/json

get/v1/registry/{registry_ref}/artifact/{artifact}/version/{version}/docker/manifest

GET /api/v1/registry/{registry_ref}/artifact/{artifact}/version/{version}/docker/manifest?digest=text HTTP/1.1
Accept: */*

{
  "data": {
    "manifest": "text"
  },
  "status": "SUCCESS"
}

Describe Docker Artifact Manifests

get

Get Docker Artifact Manifests

Path parameters

registry_refstringRequired

Reference to the scope in which the registry exists.

Format depends on the scope:

• Account-level: account_id/registry_name/+
• Organization-level: account_id/org_id/registry_name/+
• Project-level: account_id/org_id/project_id/registry_name/+

The /+ suffix is used internally to route scoped requests. It must be included exactly as shown in the URL.

Example: {"description":"Only account ID, scoped at account level","summary":"Account-level registry","value":"acc123/registry123/+"}

artifactstringRequired

Name of the artifact.

The value depends on whether the name contains a slash (/):

• If the artifact name contains /, append a trailing /+ at the end.
  • Example: mygroup/myartifact/+
• If the artifact name does not contain /, use the plain name.
  • Example: myartifact

This is used internally to distinguish between namespaced and flat artifact names.

Example: {"summary":"Flat artifact name","value":"myartifact"}

versionstringRequired

Name of Artifact Version.

Query parameters

version_typestring · enumOptional

Version Type.

Possible values:

Responses

200

response to get artifact layers

application/json

statusstring · enumRequired

Request processing status indicator

Possible values:

400

The request was invalid or malformed

application/json

401

Authentication failed or missing credentials

application/json

403

Access denied due to insufficient permissions

application/json

404

The requested resource was not found

application/json

500

An unexpected server error occurred

application/json

get/v1/registry/{registry_ref}/artifact/{artifact}/version/{version}/docker/manifests

GET /api/v1/registry/{registry_ref}/artifact/{artifact}/version/{version}/docker/manifests HTTP/1.1
Accept: */*

{
  "data": {
    "imageName": "text",
    "manifests": [
      {
        "createdAt": "text",
        "digest": "text",
        "downloadsCount": 1,
        "isQuarantined": true,
        "osArch": "text",
        "quarantineReason": "text",
        "size": "text",
        "stoDetails": {
          "critical": 1,
          "executionId": "text",
          "high": 1,
          "ignored": 1,
          "info": 1,
          "lastScanned": "text",
          "low": 1,
          "medium": 1,
          "pipelineId": "text",
          "total": 1
        },
        "stoExecutionId": "text",
        "stoPipelineId": "text"
      }
    ],
    "version": "text"
  },
  "status": "SUCCESS"
}