Amazon Managed Grafana
Amazon Managed Grafana is a fully managed and secure data visualization service that you can use to instantly query, correlate, and visualize operational…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Amazon Managed Grafana is a fully managed and secure data visualization service that you can use to instantly query, correlate, and visualize operational metrics, logs, and traces from multiple sources. Amazon Managed Grafana makes it easy to deploy, operate, and scale Grafana, a widely deployed data visualization tool that is popular for its extensible data support. With Amazon Managed Grafana, you create logically isolated Grafana servers called workspaces . In a workspace, you can create Grafana dashboards and visualizations to analyze your metrics, logs, and traces without having to build, package, or deploy any hardware to run Grafana servers.
Endpoints 25
License
- POSTAssociate license
/workspaces/:workspaceId/licenses/:licenseTypeAssigns a Grafana Enterprise license to a workspace. To upgrade, you must use ENTERPRISE for the licenseType , and pass in a valid Grafana Labs token for the… - DELETEDisassociate license
/workspaces/:workspaceId/licenses/:licenseTypeRemoves the Grafana Enterprise license from a workspace.
Workspace
- GETList workspaces
/workspaces?maxResults=0&nextToken=stringReturns a list of Amazon Managed Grafana workspaces in the account, with some information about each workspace. For more complete information about one… - POSTCreate workspace
/workspacesCreates a workspace . In a workspace, you can create Grafana dashboards and visualizations to analyze your metrics, logs, and traces. You don't have to build,… - GETDescribe workspace
/workspaces/:workspaceIdDisplays information about one Amazon Managed Grafana workspace. - PUTUpdate workspace
/workspaces/:workspaceIdModifies an existing Amazon Managed Grafana workspace. If you use this operation and omit any optional parameters, the existing values of those parameters are… - DELETEDelete workspace
/workspaces/:workspaceIdDeletes an Amazon Managed Grafana workspace.
Api key
- POSTCreate workspace api key
/workspaces/:workspaceId/apikeysCreates a Grafana API key for the workspace. This key can be used to authenticate requests sent to the workspace's HTTP API. See for available APIs and… - DELETEDelete workspace api key
/workspaces/:workspaceId/apikeys/:keyNameDeletes a Grafana API key for the workspace. In workspaces compatible with Grafana version 9 or above, use workspace service accounts instead of API keys. API…
Service account
- GETList workspace service accounts
/workspaces/:workspaceId/serviceaccounts?maxResults=0&nextToken=stringReturns a list of service accounts for a workspace. Service accounts are only available for workspaces that are compatible with Grafana version 9 and above. - POSTCreate workspace service account
/workspaces/:workspaceId/serviceaccountsCreates a service account for the workspace. A service account can be used to call Grafana HTTP APIs, and run automated workloads. After creating the service… - DELETEDelete workspace service account
/workspaces/:workspaceId/serviceaccounts/:serviceAccountIdDeletes a workspace service account from the workspace. This will delete any tokens created for the service account, as well. If the tokens are currently in…
Service account token
- GETList workspace service account tokens
/workspaces/:workspaceId/serviceaccounts/:serviceAccountId/tokens?maxResults=0&nextToken=stringReturns a list of tokens for a workspace service account. This does not return the key for each token. You cannot access keys after they are created. To… - POSTCreate workspace service account token
/workspaces/:workspaceId/serviceaccounts/:serviceAccountId/tokensCreates a token that can be used to authenticate and authorize Grafana HTTP API operations for the given workspace service account . The service account acts… - DELETEDelete workspace service account token
/workspaces/:workspaceId/serviceaccounts/:serviceAccountId/tokens/:tokenIdDeletes a token for the workspace service account. This will disable the key associated with the token. If any automation is currently using the key, it will…
Authentication
- GETDescribe workspace authentication
/workspaces/:workspaceId/authenticationDisplays information about the authentication methods used in one Amazon Managed Grafana workspace. - POSTUpdate workspace authentication
/workspaces/:workspaceId/authenticationUse this operation to define the identity provider (IdP) that this workspace authenticates users from, using SAML. You can also map SAML assertion attributes…
Configuration
- GETDescribe workspace configuration
/workspaces/:workspaceId/configurationGets the current configuration string for the given workspace. - PUTUpdate workspace configuration
/workspaces/:workspaceId/configurationUpdates the configuration string for the given workspace
Permission
- GETList permissions
/workspaces/:workspaceId/permissions?maxResults=0&nextToken=string&userType=string&userId=string&groupId=stringLists the users and groups who have the Grafana Admin and Editor roles in this workspace. If you use this operation without specifying userId or groupId , the… - PATCHUpdate permissions
/workspaces/:workspaceId/permissionsUpdates which users in a workspace have the Grafana Admin or Editor roles.
- GETList tags for resource
/tags/:resourceArnThe ListTagsForResource operation returns the tags that are associated with the Amazon Managed Service for Grafana resource specified by the resourceArn .… - POSTTag resource
/tags/:resourceArnThe TagResource operation associates tags with an Amazon Managed Grafana resource. Currently, the only resource that can be tagged is workspaces. If you… - DELETEUntag resource
/tags/:resourceArn?tagKeys=The UntagResource operation removes the association of the tag with the Amazon Managed Grafana resource. - GETList versions
/versions?maxResults=0&nextToken=string&workspace-id=stringLists available versions of Grafana. These are available when calling CreateWorkspace . Optionally, include a workspace to list the versions to which it can…
API details
- Base URL
https://grafana.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 25 operations on 14 pathsGET 9POST 7DELETE 6PUT 2PATCH 1
- Main resources
- Workspace 5Service account 3Service account token 3Api key 2Authentication 2Configuration 2License 2Permission 2
- Description format
- AWS Smithy model, API version
2020-08-18 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the Amazon Managed Grafana in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon Managed Grafana collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Associate license” (POST /workspaces/:workspaceId/licenses/:licenseType), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Amazon Managed Grafana?
Amazon Managed Grafana is a fully managed and secure data visualization service that you can use to instantly query, correlate, and visualize operational… It is listed under Developer tools and has 25 endpoints.
Who publishes the Amazon Managed Grafana?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Amazon Managed Grafana?
Requests go to https://grafana.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the Amazon Managed Grafana?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the Amazon Managed Grafana have?
25 operations on 14 paths (9 GET, 7 POST, 6 DELETE, 2 PUT, 1 PATCH). The largest groups are Workspace, Service account, Service account token, Api key.
Is forking the Amazon Managed Grafana free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.