mattermost/api/v4/source/cluster.yaml
Alejandro García Montoro d1ecea4c84
Update /api/v4/cluster/status docs (#28189)
Co-authored-by: Mattermost Build <build@mattermost.com>
2024-09-16 17:51:51 +02:00

25 lines
731 B
YAML

/api/v4/cluster/status:
get:
tags:
- cluster
summary: Get cluster status
description: >
Get a list of all healthy nodes, including local information and
status of each one. If a node is not present, it means it is not
healthy.
##### Permissions
Must have `manage_system` permission.
operationId: GetClusterStatus
responses:
"200":
description: Cluster status retrieval successful
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/ClusterInfo"
"403":
$ref: "#/components/responses/Forbidden"