Load zones REST API
Grafana Cloud

Load zones REST API

Note

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

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

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

200 response

OK.

Content types: application/json

AllowedProjectsListApiModel properties:

NameDescriptionRequiredType
valueList of the projects allowed to use particular load zone.trueArray[AllowedProjectApiModel]

AllowedProjectApiModel properties:

NameDescriptionRequiredType
idID of the project.trueinteger
nameName of the project.truestring
OK example
{
  "value": [
    {
      "id": 139,
      "name": "My sample project"
    },
    {
      "id": 328,
      "name": "Platform load tests"
    },
    {
      "id": 6789,
      "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

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

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
Update example
{
  "value": [
    {
      "id": 7284
    },
    {
      "id": 8768
    },
    {
      "id": 348
    }
  ]
}

200 response

OK.

Content types: application/json

AllowedProjectsListApiModel properties:

NameDescriptionRequiredType
valueList of the projects allowed to use particular load zone.trueArray[AllowedProjectApiModel]

AllowedProjectApiModel properties:

NameDescriptionRequiredType
idID of the project.trueinteger
nameName of the project.truestring
OK example
{
  "value": [
    {
      "id": 139,
      "name": "My sample project"
    },
    {
      "id": 328,
      "name": "Platform load tests"
    },
    {
      "id": 6789,
      "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

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

200 response

OK.

Content types: application/json

AllowedLoadZonesListApiModel properties:

NameDescriptionRequiredType
valueList of the load zones that project is allowed to use.trueArray[AllowedLoadZoneApiModel]

AllowedLoadZoneApiModel properties:

NameDescriptionRequiredType
idID of the load zone.trueinteger
nameName of the load zone.truestring
OK example
{
  "value": [
    {
      "id": 24,
      "name": "EU region load zone"
    },
    {
      "id": 173,
      "name": "US region load zone"
    },
    {
      "id": 8345,
      "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

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

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
Update example
{
  "value": [
    {
      "id": 11
    },
    {
      "id": 871
    },
    {
      "id": 17
    }
  ]
}

200 response

OK.

Content types: application/json

AllowedLoadZonesListApiModel properties:

NameDescriptionRequiredType
valueList of the load zones that project is allowed to use.trueArray[AllowedLoadZoneApiModel]

AllowedLoadZoneApiModel properties:

NameDescriptionRequiredType
idID of the load zone.trueinteger
nameName of the load zone.truestring
OK example
{
  "value": [
    {
      "id": 24,
      "name": "EU region load zone"
    },
    {
      "id": 173,
      "name": "US region load zone"
    },
    {
      "id": 8345,
      "name": "Ops playground load zone"
    }
  ]
}

400 response

401 response

403 response

404 response

500 response