Create a dashboard
Creates a new dashboard in the project. If you omit the template field,
an empty dashboard with a default sheet is created automatically.
Optional tags classify the dashboard for exact-match discovery and are
returned in ascending lexical order.
The caller must have permission to create dashboards in the project. The new dashboard is owned by the authenticated user.
Provide commitMessage to commit the newly created dashboard to the
project's connected GitHub repository. When the project requires commits
on save, commitMessage is required.
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
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
curl -X post "https://semaphor.cloud/api/management/v1/dashboards" \ -H "Content-Type: application/json" \ -d '{ "title": "string" }'{
"versionControl": {
"status": "committed",
"commitSha": "string",
"commitUrl": "http://example.com"
},
"id": "string",
"kind": "string",
"tags": [
"string"
],
"title": "string",
"description": "string",
"projectId": "string",
"tenantId": "string",
"isPrivate": true,
"isPublic": true,
"version": "string",
"permissions": {
"canEdit": true,
"canShare": true,
"canDelete": true
},
"ownership": {}
}{
"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",
"errorCode": "COMMIT_FAILED",
"dashboardSaved": true,
"dashboard": {
"id": "string",
"kind": "string",
"tags": [
"string"
],
"title": "string",
"description": "string",
"projectId": "string",
"tenantId": "string",
"isPrivate": true,
"isPublic": true,
"version": "string",
"permissions": {
"canEdit": true,
"canShare": true,
"canDelete": true
},
"ownership": {}
},
"versionControl": {
"status": "committed",
"commitSha": "string",
"commitUrl": "http://example.com"
}
}