Provisioning API Postman Examples - SearchStax


Overview

SearchStax® provides a REST API supporting the programmatic creation and deletion of SearchStax deployments.

See SearchStax REST API for the details of the API. The current page showcases examples of the API viewed through Postman.

Request Authorization Token

The first step in using the SearchStax API is to obtain an authentication token by logging in to the SearchStax server. The token is included in subsequent API requests. It expires after 30 minutes.

This image shows an obtain-auth-token request as issued from Postman:

SearchStax API authorization token

List Available Plans

What SearchStax deployment plans are available? This function generates a list of plans.

When requested through Postman: SearchStax plan list

Read Plan Details

Once you have the plan_id you can retrieve the details of a specific plan.

When requested through Postman: SearchStax Deployment Plan Details

List Deployments

The API can list the current deployments under a specific account (called a tenant_name in the code).

When requested through Postman: SearchStax Account Deployment List

View Deployment Details

If you know the uid of a deployment, you can request its details through the API.

When requested using Postman: SearchStax Account Deployment Details

Create a Deployment

The SearchStax API makes it possible to create a new SearchStax deployment programmatically. Note that there must be a pre-existing SearchStax account (a tenant_user). The new deployment is created inside that account.

When requested through Postman: SearchStax Create Deployment

When successful, the API returns the uid of the new deployment.

Delete a Deployment

The SearchStax API lets you delete a deployment based on the tenant_name and the uid.

Note that there is no safety net. If you accidentally direct this command at the wrong deployment, it will be unmade. See API Termination Protection.

When requested through Postman:

SearchStax Deployment Deletion

Questions?

Do not hesitate to contact the SearchStax Support Desk.