Relativity

Relativity ARM Module v3 API

The ARM Module v3 API from Relativity — 7 operation(s) for arm module v3.

GitHub OpenAPI

Operations 11

POST /relativity-arm/v3/restore-jobs Relativity ARM services interfaces V3 restore IArm restore job manager create… #
GET /relativity-arm/v3/restore-jobs/{jobID} Relativity ARM services interfaces V3 restore IArm restore job manager read… #
PUT /relativity-arm/v3/restore-jobs/{jobID} Relativity ARM services interfaces V3 restore IArm restore job manager update… #
DELETE /relativity-arm/v3/restore-jobs/{jobID} Relativity ARM services interfaces V3 restore IArm restore job manager delete… #
GET /relativity-arm/v3/jobs/{jobID}/status Relativity ARM services interfaces V3 job information IArm job information… #
POST /relativity-arm/v3/jobs/{jobID}/cancel Relativity ARM services interfaces V3 job action IArm job action manager cancel… #
POST /relativity-arm/v3/jobs/{jobID}/run Relativity ARM services interfaces V3 job action IArm job action manager run… #
POST /relativity-arm/v3/archive-jobs Relativity ARM services interfaces V3 archive IArm archive job manager create… #
GET /relativity-arm/v3/archive-jobs/{jobID} Relativity ARM services interfaces V3 archive IArm archive job manager read… #
PUT /relativity-arm/v3/archive-jobs/{jobID} Relativity ARM services interfaces V3 archive IArm archive job manager update… #
DELETE /relativity-arm/v3/archive-jobs/{jobID} Relativity ARM services interfaces V3 archive IArm archive job manager delete… #

Documentation

📖
Documentation
https://platform.relativity.com/RelativityOne/Content/REST_API/REST_API.htm
📖
RateLimits
https://artifacts.apis.io/relativity/rate-limits/relativity-rate-limits.yml
📖
Documentation
https://platform.relativity.com/RelativityOne/Content/Relativity_Platform/Platform_APIs.htm
📖
GettingStarted
https://platform.relativity.com/RelativityOne/Content/Getting_Started/Basic_REST_API_concepts.htm
📖
Documentation
https://help.relativity.com/RelativityOne/Content/Management_Console/Cost_Explorer.htm

Specifications

⚙
OpenAPI
https://artifacts.apis.io/relativity/openapi/relativity-arm-module-v3-api-openapi.yml

Other Resources

🔗
Plans
https://artifacts.apis.io/relativity/plans/relativity-plans-pricing.yml
🔗
FinOps
https://artifacts.apis.io/relativity/finops/relativity-finops.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/relativity:relativity-arm-module-v3-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

relativity-arm-module-v3-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Relativity.ARM.Services.Interfaces ARM Module v3 API
  description: Relativity.ARM.Services.Interfaces
  version: V1,V3
servers:
- url: /Relativity.REST/api
  description: The URL prefix for all Kepler services
tags:
- name: ARM Module v3
paths:
  /relativity-arm/v3/restore-jobs:
    post:
      tags:
      - ARM Module v3
      summary: Relativity ARM services interfaces V3 restore IArm restore job manager create…
      description: '[Public] ARM Restore Manager V3'
      operationId: Relativity.ARM.Services.Interfaces.V3.Restore.IArmRestoreJobManager.CreateAsync
      parameters:
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IArmRestoreJobManager_V3_CreateAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateRestoreJobResponse_V3'
      x-summary-source: derived
  /relativity-arm/v3/restore-jobs/{jobID}:
    get:
      tags:
      - ARM Module v3
      summary: Relativity ARM services interfaces V3 restore IArm restore job manager read…
      description: '[Public] ARM Restore Manager V3'
      operationId: Relativity.ARM.Services.Interfaces.V3.Restore.IArmRestoreJobManager.ReadAsync
      parameters:
      - $ref: '#/components/parameters/jobID'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestoreJobResponse_V3'
      x-summary-source: derived
    put:
      tags:
      - ARM Module v3
      summary: Relativity ARM services interfaces V3 restore IArm restore job manager update…
      description: '[Public] ARM Restore Manager V3'
      operationId: Relativity.ARM.Services.Interfaces.V3.Restore.IArmRestoreJobManager.UpdateAsync
      parameters:
      - $ref: '#/components/parameters/jobID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IArmRestoreJobManager_V3_UpdateAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateRestoreJobResponse_V3'
      x-summary-source: derived
    delete:
      tags:
      - ARM Module v3
      summary: Relativity ARM services interfaces V3 restore IArm restore job manager delete…
      description: '[Public] ARM Restore Manager V3'
      operationId: Relativity.ARM.Services.Interfaces.V3.Restore.IArmRestoreJobManager.DeleteAsync
      parameters:
      - $ref: '#/components/parameters/jobID'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
      x-summary-source: derived
  /relativity-arm/v3/jobs/{jobID}/status:
    get:
      tags:
      - ARM Module v3
      summary: Relativity ARM services interfaces V3 job information IArm job information…
      description: '[Public] ARM Job Information Manager V3'
      operationId: Relativity.ARM.Services.Interfaces.V3.JobInformation.IArmJobInformationManager.GetJobStatusAsync
      parameters:
      - $ref: '#/components/parameters/jobID'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobProgressResponse_V3'
      x-summary-source: derived
  /relativity-arm/v3/jobs/{jobID}/cancel:
    post:
      tags:
      - ARM Module v3
      summary: Relativity ARM services interfaces V3 job action IArm job action manager cancel…
      description: '[Public] ARM Job Actions Manager'
      operationId: Relativity.ARM.Services.Interfaces.V3.JobAction.IArmJobActionManager.CancelAsync
      parameters:
      - $ref: '#/components/parameters/jobID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IArmJobActionManager_V3_CancelAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelJobResponse_V3'
      x-summary-source: derived
  /relativity-arm/v3/jobs/{jobID}/run:
    post:
      tags:
      - ARM Module v3
      summary: Relativity ARM services interfaces V3 job action IArm job action manager run…
      description: '[Public] ARM Job Actions Manager'
      operationId: Relativity.ARM.Services.Interfaces.V3.JobAction.IArmJobActionManager.RunAsync
      parameters:
      - $ref: '#/components/parameters/jobID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IArmJobActionManager_V3_RunAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RunJobResponse_V3'
      x-summary-source: derived
  /relativity-arm/v3/archive-jobs:
    post:
      tags:
      - ARM Module v3
      summary: Relativity ARM services interfaces V3 archive IArm archive job manager create…
      description: '[Public] ARM Archive Manager V3'
      operationId: Relativity.ARM.Services.Interfaces.V3.Archive.IArmArchiveJobManager.CreateAsync
      parameters:
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IArmArchiveJobManager_V3_CreateAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateArchiveJobResponse_V3'
      x-summary-source: derived
  /relativity-arm/v3/archive-jobs/{jobID}:
    get:
      tags:
      - ARM Module v3
      summary: Relativity ARM services interfaces V3 archive IArm archive job manager read…
      description: '[Public] ARM Archive Manager V3'
      operationId: Relativity.ARM.Services.Interfaces.V3.Archive.IArmArchiveJobManager.ReadAsync
      parameters:
      - $ref: '#/components/parameters/jobID'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ArchiveJobResponse_V3'
      x-summary-source: derived
    put:
      tags:
      - ARM Module v3
      summary: Relativity ARM services interfaces V3 archive IArm archive job manager update…
      description: '[Public] ARM Archive Manager V3'
      operationId: Relativity.ARM.Services.Interfaces.V3.Archive.IArmArchiveJobManager.UpdateAsync
      parameters:
      - $ref: '#/components/parameters/jobID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IArmArchiveJobManager_V3_UpdateAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateArchiveJobResponse_V3'
      x-summary-source: derived
    delete:
      tags:
      - ARM Module v3
      summary: Relativity ARM services interfaces V3 archive IArm archive job manager delete…
      description: '[Public] ARM Archive Manager V3'
      operationId: Relativity.ARM.Services.Interfaces.V3.Archive.IArmArchiveJobManager.DeleteAsync
      parameters:
      - $ref: '#/components/parameters/jobID'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
      x-summary-source: derived
components:
  schemas:
    RestoreJobResponse_V3:
      title: RestoreJobResponse_V3
      type: object
      properties:
        JobID:
          type: string
        JobName:
          type: string
        ArchivePath:
          type: string
        ScheduledStartTime:
          type:
          - string
          - 'null'
          format: date-time
        SourceWorkspace:
          type: string
        DestinationWorkspaceID:
          type:
          - integer
          - 'null'
        ExistingTargetDatabase:
          type: string
        JobDetails:
          $ref: '#/components/schemas/JobDetails_V3'
        DestinationOptions:
          $ref: '#/components/schemas/RestoreDestinationOptions_V3'
        MigratorOptions:
          $ref: '#/components/schemas/MigratorOptions_V3'
        NotificationOptions:
          $ref: '#/components/schemas/NotificationOptions_V3'
        UiJobActionsLocked:
          type: boolean
    IArmJobActionManager_V3_RunAsync_RequestBody:
      title: IArmJobActionManager_V3_RunAsync_RequestBody
      type: object
      properties:
        request:
          $ref: '#/components/schemas/RunJobRequest_V3'
    IArmRestoreJobManager_V3_CreateAsync_RequestBody:
      title: IArmRestoreJobManager_V3_CreateAsync_RequestBody
      type: object
      properties:
        request:
          $ref: '#/components/schemas/RestoreJobRequest_V3'
    CreateRestoreJobResponse_V3:
      title: CreateRestoreJobResponse_V3
      type: object
      properties:
        JobID:
          type: string
    RestoreJobRequest_V3:
      title: RestoreJobRequest_V3
      type: object
      properties:
        ArchivePath:
          type: string
        JobPriority:
          enum:
          - Low
          - Medium
          - High
          type: string
        ScheduledStartTime:
          type:
          - string
          - 'null'
          format: date-time
        ExistingTargetDatabase:
          type: string
        DestinationOptions:
          $ref: '#/components/schemas/RestoreDestinationOptions_V3'
        MigratorOptions:
          $ref: '#/components/schemas/MigratorOptions_V3'
        NotificationOptions:
          $ref: '#/components/schemas/NotificationOptions_V3'
        UiJobActionsLocked:
          type: boolean
    RestoreDestinationOptions_V3:
      title: RestoreDestinationOptions_V3
      type: object
      properties:
        MatterID:
          type: integer
    ArchiveJobResponse_V3:
      title: ArchiveJobResponse_V3
      type: object
      properties:
        JobID:
          type: string
        JobName:
          type: string
        ArchivePath:
          type: string
        WorkspaceID:
          type: integer
        ScheduledStartTime:
          type:
          - string
          - 'null'
          format: date-time
        JobDetails:
          $ref: '#/components/schemas/JobDetails_V3'
        ExcludedMigrators:
          type: array
          items:
            type: string
        MigratorOptions:
          $ref: '#/components/schemas/MigratorOptions_V3'
        NotificationOptions:
          $ref: '#/components/schemas/NotificationOptions_V3'
        UiJobActionsLocked:
          type: boolean
    NotificationOptions_V3:
      title: NotificationOptions_V3
      type: object
      properties:
        NotifyJobCreator:
          type: boolean
        NotifyJobExecutor:
          type: boolean
    IArmJobActionManager_V3_CancelAsync_RequestBody:
      title: IArmJobActionManager_V3_CancelAsync_RequestBody
      type: object
      properties:
        request:
          $ref: '#/components/schemas/CancelJobRequest_V3'
    MigratorOptions_V3:
      title: MigratorOptions_V3
      type: object
      additionalProperties:
        type: object
      example: '"Common": {"FileFirstFlow": {"IsFilesFirstFlow": true, "AdditionalFilesDirectoryPath": "path"}},"UserGroup": {"GroupMapping": {"AutoMapGroups": false,"GroupMappings": [{"ArchiveGroupID": 1000000,"InstanceGroupID": 1000000}]},"UserMapping": {"AutoMapUsers": true,"UserMappings": [{"ArchiveUserID": 7000000,"InstanceUserID": 1000000}]}'
    JobDetails_V3:
      title: JobDetails_V3
      type: object
      properties:
        Priority:
          enum:
          - Low
          - Medium
          - High
          type: string
        ActionsHistory:
          type: array
          items:
            $ref: '#/components/schemas/JobActions_V3'
    IArmArchiveJobManager_V3_UpdateAsync_RequestBody:
      title: IArmArchiveJobManager_V3_UpdateAsync_RequestBody
      type: object
      properties:
        request:
          $ref: '#/components/schemas/ArchiveJobRequest_V3'
    JobProgressResponse_V3:
      title: JobProgressResponse_V3
      type: object
      properties:
        JobId:
          type: string
        JobState:
          enum:
          - NotStarted
          - InProgress
          - Paused
          - Cancelling
          - Cancelled
          - Errored
          - Completed
          type: string
    IArmArchiveJobManager_V3_CreateAsync_RequestBody:
      title: IArmArchiveJobManager_V3_CreateAsync_RequestBody
      type: object
      properties:
        request:
          $ref: '#/components/schemas/ArchiveJobRequest_V3'
    RunJobResponse_V3:
      title: RunJobResponse_V3
      type: object
    UpdateRestoreJobResponse_V3:
      title: UpdateRestoreJobResponse_V3
      type: object
    ArchiveJobRequest_V3:
      title: ArchiveJobRequest_V3
      type: object
      properties:
        WorkspaceID:
          type: integer
        ArchiveDirectory:
          type: string
        ScheduledStartTime:
          type:
          - string
          - 'null'
          format: date-time
        JobPriority:
          enum:
          - Low
          - Medium
          - High
          type: string
        ExcludedMigrators:
          type: array
          items:
            type: string
          example: '["ADS", "Processing", "NonRepositoryFiles", "dtIndex", "analytics-core", "StructuredAnalytics", "Audit", "Database"]'
        MigratorOptions:
          $ref: '#/components/schemas/MigratorOptions_V3'
        NotificationOptions:
          $ref: '#/components/schemas/NotificationOptions_V3'
        UiJobActionsLocked:
          type: boolean
    CancelJobResponse_V3:
      title: CancelJobResponse_V3
      type: object
    CancelJobRequest_V3:
      title: CancelJobRequest_V3
      type: object
    RunJobRequest_V3:
      title: RunJobRequest_V3
      type: object
    IArmRestoreJobManager_V3_UpdateAsync_RequestBody:
      title: IArmRestoreJobManager_V3_UpdateAsync_RequestBody
      type: object
      properties:
        request:
          $ref: '#/components/schemas/RestoreJobRequest_V3'
    JobActions_V3:
      title: JobActions_V3
      type: object
      properties:
        Date:
          type: string
          format: date-time
        Type:
          type: string
        UserName:
          type: string
    UpdateArchiveJobResponse_V3:
      title: UpdateArchiveJobResponse_V3
      type: object
    CreateArchiveJobResponse_V3:
      title: CreateArchiveJobResponse_V3
      type: object
      properties:
        JobID:
          type: string
  parameters:
    x-csrf-header:
      name: x-csrf-header
      in: header
      description: ''
      required: true
      schema:
        type: string
        default: '-'
    jobID:
      name: jobID
      in: path
      description: ''
      required: true
      schema:
        type: string