How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Grafana Get API

The Get API from Grafana — 118 operation(s) for get.

Grafana Get API is one of 78 APIs that Grafana publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, a getting-started guide, and 1 JSON Schema.

This API exposes 54 operations across 54 paths, and defines 63 schemas. It is described by OpenAPI 3.2.0, at version 0.0.1.

Requests are made against 2 base URLs: http://{defaultHost}, https://{defaultHost}.

54 operations 54 paths 63 schemas 54 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.0.1
Base URL
http://localhost:3000/api
Authentication
API Key, HTTP Basic
Resource Areas
1

Authentication & Security 2

Grafana Get API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (api_key). It accepts HTTP basic authentication (basic). By default, every request must be authenticated.

Paths & Operations 54

Across 54 paths, the API surfaces 54 operations — 54 GET. Each is listed below with its method, path, parameters, and response codes.

Get 54
GET
/orgs/name/{org_name}
Grafana Get Org By Name
getOrgByName 1 param → 200401403500
GET
/orgs/{org_id}
Grafana Get Org By ID
getOrgByID 1 param → 200401403500
GET
/orgs/{org_id}/users
Grafana Get Org Users
getOrgUsers 1 param → 200401403500
GET
/org/invites
Grafana Get Pending Org Invites
getPendingOrgInvites → 200401403500
GET
/org/preferences
Grafana Get Org Preferences
getOrgPreferences → 200401403500
GET
/teams/{team_id}
Grafana Get Team By ID
getTeamByID 2 params → 200401403404500
GET
/teams/{team_id}/members
Grafana Get Team Members
getTeamMembers 1 param → 200401403404500
GET
/teams/{team_id}/preferences
Grafana Get Team Preferences
getTeamPreferences 1 param → 200401500
GET
/datasources/uid/{uid}/lbac/teams
Grafana Get Team LBAC Rules Api
getTeamLBACRulesApi 1 param → 200400401403404500
GET
/access-control/roles/{roleUID}
Grafana Get Role
getRole 1 param → 200403500
GET
/access-control/roles/{roleUID}/assignments
Grafana Get Role Assignments
getRoleAssignments 1 param → 200403404500
GET
/access-control/{resource}/{resourceID}
Grafana Get Resource Permissions
getResourcePermissions 2 params → 200403404500
GET
/licensing/check
Grafana Get Status
getStatus → 200
GET
/licensing/token
Grafana Get License Token
getLicenseToken → 200
GET
/reports
Grafana Get Reports
getReports → 200401403500
GET
/reports/images/:image
Grafana Get Settings Image
getSettingsImage → 200401403404500
GET
/reports/settings
Grafana Get Report Settings
getReportSettings → 200401403500
GET
/reports/{id}deprecated
Grafana Get Report
getReport 1 param → 200400401403404500
GET
/admin/ldap-sync-status
Grafana Get Sync Status
getSyncStatus → 200401403500
GET
/admin/ldap/status
Grafana Get LDAP Status
getLDAPStatus → 200401403500
GET
/admin/ldap/{user_name}
Grafana Get User From LDAP
getUserFromLDAP 1 param → 200401403500
GET
/admin/users/{user_id}/quotas
Grafana Get User Quota
getUserQuota 1 param → 200401403404500
GET
/orgs/{org_id}/quotas
Grafana Get Org Quota
getOrgQuota 1 param → 200401403404500
GET
/user/quotas
Grafana Get User Quotas
getUserQuotas → 200401403404500
GET
/cloudmigration/migration
Grafana Get Session List
getSessionList → 200401403500
GET
/cloudmigration/migration/{uid}
Grafana Get Session
getSession 1 param → 200400401403500
GET
/cloudmigration/migration/{uid}/snapshot/{snapshotUid}
Grafana Get Snapshot
getSnapshot 7 params → 200400401403500
GET
/cloudmigration/migration/{uid}/snapshots
Grafana Get Shapshot List
getShapshotList 4 params → 200400401403500
GET
/groupsync/groups
Grafana Get Mapped Groups
getMappedGroups → 200400401403500
GET
/groupsync/groups/{group_id}/roles
Grafana Get Group Roles
getGroupRoles 1 param → 200400401403404500
GET
/health
Grafana Get Health
getHealth → 200503
GET
/logout/saml
Grafana Get SAML Logout
getSAMLLogout → 302404500
GET
/saml/metadata
Grafana Get Metadata
getMetadata → 200
GET
/saml/slo
Grafana Get SLO
getSLO → 302400403500
GET
/playlists/{uid}
Grafana Get Playlist
getPlaylist 1 param → 200401403404500
GET
/playlists/{uid}/items
Grafana Get Playlist Items
getPlaylistItems 1 param → 200401403404500
GET
/recording-rules/writer
Grafana Get Recording Rule Write Target
getRecordingRuleWriteTarget → 200401403404500
GET
/snapshot/shared-options
Grafana Get Sharing Options
getSharingOptions → 200401
GET
/teams/{teamId}/groups
Grafana Get Team Groups Api
getTeamGroupsApi 1 param → 200400401403404500
GET
/user
Grafana Get Signed In User
getSignedInUser → 200401403404500
GET
/user/auth-tokens
Grafana Get User Auth Tokens
getUserAuthTokens → 200401403500
GET
/user/orgs
Grafana Get Signed In User Org List
getSignedInUserOrgList → 200401403500
GET
/user/preferences
Grafana Get User Preferences
getUserPreferences → 200401500
GET
/user/teams
Grafana Get Signed In User Team List
getSignedInUserTeamList → 200401403500
GET
/users/{user_id}
Grafana Get User By ID
getUserByID 1 param → 200401403404500
GET
/users/{user_id}/orgs
Grafana Get User Org List
getUserOrgList 1 param → 200401403404500
GET
/users/{user_id}/teams
Grafana Get User Teams
getUserTeams 1 param → 200401403404500
GET
/v1/provisioning/contact-points
Grafana Route Get Contactpoints
routeGetContactpoints 1 param → 200
GET
/v1/provisioning/mute-timings
Grafana Route Get Mute Timings
routeGetMuteTimings → 200
GET
/v1/provisioning/mute-timings/{name}
Grafana Route Get Mute Timing
routeGetMuteTiming 1 param → 200404
GET
/v1/provisioning/policies
Grafana Route Get Policy Tree
routeGetPolicyTree → 200
GET
/v1/provisioning/templates
Grafana Route Get Templates
routeGetTemplates → 200
GET
/v1/provisioning/templates/{name}
Grafana Route Get Template
routeGetTemplate 1 param → 200404
GET
/v1/sso-settings/{key}
Grafana Get Provider Settings
getProviderSettings 1 param → 200400401403404

Schemas 63

The contract defines 63 schemas that model the data the API accepts and returns. The most detailed are Token (24 properties), Report (19 properties), UserProfileDTO (18 properties), resourcePermissionDTO (16 properties). Each schema is shown below with its type and property counts.

Role
string
Type
string
PreferencesCookiePreferences
object
+k8s:openapi-gen=true
3 properties
NotificationTemplate
object
4 properties
Route
object
A Route is a node that contains definitions of how to handle alerts. This is modified from the upstream alertmanager in that it adds the ObjectMatchers propert…
14 properties
getSharingOptionsResponse
object
3 properties
Permission
object
Permission is the model for access control permissions
4 properties
PlaylistItemDTO
object
3 properties
ErrorResponseBody
object
3 properties 1 required
SuccessResponseBody
object
1 property
ReportSchedule
object
8 properties
PreferencesQueryHistoryPreference
object
+k8s:openapi-gen=true
1 property
GetSnapshotResponseDTO
object
7 properties
PreferencesSpec
object
+k8s:openapi-gen=true
9 properties
TempUserDTO
object
14 properties
Status
string
CloudMigrationSessionResponseDTO
object
4 properties
getSSOSettingsResponse
object
4 properties
PublicError
object
PublicError is derived from Error and only contains information available to the end user.
4 properties
Group
object
2 properties
getGroupsResponse
object
2 properties
TeamMemberDTO
object
13 properties
SyncResultholdstheresultofasyncwithLDAP.Thisgivesusinformationonwhichuserswereupdatedandhow.
object
5 properties
Token
object
24 properties
UserToken
object
UserToken represents a user token
14 properties
ReportSettings
object
6 properties
ReportOptions
object
5 properties
Status1
string
resourcePermissionDTO
object
16 properties
RoleDTO
object
13 properties 8 required
Address
object
6 properties
ReportTimeRange
object
2 properties
TeamGroupDTO
object
4 properties
SnapshotListResponseDTO
object
1 property
Type2
string
MigrateDataResponseItemDTO
object
7 properties 3 required
PrometheusRemoteWriteTargetJSON
object
3 properties
TeamLBACRule
object
3 properties
CloudMigrationSessionListResponseDTO
object
1 property
ActiveSyncStatusDTO
object
ActiveSyncStatusDTO holds the information for LDAP background Sync
4 properties
ErrorCode
string
TeamLBACRules
object
1 property
EmbeddedContactPoint
object
EmbeddedContactPoint is the contact point type that is used by grafanas embedded alertmanager implementation.
6 properties 2 required
SnapshotDTO
object
Base snapshot without results
5 properties
RoleAssignmentsDTO
object
4 properties
Matchermodelsthematchingofalabel.
object
3 properties
PlaylistDTO
object
4 properties
PreferencesNavbarPreference
object
+k8s:openapi-gen=true
1 property
Report
object
19 properties
QuotaDTO
object
5 properties
UserOrgDTO
object
3 properties
OrgDetailsDTO
object
3 properties
ReportBrandingOptions
object
5 properties
OrgUserDTO
object
15 properties
MuteTimeIntervalrepresentsanamedsetoftimeintervalsforwhicharouteshouldbemuted.
object
2 properties
ReportDashboardID
object
3 properties
TeamDTO
object
11 properties 6 required
healthResponse
object
4 properties
UserProfileDTO
object
18 properties
FailedUser
object
FailedUser holds the information of an user that failed
2 properties
SnapshotResourceStats
object
3 properties
ReportDashboard
object
3 properties
TimeIntervalrepresentsanamedsetoftimeintervalsforwhicharouteshouldbemuted.
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

grafana-get-api-openapi.yml Raw ↑

Other APIs Grafana publishes across the network.

Grafana Access API
Grafana Account API
Grafana Accounts API
Grafana Add API
Grafana Address API
Grafana Administrative API
Grafana Alerts API
Grafana All API
Grafana Annotations API
Grafana Built API
Grafana Cache API
Grafana Call API
Where this information came from

This is an independent, third-party profile of Grafana Get API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.