Delete all tokens

If several production lines have served their purpose, they MUST be dismantled. This can be done using a single mass data operation instead of explicit individual operations. To do this, the request MUST be sent without any HTTP request path parameter.

The deleted production lines are returned from the remote service as list in the JSON response body. Each data object of type: tokens in the list has the same structure as if it had been requested by its identifier via HTTP request path parameter.

Mass data operation

This operation can be used at any time during an existing session. All existing production lines of the current session will be irretrievably destroyed, so the operation SHOULD be used responsibly.

Consider a snapshot

Consider routinely recording the status of production lines as a compact and encrypted point-in-time representation in a binary file called snapshot.blob so that you can continue the production line at any time later. The uniqueness of the tokens of a production line is only guaranteed if this snapshot is restored before the production line is continued!

Request endpoint

DELETE SERVER:PORT/api/tokens

Response status

200

Request headers

Accept:application/vnd.api+json
Content-Type:application/vnd.api+json
Session-Key:SSSSSSSS-SSSS-SSSS-SSSS-SSSSSSSSSSSS

Response headers

Transfer-Encoding:chunked
Connection:keep-alive
Accept:application/vnd.api+json
Cache-Control:no-cache
Date:Tue, 19 Mar 2024 12:52:59 GMT
Content-Type:application/vnd.api+json
Server:nginx/1.25.4

Request body

# intentionally blank

Response body

{
    "links": {
        "self": "/api/tokens"
    },
    "data": [
        {
            "attributes": {
                "analysis": "none",
                "rate": 9086,
                "reachable": "0",
                "alphabet": "DICE",
                "available": "0",
                "partial": false,
                "checksum": "0000000000000000000000000000000000000000000000000000000000000000000000",
                "status": "deleted",
                "filesizes": {
                    "data": 124415
                },
                "digits": "5",
                "size": "7776",
                "timestamps": {
                    "ended": "2024-03-19T12:52:54.707Z",
                    "deleted": "2024-03-19T12:52:59.403Z",
                    "started": "2024-03-19T12:52:50.425Z",
                    "requested": "2024-03-19T12:52:50.388Z",
                    "finished": "2024-03-19T12:52:54.708Z"
                }
            },
            "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "type": "tokens",
            "relationships": {
                "payment": {
                    "data": {
                        "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
                        "ident": "pi_XXXXXXXXXXXXXXXXXXXXXXXX",
                        "type": "transaction"
                    }
                }
            }
        },
        {
            "attributes": {
                "analysis": "none",
                "rate": 9207,
                "reachable": "0",
                "alphabet": "DICE",
                "available": "0",
                "partial": false,
                "checksum": "0000000000000000000000000000000000000000000000000000000000000000000000",
                "status": "deleted",
                "filesizes": {
                    "data": 124415
                },
                "digits": "5",
                "size": "7776",
                "timestamps": {
                    "ended": "2024-03-19T12:52:59.133Z",
                    "deleted": "2024-03-19T12:52:59.426Z",
                    "started": "2024-03-19T12:52:54.904Z",
                    "requested": "2024-03-19T12:52:54.712Z",
                    "finished": "2024-03-19T12:52:59.134Z"
                }
            },
            "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "type": "tokens",
            "relationships": {
                "payment": {
                    "data": {
                        "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
                        "ident": "pi_XXXXXXXXXXXXXXXXXXXXXXXX",
                        "type": "transaction"
                    }
                }
            }
        }
    ]
}

HTTPie example

$ http delete SERVER:PORT/api/tokens Accept:application/vnd.api+json Content-Type:application/vnd.api+json Session-Key:SSSSSSSS-SSSS-SSSS-SSSS-SSSSSSSSSSSS