To generate Access token, send a POST request to /oauth/v1/accesstokens.

Request Body

Name	Type	Required
clientId: <API key>	String	true
clientSecret: <API private key>	String	true

To list all of the keys in your account, send a GET request to /sshkey.

The response will be a JSON object with a key set to ssh_keys. The value of this will be an array of key objects, each of which contains the standard key attributes.

Response Body

Name	Type	Description
id	integer	This is a unique identification number for the key. This can be used to reference a specific SSH key when you wish to embed a key into an Instance.
public_key	string	This is the entire public key string that is embedded in the root user's authorized_keys file, if you choose to include this SSH key during the Instance creation.
name	string	This is the human-readable display name for the given SSH key. This is used to easily identify the SSH keys, when they are displayed.
Status	string	SSH key status

To list all of the active SSH keys in your account, send a GET request to /sshkey/active/status.

The response will be a JSON object with a key set to ssh_keys. The value of this will be an array of key objects, each of which contains the standard key attributes.

Response Body

Name	Type	Description
id	integer	This is a unique identification number for the key. This can be used to reference a specific SSH key when you wish to embed a key into an Instance.
public_key	string	This is the entire public key string that is embedded in the root user's authorized_keys file, if you choose to include this SSH key during the Instance creation.
name	string	This is the human-readable display name for the given SSH key. This is used to easily identify the SSH keys, when they are displayed.
Status	string	SSH key status

To add a SSH public key to your WebARENA Indigo account, send a POST request to /sshkey. Set the "name" attribute to the name you wish to use and the "public_key" attribute to a string of the full public key you are adding.

Request Body

Name	Type	Description
sshName	string	The name to give the new SSH key in your account.
sshKey	string	A string containing the entire public key.

To view details about a key, send a GET request to /sshkey/{id}.

To update the name of a SSH key, send a PUT request to /sshkey/{id}.

Request Body

Name	Type	Description
sshName	string	The name to give the new SSH key in your account.
sshKey	string	A string containing the entire public key.
sshKeyStatus	string	SSH key status (ACTIVE / DEACTIVE)

To destroy a public SSH key in your account, send a DELETE request to /sshkey/{id}.

To generate API key to your WebARENA Indigo account, send a GET request to /create/apikey.

To list all of the API Keys in your account, send a GET request to /apikey.

Response Body

Name	Type	Description
id	integer	API key id
user_id	integer	User Id
serviceid	string	Contract servce id
apikey	string	API Key

To destroy a API Key, send a DELETE request to /apikey/{id}.

To view details about Instance types, send a GET request to /instancetypes.

To view details about a region list, send a GET request to /getregion?instanceTypeId=1.

Response Body

Name	Type	Description
id	integer	Region id
name	string	Region name

To view details about a OS list, send a GET request to /oslist.

To view details about an instance specification list, send a GET request to /getinstancespec?instanceTypeId=1&osId=1.

To add an Instance to your WebARENA Indigo account, send a POST request to /api/v1/createinstance.

Request Body

Name	Type	Description	Required
sshKeyId	Integer	SSH key Id	true
regionId	Integer	Region Id	true
osId	Integer	OS Id	true
instancePlan	Integer	Instance specification id	true
instanceName	String	Instance Name	true

To add an Windows Instance to your WebARENA Indigo account, send a POST request to /api/v1/createinstance.

Request Body

Name	Type	Description	Required
winPassword	String	Windows password	true
regionId	Integer	Region Id	true
osId	Integer	OS Id	true
instancePlan	Integer	Instance specification id	true
instanceName	String	Instance Name	true

Windows Password Rules:
1. Passwords must not contain the user's account name "administrator".
2. Passwords must be at least seven characters in length.
3. Passwords must contain characters from three of the following four categories:
a. English uppercase characters (A through Z)
b. English lowercase characters (a through z)
c. Base 10 digits (0 through 9)
d. Non-alphabetic characters (for example, !, $, #, %)

To add an Import URL Instance to your WebARENA Indigo account, send a POST request to /api/v1/createinstance.

Request Body

Name	Type	Description	Required
importUrl	String	Import VM URL Path	true
regionId	Integer	Region Id	true
osId	Integer	OS Id	true
instancePlan	Integer	Instance specification id	true
instanceName	String	Instance Name	true

To add an Snapshot Instance to your WebARENA Indigo account, send a POST request to /api/v1/createinstance.

Request Body

Name	Type	Description	Required
sshKeyId	Integer	SSH key Id	true
snapshotId	Integer	Snapshot Id	true
instancePlan	Integer	Instance specification Id	true
instanceName	String	Instance Name	true

To view details about a Instance list, send a GET request to /getinstancelist.

To update an instance status in your WebARENA Indigo account, send a POST request to /api/v1/statusupdate.

Request Body

Name	Type	Description	Required
instanceId	Integer	Instance Id	true
status	String	Status (start,stop,forcestop,reset,destroy)	true

To add a firewall to your WebARENA Indigo account, send a POST request to /api/v1/createfirewall.

Request Body

Name	Type	Description	Required
name	String	Firewall template name	true
inbound	Array	Inbound rules	true (Minimum one rule required from inbound OR outbound)
outbound	Array	Outbound rules	true (Minimum one rule required from inbound OR outbound)
instances	Array	Instance id's to assign	false

To view Firewall list, send a GET request to /getfirewalllist.

To retrieve a Firewall template, send a GET request to /gettemplate/{id}.

To update a firewall, send a PUT request to /api/v1/updatefirewall.

Request Body

Name	Type	Description	Required
templateid	Integer	Firewall template name	true
name	String	Firewall template name	true
inbound	Array	Inbound rules	true (Minimum one rule required from inbound OR outbound)
outbound	Array	Outbound rules	true (Minimum one rule required from inbound OR outbound)
instances	Array	Instance id's to assign	false

To assign a firewall to the instance, send a POST request to /api/v1/assign.

Request Body

Name	Type	Description	Required
templateid	Integer	Firewall template id	true
instanceid	Integer	Instance id	true

To delete an unassigned firewall, send a DELETE request to /api/v1/deletefirewall/{id}.

To create a snapshot to an instance, send a POST request to /api/v1/takesnapshot.

Request Body

Name	Type	Description	Required
name	String	Snapshot Name	true
instanceid	Integer	Instance Id	true
slotnum	Integer	Slot Number (It must be 0)	true

To view snapshot list, send a GET request to /snapshotlist/{instanceid}.

To retry creating snapshot, send a POST request to /api/v1/retakesnapshot.

Request Body

Name	Type	Description	Required
instanceid	Integer	Instance Id	true
snapshotid	Integer	Retry Snapshot Id	true

To restore snapshot to an existing instance, send a POST request to /api/v1/restoresnapshot.

Request Body

Name	Type	Description	Required
instanceid	Integer	Instance Id	true
snapshotid	Integer	Snapshot Id	true

To delete snapshot, send a DELETE request to /api/v1/deletesnapshot/{id}.

To add a domain, send a POST request to /registerdomain.

Request Body

Name	Type	Description	Required
domain_name	String	Domain Name	true

To view domain list, send a GET request to /getdomainlist.

To get domain record, send a GET request to /getdomainrecord/{id}.

To cancel domain, send a DELETE request to /canceldomain/{id}.

To create a verification token, send a POST request to /domainverificationtoken.

Request Body

Name	Type	Description	Required
zoneid	Numeric	Id (id column value from get domain api result)	true
verifytype	String	Verification Type (TXT, NS)	true

To cancel verification token, send a DELETE request to /canceldomainverification/{id}.

To verify domain, send a GET request to /domainverification/{id}.

To get domain DNS records, send a GET request to /editdomain/{id}.

To get TTL list, send a GET request to /getttl.

To add a A record, send a POST request to /addARecord.

Request Body

Name	Type	Description	Required
zone_id	Numeric	DNS Zone Id (zone_id column value from get domain response)	true
domain_name	String	Domain Name (zone column value from get domain response)	true
host_name	String	Host Name	true
address	Array	IP V4	true
ttl	Numeric	TTL Value	true

To update a A record, send a PUT request to /updateARecord.

Request Body

Name	Type	Description	Required
zone_id	Numeric	DNS Zone Id (zone_id column value from get domain response)	true
domain_name	String	Domain Name (zone column value from get domain response)	true
host_name	String	Host Name	true
address	Array	IP V4	true
ttl	Numeric	TTL Value	true

To add a AAAA record, send a POST request to /api/v1/addAAAARecord.

Request Body

Name	Type	Description	Required
zone_id	Numeric	DNS Zone Id (zone_id column value from get domain response)	true
domain_name	String	Domain Name (zone column value from get domain response)	true
host_name	String	Host Name	true
address	String	IP V6	true
ttl	Numeric	TTL Value	true

To update a AAAA record, send a PUT request to /updateAAAARecord.

Request Body

Name	Type	Description	Required
zone_id	Numeric	DNS Zone Id (zone_id column value from get domain response)	true
domain_name	String	Domain Name (zone column value from get domain response)	true
host_name	String	Host Name	true
address	String	IP V6	true
ttl	Numeric	TTL Value	true

To add a CNAME record, send a POST request to /addCNAMERecord.

Request Body

Name	Type	Description	Required
zone_id	Numeric	DNS Zone Id (zone_id column value from get domain response)	true
domain_name	String	Domain Name (zone column value from get domain response)	true
host_name	String	Host Name	true
host_name_alias	String	Alias Name	true
ttl	Numeric	TTL Value	true

To update a CNAME record, send a PUT request to /updateCNAMERecord.

Request Body

Name	Type	Description	Required
zone_id	Numeric	DNS Zone Id (zone_id column value from get domain response)	true
domain_name	String	Domain Name (zone column value from get domain response)	true
host_name	String	Host Name	true
host_name_alias	String	Alias Name	true
ttl	Numeric	TTL Value	true

To add a MX record, send a POST request to /addMXRecord.

Request Body

Name	Type	Description	Required
zone_id	Numeric	DNS Zone Id (zone_id column value from get domain response)	true
domain_name	String	Domain Name (zone column value from get domain response)	true
host_name	String	Host Name	true
mail_server	String	Mail Server Name	true
priority	Numeric	Priority	true
ttl	Numeric	TTL Value	true

To update a MX record, send a PUT request to /updateMXRecord.

Request Body

Name	Type	Description	Required
zone_id	Numeric	DNS Zone Id (zone_id column value from get domain response)	true
domain_name	String	Domain Name (zone column value from get domain response)	true
host_name	String	Host Name	true
mail_server	String	Mail Server Name	true
priority	Numeric	Priority	true
ttl	Numeric	TTL Value	true

To add a TXT record, send a POST request to /addTXTRecord.

Request Body

Name	Type	Description	Required
zone_id	Numeric	DNS Zone Id (zone_id column value from get domain response)	true
domain_name	String	Domain Name (zone column value from get domain response)	true
host_name	String	Host Name	true
txt_value	String	TXT Value	true
ttl	Numeric	TTL Value	true

To update a TXT record, send a PUT request to /updateTXTRecord.

Request Body

Name	Type	Description	Required
zone_id	Numeric	DNS Zone Id (zone_id column value from get domain response)	true
domain_name	String	Domain Name (zone column value from get domain response)	true
host_name	String	Host Name	true
txt_value	String	TXT Value	true
ttl	Numeric	TTL Value	true

To add a NS record, send a POST request to /addNSRecord.

Request Body

Name	Type	Description	Required
zone_id	Numeric	DNS Zone Id (zone_id column value from get domain response)	true
domain_name	String	Domain Name (zone column value from get domain response)	true
host_name	String	Host Name	true
to_server	Array	Server Address	true
ttl	Numeric	TTL Value	true

To update a NS record, send a PUT request to /updateNSRecord.

Request Body

Name	Type	Description	Required
zone_id	Numeric	DNS Zone Id (zone_id column value from get domain response)	true
domain_name	String	Domain Name (zone column value from get domain response)	true
host_name	String	Host Name	true
to_server	Array	Server Address	true
ttl	Numeric	TTL Value	true

To add a SRV record, send a POST request to /addSRVRecord.

Request Body

Name	Type	Description	Required
zone_id	Numeric	DNS Zone Id (zone_id column value from get domain response)	true
domain_name	String	Domain Name (zone column value from get domain response)	true
host_name	String	Host Name	true
priority	Numeric	Priority	true
target	String	Target	true
weight	Numeric	Weight	true
port	Numeric	Port	true
ttl	Numeric	TTL Value	true

To update a SRV record, send a POST request to /updateSRVRecord.

Request Body

Name	Type	Description	Required
zone_id	Numeric	DNS Zone Id (zone_id column value from get domain response)	true
domain_name	String	Domain Name (zone column value from get domain response)	true
host_name	String	Host Name	true
priority	Numeric	Priority	true
target	String	Target	true
weight	Numeric	Weight	true
port	Numeric	Port	true
ttl	Numeric	TTL Value	true

To delete a DNS record, send a DELETE request to /deleteNSRecord.

Request Body

Name	Type	Description	Required
zone_id	Numeric	DNS Zone Id (zone_id column value from get domain response)	true
domain_name	String	Domain Name (zone column value from get domain response)	true
host_name	String	Host Name (Host name of the record to be deleted)	true
type	String	DNS Record Type (A, AAAA, CNAME, MX, TXT, NS, SRV)	true

To list all of the Licenses , send a GET request to /license/list.

The response will be a JSON object with a key set to licenses. The value of this will be an array of key objects, each of which contains the standard key attributes.

Response Body

Name	Type	Description
id	integer	This is a unique identification number for the license. This can be used to reference a specific license when you wish to embed a key into an update license quantity.
product_name	string	License product name
product_code	string	License product code.
quantity	integer	License usage quantity

To update the License quantity, send a PUT request to /license/{id}/update.

Request Body

Name	Type	Description
quantity	integer	License quantity.