CreateWorkspaceServiceAccountToken - Amazon Managed Grafana


Creates a token that can be used to authenticate and authorize Grafana HTTP API operations for the given workspace service account. The service account acts as a user for the API operations, and defines the permissions that are used by the API.


When you create the service account token, you will receive a key that is used when calling Grafana APIs. Do not lose this key, as it will not be retrievable again.

If you do lose the key, you can delete the token and recreate it to receive a new key. This will disable the initial key.

Service accounts are only available for workspaces that are compatible with Grafana version 9 and above.

Request Syntax

POST /workspaces/workspaceId/serviceaccounts/serviceAccountId/tokens HTTP/1.1 Content-type: application/json { "name": "string", "secondsToLive": number }

URI Request Parameters

The request uses the following URI parameters.


The ID of the service account for which to create a token.

Required: Yes


The ID of the workspace the service account resides within.

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

Required: Yes

Request Body

The request accepts the following data in JSON format.


A name for the token to create.

Type: String

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

Required: Yes


Sets how long the token will be valid, in seconds. You can set the time up to 30 days in the future.

Type: Integer

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

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "serviceAccountId": "string", "serviceAccountToken": { "id": "string", "key": "string", "name": "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.


The ID of the service account where the token was created.

Type: String


Information about the created token, including the key. Be sure to store the key securely.

Type: ServiceAccountTokenSummaryWithKey object


The ID of the workspace where the token was created.

Type: String

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


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


You do not have sufficient permissions to perform this action.

HTTP Status Code: 403


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

HTTP Status Code: 409


Unexpected error while processing the request. Retry the request.

HTTP Status Code: 500


The request references a resource that does not exist.

HTTP Status Code: 404


The request would cause a service quota to be exceeded.

HTTP Status Code: 402


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

HTTP Status Code: 429


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

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: