Registry V3 Registries

V3 registries endpoints

List registries

get

Lists registries.

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

package_typesstring[]Optional

Registry Package Type

typestring · enumOptional

Registry Type

Possible values:

metadatastring[]Optional

Filter by metadata using key:value format

scopestring · enumOptional

Scope of registries to list

• none – current space only (default) * ancestors – current space plus all parent spaces * descendants – current space plus all child spaces
  If omitted, none is assumed.

Possible values:

deletedstring · enumOptionalDefault: excludePossible 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.

include_metabooleanOptional

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

Default: false

Responses

200

response for list registry

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/registries

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

{
  "hasMore": true,
  "page": 0,
  "size": 20,
  "items": [
    {
      "deletedAt": 1736360000456,
      "deletedBy": {
        "display_name": "text",
        "email": "text",
        "type": "text",
        "uid": "text"
      },
      "description": "text",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "isPublic": true,
      "modifiedAt": 1736360000123,
      "modifiedBy": {
        "display_name": "text",
        "email": "text",
        "type": "text",
        "uid": "text"
      },
      "name": "text",
      "orgIdentifier": "text",
      "packageType": "DOCKER",
      "path": "text",
      "projectIdentifier": "text",
      "type": "VIRTUAL",
      "url": "text"
    }
  ],
  "meta": {
    "activeCount": 95,
    "deletedCount": 5
  }
}

Get Registry Metadata

get

Retrieves all metadata for a registry.

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/registries/{id}/metadata

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

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

Upsert Registry Metadata

post

Creates or overwrites metadata for a registry.

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/registries/{id}/metadata

POST /api/v3/registries/{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 Registry Metadata

put

Replaces all metadata for a registry.

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/registries/{id}/metadata

PUT /api/v3/registries/{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"
    }
  ]
}

Rebuild the index for a registry

post

Trigger an asynchronous rebuild of the repository index for the given registry. The rebuild runs in the background; this endpoint returns immediately once the request is accepted. Index rebuild is package-type specific — it is currently supported only for HELM_HTTP registries. Registries whose package type does not maintain a rebuildable index return 405.

Path parameters

idstringRequired

Query parameters

account_identifierstringRequired

Unique identifier for the Harness account.

Responses

202

Registry index rebuild request accepted for processing

No content

405

Index rebuild is not supported for this registry's package type.

application/json

default

Error response.

application/json

post/v3/registries/{id}/rebuild-index

POST /api/v3/registries/{id}/rebuild-index?account_identifier=text HTTP/1.1
Accept: */*

No content

Get statistics for multiple registries

post

Get statistics (packageCount, size, downloadCount, artifactsCount) for a list of registries 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

scopestring · enumOptional

Scope of registries to list

• none – current space only (default) * ancestors – current space plus all parent spaces * descendants – current space plus all child spaces
  If omitted, none is assumed.

Possible values:

Body

Request input for fetching registry statistics

registryIdsstring · uuid[] · max: 100Required

List of registry UUIDs to fetch statistics for

Responses

200

Response containing statistics for the requested registries

application/json

Response body containing registry statistics

default

Error response.

application/json

post/v3/registries/stats

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

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

{
  "items": [
    {
      "artifactsCount": 1,
      "downloadCount": 1,
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "packageCount": 1,
      "size": "text"
    }
  ]
}