Commit a dashboard to GitHub
Commits the dashboard's currently saved template to the project's connected GitHub repository. This endpoint does not change the dashboard.
Only organization users can commit dashboards. Tenant users cannot access version control, even when they have permission to edit the dashboard.
Use it after dashboard validation,
or to retry when an update saved successfully but returned an uncommitted
version-control result. A dashboard with no changes since its last commit
returns no_changes as an idempotent success.
Authorization
BearerAuth A project-scoped or dashboard-scoped access token. Generate one via the Token API using your project ID and project secret.
In: header
Path Parameters
Dashboard identifier.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X post "https://semaphor.cloud/api/management/v1/dashboards/string/commit" \ -H "Content-Type: application/json" \ -d '{ "commitMessage": "string" }'{
"dashboardId": "string",
"versionControl": {
"status": "committed",
"commitSha": "string",
"commitUrl": "http://example.com"
}
}{
"error": "string",
"code": "string",
"errorCode": "string",
"details": {},
"success": true
}{
"error": "string",
"code": "string",
"errorCode": "string",
"details": {},
"success": true
}{
"error": "string",
"code": "string",
"errorCode": "string",
"details": {},
"success": true
}{
"error": "string",
"code": "string",
"errorCode": "string",
"details": {},
"success": true
}{
"error": "string",
"code": "string",
"errorCode": "string",
"details": {},
"success": true
}{
"error": "string",
"code": "string",
"errorCode": "string",
"details": {},
"success": true
}{
"error": "string",
"code": "string",
"errorCode": "string",
"details": {},
"success": true
}