Skip to main content
POST
/
v1
/
sandbox
/
status
GetSandboxStatus
curl --request POST \
  --url https://app.textql.com/v1/sandbox/status \
  --header 'Authorization: Bearer <token>' \
  --header 'Connect-Protocol-Version: <connect-protocol-version>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "sandboxId": "<string>"
}
'
{
  "status": "<string>",
  "memoryUsage": "<string>",
  "dataframes": [
    {
      "name": "<string>",
      "numRows": 123,
      "numCols": 123,
      "memoryUsageBytes": 123
    }
  ]
}

Authorizations

Authorization
string
header
required

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

Headers

Connect-Protocol-Version
enum<number>
required

Define the version of the Connect protocol

Available options:
1
Connect-Timeout-Ms
number

Define the timeout, in ms

Body

application/json
sandboxId
string
required

Response

Success

status
string
memoryUsage
string
dataframes
DataFrameInfo · object[]