Set up multiple Minion Appliances via REST API

The Appliance Service provides external REST APIs that make it easier to set up multiple Minion Appliances. The REST API lets you access the information and functions required for appliance setup (appliance configuration, connectivity and feature profiles, instances, and so on) through GET, PUT, POST, and DELETE methods.

You can perform the following tasks through the REST API:

  • Activate an appliance from your subscription.

  • Update appliance name, profile, or geographical location.

  • Download appliance configuration file.

  • Create/delete an instance.

  • Create/delete a connectivity profile.

  • Create/edit/delete locations.

  • Add/remove Minion to/from your appliance.

Each request requires an API token as authentication to run. After you create an API token add the token secret (its generated output) to the X-API-KEY parameter in the HTTP header.

Note that when creating or updating, the API accepts input as JSON within the body of the request.

To view the REST API documentation, select API Documentation from the left menu. The documentation provides information on the available operations and their parameters; it also lets you try some of the operations in that setting.

API documentation menu

You must have an understanding of HTTP, request methods, and how to send requests (using either a command line tool or library of your choice) to use the REST API. Instructions for how to use a REST API are beyond the scope of this documentation.

Try out REST API commands

The REST API documentation includes the option to try out a command to see the response and actual information it generates. You require an API token to try out commands.

To use this feature:

  1. Click the Authorize button near the top of the page, paste your API token into the Value field, and click Authorize.

  2. Expand the command you want to try and click Try it out.

  3. Specify the appropriate information (parameters, ID, others as required) and click Execute.

  4. View the response in the Responses area.

Before you begin

Before you set up Minion Appliances through the REST API, review the requirements in the before you begin section.

Preconfiguration

You must follow the steps below in the Appliance Service portal; you cannot perform these tasks via the REST API:

Create and manage API tokens

You must create an API token to use the external REST API and include the API token secret as a header parameter in your queries.

You can access the token secret only when you create the token.

To create an API token, follow these steps:

  1. In the left menu, click API Tokens.

  2. Click Add New.

  3. Specify a name for the token and click Add New.

    A descriptive name helps to manage multiple tokens.

  4. Copy and save the token secret.

    You will not be able to access the token secret again.

  5. Click the back arrow or any menu item to exit the screen.

Update a token

You can update only the name of the token. Consider using descriptive names for easier token management.

To update a token:

  1. In the left menu, click API Tokens.

  2. Find the token that you want to update and click the pencil icon beside its name.

  3. Change the token’s name, then click Update.

Delete a token

If you delete a token, you can no longer use the token on REST API endpoints. You may want to delete a token if you accidentally expose it or as a way to revoke user access from someone else who shares the token (for example, an employee who has left the organization).

To delete a token, follow these steps:

  1. In the left menu, click API Tokens.

  2. Click the trash icon beside the token that you want to delete.

  3. Confirm deletion of the token.

src="https://polyfill.io/v3/polyfill.min.js?features=es6">