1. Documentation
2. 2024.1 (Latest) 2024.0 10.3 10.2 10.1 10.0 9.10 9.9 9.8 9.7 9.6 9.5 9.4 9.3 9.2 9.1 9.0 8.2 8.1 8.0 7.6
3. Hub
4. Api
5. REST API

REST API

RapidMiner AI Hub offers a REST API to manage it programmatically. In order to use the API, you are required to be authenticated and authorized via JSON Web Token (JWT).

Create a JWT using basic authentication

Use the following RapidMiner AI Hub REST endpoint to create a JWT:

[GET] $RMServerHost/api/rest/tokenservice

where $RMServerHost is the IP Address or host name of your RapidMiner AI Hub instance. The request needs to be authorized via Basic Auth, use your RapidMiner AI Hub credentials to do so. If the request was successfully executed, you will get the following response body:

{ 
    "idToken": "<tokenContent>",
    "expirationDate": "<epochSeconds>"
}

Use the value of idToken to authorize your requests. The expirationDate indicates how long the JWT is valid, the default is 5 minutes. Once the token expires, you will need to create a new one by repeating the steps described above or you'll receive a 401 (unauthorized) response.

curl -u username:password $RMServerHost/api/rest/tokenservice

Create a JWT using an offline token

If you want to obtain the JWT in a fully programmatic way, you'll need to use an offline token, which can be requested as described here. Follow the steps there to get, first an offline, then an access token.

That access token can be used on this RapidMiner AI Hub REST endpoint to create a JWT:

[GET] $RMServerHost/api/rest/saml/tokenservice

where $RMServerHost is the IP Address or host name of your RapidMiner AI Hub instance.

Use the response value to authorize your requests. The default expiration value is 5 minutes. Once the token expires, you will need to create a new one by repeating the steps described above or you'll receive a 401 (unauthorized) response.

curl -X GET $RMServerHost/api/rest/saml/tokenservice -H "Authorization: Bearer $idToken" 

RapidMiner AI Hub API

The REST API documentation of RapidMiner AI Hub is available as OpenApi 3.0 specification and is published on SwaggerHub.

For all further requests to the API you need to have

• the HTTP method of your request (GET, POST, PUT, PATCH or DELETE),
• the content-type header attribute,
• the authorization header attribute which includes the idToken from the token service and is prefixed with Bearer (e.g. Authorization: Bearer <tokenContent>),
• the RapidMiner AI Hub url and
• the route you like to make a request to.

curl -H "Content-Type: application/json" -H "Authorization: Bearer $idToken" $RMServerHost/executions/queues