Collaborative Drug Discovery Status API

openapi: 3.2.0
info:
  contact:
    url: https://support.collaborativedrug.com/hc/en-us/requests/new
  description: 'Collaborative Drug Discovery provides an API (Application Programming

    Interface) that can be used for secure programmatic access to your vault

    data.'
  license:
    name: Proprietary
    url: https://support.collaborativedrug.com/hc/en-us/requests/new
  title: CDD Status API
  version: 1.0.0
servers:
- url: https://app.collaborativedrug.com/api/v1
security:
- ApiKeyAuth: []
tags:
- description: Vault operational status
  name: Status
paths:
  /vaults/{vault_id}/status:
    get:
      description: 'Retrieve the operational status of the vault: currently running imports (slurps), recalculating protocols, and overall availability of the background processing services. Requires vault administrator access.'
      operationId: getVaultStatus
      parameters:
      - in: path
        name: vault_id
        required: true
        schema:
          $ref: '#/components/schemas/vault_id'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/vault_status'
          description: The current vault status
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_apikey'
          description: Missing or invalid API key
      summary: Get vault status
      tags:
      - Status
components:
  schemas:
    error_apikey:
      description: Whenever the given API key doesn't allow access to the given vault or the vault doesn't exist
      properties:
        code:
          default: 401
          type: integer
        error:
          default: key not authorized for access to this vault
          type: string
      type: object
    vault_id:
      description: Numeric identifier of the vault
      type: integer
    vault_status:
      description: 'Operational status of the vault: running imports (slurps), recalculating protocols, and overall application availability. Requires vault administrator access.'
      properties:
        any_executing_batch_move_job:
          description: Whether any batch move job is currently executing.
          type: boolean
        any_locking_chemistry_slurps:
          description: Whether any running slurp is currently holding the chemistry lock (which blocks chemistry recalculation).
          type: boolean
        application_status:
          description: Overall availability of the background processing services.
          properties:
            calculators_available:
              description: Whether calculation processors are available.
              type: boolean
            downtime_expected:
              description: Present only when scheduled downtime has been announced.
              properties:
                end:
                  description: When the downtime is expected to end.
                  format: date-time
                  type: string
                reason:
                  description: Human-readable explanation of the downtime.
                  type: string
                start:
                  description: When the downtime is expected to start.
                  format: date-time
                  type: string
              type: object
            processors_available:
              description: Whether import/data processors are available.
              type: boolean
          required:
          - processors_available
          - calculators_available
          type: object
        max_executing_account_slurps:
          description: Maximum number of slurps the account may run concurrently.
          type: integer
        num_executing_account_slurps:
          description: Number of slurps currently executing across the account.
          type: integer
        recalculating_protocols:
          description: Protocols whose data is currently being recalculated.
          items:
            properties:
              id:
                type: integer
              name:
                type: string
              projects:
                items:
                  properties:
                    id:
                      type: integer
                    name:
                      type: string
                  type: object
                type: array
            type: object
          type: array
        slurps:
          description: Slurps (imports) that are currently active in the vault.
          items:
            properties:
              chemistry_locking:
                description: Whether this slurp is holding the chemistry lock.
                type: boolean
              id:
                type: integer
              modified_at:
                format: date-time
                type: string
              owner:
                properties:
                  email:
                    type: string
                  first_name:
                    type: string
                  id:
                    type: integer
                  last_name:
                    type: string
                type: object
              project:
                properties:
                  id:
                    type: integer
                  name:
                    type: string
                type: object
              state:
                description: Current state of the slurp. Only active slurps are listed, so the state is one of the active states below (queued slurps appear here once they exceed the account's concurrent-processing limit).
                enum:
                - queued_for_processing
                - processing
                - processed
                - queued_for_committing
                - committing
                type: string
            type: object
          type: array
      required:
      - max_executing_account_slurps
      - num_executing_account_slurps
      - any_locking_chemistry_slurps
      - any_executing_batch_move_job
      - slurps
      - recalculating_protocols
      - application_status
      type: object
  securitySchemes:
    ApiKeyAuth:
      in: header
      name: X-CDD-Token
      type: apiKey