Register a report webhook endpoint

POST

/reports/webhooks

Registers a URL that NETTS will call when a report is ready. Up to two endpoints per account: primary, and an optional backup used only after delivery to the primary has been exhausted.
The signing secret is returned once, in this reply. It is never shown again — store it. Lost it, use rotate-secret.
The URL must be public HTTPS. Loopback, private and link-local addresses are rejected, and so are credentials embedded in the URL.

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"

Request Body

application/json

{

  

"url": "string",

  

"role": "string"

}

Responses

Registered. The secret field appears only here.

Content-Type

application/json

{

  

"status": "success",

  

"code": 0,

  

"msg": "",

  

"data": {

  

  

"id": 0,

  

  

"url": "string",

  

  

"role": "string",

  

  

"is_active": true,

  

  

"created_at": "string",

  

  

"updated_at": "string",

  

  

"secret": "whsec_..."

  

}

}

POST

/reports/webhooks

Playground

Authorization

ApiKeyAuth

Headers

X-Real-IP*

Body

Samples

Powered by VitePress OpenAPI