The Gateway Manager provides a REST-based API that allows you to manage resources and start migrations. The Swagger (OpenAPI v3) documentation for our API is available directly from within your installation via:

or

Open API Documentation

Version: 2024.3 last updated: 10.10.2024

Open

Authentication

Every call to the API needs to present an access token in the X-TOKEN header of the request. To obtain an access token you need to call the /login endpoint using a valid username and password.

Only users stored in the Gateway Manager’s own user table are allowed to perform API calls. SAML or oAuth authentications against the API are not available.

Test the API

You can test the API right from the SwaggerUI available using the address above. First call the /login endpoint in order to get an access token. Then click on the “Authorize” button in the top right and enter your token there. After doing this you can test all methods right from your browser.

Open

Example workflow

Open