University of Amsterdam Info API

openapi: 3.0.3
info:
  title: TriplyDB Accounts Info API
  version: 26.5.104
  description: "REST API for TriplyDB — a linked data database platform.\n\n## Authentication\n\nRead operations on publicly published datasets can be performed without\nauthentication. Write operations and read operations on private or internal\ndatasets require a valid API token.\n\n### Creating an API token\n\n1. Log into your TriplyDB instance.\n2. Click on the user menu in the top-right corner and click on \"User settings\".\n3. Go to the \"API tokens\" tab.\n4. Click \"Create token\", enter a description (e.g., \"my-script\") and select\n   the appropriate access rights.\n5. Click \"Create\" and copy the token. It is only shown once upon creation.\n\n### Using the API token\n\nInclude the token in the `Authorization` header of your HTTP requests:\n\n```\nAuthorization: Bearer YOUR_TOKEN\n```\n\n### Security considerations\n\n- **Do not commit tokens to git repositories.**\n- **Do not share tokens** with anyone who should not have access to your\n  TriplyDB resources.\n- **Rotate tokens regularly**, especially if you suspect a compromise.\n\n## Pagination\n\nList endpoints are paginated. The response includes a `Link` header\n([RFC 8288](https://www.rfc-editor.org/rfc/rfc8288)) with URLs for\nnavigating the result set. To paginate, follow the URLs in the `Link`\nheader rather than constructing URLs manually.\n\nThe `Link` header contains up to three relations:\n\n| Relation | Meaning |\n|----------|---------|\n| `first`  | URL to the first page of results |\n| `next`   | URL to the next page (absent when on the last page) |\n| `prev`   | URL to the previous page (absent when on the first page) |\n\nExample response header:\n\n```\nLink: <https://api.example.com/datasets/user/ds?limit=30>; rel=\"first\",\n      <https://api.example.com/datasets/user/ds?since=6435a&limit=30>; rel=\"next\"\n```\n\nTo iterate through all results, keep following the `rel=\"next\"` URL until\nit is no longer present. You can control the page size with the `limit`\nquery parameter (default: 30).\n\n## Content negotiation\n\nLinked data endpoints support format negotiation in two ways:\n\n1. **Accept header** — set the `Accept` request header to the desired media type.\n2. **URL extension** — append a format extension to the URL path (e.g., `/run.csv`).\n   When present, the extension takes precedence over the `Accept` header.\n"
  contact:
    name: Triply
    url: https://triply.cc
servers:
- url: https://api.lod.uba.uva.nl
  description: This instance
security:
- bearerAuth: []
- {}
tags:
- name: Info
  description: Instance information
paths:
  /info:
    get:
      tags:
      - Info
      summary: Get instance configuration
      operationId: getInfo
      security:
      - {}
      responses:
        '200':
          description: Instance configuration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientConfig'
components:
  schemas:
    Prefixes:
      type: object
      additionalProperties:
        type: string
        format: uri
      example:
        rdf: http://www.w3.org/1999/02/22-rdf-syntax-ns#
        rdfs: http://www.w3.org/2000/01/rdf-schema#
    ClientConfig:
      type: object
      properties:
        branding:
          type: object
          properties:
            name:
              type: string
            logo:
              type: string
            logoBgType:
              type: string
              enum:
              - circle
              - square
              - none
            logoBgColor:
              type: string
            logoLg:
              type: string
            banner:
              type: string
            tagline:
              type: string
            description:
              type: string
            welcomeMessage:
              type: string
        consoleUrl:
          type: string
        apiUrl:
          type: string
        contactEmail:
          type: string
        prefixes:
          $ref: '#/components/schemas/Prefixes'
        enabledServices:
          type: array
          items:
            $ref: '#/components/schemas/ServiceType'
        enabledOauth:
          type: array
          items:
            type: string
        passwordSignup:
          type: boolean
        version:
          type: string
        statements:
          type: integer
        buildDate:
          type: string
        buildId:
          type: string
        instanceUpdatedAt:
          type: string
          format: date-time
        instanceStartedAt:
          type: string
          format: date-time
        counts:
          type: object
          properties:
            queries:
              type: integer
            datasets:
              type: integer
            stories:
              type: integer
        legal:
          type: object
          properties:
            latestRequiredConsentUpdate:
              type: string
            privacyPolicyUrl:
              type: string
            generalTermsUrl:
              type: string
    ServiceType:
      type: string
      enum:
      - elasticSearch
      - virtuoso
      - jena
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT