Registry V3 Versions

V3 versions endpoints

List versions of packages

get

Lists versions of packages

Query parameters

account_identifierstringRequired

Unique identifier for the Harness account.

org_identifierstringOptional

Unique identifier for the organization within the account.

Example: default or engineering_org

project_identifierstringOptional

Unique identifier for the project within the organization.

Example: my_project or frontend_services

registry_idsstring · uuid[]Optional

Unique id for the registry. Note: This parameter should have one id if package query param is provided

Example: ["12345678-1234-1234-1234-123456789012","aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"]

package_idsstring · uuid[]Optional

Unique id for the package.

Example: ["12345678-1234-1234-1234-123456789012","aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"]

package_typesstring[]Optional

Registry Package Type

deletedstring · enumOptionalDefault: excludePossible values:

metadatastring[]Optional

Filter by metadata using key:value format

pageinteger · int64Optional

The page number for pagination (0-indexed).

Used to navigate through large result sets. Combined with size parameter to control which subset of results to return.

Example: page=0 returns the first page, page=1 returns the second page

Default: 0

sizeinteger · int64 · min: 1 · max: 100Optional

The number of items to return per page.

Controls the page size for paginated results.

Example: size=50 returns up to 50 items per page

Default: 20

sortstringOptional

The sort for the results. Accepted pattern: sort_field:sort_order where sort_field is the field name and sort_order is either asc or desc.

Examples: name:asc, modifiedAt:desc

search_termstringOptional

Search term for filtering results.

Example: search_term=prod might match keys like "production", "prod-env", etc.

include_metabooleanOptional

When true, include the meta object (e.g. active/deleted counts) in the response.

Default: false

uploaded_byinteger · int64[]Optional

Filter by uploaded by user ID.

Example: uploaded_by=123

Example: 123

Responses

200

response for list versions

application/json

Pagination metadata.

• page selects which page of results to return (0 = first page).
• size controls how many items are returned per page.
• hasMore is true if more results exist after this page.

hasMorebooleanRequired

True if more results exist after this page.

Example: true

pageinteger · int64Required

The current page (0-indexed)

Example: 0

sizeinteger · int64Required

Number of items per page

Example: 20

default

Error response.

application/json

get/v3/versions

GET /api/v3/versions?account_identifier=text HTTP/1.1
Accept: */*

{
  "hasMore": true,
  "page": 0,
  "size": 20,
  "items": [
    {
      "artifactKey": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "createdAt": 1736360000123,
      "createdBy": {
        "display_name": "text",
        "email": "text",
        "type": "text",
        "uid": "text"
      },
      "deletedAt": 1736360000456,
      "deletedBy": {
        "display_name": "text",
        "email": "text",
        "type": "text",
        "uid": "text"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "isQuarantined": true,
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "modifiedAt": 1736360000123,
      "modifiedBy": {
        "display_name": "text",
        "email": "text",
        "type": "text",
        "uid": "text"
      },
      "name": "text",
      "orgIdentifier": "text",
      "packageId": "123e4567-e89b-12d3-a456-426614174000",
      "packageKind": "model",
      "packageName": "text",
      "packageType": "DOCKER",
      "projectIdentifier": "text",
      "pullCommand": "text",
      "pushedBy": {
        "display_name": "text",
        "email": "text",
        "type": "text",
        "uid": "text"
      },
      "quarantineReason": "text",
      "registryId": "123e4567-e89b-12d3-a456-426614174000",
      "registryName": "text",
      "registryType": "VIRTUAL"
    }
  ],
  "meta": {
    "activeCount": 95,
    "deletedCount": 5
  }
}

List Conan Recipe Revisions

get

List finalized Conan recipe revisions for a version.

Path parameters

idstringRequired

Query parameters

account_identifierstringRequired

Unique identifier for the Harness account.

pageinteger · int64Optional

The page number for pagination (0-indexed).

Used to navigate through large result sets. Combined with size parameter to control which subset of results to return.

Example: page=0 returns the first page, page=1 returns the second page

Default: 0

sizeinteger · int64 · min: 1 · max: 100Optional

The number of items to return per page.

Controls the page size for paginated results.

Example: size=50 returns up to 50 items per page

Default: 20

Responses

200

Response to list Conan recipe revisions for a version

application/json

Pagination metadata.

• page selects which page of results to return (0 = first page).
• size controls how many items are returned per page.
• hasMore is true if more results exist after this page.

hasMorebooleanRequired

True if more results exist after this page.

Example: true

pageinteger · int64Required

The current page (0-indexed)

Example: 0

sizeinteger · int64Required

Number of items per page

Example: 20

default

Error response.

application/json

get/v3/versions/{id}/conan/recipe-revisions

GET /api/v3/versions/{id}/conan/recipe-revisions?account_identifier=text HTTP/1.1
Accept: */*

{
  "hasMore": true,
  "page": 0,
  "size": 20,
  "items": [
    {
      "downloadCount": 1,
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "lastDownloadedAt": 1,
      "lastPushedAt": 1,
      "packageCount": 1,
      "recipeRevision": "text",
      "size": "text"
    }
  ]
}

Get Conan Recipe Revision Detail

get

Get a Conan recipe revision (RREV) detail.

Path parameters

idstringRequired

recipe_revision_idstringRequired

The stable UUID of the recipe revision (RREV) row.

Query parameters

account_identifierstringRequired

Unique identifier for the Harness account.

Responses

200

Response to get a Conan recipe revision detail

application/json

default

Error response.

application/json

get/v3/versions/{id}/conan/recipe-revisions/{recipe_revision_id}/details

GET /api/v3/versions/{id}/conan/recipe-revisions/{recipe_revision_id}/details?account_identifier=text HTTP/1.1
Accept: */*

{
  "data": {
    "downloadCount": 1,
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "lastDownloadedAt": 1,
    "lastPushedAt": 1,
    "packageCount": 1,
    "recipeRevision": "text",
    "size": "text"
  }
}

List Conan Packages of a Recipe Revision

get

List the packages (PKGIDs) under a Conan recipe revision.

Path parameters

idstringRequired

recipe_revision_idstringRequired

The stable UUID of the recipe revision (RREV) row.

Query parameters

account_identifierstringRequired

Unique identifier for the Harness account.

pageinteger · int64Optional

The page number for pagination (0-indexed).

Used to navigate through large result sets. Combined with size parameter to control which subset of results to return.

Example: page=0 returns the first page, page=1 returns the second page

Default: 0

sizeinteger · int64 · min: 1 · max: 100Optional

The number of items to return per page.

Controls the page size for paginated results.

Example: size=50 returns up to 50 items per page

Default: 20

Responses

200

Response to list Conan packages of a recipe revision

application/json

Pagination metadata.

• page selects which page of results to return (0 = first page).
• size controls how many items are returned per page.
• hasMore is true if more results exist after this page.

hasMorebooleanRequired

True if more results exist after this page.

Example: true

pageinteger · int64Required

The current page (0-indexed)

Example: 0

sizeinteger · int64Required

Number of items per page

Example: 20

default

Error response.

application/json

get/v3/versions/{id}/conan/recipe-revisions/{recipe_revision_id}/packages

GET /api/v3/versions/{id}/conan/recipe-revisions/{recipe_revision_id}/packages?account_identifier=text HTTP/1.1
Accept: */*

{
  "hasMore": true,
  "page": 0,
  "size": 20,
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "latestPackageRevision": "text",
      "options": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "packageId": "text",
      "settings": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "size": "text"
    }
  ]
}

Get Conan Package Detail

get

Get a Conan package (PKGID) detail with its package revisions.

Path parameters

idstringRequired

recipe_revision_idstringRequired

The stable UUID of the recipe revision (RREV) row.

package_idstringRequired

The stable UUID of the package (PKGID) row.

Query parameters

account_identifierstringRequired

Unique identifier for the Harness account.

Responses

200

Response to get a Conan package detail

application/json

default

Error response.

application/json

get/v3/versions/{id}/conan/recipe-revisions/{recipe_revision_id}/packages/{package_id}/details

GET /api/v3/versions/{id}/conan/recipe-revisions/{recipe_revision_id}/packages/{package_id}/details?account_identifier=text HTTP/1.1
Accept: */*

{
  "data": {
    "downloadCount": 1,
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "lastDownloadedAt": 1,
    "options": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "packageId": "text",
    "packageRevisionCount": 1,
    "recipeRevision": "text",
    "settings": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "size": "text"
  }
}

List Conan Package Revisions of a Package

get

List the package revisions (PREVs) under a Conan package.

Path parameters

idstringRequired

recipe_revision_idstringRequired

The stable UUID of the recipe revision (RREV) row.

package_idstringRequired

The stable UUID of the package (PKGID) row.

Query parameters

account_identifierstringRequired

Unique identifier for the Harness account.

pageinteger · int64Optional

The page number for pagination (0-indexed).

Used to navigate through large result sets. Combined with size parameter to control which subset of results to return.

Example: page=0 returns the first page, page=1 returns the second page

Default: 0

sizeinteger · int64 · min: 1 · max: 100Optional

The number of items to return per page.

Controls the page size for paginated results.

Example: size=50 returns up to 50 items per page

Default: 20

Responses

200

Response to list Conan package revisions of a package

application/json

Pagination metadata.

• page selects which page of results to return (0 = first page).
• size controls how many items are returned per page.
• hasMore is true if more results exist after this page.

hasMorebooleanRequired

True if more results exist after this page.

Example: true

pageinteger · int64Required

The current page (0-indexed)

Example: 0

sizeinteger · int64Required

Number of items per page

Example: 20

default

Error response.

application/json

get/v3/versions/{id}/conan/recipe-revisions/{recipe_revision_id}/packages/{package_id}/package-revisions

GET /api/v3/versions/{id}/conan/recipe-revisions/{recipe_revision_id}/packages/{package_id}/package-revisions?account_identifier=text HTTP/1.1
Accept: */*

{
  "hasMore": true,
  "page": 0,
  "size": 20,
  "items": [
    {
      "createdAt": 1736360000123,
      "downloadCount": 1,
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "lastDownloadedAt": 1,
      "packageRevision": "text",
      "size": "text"
    }
  ]
}

Get Conan Package Revision Detail

get

Get a Conan package revision (PREV) detail.

Path parameters

idstringRequired

recipe_revision_idstringRequired

The stable UUID of the recipe revision (RREV) row.

package_idstringRequired

The stable UUID of the package (PKGID) row.

package_revision_idstringRequired

The stable UUID of the package revision (PREV) row.

Query parameters

account_identifierstringRequired

Unique identifier for the Harness account.

Responses

200

Response to get a Conan package revision detail

application/json

default

Error response.

application/json

get/v3/versions/{id}/conan/recipe-revisions/{recipe_revision_id}/packages/{package_id}/package-revisions/{package_revision_id}/details

GET /api/v3/versions/{id}/conan/recipe-revisions/{recipe_revision_id}/packages/{package_id}/package-revisions/{package_revision_id}/details?account_identifier=text HTTP/1.1
Accept: */*

{
  "data": {
    "createdAt": 1736360000123,
    "downloadCount": 1,
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "lastDownloadedAt": 1,
    "packageRevision": "text",
    "size": "text"
  }
}

List deployments for a version

get

List Harness CD deployments for a specific version. Returns the environments and services that are actively running this version, together with aggregate prod/non-prod counts in meta. For OCI-based package types (DOCKER, HELM) the artifact is identified by image:tag — supply package_tag or an empty response is returned. For all other package types the artifact is identified by package_name/version_name.

Path parameters

idstringRequired

Query parameters

account_identifierstringRequired

Unique identifier for the Harness account.

env_typestring · enumOptional

Filter by environment type. Allowed values: PRODUCTION, PRE_PRODUCTION.

Possible values:

pageinteger · int64Optional

The page number for pagination (0-indexed).

Used to navigate through large result sets. Combined with size parameter to control which subset of results to return.

Example: page=0 returns the first page, page=1 returns the second page

Default: 0

sizeinteger · int64 · min: 1 · max: 100Optional

The number of items to return per page.

Controls the page size for paginated results.

Example: size=50 returns up to 50 items per page

Default: 20

sortstringOptional

The sort for the results. Accepted pattern: sort_field:sort_order where sort_field is the field name and sort_order is either asc or desc.

Examples: name:asc, modifiedAt:desc

search_termstringOptional

Search term for filtering results.

Example: search_term=prod might match keys like "production", "prod-env", etc.

package_tagstringOptional

Tag to use when identifying the artifact in CD. Currently used for Docker images: provide the tag (e.g. latest) so the artifact is resolved as image:tag. For OCI-based package types (DOCKER, HELM), if this parameter is omitted no deployment data is returned.

Responses

200

Paginated list of Harness CD deployments for a version

application/json

Pagination metadata.

• page selects which page of results to return (0 = first page).
• size controls how many items are returned per page.
• hasMore is true if more results exist after this page.

hasMorebooleanRequired

True if more results exist after this page.

Example: true

pageinteger · int64Required

The current page (0-indexed)

Example: 0

sizeinteger · int64Required

Number of items per page

Example: 20

default

Error response.

application/json

get/v3/versions/{id}/deployments

GET /api/v3/versions/{id}/deployments?account_identifier=text HTTP/1.1
Accept: */*

{
  "hasMore": true,
  "page": 0,
  "size": 20,
  "items": [
    {
      "envIdentifier": "text",
      "envName": "text",
      "envType": "PRODUCTION",
      "infraIdentifier": "text",
      "infraName": "text",
      "instanceCount": 1,
      "lastDeployedAt": 1,
      "lastDeployedBy": {
        "display_name": "text",
        "email": "text",
        "type": "text",
        "uid": "text"
      },
      "orgIdentifier": "text",
      "pipelineExecutionId": "text",
      "pipelineExecutionName": "text",
      "projectIdentifier": "text",
      "serviceIdentifier": "text",
      "serviceName": "text"
    }
  ],
  "meta": {
    "nonProdEnvCount": 1,
    "prodEnvCount": 1
  }
}

Get Version Metadata

get

Retrieves all metadata for a version.

Path parameters

idstringRequired

Query parameters

account_identifierstringRequired

Unique identifier for the Harness account.

Responses

200

Response containing all metadata entries for the requested entity

application/json

default

Error response.

application/json

get/v3/versions/{id}/metadata

GET /api/v3/versions/{id}/metadata?account_identifier=text HTTP/1.1
Accept: */*

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "key": "environment",
      "type": "MANUAL",
      "value": "production"
    }
  ]
}

Upsert Version Metadata

post

Creates or overwrites metadata for a version.

Path parameters

idstringRequired

Query parameters

account_identifierstringRequired

Unique identifier for the Harness account.

Body

Request payload containing metadata key-value pairs to add or update.

Responses

200

Response containing all metadata entries for the requested entity

application/json

default

Error response.

application/json

post/v3/versions/{id}/metadata

POST /api/v3/versions/{id}/metadata?account_identifier=text HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 90

{
  "metadata": [
    {
      "key": "environment",
      "value": "production"
    },
    {
      "key": "team",
      "value": "backend"
    }
  ]
}

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "key": "environment",
      "type": "MANUAL",
      "value": "production"
    }
  ]
}

Replace Version Metadata

put

Replaces all metadata for a version.

Path parameters

idstringRequired

Query parameters

account_identifierstringRequired

Unique identifier for the Harness account.

Body

Request payload containing metadata key-value pairs to add or update.

Responses

200

Response containing all metadata entries for the requested entity

application/json

default

Error response.

application/json

put/v3/versions/{id}/metadata

PUT /api/v3/versions/{id}/metadata?account_identifier=text HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 90

{
  "metadata": [
    {
      "key": "environment",
      "value": "production"
    },
    {
      "key": "team",
      "value": "backend"
    }
  ]
}

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "key": "environment",
      "type": "MANUAL",
      "value": "production"
    }
  ]
}

Add tags to version of package

post

Add tags to version of package. Currently supported for only OCI package.

Path parameters

idstringRequired

Query parameters

account_identifierstringRequired

Unique identifier for the Harness account.

Body

tagsstring[]Required

Responses

204

Tags added successfully

No content

default

Error response.

application/json

post/v3/versions/{id}/tags

POST /api/v3/versions/{id}/tags?account_identifier=text HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "tags": [
    "text"
  ]
}

No content

Rebuild metadata for all versions in a registry

post

Trigger metadata rebuild for all versions in a registry

Query parameters

account_identifierstringRequired

Unique identifier for the Harness account.

Body

Request to rebuild metadata for all versions in a registry

registryIdstringRequired

UUID of the registry to rebuild metadata for

Responses

202

Rebuild metadata request accepted for processing

No content

default

Error response.

application/json

post/v3/versions/rebuild-metadata

POST /api/v3/versions/rebuild-metadata?account_identifier=text HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "registryId": "text"
}

No content

Get statistics for multiple versions

post

Get statistics (deploymentMetadata, downloadCount, fileCount, scanStatus, scanID, size, artifactKey) for a list of versions by their UUIDs.

Query parameters

account_identifierstringRequired

Unique identifier for the Harness account.

org_identifierstringOptional

Unique identifier for the organization within the account.

Example: default or engineering_org

project_identifierstringOptional

Unique identifier for the project within the organization.

Example: my_project or frontend_services

Body

Request input for fetching version statistics

versionIdsstring · uuid[] · max: 100Required

List of version UUIDs to fetch statistics for

Responses

200

Response containing statistics for the requested versions

application/json

Response body containing version statistics

default

Error response.

application/json

post/v3/versions/stats

POST /api/v3/versions/stats?account_identifier=text HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 55

{
  "versionIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

{
  "items": [
    {
      "deploymentMetadata": {
        "nonProdEnvCount": 1,
        "prodEnvCount": 1
      },
      "digestCount": 1,
      "downloadCount": 1,
      "fileCount": 1,
      "firewallMode": "ENABLED",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "lastScannedAt": "text",
      "scanID": "123e4567-e89b-12d3-a456-426614174000",
      "scanStatus": "ALLOWED",
      "size": "text"
    }
  ]
}