The Status API from Grafana — 4 operation(s) for status.
openapi: 3.0.3
info:
title: Grafana HTTP Access Status API
description: The Grafana HTTP API provides programmatic access to Grafana's core functionality including dashboards, data sources, alerts, users, organizations, folders, annotations, and teams. Authentication is handled via API keys, basic auth, or OAuth tokens passed in the Authorization header.
version: 11.0.0
contact:
name: Grafana Labs
url: https://grafana.com
license:
name: AGPL-3.0
url: https://www.gnu.org/licenses/agpl-3.0.html
servers:
- url: https://{instance}.grafana.net/api
description: Grafana Cloud
variables:
instance:
default: your-instance
- url: http://localhost:3000/api
description: Local Grafana instance
security:
- BearerAuth: []
- BasicAuth: []
- ApiKeyAuth: []
tags:
- name: Status
paths:
/access-control/status:
parameters: []
get:
tags:
- Status
summary: Grafana Get Access Control Status
description: This API operation retrieves the current status of Grafana's access control system, providing information about whether fine-grained access control (RBAC) is enabled and operational within the Grafana instance. It returns details about the access control configuration and its current state, allowing administrators to verify that permission management features are functioning correctly and to understand which access control mode is active. This is particularly useful for troubleshooting permission-related issues or confirming that enterprise access control features are properly configured.
operationId: getAccessControlStatus
parameters: []
responses:
'200':
description: (empty)
headers: {}
content:
application/json:
schema:
type: integer
contentEncoding: int64
contentMediaType: application/json
'403':
description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseBody'
'404':
description: NotFoundError is returned when the requested resource was not found.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseBody'
'500':
description: InternalServerError is a general error indicating something went wrong internally.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseBody'
deprecated: false
x-api-evangelist-processing:
SplitPascalCaseOperationSummaries: true
CaselCaseOperationIds: true
WriteDescription: true
ChooseTags: true
/licensing/check:
parameters: []
get:
tags:
- Status
summary: Grafana Get Status
description: This API operation retrieves the current licensing status information from a Grafana instance. When invoked using a GET request to the /licensing/check endpoint, it returns details about the active license, including validity, expiration dates, enabled features, and any limitations or restrictions associated with the current license tier. This endpoint is typically used by administrators to monitor license compliance, verify enterprise feature availability, and ensure the Grafana installation is properly licensed for its intended use case.
operationId: getStatus
parameters: []
responses:
'200':
description: (empty)
headers: {}
content: {}
deprecated: false
x-api-evangelist-processing:
SplitPascalCaseOperationSummaries: true
CaselCaseOperationIds: true
WriteDescription: true
ChooseTags: true
/admin/ldap-sync-status:
parameters: []
get:
tags:
- Status
summary: Grafana Get Sync Status
description: This API endpoint retrieves the current synchronization status between Grafana and LDAP (Lightweight Directory Access Protocol) servers. It is an administrative GET operation that returns information about the last LDAP sync operation, including whether it was successful, when it occurred, and any relevant error messages or warnings. This endpoint is typically used by system administrators to monitor and troubleshoot LDAP integration, ensuring that user accounts and permissions are properly synchronized between the external LDAP directory and Grafana's internal user database.
operationId: getSyncStatus
parameters: []
responses:
'200':
description: (empty)
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ActiveSyncStatusDTO'
'401':
description: UnauthorizedError is returned when the request is not authenticated.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseBody'
'403':
description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseBody'
'500':
description: InternalServerError is a general error indicating something went wrong internally.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseBody'
deprecated: false
x-api-evangelist-processing:
SplitPascalCaseOperationSummaries: true
CaselCaseOperationIds: true
WriteDescription: true
ChooseTags: true
/admin/ldap/status:
parameters: []
get:
tags:
- Status
summary: Grafana Get LDAP Status
description: This API operation retrieves the current status of LDAP integration in Grafana by sending a GET request to the /admin/ldap/status endpoint. It provides administrators with information about the LDAP connection status, configuration validation, and whether the LDAP authentication system is functioning properly. The endpoint returns details that help verify if Grafana can successfully communicate with the configured LDAP server, making it useful for troubleshooting authentication issues and monitoring the health of LDAP-based user authentication within the Grafana instance.
operationId: getLDAPStatus
parameters: []
responses:
'200':
description: An OKResponse is returned if the request was successful.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessResponseBody'
'401':
description: UnauthorizedError is returned when the request is not authenticated.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseBody'
'403':
description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseBody'
'500':
description: InternalServerError is a general error indicating something went wrong internally.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseBody'
deprecated: false
security:
- basic: []
x-api-evangelist-processing:
SplitPascalCaseOperationSummaries: true
CaselCaseOperationIds: true
WriteDescription: true
ChooseTags: true
components:
schemas:
SyncResultholdstheresultofasyncwithLDAP.Thisgivesusinformationonwhichuserswereupdatedandhow.:
title: SyncResultholdstheresultofasyncwithLDAP.Thisgivesusinformationonwhichuserswereupdatedandhow.
type: object
properties:
Elapsed:
type: integer
description: 'A Duration represents the elapsed time between two instants
as an int64 nanosecond count. The representation limits the
largest representable duration to approximately 290 years.'
contentEncoding: int64
FailedUsers:
type: array
items:
$ref: '#/components/schemas/FailedUser'
description: ''
MissingUserIds:
type: array
items:
type: integer
contentEncoding: int64
description: ''
Started:
type: string
contentEncoding: date-time
UpdatedUserIds:
type: array
items:
type: integer
contentEncoding: int64
description: ''
FailedUser:
title: FailedUser
type: object
properties:
Error:
type: string
Login:
type: string
description: FailedUser holds the information of an user that failed
ActiveSyncStatusDTO:
title: ActiveSyncStatusDTO
type: object
properties:
enabled:
type: boolean
nextSync:
type: string
contentEncoding: date-time
prevSync:
$ref: '#/components/schemas/SyncResultholdstheresultofasyncwithLDAP.Thisgivesusinformationonwhichuserswereupdatedandhow.'
schedule:
type: string
description: ActiveSyncStatusDTO holds the information for LDAP background Sync
SuccessResponseBody:
title: SuccessResponseBody
type: object
properties:
message:
type: string
ErrorResponseBody:
title: ErrorResponseBody
required:
- message
type: object
properties:
error:
type: string
description: Error An optional detailed description of the actual error. Only included if running in developer mode.
message:
type: string
description: a human readable version of the error
status:
type: string
description: 'Status An optional status to denote the cause of the error.
For example, a 412 Precondition Failed error may include additional information of why that error happened.'
securitySchemes:
BearerAuth:
type: http
scheme: bearer
description: Service account token or API key
BasicAuth:
type: http
scheme: basic
ApiKeyAuth:
type: apiKey
in: header
name: Authorization
description: 'Format: Bearer <api-key>'