/api/v1/appliance
Provision an Appliance
Provisions a (Undefined variable: ALVariables.WSM_OutBndWaf_2) (WSM) appliance, and optionally can add a new API user.
This API call is the only one which can be called without an API user. All other API calls must authenticate with an API user's credentials.
URL
/api/v1/appliance
HTTP Method
POST
POST Parameters
|
Parameter |
Required |
Type |
Description |
|---|---|---|---|
|
key |
true |
string |
Specifies the WSM license key to provision the appliance with. |
|
public_ip |
true |
string |
Specifies the public IP of the WSM appliance. |
|
api_user |
false |
string |
Specifies the username of the API user to be created. |
|
api_password |
false |
string |
Specifies the password of the API user to be created. |
Response Parameters
Returns a message string indicating whether the (Undefined variable: ALVariables.WSM_OutBndWaf_2) appliance was successfully provisioned.
Example: Provision an Appliance
Request
POST
/api/v1/appliance
cURL
curl -kv
-X POST
-H 'Content-Type: text/json'
--data-binary @prov.json
https://172.31.1.172:4849/api/v1/appliance
POST Parameters
{
"key": "examplekey947ac79b4a774348debf9fdeba93a4examplekey",
"public_ip": "5.6.7.8"
}
Response
"appliance successfully provisioned"
Example: Provision an Appliance and Create a New API User
Request
POST
cURL
curl -kv
-X POST
-H 'Content-Type: text/json'
--data-binary @prov.json
https://172.31.1.172:4849/api/v1/appliance
POST Parameters
{
"key": "examplekey947ac79b4a774348debf9fdeba93a4examplekey",
"public_ip": "5.6.7.8",
"api_user": "api_ninja",
"api_password": "ninja_password"
}
Response
"appliance successfully provisioned"