---
title: "Validate workspace input"
method: POST
path: "/api/projects/{projectId}/workspaces/validate"
tags: ["Workspaces"]
---

# Validate workspace input

`POST /api/projects/{projectId}/workspaces/validate`

Validate workspace input. Accepts a JSON request body when defined and returns the resulting resource or action status.

## Path parameters

- `projectId` string, required

## Request body

- ValidateWorkspaceRequest — validate Workspace Request payload accepted by the API.
  - `path` string, required — File system path or repository-relative path.
  - `sourceType` string, required — source Type value for the validate Workspace Request object.

## Response `200`

Validation result

- ValidateWorkspaceResponse — validate Workspace Response payload returned by the API.
  - `path` string, required — File system path or repository-relative path.
  - `sourceType` string, required — source Type value for the validate Workspace Response object.
  - `valid` boolean, required — Whether the value passed validation.
  - `classification` string, required — Classification assigned during validation or suggestion lookup.
  - `error` string — Error message when the operation failed.
  - `suggestions` Suggestion[], required — Suggested values returned by validation or autocomplete.
    - `value` string, required — value value for the suggestion object.
    - `type` string, required — type value for the suggestion object.
    - `valid` boolean, required — Whether the value passed validation.
    - `classification` string — Classification assigned during validation or suggestion lookup.
  - `authProvider` string — auth Provider value for the validate Workspace Response object.
  - `authRequired` boolean — auth Required value for the validate Workspace Response object.
  - `authMessage` string — auth Message value for the validate Workspace Response object.

---

[API](https://skmtc.net/ibuildthecloud/apis/discobot-server-api.md) · [All operations](https://skmtc.net/ibuildthecloud/apis/discobot-server-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ibuildthecloud/discobot-server-api/versions/4de3fcd6be56/schema)