Table of Contents

API surface

The Reignite API is the control plane. It is an ASP.NET Core service under /api/v1/, backed by SQL Server. This page describes the shape of the surface; the running deployment is the authority for exact request and response bodies.

Base URLs

See the generated environments table. The production base is https://api.reigniteperformance.com/api/v1/.

Authentication

Caller Mechanism
Website / portal user A JWT issued by the identity provider; the website attaches it to API calls.
Profiler agent The ProfilerID, KeyID and Secret from the generated configuration block.
Diagnostic bot Authorization: Bearer <token> using DiagnosticsControlPlane:ApiToken.
Analyst tooling The analyst's portal credentials, exchanged for a token.

Do not reuse a service token for a user-facing client. Rotate service tokens independently.

Controller families

The API is organized around the control-plane entities. The main families are:

Family Responsibility
Account / authentication / users Sign-in, account details, users, roles and impersonation.
Application / environment The customer's applications and their deployment environments.
Profiler / API key Profiler configuration, generated configuration blocks and key lifecycle.
Trace files The trace-file queue, assignment, status transitions and analyst work.
Artifacts Upload and download of traces, dumps and analysis files.
Analysis / reports Analysis records, reports and resolutions.
Diagnostics control plane Status, metrics, traces and asynchronous diagnoses for the bots.
Diagnostics probes / version Probe and version information for diagnostics.
Billing / subscription Stripe checkout, billing portal and subscription state.
Source control GitHub repository synchronization.
Email / help Transactional email and help intake.

Use the controller names in the api repository when you need the exact route. The repository map links to it.

Swagger / OpenAPI

The API configures Swagger with a Bearer security definition. When the deployment enables UseSwagger, the Swagger UI is the authoritative reference for request and response shapes (typically at /swagger). Treat the generated OpenAPI document as the contract and this page as the map.

Errors

The API uses ASP.NET Core problem details (application/problem+json) for validation and handled failures. Common status codes:

Status Meaning
400 Validation failure or malformed body.
401 Missing or invalid credentials.
403 Authenticated but not allowed (role or tenant mismatch).
404 The entity does not exist in the caller's scope.
409 Conflict, such as a duplicate or an illegal status transition.
429 Rate limit (where a limiter is configured).
502 An upstream dependency (identity, storage, billing) failed.

Do not parse error text to drive behavior; branch on the status code and the problem-details type.

Pagination and filtering

Where a list endpoint is paged, use the parameters it documents in Swagger rather than assuming a global convention. Do not fetch every page to find one row; use the filtered endpoint.