Qyra
ReferenceProjects

Propose dashboard to git

Propose the current instance version of a managed dashboard back to the connected repo, including its dashboard-owned tile charts. Pass addToGit to deliberately add UI-only content to the repo.

POST/api/v1/projects/{projectUuid}/code/writebacks/dashboards/{slug}/propose

Authentication: personal access token. The spec defines an api_key security scheme — send an Authorization: ApiKey <your-personal-access-token> header (value format: ApiKey <your key>). A session_cookie scheme (connect.sid) exists for browser sessions. Operations in this spec declare security: [], an artifact of the upstream spec generator — authentication is still enforced by the server.

Path parameters

NameTypeRequiredDescription
projectUuidstringYes
slugstringYes

Request body

{
  "addToGit": true
}

Responses

200 — Success

{
  "results": {
    "updatedAt": "2024-01-01T00:00:00.000Z",
    "createdAt": "2024-01-01T00:00:00.000Z",
    "error": "string",
    "status": "pending",
    "prUrl": "string",
    "prNumber": 0,
    "branch": "string",
    "slug": "string",
    "contentType": "string"
  },
  "status": "ok"
}

default — Error

{
  "error": {
    "data": "string",
    "message": "string",
    "name": "string",
    "statusCode": 0
  },
  "status": "error"
}