API Endpoints - Explanation, Links, Examples
POST /auth
Authenticates against the IAA API
You can use this endpoint to authenticate with the Intrexx Administration API.
Open the step-by-step guide to learn how to authenticate yourself.
Step-by-Step
To authenticate with the Intrexx Administration API, follow these steps:
-
Open the authentication endpoint.
-
Enter the username and password you specified when installing the Intrexx Administration API.
For more information, see the section Go to the "Administration API Configuration" tab.
-
Click .
The authentication token is displayed.
-
Copy the key to the clipboard.
-
Navigate to the top of the Swagger file.
-
Click "Authorize."
The input field for the key is displayed.
-
Enter the token (
) in the "Value" field. -
Click "Authorize" (
).
-
Click "Close."
You can now use the Intrexx Administration API.
The generated token is valid for one hour.
Create Portals
GET /portals
Get the list of portals.
This endpoint returns a list of all portals in your Intrexx instance.
Available Portals
POST /portals
Create a new portal
You can use this endpoint to create a new portal.
DELETE /portals/{id}
Delete a portal
You can use this endpoint to delete a portal.
GET /templates
Get a list of all portal templates.
This endpoint returns a list of all portal templates in your Intrexx instance.
POST /templates
Upload a portal template
You can use this endpoint to upload a portal template to the Intrexx server. The template can then be used to create a new portal.
Manage Portals
GET /{portal}/webserver
Get the portal base URL
This endpoint returns the base URL of the portal.
PUT /{portal}/webserver
Set the portal base URL
You can use this endpoint to change the portal's base URL.
GET /{portal}/settings
Get the portal settings
This endpoint returns the properties of the portal.
PATCH /{portal}/settings
Set the portal settings
You can use this endpoint to change the portal properties.
GET /{portal}/mobile
Get the current mobile API key
This endpoint returns the API key stored in Intrexx for the Intrexx Mobile app.
Intrexx Mobile App - Settings in the Tools Module
PATCH /{portal}/mobile
Change the current mobile API key.
This endpoint allows you to change the API key stored in Intrexx for the Intrexx Mobile app.
Intrexx Mobile App - Settings in the Tools Module
DELETE /{portal}/mobile
Delete the current mobile API key.
This endpoint allows you to delete the API key stored in Intrexx for the Intrexx Mobile app.
Intrexx Mobile App - Settings in the Tools Module
GET /{portal}/reports/engine
Retrieve the current reports engine and its configuration.
PATCH /{portal}/reports/engine
Set or update and configure the current reporting engine and its settings.
GET /{portal}/export
Read the portal export template configuration.
PATCH /{portal}/export
Write the portal export configuration.
GET /{portal}/diagnosis
Download the server's diagnostic ZIP file.
POST /{portal}/search/index
Triggers an action for the search index.
POST /{portal}/applications
Upload and import/create applications, processes, layouts, and files by exporting a ZIP file
PATCH /{portal}/applications
Overwrite applications, processes, layouts, and files by exporting a ZIP file.
POST /{portal}/logout
Log out of a portal.
You can use this endpoint to log a user out of the portal.
Scheduler
GET /{portal}/scheduler/jobs
Read the list of all scheduler jobs
POST /{portal}/scheduler/job/{type}
Create a scheduled job
GET /{portal}/scheduler/job/{id}
Get all the information about a scheduler job
PATCH /{portal}/scheduler/job/{id}
Patch a scheduler job
DELETE /{portal}/scheduler/job/{id}
Delete a scheduled job
GET /{portal}/scheduler/standby
Get the scheduler's standby status
PUT /{portal}/scheduler/standby
Put the scheduler into standby mode or take it out of standby mode
GET /{portal}/scheduler/configuration
Get the scheduler configuration
PATCH /{portal}/scheduler/configuration
Modify the scheduler configuration
PUT /{portal}/scheduler/actions
Perform actions on jobs
Mail Services
GET /{portal}/mailservices
Retrieves the available email services.
POST /{portal}/mailservices
Adds a mail service.
GET /{portal}/mailservices/{id}
Sign up for the mail service.
Code Sample
PATCH /{portal}/mailservices/{id}
Let's modify the properties of a given configuration.
GET /{portal}/mailservices/{id}/status
Get the mail service status.
PUT /{portal}/mailservices/{id}/status
Change the service status.
Users
POST /{portal}/users
Creates a new user.
POST /{portal}/groups
Creates a new group.
GET /{portal}/groups/{group-id}
Retrieves the group's details.
DELETE /{portal}/groups/{group-id}
Deletes the group.
GET /{portal}/users/{user-id}/groups
Retrieves the groups of which the user is a member.
PUT /{portal}/users/{user-id}/groups/{group-id}
Adds the user to a group.
DELETE /{portal}/users/{user-id}/groups/{group-id}
Removes the user from the group.
GET /{portal}/users/{user-id}
Retrieves a user.
PATCH /{portal}/users/{user-id}
Change a user property.
DELETE /{portal}/users/{user-id}
Deletes the user.
Licenses
GET /{portal}/licenses
Retrieves all available Intrexx licenses.
POST /{portal}/licenses
Adds a new license.
DELETE /{portal}/licenses/{key}
Deletes a license.
PUT /{portal}/trial-license
Sets a trial license to extend the license period.
PUT /admin-api/license
Adds a new Admin API license.
You can use this endpoint to license the Administration API. (This endpoint can be used even if the Administration API has not yet been licensed.)