Intrexx Administration API

Features

The Intrexx Administration API provides a set of API endpoints that can be used to perform key tasks in Intrexx without having to launch the Intrexx Portal Manager.

This allows you to use an API client to create and delete portals or users, activate licenses, or import applications. For a complete list of all API endpoints, see the section API Endpoints - Explanation, Links, Examples." In addition, you can find the overview of API endpoints in a documentation in the OpenAPI standard. This is displayed by a Swagger UI component. For detailed information on this topic, see the " Interactive Swagger Documentation" section.

Distinction Between "Application API" and "Administration API"

Intrexx offers two comprehensive API functionalities: the Intrexx Application API and the Intrexx Administration API. With the Application API, you can create your own API endpoints for Intrexx applications. The Administration API provides you with a defined set of API endpoints that offer key functions for configuring Intrexx.

• Intrexx Administration API

• Intrexx Application API

Target Audience

The Intrexx Administration API is especially suitable for administrators or experienced Intrexx users who manage multiple Intrexx instances. For example, if you want to create new users for a portal or import a new license, you can create your own applications or scripts for this purpose and perform the corresponding actions using the API endpoints.

You can find a number of sample scripts on GitHub at the following link: https://github.com/UnitedPlanet/intrexx-sample-admin-api.

You can also access the individual script examples by following the links below the respective endpoints on the API Endpoints - Explanation, Links, Examples page.

Specification

The Intrexx Administration API complies with the OpenAPI specification.

Architecture

The Intrexx Administration API is an API gateway. It is part of the Intrexx instance and must be installed and then started.

After installation, all files, libraries, and scripts related to the Intrexx Administration API are located in the directory <intrexx-installation-directory>\admin-api and its subdirectories.

For detailed information on installing the Intrexx Administration API, see the " Installation" section.