General structure

get
+ POST, PUT, DELETE

https://redivis.com/api/v1
All Redivis API endpoints inherit from the following structure:
Request
Response
Request
Headers
Authorization
optional
string
Bearer: {REDIVIS_API_TOKEN} If not provided, you will only be able to access publicly available content, and cannot edit content. Many methods require authorization credentials, including all POST/PATCH/DELETE methods.
Query Parameters
exactReferences
optional
boolean
If this query parameter is present, require that all datasets, projects, and tables are qualified with their persistent id.
strictReferences
optional
boolean
If this query parameter is present, an error will occur if a dataset, project, or table reference is inconsistent — that is, if the id and name do not match. See "referencing entities" for more information.
Response
200: OK
{
// The JSON encoded resource definition
}
201: Created
The resource was successfully created. Returned for POST methods only
{
// The JSON encoded resource definition
}
202: Accepted
Recognizes that content was received and has been queued for additional processing.
{
// The JSON encoded resource definition
}
400: Bad Request
The request payload was malformed
{
"error": {
"message": "",
"status": 400
}
}
401: Unauthorized
API access token (on the Authorization header) was missing or invalid
{
"error": {
"message": "Must provide a valid Authorization token",
"status": 401
}
}
403: Forbidden
You are not authorized to perform the given action
{
"error": {
"message": "Not authorized",
"status": 403
}
}
404: Not Found
The requested resource was not found
{
"error": {
"message": string,
"status": 404
}
}
429: Too Many Requests
API limit exhausted. Please see "Limits" below
{
"error": {
"message": "Too many requests, please try again later.",
"status": 429
}
}
500: Internal Server Error
An internal error occurred. Please contact support@redivis.com for further assistance.
{
"error": {
"message": string,
"status": 500
}
}

Warning headers

TODO

Limits

The API is currently limited to roughly 100 request per 100-second interval. The X-RateLimit-Limit header on all responses will be set to 100, and the X-RateLimit-Remaining will reveal the number of requests remaining within the current interval.

If the limit is exceeded for the current interval, you will receive a 429 error with a Retry-After header, specifying when you may resume requests.