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

Registry V3 Packages

V3 packages endpoints

List Packages

get

Lists 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"]
metadatastring[]Optional

Filter by metadata using key:value format

package_kindstringOptional

refers to package kind which is being used in huggingface packages for model, dataset and terraform packages for module, provider

Example: model
package_typesstring[]Optional

Registry Package Type

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 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
get/v3/packages
GET /api/v3/packages?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"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "isPublic": true,
      "isQuarantined": true,
      "latestVersion": "text",
      "latestVersionArtifactKey": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "modifiedAt": 1736360000123,
      "modifiedBy": {
        "display_name": "text",
        "email": "text",
        "type": "text",
        "uid": "text"
      },
      "name": "text",
      "orgIdentifier": "text",
      "packageKind": "model",
      "packageType": "DOCKER",
      "projectIdentifier": "text",
      "quarantineReason": "text",
      "registryId": "123e4567-e89b-12d3-a456-426614174000",
      "registryName": "text"
    }
  ],
  "meta": {
    "activeCount": 95,
    "deletedCount": 5
  }
}

Get Package Metadata

get

Retrieves all metadata for a package.

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
get/v3/packages/{id}/metadata
GET /api/v3/packages/{id}/metadata?account_identifier=text HTTP/1.1
Accept: */*

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

Upsert Package Metadata

post

Creates or overwrites metadata for a package.

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
post/v3/packages/{id}/metadata
POST /api/v3/packages/{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 Package Metadata

put

Replaces all metadata for a package.

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
put/v3/packages/{id}/metadata
PUT /api/v3/packages/{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 package

post

Trigger an asynchronous rebuild of the package index for the given package. The rebuild runs in the background; this endpoint returns immediately once the request is accepted. Package index rebuild is package-type specific — registries whose package type does not maintain a rebuildable per-package index return 405.

Query parameters
account_identifierstringRequired

Unique identifier for the Harness account.

Body

Request to rebuild the package index for a single package

packageIdstringRequired

UUID of the package to rebuild the index for

Responses
202

Package index rebuild request accepted for processing

No content
post/v3/packages/rebuild-index
POST /api/v3/packages/rebuild-index?account_identifier=text HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "packageId": "text"
}
No content

Get statistics for multiple packages

post

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

packageIdsstring · uuid[] · max: 100Required

List of package UUIDs to fetch statistics for

Responses
200

Response containing statistics for the requested packages

application/json

Response body containing package statistics

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

{
  "packageIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}
{
  "items": [
    {
      "artifactsCount": 1,
      "downloadCount": 1,
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "size": "text"
    }
  ]
}
PreviousRegistry V3 Registries
NextRegistry V3 Versions

Last updated

Was this helpful?