Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Relativity Health Check Module API

The Health Check Module API from Relativity — 1 operation(s) for health check module.

Relativity Health Check Module API is one of 51 APIs that Relativity publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Health Check Module. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, rate-limit docs, and a getting-started guide.

This API exposes 1 operation across 1 path, and defines 1 schema. It is described by OpenAPI 3.0.1, at version V1.

Requests are made against a single base URL, /Relativity.REST/api.

1 operations 1 paths 1 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
V1
Base URL
https://{host}/Relativity.REST/api/relativity-object-model/v1
Resource Areas
1

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

Health Check Module 1
GET
/import-service/v1/health-check/
Check if Import Service is available.
Import.Services.V1.HealthCheckController.HealthCheckAsync 1 param → 200400

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is HealthCheckResult (2 properties). Each schema is shown below with its type and property counts.

HealthCheckResult
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

relativity-health-check-module-api-openapi.yml Raw ↑

Other APIs Relativity publishes across the network.

Relativity AnnotationService API
Relativity ArchiveJobs API
Relativity ARM Module v1 API
Relativity ARM Module v3 API
Relativity BillableSummaryReports API
Relativity BillingConfiguration API
Relativity BillingInsights API
Relativity Client Side Libraries Module API
Relativity ColdStorage API
Relativity CollectAPI API
Relativity Conceptual Analytics v1 API
Relativity Directory API