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.

Name Description In Required Type

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_load_zone_id`	Filter results by k6 load zone ID (exact match).	`query`	`false`	`string`

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_load_zone_id Filter results by k6 load zone ID (exact match). query false string

OK.

LoadZonesListApiModel properties:

Name	Description	Required	Type
`value`	List of the resulting values.	`true`	`Array[LoadZoneApiModel]`

LoadZoneApiModel properties:

Name	Description	Required	Type
`available`	Whether the load zone can be used to start tests.	`true`	`boolean`
`custom_load_runner_image`	Custom load runner image. Only set for private load zones.	`true`	`string` \| `null`
`id`	ID of the load zone.	`true`	`integer` , format: `int64`
`k6_load_zone_id`	ID used to identify the load zone in the k6 scripts.	`true`	`string`
`name`	Name of the load zone.	`true`	`string`
`public`	Whether the load zone is public or private.	`true`	`boolean`