Tunploy
APIReferenceGroups

Reset usage for a group

POST/groups/{external_id}/usage/reset

Resets every device in the group, as POST /devices/{id}/usage/reset does for one.

Needs the devices:write scope.

Authorization

apiKey
AuthorizationBearer <token>

An API key: tp_….

In: header

Path Parameters

external_id*string

The external_id the devices share, URL-encoded.

Lengthlength <= 255

Header Parameters

Idempotency-Key?string

A retry with the same key within 24 hours gets the first reply back (with Idempotent-Replayed: true) instead of running again.

Lengthlength <= 255

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/groups/string/usage/reset"
{  "external_id": "string",  "device_count": 0,  "month_usage": {    "rx_bytes": 0,    "tx_bytes": 0,    "total_bytes": 0  },  "devices": [    {      "id": 0,      "server_id": 0,      "name": "string",      "external_id": "string",      "metadata": {},      "address": "10.8.0.2",      "public_key": "string",      "client_key": true,      "enabled": true,      "status": "active",      "online": true,      "last_handshake": "2019-08-24T14:15:22Z",      "data_limit": 0,      "limit_period": "monthly",      "period_usage": {        "rx_bytes": 0,        "tx_bytes": 0,        "total_bytes": 0      },      "usage_reset_at": "2019-08-24T14:15:22Z",      "expires_at": "2019-08-24T14:15:22Z",      "speed_limit": 0,      "month_usage": {        "rx_bytes": 0,        "tx_bytes": 0,        "total_bytes": 0      },      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z",      "config": "string"    }  ]}