Skip to content
Nexa Platform Docs

Get workspace object status

GET
/api/v1/workspace/status
curl --request GET \
  --url 'https://example.com/api/v1/workspace/status?path=example'

Get status of a workspace object.

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
path
required
Path

Workspace path to check

string

Workspace path to check

Header Parameters

Section titled “Header Parameters”
X-Environment-Id
Any of:
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
WorkspaceStatusResponse

Response model for workspace object status.

object
path
required
Path

Object path

string
object_type
required
Object Type

Object type

string
object_id
Any of:
integer
language
Any of:
string
Examplegenerated
{
  "path": "example",
  "object_type": "example",
  "object_id": 1,
  "language": "example"
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}