---
title: "Suspend API key"
method: POST
path: "/api/api-keys/{key_id}/suspend"
tags: ["v1", "api-keys"]
---

# Suspend API key

`POST /api/api-keys/{key_id}/suspend`

Suspend an API key

## Path parameters

- `key_id` string, required

## Response `200`

Successful Response

- APIKeyInfo
  - `user_id` string, required
  - `scopes` APIKeyPermission[], required
  - `type` 'api_key'
  - `created_at` string, date-time, required
  - `expires_at` string, date-time, nullable
  - `last_used_at` string, date-time, nullable
  - `revoked_at` string, date-time, nullable
  - `organization_id` string, nullable
  - `team_id_restriction` string, nullable
  - `id` string, required
  - `name` string, required
  - `head` string, required — The first 8 characters of the key
  - `tail` string, required — The last 8 characters of the key
  - `status` 'ACTIVE' | 'REVOKED' | 'SUSPENDED', required
  - `description` string, nullable
  - `owner_type` string, nullable

## Other responses

- `401` — Authentication required
- `422` — Validation Error

---

[API](https://skmtc.net/significant-gravitas/apis/autogpt-agent-server.md) · [All operations](https://skmtc.net/significant-gravitas/apis/autogpt-agent-server/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/significant-gravitas/autogpt-agent-server/versions/382041c7ecb2/schema)