Documentationbreadcrumb arrow Grafana Cloudbreadcrumb arrow Testing and syntheticsbreadcrumb arrow Performance testingbreadcrumb arrow Reference pagesbreadcrumb arrow Cloud REST APIbreadcrumb arrow Load zones
Grafana Cloud

Load zones REST API

Note

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

List all load zones

GET /cloud/v6/load_zones

List all load zones.

Request parameters

NameDescriptionInRequiredType
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.
headertrueinteger
k6_load_zone_idFilter results by k6 load zone ID (exact match).queryfalsestring

200 response

OK.

Content types: application/json

LoadZonesListApiModel properties:

NameDescriptionRequiredType
valueList of the resulting values.trueArray[LoadZoneApiModel]

LoadZoneApiModel properties:

NameDescriptionRequiredType
availableWhether the load zone can be used to start tests.trueboolean
custom_load_runner_imageCustom load runner image. Only set for private load zones.truestring | null
idID of the load zone.trueinteger , format: int64
k6_load_zone_idID used to identify the load zone in the k6 scripts.truestring
nameName of the load zone.truestring
publicWhether the load zone is public or private.trueboolean
OK example
{
  "value": [
    {
      "available": true,
      "custom_load_runner_image": null,
      "id": 1,
      "k6_load_zone_id": "amazon:us:ashburn",
      "name": "US East (N. Virginia)",
      "public": true
    },
    {
      "available": true,
      "custom_load_runner_image": "grafana/k6:latest",
      "id": 2,
      "k6_load_zone_id": "ops-playground-plz",
      "name": "Ops playground",
      "public": false
    },
    {
      "available": false,
      "custom_load_runner_image": null,
      "id": 3,
      "k6_load_zone_id": "amazon:jp:tokyo",
      "name": "Asia Pacific (Tokyo)",
      "public": true
    }
  ]
}

400 response

Request validation error.

Content types: application/json

ErrorResponseApiModel properties:

NameDescriptionRequiredType
errortrueErrorApiModel

Details of the error.

ErrorApiModel properties:

NameDescriptionRequiredType
codeService-defined error code.truestring
detailsArray of objects with more specific error information when applicable.falsearray | null
messageHuman-readable string describing the error.truestring
targetA string indicating the target of the error. For example, the name of the property in error.falsestring | null

401 response

Invalid token or authentication scheme.

Content types: application/json

ErrorResponseApiModel properties:

NameDescriptionRequiredType
errortrueErrorApiModel

Details of the error.

ErrorApiModel properties:

NameDescriptionRequiredType
codeService-defined error code.truestring
detailsArray of objects with more specific error information when applicable.falsearray | null
messageHuman-readable string describing the error.truestring
targetA string indicating the target of the error. For example, the name of the property in error.falsestring | null

403 response

The user does not have permission to perform this action.

Content types: application/json

ErrorResponseApiModel properties:

NameDescriptionRequiredType
errortrueErrorApiModel

Details of the error.

ErrorApiModel properties:

NameDescriptionRequiredType
codeService-defined error code.truestring
detailsArray of objects with more specific error information when applicable.falsearray | null
messageHuman-readable string describing the error.truestring
targetA string indicating the target of the error. For example, the name of the property in error.falsestring | null

500 response

Unexpected error.

Content types: application/json

ErrorResponseApiModel properties:

NameDescriptionRequiredType
errortrueErrorApiModel

Details of the error.

ErrorApiModel properties:

NameDescriptionRequiredType
codeService-defined error code.truestring
detailsArray of objects with more specific error information when applicable.falsearray | null
messageHuman-readable string describing the error.truestring
targetA string indicating the target of the error. For example, the name of the property in error.falsestring | null

List projects allowed to use a given private load zone

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

List projects allowed to use a given private load zone.

Request parameters

NameDescriptionInRequiredType
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.
headertrueinteger
idID of the load zone.pathtrueinteger , format: int64

200 response

OK.

Content types: application/json

AllowedProjectsListApiModel properties:

NameDescriptionRequiredType
valueList of the resulting values.trueArray[AllowedProjectApiModel]

AllowedProjectApiModel properties:

NameDescriptionRequiredType
idID of the project.trueinteger , format: int64
nameName of the project.truestring
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

Invalid token or authentication scheme.

Content types: application/json

ErrorResponseApiModel properties:

NameDescriptionRequiredType
errortrueErrorApiModel

Details of the error.

ErrorApiModel properties:

NameDescriptionRequiredType
codeService-defined error code.truestring
detailsArray of objects with more specific error information when applicable.falsearray | null
messageHuman-readable string describing the error.truestring
targetA string indicating the target of the error. For example, the name of the property in error.falsestring | null

403 response

The user does not have permission to perform this action.

Content types: application/json

ErrorResponseApiModel properties:

NameDescriptionRequiredType
errortrueErrorApiModel

Details of the error.

ErrorApiModel properties:

NameDescriptionRequiredType
codeService-defined error code.truestring
detailsArray of objects with more specific error information when applicable.falsearray | null
messageHuman-readable string describing the error.truestring
targetA string indicating the target of the error. For example, the name of the property in error.falsestring | null

404 response

Resource not found.

Content types: application/json

ErrorResponseApiModel properties:

NameDescriptionRequiredType
errortrueErrorApiModel

Details of the error.

ErrorApiModel properties:

NameDescriptionRequiredType
codeService-defined error code.truestring
detailsArray of objects with more specific error information when applicable.falsearray | null
messageHuman-readable string describing the error.truestring
targetA string indicating the target of the error. For example, the name of the property in error.falsestring | null

500 response

Unexpected error.

Content types: application/json

ErrorResponseApiModel properties:

NameDescriptionRequiredType
errortrueErrorApiModel

Details of the error.

ErrorApiModel properties:

NameDescriptionRequiredType
codeService-defined error code.truestring
detailsArray of objects with more specific error information when applicable.falsearray | null
messageHuman-readable string describing the error.truestring
targetA string indicating the target of the error. For example, the name of the property in error.falsestring | null

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

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

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

Request parameters

NameDescriptionInRequiredType
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.
headertrueinteger
idID of the load zone.pathtrueinteger , format: int64

Request body

Content types: application/json

UpdateAllowedProjectsListApiModel properties:

NameDescriptionRequiredType
valueList of the projects that will become allowed to use load zone.trueArray[AllowedProjectToUpdateApiModel]

AllowedProjectToUpdateApiModel properties:

NameDescriptionRequiredType
idID of the project.trueinteger , format: int64
Update example
{
  "value": [
    {
      "id": 7284
    },
    {
      "id": 8768
    },
    {
      "id": 348
    }
  ]
}

200 response

OK.

Content types: application/json

AllowedProjectsListApiModel properties:

NameDescriptionRequiredType
valueList of the resulting values.trueArray[AllowedProjectApiModel]

AllowedProjectApiModel properties:

NameDescriptionRequiredType
idID of the project.trueinteger , format: int64
nameName of the project.truestring
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

Request validation error.

Content types: application/json

ErrorResponseApiModel properties:

NameDescriptionRequiredType
errortrueErrorApiModel

Details of the error.

ErrorApiModel properties:

NameDescriptionRequiredType
codeService-defined error code.truestring
detailsArray of objects with more specific error information when applicable.falsearray | null
messageHuman-readable string describing the error.truestring
targetA string indicating the target of the error. For example, the name of the property in error.falsestring | null

401 response

Invalid token or authentication scheme.

Content types: application/json

ErrorResponseApiModel properties:

NameDescriptionRequiredType
errortrueErrorApiModel

Details of the error.

ErrorApiModel properties:

NameDescriptionRequiredType
codeService-defined error code.truestring
detailsArray of objects with more specific error information when applicable.falsearray | null
messageHuman-readable string describing the error.truestring
targetA string indicating the target of the error. For example, the name of the property in error.falsestring | null

403 response

The user does not have permission to perform this action.

Content types: application/json

ErrorResponseApiModel properties:

NameDescriptionRequiredType
errortrueErrorApiModel

Details of the error.

ErrorApiModel properties:

NameDescriptionRequiredType
codeService-defined error code.truestring
detailsArray of objects with more specific error information when applicable.falsearray | null
messageHuman-readable string describing the error.truestring
targetA string indicating the target of the error. For example, the name of the property in error.falsestring | null

404 response

Resource not found.

Content types: application/json

ErrorResponseApiModel properties:

NameDescriptionRequiredType
errortrueErrorApiModel

Details of the error.

ErrorApiModel properties:

NameDescriptionRequiredType
codeService-defined error code.truestring
detailsArray of objects with more specific error information when applicable.falsearray | null
messageHuman-readable string describing the error.truestring
targetA string indicating the target of the error. For example, the name of the property in error.falsestring | null

500 response

Unexpected error.

Content types: application/json

ErrorResponseApiModel properties:

NameDescriptionRequiredType
errortrueErrorApiModel

Details of the error.

ErrorApiModel properties:

NameDescriptionRequiredType
codeService-defined error code.truestring
detailsArray of objects with more specific error information when applicable.falsearray | null
messageHuman-readable string describing the error.truestring
targetA string indicating the target of the error. For example, the name of the property in error.falsestring | null

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

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

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

Request parameters

NameDescriptionInRequiredType
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.
headertrueinteger
idID of the project.pathtrueinteger , format: int64

200 response

OK.

Content types: application/json

AllowedLoadZonesListApiModel properties:

NameDescriptionRequiredType
valueList of the resulting values.trueArray[AllowedLoadZoneApiModel]

AllowedLoadZoneApiModel properties:

NameDescriptionRequiredType
availableWhether the load zone can be used to start tests.trueboolean
custom_load_runner_imageCustom load runner image. Only set for private load zones.truestring | null
idID of the load zone.trueinteger , format: int64
k6_load_zone_idID used to identify the load zone in the k6 scripts.truestring
nameName of the load zone.truestring
publicWhether the load zone is public or private.trueboolean
OK example
{
  "value": [
    {
      "available": true,
      "custom_load_runner_image": "grafana/k6:latest",
      "id": 24,
      "k6_load_zone_id": "eu-region-load-zone",
      "name": "EU region load zone",
      "public": false
    },
    {
      "available": true,
      "custom_load_runner_image": "grafana/k6:latest",
      "id": 173,
      "k6_load_zone_id": "us-region-load-zone",
      "name": "US region load zone",
      "public": false
    },
    {
      "available": false,
      "custom_load_runner_image": null,
      "id": 8345,
      "k6_load_zone_id": "ops-playground-load-zone",
      "name": "Ops playground load zone",
      "public": false
    }
  ]
}

401 response

Invalid token or authentication scheme.

Content types: application/json

ErrorResponseApiModel properties:

NameDescriptionRequiredType
errortrueErrorApiModel

Details of the error.

ErrorApiModel properties:

NameDescriptionRequiredType
codeService-defined error code.truestring
detailsArray of objects with more specific error information when applicable.falsearray | null
messageHuman-readable string describing the error.truestring
targetA string indicating the target of the error. For example, the name of the property in error.falsestring | null

403 response

The user does not have permission to perform this action.

Content types: application/json

ErrorResponseApiModel properties:

NameDescriptionRequiredType
errortrueErrorApiModel

Details of the error.

ErrorApiModel properties:

NameDescriptionRequiredType
codeService-defined error code.truestring
detailsArray of objects with more specific error information when applicable.falsearray | null
messageHuman-readable string describing the error.truestring
targetA string indicating the target of the error. For example, the name of the property in error.falsestring | null

404 response

Resource not found.

Content types: application/json

ErrorResponseApiModel properties:

NameDescriptionRequiredType
errortrueErrorApiModel

Details of the error.

ErrorApiModel properties:

NameDescriptionRequiredType
codeService-defined error code.truestring
detailsArray of objects with more specific error information when applicable.falsearray | null
messageHuman-readable string describing the error.truestring
targetA string indicating the target of the error. For example, the name of the property in error.falsestring | null

500 response

Unexpected error.

Content types: application/json

ErrorResponseApiModel properties:

NameDescriptionRequiredType
errortrueErrorApiModel

Details of the error.

ErrorApiModel properties:

NameDescriptionRequiredType
codeService-defined error code.truestring
detailsArray of objects with more specific error information when applicable.falsearray | null
messageHuman-readable string describing the error.truestring
targetA string indicating the target of the error. For example, the name of the property in error.falsestring | null

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

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

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

Request parameters

NameDescriptionInRequiredType
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.
headertrueinteger
idID of the project.pathtrueinteger , format: int64

Request body

Content types: application/json

UpdateAllowedLoadZonesListApiModel properties:

NameDescriptionRequiredType
valueList of the load zones that the project will be allowed to use.trueArray[AllowedLoadZoneToUpdateApiModel]

AllowedLoadZoneToUpdateApiModel properties:

NameDescriptionRequiredType
idID of the load zone.trueinteger , format: int64
Update example
{
  "value": [
    {
      "id": 11
    },
    {
      "id": 871
    },
    {
      "id": 17
    }
  ]
}

200 response

OK.

Content types: application/json

AllowedLoadZonesListApiModel properties:

NameDescriptionRequiredType
valueList of the resulting values.trueArray[AllowedLoadZoneApiModel]

AllowedLoadZoneApiModel properties:

NameDescriptionRequiredType
availableWhether the load zone can be used to start tests.trueboolean
custom_load_runner_imageCustom load runner image. Only set for private load zones.truestring | null
idID of the load zone.trueinteger , format: int64
k6_load_zone_idID used to identify the load zone in the k6 scripts.truestring
nameName of the load zone.truestring
publicWhether the load zone is public or private.trueboolean
OK example
{
  "value": [
    {
      "available": true,
      "custom_load_runner_image": "grafana/k6:latest",
      "id": 24,
      "k6_load_zone_id": "eu-region-load-zone",
      "name": "EU region load zone",
      "public": false
    },
    {
      "available": true,
      "custom_load_runner_image": "grafana/k6:latest",
      "id": 173,
      "k6_load_zone_id": "us-region-load-zone",
      "name": "US region load zone",
      "public": false
    },
    {
      "available": false,
      "custom_load_runner_image": null,
      "id": 8345,
      "k6_load_zone_id": "ops-playground-load-zone",
      "name": "Ops playground load zone",
      "public": false
    }
  ]
}

400 response

Request validation error.

Content types: application/json

ErrorResponseApiModel properties:

NameDescriptionRequiredType
errortrueErrorApiModel

Details of the error.

ErrorApiModel properties:

NameDescriptionRequiredType
codeService-defined error code.truestring
detailsArray of objects with more specific error information when applicable.falsearray | null
messageHuman-readable string describing the error.truestring
targetA string indicating the target of the error. For example, the name of the property in error.falsestring | null

401 response

Invalid token or authentication scheme.

Content types: application/json

ErrorResponseApiModel properties:

NameDescriptionRequiredType
errortrueErrorApiModel

Details of the error.

ErrorApiModel properties:

NameDescriptionRequiredType
codeService-defined error code.truestring
detailsArray of objects with more specific error information when applicable.falsearray | null
messageHuman-readable string describing the error.truestring
targetA string indicating the target of the error. For example, the name of the property in error.falsestring | null

403 response

The user does not have permission to perform this action.

Content types: application/json

ErrorResponseApiModel properties:

NameDescriptionRequiredType
errortrueErrorApiModel

Details of the error.

ErrorApiModel properties:

NameDescriptionRequiredType
codeService-defined error code.truestring
detailsArray of objects with more specific error information when applicable.falsearray | null
messageHuman-readable string describing the error.truestring
targetA string indicating the target of the error. For example, the name of the property in error.falsestring | null

404 response

Resource not found.

Content types: application/json

ErrorResponseApiModel properties:

NameDescriptionRequiredType
errortrueErrorApiModel

Details of the error.

ErrorApiModel properties:

NameDescriptionRequiredType
codeService-defined error code.truestring
detailsArray of objects with more specific error information when applicable.falsearray | null
messageHuman-readable string describing the error.truestring
targetA string indicating the target of the error. For example, the name of the property in error.falsestring | null

500 response

Unexpected error.

Content types: application/json

ErrorResponseApiModel properties:

NameDescriptionRequiredType
errortrueErrorApiModel

Details of the error.

ErrorApiModel properties:

NameDescriptionRequiredType
codeService-defined error code.truestring
detailsArray of objects with more specific error information when applicable.falsearray | null
messageHuman-readable string describing the error.truestring
targetA string indicating the target of the error. For example, the name of the property in error.falsestring | null