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

DescribeWorkspaceConfiguration

Gets the current configuration string for the given workspace.

Request Syntax


GET /workspaces/workspaceId/configuration HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

workspaceId

The ID of the workspace to get configuration information for.

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

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

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

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

configuration

The configuration string for the workspace that you requested. 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.

grafanaVersion

The supported Grafana version for the workspace.

Type: String

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

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

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