Menu
Documentationbreadcrumb arrow Grafana Cloudbreadcrumb arrow Testing and syntheticsbreadcrumb arrow Performance testingbreadcrumb arrow Reference pagesbreadcrumb arrow Cloud REST APIbreadcrumb arrow Legacy REST APIbreadcrumb arrow Tests
Grafana Cloud

Tests Legacy API

Warning

The Legacy REST API is no longer under active development. It should not be used except when it provides capabilities not yet offered by the Grafana Cloud k6 REST API.

To read, update, and start tests, use the /loadtests/v2/tests/ path.

List load tests

Returns all tests within a specified project. If no project is specified, k6 returns the default project.

You MAY sort or query the results with query parameters.

GET https://api.k6.io/loadtests/v2/tests

Query ParametersTypeDescriptionExample
project_idintegerReturns tests associated with a given project_id/loadtests/v2/tests?project_id={project_id}
ids[]integerReturns tests with given ids./loadtests/v2/tests?ids[]={id_1}&ids[]={id_2}
order_bystringSelects the parameter to use to order the returned tests. Available parameter values: id, name, last_run_time./loadtests/v2/tests?project_id={project_id}&order_by=last_run_time
qstringReturns tests whose name property matches the queried string./loadtests/v2/tests?project_id={project_id}&q=some_string
pageintegerA page number within the paginated result set./loadtests/v2/tests?project_id={project_id}&page=2&page_size=5
page_sizeintegerNumber of results to return per page./loadtests/v2/tests?project_id={project_id}&page=2&page_size=5
json 
{
  "k6-runs": [],
  "k6-tests": [
    {
      "id": 0,
      "project_id": 0,
      "user_id": 0,
      "name": "string",
      "created": "2020-08-13T18:28:45Z",
      "updated": "2020-08-13T18:28:45Z",
      "last_test_run_id": "string",
      "test_run_ids": [0],
      "script": "string"
    }
  ],
  "load_zones": [],
  "meta": {
    "count": 1
  }
}

Read load test

Returns details of a test with the specified ID.

GET https://api.k6.io/loadtests/v2/tests/{id}

Path ParameterTypeDescription
idintegerA unique integer value identifying this test.
json 
{
  "k6-test": {
    "id": 0,
    "project_id": 0,
    "user_id": 0,
    "name": "string",
    "created": "2020-08-13T18:28:45Z",
    "updated": "2020-08-13T18:28:45Z",
    "last_test_run_id": "string",
    "test_run_ids": [],
    "script": "string"
  }
}

Update load test

Partially updates a cloud test.

PATCH https://api.k6.io/loadtests/v2/tests/{id}

Path ParameterTypeDescription
idintegerA unique integer value identifying this test.
Request Body ParameterTypeDescription
namestringName of the test.
scriptstringk6 script to use when starting test runs.
json 
{
  "k6-test": {
    "id": 0,
    "project_id": 0,
    "user_id": 0,
    "name": "string",
    "created": "2020-08-13T18:28:45Z",
    "updated": "2020-08-13T18:28:45Z",
    "last_test_run_id": "string",
    "test_run_ids": [0],
    "script": "string"
  }
}

Delete load test

Deletes a test with the specified test ID.

DELETE https://api.k6.io/loadtests/v2/tests/{id}

Path ParameterTypeDescription
idintegerA unique integer value identifying this test.

RESPONSE 204