v1

latestOpenAPI 3.0.12026-07-17635367.2 KB
workspace

Get workspace info

Get workspace info

get/workspace/{workspaceId}

Path parameters

workspaceIdstring required

Workspace ID or Name

Query parameters

verboseboolean

Verbose

Response

OK

idstring required
namestring required
targetstring required

Example response

{
  "projects": [
    {
      "buildConfig": {
        "cachedBuild": {
          "image": "image",
          "user": "user"
        },
        "devcontainer": {
          "filePath": "filePath"
        }
      },
      "gitProviderConfigId": "gitProviderConfigId",
      "image": "image",
      "envVars": {
        "key": "envVars"
      },
      "name": "name",
      "state": {
        "gitStatus": {
          "behind": 6,
          "fileStatus": [
            {
              "extra": "extra",
              "name": "name",
              "staging": "Unmodified",
              "worktree": null
            },
            {
              "extra": "extra",
              "name": "name",
              "staging": "Unmodified",
              "worktree": null
            }
          ],
          "ahead": 0,
          "branchPublished": true,
          "currentBranch": "currentBranch"
        },
        "updatedAt": "updatedAt",
        "uptime": 1
      },
      "repository": {
        "owner": "owner",
        "path": "path",
        "name": "name",
        "id": "id",
        "source": "source",
        "prNumber": 0,
        "branch": "branch",
        "cloneTarget": "branch",
        "sha": "sha",
        "url": "url"
      },
      "user": "user",
      "target": "target",
      "workspaceId": "workspaceId"
    },
    {
      "buildConfig": {
        "cachedBuild": {
          "image": "image",
          "user": "user"
        },
        "devcontainer": {
          "filePath": "filePath"
        }
      },
      "gitProviderConfigId": "gitProviderConfigId",
      "image": "image",
      "envVars": {
        "key": "envVars"
      },
      "name": "name",
      "state": {
        "gitStatus": {
          "behind": 6,
          "fileStatus": [
            {
              "extra": "extra",
              "name": "name",
              "staging": "Unmodified",
              "worktree": null
            },
            {
              "extra": "extra",
              "name": "name",
              "staging": "Unmodified",
              "worktree": null
            }
          ],
          "ahead": 0,
          "branchPublished": true,
          "currentBranch": "currentBranch"
        },
        "updatedAt": "updatedAt",
        "uptime": 1
      },
      "repository": {
        "owner": "owner",
        "path": "path",
        "name": "name",
        "id": "id",
        "source": "source",
        "prNumber": 0,
        "branch": "branch",
        "cloneTarget": "branch",
        "sha": "sha",
        "url": "url"
      },
      "user": "user",
      "target": "target",
      "workspaceId": "workspaceId"
    }
  ],
  "name": "name",
  "id": "id",
  "info": {
    "projects": [
      {
        "providerMetadata": "providerMetadata",
        "isRunning": true,
        "created": "created",
        "name": "name",
        "workspaceId": "workspaceId"
      },
      {
        "providerMetadata": "providerMetadata",
        "isRunning": true,
        "created": "created",
        "name": "name",
        "workspaceId": "workspaceId"
      }
    ],
    "providerMetadata": "providerMetadata",
    "name": "name"
  },
  "target": "target"
}