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

CreateWorkspaceApiKey

Creates a Grafana API key for the workspace. This key can be used to authenticate requests sent to the workspace's HTTP API. See https://docs.aws.amazon.com/grafana/latest/userguide/Using-Grafana-APIs.html for available APIs and example requests.

Note

In workspaces compatible with Grafana version 9 or above, use workspace service accounts instead of API keys. API keys will be removed in a future release.

Request Syntax


POST /workspaces/workspaceId/apikeys HTTP/1.1
Content-type: application/json

{
   "keyName": "string",
   "keyRole": "string",
   "secondsToLive": number
}

URI Request Parameters

The request uses the following URI parameters.

workspaceId

The ID of the workspace to create an API key.

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

keyName

Specifies the name of the key. Keynames must be unique to the workspace.

Type: String

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

Required: Yes

keyRole

Specifies the permission level of the key.

Valid values: ADMIN|EDITOR|VIEWER

Type: String

Required: Yes

secondsToLive

Specifies the time in seconds until the key expires. Keys can be valid for up to 30 days.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 2592000.

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "key": "string",
   "keyName": "string",
   "workspaceId": "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.

key

The key token. Use this value as a bearer token to authenticate HTTP requests to the workspace.

Type: String

keyName

The name of the key that was created.

Type: String

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

workspaceId

The ID of the workspace that the key is valid for.

Type: String

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

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

ServiceQuotaExceededException

The request would cause a service quota to be exceeded.

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

HTTP Status Code: 402

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