Realtime Cloud Storage

describeTable

Retrieves information about the table, including the current status of the table, the primary key schema and date of creation.

Sample

curl 'https://storage-backend-prd-useast1.realtime.co/describeTable' -H 'Content-Type: application/json; charset=UTF-8' -d '{ "applicationKey":"[YOUR_APP_KEY]", "authenticationToken":"[YOUR_TOKEN]", "table":"SampleUser" }'

Parameters

String applicationKey

Public key of the application's license.

String privateKey optional

Private key of the application's license. For administration use only.

String authenticationToken

Identification of the user using the application.

String table

The name of the table.

DescribeTableResponse callback

Function called when the operation completes.

Response

DescribeTableResponse(data, error)

Response of the describeTable operation.

Object data

Error error

The attribute that holds the results of the operation if an error occurred.