---
title: "Revoke the honeytoken"
method: POST
path: "/v1/honeytokens/{honeytoken_id}/revoke"
tags: ["Honeytokens"]
---

# Revoke the honeytoken

`POST /v1/honeytokens/{honeytoken_id}/revoke`

## Request

- Base URL: `https://api.gitguardian.com`
- URL: `https://api.gitguardian.com/v1/honeytokens/{honeytoken_id}/revoke`
- Auth: HTTP bearer

Revokes an active or triggered honeytoken. All the associated events will be closed.

## Path parameters

- `honeytoken_id` string, uuid, required

## Headers

- `X-Privacy-Mode` 'true' | 'false'

## Response `200`

Honeytoken was successfully revoked.

- object
  - `id` string, uuid
  - `name` string
  - `description` string
  - `created_at` string, date-time: Creation date of the honeytoken
  - `gitguardian_url` string
  - `status` 'active' | 'triggered' | 'revoked': Status of the honeytoken.
  - `triggered_at` string, date-time: Date when the honeytoken was switched from active to triggered the last time
  - `revoked_at` string, date-time: Date when the honeytoken was revoked
  - `open_events_count` integer
  - `type` 'AWS': Type of the honeytoken.
  - `creator_id` integer, nullable: Id of the member who created this honeytoken.
  - `revoker_id` integer, nullable: Id of the member who revoked this honeytoken.
  - `creator_api_token_id` string, uuid, nullable: ID of the API key which created this honeytoken. Can be null if the honeytoken was not created via the API.
  - `revoker_api_token_id` string, uuid, nullable: ID of the API key which created honeytoken note. Can be null if the honeytoken was not created via the API.
  - `token` object: Secret to be placed as a honeytoken.
  - `tags` string[]
  - `custom_tags` object[]: Custom tags set on the honeytoken.
    - `id` string, uuid
    - `key` string
    - `value` string, nullable

## Other responses

- `400`: Invalid data
- `401`: Invalid API key
- `503`: API under maintenance

---

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