Relativity

Relativity ColdStorage API

The ColdStorage API from Relativity — 1 operation(s) for coldstorage.

Documentation GitHub OpenAPI

Operations 1

GET /v1/workspace/{workspaceId}/cold-storage/status Gets the cold storage status of a workspace

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-coldstorage-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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

openapi: 3.2.0
info:
  title: Analytics.Conceptual.Service.Interfaces.Public.V1 AnnotationService Cold Storage API
  description: Analytics.Conceptual.Service.Interfaces.Public
  version: V1
servers:
- url: /Relativity.REST/api
  description: The URL prefix for all Kepler services
tags:
- name: ColdStorage
paths:
  /v1/workspace/{workspaceId}/cold-storage/status:
    get:
      tags:
      - ColdStorage
      summary: Gets the cold storage status of a workspace
      description: 'Returns one of:

        Out – Workspace is not in cold storage.

        In – Workspace is in cold storage.

        MovingOut – Retrieval has been requested; the workspace will be returned to Active by the retrieval agent after the minimum request age has elapsed.

        For MovingOut, ActivationJobSubmittedBy and ActivationJobSubmittedOnUtc identify the user who requested retrieval (secured when the caller cannot view the user).'
      parameters:
      - name: workspaceId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/WorkspaceColdStorageStatusResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspaceColdStorageStatusResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/WorkspaceColdStorageStatusResponse'
        '401':
          description: Unauthorized
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: Forbidden
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '500':
          description: Internal Server Error
components:
  schemas:
    ObjectIdentifier:
      type: object
      properties:
        ArtifactID:
          type:
          - integer
          - 'null'
          format: int32
        Guids:
          type:
          - array
          - 'null'
          items:
            type: string
            format: uuid
      additionalProperties: false
    ObjectIdentifierSecurable:
      type: object
      properties:
        Value:
          $ref: '#/components/schemas/ObjectIdentifier'
        Secured:
          type: boolean
      additionalProperties: false
    ProblemDetails:
      type: object
      properties:
        type:
          type:
          - string
          - 'null'
        title:
          type:
          - string
          - 'null'
        status:
          type:
          - integer
          - 'null'
          format: int32
        detail:
          type:
          - string
          - 'null'
        instance:
          type:
          - string
          - 'null'
      additionalProperties: {}
    WorkspaceColdStorageStatusResponse:
      type: object
      properties:
        WorkspaceID:
          type: integer
          format: int32
        Status:
          enum:
          - Out
          - In
          - MovingOut
          - MovingIn
          type: string
        ActivationJobSubmittedBy:
          $ref: '#/components/schemas/ObjectIdentifierSecurable'
        ActivationJobSubmittedOnUtc:
          type:
          - string
          - 'null'
          format: date-time
        AddedToColdStorageOnUtc:
          type:
          - string
          - 'null'
          format: date-time
      additionalProperties: false