AI Model Hub for free till June 30, 2025.
Try now
Test nowLog inShare Feedback

Artifacts

Artifacts are the individual files stored in a repository

This tag groups all operations for artifacts.

Retrieve all Artifacts by Registry

get

This endpoint enables retrieving all Artifacts using pagination and optional filters.

Authorizations
Path parameters
registryIdstring · uuidRequired

The ID (UUID) of the Registry.

Example: 1e41a73c-59d0-5507-86dd-fa2fc2501cfd
Query parameters
offsetinteger · int32Optional

The first element (of the total list of elements) to include in the response. Use together with limit for pagination.

Default: 0Example: 0
limitinteger · int32 · min: 1 · max: 1000Optional

The maximum number of elements to return. Use together with offset for pagination.

Default: 100Example: 100
filter.vulnerabilityIdstringOptional

Filter resources by vulnerabilityId.

orderBystring · enumOptional

The field to order the results by. If not provided, the results will be ordered by the default field.

Default: -pullCountPossible values:
Responses
200
Returned all requested Artifacts successfully.
application/json
get
GET /containerregistries/registries/{registryId}/artifacts HTTP/1.1
Host: api.ionos.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": "artifacts",
  "type": "collection",
  "href": "https://api.ionos.com/containerregistries/registries/artifacts",
  "items": [
    {
      "id": "sha256:12345678901234567890123456789012",
      "type": "artifact",
      "href": "https://api.ionos.com/containerregistries/registries/f39c94e6-e84b-4d25-b54f-75e4289be43c/repositories/my-service/artifacts/sha256:12345678901234567890123456789012",
      "metadata": {
        "createdDate": "2020-12-10T13:37:50+01:00",
        "createdBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
        "createdByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
        "lastModifiedDate": "2020-12-11T13:37:50+01:00",
        "lastModifiedBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
        "lastModifiedByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
        "resourceURN": "ionos:<product>:<location>:<contract>:<resource-path>",
        "lastPushedAt": "2025-07-17T03:21:41.973Z",
        "lastPulledAt": "2025-07-17T03:21:41.973Z",
        "lastScannedAt": "2025-07-17T03:21:41.973Z",
        "pushCount": 1,
        "pullCount": 42,
        "vulnMaxSeverity": "high",
        "vulnTotalScore": 9.8,
        "vulnTotalCount": 20,
        "vulnFixableCount": 10
      },
      "properties": {
        "repositoryName": "my-service",
        "digest": "sha256:12345678901234567890123456789012",
        "tags": [
          "latest",
          "1.0.0"
        ],
        "mediaType": "application/vnd.oci.image.manifest.v1+json"
      }
    }
  ],
  "offset": 0,
  "limit": 42,
  "_links": {
    "prev": "http://PREVIOUS-PAGE-URI",
    "self": "http://THIS-PAGE-URI",
    "next": "http://NEXT-PAGE-URI"
  }
}

Retrieve all Artifacts by Repository

get

This endpoint enables retrieving all Artifacts using pagination and optional filters.

Authorizations
Path parameters
registryIdstring · uuidRequired

The ID (UUID) of the Registry.

Example: 1e41a73c-59d0-5507-86dd-fa2fc2501cfd
repositoryNamestring · max: 256Required

The Name of the Repository.

Example: my-service
Query parameters
offsetinteger · int32Optional

The first element (of the total list of elements) to include in the response. Use together with limit for pagination.

Default: 0Example: 0
limitinteger · int32 · min: 1 · max: 1000Optional

The maximum number of elements to return. Use together with offset for pagination.

Default: 100Example: 100
orderBystring · enumOptional

The field to order the results by. If not provided, the results will be ordered by the default field.

Default: -lastPushPossible values:
Responses
200
Returned all requested Artifacts successfully.
application/json
get
GET /containerregistries/registries/{registryId}/repositories/{repositoryName}/artifacts HTTP/1.1
Host: api.ionos.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": "artifacts",
  "type": "collection",
  "href": "https://api.ionos.com/containerregistries/registries/f39c94e6-e84b-4d25-b54f-75e4289be43c/repositories/my-service/artifacts",
  "items": [
    {
      "id": "sha256:12345678901234567890123456789012",
      "type": "artifact",
      "href": "https://api.ionos.com/containerregistries/registries/f39c94e6-e84b-4d25-b54f-75e4289be43c/repositories/my-service/artifacts/sha256:12345678901234567890123456789012",
      "metadata": {
        "createdDate": "2020-12-10T13:37:50+01:00",
        "createdBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
        "createdByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
        "lastModifiedDate": "2020-12-11T13:37:50+01:00",
        "lastModifiedBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
        "lastModifiedByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
        "resourceURN": "ionos:<product>:<location>:<contract>:<resource-path>",
        "lastPushedAt": "2025-07-17T03:21:41.973Z",
        "lastPulledAt": "2025-07-17T03:21:41.973Z",
        "lastScannedAt": "2025-07-17T03:21:41.973Z",
        "pushCount": 1,
        "pullCount": 42,
        "vulnMaxSeverity": "high",
        "vulnTotalScore": 9.8,
        "vulnTotalCount": 20,
        "vulnFixableCount": 10
      },
      "properties": {
        "repositoryName": "my-service",
        "digest": "sha256:12345678901234567890123456789012",
        "tags": [
          "latest",
          "1.0.0"
        ],
        "mediaType": "application/vnd.oci.image.manifest.v1+json"
      }
    }
  ],
  "offset": 0,
  "limit": 42,
  "_links": {
    "prev": "http://PREVIOUS-PAGE-URI",
    "self": "http://THIS-PAGE-URI",
    "next": "http://NEXT-PAGE-URI"
  }
}

Retrieve Artifact

get

Returns the Artifact by Digest.

Authorizations
Path parameters
registryIdstring · uuidRequired

The ID (UUID) of the Registry.

Example: 1e41a73c-59d0-5507-86dd-fa2fc2501cfd
repositoryNamestring · max: 256Required

The Name of the Repository.

Example: my-service
digeststring · max: 128Required

The Digest of the Artifact.

Example: sha256:12345678901234567890123456789012
Responses
200
Getting Artifact was successful.
application/json
get
GET /containerregistries/registries/{registryId}/repositories/{repositoryName}/artifacts/{digest} HTTP/1.1
Host: api.ionos.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": "sha256:12345678901234567890123456789012",
  "type": "artifact",
  "href": "https://api.ionos.com/containerregistries/registries/f39c94e6-e84b-4d25-b54f-75e4289be43c/repositories/my-service/artifacts/sha256:12345678901234567890123456789012",
  "metadata": {
    "createdDate": "2020-12-10T13:37:50+01:00",
    "createdBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "createdByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "lastModifiedDate": "2020-12-11T13:37:50+01:00",
    "lastModifiedBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "lastModifiedByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "resourceURN": "ionos:<product>:<location>:<contract>:<resource-path>",
    "lastPushedAt": "2025-07-17T03:21:41.973Z",
    "lastPulledAt": "2025-07-17T03:21:41.973Z",
    "lastScannedAt": "2025-07-17T03:21:41.973Z",
    "pushCount": 1,
    "pullCount": 42,
    "vulnMaxSeverity": "high",
    "vulnTotalScore": 9.8,
    "vulnTotalCount": 20,
    "vulnFixableCount": 10
  },
  "properties": {
    "repositoryName": "my-service",
    "digest": "sha256:12345678901234567890123456789012",
    "tags": [
      "latest",
      "1.0.0"
    ],
    "mediaType": "application/vnd.oci.image.manifest.v1+json"
  }
}

Retrieve all Vulnerabilities

get

This endpoint enables retrieving all Vulnerabilities using pagination and optional filters.

Authorizations
Path parameters
registryIdstring · uuidRequired

The ID (UUID) of the Registry.

Example: 1e41a73c-59d0-5507-86dd-fa2fc2501cfd
repositoryNamestring · max: 256Required

The Name of the Repository.

Example: my-service
digeststring · max: 128Required

The Digest of the Artifact.

Example: sha256:12345678901234567890123456789012
Query parameters
offsetinteger · int32Optional

The first element (of the total list of elements) to include in the response. Use together with limit for pagination.

Default: 0Example: 0
limitinteger · int32 · min: 1 · max: 1000Optional

The maximum number of elements to return. Use together with offset for pagination.

Default: 100Example: 100
filter.severitystringOptional

The CVSS vulnerability severity rating

Example: high
filter.fixablebooleanOptional

Filter resources by fixable (i.e. remediation action is available)

orderBystring · enumOptional

The field to order the results by. If not provided, the results will be ordered by the default field.

Default: -scorePossible values:
Responses
200
Returned all requested Vulnerabilities successfully.
application/json
get
GET /containerregistries/registries/{registryId}/repositories/{repositoryName}/artifacts/{digest}/vulnerabilities HTTP/1.1
Host: api.ionos.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": "vulnerabilities",
  "type": "collection",
  "href": "https://api.ionos.com/containerregistries/registries/f39c94e6-e84b-4d25-b54f-75e4289be43c/repositories/my-service/artifacts/sha256:12345678901234567890123456789012/vulnerabilities",
  "items": [
    {
      "id": "CVE-2019-1234",
      "type": "vulnerability",
      "href": "https://api.ionos.com/containerregistries/vulnerabilities/CVE-2019-1234",
      "metadata": {
        "publishedAt": "2019-01-01T00:00:00+00:00",
        "updatedAt": "2019-01-01T00:00:00+00:00"
      },
      "properties": {
        "description": "A vulnerability in the web UI of Cisco IOS XE Software could allow an authenticated, remote attacker to execute commands on the underlying Linux shell of an affected device with root privileges.",
        "recommendations": "Cisco has released software updates that address this vulnerability. There are no workarounds that address this vulnerability.",
        "dataSource": {
          "id": "osv",
          "url": "https://github.com/pypa/advisory-db"
        },
        "fixable": true,
        "affects": [
          {
            "type": "maven",
            "name": "org.apache.commons:commons-lang3",
            "version": "3.8.1"
          }
        ],
        "references": [
          "https://access.redhat.com/security/cve/CVE-2019-1234"
        ],
        "severity": "high",
        "score": 9.8
      }
    }
  ],
  "offset": 0,
  "limit": 42,
  "_links": {
    "prev": "http://PREVIOUS-PAGE-URI",
    "self": "http://THIS-PAGE-URI",
    "next": "http://NEXT-PAGE-URI"
  }
}
PreviousRepositoriesNextVulnerabilities

Was this helpful?