# Helm Repo Index Extractor (`datamule/helm-repo-index-extractor`) Actor

Point at any Helm chart repository's index.yaml and get one structured row per chart version: appVersion, digest, dependencies, maintainers, keywords, sources, deprecation and more.

- **URL**: https://apify.com/datamule/helm-repo-index-extractor.md
- **Developed by:** [Datamule](https://apify.com/datamule) (community)
- **Categories:** Developer tools
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $0.35 / 1,000 charts

This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events.
Since this Actor supports Apify Store discounts, the price gets lower the higher subscription plan you have.

Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event

## What's an Apify Actor?

Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.
Actors are written with capital "A".

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.
The best way to integrate Actors is as follows.

In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md):

```bash
npm install apify-client
```

In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md):

```bash
pip install apify-client
```

In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md):

````bash
# MacOS / Linux
curl -fsSL https://apify.com/install-cli.sh | bash
# Windows
irm https://apify.com/install-cli.ps1 | iex
```bash

In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md).

If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md).

For usage examples, see the [API](#api) section below.

For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt).


# README

## Helm Repo Index Extractor

Point at **any** Helm chart repository's `index.yaml` and get one clean,
structured row per chart **version** — the entire repository catalogue as a flat
dataset you can filter, diff, inventory, or feed into an SBOM / supply-chain
pipeline.

Every Helm repository — [Prometheus Community](https://prometheus-community.github.io/helm-charts/index.yaml),
[Grafana](https://grafana.github.io/helm-charts/index.yaml),
[Jetstack / cert-manager](https://charts.jetstack.io/index.yaml),
[Bitnami](https://charts.bitnami.com/bitnami/index.yaml),
[HashiCorp](https://helm.releases.hashicorp.com/index.yaml),
[ingress-nginx](https://kubernetes.github.io/ingress-nginx/index.yaml),
and the tens of thousands of self-hosted and GitHub-Pages-hosted repos — publishes
the **identical** Helm repository index standard. So this one actor works against
all of them. No per-repo scraper, no host enumeration: give it an `index.yaml`
URL and it returns the whole catalogue.

### What you get

One dataset row per chart version, with every standard Helm index field
flattened and safely nullable (a repo that omits a field simply yields `null`):

| Field | Description |
| --- | --- |
| `chart` / `name` | Chart name |
| `version` | Chart version (SemVer) — one row each |
| `appVersion` | Version of the app the chart deploys |
| `chartApiVersion` | Chart schema (`v1` / `v2`) |
| `chartType` | `application` or `library` |
| `created` | Publish timestamp (ISO-8601) |
| `digest` | SHA-256 digest of the packaged chart |
| `description` | Chart description |
| `deprecated` | Whether the version is deprecated |
| `kubeVersion` | Compatible Kubernetes version range |
| `home` / `icon` | Project home URL / icon URL |
| `chartUrl` | Direct, absolute download URL of the `.tgz` (relative repo URLs resolved for you) |
| `urls` | Raw download URL list |
| `sources` | Source-code repository URLs |
| `keywords` | Chart keywords |
| `dependencies` | Sub-chart dependencies (name, version, repository, condition, …) |
| `maintainers` | Maintainers (name, email, url) |
| `annotations` | Chart annotations (e.g. ArtifactHub metadata) |
| `_raw` | The lossless original version entry |
| `_source`, `_chartCount`, `_versionCount`, `_chartVersionCount` | Provenance & totals |

### Input

| Field | Required | Description |
| --- | --- | --- |
| `indexUrl` | ✅ | URL of a Helm repository `index.yaml`. Redirects are followed. |
| `chartFilter` | | Case-insensitive substring; only matching chart names are emitted. |
| `maxRecords` | | Global cap on emitted rows (each row = one chart version). |
| `bearer` | | Bearer token for a private/gated repo. Never logged. |
| `extraHeaders` | | Extra request headers (JSON object) for gated repos. Never logged. |

#### Example

```json
{
  "indexUrl": "https://charts.jetstack.io/index.yaml",
  "chartFilter": "cert-manager",
  "maxRecords": 25
}
````

### Notes

- **Large repos:** a single popular chart can have hundreds of releases (Bitnami's
  index is tens of MB and holds thousands of versions). Use `maxRecords` and/or
  `chartFilter` to scope a run; charts are processed in sorted name order so a
  capped run is deterministic.
- **Robust by design:** fields are read by key presence, so a repository that
  omits `appVersion`, `dependencies`, `maintainers`, `type`, etc. never breaks the
  run — the missing column is simply `null`.
- **Honest failure:** if the URL doesn't return a Helm repository index (an HTML
  error page, a 404, or YAML without an `entries` map) the run fails fast rather
  than emitting empty rows.

### Pricing

Pay-per-event: **one `chart` charge per emitted chart-version row.** You only pay
for the rows you extract.

# Actor input Schema

## `indexUrl` (type: `string`):

URL of a Helm chart repository's index.yaml. Every Helm repo publishes the identical index standard, so one actor works against any of them: https://charts.jetstack.io/index.yaml (Jetstack / cert-manager), https://prometheus-community.github.io/helm-charts/index.yaml (Prometheus Community), https://grafana.github.io/helm-charts/index.yaml (Grafana), https://helm.releases.hashicorp.com/index.yaml (HashiCorp), https://kubernetes.github.io/ingress-nginx/index.yaml, or any self-hosted / GitHub-Pages repo. Redirects are followed (Bitnami's index 302-redirects). The URL usually ends in /index.yaml.

## `chartFilter` (type: `string`):

Optional case-insensitive substring. Only charts whose name contains it are emitted; charts that do not match are skipped entirely. Leave empty to extract every chart in the repository. Example: prometheus (matches kube-prometheus-stack, prometheus-node-exporter, …).

## `maxRecords` (type: `integer`):

A GLOBAL cap on the number of chart-version rows to emit (each row is one chart version and one billable event). Charts are processed in sorted name order, so a small cap is deterministic. Leave empty to emit every version of every chart — note a large repo can hold thousands of versions (a single chart may have hundreds of releases).

## `bearer` (type: `string`):

Optional bearer token for a private/gated Helm repository (sent as Authorization: Bearer \*\*\*). Not required for public repos. Never logged.

## `extraHeaders` (type: `object`):

Optional extra HTTP headers as a JSON object, e.g. {"x-api-key": "..."} for gated/authenticated repositories. Not required for public repos. Header values are never logged.

## Actor input object example

```json
{
  "indexUrl": "https://charts.jetstack.io/index.yaml"
}
```

# Actor output Schema

## `results` (type: `string`):

No description

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "indexUrl": "https://charts.jetstack.io/index.yaml"
};

// Run the Actor and wait for it to finish
const run = await client.actor("datamule/helm-repo-index-extractor").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = { "indexUrl": "https://charts.jetstack.io/index.yaml" }

# Run the Actor and wait for it to finish
run = client.actor("datamule/helm-repo-index-extractor").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"])
for item in client.dataset(run["defaultDatasetId"]).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "indexUrl": "https://charts.jetstack.io/index.yaml"
}' |
apify call datamule/helm-repo-index-extractor --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "command": "npx",
            "args": [
                "mcp-remote",
                "https://mcp.apify.com/?tools=datamule/helm-repo-index-extractor",
                "--header",
                "Authorization: Bearer <YOUR_API_TOKEN>"
            ]
        }
    }
}

```

## OpenAPI specification

```json
{
    "openapi": "3.0.1",
    "info": {
        "title": "Helm Repo Index Extractor",
        "description": "Point at any Helm chart repository's index.yaml and get one structured row per chart version: appVersion, digest, dependencies, maintainers, keywords, sources, deprecation and more.",
        "version": "0.1",
        "x-build-id": "zoPkwAeQdnoTst3JX"
    },
    "servers": [
        {
            "url": "https://api.apify.com/v2"
        }
    ],
    "paths": {
        "/acts/datamule~helm-repo-index-extractor/run-sync-get-dataset-items": {
            "post": {
                "operationId": "run-sync-get-dataset-items-datamule-helm-repo-index-extractor",
                "x-openai-isConsequential": false,
                "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
                "tags": [
                    "Run Actor"
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/inputSchema"
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "token",
                        "in": "query",
                        "required": true,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Enter your Apify token here"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK"
                    }
                }
            }
        },
        "/acts/datamule~helm-repo-index-extractor/runs": {
            "post": {
                "operationId": "runs-sync-datamule-helm-repo-index-extractor",
                "x-openai-isConsequential": false,
                "summary": "Executes an Actor and returns information about the initiated run in response.",
                "tags": [
                    "Run Actor"
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/inputSchema"
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "token",
                        "in": "query",
                        "required": true,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Enter your Apify token here"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/runsResponseSchema"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/acts/datamule~helm-repo-index-extractor/run-sync": {
            "post": {
                "operationId": "run-sync-datamule-helm-repo-index-extractor",
                "x-openai-isConsequential": false,
                "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
                "tags": [
                    "Run Actor"
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/inputSchema"
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "token",
                        "in": "query",
                        "required": true,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Enter your Apify token here"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK"
                    }
                }
            }
        }
    },
    "components": {
        "schemas": {
            "inputSchema": {
                "type": "object",
                "required": [
                    "indexUrl"
                ],
                "properties": {
                    "indexUrl": {
                        "title": "Helm repository index.yaml URL",
                        "type": "string",
                        "description": "URL of a Helm chart repository's index.yaml. Every Helm repo publishes the identical index standard, so one actor works against any of them: https://charts.jetstack.io/index.yaml (Jetstack / cert-manager), https://prometheus-community.github.io/helm-charts/index.yaml (Prometheus Community), https://grafana.github.io/helm-charts/index.yaml (Grafana), https://helm.releases.hashicorp.com/index.yaml (HashiCorp), https://kubernetes.github.io/ingress-nginx/index.yaml, or any self-hosted / GitHub-Pages repo. Redirects are followed (Bitnami's index 302-redirects). The URL usually ends in /index.yaml."
                    },
                    "chartFilter": {
                        "title": "Chart name filter (substring)",
                        "type": "string",
                        "description": "Optional case-insensitive substring. Only charts whose name contains it are emitted; charts that do not match are skipped entirely. Leave empty to extract every chart in the repository. Example: prometheus (matches kube-prometheus-stack, prometheus-node-exporter, …)."
                    },
                    "maxRecords": {
                        "title": "Max records (global cap)",
                        "minimum": 1,
                        "type": "integer",
                        "description": "A GLOBAL cap on the number of chart-version rows to emit (each row is one chart version and one billable event). Charts are processed in sorted name order, so a small cap is deterministic. Leave empty to emit every version of every chart — note a large repo can hold thousands of versions (a single chart may have hundreds of releases)."
                    },
                    "bearer": {
                        "title": "Bearer token",
                        "type": "string",
                        "description": "Optional bearer token for a private/gated Helm repository (sent as Authorization: Bearer ***). Not required for public repos. Never logged."
                    },
                    "extraHeaders": {
                        "title": "Extra request headers",
                        "type": "object",
                        "description": "Optional extra HTTP headers as a JSON object, e.g. {\"x-api-key\": \"...\"} for gated/authenticated repositories. Not required for public repos. Header values are never logged."
                    }
                }
            },
            "runsResponseSchema": {
                "type": "object",
                "properties": {
                    "data": {
                        "type": "object",
                        "properties": {
                            "id": {
                                "type": "string"
                            },
                            "actId": {
                                "type": "string"
                            },
                            "userId": {
                                "type": "string"
                            },
                            "startedAt": {
                                "type": "string",
                                "format": "date-time",
                                "example": "2025-01-08T00:00:00.000Z"
                            },
                            "finishedAt": {
                                "type": "string",
                                "format": "date-time",
                                "example": "2025-01-08T00:00:00.000Z"
                            },
                            "status": {
                                "type": "string",
                                "example": "READY"
                            },
                            "meta": {
                                "type": "object",
                                "properties": {
                                    "origin": {
                                        "type": "string",
                                        "example": "API"
                                    },
                                    "userAgent": {
                                        "type": "string"
                                    }
                                }
                            },
                            "stats": {
                                "type": "object",
                                "properties": {
                                    "inputBodyLen": {
                                        "type": "integer",
                                        "example": 2000
                                    },
                                    "rebootCount": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "restartCount": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "resurrectCount": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "computeUnits": {
                                        "type": "integer",
                                        "example": 0
                                    }
                                }
                            },
                            "options": {
                                "type": "object",
                                "properties": {
                                    "build": {
                                        "type": "string",
                                        "example": "latest"
                                    },
                                    "timeoutSecs": {
                                        "type": "integer",
                                        "example": 300
                                    },
                                    "memoryMbytes": {
                                        "type": "integer",
                                        "example": 1024
                                    },
                                    "diskMbytes": {
                                        "type": "integer",
                                        "example": 2048
                                    }
                                }
                            },
                            "buildId": {
                                "type": "string"
                            },
                            "defaultKeyValueStoreId": {
                                "type": "string"
                            },
                            "defaultDatasetId": {
                                "type": "string"
                            },
                            "defaultRequestQueueId": {
                                "type": "string"
                            },
                            "buildNumber": {
                                "type": "string",
                                "example": "1.0.0"
                            },
                            "containerUrl": {
                                "type": "string"
                            },
                            "usage": {
                                "type": "object",
                                "properties": {
                                    "ACTOR_COMPUTE_UNITS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_WRITES": {
                                        "type": "integer",
                                        "example": 1
                                    },
                                    "KEY_VALUE_STORE_LISTS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_INTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_EXTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_SERPS": {
                                        "type": "integer",
                                        "example": 0
                                    }
                                }
                            },
                            "usageTotalUsd": {
                                "type": "number",
                                "example": 0.00005
                            },
                            "usageUsd": {
                                "type": "object",
                                "properties": {
                                    "ACTOR_COMPUTE_UNITS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_WRITES": {
                                        "type": "number",
                                        "example": 0.00005
                                    },
                                    "KEY_VALUE_STORE_LISTS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_INTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_EXTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_SERPS": {
                                        "type": "integer",
                                        "example": 0
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}
```
