The vzaar Developer Hub

Welcome to the vzaar developer hub. You'll find comprehensive guides and documentation to help you start working with vzaar as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Responses

Every API response will use an appropriate HTTP status code and you can use this to determine whether a request was successful or otherwise.

If there are errors, the response body will contain a JSON document with details.

Success (2xx)

200 OK
The request was successful.

201 Created
The new resource was successfully created.

202 Accepted
The request has been accepted for processing, but the processing has not been completed.

204 No Content
The request was successful and there is no response body. Typically this would be when deleting a resource.

Client Error (4xx)

400 Bad Request
The request was invalid or could not be understood by the server. Resubmitting the request will likely result in the same error. This commonly occurs when your JSON is invalid.

401 Unauthorized
Your API credentials are missing or invalid.

403 Forbidden
You are attempting to perform an action or access a resource you it do not have privileges to access.

404 Not Found
The resource was not found with the given identifier.

422 Unprocessable Entity
Could not process request because the request parameters are invalid. See the response body for more details.

429 Too many Requests
You have exceeded your API rate limit.

Server Error (5xx)

500 Server error
An unexpected error has occurred on the server.

Error Examples

{
  "errors": [
    {
      "message": "Authentication failed",
      "detail": "Invalid credentials"
    }
  ]
}
{
  "errors": [
    {
      "message": "Not found",
      "detail": "The requested resource cannot be found"
    }
  ]
}
{
  "errors": [
    {
      "message": "Bad parameters",
      "detail": "filename is missing, filesize is missing, uploader is missing"
    }
  ]
}
{
  "errors": [
    {
      "message": "Server error",
      "detail": "An unexpected error occurred"
    }
  ]
}

Updated about a year ago

Responses


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.