---
title: "Retire"
method: POST
path: "/robots/{robot_id}/deployments/{deployment_id}/retire"
tags: ["robots"]
---

# Retire

`POST /robots/{robot_id}/deployments/{deployment_id}/retire`

## Request

- Base URL: `https://api.os3robotics.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.os3robotics.com/robots/{robot_id}/deployments/{deployment_id}/retire`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer

## Path parameters

- `robot_id` string, uuid, required
- `deployment_id` string, uuid, required

## Response `200`

Successful Response

- Deployment
  - `id` string, uuid, required
  - `robot_id` string, uuid, required
  - `endpoint_id` string, uuid, required
  - `model_version_id` string, uuid, nullable, required
  - `handshake` object, required
  - `note` string, nullable, required
  - `active` boolean, required
  - `created_at` string, date-time, required
  - `retired_at` string, date-time, nullable, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/os3robotics/apis/os3-api.md) - [All operations](https://skmtc.dev/os3robotics/apis/os3-api/llms.txt) - [OpenAPI document](https://skmtc.dev/os3robotics/apis/os3-api/revisions/af32cd4f14bb?raw)