University of Chicago Gen3 indexd — system API

System endpoints

Operations 5

GET /_status Returns if Fence is healthy or not
GET /_version Returns the version of Fence
GET /metrics Get Prometheus metrics
GET /_dist Returns the IndexD dist configuration
GET /_stats Returns basic information about the records in IndexD

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/university-of-chicago-system-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.

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

OpenAPI Specification

university-of-chicago-system-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Gen3 indexd OpenAPI Specification System API
  version: 0.1.0
  description: 'indexd is the Gen3 data indexing and GUID service, authored by the University of Chicago Center for Translational Data Science. Code: https://github.com/uc-cdis/indexd'
  termsOfService: http://cdis.uchicago.edu/terms/
  contact:
    email: cdis@uchicago.edu
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
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
  /_version:
    get:
      tags:
      - system
      summary: Returns the version of Fence
      produces:
      - application/json
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/SystemVersionOutputRef'
  /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
  /_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])
  /_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'
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
  securitySchemes:
    OAuth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: /oauth/authorize
          tokenUrl: /oauth/token
          scopes:
            user: generic user access