# Export API

An API is available to allow exporting information from Cover Reports. This is a read only REST API that returns information in a [JSON](https://www.json.org/json-en.html) format. This API is provided to allow external systems to integrate with Cover Reports, for example, to download coverage statistics and incorporate them with other information within your organisation.

## Available Endpoints

The available endpoints are specified in live documentation deployed within Cover Reports itself. To view this, navigate to**`/swagger-ui/index.html`** in Cover Reports, for example `http://cover-reports.mycompany.com:8080`**`/swagger-ui/index.html`**

<figure><img src="/files/UOdgNC42YX6ktksM3523" alt=""><figcaption><p>The live documentation in a locally installed Cover Reports</p></figcaption></figure>

This page reflects the capabilities of the installed Cover Reports.

Additionally, it is possible to send requests to the API using this page. This can be useful when exploring the API to understand how it works.

## Authentication

By default, any Diffblue Cover user can access the Cover Reports export API. However, you may want to restrict and/or secure access using API authentication. For example, you may want to restrict access to specific systems only. For more information see [Configuration options](/features/cover-reports/cover-reports-administrator/configuration-options.md).

## Versioning

Each release of Cover Reports may change the API. When changes are made that may break existing installations that have come to rely on the API, a new version will be set in the API URL. Existing systems will continue to work using the previous URLs, while new integrations can benefit from the improved API.

At this point, the previous API will be deprecated in favour of the new one. This will provide a short transition period to allow installations to adjust to use the new API.

{% hint style="info" %}
Only 2 versions of the API will be supported at any time. Therefore, when an API is deprecated, it is important to migrate to the new API as soon as possible to ensure a continuous upgrade path.
{% endhint %}


---

# Agent Instructions: Querying This Documentation

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

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://cover-docs-preview.diffblue.com/features/cover-reports/cover-reports-user/export-api.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.