For the complete documentation index, see llms.txt. This page is also available as Markdown.

Helm Artifacts

APIs to get details of helm artifacts

Describe Helm Artifact Detail

get

Get Helm Artifact Details

Path parameters
registry_refstringRequired

Reference to the scope in which the registry exists.

Format depends on the scope:

  • Account-level: account_id/registry_name/+
  • Organization-level: account_id/org_id/registry_name/+
  • Project-level: account_id/org_id/project_id/registry_name/+

The /+ suffix is used internally to route scoped requests. It must be included exactly as shown in the URL.

Example: {"description":"Only account ID, scoped at account level","summary":"Account-level registry","value":"acc123/registry123/+"}
artifactstringRequired

Name of the artifact.

The value depends on whether the name contains a slash (/):

  • If the artifact name contains /, append a trailing /+ at the end.
    • Example: mygroup/myartifact/+
  • If the artifact name does not contain /, use the plain name.
    • Example: myartifact

This is used internally to distinguish between namespaced and flat artifact names.

Example: {"summary":"Flat artifact name","value":"myartifact"}
versionstringRequired

Name of Artifact Version.

Query parameters
version_typestring · enumOptional

Version Type.

Possible values:
Responses
200

response to get helm artifact detail

application/json
statusstring · enumRequired

Request processing status indicator

Possible values:
get/v1/registry/{registry_ref}/artifact/{artifact}/version/{version}/helm/details
GET /api/v1/registry/{registry_ref}/artifact/{artifact}/version/{version}/helm/details HTTP/1.1
Accept: */*
{
  "data": {
    "artifact": "text",
    "createdAt": "text",
    "downloadsCount": 1,
    "metadata": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "modifiedAt": "text",
    "packageType": "DOCKER",
    "pullCommand": "text",
    "pullCommandByDigest": "text",
    "registryPath": "text",
    "size": "text",
    "url": "text",
    "version": "text"
  },
  "status": "SUCCESS"
}

Describe Helm Artifact Manifest

get

Get Helm Artifact Manifest

Path parameters
registry_refstringRequired

Reference to the scope in which the registry exists.

Format depends on the scope:

  • Account-level: account_id/registry_name/+
  • Organization-level: account_id/org_id/registry_name/+
  • Project-level: account_id/org_id/project_id/registry_name/+

The /+ suffix is used internally to route scoped requests. It must be included exactly as shown in the URL.

Example: {"description":"Only account ID, scoped at account level","summary":"Account-level registry","value":"acc123/registry123/+"}
artifactstringRequired

Name of the artifact.

The value depends on whether the name contains a slash (/):

  • If the artifact name contains /, append a trailing /+ at the end.
    • Example: mygroup/myartifact/+
  • If the artifact name does not contain /, use the plain name.
    • Example: myartifact

This is used internally to distinguish between namespaced and flat artifact names.

Example: {"summary":"Flat artifact name","value":"myartifact"}
versionstringRequired

Name of Artifact Version.

Responses
200

response to get helm artifact manifest

application/json
statusstring · enumRequired

Request processing status indicator

Possible values:
get/v1/registry/{registry_ref}/artifact/{artifact}/version/{version}/helm/manifest
GET /api/v1/registry/{registry_ref}/artifact/{artifact}/version/{version}/helm/manifest HTTP/1.1
Accept: */*
{
  "data": {
    "manifest": "text"
  },
  "status": "SUCCESS"
}

Last updated

Was this helpful?