Ctrlk
Sign UpGet a DemoContact Us
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Artifacts

APIs to get, list artifacts

Redirect to Harness Artifact Page

get

Redirect to Harness Artifact Page

Path parameters
registry_identifierstringRequired

Unique registry Identifier in a account.

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"}
Query parameters
accountIdentifierstringOptional

Account Identifier

versionstringOptional

Version

Responses
302

Temporary Redirect

get/v1/registry/{registry_identifier}/artifact/{artifact}/redirect
GET /api/v1/registry/{registry_identifier}/artifact/{artifact}/redirect HTTP/1.1
Accept: */*

No content

Delete Artifact

delete

Delete Artifact.

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"}
Query parameters
artifact_typestring · enumOptional

artifact type.

Possible values:
Responses
200

Generic success response

application/json
statusstring · enumRequired

Request processing status indicator

Possible values:
delete/v1/registry/{registry_ref}/artifact/{artifact}
DELETE /api/v1/registry/{registry_ref}/artifact/{artifact} HTTP/1.1
Accept: */*

{
  "status": "SUCCESS"
}

Update Artifact Labels

put

Update Artifact Labels.

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"}
Query parameters
artifact_typestring · enumOptional

artifact type.

Possible values:
Body
labelsstring[]Required
Responses
200

response to get artifact label response

application/json
statusstring · enumRequired

Request processing status indicator

Possible values:
put/v1/registry/{registry_ref}/artifact/{artifact}/labels
PUT /api/v1/registry/{registry_ref}/artifact/{artifact}/labels HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "labels": [
    "text"
  ]
}
{
  "data": {
    "artifactType": "model",
    "createdAt": "text",
    "deletedAt": "text",
    "downloadsCount": 1,
    "imageName": "text",
    "labels": [
      "text"
    ],
    "modifiedAt": "text",
    "packageType": "DOCKER",
    "registryUUID": "text",
    "uuid": "text"
  },
  "status": "SUCCESS"
}

Get Artifact Stats

get

Get Artifact Stats.

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"}
Query parameters
fromstringOptional

Date. Format - MM/DD/YYYY

tostringOptional

Date. Format - MM/DD/YYYY

Responses
200

response to get artifact stats response

application/json
statusstring · enumRequired

Request processing status indicator

Possible values:
get/v1/registry/{registry_ref}/artifact/{artifact}/stats
GET /api/v1/registry/{registry_ref}/artifact/{artifact}/stats HTTP/1.1
Accept: */*

{
  "data": {
    "downloadCount": 1,
    "downloadSize": 1,
    "totalStorageSize": 1,
    "uploadSize": 1
  },
  "status": "SUCCESS"
}

Get Artifact Summary

get

Get Artifact Summary.

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"}
Query parameters
artifact_typestring · enumOptional

artifact type.

Possible values:
Responses
200

response to get artifact summary

application/json
statusstring · enumRequired

Request processing status indicator

Possible values:
get/v1/registry/{registry_ref}/artifact/{artifact}/summary
GET /api/v1/registry/{registry_ref}/artifact/{artifact}/summary HTTP/1.1
Accept: */*

{
  "data": {
    "artifactType": "model",
    "createdAt": "text",
    "deletedAt": "text",
    "downloadsCount": 1,
    "imageName": "text",
    "labels": [
      "text"
    ],
    "modifiedAt": "text",
    "packageType": "DOCKER",
    "registryUUID": "text",
    "uuid": "text"
  },
  "status": "SUCCESS"
}

List OCI Artifact tags

get

Lists OCI Artifact Tags.

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"}
Query parameters
pageinteger · int64Optional

Current page number

Default: 1
sizeinteger · int64Optional

Number of items per page

Default: 20
search_termstringOptional

search Term.

Responses
200

response for list tags info of an OCI artifact

application/json
statusstring · enumRequired

Request processing status indicator

Possible values:
get/v1/registry/{registry_ref}/artifact/{artifact}/tags
GET /api/v1/registry/{registry_ref}/artifact/{artifact}/tags HTTP/1.1
Accept: */*

{
  "data": {
    "itemCount": 1,
    "ociArtifactTags": [
      {
        "digest": "text",
        "name": "text"
      }
    ],
    "pageCount": 100,
    "pageIndex": 0,
    "pageSize": 1
  },
  "status": "SUCCESS"
}

Delete an Artifact Version

delete

Delete Artifact Version.

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
artifact_typestring · enumOptional

artifact type.

Possible values:
filtersstring[]Optional

Key-value filters for artifact version. Repeat the parameter once per filter. Format per entry: key:value Example: ?filters=architecture:amd64&filters=distribution:ubuntu

Example: architecture:amd64
Responses
200

Generic success response

application/json
statusstring · enumRequired

Request processing status indicator

Possible values:
delete/v1/registry/{registry_ref}/artifact/{artifact}/version/{version}
DELETE /api/v1/registry/{registry_ref}/artifact/{artifact}/version/{version} HTTP/1.1
Accept: */*

{
  "status": "SUCCESS"
}

Create a bulk download request

get

Create a bulk download request

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.

Responses
200

Response containing status of bulk download operation

application/json
statusstring · enumRequired

Request processing status indicator

Possible values:
get/v1/registry/{registry_ref}/artifact/{artifact}/version/{version}/bulk-download
GET /api/v1/registry/{registry_ref}/artifact/{artifact}/version/{version}/bulk-download HTTP/1.1
Accept: */*

{
  "data": {
    "downloadId": "12345678-1234-1234-1234-123456789012"
  },
  "status": "SUCCESS"
}

Describe Artifact Deployments

get

Get Artifact Deployments

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
env_typestring · enumOptional

Environment Type

Possible values:
pageinteger · int64Optional

Current page number

Default: 1
sizeinteger · int64Optional

Number of items per page

Default: 20
sort_orderstringOptional

sortOrder

sort_fieldstringOptional

sortField

search_termstringOptional

search Term.

version_typestring · enumOptional

Version Type.

Possible values:
Responses
200

response to get docker artifact deployments details

application/json
statusstring · enumRequired

Request processing status indicator

Possible values:
get/v1/registry/{registry_ref}/artifact/{artifact}/version/{version}/deploymentdetails
GET /api/v1/registry/{registry_ref}/artifact/{artifact}/version/{version}/deploymentdetails HTTP/1.1
Accept: */*

{
  "data": {
    "deployments": {
      "deployments": [
        {
          "count": 1,
          "envIdentifier": "text",
          "envName": "text",
          "envType": "PreProduction",
          "infraIdentifier": "text",
          "infraName": "text",
          "lastDeployedAt": "text",
          "lastDeployedById": "text",
          "lastDeployedByName": "text",
          "lastPipelineExecutionId": "text",
          "lastPipelineExecutionName": "text",
          "orgIdentifier": "text",
          "pipelineId": "text",
          "projectIdentifier": "text",
          "serviceIdentifier": "text",
          "serviceName": "text"
        }
      ],
      "itemCount": 1,
      "pageCount": 100,
      "pageIndex": 0,
      "pageSize": 1
    },
    "deploymentsStats": {
      "PreProduction": 1,
      "Production": 1
    }
  },
  "status": "SUCCESS"
}

Describe Artifact Details

get

Get 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
artifact_typestring · enumOptional

artifact type.

Possible values:
childVersionstringOptional

Child version incase of Docker artifacts.

filtersstring[]Optional

Key-value filters for artifact version. Repeat the parameter once per filter. Format per entry: key:value Example: ?filters=architecture:amd64&filters=distribution:ubuntu

Example: architecture:amd64
Responses
200

response to get artifact details

application/json
statusstring · enumRequired

Request processing status indicator

Possible values:
get/v1/registry/{registry_ref}/artifact/{artifact}/version/{version}/details
GET /api/v1/registry/{registry_ref}/artifact/{artifact}/version/{version}/details HTTP/1.1
Accept: */*

{
  "data": {
    "artifactKey": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "artifactType": "model",
    "createdAt": "text",
    "createdBy": {
      "display_name": "text",
      "email": "text",
      "type": "text",
      "uid": "text"
    },
    "deletedAt": "text",
    "downloadCount": 1,
    "isQuarantined": true,
    "modifiedAt": "text",
    "name": "text",
    "packageType": "DOCKER",
    "quarantineReason": "text",
    "size": "text",
    "version": "text",
    "pullCommand": "text"
  },
  "status": "SUCCESS"
}

Get Artifact file

get

just validate existence of Artifact file

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.

file_namestringRequired

Name of Artifact File.

Query parameters
artifact_typestring · enumOptional

artifact type.

Possible values:
filtersstring[]Optional

Key-value filters for artifact version. Repeat the parameter once per filter. Format per entry: key:value Example: ?filters=architecture:amd64&filters=distribution:ubuntu

Example: architecture:amd64
Responses
200

response to head artifact file

application/json
downloadUrlstringRequired

download url of artifact

statusstring · enumRequired

Request processing status indicator

Possible values:
get/v1/registry/{registry_ref}/artifact/{artifact}/version/{version}/file/{file_name}
GET /api/v1/registry/{registry_ref}/artifact/{artifact}/version/{version}/file/{file_name} HTTP/1.1
Accept: */*

{
  "downloadUrl": "text",
  "status": "SUCCESS"
}

Describe Artifact files

get

Get Artifact files

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
artifact_typestring · enumOptional

artifact type.

Possible values:
pageinteger · int64Optional

Current page number

Default: 1
sizeinteger · int64Optional

Number of items per page

Default: 20
sort_orderstringOptional

sortOrder

sort_fieldstringOptional

sortField

search_termstringOptional

search Term.

filtersstring[]Optional

Key-value filters for artifact version. Repeat the parameter once per filter. Format per entry: key:value Example: ?filters=architecture:amd64&filters=distribution:ubuntu

Example: architecture:amd64
Responses
200

response to get artifact files

application/json
statusstring · enumRequired

Request processing status indicator

Possible values:
get/v1/registry/{registry_ref}/artifact/{artifact}/version/{version}/files
GET /api/v1/registry/{registry_ref}/artifact/{artifact}/version/{version}/files HTTP/1.1
Accept: */*

{
  "data": {
    "files": [
      {
        "checksums": [
          "text"
        ],
        "createdAt": "text",
        "downloadCommand": "text",
        "name": "text",
        "path": "text",
        "size": "text"
      }
    ],
    "itemCount": 1,
    "pageCount": 100,
    "pageIndex": 0,
    "pageSize": 1
  },
  "status": "SUCCESS"
}

Get Artifact Version Summary

get

Get Artifact Version Summary.

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
artifact_typestring · enumOptional

artifact type.

Possible values:
digeststringOptional

Digest.

filtersstring[]Optional

Key-value filters for artifact version. Repeat the parameter once per filter. Format per entry: key:value Example: ?filters=architecture:amd64&filters=distribution:ubuntu

Example: architecture:amd64
Responses
200

response to get docker artifact version summary

application/json
statusstring · enumRequired

Request processing status indicator

Possible values:
get/v1/registry/{registry_ref}/artifact/{artifact}/version/{version}/summary
GET /api/v1/registry/{registry_ref}/artifact/{artifact}/version/{version}/summary HTTP/1.1
Accept: */*

{
  "data": {
    "artifactKey": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "artifactType": "model",
    "deletedAt": "text",
    "firewallMode": "ENABLED",
    "imageName": "text",
    "imageUUID": "text",
    "isQuarantined": true,
    "lastScannedAt": "text",
    "packageType": "DOCKER",
    "purl": "text",
    "quarantineReason": "text",
    "registryType": "VIRTUAL",
    "registryUUID": "text",
    "scanId": "text",
    "scanStatus": "WARN",
    "sscaArtifactId": "text",
    "sscaArtifactSourceId": "text",
    "stoExecutionId": "text",
    "stoPipelineId": "text",
    "uuid": "text",
    "version": "text"
  },
  "status": "SUCCESS"
}

List Artifact Versions

get

Lists all the Artifact Versions.

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"}
Query parameters
artifact_typestring · enumOptional

artifact type.

Possible values:
pageinteger · int64Optional

Current page number

Default: 1
sizeinteger · int64Optional

Number of items per page

Default: 20
sort_orderstringOptional

sortOrder

sort_fieldstringOptional

sortField

search_termstringOptional

search Term.

deletedstring · enumOptional

Filter for soft-deleted entities

Default: excludePossible values:
Responses
200

response for list versions of artifact

application/json
statusstring · enumRequired

Request processing status indicator

Possible values:
get/v1/registry/{registry_ref}/artifact/{artifact}/versions
GET /api/v1/registry/{registry_ref}/artifact/{artifact}/versions HTTP/1.1
Accept: */*

{
  "data": {
    "artifactVersions": [
      {
        "artifactKey": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "artifactType": "model",
        "deletedAt": "text",
        "deploymentMetadata": {
          "nonProdEnvCount": 1,
          "prodEnvCount": 1
        },
        "digestCount": 1,
        "downloadsCount": 1,
        "fileCount": 1,
        "firewallMode": "ENABLED",
        "isQuarantined": true,
        "lastModified": "text",
        "lastScannedAt": "text",
        "metadata": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "name": "text",
        "opaMetadataValidation": true,
        "packageType": "DOCKER",
        "pullCommand": "text",
        "quarantineReason": "text",
        "registryIdentifier": "text",
        "registryPath": "text",
        "registryType": "VIRTUAL",
        "registryUUID": "text",
        "scanId": "text",
        "scanStatus": "WARN",
        "size": "text",
        "uuid": "text"
      }
    ],
    "itemCount": 1,
    "pageCount": 100,
    "pageIndex": 0,
    "pageSize": 1
  },
  "status": "SUCCESS"
}

List Artifact Labels

get

List Artifact Labels.

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/+"}
Query parameters
pageinteger · int64Optional

Current page number

Default: 1
sizeinteger · int64Optional

Number of items per page

Default: 20
search_termstringOptional

search Term.

Responses
200

response for list artifact labels

application/json
statusstring · enumRequired

Request processing status indicator

Possible values:
get/v1/registry/{registry_ref}/artifact/labels
GET /api/v1/registry/{registry_ref}/artifact/labels HTTP/1.1
Accept: */*

{
  "data": {
    "itemCount": 1,
    "labels": [
      "text"
    ],
    "pageCount": 100,
    "pageIndex": 0,
    "pageSize": 1
  },
  "status": "SUCCESS"
}

Get Artifact Stats

get

Get Artifact Stats.

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/+"}
Query parameters
fromstringOptional

Date. Format - MM/DD/YYYY

tostringOptional

Date. Format - MM/DD/YYYY

Responses
200

response to get artifact stats response

application/json
statusstring · enumRequired

Request processing status indicator

Possible values:
get/v1/registry/{registry_ref}/artifact/stats
GET /api/v1/registry/{registry_ref}/artifact/stats HTTP/1.1
Accept: */*

{
  "data": {
    "downloadCount": 1,
    "downloadSize": 1,
    "totalStorageSize": 1,
    "uploadSize": 1
  },
  "status": "SUCCESS"
}
PreviousRegistries
NextDocker Artifacts

Last updated

Was this helpful?