Introduction

The Qlty API is organized around REST. The API provides predictable, resource-oriented URLs, accepts JSON-encoded request bodies, and returns JSON-encoded responses. We strive to make use of standard HTTP response codes, authentication, and verbs.

Authentication

The Qlty API uses tokens to authenticate requests.

Authentication is performed either by HTTP Basic Auth or by passing the token in the Authorization header. To use HTTP Basic Auth, you must pass the token as the username and leave the password blank. For example:

$
curl -u <token>: https://api.qlty.com/v1/...

Alternatively, you can pass the token in the Authorization header:

$
curl -H "Authorization: Bearer <token>" https://api.qlty.com/v1/...

All API requests must be made over HTTPS. Calls made over plain HTTP or without authentication will fail.

Errors

Qlty uses conventional HTTP response codes to indicate the success or failure of an API request. Codes in the 2xx range indicate success.

Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted). Codes in the 5xx range indicate an error with Qlty’s server.

Errors are returned in the errors key of the response.

1
{
2
    "errors": [
3
        {
4
            "status": "400",
5
            "title": "Bad Request",
6
            "detail": "The request was invalid."
7
        }
8
    ]
9
}

Pagination

Many list API endpoints return paginated results. The Qlty API uses offset-based pagination. The page[limit] query parameter is used to specify the number of items to return per page. The page[offset] query parameter is used to specify the offset of the first item to return.

When additional records are available, the response will include a meta key with a hasMore: true property.

$
curl -X GET "https://api.qlty.com/v1/workspaces?page[limit]=2&page[offset]=0" \
>
    -H "Authorization: Bearer <token>"

1
{
2
    "data": [{
3
        "id": "1",
4
        "name": "John Doe"
5
    }, {
6
        "id": "2",
7
        "name": "Jane Doe"
8
    }],
9
    "meta": {
10
        "hasMore": true
11
    }
12
}

Rate Limiting

Qlty uses rate limiting to ensure that the API is not overwhelmed by too many requests. If you exceed the rate limit, you will receive a 429 Too Many Requests response.

The rate limit is 1,000 requests per hour per workspace.

Versioning

The Qlty API does not currently have a versioning scheme. Today, all endpoints are available at https://api.qlty.com/v1/ signifying V1.

Prior to the general availability of the API, we are evaluating a versioning scheme that will allow us to make breaking changes without affecting existing users.