Sinatra Docs
API ReferenceRepositories

Read repository environment status

Members can read environment versions and saved update status.

Requires repository environments to be enabled for the workspace.

GET/v1/workspaces/{workspaceId}/repos/{repoId}/environment
AuthorizationBearer <token>

A personal access token, which starts with sntr_. Create one on the dashboard's CLI & API page (https://app.sinatra.dev/tokens). It acts as you in every workspace you belong to, with your role in each, and expires after at most 365 days. The CLI's browser sign-in sends an OAuth access token here instead.

In: header

Path Parameters

workspaceIdstring

The workspace's id, from GET /v1/me.

repoIdstring

The repository id from the repos data in GET /v1/workspaces/{workspaceId}.

Response Body

curl -X GET "https://api.sinatra.dev/v1/workspaces/string/repos/string/environment"
{
  "environment": {
    "initialPassState": "string",
    "activeVersionId": "string",
    "versions": [
      {
        "id": "string",
        "sequence": 0,
        "status": "string",
        "origin": "string",
        "sourceCommit": "string",
        "readiness": null,
        "snapshotResources": null,
        "failureReason": "string",
        "supersededById": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "completedAt": "2019-08-24T14:15:22Z"
      }
    ]
  },
  "updates": [
    {
      "id": "string",
      "reason": "string",
      "evidence": "string",
      "change": "string",
      "state": "string",
      "versionId": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "finishedAt": "2019-08-24T14:15:22Z"
    }
  ]
}
{
  "error": "string",
  "reason": "string",
  "requestId": "string",
  "refusal": "string",
  "billingUrl": "string",
  "settingsUrl": "string",
  "plan": "string",
  "running": 0,
  "queued": 0,
  "taskId": "string",
  "messageId": "string"
}
{
  "error": "string",
  "reason": "string",
  "requestId": "string",
  "refusal": "string",
  "billingUrl": "string",
  "settingsUrl": "string",
  "plan": "string",
  "running": 0,
  "queued": 0,
  "taskId": "string",
  "messageId": "string"
}
{
  "error": "string",
  "reason": "string",
  "requestId": "string",
  "refusal": "string",
  "billingUrl": "string",
  "settingsUrl": "string",
  "plan": "string",
  "running": 0,
  "queued": 0,
  "taskId": "string",
  "messageId": "string"
}
{
  "error": "string",
  "reason": "string",
  "requestId": "string",
  "refusal": "string",
  "billingUrl": "string",
  "settingsUrl": "string",
  "plan": "string",
  "running": 0,
  "queued": 0,
  "taskId": "string",
  "messageId": "string"
}
{
  "error": "string",
  "reason": "string",
  "requestId": "string",
  "refusal": "string",
  "billingUrl": "string",
  "settingsUrl": "string",
  "plan": "string",
  "running": 0,
  "queued": 0,
  "taskId": "string",
  "messageId": "string"
}