# Burn Secret

**POST /api/v1/metadata/{key}/burn**




## Servers
- Aotearoa New Zealand: https://nz.onetimesecret.com (Aotearoa New Zealand)
- Canada: https://ca.onetimesecret.com (Canada)
- Europe: https://eu.onetimesecret.com (Europe)
- United Kingdom: https://uk.onetimesecret.com (United Kingdom)
- United States: https://us.onetimesecret.com (United States)
- Development: http://localhost:3000 (Development)


## Authentication methods
- Basic auth


## Parameters

### Path parameters
- **key** (string)
  The key parameter


### Body: application/x-www-form-urlencoded (object)

- **continue** (string)



## Responses
### 200
Successful response

#### Body: application/json (object)
- **state** (object)

- **secret_shortkey** (string)


### 400
Bad Request - Invalid request parameters or body

#### Body: application/json (object)
- **error** (string)
  Error type identifier (e.g., "FormError")
- **message** (string)
  Human-readable error message
- **field** (string)
  Field that caused the error, if applicable
- **error_id** (string)
  Unique error tracking identifier

### 401
Unauthorized - Authentication required

#### Body: application/json (object)
- **error** (string)
  Error type identifier (e.g., "FormError")
- **message** (string)
  Human-readable error message
- **field** (string)
  Field that caused the error, if applicable
- **error_id** (string)
  Unique error tracking identifier

### 403
Forbidden - Insufficient permissions

#### Body: application/json (object)
- **error** (string)
  Error type identifier (e.g., "FormError")
- **message** (string)
  Human-readable error message
- **field** (string)
  Field that caused the error, if applicable
- **error_id** (string)
  Unique error tracking identifier

### 404
Not Found - Resource does not exist

#### Body: application/json (object)
- **error** (string)
  Error type identifier (e.g., "FormError")
- **message** (string)
  Human-readable error message
- **field** (string)
  Field that caused the error, if applicable
- **error_id** (string)
  Unique error tracking identifier

### 422
Unprocessable Entity - Validation failed

#### Body: application/json (object)
- **error** (string)
  Error type identifier (e.g., "FormError")
- **message** (string)
  Human-readable error message
- **field** (string)
  Field that caused the error, if applicable
- **error_id** (string)
  Unique error tracking identifier

### 500
Internal Server Error - Something went wrong

#### Body: application/json (object)
- **error** (string)
  Error type identifier (e.g., "FormError")
- **message** (string)
  Human-readable error message
- **field** (string)
  Field that caused the error, if applicable
- **error_id** (string)
  Unique error tracking identifier


[Powered by Bump.sh](https://bump.sh)