Introduction

This page describes the rest http api. It provides interfaces for administrative purposes and is therefore not intended to be used by clients for endusers. Basic authentication is used to authenticate the client, which needs to be configured in the middleware via the following properties:

com.openexchange.rest.services.basic-auth.login
com.openexchange.rest.services.basic-auth.password

Authentication


basicAuth

HTTP Basic Authentication.
Security scheme type: http
HTTP Authorization Scheme: basic


contextAdminAuth

The API can be accessed via HTTP Basic Auth with context administrator credentials or reseller/master administrator credentials if MASTER_ACCOUNT_OVERRIDE is enabled.
Security scheme type: http
HTTP Authorization Scheme: basic


masterAdminAuth

The API can be accessed via HTTP Basic Auth with master administrator credentials.
Security scheme type: http
HTTP Authorization Scheme: basic


OX REST API

Documentation of the Open-Xchange REST API.
  • Admin

    Interface for provisioning and other administrative operations.

  • The advertisement module

  • Health

    The health-check module

  • InternetFreeBusy

    Servlet for requesting free busy data.

  • Metrics

    The metrics module

  • Preliminary

    This module contains preliminary endpoints which can change in the future.

  • Push

    The push module

  • Request-Analysis

    This module contains endpoints used to analyze requests

  • Userfeedback

    The user feedback module