Skip to content

Issue a new signing secret

POST
/reports/webhooks/{endpoint_id}/rotate-secret

Replaces the signing secret and returns the new one once. The old secret stops working immediately, so deploy the new value before rotating if you cannot tolerate a gap.

Authorizations

ApiKeyAuth

API key from the dashboard. Some Host Mode endpoints also accept the key as an api_key field in the request body — this is stated in the schema of the particular operation.

Type
API Key (header: X-API-KEY)

Parameters

Header Parameters

X-Real-IP*

An IP address from the key's whitelist. A request from an address outside the whitelist is rejected with 401.

Type
string
Required
Example"203.0.113.10"
Format
"ipv4"

Path Parameters

endpoint_id*
Type
integer
Required

Responses

Rotated. The secret field appears only here.

application/json
JSON
{
  
"status": "success",
  
"code": 0,
  
"msg": "",
  
"data": {
  
  
"id": 0,
  
  
"url": "string",
  
  
"role": "string",
  
  
"is_active": true,
  
  
"created_at": "string",
  
  
"updated_at": "string",
  
  
"secret": "whsec_..."
  
}
}

Playground

Authorization
Headers
Variables
Key
Value

Samples

Powered by VitePress OpenAPI