Registry V3 Metadata

V3 metadata endpoints

Delete Metadata

delete

Delete metadata key-value pairs by ID of metadata

Path parameters

idstringRequired

Query parameters

account_identifierstringRequired

Unique identifier for the Harness account.

Responses

200

Metadata deleted successfully

No content

default

Error response.

application/json

delete/v3/metadata/{id}

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

No content

Get Metadata Keys

get

Retrieve a paginated list of all available metadata keys.

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

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

search_termstringOptional

Search term for filtering results.

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

Responses

200

Response contains metadata keys

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

itemsstring[]Required

A unique metadata key name

default

Error response.

application/json

get/v3/metadata/keys

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

{
  "hasMore": true,
  "page": 0,
  "size": 20,
  "items": [
    "text"
  ]
}

Get Metadata Values

get

Retrieve all possible values for a specific metadata key.

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

keystringRequired

The metadata key for which to retrieve all possible values. This parameter is used to filter metadata values by a specific key name.

Examples: environment, team, version_type, build_number

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

search_termstringOptional

Search term for filtering results.

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

Responses

200

Response containing all possible values for a specific metadata key

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

itemsstring[]Required

A unique value for the specified metadata key

default

Error response.

application/json

get/v3/metadata/values

GET /api/v3/metadata/values?account_identifier=text&key=text HTTP/1.1
Accept: */*

{
  "hasMore": true,
  "page": 0,
  "size": 20,
  "items": [
    "text"
  ]
}