DeleteWorkspaceApiKey
Deletes a Grafana API key for the workspace.
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
DELETE /workspaces/workspaceId/apikeys/keyName HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- keyName
-
The name of the API key to delete.
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: Yes
- workspaceId
-
The ID of the workspace to delete.
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
{
"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.
- keyName
-
The name of the key that was deleted.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
- workspaceId
-
The ID of the workspace where the key was deleted.
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.
HTTP Status Code: 409
- InternalServerException
-
Unexpected error while processing the request. Retry the request.
HTTP Status Code: 500
- ResourceNotFoundException
-
The request references a resource that does not exist.
HTTP Status Code: 404
- ThrottlingException
-
The request was denied because of request throttling. Retry the request.
HTTP Status Code: 429
- ValidationException
-
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:
