Qorus Public REST API Overview

The APIs documented here do not require any authentication to access.

Swagger Schema: A static version can be downloaded here: qorus-rest-api-public.yaml; a dynamic version is available from every Qorus instance without authentication at URI paths /schema/qorus-rest-api-public.yaml and /schema/qorus-rest-api-public.json (ex: if Qorus is available on https://localhost:8011, then the dynamic schema can be retrieved from https://localhost:8011/schema/qorus-rest-api-public.yaml and https://localhost:8011/schema/qorus-rest-api-public.json).

/api/public/info

This URI path implements token-based user authentication.

Return Value

This API returns a QorusPublicInfo hash with the following keys (information about the current Qorus instance):

instance-key (string): Qorus instance identifier
omq-version (string): Qorus executable version
omq-build (string): Qorus executable git hash
qore-version (string): Qore library version
omq-schema (string): Qorus system schema info
noauth (bool): Always True in the Community Edition
edition (string): Community for Qorus Integration Engine(R) Community Edition
tz_region (string): the time zone region the server is running in
tz_utc_offset (int): the UTC offset in seconds east of UTC; negative numbers indicate west of UTC

This URI path implements token-based user authentication.

Arguments

This API takes the following hash arguments:

Return Value

This API returns a QorusTokenInfo hash with the following key (Authentication info):

Errors