University of Chicago Gen3 indexd — system API

openapi: 3.2.0
info:
  title: University Of Chicago System API
  contact:
    email: cdis@uchicago.edu
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  termsOfService: http://cdis.uchicago.edu/terms/
  version: '1.0'
  description: 'Operations tagged system across 4 of this provider''s published API definitions: university-of-chicago-fence.yaml, university-of-chicago-indexd.yaml, university-of-chicago-peregrine.yaml, university-of-chicago-sheepdog.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://gen3.datacommons.io/
  description: University of Chicago Center for Translational Data Science (CTDS) reference Gen3 data commons. Gen3 is deployable software authored by CTDS (github.com/uc-cdis), so the upstream specification ships a placeholder host; this is the base URL of the deployment CTDS itself operates. The datacommons.io domain is registered to CDIS, University of Chicago.
  x-operator: institution
  x-verified: '2026-08-19'
  x-verified-evidence: https://gen3.datacommons.io/.well-known/openid-configuration
tags:
- name: System
  description: System endpoints
paths:
  /_status:
    get:
      tags:
      - System
      summary: Returns if Fence is healthy or not
      description: Health check endpoint
      produces:
      - application/text
      responses:
        '200':
          description: Healthy
        default:
          description: Unhealthy
      operationId: getStatus
      x-operation-id-source: derived
    servers:
    - url: https://gen3.datacommons.io/
      description: University of Chicago Center for Translational Data Science (CTDS) reference Gen3 data commons. Gen3 is deployable software authored by CTDS (github.com/uc-cdis), so the upstream specification ships a placeholder host; this is the base URL of the deployment CTDS itself operates. The datacommons.io domain is registered to CDIS, University of Chicago.
      x-operator: institution
      x-verified: '2026-08-19'
      x-verified-evidence: https://gen3.datacommons.io/.well-known/openid-configuration
  /_version:
    get:
      tags:
      - System
      summary: Returns the version of Fence
      produces:
      - application/json
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/SystemVersionOutputRef'
      operationId: getVersion
      x-operation-id-source: derived
    servers:
    - url: https://gen3.datacommons.io/
      description: University of Chicago Center for Translational Data Science (CTDS) reference Gen3 data commons. Gen3 is deployable software authored by CTDS (github.com/uc-cdis), so the upstream specification ships a placeholder host; this is the base URL of the deployment CTDS itself operates. The datacommons.io domain is registered to CDIS, University of Chicago.
      x-operator: institution
      x-verified: '2026-08-19'
      x-verified-evidence: https://gen3.datacommons.io/.well-known/openid-configuration
  /metrics:
    get:
      tags:
      - System
      summary: Get Prometheus metrics
      description: Returns Prometheus metrics if the `ENABLE_PROMETHEUS_METRICS` setting is `True`. By default, this endpoint is public. Authorization controls can be setup externally; in cloud-automation setups, access to this endpoint is blocked at the revproxy level.
      responses:
        '200':
          description: successful operation
      operationId: getMetrics
      x-operation-id-source: derived
    servers:
    - url: https://gen3.datacommons.io/
      description: University of Chicago Center for Translational Data Science (CTDS) reference Gen3 data commons. Gen3 is deployable software authored by CTDS (github.com/uc-cdis), so the upstream specification ships a placeholder host; this is the base URL of the deployment CTDS itself operates. The datacommons.io domain is registered to CDIS, University of Chicago.
      x-operator: institution
      x-verified: '2026-08-19'
      x-verified-evidence: https://gen3.datacommons.io/.well-known/openid-configuration
  /_dist:
    get:
      tags:
      - System
      summary: Returns the IndexD dist configuration
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    name:
                      type: string
                      description: Commons name
                    host:
                      type: string
                      description: Resolver URL
                    hints:
                      type: array
                      items:
                        type: string
                        description: Regex for prefix matching
                    type:
                      type: string
                      description: Type of resolver (one of [indexd, doi, dos, hs])
      operationId: getDist
      x-operation-id-source: derived
    servers:
    - url: https://gen3.datacommons.io/
      description: University of Chicago Center for Translational Data Science (CTDS) reference Gen3 data commons. Gen3 is deployable software authored by CTDS (github.com/uc-cdis), so the upstream specification ships a placeholder host; this is the base URL of the deployment CTDS itself operates. The datacommons.io domain is registered to CDIS, University of Chicago.
      x-operator: institution
      x-verified: '2026-08-19'
      x-verified-evidence: https://gen3.datacommons.io/.well-known/openid-configuration
  /_stats:
    get:
      tags:
      - System
      summary: Returns basic information about the records in IndexD
      parameters:
      - in: query
        name: month
        description: Month for which data is to be returned. (Either both month and year or neither must be provided)
        required: false
        schema:
          type: integer
      - in: query
        name: year
        description: year for which data is to be returned. (Either both month and year or neither must be provided)
        required: false
        schema:
          type: integer
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SystemStatsOutputRef'
      operationId: getStats
      x-operation-id-source: derived
    servers:
    - url: https://gen3.datacommons.io/
      description: University of Chicago Center for Translational Data Science (CTDS) reference Gen3 data commons. Gen3 is deployable software authored by CTDS (github.com/uc-cdis), so the upstream specification ships a placeholder host; this is the base URL of the deployment CTDS itself operates. The datacommons.io domain is registered to CDIS, University of Chicago.
      x-operator: institution
      x-verified: '2026-08-19'
      x-verified-evidence: https://gen3.datacommons.io/.well-known/openid-configuration
components:
  schemas:
    SystemStatsOutputRef:
      type: object
      properties:
        fileCount:
          type: integer
          description: the number of records stored in IndexD
        totalFileSize:
          type: integer
          description: the accumulated size of the object files recorded in IndexD
    SystemVersionOutputRef:
      type: object
      properties:
        commit:
          type: string
          description: the current git commit hash for this version
        version:
          type: string
          description: the current git tag version
    VersionOutputRef:
      type: object
      properties:
        commit:
          type: string
          description: the current git commit hash for this version
        version:
          type: string
          description: the current git tag version
        dictionary:
          type: object
          description: the version information for the data dictionary
          properties:
            commit:
              type: string
              description: the current git commit hash for the dictionary
            version:
              type: string
              description: the current git tag version for the dictionary
  securitySchemes:
    OAuth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: /oauth/authorize
          tokenUrl: /oauth/token
          scopes:
            user: generic user access
    basic_auth:
      type: http
      scheme: basic
    authToken:
      type: apiKey
      in: header
      name: Authorization
x-refined-from:
- university-of-chicago-fence.yaml
- university-of-chicago-indexd.yaml
- university-of-chicago-peregrine.yaml
- university-of-chicago-sheepdog.yaml