WebARENA Indigo

Access Token Generation

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

Access Token Generation

cURL Example

curl -X POST \
  https://api.customer.jp/oauth/v1/accesstokens\
  -H 'Content-Type: application/json' \
  -d '{
    "grantType": "client_credentials",
    "clientId": "YNG2yIyLDA3TqODlEXvLRwL7HzBjDsCQ",
    "clientSecret": "uDczeZJlxYvuzqcU",
    "code": ""
}'

Request Headers

Content-Type: application/json

Response Headers

content-type: application/json;
status: 201 Created

Response Body

{
    "accessToken": "HnGma03YnFPIF4DMttywiSOCGUHR",
    "tokenType": "BearerToken",
    "expiresIn": "3599",
    "scope": "",
    "issuedAt": "1550570350202"
}

SSH Key

WebARENA Indigo allows you to add SSH public keys to the interface so that you can embed your public key into an Instance, at the time of creation. Only the public key is required to take advantage of this functionality.

Request Headers

Authorization: Bearer {accessToken}

SSH Key List

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

SSH Key List

cURL Example

curl -X GET \
  https://api.customer.jp/webarenaIndigo/v1/vm/sshkey \
  -H 'Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR' 

Request Headers

Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR

Response Headers

content-type: application/json;
status: 200 Ok

Response Body

{
    "success": true,
    "total": 2,
    "sshkeys": [
        {
            "id": 5,
            "service_id": "wsi-000001",
            "user_id": 431,
            "name": "Example",
            "sshkey": "example1",
            "status": "ACTIVE",
            "created_at": "2018-11-01 17:18:00",
            "updated_at": "2018-11-01 17:18:12"
        },
        {
            "id": 5,
            "service_id": "wsi-000001",
            "user_id": 431,
            "name": "Example",
            "sshkey": "example2",
            "status": "ACTIVE",
            "created_at": "2018-11-01 05:37:03",
            "updated_at": "2018-11-01 05:37:03"
        }

    ]
}

Active SSH Key List

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

Active SSH Key List

cURL Example

curl -X GET \
  https://api.customer.jp/webarenaIndigo/v1/vm/sshkey/active/status \
  -H 'Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR' 

Request Headers

Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR

Response Headers

content-type: application/json; 
status: 200 Ok

Response Body

{
    "success": true,
    "total": 2,
    "sshkeys": [
        {
            "id": 5,
            "service_id": "wsi-000001",
            "user_id": 431,
            "name": "Example",
            "sshkey": "examplekey1",
            "status": "ACTIVE",
            "created_at": "2018-11-01 17:18:00",
            "updated_at": "2018-11-01 17:18:12"
        },
        {
            "id": 5,
            "service_id": "wsi-000001",
            "user_id": 431,
            "name": "Example",
            "sshkey": "examplekey2",
            "status": "ACTIVE",
            "created_at": "2018-11-01 05:37:03",
            "updated_at": "2018-11-01 05:37:03"
        }

    ]
}

Create SSH Key

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.

Create SSH Key

cURL Example

curl -X POST \
  https://api.customer.jp/webarenaIndigo/v1/vm/sshkey \
  -H 'Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR' \
  -d '{
   "sshName":"Example",
   "sshKey":"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQDRGTcjdlRYZ9"

}'

Request Headers

Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR

Response Headers

content-type: application/json; 
status: 201 Created

Response Body

{
    "success": true,
    "message": "SSH key has been added successfully",
    "sshKey": {
        "name": "Example",
        "sshkey": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQDRGTcjdlRYZ9",
        "status": "ACTIVE",
        "user_id": 431,
        "service_id": "wsi-000001",
        "updated_at": "2019-10-23 11:24:31",
        "created_at": "2019-10-23 11:24:31",
        "id": 892
    }
}

Retrieve SSH Key

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

Retrieve SSH Key

cURL Example

curl -X GET \
  https://api.customer.jp/webarenaIndigo/v1/vm/sshkey/34 \
  -H 'Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR' \
  

Request Headers

Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR

Response Headers

content-type: application/json; 
status: 200 OK

Response Body

{
    "success": true,
    "sshKey": [
        {
            "id": 5,
            "service_id": "wsi-000001",
            "user_id": 431,
            "name": "Example",
            "sshkey": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQDRGTcjdlRYZ9J4KEaZ3A8FwPSWKHak1UKUusSX",
            "status": "ACTIVE",
            "created_at": "2018-11-01 17:35:32",
            "updated_at": "2018-11-01 17:35:32"
        }
    ]
}

Update SSH Key

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)

Update SSH Key

cURL Example

curl -X PUT \
  https://api.customer.jp/webarenaIndigo/v1/vm/sshkey/34 \
  -H 'Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR' \
  -d '{
   "sshName": "Example",
   "sshKey": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQDRGTcjdlRYZ9J4KEaZ3A8FwPSWKHak1UKUusSX",
   "sshKeyStatus": "ACTIVE"

}'

Request Headers

Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR

Response Headers

content-type: application/json; 
status: 200 OK

Response Body

{
    "success": true,
    "message": "SSH key has been updated successfully"
}

Destroy SSH Key

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


Destroy SSH Key

cURL Example

curl -X DELETE \
  https://api.customer.jp/webarenaIndigo/v1/vm/sshkey/34 \
  -H 'Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR' \
  

Request Headers

Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR

Response Headers

content-type: application/json; 
status: 200 OK

Response Body

{
    "success": true,
    "message": "SSH key has been removed successfully"
}

API Key

WebARENA Indigo allows you to Generate API key for accessing the API.












Request Headers

Authorization: Bearer {accessToken}

Generate API Key

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

Generate API Key

cURL Example

curl -X GET \
  https://api.customer.jp/webarenaIndigo/v1/auth/create/apikey \
  -H 'Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR' \
 

Request Headers

Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR

Response Headers

content-type: application/json;
status: 201 Created

Response Body

{
    "apiKey": "m70QyrbMUZWl06SfSAvRBPQO0ofsadf",
    "apiSecret": "LmAY0pB1xA1fas"
}

API Key List

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

API Key List

cURL Example

curl -X GET \
  https://api.customer.jp/webarenaIndigo/v1/auth/apikey \
  -H 'Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR' \
  

Request Headers

Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR

Response Headers

content-type: application/json;
status: 200 Ok

Response Body

{
    "success": true,
    "total": 1,
    "accesstokens": [
        {
            "id": 434,
            "apiKey": "3PwzRzZyXAmBSi0NiYGQjUGpDfsadf",
            "created_at": "2019-10-21 11:17:08"
        }
    ]
}

Destroy API Key

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


Destroy API Key

cURL Example

curl -X DELETE \
  https://api.customer.jp/webarenaIndigo/v1/auth/apikey/88 \
  -H 'Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR' \
  

Request Headers

Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR

Response Headers

content-type: application/json;
status: 200 OK

Response Body

{
    "success": true,
    "message": "API Key is removed successfully"
}

Instance

WebARENA Indigo allows you to manage Instance.












Request Headers

Authorization: Bearer {accessToken}

Instance Type List

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


Instance Type List

cURL Example

curl -X GET \
  https://api.customer.jp/webarenaIndigo/v1/vm/instancetypes \
  -H 'Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR' 

Request Headers

Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR

Response Headers

content-type: application/json; 
status: 200 OK

Response Body

{
    "success": true,
    "total": 1,
    "instanceTypes": [
        {
            "id": 1,
            "name": "instance",
            "display_name": "KVM Instance",
            "created_at": "2019-02-12 22:46:35",
            "updated_at": "2019-02-12 22:46:35"
        }
    ]
}

Get region list

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

Get region list

cURL Example

curl -X GET \
  https://api.customer.jp/webarenaIndigo/v1/vm/getregion?instanceTypeId=1 \
  -H 'Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR' 

Request Headers

Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR

Response Headers

content-type: application/json; 
status: 200 OK

Response Body

{
    "success": true,
    "total": 2,
    "regionlist": [
        {
            "id": 1,
            "name": "Tokyo",
            "use_possible_date": "2018-09-30 12:00:00"
        },
        {
            "id": 2,
            "name": "Tokyo1",
            "use_possible_date": "2018-12-09 00:00:00"
        }
    ]
}

Get OS list

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


Get OS list

cURL Example

curl -X GET \
  https://api.customer.jp/webarenaIndigo/v1/vm/oslist?instanceTypeId=1 \
  -H 'Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR' 

Request Headers

Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR

Response Headers

content-type: application/json; 
status: 200 OK

Response Body

{
    "success": true,
    "total": 1,
    "osCategory": [
        {
            "id": 1,
            "name": "Ubuntu",
            "logo": "Ubudu.png",
            "osLists": [
                {
                    "id": 1,
                    "categoryid": 1,
                    "name": "Ubuntu18.04",
                    "viewname": "Ubuntu 18.04",
                    "instancetype_id": 1
                }
            ]
        }
    ]
}

Get Instance Specification

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


Get Instance Specification

cURL Example

curl -X GET \
  https://api.customer.jp/webarenaIndigo/v1/vm/getinstancespec?instanceTypeId=1 \
  -H 'Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR' 

Request Headers

Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR

Response Headers

content-type: application/json; 
status: 200 OK

Response Body

{
    "success": true,
    "total": 1,
    "speclist": [
        {
            "id": 1,
            "name": "2 CPU & 2 GB RAM plan",
            "description": "2 CPU & 2 GB RAM plan",
            "use_possible_date": "2019-01-03 08:50:00",
            "instancetype_id": 1,
            "created_at": "2019-01-04 08:40:57",
            "updated_at": "2019-01-04 08:40:57",
            "instance_type": {
                "id": 1,
                "name": "instance",
                "display_name": "KVM Instance",
                "created_at": "2019-02-12 22:46:35",
                "updated_at": "2019-02-12 22:46:35"
            }
        }
    ]
}

Create Instance

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

Instance Creation

cURL Example

curl -X POST \
  https://api.customer.jp/webarenaIndigo/v1/vm/createinstance \
  -H 'Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR' \
  -d '{
  "sshKeyId": 11,
  "regionId": 1,
  "osId": 1,
  "instancePlan": 1,
  "instanceName": "Centos Dev Env"
}'

Request Headers

Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR

Response Headers

content-type: application/json; 
status: 201 Created

Response Body

{
    "success": true,
    "message": "Instance created  successfully",
    "vms": {
        "id": 3,
        "instance_name": "Centos Dev Env",
        "set_no": 10,
        "vps_kind": "10",
        "sequence_id": 3,
        "user_id": 1,
        "service_id": "wsi-000001",
        "status": "UNUSED",
        "sshkey_id": 1,
        "start_date": {
            "date": "2018-11-10 10:03:17.744562",
            "timezone_type": 3,
            "timezone": "UTC"
        },
        "host_id": 1,
        "plan": "2CR2GB",
        "disk_point": 12,
        "memsize": 2,
        "cpus": 2,
        "os_id": 1,
        "otherstatus": 10,
        "uuid": "9868faef-e658-4880-b4ad-fd3078e51b6a",
        "uidgid": 100003,
        "vnc_port": 10003,
        "vnc_passwd": "fHTsl4EoLfMksYKW",
        "arpaname": "192-168-0-3.pro.static.arena.ne.jp",
        "arpadate": "",
        "status_change_date": {
            "date": "2018-11-10 10:03:17.746562",
            "timezone_type": 3,
            "timezone": "UTC"
        },
        "updated_at": null,
        "vm_revert": 0
    }
}

Get Instance list

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


Get Instance list

cURL Example

curl -X GET \
  https://api.customer.jp/webarenaIndigo/v1/vm/getinstancelist \
  -H 'Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR'  

Request Headers

Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR

Response Headers

content-type: application/json; 
status: 200 OK

Response Body

[
    {
        "id": 20,
        "instance_name": "Centos Dev Env",
        "set_no": 10,
        "vps_kind": 10,
        "sequence_id": 20,
        "user_id": 18,
        "service_id": "wsi-000200",
        "status": "UNUSED",
        "sshkey_id": 5,
        "start_date": "2018-11-07 17:11:21",
        "host_id": 2,
        "plan": "2CR2GB",
        "disk_point": 12,
        "memsize": 2,
        "cpus": 2,
        "os_id": 1,
        "otherstatus": 10,
        "uuid": "92fa4815-1ec1-403b-93bc-514a11dfeb56",
        "uidgid": 100001,
        "vnc_port": 10001,
        "vnc_passwd": "6z2d9ngprQuxofs6",
        "arpaname": "192-168-0-20.pro.static.arena.ne.jp",
        "arpadate": 0,
        "status_change_date": "2018-11-07 17:11:21",
        "updated_at": null,
        "vm_revert": 0,
        "VEID": "10100000000020",
        "os": {
            "id": 1,
            "name": "CentOS6.6",
            "viewname": "CentOS 6.6"
        },
        "ip": "192.168.0.20"
    },
    {
        "id": 19,
        "instance_name": "Centos Dev Env",
        "set_no": 10,
        "vps_kind": 10,
        "sequence_id": 19,
        "user_id": 18,
        "service_id": "wsi-000200",
        "status": "UNUSED",
        "sshkey_id": 11,
        "start_date": "2018-11-07 17:11:08",
        "host_id": 2,
        "plan": "2CR2GB",
        "disk_point": 12,
        "memsize": 2,
        "cpus": 2,
        "os_id": 1,
        "otherstatus": 10,
        "uuid": "372827ec-0946-494f-911c-fbb0bceba399",
        "uidgid": 100001,
        "vnc_port": 10001,
        "vnc_passwd": "GXr3VkGhGofT3yf8",
        "arpaname": "192-168-0-19.pro.static.arena.ne.jp",
        "arpadate": 0,
        "status_change_date": "2018-11-07 17:11:08",
        "updated_at": null,
        "vm_revert": 0,
        "VEID": "10100000000019",
        "os": {
            "id": 1,
            "name": "CentOS6.6",
            "viewname": "CentOS 6.6"
        },
        "ip": "192.168.0.19"
    }]

Update Instance Status

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

Update Instance Status

cURL Example

curl -X POST \
  https://api.customer.jp/webarenaIndigo/v1/vm/instance/statusupdate \
  -H 'Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR' \
  -d '{"instanceId":"16","status":"stop"}'

Request Headers

Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR

Response Headers

content-type: application/json; 
status: 200 Ok

Response Body

{
    "success": true,
    "message": "Instance has stopped successfully ",
    "sucessCode": "I20009",
    "instanceStatus": "shutoff"
}

Firewall

WebARENA Indigo allows you to manage Firewall.












Request Headers

Authorization: Bearer {accessToken}

Create Firewall

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

Create Firewall

cURL Example

curl -X POST \
  https://api.customer.jp/webarenaIndigo/v1/nw/createfirewall \
  -H 'Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR' \
  -d '{
    "name":"Example",
    "inbound":[
        {"type":"HTTP","protocol":"TCP","port":"80","source":"0.0.0.0"},
        {"type":"HTTPS","protocol":"TCP","port":"443","source":"0.0.0.0"}
    ],
    "outbound":[
        {"type":"HTTP","protocol":"TCP","port":"80","source":"0.0.0.0"},
        {"type":"HTTPS","protocol":"TCP","port":"443","source":"0.0.0.0"}
    ],
    "instances":["6","5"]
}'

Request Headers

Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR

Response Headers

content-type: application/json; 
status: 200 OK

Response Body

{
    "success": true,
    "message": "Firewall template has been created successfully.",
    "sucessCode": "F60002",
    "firewallId": 55
}

Get Firewall list

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


Get Firewall list

cURL Example

curl -X GET \
  https://api.customer.jp/webarenaIndigo/v1/nw/getfirewalllist \
  -H 'Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR'  

Request Headers

Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR

Response Headers

content-type: application/json; 
status: 200 OK

Response Body

[
    {
        "id": 55,
        "service_id": "wsi-00003",
        "user_id": 6,
        "name": "Example",
        "status": 1,
        "created_at": "2018-11-14 10:35:33",
        "updated_at": "2018-11-14 10:35:33"
    },
    {
        "id": 47,
        "service_id": "wsi-00003",
        "user_id": 6,
        "name": "Example2",
        "status": 1,
        "created_at": "2018-10-30 10:07:46",
        "updated_at": "2018-11-05 04:54:15"
    }]

Retrieve firewall

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


Retrieve firewall

cURL Example

curl -X GET \
  https://api.customer.jp/webarenaIndigo/v1/nw/gettemplate/55 \
  -H 'Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR'  

Request Headers

Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR

Response Headers

content-type: application/json;
status: 200 OK

Response Body

{
    "id": 55,
    "name": "Example",
    "direction": "in",
    "type": "HTTP",
    "protocol": "TCP",
    "port": "80",
    "source": "0.0.0.0"
},
{
    "id": 55,
    "name": "Example",
    "direction": "in",
    "type": "HTTPS",
    "protocol": "TCP",
    "port": "443",
    "source": "0.0.0.0"
},
{
    "id": 55,
    "name": "Example",
    "direction": "out",
    "type": "HTTP",
    "protocol": "TCP",
    "port": "80",
    "source": "0.0.0.0"
},
{
    "id": 55,
    "name": "Example",
    "direction": "out",
    "type": "HTTPS",
    "protocol": "TCP",
    "port": "443",
    "source": "0.0.0.0"
}

Update Firewall

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

Update Firewall

cURL Example

curl -X PUT \
  https://api.customer.jp/webarenaIndigo/v1/nw/updatefirewall \
  -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjNiZjI5MWU4NmMyMTY4ZTMxN2U2OTViMGFmYjI3MzBjYzUwZWFiYjg4MzIwZmQzMTcwY2FhYjE5ZDRjNzZmMDlkYzAyZWI4YTU1ZTYyN2Q0In0.eyJhdWQiOiJjbGllbnQxIiwianRpIjoiM2JmMjkxZTg2YzIxNjhlMzE3ZTY5NWIwYWZiMjczMGNjNTBlYWJiODgzMjBmZDMxNzBjYWFiMTlkNGM3NmYwOWRjMDJlYjhhNTVlNjI3ZDQiLCJpYXQiOjE1NDE1NjY2MjIsIm5iZiI6MTU0MTU2NjYyMiwiZXhwIjoxNTQxNjUzMDIyLCJzdWIiOiIxNzEiLCJzY29wZXMiOltdfQ.efsYC4sJx1Arms5qwuBf5tbBjGxJ1Ep_p6XYSf9ugO8PiZECmPcl4p3MaqPs_Loxz_EcQODGqIKSF3w0KBpf-gC9vGD4G_4pikGgpsRcmvsvJ64X5K1p_WOI_v_REUo3adW7Gu4QXyDeEjiAGesl23dSi0C4EZHQ2x7L7joGAzkS0cWASWrM7H3cOKIlXDVtqh8fdykSkxXghx504SSiDzObXt28VnFY4fRvqKawe2-vMvG5EmZgAejriyPIS8nbrd2gnlLCaBTD96u4qz05w4MRtgPPWSfQ8e6sYMavXGau8D60KSyTstJyVV3AKX5GY5ESD15Ikt4tSIWlk8BbdNovnkGx8oKv_rkDEY1thWu_40Jgf7plUQ9ox_kf1kbhhj-YXSxfpQFT_tLFIaM3Ntb-FhfFlaw37OhC93B79Bq0J3RbQO7qw3hPKaIb0AdTL_iYjU2IKUUZ6Sr--GuZiqWW5Ls-L4OTkl7NyNc0G8ZJk5Pibavgp91B1Do5jpVS43IsuQGKmVfLRqJc-mR5RR3FmbKaGvj3ULvxN9kYYeP2e98bcHIBmkWhMgkuaZqUFrgTdq6a9fc0vhUZTmNVINGjCA6BLCixTrQfZ_eAtIam2jW4TGZB0yuQuLNa-yKx_Sop6rwVv-y9U7H-gvXE5G-K7lIXd0-Lz-sROhKMwtA' \
  -d '{
    "templateid":"55",
    "name":"Example",
    "inbound":[
        {"type":"HTTP","protocol":"TCP","port":"80","source":"0.0.0.0"},
        {"type":"HTTPS","protocol":"TCP","port":"443","source":"0.0.0.0"}
    ],
    "outbound":[
        {"type":"HTTP","protocol":"TCP","port":"80","source":"0.0.0.0"},
        {"type":"HTTPS","protocol":"TCP","port":"443","source":"0.0.0.0"}
    ],
    "instances":["6","5"]
}'

Request Headers

Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR

Response Headers

content-type: application/json; 
status: 200 OK

Response Body

{
    "success": true,
    "message": "Firewall template is updated successfully.",
    "sucessCode": "F6004",
    "firewallId": 55
}

Assign Firewall

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

Assign Firewall

cURL Example

curl -X POST \
  https://api.customer.jp/webarenaIndigo/v1/nw/assign \
  -H 'Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR' \
  -d '{
      "instanceid":"4",
      "templateid":"8"
      }'

Request Headers

Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR

Response Headers

content-type: application/json; 
status: 200 OK

Response Body

{
    "success": true,
    "message": "Firewall template is assigned successfully.",
    "sucessCode": "F60003"
}

Delete Firewall

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


Delete Firewall

cURL Example

curl -X DELETE \
  https://api.customer.jp/webarenaIndigo/v1/nw/deletefirewall/30 \
  -H 'Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR' \
  

Request Headers

Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR

Response Headers

content-type: application/json; 
status: 200 OK

Response Body

{
    "success": true,
    "message": "Firewall template has been deleted successfully.",
    "sucessCode": "F6005"
}

Snapshot

WebARENA Indigo allows you to manage Snapshots.












Request Headers

Authorization: Bearer {accessToken}

Snapshot Creation

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

Snapshot Creation

cURL Example

curl -X POST \
  https://api.customer.jp/webarenaIndigo/v1/disk/takesnapshot \
  -H 'Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR' \
  -d '{"name":"Example", "instanceid":12, "slotnum":"0"}'

Request Headers

Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR

Response Headers

content-type: application/json; 
status: 200 Created

Response Body

{"STATUS":0}

Snapshot list

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


Snapshot list

cURL Example

curl -X GET \
  https://api.customer.jp/webarenaIndigo/v1/disk/snapshotlist/{instanceid} \
  -H 'Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR'  

Request Headers

Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR

Response Headers

content-type: application/json; 
status: 200 OK

Response Body

[
    {
        "id": 3,
        "name": "Example",
        "service_id": "wsi-000401",
        "user_id": "134",
        "disk_id": 29,
        "volume": 1,
        "slot_number": 0,
        "status": "created",
        "size": "2000",
        "deleted": 0,
        "completed_timestamp": "2018-11-27 07:24:05",
        "deleted_timestamp": "0000-00-00 00:00:00"
    },
    {
        "id": 8,
        "name": "Example2",
        "service_id": "wsi-000401",
        "user_id": "134",
        "disk_id": 29,
        "volume": 2,
        "slot_number": 0,
        "status": "failed",
        "size": "2000",
        "deleted": 0,
        "completed_timestamp": "2018-11-27 10:43:22",
        "deleted_timestamp": "0000-00-00 00:00:00"
    }
]

Retry to create snapshot

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

Retry to create snapshot

cURL Example

curl -X POST \
  https://api.customer.jp/webarenaIndigo/v1/disk/retakesnapshot \
  -H 'Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR' \
  -d '{"instanceid":12, "snapshotid":"11"}'

Request Headers

Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR

Response Headers

content-type: application/json; 
status: 200 Created

Response Body

{"STATUS":0}

Restore snapshot

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

Restore snapshot

cURL Example

curl -X POST \
  https://api.customer.jp/webarenaIndigo/v1/disk/restoresnapshot \
  -H 'Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR' \
  -d '{"instanceid":"12", "snapshotid":"12"}'

Request Headers

Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR

Response Headers

content-type: application/json; 
status: 200 Created

Response Body

{"STATUS":0}

Delete snapshot

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


Delete snapshot

cURL Example

curl -X DELETE \
  https://api.customer.jp/webarenaIndigo/v1/disk/deletesnapshot/10 \
  -H 'Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR' \
  

Request Headers

Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR

Response Headers

content-type: application/json; 
status: 200 Created

Response Body

{"STATUS":0}

DNS

WebARENA Indigo allows you to manage DNS.












Request Headers

Authorization: Bearer {accessToken}

Add Domain

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


Request Body
Name Type Description Required
domain_name String Domain Name true

Add Domain

cURL Example

curl -X POST \
  https://api.customer.jp/webarenaIndigo/v1/dns/registerdomain \
  -H 'Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR' \
  -d '{"domain_name":"example.com"}'

Request Headers

Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR

Response Headers

content-type: application/json; 
status: 200 OK

Response Body

{
    "success": true,
    "message": "Domain added successfully",
    "sucessCode": "D80002",
    "zoneId": 26
}

Domain List

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


Domain List

cURL Example

curl -X GET \
  https://api.customer.jp/webarenaIndigo/v1/dns/getdomainlist \
  -H 'Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR' 

Request Headers

Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR

Response Headers

content-type: application/json; 
status: 200 OK

Response Body

[
    {
        "id": 26,
        "zone": "example.com",
        "zone_id": 0,
        "verify_status": "Verification Pending",
        "verify_type": "",
        "verify_token": "",
        "user_id": 128,
        "service_id": "wsi-000403",
        "deleted": 0,
        "created_at": "2019-02-28 10:03:25",
        "verified_at": "2019-02-28 11:03:05",
        "deleted_at": null
    },
    {
        "id": 1,
        "zone": "example2.com",
        "zone_id": 10222,
        "verify_status": "Verification Completed",
        "verify_type": "NS",
        "verify_token": "adth6koxedhw8qvqhwyk2o4.customer.ne.jp",
        "user_id": 128,
        "service_id": "wsi-000403",
        "deleted": 0,
        "created_at": "2019-02-28 06:03:18",
        "verified_at": "2019-02-28 07:03:05",
        "deleted_at": null
    }
]

Get Domain

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


Get Domain

cURL Example

curl -X GET \
  https://api.customer.jp/webarenaIndigo/v1/dns/getdomainrecord/26 \
  -H 'Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR'  

Request Headers

Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR

Response Headers

content-type: application/json; 
status: 200 OK

Response Body

{
    "id": 43,
    "zone": "example.com",
    "zone_id": 102756,
    "verify_status": "Verification Completed",
    "verify_type": "NS",
    "verify_token": "w9edpa2il9gown45719zjq1bv96yzl.customer.ne.jp",
    "user_id": 128,
    "service_id": "wsi-000403",
    "deleted": 0,
    "created_at": "2019-03-01 05:17:34",
    "verified_at": "2019-03-01 11:03:05",
    "deleted_at": null
}

Cancel Domain

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


Cancel Domain

cURL Example

curl -X DELETE \
  https://api.customer.jp/webarenaIndigo/v1/dns/canceldomain/26 \
  -H 'Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR'  

Request Headers

Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR

Response Headers

content-type: application/json;
status: 200 OK

Response Body

{
    "success": true,
    "message": "Domain cancelled successfully.",
    "sucessCode": "D80003"
}

Generate Domain Verification Token

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

Generate Domain Verification Token

cURL Example

curl -X POST \
  https://api.customer.jp/webarenaIndigo/v1/dns/domainverificationtoken \
  -H 'Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR' \
  -d '{"zoneid":"29", "verifytype":"NS"}'

Request Headers

Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR

Response Headers

content-type: application/json; 
status: 200 OK

Response Body

o6j5brpsjbnjdsu7wzvo8ub0j05akk.customer.ne.jp

Cancel Verification Token

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


Cancel Verification Token

cURL Example

curl -X DELETE \
  https://api.customer.jp/webarenaIndigo/v1/dns/canceldomainverification/26 \
  -H 'Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR' 

Request Headers

Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR

Response Headers

content-type: application/json;
status: 200 OK

Response Body

{
    "success": true,
    "message": "Domain verification cancelled successfully.",
    "sucessCode": "D80024"
}

Domain Verification

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


Domain Verification

cURL Example

curl -X GET \
  https://api.customer.jp/webarenaIndigo/v1/dns/domainverification/26 \
  -H 'Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR' 

Request Headers

Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR

Response Headers

content-type: application/json; 
status: 200 OK

Response Body

{
    "success": true,
    "message": "Domain verification completed successfully",
    "sucessCode": "D80018",
    "DNSZoneId": "102756",
    "type": "NS"
}

Get Domain DNS Records

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


Get Domain DNS Records

cURL Example

curl -X GET \
  https://api.customer.jp/webarenaIndigo/v1/dns/editdomain/26 \
  -H 'Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR' 

Request Headers

Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR

Response Headers

content-type: application/json; 
status: 200 OK

Response Body

{
    "zone_records": [
        {
            "value": [
                {
                    "minimum": "3600",
                    "serial": "1551174766",
                    "mname": "test-asns1.customer.ne.jp",
                    "retry": "1800",
                    "refresh": "3600",
                    "rname": "example@gmail.com",
                    "expire": "3628800"
                }
            ],
            "ttl": 86400,
            "name": "example.com",
            "class": "IN",
            "type": "SOA"
        },
        {
            "value": [
                {
                    "nsdname": "test-asns1.customer.ne.jp"
                },
                {
                    "nsdname": "test-asns2.customer.ne.jp"
                }
            ],
            "ttl": 86400,
            "name": "example.com",
            "class": "IN",
            "type": "NS"
        },
        {
            "value": [
                {
                    "preference": "10",
                    "exchange": "1600.7218.com"
                }
            ],
            "ttl": 500,
            "name": "2202.example.com",
            "class": "IN",
            "type": "MX"
        },
        {
            "value": [
                {
                    "address": "fe80:0:0:0:202:b3ff:fe1e:8329"
                }
            ],
            "ttl": 500,
            "name": "376.example.com",
            "class": "IN",
            "type": "AAAA"
        },
        {
            "value": [
                {
                    "nsdname": "3743.com"
                }
            ],
            "ttl": 500,
            "name": "784.example.com",
            "class": "IN",
            "type": "NS"
        },
        {
            "value": [
                {
                    "address": "192.168.0.11"
                },
                {
                    "address": "192.168.1.2"
                }
            ],
            "ttl": 500,
            "name": "805.example.com",
            "class": "IN",
            "type": "A"
        },
        {
            "value": [
                {
                    "priority": "10",
                    "port": "80",
                    "target": "2001.example.com",
                    "weight": "10"
                }
            ],
            "ttl": 500,
            "name": "8411.example.com",
            "class": "IN",
            "type": "SRV"
        },
        {
            "value": [
                {
                    "txtdata": [
                        "8585"
                    ]
                }
            ],
            "ttl": 500,
            "name": "8533.example.com",
            "class": "IN",
            "type": "TXT"
        },
        {
            "value": [
                {
                    "cname": "7331.com"
                }
            ],
            "ttl": 500,
            "name": "9782.example.com",
            "class": "IN",
            "type": "CNAME"
        }
    ]
}

Get TTL List

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


Get TTL List

cURL Example

curl -X GET \
  https://api.customer.jp/webarenaIndigo/v1/dns/getttl \
  -H 'Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR' 

Request Headers

Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR

Response Headers

content-type: application/json; 
status: 200 OK

Response Body

[
    {
        "id": 1,
        "name": "5 Minutes",
        "value": 300
    },
    {
        "id": 2,
        "name": "15 Minutes",
        "value": 900
    },
    {
        "id": 3,
        "name": "30 Minutes",
        "value": 1800
    },
    {
        "id": 4,
        "name": "1 Hour",
        "value": 3600
    },
    {
        "id": 5,
        "name": "4 Hours",
        "value": 14400
    },
    {
        "id": 6,
        "name": "8 Hours",
        "value": 28800
    },
    {
        "id": 7,
        "name": "12 Hours",
        "value": 43200
    },
    {
        "id": 8,
        "name": "1 Day",
        "value": 86400
    },
    {
        "id": 9,
        "name": "1 Week",
        "value": 604800
    }
]

Add A Record

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

Add A Record

cURL Example

curl -X POST \
  https://api.customer.jp/webarenaIndigo/v1/dns/addARecord \
  -H 'Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR' \
  -d '{"zone_id":"24513", "domain_name":"example.com", "host_name":"dev", "address":["192.168.0.11","192.168.1.2"], "ttl":"600"}'

Request Headers

Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR

Response Headers

content-type: application/json; 
status: 200 OK

Response Body

{
    "success": true,
    "message": "A record added successfully.",
    "sucessCode": "D80005"
}

Update A Record

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

Update A Record

cURL Example

curl -X PUT \
  https://api.customer.jp/webarenaIndigo/v1/dns/updateARecord \
  -H 'Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR' \
  -d '{"zone_id":"102756", "domain_name":"example.com", "host_name":"dev", "address":["192.168.0.11","192.168.1.12"], "ttl":"600"}'

Request Headers

Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR

Response Headers

content-type: application/json; 
status: 200 OK

Response Body

{
    "success": true,
    "message": "A record updated successfully.",
    "sucessCode": "D80004"
}

Add AAAA Record

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

Add AAAA Record

cURL Example

curl -X POST \
  https://api.customer.jp/webarenaIndigo/v1/dns/addAAAARecord \
  -H 'Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR' \
  -d '{"zone_id":"24513", "domain_name":"example.com", "host_name":"dev", "address":"FE80:0000:0000:0000:0202:B3FF:FE1E:8329", "ttl":"600"}'

Request Headers

Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR

Response Headers

content-type: application/json; 
status: 200 OK

Response Body

{
    "success": true,
    "message": "AAAA record added successfully.",
    "sucessCode": "D80007"
}

Update AAAA Record

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

Update AAAA Record

cURL Example

curl -X PUT \
  https://api.customer.jp/webarenaIndigo/v1/dns/updateAAAARecord \
  -H 'Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR' \
  -d '{"zone_id":"24513", "domain_name":"example.com", "host_name":"dev", "address":"FE80:0000:0000:0000:0202:B3FF:FE1E:8329", "ttl":"600"}'

Request Headers

Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR

Response Headers

content-type: application/json; 
status: 200 OK

Response Body

{
    "success": true,
    "message": "AAAA record updated successfully.",
    "sucessCode": "D80008"
}

Add CNAME Record

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

Add CNAME Record

cURL Example

curl -X POST \
  https://api.customer.jp/webarenaIndigo/v1/dns/addCNAMERecord \
  -H 'Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR' \
  -d '{"zone_id":"102756", "domain_name":"example.com", "host_name":"dev", "host_name_alias":"test.com", "ttl":"600"}'

Request Headers

Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR

Response Headers

content-type: application/json; 
status: 200 OK

Response Body

{
    "success": true,
    "message": "CNAME record added successfully.",
    "sucessCode": "D80022"
}

Update CNAME Record

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

Update CNAME Record

cURL Example

curl -X PUT \
  https://api.customer.jp/webarenaIndigo/v1/dns/updateCNAMERecord \
  -H 'Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR' \
  -d '{"zone_id":"102756", "domain_name":"example.com", "host_name":"www", "host_name_alias":"test.com", "ttl":"600"}'

Request Headers

Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR

Response Headers

content-type: application/json; 
status: 200 OK

Response Body

{
    "success": true,
    "message": "CNAME record updated successfully.",
    "sucessCode": "D80023"
}

Add MX Record

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

Add MX Record

cURL Example

curl -X POST \
  https://api.customer.jp/webarenaIndigo/v1/dns/addMXRecord \
  -H 'Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR' \
  -d '{"zone_id":"102756", "domain_name":"example.com", "host_name":"www", "mail_server":"mail.example.com", "priority":"100", "ttl":"600"}'

Request Headers

Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR

Response Headers

content-type: application/json; 
status: 200 OK

Response Body

{
    "success": true,
    "message": "MX record added successfully.",
    "sucessCode": "D80010"
}

Update MX Record

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

Update MX Record

cURL Example

curl -X PUT \
  https://api.customer.jp/webarenaIndigo/v1/dns/updateMXRecord \
  -H 'Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR' \
  -d '{"zone_id":"102756", "domain_name":"example.com", "host_name":"www", "mail_server":"mail.example.com", "priority":"100", "ttl":"600"}'

Request Headers

Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR

Response Headers

content-type: application/json; 
status: 200 OK

Response Body

{
    "success": true,
    "message": "MX record updated successfully.",
    "sucessCode": "D80011"
}

Add TXT Record

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

Add TXT Record

cURL Example

curl -X POST \
  https://api.customer.jp/webarenaIndigo/v1/dns/addTXTRecord \
  -H 'Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR' \
  -d '{"zone_id":"102756", "domain_name":"example.com", "host_name":"www", "txt_value":"100", "ttl":"600"}'

Request Headers

Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR

Response Headers

content-type: application/json; 
status: 200 OK

Response Body

{
    "success": true,
    "message": "TXT record added successfully.",
    "sucessCode": "D80013"
}

Update TXT Record

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

Update TXT Record

cURL Example

curl -X PUT \
  https://api.customer.jp/webarenaIndigo/v1/dns/updateTXTRecord \
  -H 'Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR' \
  -d '{"zone_id":"102756", "domain_name":"example.com", "host_name":"www", "txt_value":"100", "ttl":"600"}'

Request Headers

Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR

Response Headers

content-type: application/json; 
status: 200 OK

Response Body

{
    "success": true,
    "message": "TXT record updated successfully.",
    "sucessCode": "D80014"
}

Add NS Record

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

Add NS Record

cURL Example

curl -X POST \
  https://api.customer.jp/webarenaIndigo/v1/dns/addNSRecord \
  -H 'Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR' \
  -d '{"zone_id":"102756", "domain_name":"example.com", "host_name":"www", "to_server":["example1.com","example2.com"], "ttl":"600"}'

Request Headers

Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR

Response Headers

content-type: application/json; 
status: 200 OK

Response Body

{
    "success": true,
    "message": "NS record added successfully.",
    "sucessCode": "D80016"
}

Update NS Record

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

Update NS Record

cURL Example

curl -X PUT \
  https://api.customer.jp/webarenaIndigo/v1/dns/updateNSRecord \
  -H 'Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR' \
  -d '{"zone_id":"102756", "domain_name":"example.com", "host_name":"www", "to_server":["example1.com","example2.com"], "ttl":"600"}'

Request Headers

Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR

Response Headers

content-type: application/json; 
status: 200 OK

Response Body

{
    "success": true,
    "message": "NS record updated successfully.",
    "sucessCode": "D80017"
}

Add SRV Record

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

Add SRV Record

cURL Example

curl -X POST \
  https://api.customer.jp/webarenaIndigo/v1/dns/addSRVRecord \
  -H 'Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR' \
  -d '{"zone_id":"102756", "domain_name":"example.com", "host_name":"www", "priority":10,"target":"app2.","weight":50,"port":80, "ttl":"600"}'

Request Headers

Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR

Response Headers

content-type: application/json; 
status: 200 OK

Response Body

{
    "success": true,
    "message": "SRV record added successfully.",
    "sucessCode": "D80019"
}

Update SRV Record

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

Update SRV Record

cURL Example

curl -X PUT \
  https://api.customer.jp/webarenaIndigo/v1/dns/updateSRVRecord \
  -H 'Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR' \
  -d '{"zone_id":"102756", "domain_name":"example.com", "host_name":"www1", "priority":10,"target":"app2.","weight":50,"port":80, "ttl":"600"}'

Request Headers

Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR

Response Headers

content-type: application/json;
status: 200 OK

Response Body

{
    "success": true,
    "message": "SRV record updated successfully.",
    "sucessCode": "D80020"
}

Delete DNS Record

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

Delete DNS Record

cURL Example

curl -X DELETE \
  https://api.customer.jp/webarenaIndigo/v1/dns/deleteNSRecord \
  -H 'Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR' \
  -d '{"zone_id":"102756", "domain_name":"example.com", "host_name":"www", "type":"A"}'

Request Headers

Authorization: Bearer HnGma03YnFPIF4DMttywiSOCGUHR

Response Headers

content-type: application/json; 
status: 200 OK

Response Body

{
    "success": true,
    "message": "A record deleted successfully.",
    "sucessCode": "D80006"
}