Skip to main content
POST
/
Agent
/
Tokens
/
GetDescription
Get Description
curl --request POST \
  --url https://{host}/Agent/Tokens/GetDescription \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "tokenId": "<string>",
  "reportFormat": "<string>"
}
'
{
  "report": "<string>"
}

Overview

Creates a report relating to a state machine associated with a token.

Authentication

Requires a valid JWT bearer token.

Notes

This endpoint uses the request schema notation described in Pattern matching.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
tokenId
string
required
reportFormat
string
required

Response

200 - application/json

Success

report
string
required