ManagedGrafana / Client / delete_workspace_api_key

delete_workspace_api_key

ManagedGrafana.Client.delete_workspace_api_key(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.delete_workspace_api_key(
    keyName='string',
    workspaceId='string'
)

Parameters:

• keyName (string) –

  [REQUIRED]

  The name of the API key to delete.

• workspaceId (string) –

  [REQUIRED]

  The ID of the workspace to delete.

Return type:

dict

Returns:

Response Syntax

{
    'keyName': 'string',
    'workspaceId': 'string'
}

Response Structure

• (dict) –

  • keyName (string) –

    The name of the key that was deleted.

  • workspaceId (string) –

    The ID of the workspace where the key was deleted.

Exceptions

• ManagedGrafana.Client.exceptions.ResourceNotFoundException

• ManagedGrafana.Client.exceptions.ThrottlingException

• ManagedGrafana.Client.exceptions.ConflictException

• ManagedGrafana.Client.exceptions.ValidationException

• ManagedGrafana.Client.exceptions.AccessDeniedException

• ManagedGrafana.Client.exceptions.InternalServerException