API docs by Redocly

Grafana k6 Extension Registry Service (0.1.0)

Download OpenAPI specification:Download

License: AGPL-3.0-only Terms of Service

Query the Grafana k6 Extension Registry database.

The Grafana k6 Extension Registry Service enables read-only access to the Grafana k6 Extension Registry database.

The Grafana k6 Extension Registry database contains up-to-date information about registered extensions. The basic data of the extensions (e.g. go module path, JavaScript import path, description) are registered manually, the other data (e.g. available versions, number of stars) are retrieved automatically via the repository manager API (GitHub, GitLab, etc.).

Detailed information about response schemas can be found in the schema documentation. Schemas are defined in registry.schema.json

The source code of extensions is automatically statically analyzed. The result of the analysis is the compliance level of the best practices of Grafana k6 extensions (0-100%). Based on the compliance level, a compliance grade is also calculated (A-F). Based on the compliance grade, an SVG compliance badge is created for each extension. Example badge:

xk6-sql

The k6 Extension Catalog is an alternative representation of the k6 Extension Registry. Most queries have an alternative counterpart that returns a catalog instead of a registry.

You can try the k6 Extension Registry Service!

Information about modifying the registry (register new extensions, modify or delete existing registrations) can be found in the grafana/k6-extension-registry GitHub repository.

Find out more about Grafana k6 extensions

global

Access to the entire registry

Entire registry

Download the entire registry as a single JSON file

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Registry metrics

Download the registry metrics as a single JSON file

Responses

Response samples

Content type
application/json
{
  • "registry_extension_count": 0,
  • "registry_tier_official_count": 0,
  • "registry_tier_unofficial_count": 0,
  • "registry_tier_partner_count": 0,
  • "registry_tier_community_count": 0,
  • "registry_type_javascript_count": 0,
  • "registry_type_output_count": 0,
  • "registry_product_cloud_count": 0,
  • "registry_product_oss_count": 0,
  • "registry_product_synthetic_count": 0,
  • "registry_grade_a_count": 0,
  • "registry_grade_b_count": 0,
  • "registry_grade_c_count": 0,
  • "registry_grade_d_count": 0,
  • "registry_grade_e_count": 0,
  • "registry_grade_f_count": 0,
  • "registry_cgo_count": 0,
  • "registry_category_authentication_count": 0,
  • "registry_category_browser_count": 0,
  • "registry_category_data_count": 0,
  • "registry_category_kubernetes_count": 0,
  • "registry_category_messaging_count": 0,
  • "registry_category_misc_count": 0,
  • "registry_category_observability_count": 0,
  • "registry_category_protocol_count": 0,
  • "registry_category_reporting_count": 0,
  • "registry_issue_module_count": 0,
  • "registry_issue_replace_count": 0,
  • "registry_issue_readme_count": 0,
  • "registry_issue_examples_count": 0,
  • "registry_issue_license_count": 0,
  • "registry_issue_git_count": 0,
  • "registry_issue_versions_count": 0,
  • "registry_issue_build_count": 0,
  • "registry_issue_smoke_count": 0,
  • "registry_issue_types_count": 0,
  • "registry_issue_codeowners_count": 0
}

module

Query a specific extension

Query an extension

Query the data of a specific extension as a single JSON file

path Parameters
module
required
string
Examples:
  • github.com/grafana/xk6-dashboard -
  • github.com/grafana/xk6-sql -

go module path of the extension

Responses

Response samples

Content type
application/json
{
  • "module": "github.com/grafana/xk6-dashboard",
  • "imports": [
    ],
  • "outputs": [
    ],
  • "description": "This is a very cool extension, it displays the message 'Hello World!'",
  • "versions": [
    ],
  • "cgo": false,
  • "constraints": [
    ],
  • "repo": {},
  • "tier": "community",
  • "products": [
    ],
  • "categories": [
    ],
  • "compliance": {
    }
}

Download a badge

Download an extension's badge as an SVG image

Example:

xk6-sql

path Parameters
module
required
string
Examples:
  • github.com/grafana/xk6-dashboard -
  • github.com/grafana/xk6-sql -

go module path of the extension

Responses

Download a grade badge

Download an extension's grade badge as an SVG image

Example:

xk6-sql

path Parameters
module
required
string
Examples:
  • github.com/grafana/xk6-dashboard -
  • github.com/grafana/xk6-sql -

go module path of the extension

Responses

catalog

Extension catalog queries

Entire catalog

Download the entire catalog as a single JSON file

Responses

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Catalog by product

Query the catalog containing extensions available in a given product.

path Parameters
product
required
string (product)
Enum: "oss" "cloud" "synthetic"
Examples:
  • oss -
  • cloud -

product to be queried

Responses

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Catalog by support

Query the catalog containing extensions available with a given support.

path Parameters
tier
required
string (tier)
Enum: "official" "partner" "community"
Examples:
  • official -
  • community -

tier to be queried

Responses

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Catalog by min support

Query the catalog containing extensions available with at least the support specified as a parameter.

path Parameters
tier
required
string (tier)
Enum: "official" "partner" "community"
Examples:
  • official -
  • community -

tier to be queried

Responses

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

subset

Query subsets of the registry

Suubset by product

Querying the subset of the registry containing the extensions available in the product specified in the parameter

path Parameters
product
required
string (product)
Enum: "oss" "cloud" "synthetic"
Examples:
  • oss -
  • cloud -

product to be queried

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Subset by support

Querying the subset of the registry containing the extensions with support specified in the parameter

path Parameters
tier
required
string (tier)
Enum: "official" "partner" "community"
Examples:
  • official -
  • community -

tier to be queried

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Subset by min support

Query the subset of the registry that contains the extensions whose support is at least the level specified as a parameter.

path Parameters
tier
required
string (tier)
Enum: "official" "partner" "community"
Examples:
  • official -
  • community -

tier to be queried

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Subset by category

Querying the subset of the registry containing extensions belonging to the category specified in the parameter

path Parameters
category
required
string (category)
Enum: "authentication" "browser" "data" "kubernetes" "messaging" "misc" "observability" "protocol" "reporting"
Examples: data,reporting observability,protocol

category to be queried

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Subset by grade

Querying the subset of the registry containing the extensions with the compliance grade specified in the parameter

path Parameters
grade
required
string (grade)
Enum: "A" "B" "C" "D" "E" "F" "G"
Examples:
  • A -
  • C -

grade to be queried

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Subset by min grade

Querying the subset of the registry containing extensions with at least compliance grade specified in the parameter

path Parameters
grade
required
string (grade)
Enum: "A" "B" "C" "D" "E" "F" "G"
Examples:
  • A -
  • C -

grade to be queried

Responses

Response samples

Content type
application/json
[
  • {
    }
]