Testing and synthetics

Performance testing

Reference pages

Cloud REST API

Load tests

Grafana Cloud

Tests REST API

Note
The documentation for this API is also available as an OpenAPI description.

List all tests

GET /cloud/v6/load_tests

List all available tests.

Request parameters

Name	Description	In	Required	Type
`X-Stack-Id`	Numeric ID of the Grafana stack representing the request scope. If the API is called with a Personal API token, the user must be a member of the specified stack. If the API is called with a Grafana Stack API token, the value must be the ID of the corresponding stack.	`header`	`true`	`integer`
`$count`	Include collection length in the response object as `@count`.	`query`	`false`	`boolean`
`$orderby`	Comma-separated list of fields to use when ordering the results. Available fields: id project_id name created updated The default ascending order can be reversed by appending the `desc` specifier.	`query`	`false`	`string`
`$skip`	The initial index from which to return the results.	`query`	`false`	`integer`
`$top`	Number of results to return per page. Default: `1000` Maximum: `1000`	`query`	`false`	`integer`
`name`	Filter results by load test name (exact match).	`query`	`false`	`string`

`200` response

OK.

Content types: `application/json`

LoadTestListResponse properties:

Name	Description	Required	Type
`@count`	Object count in the collection.	`false`	`integer`
`@nextLink`	A reference to the next page of results. The property is included until there are no more pages of results to retrieve.	`false`	`string` , format: `uri`
`value`	List of the resulting values.	`true`	`Array[LoadTestApiModel]`

LoadTestApiModel properties:

Name	Description	Required	Type
`baseline_test_run_id`	ID of a baseline test run used for results comparison. Deprecated: baselines are being replaced by the star/unstar test run APIs and this field is scheduled for removal on 2026-09-01.	`true`	`integer` \| `null` , format: `int64`
`created`	The date when the test was created.	`true`	`string` , format: `date-time`
`id`	ID of the load test.	`true`	`integer` , format: `int64`
`k6_version`	Identifier of the k6 version used to run the test.	`false`	`integer` \| `null`
`name`	Unique name of the test within the project.	`true`	`string`
`project_id`	ID of the parent project.	`true`	`integer` , format: `int64`
`updated`	The date when the test was last updated.	`true`	`string` , format: `date-time`

OK example

{
  "@count": 123,
  "@nextLink": "https://api.k6.io/cloud/v6/load_tests?$skip=50\u0026$top=20",
  "value": [
    {
      "baseline_test_run_id": null,
      "created": "2024-12-03T09:53:00.553",
      "id": 1234,
      "k6_version": null,
      "name": "Orders API Soak Test",
      "project_id": 312,
      "updated": "2024-12-03T09:53:00.553"
    }
  ]
}

`400` response

Request validation error.

Content types: `application/json`

ErrorResponseApiModel properties:

Name	Description	Required	Type
`error`		`true`	`ErrorApiModel`

Details of the error.

ErrorApiModel properties:

Name	Description	Required	Type
`code`	Service-defined error code.	`true`	`string`
`details`	Array of objects with more specific error information when applicable.	`false`	`array` \| `null`
`message`	Human-readable string describing the error.	`true`	`string`
`target`	A string indicating the target of the error. For example, the name of the property in error.	`false`	`string` \| `null`

`401` response

Invalid token or authentication scheme.

Content types: `application/json`

ErrorResponseApiModel properties:

Name	Description	Required	Type
`error`		`true`	`ErrorApiModel`

Details of the error.

ErrorApiModel properties:

Name	Description	Required	Type
`code`	Service-defined error code.	`true`	`string`
`details`	Array of objects with more specific error information when applicable.	`false`	`array` \| `null`
`message`	Human-readable string describing the error.	`true`	`string`
`target`	A string indicating the target of the error. For example, the name of the property in error.	`false`	`string` \| `null`

`403` response

The user does not have permission to perform this action.

Content types: `application/json`

ErrorResponseApiModel properties:

Name	Description	Required	Type
`error`		`true`	`ErrorApiModel`

Details of the error.

ErrorApiModel properties:

Name	Description	Required	Type
`code`	Service-defined error code.	`true`	`string`
`details`	Array of objects with more specific error information when applicable.	`false`	`array` \| `null`
`message`	Human-readable string describing the error.	`true`	`string`
`target`	A string indicating the target of the error. For example, the name of the property in error.	`false`	`string` \| `null`

`500` response

Unexpected error.

Content types: `application/json`

ErrorResponseApiModel properties:

Name	Description	Required	Type
`error`		`true`	`ErrorApiModel`

Details of the error.

ErrorApiModel properties:

Name	Description	Required	Type
`code`	Service-defined error code.	`true`	`string`
`details`	Array of objects with more specific error information when applicable.	`false`	`array` \| `null`
`message`	Human-readable string describing the error.	`true`	`string`
`target`	A string indicating the target of the error. For example, the name of the property in error.	`false`	`string` \| `null`

Get a load test by ID

GET /cloud/v6/load_tests/{id}

Fetch a single load test.

Request parameters

Name Description In Required Type

X-Stack-Id

Numeric ID of the Grafana stack representing the request scope.

If the API is called with a Personal API token, the user must be a member of the specified stack.
If the API is called with a Grafana Stack API token, the value must be the ID of the corresponding stack.

header

true

integer

id ID of the load test. path true integer , format: int64

`200` response

OK.

Content types: `application/json`

LoadTestApiModel properties:

Name	Description	Required	Type
`baseline_test_run_id`	ID of a baseline test run used for results comparison. Deprecated: baselines are being replaced by the star/unstar test run APIs and this field is scheduled for removal on 2026-09-01.	`true`	`integer` \| `null` , format: `int64`
`created`	The date when the test was created.	`true`	`string` , format: `date-time`
`id`	ID of the load test.	`true`	`integer` , format: `int64`
`k6_version`	Identifier of the k6 version used to run the test.	`false`	`integer` \| `null`
`name`	Unique name of the test within the project.	`true`	`string`
`project_id`	ID of the parent project.	`true`	`integer` , format: `int64`
`updated`	The date when the test was last updated.	`true`	`string` , format: `date-time`

OK example

{
  "baseline_test_run_id": null,
  "created": "2024-12-03T09:53:00.553",
  "id": 1234,
  "k6_version": null,
  "name": "Orders API Soak Test",
  "project_id": 312,
  "updated": "2024-12-03T09:53:00.553"
}

`401` response

Invalid token or authentication scheme.

Content types: `application/json`

ErrorResponseApiModel properties:

Name	Description	Required	Type
`error`		`true`	`ErrorApiModel`

Details of the error.

ErrorApiModel properties:

Name	Description	Required	Type
`code`	Service-defined error code.	`true`	`string`
`details`	Array of objects with more specific error information when applicable.	`false`	`array` \| `null`
`message`	Human-readable string describing the error.	`true`	`string`
`target`	A string indicating the target of the error. For example, the name of the property in error.	`false`	`string` \| `null`

`403` response

The user does not have permission to perform this action.

Content types: `application/json`

ErrorResponseApiModel properties:

Name	Description	Required	Type
`error`		`true`	`ErrorApiModel`

Details of the error.

ErrorApiModel properties:

Name	Description	Required	Type
`code`	Service-defined error code.	`true`	`string`
`details`	Array of objects with more specific error information when applicable.	`false`	`array` \| `null`
`message`	Human-readable string describing the error.	`true`	`string`
`target`	A string indicating the target of the error. For example, the name of the property in error.	`false`	`string` \| `null`

`404` response

Resource not found.

Content types: `application/json`

ErrorResponseApiModel properties:

Name	Description	Required	Type
`error`		`true`	`ErrorApiModel`

Details of the error.

ErrorApiModel properties:

Name	Description	Required	Type
`code`	Service-defined error code.	`true`	`string`
`details`	Array of objects with more specific error information when applicable.	`false`	`array` \| `null`
`message`	Human-readable string describing the error.	`true`	`string`
`target`	A string indicating the target of the error. For example, the name of the property in error.	`false`	`string` \| `null`

`500` response

Unexpected error.

Content types: `application/json`

ErrorResponseApiModel properties:

Name	Description	Required	Type
`error`		`true`	`ErrorApiModel`

Details of the error.

ErrorApiModel properties:

Name	Description	Required	Type
`code`	Service-defined error code.	`true`	`string`
`details`	Array of objects with more specific error information when applicable.	`false`	`array` \| `null`
`message`	Human-readable string describing the error.	`true`	`string`
`target`	A string indicating the target of the error. For example, the name of the property in error.	`false`	`string` \| `null`

Delete a load test

DELETE /cloud/v6/load_tests/{id}

Delete a load test.

Request parameters

Name Description In Required Type

X-Stack-Id

Numeric ID of the Grafana stack representing the request scope.

If the API is called with a Personal API token, the user must be a member of the specified stack.
If the API is called with a Grafana Stack API token, the value must be the ID of the corresponding stack.

header

true

integer

id ID of the load test. path true integer , format: int64

`204` response

OK.

`401` response

Invalid token or authentication scheme.

Content types: `application/json`

ErrorResponseApiModel properties:

Name	Description	Required	Type
`error`		`true`	`ErrorApiModel`

Details of the error.

ErrorApiModel properties:

Name	Description	Required	Type
`code`	Service-defined error code.	`true`	`string`
`details`	Array of objects with more specific error information when applicable.	`false`	`array` \| `null`
`message`	Human-readable string describing the error.	`true`	`string`
`target`	A string indicating the target of the error. For example, the name of the property in error.	`false`	`string` \| `null`

`403` response

The user does not have permission to perform this action.

Content types: `application/json`

ErrorResponseApiModel properties:

Name	Description	Required	Type
`error`		`true`	`ErrorApiModel`

Details of the error.

ErrorApiModel properties:

Name	Description	Required	Type
`code`	Service-defined error code.	`true`	`string`
`details`	Array of objects with more specific error information when applicable.	`false`	`array` \| `null`
`message`	Human-readable string describing the error.	`true`	`string`
`target`	A string indicating the target of the error. For example, the name of the property in error.	`false`	`string` \| `null`

`404` response

Resource not found.

Content types: `application/json`

ErrorResponseApiModel properties:

Name	Description	Required	Type
`error`		`true`	`ErrorApiModel`

Details of the error.

ErrorApiModel properties:

Name	Description	Required	Type
`code`	Service-defined error code.	`true`	`string`
`details`	Array of objects with more specific error information when applicable.	`false`	`array` \| `null`
`message`	Human-readable string describing the error.	`true`	`string`
`target`	A string indicating the target of the error. For example, the name of the property in error.	`false`	`string` \| `null`

`409` response

Cannot delete test while it’s running.

Content types: `application/json`

ErrorResponseApiModel properties:

Name	Description	Required	Type
`error`		`true`	`ErrorApiModel`

Details of the error.

ErrorApiModel properties:

Name	Description	Required	Type
`code`	Service-defined error code.	`true`	`string`
`details`	Array of objects with more specific error information when applicable.	`false`	`array` \| `null`
`message`	Human-readable string describing the error.	`true`	`string`
`target`	A string indicating the target of the error. For example, the name of the property in error.	`false`	`string` \| `null`

`500` response

Unexpected error.

Content types: `application/json`

ErrorResponseApiModel properties:

Name	Description	Required	Type
`error`		`true`	`ErrorApiModel`

Details of the error.

ErrorApiModel properties:

Name	Description	Required	Type
`code`	Service-defined error code.	`true`	`string`
`details`	Array of objects with more specific error information when applicable.	`false`	`array` \| `null`
`message`	Human-readable string describing the error.	`true`	`string`
`target`	A string indicating the target of the error. For example, the name of the property in error.	`false`	`string` \| `null`

Update a load test

PATCH /cloud/v6/load_tests/{id}

Update a load test.

Request parameters

Name Description In Required Type

X-Stack-Id

Numeric ID of the Grafana stack representing the request scope.

If the API is called with a Personal API token, the user must be a member of the specified stack.
If the API is called with a Grafana Stack API token, the value must be the ID of the corresponding stack.

header

true

integer

id ID of the load test. path true integer , format: int64

Request body

Content types: `application/json`

PatchLoadTestApiModel properties:

Name	Description	Required	Type
`baseline_test_run_id`	ID of a baseline test run used for results comparison. Deprecated: baselines are being replaced by the star/unstar test run APIs and this field is scheduled for removal on 2026-09-01.	`false`	`integer` \| `null` , format: `int64`
`k6_version`	Identifier of the k6 version used to run the test.	`false`	`integer` \| `null`
`name`	Unique name of the test within the project.	`false`	`string`

Update example

{
  "baseline_test_run_id": 123,
  "name": "New Test Name"
}

`204` response

OK.

`400` response

Request validation error.

Content types: `application/json`

ErrorResponseApiModel properties:

Name	Description	Required	Type
`error`		`true`	`ErrorApiModel`

Details of the error.

ErrorApiModel properties:

Name	Description	Required	Type
`code`	Service-defined error code.	`true`	`string`
`details`	Array of objects with more specific error information when applicable.	`false`	`array` \| `null`
`message`	Human-readable string describing the error.	`true`	`string`
`target`	A string indicating the target of the error. For example, the name of the property in error.	`false`	`string` \| `null`

`401` response

Invalid token or authentication scheme.

Content types: `application/json`

ErrorResponseApiModel properties:

Name	Description	Required	Type
`error`		`true`	`ErrorApiModel`

Details of the error.

ErrorApiModel properties:

Name	Description	Required	Type
`code`	Service-defined error code.	`true`	`string`
`details`	Array of objects with more specific error information when applicable.	`false`	`array` \| `null`
`message`	Human-readable string describing the error.	`true`	`string`
`target`	A string indicating the target of the error. For example, the name of the property in error.	`false`	`string` \| `null`

`403` response

The user does not have permission to perform this action.

Content types: `application/json`

ErrorResponseApiModel properties:

Name	Description	Required	Type
`error`		`true`	`ErrorApiModel`

Details of the error.

ErrorApiModel properties:

Name	Description	Required	Type
`code`	Service-defined error code.	`true`	`string`
`details`	Array of objects with more specific error information when applicable.	`false`	`array` \| `null`
`message`	Human-readable string describing the error.	`true`	`string`
`target`	A string indicating the target of the error. For example, the name of the property in error.	`false`	`string` \| `null`

`404` response

Resource not found.

Content types: `application/json`

ErrorResponseApiModel properties:

Name	Description	Required	Type
`error`		`true`	`ErrorApiModel`

Details of the error.

ErrorApiModel properties:

Name	Description	Required	Type
`code`	Service-defined error code.	`true`	`string`
`details`	Array of objects with more specific error information when applicable.	`false`	`array` \| `null`
`message`	Human-readable string describing the error.	`true`	`string`
`target`	A string indicating the target of the error. For example, the name of the property in error.	`false`	`string` \| `null`

`409` response

The name is already taken.

Content types: `application/json`

ErrorResponseApiModel properties:

Name	Description	Required	Type
`error`		`true`	`ErrorApiModel`

Details of the error.

ErrorApiModel properties:

Name	Description	Required	Type
`code`	Service-defined error code.	`true`	`string`
`details`	Array of objects with more specific error information when applicable.	`false`	`array` \| `null`
`message`	Human-readable string describing the error.	`true`	`string`
`target`	A string indicating the target of the error. For example, the name of the property in error.	`false`	`string` \| `null`

`500` response

Unexpected error.

Content types: `application/json`

ErrorResponseApiModel properties:

Name	Description	Required	Type
`error`		`true`	`ErrorApiModel`

Details of the error.

ErrorApiModel properties:

Name	Description	Required	Type
`code`	Service-defined error code.	`true`	`string`
`details`	Array of objects with more specific error information when applicable.	`false`	`array` \| `null`
`message`	Human-readable string describing the error.	`true`	`string`
`target`	A string indicating the target of the error. For example, the name of the property in error.	`false`	`string` \| `null`

Move a test to another project

PUT /cloud/v6/load_tests/{id}/move

Move a load test to a different project of the same organization. All respective test runs will be also moved to the new project.

Request parameters

Name Description In Required Type

X-Stack-Id

Numeric ID of the Grafana stack representing the request scope.

If the API is called with a Personal API token, the user must be a member of the specified stack.
If the API is called with a Grafana Stack API token, the value must be the ID of the corresponding stack.

header

true

integer

id ID of the load test. path true integer , format: int64

Request body

Content types: `application/json`

MoveLoadTestApiModel properties:

Name	Description	Required	Type
`project_id`	ID of the destination project.	`true`	`integer` , format: `int64`

Move example

{
  "project_id": 123
}

`204` response

OK.

`400` response

Request validation error.

Content types: `application/json`

ErrorResponseApiModel properties:

Name	Description	Required	Type
`error`		`true`	`ErrorApiModel`

Details of the error.

ErrorApiModel properties:

Name	Description	Required	Type
`code`	Service-defined error code.	`true`	`string`
`details`	Array of objects with more specific error information when applicable.	`false`	`array` \| `null`
`message`	Human-readable string describing the error.	`true`	`string`
`target`	A string indicating the target of the error. For example, the name of the property in error.	`false`	`string` \| `null`

`401` response

Invalid token or authentication scheme.

Content types: `application/json`

ErrorResponseApiModel properties:

Name	Description	Required	Type
`error`		`true`	`ErrorApiModel`

Details of the error.

ErrorApiModel properties:

Name	Description	Required	Type
`code`	Service-defined error code.	`true`	`string`
`details`	Array of objects with more specific error information when applicable.	`false`	`array` \| `null`
`message`	Human-readable string describing the error.	`true`	`string`
`target`	A string indicating the target of the error. For example, the name of the property in error.	`false`	`string` \| `null`

`403` response

The user does not have permission to perform this action.

Content types: `application/json`

ErrorResponseApiModel properties:

Name	Description	Required	Type
`error`		`true`	`ErrorApiModel`

Details of the error.

ErrorApiModel properties:

Name	Description	Required	Type
`code`	Service-defined error code.	`true`	`string`
`details`	Array of objects with more specific error information when applicable.	`false`	`array` \| `null`
`message`	Human-readable string describing the error.	`true`	`string`
`target`	A string indicating the target of the error. For example, the name of the property in error.	`false`	`string` \| `null`

`404` response

Resource not found.

Content types: `application/json`

ErrorResponseApiModel properties:

Name	Description	Required	Type
`error`		`true`	`ErrorApiModel`

Details of the error.

ErrorApiModel properties:

Name	Description	Required	Type
`code`	Service-defined error code.	`true`	`string`
`details`	Array of objects with more specific error information when applicable.	`false`	`array` \| `null`
`message`	Human-readable string describing the error.	`true`	`string`
`target`	A string indicating the target of the error. For example, the name of the property in error.	`false`	`string` \| `null`

`409` response

Test with the same name exists in the destination.

Content types: `application/json`

ErrorResponseApiModel properties:

Name	Description	Required	Type
`error`		`true`	`ErrorApiModel`

Details of the error.

ErrorApiModel properties:

Name	Description	Required	Type
`code`	Service-defined error code.	`true`	`string`
`details`	Array of objects with more specific error information when applicable.	`false`	`array` \| `null`
`message`	Human-readable string describing the error.	`true`	`string`
`target`	A string indicating the target of the error. For example, the name of the property in error.	`false`	`string` \| `null`

`500` response

Unexpected error.

Content types: `application/json`

ErrorResponseApiModel properties:

Name	Description	Required	Type
`error`		`true`	`ErrorApiModel`

Details of the error.

ErrorApiModel properties:

Name	Description	Required	Type
`code`	Service-defined error code.	`true`	`string`
`details`	Array of objects with more specific error information when applicable.	`false`	`array` \| `null`
`message`	Human-readable string describing the error.	`true`	`string`
`target`	A string indicating the target of the error. For example, the name of the property in error.	`false`	`string` \| `null`

Download the test script

GET /cloud/v6/load_tests/{id}/script

Download the test script.

The script can be either in the form of a single JavaScript file or a k6 .tar archive - the type is identified by the request content type.

Request parameters

Name Description In Required Type

X-Stack-Id

Numeric ID of the Grafana stack representing the request scope.

If the API is called with a Personal API token, the user must be a member of the specified stack.
If the API is called with a Grafana Stack API token, the value must be the ID of the corresponding stack.

header

true

integer

id ID of the load test. path true integer , format: int64

`200` response

OK.

Content types: `application/x-tar` `text/javascript`

K6ArchiveScript example

(.tar data)

TextScript example

import http from 'k6/http';
import { sleep } from 'k6';

export const options = {
  vus: 10,
  duration: '30s',
  cloud: {
    // Project: Default project
    projectID: 3684621,
    // Test runs with the same name groups test runs together.
    name: 'Test (04/12/2024-20:28:06)'
  }
};

export default function() {
  http.get('https://test.k6.io');
  sleep(1);
}

`401` response

Invalid token or authentication scheme.

Content types: `application/json`

ErrorResponseApiModel properties:

Name	Description	Required	Type
`error`		`true`	`ErrorApiModel`

Details of the error.

ErrorApiModel properties:

Name	Description	Required	Type
`code`	Service-defined error code.	`true`	`string`
`details`	Array of objects with more specific error information when applicable.	`false`	`array` \| `null`
`message`	Human-readable string describing the error.	`true`	`string`
`target`	A string indicating the target of the error. For example, the name of the property in error.	`false`	`string` \| `null`

`403` response

The user does not have permission to perform this action.

Content types: `application/json`

ErrorResponseApiModel properties:

Name	Description	Required	Type
`error`		`true`	`ErrorApiModel`

Details of the error.

ErrorApiModel properties:

Name	Description	Required	Type
`code`	Service-defined error code.	`true`	`string`
`details`	Array of objects with more specific error information when applicable.	`false`	`array` \| `null`
`message`	Human-readable string describing the error.	`true`	`string`
`target`	A string indicating the target of the error. For example, the name of the property in error.	`false`	`string` \| `null`

`404` response

Resource not found.

Content types: `application/json`

ErrorResponseApiModel properties:

Name	Description	Required	Type
`error`		`true`	`ErrorApiModel`

Details of the error.

ErrorApiModel properties:

Name	Description	Required	Type
`code`	Service-defined error code.	`true`	`string`
`details`	Array of objects with more specific error information when applicable.	`false`	`array` \| `null`
`message`	Human-readable string describing the error.	`true`	`string`
`target`	A string indicating the target of the error. For example, the name of the property in error.	`false`	`string` \| `null`

`406` response

The current script type can’t satisfy the request Accept header format.

Content types: `application/json`

ErrorResponseApiModel properties:

Name	Description	Required	Type
`error`		`true`	`ErrorApiModel`

Details of the error.

ErrorApiModel properties:

Name	Description	Required	Type
`code`	Service-defined error code.	`true`	`string`
`details`	Array of objects with more specific error information when applicable.	`false`	`array` \| `null`
`message`	Human-readable string describing the error.	`true`	`string`
`target`	A string indicating the target of the error. For example, the name of the property in error.	`false`	`string` \| `null`

`500` response

Unexpected error.

Content types: `application/json`

ErrorResponseApiModel properties:

Name	Description	Required	Type
`error`		`true`	`ErrorApiModel`

Details of the error.

ErrorApiModel properties:

Name	Description	Required	Type
`code`	Service-defined error code.	`true`	`string`
`details`	Array of objects with more specific error information when applicable.	`false`	`array` \| `null`
`message`	Human-readable string describing the error.	`true`	`string`
`target`	A string indicating the target of the error. For example, the name of the property in error.	`false`	`string` \| `null`

Upload the script for a test

PUT /cloud/v6/load_tests/{id}/script

Upload the script for a test.

The script can be either in the form of a single JavaScript text file or a k6 .tar archive - the type is auto-detected by the API. Any received payload that is not a .tar archive is assumed to be a JavaScript file.

Request parameters

Name Description In Required Type

X-Stack-Id

Numeric ID of the Grafana stack representing the request scope.

If the API is called with a Personal API token, the user must be a member of the specified stack.
If the API is called with a Grafana Stack API token, the value must be the ID of the corresponding stack.

header

true

integer

id ID of the load test. path true integer , format: int64

Request body

Content types: `application/octet-stream`

K6ArchiveScript example

(.tar data)

TextScript example

import http from 'k6/http';
import { sleep } from 'k6';

export const options = {
  vus: 10,
  duration: '30s',
  cloud: {
    // Project: Default project
    projectID: 3684621,
    // Test runs with the same name groups test runs together.
    name: 'Test (04/12/2024-20:28:06)'
  }
};

export default function() {
  http.get('https://test.k6.io');
  sleep(1);
}

`204` response

OK.

`400` response

Request validation error.

Content types: `application/json`

ErrorResponseApiModel properties:

Name	Description	Required	Type
`error`		`true`	`ErrorApiModel`

Details of the error.

ErrorApiModel properties:

Name	Description	Required	Type
`code`	Service-defined error code.	`true`	`string`
`details`	Array of objects with more specific error information when applicable.	`false`	`array` \| `null`
`message`	Human-readable string describing the error.	`true`	`string`
`target`	A string indicating the target of the error. For example, the name of the property in error.	`false`	`string` \| `null`

`401` response

Invalid token or authentication scheme.

Content types: `application/json`

ErrorResponseApiModel properties:

Name	Description	Required	Type
`error`		`true`	`ErrorApiModel`

Details of the error.

ErrorApiModel properties:

Name	Description	Required	Type
`code`	Service-defined error code.	`true`	`string`
`details`	Array of objects with more specific error information when applicable.	`false`	`array` \| `null`
`message`	Human-readable string describing the error.	`true`	`string`
`target`	A string indicating the target of the error. For example, the name of the property in error.	`false`	`string` \| `null`

`403` response

The user does not have permission to perform this action.

Content types: `application/json`

ErrorResponseApiModel properties:

Name	Description	Required	Type
`error`		`true`	`ErrorApiModel`

Details of the error.

ErrorApiModel properties:

Name	Description	Required	Type
`code`	Service-defined error code.	`true`	`string`
`details`	Array of objects with more specific error information when applicable.	`false`	`array` \| `null`
`message`	Human-readable string describing the error.	`true`	`string`
`target`	A string indicating the target of the error. For example, the name of the property in error.	`false`	`string` \| `null`

`404` response

Resource not found.

Content types: `application/json`

ErrorResponseApiModel properties:

Name	Description	Required	Type
`error`		`true`	`ErrorApiModel`

Details of the error.

ErrorApiModel properties:

Name	Description	Required	Type
`code`	Service-defined error code.	`true`	`string`
`details`	Array of objects with more specific error information when applicable.	`false`	`array` \| `null`
`message`	Human-readable string describing the error.	`true`	`string`
`target`	A string indicating the target of the error. For example, the name of the property in error.	`false`	`string` \| `null`

`500` response

Unexpected error.

Content types: `application/json`

ErrorResponseApiModel properties:

Name	Description	Required	Type
`error`		`true`	`ErrorApiModel`

Details of the error.

ErrorApiModel properties:

Name	Description	Required	Type
`code`	Service-defined error code.	`true`	`string`
`details`	Array of objects with more specific error information when applicable.	`false`	`array` \| `null`
`message`	Human-readable string describing the error.	`true`	`string`
`target`	A string indicating the target of the error. For example, the name of the property in error.	`false`	`string` \| `null`

Start a test in Grafana Cloud

POST /cloud/v6/load_tests/{id}/start

Start a test in Grafana Cloud.

Request parameters

Name Description In Required Type

X-Stack-Id

Numeric ID of the Grafana stack representing the request scope.

If the API is called with a Personal API token, the user must be a member of the specified stack.
If the API is called with a Grafana Stack API token, the value must be the ID of the corresponding stack.

header

true

integer

K6-Idempotency-Key Idempotency key to prevent duplicate test starts when retrying requests. The key is valid for 10 minutes. header false string

id ID of the load test. path true integer , format: int64

`200` response

OK.

Content types: `application/json`

StartLoadTestResponse properties:

Name	Description	Required	Type
`cost`	Test run cost details. The cost is available only after test run validation. For test runs still in progress, the value is an estimate of the full cost that will be charged upon successful completion. For finished test runs, the value is the real cost charged for the test run.	`true`	`TestCostApiModel` \| `null`
`created`	Date and time when the test run was started.	`true`	`string` , format: `date-time`
`distribution`	List of the load zones configured for the test and the corresponding distribution percentages.	`true`	`array` \| `null`
`ended`	Date and time when the test run ended. Unset if the test is still running.	`true`	`string` \| `null` , format: `date-time`
`estimated_duration`	The estimated duration of the test run in seconds.	`true`	`integer` \| `null`
`execution_duration`	The real billable duration of the test run in seconds.	`true`	`integer`
`id`	ID of the test run.	`true`	`integer` , format: `int64`
`is_starred`	Whether the test run is starred for quick access.	`true`	`boolean`
`k6_dependencies`	The requested version of k6 and extensions that was part of the script/archive.	`true`	`object`
`k6_versions`	The computed version for k6 and extensions used to run the test.	`true`	`object`
`max_browser_vus`	The maximum number of browser VUs at any stage of the execution plan.	`true`	`integer` \| `null`
`max_vus`	The maximum number of total VUs (browser and protocol) at any stage of the execution plan.	`true`	`integer` \| `null`
`note`	User-defined note for the test run.	`true`	`string`
`options`	The original options object if available.	`true`	`object` \| `null`
`project_id`	ID of the parent project.	`true`	`integer` , format: `int64`
`result`	Test run result. `passed` if there were no issues, `failed` if thresholds were breached, `error` if the execution was not completed.	`true`	`string` \| `null`
`result_details`	Additional information about the test run result.	`true`	`ResultDetailsApiModel` \| `null`
`retention_expiry`	Timestamp after which the test run results are deleted or null if the test run is saved.	`true`	`string` \| `null` , format: `date-time`
`started_by`	Email of the user who started the test if started with a user token.	`true`	`string` \| `null` , format: `email`
`status`	Current test run status.	`true`	`string`
`status_details`	Details of the current test run status.	`true`	`StatusApiModel`
`status_history`	List of test run status objects sorted by the status start time. The list represents the test run status history.	`true`	`Array[StatusApiModel]`
`test_id`	ID of the parent test.	`true`	`integer` , format: `int64`
`test_run_details_page_url`	URL to the Grafana web app test run page.	`true`	`string`

ResultDetailsApiModel properties:

Name	Description	Required	Type
`code`	Service-defined error code if applicable.	`false`	`integer` \| `null`
`message`	Human-readable description of why the test failed or the description of the error if applicable.	`false`	`string` \| `null`
`type`	Type of the result: `passed`, `failed` or `error`.	`true`	`string`

Details of the test run status.

StatusApiModel properties:

Name	Description	Required	Type
`entered`	Date and time when the test run entered the status.	`true`	`string` , format: `date-time`
`extra`	Extra information about the indicated status.	`false`	`StatusExtraApiModel` \| `null`
`type`	Type of simple test run status: `created`, `queued`, `initializing`, `running`, `processing_metrics`, `completed` or `aborted`.	`true`	`string`

StatusExtraApiModel properties:

Name	Description	Required	Type
`by_user`	Email of the user that set the status if applicable.	`true`	`string` \| `null` , format: `email`
`code`	Service-defined error code if applicable.	`true`	`integer` \| `null`
`message`	Human-readable string describing the error if applicable.	`true`	`string` \| `null`

TestCostApiModel properties:

Name	Description	Required	Type
`breakdown`		`true`	`CostBreakdownApiModel`
`total_vuh`	Total number of billed VUH charged for the test run.	`true`

Breakdown details of the test cost.

CostBreakdownApiModel properties:

Name	Description	Required	Type
`base_total_vuh`	VUH usage before applying the effective reduction.	`true`
`browser_vuh`	Number of billed VUH charged for the browser part of the test run.	`true`
`protocol_vuh`	Number of billed VUH charged for the protocol part of the test run.	`true`
`reduction_rate`	The effective reduction rate after applying all individual reductions to the base VUH usage.	`true`
`reduction_rate_breakdown`	The individual reduction rates applied to the base VUH usage.	`true`	`object` \| `null`

Started example

{
  "cost": null,
  "created": "2024-06-01T19:00:00Z",
  "distribution": null,
  "ended": null,
  "estimated_duration": null,
  "execution_duration": 0,
  "id": 1234,
  "is_starred": false,
  "k6_dependencies": {
    "k6": "\u003e=v0.52",
    "k6/x/faker": "\u003e=0.4.0"
  },
  "k6_versions": {
    "k6": "v0.56.0",
    "k6/x/faker": "v0.4.1"
  },
  "max_browser_vus": null,
  "max_vus": null,
  "note": "",
  "options": null,
  "project_id": 12,
  "result": null,
  "result_details": null,
  "retention_expiry": "2024-06-07T19:00:00Z",
  "started_by": "user@example.com",
  "status": "created",
  "status_details": {
    "entered": "2024-06-01T19:00:00Z",
    "type": "created"
  },
  "status_history": [
    {
      "entered": "2024-06-01T19:00:00Z",
      "type": "created"
    }
  ],
  "test_id": 123,
  "test_run_details_page_url": "https://example.grafana.net/a/k6-app/runs/1234"
}

`401` response

Invalid token or authentication scheme.

Content types: `application/json`

ErrorResponseApiModel properties:

Name	Description	Required	Type
`error`		`true`	`ErrorApiModel`

Details of the error.

ErrorApiModel properties:

Name	Description	Required	Type
`code`	Service-defined error code.	`true`	`string`
`details`	Array of objects with more specific error information when applicable.	`false`	`array` \| `null`
`message`	Human-readable string describing the error.	`true`	`string`
`target`	A string indicating the target of the error. For example, the name of the property in error.	`false`	`string` \| `null`

`403` response

The user does not have permission to perform this action.

Content types: `application/json`

ErrorResponseApiModel properties:

Name	Description	Required	Type
`error`		`true`	`ErrorApiModel`

Details of the error.

ErrorApiModel properties:

Name	Description	Required	Type
`code`	Service-defined error code.	`true`	`string`
`details`	Array of objects with more specific error information when applicable.	`false`	`array` \| `null`
`message`	Human-readable string describing the error.	`true`	`string`
`target`	A string indicating the target of the error. For example, the name of the property in error.	`false`	`string` \| `null`

`404` response

Resource not found.

Content types: `application/json`

ErrorResponseApiModel properties:

Name	Description	Required	Type
`error`		`true`	`ErrorApiModel`

Details of the error.

ErrorApiModel properties:

Name	Description	Required	Type
`code`	Service-defined error code.	`true`	`string`
`details`	Array of objects with more specific error information when applicable.	`false`	`array` \| `null`
`message`	Human-readable string describing the error.	`true`	`string`
`target`	A string indicating the target of the error. For example, the name of the property in error.	`false`	`string` \| `null`

`500` response

Unexpected error.

Content types: `application/json`

ErrorResponseApiModel properties:

Name	Description	Required	Type
`error`		`true`	`ErrorApiModel`

Details of the error.

ErrorApiModel properties:

Name	Description	Required	Type
`code`	Service-defined error code.	`true`	`string`
`details`	Array of objects with more specific error information when applicable.	`false`	`array` \| `null`
`message`	Human-readable string describing the error.	`true`	`string`
`target`	A string indicating the target of the error. For example, the name of the property in error.	`false`	`string` \| `null`

List load tests in a project

GET /cloud/v6/projects/{id}/load_tests

List load tests in a project.

Request parameters

Name	Description	In	Required	Type
`X-Stack-Id`	Numeric ID of the Grafana stack representing the request scope. If the API is called with a Personal API token, the user must be a member of the specified stack. If the API is called with a Grafana Stack API token, the value must be the ID of the corresponding stack.	`header`	`true`	`integer`
`$count`	Include collection length in the response object as `@count`.	`query`	`false`	`boolean`
`$orderby`	Comma-separated list of fields to use when ordering the results. Available fields: id project_id name created updated The default ascending order can be reversed by appending the `desc` specifier.	`query`	`false`	`string`
`$skip`	The initial index from which to return the results.	`query`	`false`	`integer`
`$top`	Number of results to return per page. Default: `1000` Maximum: `1000`	`query`	`false`	`integer`
`id`	ID of the project.	`path`	`true`	`integer` , format: `int64`
`name`	Filter results by load test name (exact match).	`query`	`false`	`string`

`200` response

OK.

Content types: `application/json`

LoadTestListResponse properties:

Name	Description	Required	Type
`@count`	Object count in the collection.	`false`	`integer`
`@nextLink`	A reference to the next page of results. The property is included until there are no more pages of results to retrieve.	`false`	`string` , format: `uri`
`value`	List of the resulting values.	`true`	`Array[LoadTestApiModel]`

LoadTestApiModel properties:

Name	Description	Required	Type
`baseline_test_run_id`	ID of a baseline test run used for results comparison. Deprecated: baselines are being replaced by the star/unstar test run APIs and this field is scheduled for removal on 2026-09-01.	`true`	`integer` \| `null` , format: `int64`
`created`	The date when the test was created.	`true`	`string` , format: `date-time`
`id`	ID of the load test.	`true`	`integer` , format: `int64`
`k6_version`	Identifier of the k6 version used to run the test.	`false`	`integer` \| `null`
`name`	Unique name of the test within the project.	`true`	`string`
`project_id`	ID of the parent project.	`true`	`integer` , format: `int64`
`updated`	The date when the test was last updated.	`true`	`string` , format: `date-time`

OK example

{
  "@count": 123,
  "@nextLink": "https://api.k6.io/cloud/v6/projects/312/load_tests?$skip=50\u0026$top=20",
  "value": [
    {
      "baseline_test_run_id": null,
      "created": "2024-12-03T09:53:00.553",
      "id": 1234,
      "k6_version": null,
      "name": "Orders API Soak Test",
      "project_id": 312,
      "updated": "2024-12-03T09:53:00.553"
    }
  ]
}

`400` response

Request validation error.

Content types: `application/json`

ErrorResponseApiModel properties:

Name	Description	Required	Type
`error`		`true`	`ErrorApiModel`

Details of the error.

ErrorApiModel properties:

Name	Description	Required	Type
`code`	Service-defined error code.	`true`	`string`
`details`	Array of objects with more specific error information when applicable.	`false`	`array` \| `null`
`message`	Human-readable string describing the error.	`true`	`string`
`target`	A string indicating the target of the error. For example, the name of the property in error.	`false`	`string` \| `null`

`401` response

Invalid token or authentication scheme.

Content types: `application/json`

ErrorResponseApiModel properties:

Name	Description	Required	Type
`error`		`true`	`ErrorApiModel`

Details of the error.

ErrorApiModel properties:

Name	Description	Required	Type
`code`	Service-defined error code.	`true`	`string`
`details`	Array of objects with more specific error information when applicable.	`false`	`array` \| `null`
`message`	Human-readable string describing the error.	`true`	`string`
`target`	A string indicating the target of the error. For example, the name of the property in error.	`false`	`string` \| `null`

`403` response

The user does not have permission to perform this action.

Content types: `application/json`

ErrorResponseApiModel properties:

Name	Description	Required	Type
`error`		`true`	`ErrorApiModel`

Details of the error.

ErrorApiModel properties:

Name	Description	Required	Type
`code`	Service-defined error code.	`true`	`string`
`details`	Array of objects with more specific error information when applicable.	`false`	`array` \| `null`
`message`	Human-readable string describing the error.	`true`	`string`
`target`	A string indicating the target of the error. For example, the name of the property in error.	`false`	`string` \| `null`

`404` response

Resource not found.

Content types: `application/json`

ErrorResponseApiModel properties:

Name	Description	Required	Type
`error`		`true`	`ErrorApiModel`

Details of the error.

ErrorApiModel properties:

Name	Description	Required	Type
`code`	Service-defined error code.	`true`	`string`
`details`	Array of objects with more specific error information when applicable.	`false`	`array` \| `null`
`message`	Human-readable string describing the error.	`true`	`string`
`target`	A string indicating the target of the error. For example, the name of the property in error.	`false`	`string` \| `null`

`500` response

Unexpected error.

Content types: `application/json`

ErrorResponseApiModel properties:

Name	Description	Required	Type
`error`		`true`	`ErrorApiModel`

Details of the error.

ErrorApiModel properties:

Name	Description	Required	Type
`code`	Service-defined error code.	`true`	`string`
`details`	Array of objects with more specific error information when applicable.	`false`	`array` \| `null`
`message`	Human-readable string describing the error.	`true`	`string`
`target`	A string indicating the target of the error. For example, the name of the property in error.	`false`	`string` \| `null`

Create a new test

POST /cloud/v6/projects/{id}/load_tests

Create a new test in the project.

Request parameters

Name Description In Required Type

X-Stack-Id

Numeric ID of the Grafana stack representing the request scope.

If the API is called with a Personal API token, the user must be a member of the specified stack.
If the API is called with a Grafana Stack API token, the value must be the ID of the corresponding stack.

header

true

integer

id ID of the project. path true integer , format: int64

Request body

Content types: `multipart/form-data`

CreateLoadTestApiModel properties:

Name	Description	Required	Type
`k6_version`	Identifier of the k6 version used to run the test.	`false`	`integer` \| `null`
`name`	Unique name of the test within the project.	`true`	`string`
`script`	Test script in the form of a UTF-8 encoded text or a k6 .tar archive.	`false`	`string` \| `null` , format: `binary`

`201` response

OK.

Content types: `application/json`

LoadTestApiModel properties:

Name	Description	Required	Type
`baseline_test_run_id`	ID of a baseline test run used for results comparison. Deprecated: baselines are being replaced by the star/unstar test run APIs and this field is scheduled for removal on 2026-09-01.	`true`	`integer` \| `null` , format: `int64`
`created`	The date when the test was created.	`true`	`string` , format: `date-time`
`id`	ID of the load test.	`true`	`integer` , format: `int64`
`k6_version`	Identifier of the k6 version used to run the test.	`false`	`integer` \| `null`
`name`	Unique name of the test within the project.	`true`	`string`
`project_id`	ID of the parent project.	`true`	`integer` , format: `int64`
`updated`	The date when the test was last updated.	`true`	`string` , format: `date-time`

OK example

{
  "baseline_test_run_id": null,
  "created": "2024-12-03T09:53:00.553",
  "id": 1234,
  "k6_version": null,
  "name": "Orders API Soak Test",
  "project_id": 312,
  "updated": "2024-12-03T09:53:00.553"
}

`400` response

Request validation error.

Content types: `application/json`

ErrorResponseApiModel properties:

Name	Description	Required	Type
`error`		`true`	`ErrorApiModel`

Details of the error.

ErrorApiModel properties:

Name	Description	Required	Type
`code`	Service-defined error code.	`true`	`string`
`details`	Array of objects with more specific error information when applicable.	`false`	`array` \| `null`
`message`	Human-readable string describing the error.	`true`	`string`
`target`	A string indicating the target of the error. For example, the name of the property in error.	`false`	`string` \| `null`

`401` response

Invalid token or authentication scheme.

Content types: `application/json`

ErrorResponseApiModel properties:

Name	Description	Required	Type
`error`		`true`	`ErrorApiModel`

Details of the error.

ErrorApiModel properties:

Name	Description	Required	Type
`code`	Service-defined error code.	`true`	`string`
`details`	Array of objects with more specific error information when applicable.	`false`	`array` \| `null`
`message`	Human-readable string describing the error.	`true`	`string`
`target`	A string indicating the target of the error. For example, the name of the property in error.	`false`	`string` \| `null`

`403` response

The user does not have permission to perform this action.

Content types: `application/json`

ErrorResponseApiModel properties:

Name	Description	Required	Type
`error`		`true`	`ErrorApiModel`

Details of the error.

ErrorApiModel properties:

Name	Description	Required	Type
`code`	Service-defined error code.	`true`	`string`
`details`	Array of objects with more specific error information when applicable.	`false`	`array` \| `null`
`message`	Human-readable string describing the error.	`true`	`string`
`target`	A string indicating the target of the error. For example, the name of the property in error.	`false`	`string` \| `null`

`404` response

Resource not found.

Content types: `application/json`

ErrorResponseApiModel properties:

Name	Description	Required	Type
`error`		`true`	`ErrorApiModel`

Details of the error.

ErrorApiModel properties:

Name	Description	Required	Type
`code`	Service-defined error code.	`true`	`string`
`details`	Array of objects with more specific error information when applicable.	`false`	`array` \| `null`
`message`	Human-readable string describing the error.	`true`	`string`
`target`	A string indicating the target of the error. For example, the name of the property in error.	`false`	`string` \| `null`

`409` response

The name is already taken.

Content types: `application/json`

ErrorResponseApiModel properties:

Name	Description	Required	Type
`error`		`true`	`ErrorApiModel`

Details of the error.

ErrorApiModel properties:

Name	Description	Required	Type
`code`	Service-defined error code.	`true`	`string`
`details`	Array of objects with more specific error information when applicable.	`false`	`array` \| `null`
`message`	Human-readable string describing the error.	`true`	`string`
`target`	A string indicating the target of the error. For example, the name of the property in error.	`false`	`string` \| `null`

`500` response

Unexpected error.

Content types: `application/json`

ErrorResponseApiModel properties:

Name	Description	Required	Type
`error`		`true`	`ErrorApiModel`

Details of the error.

ErrorApiModel properties:

Name	Description	Required	Type
`code`	Service-defined error code.	`true`	`string`
`details`	Array of objects with more specific error information when applicable.	`false`	`array` \| `null`
`message`	Human-readable string describing the error.	`true`	`string`
`target`	A string indicating the target of the error. For example, the name of the property in error.	`false`	`string` \| `null`

Validate k6 script options

POST /cloud/v6/validate_options

Verify a test can be run in Grafana Cloud with the provided k6 script options.

Project ID can be specified in the root object as well as under options.cloud.

Request parameters

Name Description In Required Type

X-Stack-Id

Numeric ID of the Grafana stack representing the request scope.

If the API is called with a Personal API token, the user must be a member of the specified stack.
If the API is called with a Grafana Stack API token, the value must be the ID of the corresponding stack.

header

true

integer

Request body

Content types: `application/json`

ValidateOptionsRequest properties:

Name	Description	Required	Type
`is_local_execution`	Whether the test is being executed locally.	`false`	`boolean`
`k6_dependencies`	Version of k6 and extensions to validate, as a map of dependency name to dependency version constraint.	`false`	`object` \| `null`
`k6_version`	Identifier of the k6 version used to run the test.	`false`	`integer` \| `null`
`options`	k6 script options object to validate.	`true`	`Options`
`project_id`	ID of a project where the test belongs.	`false`	`integer` \| `null` , format: `int64`

Options properties:

Name	Description	Required	Type
`cloud`	Cloud-specific k6 options.	`false`	`CloudOptions` \| `null`

CloudOptions properties:

Name	Description	Required	Type
`projectID`	ID of a project where the test belongs.	`false`	`integer` \| `null` , format: `int64`

ProjectIdInOptionsExtensionsWithVersioning example

{
  "k6_dependencies": {
    "k6": "\u003e=v0.52",
    "k6/x/faker": "\u003e=0.4.0"
  },
  "options": {
    "cloud": {
      "distribution": {
        "amazon:us:ashburn": {
          "loadZone": "amazon:us:ashburn",
          "percent": 100
        }
      },
      "projectID": 123456
    },
    "stages": [
      {
        "duration": "1m",
        "target": 20
      },
      {
        "duration": "3m",
        "target": 20
      },
      {
        "duration": "30s",
        "target": 0
      }
    ]
  }
}

ProjectIdInOptionsExtensionsWithoutVersioning example

{
  "k6_dependencies": {
    "k6": "*",
    "k6/x/faker": "*"
  },
  "options": {
    "cloud": {
      "distribution": {
        "amazon:us:ashburn": {
          "loadZone": "amazon:us:ashburn",
          "percent": 100
        }
      },
      "projectID": 123456
    },
    "stages": [
      {
        "duration": "1m",
        "target": 20
      },
      {
        "duration": "3m",
        "target": 20
      },
      {
        "duration": "30s",
        "target": 0
      }
    ]
  }
}

ProjectIdInOptionsNoDependencies example

{
  "options": {
    "cloud": {
      "distribution": {
        "amazon:us:ashburn": {
          "loadZone": "amazon:us:ashburn",
          "percent": 100
        }
      },
      "projectID": 123456
    },
    "stages": [
      {
        "duration": "1m",
        "target": 20
      },
      {
        "duration": "3m",
        "target": 20
      },
      {
        "duration": "30s",
        "target": 0
      }
    ]
  }
}

`200` response

OK.

Content types: `application/json`

ValidateOptionsResponse properties:

Name	Description	Required	Type
`breakdown`	Breakdown of the VUH usage.	`true`	`CostBreakdownApiModel`
`vuh_usage`	How many VUH will be charged for the test.	`true`	`number`

Breakdown details of the test cost.

CostBreakdownApiModel properties:

Name	Description	Required	Type
`base_total_vuh`	VUH usage before applying the effective reduction.	`true`
`browser_vuh`	Number of billed VUH charged for the browser part of the test run.	`true`
`protocol_vuh`	Number of billed VUH charged for the protocol part of the test run.	`true`
`reduction_rate`	The effective reduction rate after applying all individual reductions to the base VUH usage.	`true`
`reduction_rate_breakdown`	The individual reduction rates applied to the base VUH usage.	`true`	`object` \| `null`

OK example

{
  "breakdown": {
    "base_total_vuh": 10,
    "browser_vuh": 0,
    "protocol_vuh": 6.75,
    "reduction_rate": 32.5,
    "reduction_rate_breakdown": {
      "local_run": 25,
      "volume": 10
    }
  },
  "vuh_usage": 6.75
}

`400` response

Request validation error.

Content types: `application/json`

ErrorResponseApiModel properties:

Name	Description	Required	Type
`error`		`true`	`ErrorApiModel`

Details of the error.

ErrorApiModel properties:

Name	Description	Required	Type
`code`	Service-defined error code.	`true`	`string`
`details`	Array of objects with more specific error information when applicable.	`false`	`array` \| `null`
`message`	Human-readable string describing the error.	`true`	`string`
`target`	A string indicating the target of the error. For example, the name of the property in error.	`false`	`string` \| `null`

`401` response

Invalid token or authentication scheme.

Content types: `application/json`

ErrorResponseApiModel properties:

Name	Description	Required	Type
`error`		`true`	`ErrorApiModel`

Details of the error.

ErrorApiModel properties:

Name	Description	Required	Type
`code`	Service-defined error code.	`true`	`string`
`details`	Array of objects with more specific error information when applicable.	`false`	`array` \| `null`
`message`	Human-readable string describing the error.	`true`	`string`
`target`	A string indicating the target of the error. For example, the name of the property in error.	`false`	`string` \| `null`

`403` response

The user does not have permission to perform this action.

Content types: `application/json`

ErrorResponseApiModel properties:

Name	Description	Required	Type
`error`		`true`	`ErrorApiModel`

Details of the error.

ErrorApiModel properties:

Name	Description	Required	Type
`code`	Service-defined error code.	`true`	`string`
`details`	Array of objects with more specific error information when applicable.	`false`	`array` \| `null`
`message`	Human-readable string describing the error.	`true`	`string`
`target`	A string indicating the target of the error. For example, the name of the property in error.	`false`	`string` \| `null`

`500` response

Unexpected error.

Content types: `application/json`

ErrorResponseApiModel properties:

Name	Description	Required	Type
`error`		`true`	`ErrorApiModel`

Details of the error.

ErrorApiModel properties:

Name	Description	Required	Type
`code`	Service-defined error code.	`true`	`string`
`details`	Array of objects with more specific error information when applicable.	`false`	`array` \| `null`
`message`	Human-readable string describing the error.	`true`	`string`
`target`	A string indicating the target of the error. For example, the name of the property in error.	`false`	`string` \| `null`

Was this page helpful?

Email docs@grafana.com

Help and support

Community

Tests REST API

List all tests

Request parameters

200 response

Content types: application/json

OK example

400 response

Content types: application/json

401 response

Content types: application/json

403 response

Content types: application/json

500 response

Content types: application/json

Get a load test by ID

Request parameters

200 response

Content types: application/json

OK example

401 response

Content types: application/json

403 response

Content types: application/json

404 response

Content types: application/json

500 response

Content types: application/json

Delete a load test

Request parameters

204 response

401 response

Content types: application/json

403 response

Content types: application/json

404 response

Content types: application/json

409 response

Content types: application/json

500 response

Content types: application/json

Update a load test

Request parameters

Request body

Content types: application/json

Update example

204 response

400 response

Content types: application/json

401 response

Content types: application/json

403 response

Content types: application/json

404 response

Content types: application/json

409 response

Content types: application/json

500 response

Content types: application/json

Move a test to another project

Request parameters

Request body

Content types: application/json

Move example

204 response

400 response

Content types: application/json

401 response

Content types: application/json

403 response

Content types: application/json

404 response

Content types: application/json

409 response

Content types: application/json

500 response

Content types: application/json

Download the test script

Request parameters

200 response

Content types: application/x-tar text/javascript

`200` response

Content types: `application/json`

`400` response

Content types: `application/json`

`401` response

Content types: `application/json`

`403` response

Content types: `application/json`

`500` response

Content types: `application/json`

`200` response

Content types: `application/json`

`401` response

Content types: `application/json`

`403` response

Content types: `application/json`

`404` response

Content types: `application/json`

`500` response

Content types: `application/json`

`204` response

`401` response

Content types: `application/json`

`403` response

Content types: `application/json`

`404` response

Content types: `application/json`

`409` response

Content types: `application/json`

`500` response

Content types: `application/json`

Content types: `application/json`

`204` response

`400` response

Content types: `application/json`

`401` response

Content types: `application/json`

`403` response

Content types: `application/json`

`404` response

Content types: `application/json`

`409` response

Content types: `application/json`

`500` response

Content types: `application/json`

Content types: `application/json`

`204` response

`400` response

Content types: `application/json`

`401` response

Content types: `application/json`

`403` response

Content types: `application/json`

`404` response

Content types: `application/json`

`409` response

Content types: `application/json`

`500` response

Content types: `application/json`

`200` response

Content types: `application/x-tar` `text/javascript`

`401` response

Content types: `application/json`

`403` response

Content types: `application/json`

`404` response

Content types: `application/json`

`406` response

Content types: `application/json`

`500` response

Content types: `application/json`

Content types: `application/octet-stream`

`204` response

`400` response

Content types: `application/json`

`401` response

Content types: `application/json`

`403` response

Content types: `application/json`

`404` response