SearchStax Cloud Private VPC API

SearchStax provides an API supporting the creation, deletion and management of SearchStax Cloud deployments.

Platinum and Platinum Plus Clients Only!

The SearchStax API suite is available to our Platinum and Platinum Plus clients only, as noted on our Pricing page.

This page describes how to obtain the ID number of a Virtual Private Cloud (VPC) using the API. This ID is essential to creating a new deployment inside the VPC using the account > deployment > create method.

The API can be accessed through any tool that assembles HTTP requests and dispatch them to a server. Among these would be the Python coreapi package, the Postman tool, and cURL. For Windows, use PowerShell 7+.

Account Owner, Admin, or Technical Contact

To run the SearchStax Provisioning API, you must be the account Owner, an account Admin, or a Technical Contact. See SearchStax User Roles.

Symbols enclosed in carets (< and >) such as <username> are metavariables. Substitute your local values when you encounter them in the examples.

Contents:

Private VPC API
- account > privatevpc > list

Private VPC API

SearchStax provides the ability to create new Solr deployments within your VPC using the account > deployment > create method. That method, in turn, requires the ID number of the VPC in your account. The following method lets you obtain this ID number.

account > privatevpc > list

This method lists VPCs associated with an account.

GET /api/rest/v2/account/<account_name>/privatevpc/?page=1

where <account_name> is the name of the tenant account, and <page> is an optional page number within the paginated result set.

This method uses Token authentication.

When invoked from Linux (Bash script):

curl --request GET "https://app.searchstax.com/api/rest/v2/account/<account_name>/privatevpc" 
  --header "Authorization: Token <token>"

When invoked from Windows (PowerShell script):

$ACCOUNT = "AccountName"

$RESULT = Invoke-RestMethod -Method Get -ContentType 'application/json' -Headers $headers `
              -uri "https://app.searchstax.com/api/rest/v2/account/$ACCOUNT/privatevpc/"
$RESULT = $RESULT | ConvertTo-Json

A successful response is a JSON object describing the VPCs of the account:

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": 2,
      "account": "test",
      "region": "us-east1",
      "status": "Active",
      "address_space": "10.63.0.0/16",
      "name": "test-vpc"
    }
  ]
}

Questions?

Do not hesitate to contact the SearchStax Support Desk.