---
title: "Narrow Api Key"
method: PATCH
path: "/org/api-keys/{key_id}"
tags: ["org"]
---

# Narrow Api Key

`PATCH /org/api-keys/{key_id}`

## 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/org/api-keys/{key_id}`
- Auth: HTTP bearer

Narrows a live key's scopes from its next request on; more scopes need a new key.

## Path parameters

- `key_id` string, uuid, required

## Request body

- ApiKeyPatch
  - `scopes` string[], required

## Response `200`

Successful Response

- ApiKey
  - `id` string, uuid, required
  - `name` string, required
  - `prefix` string, required
  - `workspace_id` string, uuid, nullable, required
  - `scopes` string[], nullable, required
  - `created_by` string, uuid, nullable, required
  - `created_by_email` string, nullable, required
  - `created_at` string, date-time, required
  - `expires_at` string, date-time, nullable, required
  - `last_used_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)