Menu
Documentationbreadcrumb arrow Grafana Cloudbreadcrumb arrow Testing and syntheticsbreadcrumb arrow Performance testingbreadcrumb arrow Reference pagesbreadcrumb arrow Cloud REST APIbreadcrumb arrow V5breadcrumb arrow Projects
Grafana Cloud

Projects REST API

Warning

The use of this API is discouraged in favor of API v6 Projects.

Use these endpoints to access Projects data in Grafana Cloud k6.

To learn more about Projects, refer to the Projects documentation.

List projects

GET /projects

Example URL with optional parameters:

GET /projects?$top=10&$skip=20&$count=true&$select=id,name,created&$orderby=created desc&$filter=contains(name,'tests')

Parameters

All parameters are optional.

ParameterDescription
$selectSpecifies a comma-separated list of properties to include in the response.
$orderbySpecifies the sorting order for the returned results. It accepts one or more comma-separated properties with an optional asc (ascending) or desc (descending) keyword.
$topLimits the number of items to return in the response.
$skipSpecifies the number of items to skip in the result set before returning the remaining items. It is used for paging through a large result set.
$countIncludes a count of the total number of items in the result set in the response.
$filterFilters the result set based on specified conditions.

Example request:

http 
GET https://api.k6.io/cloud/v5/projects?$count=true
Accept: application/json
Authorization: Token 56c166885f9a7fc1e588a1b3cb66f6dd

Example response

http 
HTTP/1.1 200
Content-Type: application/json

{
  "@count": "2",
  "value": [
    {
      "created": "2023-02-21T20:29:21.741391Z",
      "description": "Default project",
      "id": 5175,
      "name": "My first project",
      "organization_id": 499,
      "updated": "2023-02-28T08:22:36.362574Z"
    },
    {
      "created": "2023-02-28T08:22:10.253310Z",
      "description": "Load tests to simulate heavy traffic",
      "id": 5276,
      "name": "Heavy tests",
      "organization_id": 499,
      "updated": "2023-02-28T08:22:47.550033Z"
    },
}

Get single project by Id

GET /projects/:id

Parameters

ParameterDescription
$select(optional) Specifies a comma-separated list of properties to include in the response.

Example Request:

http 
GET https://api.k6.io/cloud/v5/projects/5175?$select=id,name,description
Accept: application/json
Authorization: Token 56c166885f9a7fc1e588a1b3cb66f6dd

Example Response:

http 
HTTP/1.1 200
Content-Type: application/json

{
  "description": "Default project",
  "id": 5175,
  "name": "My first project",
}