Skip to main content

API Introduction

Welcome to the documentation for our API!

This document provides you an OpenAPI specification for the ReportPortal API.

What is ReportPortal API?

ReportPortal implements a REST API that allows you to interact with our services programmatically. There are two types of specifications:

  • Manual described API according to API First approach. It doesn't cover all API endpoints, but it's more detailed.
  • Automated generated API according to OpenAPI specification. It covers all API endpoints, but it's less detailed.

Why use our API?

Our API provides a convenient and efficient way to access and interact with the ReportPortal services. By using our API, you can report test results, manage your projects, and more.

Getting Started

To get started with our API, you will need an API key. You can obtain an API key by signing up for an account on a ReportPortal UI. Once you have an API key, you can use it to authenticate your requests and access ReportPortal API endpoints.

API Documentation

Our API documentation provides detailed information about each API endpoint, including the request and response formats, authentication requirements, and available parameters.


If you have any questions or need assistance with our API, please don't hesitate to contact our support team. We're here to help!

ReportPortal Team:

ReportPortal Website:

Happy coding!