Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdateWorkspaceConfiguration

Updates the configuration string for the given workspace

Request Syntax


PUT /workspaces/workspaceId/configuration HTTP/1.1
Content-type: application/json

{
   "configuration": "string",
   "grafanaVersion": "string"
}

URI Request Parameters

The request uses the following URI parameters.

workspaceId

The ID of the workspace to update.

Pattern: g-[0-9a-f]{10}

Required: Yes

Request Body

The request accepts the following data in JSON format.

configuration

The new configuration string for the workspace. For more information about the format and configuration options available, see Working in your Grafana workspace.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 65536.

Required: Yes

grafanaVersion

Specifies the version of Grafana to support in the workspace. If not specified, keeps the current version of the workspace.

Can only be used to upgrade (for example, from 8.4 to 9.4), not downgrade (for example, from 9.4 to 8.4).

To know what versions are available to upgrade to for a specific workspace, see the ListVersions operation.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: No

Response Syntax


HTTP/1.1 202

Response Elements

If the action is successful, the service sends back an HTTP 202 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient permissions to perform this action.

HTTP Status Code: 403

ConflictException

A resource was in an inconsistent state during an update or a deletion.

message: A description of the error.
resourceId: The ID of the resource that is associated with the error.
resourceType: The type of the resource that is associated with the error.

HTTP Status Code: 409

InternalServerException

Unexpected error while processing the request. Retry the request.

message: A description of the error.
retryAfterSeconds: How long to wait before you retry this operation.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource that does not exist.

message: The value of a parameter in the request caused an error.
resourceId: The ID of the resource that is associated with the error.
resourceType: The type of the resource that is associated with the error.

HTTP Status Code: 404

ThrottlingException

The request was denied because of request throttling. Retry the request.

message: A description of the error.
quotaCode: The ID of the service quota that was exceeded.
retryAfterSeconds: The value of a parameter in the request caused an error.
serviceCode: The ID of the service that is associated with the error.

HTTP Status Code: 429

ValidationException

The value of a parameter in the request caused an error.

fieldList: A list of fields that might be associated with the error.
message: A description of the error.
reason: The reason that the operation failed.

HTTP Status Code: 400