Documentation Grafana Cloud Testing and synthetics Performance testing Reference pages Cloud REST API Load zones

Load zones REST API

List all load zones

GET /cloud/v6/load_zones

List all load zones.

Request parameters

200 response

OK.

Content types: application/json

LoadZonesListApiModel properties:

LoadZoneApiModel properties:

OK example

{
  "value": [
    {
      "id": 1,
      "k6_load_zone_id": "amazon:us:ashburn",
      "name": "US East (N. Virginia)"
    },
    {
      "id": 2,
      "k6_load_zone_id": "ops-playground-plz",
      "name": "Ops playground"
    },
    {
      "id": 3,
      "k6_load_zone_id": "amazon:jp:tokyo",
      "name": "Asia Pacific (Tokyo)"
    }
  ]
}

400 response

401 response

403 response

500 response

List projects allowed to use a given load zone

GET /cloud/v6/load_zones/{id}/allowed_projects

List projects allowed to use a given load zone.

Request parameters

200 response

OK.

Content types: application/json

AllowedProjectsListApiModel properties:

AllowedProjectApiModel properties:

OK example

{
  "value": [
    {
      "id": 139,
      "k6_load_zone_id": "my-sample-project",
      "name": "My sample project"
    },
    {
      "id": 328,
      "k6_load_zone_id": "platform-load-tests",
      "name": "Platform load tests"
    },
    {
      "id": 6789,
      "k6_load_zone_id": "ops-playground",
      "name": "Ops playground"
    }
  ]
}

401 response

403 response

404 response

500 response

Update the list of projects allowed to use a given load zone

PUT /cloud/v6/load_zones/{id}/allowed_projects

Update the list of projects allowed to use a given load zone.

Request parameters

Request body

Content types: application/json

UpdateAllowedProjectsListApiModel properties:

AllowedProjectToUpdateApiModel properties:

Update example

{
  "value": [
    {
      "id": 7284
    },
    {
      "id": 8768
    },
    {
      "id": 348
    }
  ]
}

200 response

OK.

Content types: application/json

AllowedProjectsListApiModel properties:

AllowedProjectApiModel properties:

OK example

{
  "value": [
    {
      "id": 139,
      "k6_load_zone_id": "my-sample-project",
      "name": "My sample project"
    },
    {
      "id": 328,
      "k6_load_zone_id": "platform-load-tests",
      "name": "Platform load tests"
    },
    {
      "id": 6789,
      "k6_load_zone_id": "ops-playground",
      "name": "Ops playground"
    }
  ]
}

400 response

401 response

403 response

404 response

500 response

List load zones that can be used by a given project

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

List load zones that can be used by a given project.

Request parameters

200 response

OK.

Content types: application/json

AllowedLoadZonesListApiModel properties:

AllowedLoadZoneApiModel properties:

OK example

{
  "value": [
    {
      "id": 24,
      "k6_load_zone_id": "eu-region-load-zone",
      "name": "EU region load zone"
    },
    {
      "id": 173,
      "k6_load_zone_id": "us-region-load-zone",
      "name": "US region load zone"
    },
    {
      "id": 8345,
      "k6_load_zone_id": "ops-playground-load-zone",
      "name": "Ops playground load zone"
    }
  ]
}

401 response

403 response

404 response

500 response

Update the list of load zones that can be used by a given project

PUT /cloud/v6/projects/{id}/allowed_load_zones

Update the list of load zones that can be used by a given project.

Request parameters

Request body

Content types: application/json

UpdateAllowedLoadZonesListApiModel properties:

AllowedLoadZoneToUpdateApiModel properties:

Update example

{
  "value": [
    {
      "id": 11
    },
    {
      "id": 871
    },
    {
      "id": 17
    }
  ]
}

200 response

OK.

Content types: application/json

AllowedLoadZonesListApiModel properties:

AllowedLoadZoneApiModel properties:

OK example

{
  "value": [
    {
      "id": 24,
      "k6_load_zone_id": "eu-region-load-zone",
      "name": "EU region load zone"
    },
    {
      "id": 173,
      "k6_load_zone_id": "us-region-load-zone",
      "name": "US region load zone"
    },
    {
      "id": 8345,
      "k6_load_zone_id": "ops-playground-load-zone",
      "name": "Ops playground load zone"
    }
  ]
}

400 response

401 response

403 response

404 response

500 response