GET
/
repos
/
{repo_id}
/
workspaces
/
{workspace_id}
/
status

Authorizations

Authorization
string
headerrequired

This API uses OAuth 2 with the implicit grant flow

Path Parameters

repo_id
string
required

The repo ID of the repository. Repo name can be used instead of the ID, but usage of ID for permanent linking and API requests is preferred.

workspace_id
string
required

The repo ID of the workspace.

Query Parameters

detail_items
boolean
default: true

Should detail all the changed items in status response

limit
integer

Limit the number of entries returned from walk

recurse
boolean
default: true

Specifies if to recursively iterate file tree to next directory levels

path_prefix
string

A path prefix in the file tree to walk under

Response

200 - application/json

The status of the workspace, meaning its bill of changes. It will contain the total number of changed items and specifically changed files. If paths details were requested, it will also contain an object having 'new', 'modified', 'deleted' arrays of file entries, sorted lexicographically.

changed_items_count
number
required

Number of changed items of all types

changed_files_count
number
required

Number of changed files

incomplete_result
boolean

The result list was trimmed and the counts are a lower bound only

items
object

Drill down into modified items by change type

conflicts
string[] | null

List of conflicted file paths, compared to the base branch, if applicable

Get updates needed to be applied by the client to this workspaceReset changes in workspace