University of Alberta

University of Alberta Info API

The Info API from University of Alberta — 1 operation(s) for info.

GitHub OpenAPI

Documentation

📖
Documentation
https://borealisdata.ca/guides/en/latest/api/index.html
📖
Documentation
https://borealisdata.ca/guides/en/latest/api/native-api.html
📖
Documentation
https://borealisdata.ca/guides/en/latest/api/search.html
📖
Authentication
https://borealisdata.ca/guides/en/latest/api/getting-started.html

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/university-of-alberta/refs/heads/main/openapi/university-of-alberta-info-api-openapi.yml

Other Resources

🔗
x-json-schema
https://raw.githubusercontent.com/api-evangelist/university-of-alberta/refs/heads/main/json-schema/university-of-alberta-search-item-schema.json
🔗
x-vocabulary
https://raw.githubusercontent.com/api-evangelist/university-of-alberta/refs/heads/main/vocabulary/university-of-alberta-vocabulary.yml
🔗
x-rules
https://raw.githubusercontent.com/api-evangelist/university-of-alberta/refs/heads/main/rules/university-of-alberta-rules.yml
🔗
x-json-ld
https://raw.githubusercontent.com/api-evangelist/university-of-alberta/refs/heads/main/json-ld/university-of-alberta-context.jsonld

OpenAPI Specification

university-of-alberta-info-api-openapi.yml Raw ↑ 
openapi: 3.0.3
info:
  title: University of Alberta Research Data (Borealis Dataverse) Info API
  description: Scoped OpenAPI 3.0 description of the publicly accessible, read-only Borealis (Canadian Dataverse Repository) endpoints used to query the University of Alberta research data collection (subtree "ualberta"). Borealis runs the open-source Dataverse software; the full machine-readable spec is published by the server at https://borealisdata.ca/openapi (OpenAPI 3.0.3, Dataverse API, v6.8.1-SP). This document captures only the public Search and Info operations confirmed live against the production host. API tokens (X-Dataverse-key header) are required only for account-scoped or write operations; public searching is open.
  version: v6.8.1-SP
  contact:
    name: API Evangelist
    url: https://borealisdata.ca/dataverse/ualberta
  license:
    name: Apache-2.0
    url: https://github.com/IQSS/dataverse/blob/develop/LICENSE.md
servers:
- url: https://borealisdata.ca/api
  description: Borealis Dataverse production Native/Search API
tags:
- name: Info
paths:
  /info/version:
    get:
      operationId: getVersion
      summary: Get Dataverse version
      description: Returns the running Dataverse software version and build.
      tags:
      - Info
      responses:
        '200':
          description: Version information.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VersionResponse'
components:
  schemas:
    VersionResponse:
      type: object
      properties:
        status:
          type: string
          example: OK
        data:
          type: object
          properties:
            version:
              type: string
              example: v6.8.1-SP
            build:
              type: string
              nullable: true
  securitySchemes:
    DataverseApiKey:
      type: apiKey
      in: header
      name: X-Dataverse-key
      description: API token required only for account-scoped or write operations. Public search and info endpoints do not require it.