> For the complete documentation index, see [llms.txt](https://docs.qubitro.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.qubitro.com/developers/qubitro-rest-api.md).

# 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](https://www.ssllabs.com/ssltest/analyze.html?d=api.qubitro.com\&s=139.178.72.18).

#### 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.&#x20;

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:

```bash
Authorization: Bearer YOUR_API_KEY
```

#### Creating an API Key

API keys can be created and managed within the Account Credentials section.

{% embed url="<https://qubitro.gitbook.io/qubitro-documentation/platform/credentials/api-keys>" %}
Manage API Keys
{% endembed %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.qubitro.com/developers/qubitro-rest-api.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
