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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Relativity

Relativity Relativity Infrastructure Module v1 API

The Relativity Infrastructure Module v1 API from Relativity — 70 operation(s) for relativity infrastructure module v1.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 100 operations across 70 paths, and defines 44 schemas. It is described by OpenAPI 3.0.1, at version V1.

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

100 operations 70 paths 44 schemas 8 DELETE43 GET27 POST22 PUT

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 100

Across 70 paths, the API surfaces 100 operations — 8 DELETE, 43 GET, 27 POST, 22 PUT. Each is listed below with its method, path, parameters, and response codes.

Relativity Infrastructure Module v1 100
GET
/relativity-infrastructure/v1/workspaces/-1/worker-servers/{serverID}
[Public] IWorkerServerManager -
Relativity.Infrastructure.V1.WorkerServer.IWorkerServerManager.ReadAsync 3 params → 200
PUT
/relativity-infrastructure/v1/workspaces/-1/worker-servers/{serverID}
[Public] IWorkerServerManager -
Relativity.Infrastructure.V1.WorkerServer.IWorkerServerManager.UpdateAsync 1 param body → 200
DELETE
/relativity-infrastructure/v1/workspaces/-1/worker-servers/{serverID}
[Public] IWorkerServerManager -
Relativity.Infrastructure.V1.WorkerServer.IWorkerServerManager.DeleteAsync 1 param → 200
GET
/relativity-infrastructure/v1/workspaces/-1/worker-servers/{serverID}/eligible-designated-work
[Public] IWorkerServerManager -
Relativity.Infrastructure.V1.WorkerServer.IWorkerServerManager.GetEligibleWorkerDesignatedWorkAsync 1 param → 200
POST
/relativity-infrastructure/v1/workspaces/-1/worker-servers/{serverID}/start-worker
[Public] IWorkerServerManager -
Relativity.Infrastructure.V1.WorkerServer.IWorkerServerManager.StartWorkerAsync 1 param → 200
POST
/relativity-infrastructure/v1/workspaces/-1/worker-servers/{serverID}/stop-worker
[Public] IWorkerServerManager -
Relativity.Infrastructure.V1.WorkerServer.IWorkerServerManager.StopWorkerAsync 1 param → 200
POST
/relativity-infrastructure/v1/workspaces/-1/worker-servers/{serverID}/enable-processing-license
[Public] IWorkerServerManager -
Relativity.Infrastructure.V1.WorkerServer.IWorkerServerManager.EnableProcessingLicenseAsync 1 param → 200
POST
/relativity-infrastructure/v1/workspaces/-1/worker-servers/{serverID}/disable-processing-license
[Public] IWorkerServerManager -
Relativity.Infrastructure.V1.WorkerServer.IWorkerServerManager.DisableProcessingLicenseAsync 1 param → 200
POST
/relativity-infrastructure/v1/workspaces/-1/worker-manager-servers
[Public] IWorkerManagerServerManager -
Relativity.Infrastructure.V1.WorkerManagerServer.IWorkerManagerServerManager.CreateAsync body → 200
GET
/relativity-infrastructure/v1/workspaces/-1/worker-manager-servers/{serverID}
[Public] IWorkerManagerServerManager -
Relativity.Infrastructure.V1.WorkerManagerServer.IWorkerManagerServerManager.ReadAsync 3 params → 200
PUT
/relativity-infrastructure/v1/workspaces/-1/worker-manager-servers/{serverID}
[Public] IWorkerManagerServerManager -
Relativity.Infrastructure.V1.WorkerManagerServer.IWorkerManagerServerManager.UpdateAsync 1 param body → 200
DELETE
/relativity-infrastructure/v1/workspaces/-1/worker-manager-servers/{serverID}
[Public] IWorkerManagerServerManager -
Relativity.Infrastructure.V1.WorkerManagerServer.IWorkerManagerServerManager.DeleteAsync 1 param → 200
GET
/relativity-infrastructure/v1/workspaces/-1/worker-manager-servers/default-field-values
[Public] IWorkerManagerServerManager -
Relativity.Infrastructure.V1.WorkerManagerServer.IWorkerManagerServerManager.GetDefaultFieldValuesAsync → 200
GET
/relativity-infrastructure/v1/workspaces/-1/web-windows-auth-servers/{serverID}
[Public] IWebWindowsAuthServerManager -
Relativity.Infrastructure.V1.WebWindowsAuthServer.IWebWindowsAuthServerManager.ReadAsync 3 params → 200
PUT
/relativity-infrastructure/v1/workspaces/-1/web-windows-auth-servers/{serverID}
[Public] IWebWindowsAuthServerManager -
Relativity.Infrastructure.V1.WebWindowsAuthServer.IWebWindowsAuthServerManager.UpdateAsync 1 param body → 200
GET
/relativity-infrastructure/v1/workspaces/-1/web-servers/{serverID}
[Public] IWebServerManager -
Relativity.Infrastructure.V1.WebServerManager.IWebServerManager.ReadAsync 3 params → 200
PUT
/relativity-infrastructure/v1/workspaces/-1/web-servers/{serverID}
[Public] IWebServerManager -
Relativity.Infrastructure.V1.WebServerManager.IWebServerManager.UpdateAsync 1 param body → 200
GET
/relativity-infrastructure/v1/workspaces/-1/web-forms-auth-servers/{serverID}
[Public] IWebFormsAuthServerManager -
Relativity.Infrastructure.V1.WebFormsAuthServer.IWebFormsAuthServerManager.ReadAsync 3 params → 200
PUT
/relativity-infrastructure/v1/workspaces/-1/web-forms-auth-servers/{serverID}
[Public] IWebFormsAuthServerManager -
Relativity.Infrastructure.V1.WebFormsAuthServer.IWebFormsAuthServerManager.UpdateAsync 1 param body → 200
GET
/relativity-infrastructure/v1/workspaces/-1/web-distributed-windows-auth-servers/{serverID}
[Public] IWebDistributedWindowsAuthServerManager -
Relativity.Infrastructure.V1.WebDistributedWindowsAuthServer.IWebDistributedWindowsAuthServerManager.ReadAsync 3 params → 200
PUT
/relativity-infrastructure/v1/workspaces/-1/web-distributed-windows-auth-servers/{serverID}
[Public] IWebDistributedWindowsAuthServerManager -
Relativity.Infrastructure.V1.WebDistributedWindowsAuthServer.IWebDistributedWindowsAuthServerManager.UpdateAsync 1 param body → 200
GET
/relativity-infrastructure/v1/workspaces/-1/web-distributed-servers/{serverID}
[Public] IWebDistributedServerManager -
Relativity.Infrastructure.V1.WebDistributedServer.IWebDistributedServerManager.ReadAsync 3 params → 200
PUT
/relativity-infrastructure/v1/workspaces/-1/web-distributed-servers/{serverID}
[Public] IWebDistributedServerManager -
Relativity.Infrastructure.V1.WebDistributedServer.IWebDistributedServerManager.UpdateAsync 1 param body → 200
GET
/relativity-infrastructure/v1/workspaces/-1/web-distributed-forms-auth-servers/{serverID}
[Public] IWebDistributedFormsAuthServerManager -
Relativity.Infrastructure.V1.WebDistributedFormsAuthServer.IWebDistributedFormsAuthServerManager.ReadAsync 3 params → 200
PUT
/relativity-infrastructure/v1/workspaces/-1/web-distributed-forms-auth-servers/{serverID}
[Public] IWebDistributedFormsAuthServerManager -
Relativity.Infrastructure.V1.WebDistributedFormsAuthServer.IWebDistributedFormsAuthServerManager.UpdateAsync 1 param body → 200
GET
/relativity-infrastructure/v1/workspaces/-1/web-background-processing-servers/{serverID}
[Public] IWebBackgroundProcessingServerManager -
Relativity.Infrastructure.V1.WebBackgroundProcessingServer.IWebBackgroundProcessingServerManager.ReadAsync 3 params → 200
PUT
/relativity-infrastructure/v1/workspaces/-1/web-background-processing-servers/{serverID}
[Public] IWebBackgroundProcessingServerManager -
Relativity.Infrastructure.V1.WebBackgroundProcessingServer.IWebBackgroundProcessingServerManager.UpdateAsync 1 param body → 200
POST
/relativity-infrastructure/v1/workspaces/-1/web-background-processing-servers/{serverID}/restart-windows-service
[Public] IWebBackgroundProcessingServerManager -
Relativity.Infrastructure.V1.WebBackgroundProcessingServer.IWebBackgroundProcessingServerManager.RestartWindowsServiceAsync 1 param → 200
GET
/relativity-infrastructure/v1/workspaces/-1/web-api-windows-auth-servers/{serverID}
[Public] IWebApiWindowsAuthServerManager -
Relativity.Infrastructure.V1.WebApiWindowsAuthServer.IWebApiWindowsAuthServerManager.ReadAsync 3 params → 200
PUT
/relativity-infrastructure/v1/workspaces/-1/web-api-windows-auth-servers/{serverID}
[Public] IWebApiWindowsAuthServerManager -
Relativity.Infrastructure.V1.WebApiWindowsAuthServer.IWebApiWindowsAuthServerManager.UpdateAsync 1 param body → 200
GET
/relativity-infrastructure/v1/workspaces/-1/web-api-servers/{serverID}
[Public] IWebApiServerManager -
Relativity.Infrastructure.V1.WebApiServer.IWebApiServerManager.ReadAsync 3 params → 200
PUT
/relativity-infrastructure/v1/workspaces/-1/web-api-servers/{serverID}
[Public] IWebApiServerManager -
Relativity.Infrastructure.V1.WebApiServer.IWebApiServerManager.UpdateAsync 1 param body → 200
GET
/relativity-infrastructure/v1/workspaces/-1/web-api-forms-auth-servers/{serverID}
[Public] IWebApiFormsAuthServerManager -
Relativity.Infrastructure.V1.WebApiFormsAuthServerManager.IWebApiFormsAuthServerManager.ReadAsync 3 params → 200
PUT
/relativity-infrastructure/v1/workspaces/-1/web-api-forms-auth-servers/{serverID}
[Public] IWebApiFormsAuthServerManager -
Relativity.Infrastructure.V1.WebApiFormsAuthServerManager.IWebApiFormsAuthServerManager.UpdateAsync 1 param body → 200
GET
/relativity-infrastructure/v1/workspaces/-1/sql-primary-servers/{serverID}
[Public] ISqlPrimaryServerManager -
Relativity.Infrastructure.V1.SQLPrimary.ISqlPrimaryServerManager.ReadAsync 3 params → 200
PUT
/relativity-infrastructure/v1/workspaces/-1/sql-primary-servers/{serverID}
[Public] ISqlPrimaryServerManager -
Relativity.Infrastructure.V1.SQLPrimary.ISqlPrimaryServerManager.UpdateAsync 1 param body → 200
GET
/relativity-infrastructure/v1/workspaces/-1/sql-primary-servers/{serverID}/is-last-visible-server
[Public] ISqlPrimaryServerManager -
Relativity.Infrastructure.V1.SQLPrimary.ISqlPrimaryServerManager.IsLastVisibleServerAsync 1 param → 200
GET
/relativity-infrastructure/v1/workspaces/-1/sql-distributed-servers/{serverID}
[Public] ISqlDistributedServerManager -
Relativity.Infrastructure.V1.SQLDistributed.ISqlDistributedServerManager.ReadAsync 3 params → 200
PUT
/relativity-infrastructure/v1/workspaces/-1/sql-distributed-servers/{serverID}
[Public] ISqlDistributedServerManager -
Relativity.Infrastructure.V1.SQLDistributed.ISqlDistributedServerManager.UpdateAsync 1 param body → 200
GET
/relativity-infrastructure/v1/workspaces/-1/sql-distributed-servers/{serverID}/is-last-visible-server
[Public] ISqlDistributedServerManager -
Relativity.Infrastructure.V1.SQLDistributed.ISqlDistributedServerManager.IsLastVisibleServerAsync 1 param → 200
GET
/relativity-infrastructure/v1/workspaces/-1/services-servers/{serverID}
[Public] IServicesServerManager -
Relativity.Infrastructure.V1.ServicesServer.IServicesServerManager.ReadAsync 3 params → 200
PUT
/relativity-infrastructure/v1/workspaces/-1/services-servers/{serverID}
[Public] IServicesServerManager -
Relativity.Infrastructure.V1.ServicesServer.IServicesServerManager.UpdateAsync 1 param body → 200
GET
/relativity-infrastructure/v1/workspaces/-1/resource-servers/{serverID}
[Public] IResourceServerManager -
Relativity.Infrastructure.V1.ResourceServer.IResourceServerManager.ReadAsync 1 param → 200
GET
/relativity-infrastructure/v1/workspaces/-1/resource-servers/types
[Public] IResourceServerManager -
Relativity.Infrastructure.V1.ResourceServer.IResourceServerManager.ReadServerTypesAsync → 200
GET
/relativity-infrastructure/v1/workspaces/-1/resource-servers/eligible-statuses
[Public] IResourceServerManager -
Relativity.Infrastructure.V1.ResourceServer.IResourceServerManager.GetEligibleStatusesAsync → 200
POST
/relativity-infrastructure/v1/workspaces/-1/resource-pools
[Public] IResourcePoolManager -
Relativity.Infrastructure.V1.ResourcePool.IResourcePoolManager.CreateAsync body → 200
GET
/relativity-infrastructure/v1/workspaces/-1/resource-pools/{resourcePoolID}
[Public] IResourcePoolManager -
Relativity.Infrastructure.V1.ResourcePool.IResourcePoolManager.ReadAsync 3 params → 200
PUT
/relativity-infrastructure/v1/workspaces/-1/resource-pools/{resourcePoolID}
[Public] IResourcePoolManager -
Relativity.Infrastructure.V1.ResourcePool.IResourcePoolManager.UpdateAsync 1 param body → 200
DELETE
/relativity-infrastructure/v1/workspaces/-1/resource-pools/{resourcePoolID}
[Public] IResourcePoolManager -
Relativity.Infrastructure.V1.ResourcePool.IResourcePoolManager.DeleteAsync 1 param → 200
POST
/relativity-infrastructure/v1/workspaces/-1/resource-pools/{resourcePoolID}/query-associated
[Public] IResourcePoolManager -
Relativity.Infrastructure.V1.ResourcePool.IResourcePoolManager.QueryResourcesAsync 4 params body → 200
POST
/relativity-infrastructure/v1/workspaces/-1/resource-pools/{resourcePoolID}-to-add
[Public] IResourcePoolManager -
Relativity.Infrastructure.V1.ResourcePool.IResourcePoolManager.QueryEligibleToAddResourcesAsync 4 params body → 200
POST
/relativity-infrastructure/v1/workspaces/-1/resource-pools/query-eligible-clients
[Public] IResourcePoolManager -
Relativity.Infrastructure.V1.ResourcePool.IResourcePoolManager.QueryClientsAsync 2 params body → 200
POST
/relativity-infrastructure/v1/workspaces/-1/resource-pools/{resourcePoolID}/add
[Public] IResourcePoolManager -
Relativity.Infrastructure.V1.ResourcePool.IResourcePoolManager.AddResourcesAsync 2 params body → 200
POST
/relativity-infrastructure/v1/workspaces/-1/resource-pools/{resourcePoolID}/remove
[Public] IResourcePoolManager -
Relativity.Infrastructure.V1.ResourcePool.IResourcePoolManager.RemoveResourcesAsync 2 params body → 200
POST
/relativity-infrastructure/v1/workspaces/-1/resource-pools/mass-ops/add-servers
[Public] IResourcePoolManager -
Relativity.Infrastructure.V1.ResourcePool.IResourcePoolManager.MassAddResourceServersAsync body → 200
POST
/relativity-infrastructure/v1/workspaces/-1/resource-pools/mass-ops/remove-servers
[Public] IResourcePoolManager -
Relativity.Infrastructure.V1.ResourcePool.IResourcePoolManager.MassRemoveResourceServersAsync body → 200
POST
/relativity-infrastructure/v1/workspaces/-1/resource-pools/query-by-resource-server/{resourceServerID}
[Public] IResourcePoolManager -
Relativity.Infrastructure.V1.ResourcePool.IResourcePoolManager.QueryByResourceServerAsync 3 params body → 200
POST
/relativity-infrastructure/v1/workspaces/-1/resource-pools/query-eligible-by-resource-server/{resourceServerID}
[Public] IResourcePoolManager -
Relativity.Infrastructure.V1.ResourcePool.IResourcePoolManager.QueryEligibleByResourceServerAsync 3 params body → 200
GET
/relativity-infrastructure/v1/workspaces/-1/notifications
[Public] INotificationsManager -
Relativity.Infrastructure.V1.Notifications.INotificationsManager.ReadMotdAsync → 200
PUT
/relativity-infrastructure/v1/workspaces/-1/notifications
[Public] INotificationsManager -
Relativity.Infrastructure.V1.Notifications.INotificationsManager.UpdateMotdAsync body → 200
POST
/relativity-infrastructure/v1/workspaces/-1/notifications/dismiss/{userID}
[Public] INotificationsManager -
Relativity.Infrastructure.V1.Notifications.INotificationsManager.DismissMotdAsync 1 param → 200
GET
/relativity-infrastructure/v1/workspaces/-1/notifications/has-dismissed/{userID}
[Public] INotificationsManager -
Relativity.Infrastructure.V1.Notifications.INotificationsManager.HasDismissedMotdAsync 1 param → 200
GET
/relativity-infrastructure/v1/workspaces/-1/notifications/is-text-only
[Public] INotificationsManager -
Relativity.Infrastructure.V1.Notifications.INotificationsManager.IsTextOnlyMotdAsync → 200
POST
/relativity-infrastructure/v1/workspaces/-1/file-repository-servers
[Public] IFileRepositoryServerManager -
Relativity.Infrastructure.V1.FileRepositoryServer.IFileRepositoryServerManager.CreateAsync body → 200
GET
/relativity-infrastructure/v1/workspaces/-1/file-repository-servers/{serverID}
[Public] IFileRepositoryServerManager -
Relativity.Infrastructure.V1.FileRepositoryServer.IFileRepositoryServerManager.ReadAsync 3 params → 200
PUT
/relativity-infrastructure/v1/workspaces/-1/file-repository-servers/{serverID}
[Public] IFileRepositoryServerManager -
Relativity.Infrastructure.V1.FileRepositoryServer.IFileRepositoryServerManager.UpdateAsync 1 param body → 200
DELETE
/relativity-infrastructure/v1/workspaces/-1/file-repository-servers/{serverID}
[Public] IFileRepositoryServerManager -
Relativity.Infrastructure.V1.FileRepositoryServer.IFileRepositoryServerManager.DeleteAsync 1 param → 200
POST
/relativity-infrastructure/v1/workspaces/-1/file-repository-servers/query-eligible-file-access-credentials
[Public] IFileRepositoryServerManager -
Relativity.Infrastructure.V1.FileRepositoryServer.IFileRepositoryServerManager.QueryEligibleFileAccessCredentialsAsync 2 params body → 200
GET
/relativity-infrastructure/v1/workspaces/-1/file-repository-servers/metadata
[Public] IFileRepositoryServerManager -
Relativity.Infrastructure.V1.FileRepositoryServer.IFileRepositoryServerManager.GetMetadataAsync → 200
GET
/relativity-infrastructure/v1/workspaces/-1/file-repository-servers/{serverID}/is-last-visible-server
[Public] IFileRepositoryServerManager -
Relativity.Infrastructure.V1.FileRepositoryServer.IFileRepositoryServerManager.IsLastVisibleServerAsync 1 param → 200
POST
/relativity-infrastructure/v1/workspaces/-1/cache-location-servers
[Public] ICacheLocationServerManager -
Relativity.Infrastructure.V1.CacheLocationServer.ICacheLocationServerManager.CreateAsync body → 200
GET
/relativity-infrastructure/v1/workspaces/-1/cache-location-servers/{serverID}
[Public] ICacheLocationServerManager -
Relativity.Infrastructure.V1.CacheLocationServer.ICacheLocationServerManager.ReadAsync 3 params → 200
PUT
/relativity-infrastructure/v1/workspaces/-1/cache-location-servers/{serverID}
[Public] ICacheLocationServerManager -
Relativity.Infrastructure.V1.CacheLocationServer.ICacheLocationServerManager.UpdateAsync 1 param body → 200
DELETE
/relativity-infrastructure/v1/workspaces/-1/cache-location-servers/{serverID}
[Public] ICacheLocationServerManager -
Relativity.Infrastructure.V1.CacheLocationServer.ICacheLocationServerManager.DeleteAsync 1 param → 200
POST
/relativity-infrastructure/v1/workspaces/-1/cache-location-servers/query-eligible-file-access-credentials
[Public] ICacheLocationServerManager -
Relativity.Infrastructure.V1.CacheLocationServer.ICacheLocationServerManager.QueryEligibleFileAccessCredentialsAsync 2 params body → 200
GET
/relativity-infrastructure/v1/workspaces/-1/cache-location-servers/metadata
[Public] ICacheLocationServerManager -
Relativity.Infrastructure.V1.CacheLocationServer.ICacheLocationServerManager.GetMetadataAsync → 200
GET
/relativity-infrastructure/v1/workspaces/-1/cache-location-servers/{serverID}/is-last-visible-server
[Public] ICacheLocationServerManager -
Relativity.Infrastructure.V1.CacheLocationServer.ICacheLocationServerManager.IsLastVisibleServerAsync 1 param → 200
POST
/relativity-infrastructure/v1/workspaces/-1/analytics-servers
[Public] IAnalyticsServerManager -
Relativity.Infrastructure.V1.AnalyticsServer.IAnalyticsServerManager.CreateAsync body → 200
GET
/relativity-infrastructure/v1/workspaces/-1/analytics-servers/{serverID}
[Public] IAnalyticsServerManager -
Relativity.Infrastructure.V1.AnalyticsServer.IAnalyticsServerManager.ReadAsync 3 params → 200
PUT
/relativity-infrastructure/v1/workspaces/-1/analytics-servers/{serverID}
[Public] IAnalyticsServerManager -
Relativity.Infrastructure.V1.AnalyticsServer.IAnalyticsServerManager.UpdateAsync 1 param body → 200
DELETE
/relativity-infrastructure/v1/workspaces/-1/analytics-servers/{serverID}
[Public] IAnalyticsServerManager -
Relativity.Infrastructure.V1.AnalyticsServer.IAnalyticsServerManager.DeleteAsync 1 param → 200
GET
/relativity-infrastructure/v1/workspaces/-1/analytics-servers/default-field-values
[Public] IAnalyticsServerManager -
Relativity.Infrastructure.V1.AnalyticsServer.IAnalyticsServerManager.GetDefaultFieldValuesAsync → 200
GET
/relativity-infrastructure/v1/workspaces/-1/analytics-servers/eligible-analytics-operations
[Public] IAnalyticsServerManager -
Relativity.Infrastructure.V1.AnalyticsServer.IAnalyticsServerManager.GetEligibleAnalyticsOperationsAsync → 200
POST
/relativity-infrastructure/v1/workspaces/-1/analytics-servers/{serverID}/restart-windows-service
[Public] IAnalyticsServerManager -
Relativity.Infrastructure.V1.AnalyticsServer.IAnalyticsServerManager.RestartWindowsServiceAsync 1 param → 200
GET
/relativity-infrastructure/v1/workspaces/-1/analytics-servers/metadata
[Public] IAnalyticsServerManager -
Relativity.Infrastructure.V1.AnalyticsServer.IAnalyticsServerManager.GetMetadataAsync → 200
POST
/relativity-infrastructure/v1/workspace/{workspaceID}/agents
[Public] IAgentManager -
Relativity.Infrastructure.V1.Agent.IAgentManager.CreateAsync 1 param body → 200
GET
/relativity-infrastructure/v1/workspace/{workspaceID}/agents/{agentID}
[Public] IAgentManager -
Relativity.Infrastructure.V1.Agent.IAgentManager.ReadAsync 2 params → 200
PUT
/relativity-infrastructure/v1/workspace/{workspaceID}/agents/{agentID}
[Public] IAgentManager -
Relativity.Infrastructure.V1.Agent.IAgentManager.UpdateAsync 2 params body → 200
DELETE
/relativity-infrastructure/v1/workspace/{workspaceID}/agents/{agentID}
[Public] IAgentManager -
Relativity.Infrastructure.V1.Agent.IAgentManager.DeleteAsync 2 params → 200
GET
/relativity-infrastructure/v1/workspace/{workspaceID}/agents/{agentID}/{includeMetadata}/{includeActions}
[Public] IAgentManager -
Relativity.Infrastructure.V1.Agent.IAgentManager.ReadAsync 4 params → 200
POST
/relativity-infrastructure/v1/workspace/{workspaceID}/agents/validateinstancelimits
[Public] IAgentManager -
Relativity.Infrastructure.V1.Agent.IAgentManager.ValidateCreateInstanceLimitAsync 2 params body → 200
POST
/relativity-infrastructure/v1/workspace/{workspaceID}/agents/{agentID}/validateinstancelimits
[Public] IAgentManager -
Relativity.Infrastructure.V1.Agent.IAgentManager.ValidateUpdateInstanceLimitAsync 2 params body → 200
DELETE
/relativity-infrastructure/v1/workspace/{workspaceID}/agents/{agentID}/validateinstancelimits
[Public] IAgentManager -
Relativity.Infrastructure.V1.Agent.IAgentManager.ValidateDeleteInstanceLimitAsync 2 params → 200
GET
/relativity-infrastructure/v1/workspace/{workspaceID}/agentservers
[Public] IAgentManager -
Relativity.Infrastructure.V1.Agent.IAgentManager.GetAgentServersAsync 1 param → 200
GET
/relativity-infrastructure/v1/workspace/{workspaceID}/agenttypes/{agentTypeID}/availableagentservers
[Public] IAgentManager -
Relativity.Infrastructure.V1.Agent.IAgentManager.GetAvailableAgentServersAsync 2 params → 200
GET
/relativity-infrastructure/v1/workspace/{workspaceID}/agenttypes/{agentTypeGuid}/availableagentservers
[Public] IAgentManager -
Relativity.Infrastructure.V1.Agent.IAgentManager.GetAvailableAgentServersAsync 2 params → 200
GET
/relativity-infrastructure/v1/workspace/{workspaceID}/agenttypes
[Public] IAgentManager -
Relativity.Infrastructure.V1.Agent.IAgentManager.GetAgentTypesAsync 1 param → 200
GET
/relativity-infrastructure/v1/workspaces/-1/agent-servers/{serverID}
[Public] IAgentServerManager -
Relativity.Infrastructure.V1.AgentServerManager.IAgentServerManager.ReadAsync 3 params → 200
PUT
/relativity-infrastructure/v1/workspaces/-1/agent-servers/{serverID}
[Public] IAgentServerManager -
Relativity.Infrastructure.V1.AgentServerManager.IAgentServerManager.UpdateAsync 1 param body → 200
POST
/relativity-infrastructure/v1/workspaces/-1/agent-servers/{serverID}/restart-windows-service
[Public] IAgentServerManager -
Relativity.Infrastructure.V1.AgentServerManager.IAgentServerManager.RestartWindowsServiceAsync 1 param → 200

Schemas 44

The contract defines 44 schemas that model the data the API accepts and returns. The most detailed are QueryRequest (19 properties), WorkerManagerServerRequest (13 properties), AnalyticsServerRequest (10 properties), QueryResultSlim (10 properties). Each schema is shown below with its type and property counts.

Object
object
ObjectTypeRef
object
4 properties
AnalyticsServerDefaultValuesResponse
object
3 properties
AgentInstanceLimitResult
object
3 properties
ServerTypeResponse
object
3 properties
Meta
object
2 properties
FieldRef
object
4 properties
WebServerRequest
object
5 properties
WorkerServerRequest
object
3 properties
SearchProviderCondition
object
2 properties
MotdRequest
object
3 properties
WebBackgroundProcessingServerRequest
object
3 properties
ServicesServerRequest
object
3 properties
WorkerManagerServerDefaultValuesResponse
object
7 properties
SampleParameters
object
5 properties
WebWindowsAuthServerRequest
object
5 properties
AnalyticsServerRequest
object
10 properties
Sort
object
3 properties
ObjectType
object
4 properties
Field
object
6 properties
FileRepositoryServerRequest
object
6 properties
WebApiServerRequest
object
3 properties
RelativityObjectSlim
object
2 properties
MotdResponse
object
3 properties
WebApiFormsAuthServerRequest
object
3 properties
ResourcePoolRequest
object
5 properties
CacheLocationServerRequest
object
6 properties
WebDistributedWindowsAuthServerRequest
object
3 properties
WebDistributedFormsAuthServerRequest
object
3 properties
AgentRequest
object
7 properties
QueryRequest
object
19 properties
WebApiWindowsAuthServerRequest
object
3 properties
Securable`1
object
2 properties
ObjectIdentifier
object
2 properties
SampleDetails
object
3 properties
SqlDistributedServerRequest
object
7 properties
DisplayableObjectIdentifier
object
3 properties
SqlPrimaryServerRequest
object
7 properties
SearchIndexRef
object
2 properties
WorkerManagerServerRequest
object
13 properties
AgentServerRequest
object
4 properties
WebFormsAuthServerRequest
object
5 properties
QueryResultSlim
object
10 properties
WebDistributedServerRequest
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

relativity-relativity-infrastructure-module-v1-api-openapi.yml Raw ↑

Other APIs Relativity publishes across the network.

Relativity AnnotationService API
AE Profile APIs.io
Relativity ArchiveJobs API
AE Profile APIs.io
Relativity ARM Module v1 API
AE Profile APIs.io
Relativity ARM Module v3 API
AE Profile APIs.io
Relativity BillableSummaryReports API
AE Profile APIs.io
Relativity BillingConfiguration API
AE Profile APIs.io
Relativity BillingInsights API
AE Profile APIs.io
Relativity Client Side Libraries Module API
AE Profile APIs.io
Relativity ColdStorage API
AE Profile APIs.io
Relativity CollectAPI API
AE Profile APIs.io
Relativity Conceptual Analytics v1 API
AE Profile APIs.io
Relativity Directory API
AE Profile APIs.io
#Relativity Infrastructure Module v1
← Back to R APIs
API Details
ID
relativity:relativity-relativity-infrastructure-module-v1-api
Base URL
https://{host}/Relativity.REST/api/relativity-object-model/v1
Docs
https://platform.relativity.com/RelativityOne/Content/REST_API/REST_API.htm
Provider
Relativity
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network