Qubitro REST API
The Qubitro REST API is a REST-styled API that gives you full control over the entire Qubitro platform. You can use it with any programming language or framework that can send HTTP requests.
The API supports any programming language or framework that can send HTTP requests.
API Basics
Our API is exposed as an HTTP/1 and HTTP/2 service over SSL. All endpoints live under the URL https://api.qubitro.com and then generally follow the REST architecture.
Server Specs
The API supports HTTP versions 1, 1.1, and 2, although HTTP/2 is preferred.
TLS versions 1.2 and 1.3 are supported, with resumption.
For more information on TLS support, refer to the SSL Labs report.
Content Type
All requests must be encoded as JSON with the Content-Type: application/json header. If not otherwise specified, responses from the Qubitro API, including errors, are encoded exclusively as JSON as well.
Authentication
All requests to the Qubitro REST API require an API Key passed as a Bearer token in the Authorization header.
You can generate and manage API Keys in the Qubitro Portal. If needed, configure scopes to limit access to specific projects or actions.
Include the header as follows:
Authorization: Bearer YOUR_API_KEYCreating an API Key
API keys can be created and managed within the Account Credentials section.
Requests and Responses
Qubitro REST API returns JSON responses along with standard HTTP status codes.
For example, 200 indicates a successful request, while errors such as 401 or 403 arise from invalid authentication or insufficient permissions.
The following table outlines common status codes:
200
OK
The request was successful
201
Created
A new resource was successfully created
400
Bad Request
Invalid input or missing parameters
401
Unauthorized
Invalid or missing API Key
403
Forbidden
Insufficient permissions for the resource
404
Not Found
Requested resource does not exist
500
Internal Error
Server encountered an error
Last updated