Instances – IDrive® Compute

Instances are virtual machines (VMs) or servers hosted on hardware resources that are managed by IDrive® Compute. You can create and customize multiple instances configured with an OS of your choice.

List of Instances

`GET`	https://la3.servers.api.idrivecompute.io/v2.1/servers
`X-Auth-Token`	Provide a valid authentication token

Request Samples

curl -H "X-Auth-Token: ${TOKEN}" \
    -X GET \
    https://la3.servers.api.idrivecompute.io/v2.1/servers/detail

Response Samples

{
  "servers_links": [
    {
      "href": "http://la3.servers.api.idrivecompute.io/v2.1/servers/detail?limit=2
       &marker=06ad3719-8c04-453c-b8d4-3b7dcc5b4fed",
      "rel": "next"
    }
  ],
  "servers": [
    {
      "OS-EXT-STS:task_state": null,
      "addresses": {
        "provider.public": [
          {
            "OS-EXT-IPS-MAC:mac_addr": "fa:16:3e:c5:c1:aa",
            "version": 6,
            "addr": "2606:6e00:8000:3:f816:3eff:fec5:c1aa",
            "OS-EXT-IPS:type": "fixed"
          },
          {
            "OS-EXT-IPS-MAC:mac_addr": "fa:16:3e:c5:c1:aa",
            "version": 4,
            "addr": "72.26.117.57",
            "OS-EXT-IPS:type": "fixed"
          }
        ]
      },
      "links": [
        {
          "href": "http://la3.servers.api.idrivecompute.io/v2.1/servers/
           d55c2044-d826-4d28-a295-e37be5519dea",
          "rel": "self"
        },
        {
          "href": "http://la3.servers.api.idrivecompute.io/servers/
           d55c2044-d826-4d28-a295-e37be5519dea",
          "rel": "bookmark"
        }
      ],
      "image": {
        "id": "07d43880-1df9-49ae-a89e-81e7033bbbcb",
        "links": [
          {
            "href": "http://la3.servers.api.idrivecompute.io/images/
             07d43880-1df9-49ae-a89e-81e7033bbbcb",
            "rel": "bookmark"
          }
        ]
      },
      "OS-EXT-STS:vm_state": "active",
      "OS-SRV-USG:launched_at": "2022-10-10T07:08:11.000000",
      "flavor": {
        "id": "1468c56b-a5e4-4d84-8b2c-ded1dd22792d",
        "links": [
          {
            "href": "http://la3.servers.api.idrivecompute.io/flavors/
             1468c56b-a5e4-4d84-8b2c-ded1dd22792d",
            "rel": "bookmark"
          }
        ]
      },
      "id": "d55c2044-d826-4d28-a295-e37be5519dea",
      "security_groups": [
        {
          "name": "default"
        }
      ],
      "user_id": "191931bc755f410784fe42594c8e588d",
      "OS-DCF:diskConfig": "MANUAL",
      "accessIPv4": "",
      "accessIPv6": "",
      "progress": 0,
      "OS-EXT-STS:power_state": 1,
      "OS-EXT-AZ:availability_zone": "nova",
      "config_drive": "",
      "status": "ACTIVE",
      "updated": "2022-10-10T08:08:23Z",
      "hostId": "078144db3ecf174253810238458aae18e05b5ecb8b3edfb117a69598",
      "OS-SRV-USG:terminated_at": null,
      "key_name": null,
      "name": "my-server",
      "created": "2022-10-10T05:39:41Z",
      "tenant_id": "b88176b3de3f4771aa183e8bd7e1edc7",
      "os-extended-volumes:volumes_attached": [],
      "metadata": {}
    },
    {
      "OS-EXT-STS:task_state": null,
      "addresses": {
        "provider.public": [
          {
            "OS-EXT-IPS-MAC:mac_addr": "fa:16:3e:ef:5a:8f",
            "version": 6,
            "addr": "2606:6e00:8000:3:f816:3eff:feef:5a8f",
            "OS-EXT-IPS:type": "fixed"
          },
          {
            "OS-EXT-IPS-MAC:mac_addr": "fa:16:3e:ef:5a:8f",
            "version": 4,
            "addr": "72.26.117.23",
            "OS-EXT-IPS:type": "fixed"
          }
        ]
      },
      "links": [
        {
          "href": "http://la3.servers.api.idrivecompute.io/v2.1/servers/
           06ad3719-8c04-453c-b8d4-3b7dcc5b4fed",
          "rel": "self"
        },
        {
          "href": "http://la3.servers.api.idrivecompute.io/servers/
           06ad3719-8c04-453c-b8d4-3b7dcc5b4fed",
          "rel": "bookmark"
        }
      ],
      "image": {
        "id": "099f4835-575f-41d8-b287-ed12fdcf0c17",
        "links": [
          {
            "href": "http://la3.servers.api.idrivecompute.io/images/
             099f4835-575f-41d8-b287-ed12fdcf0c17",
            "rel": "bookmark"
          }
        ]
      },
      "OS-EXT-STS:vm_state": "active",
      "OS-SRV-USG:launched_at": "2022-10-07T08:35:25.000000",
      "flavor": {
        "id": "1468c56b-a5e4-4d84-8b2c-ded1dd22792d",
        "links": [
          {
            "href": "http://la3.servers.api.idrivecompute.io/flavors/
             1468c56b-a5e4-4d84-8b2c-ded1dd22792d",
            "rel": "bookmark"
          }
        ]
      },
      "id": "06ad3719-8c04-453c-b8d4-3b7dcc5b4fed",
      "security_groups": [
        {
          "name": "default"
        }
      ],
      "user_id": "191931bc755f410784fe42594c8e588d",
      "OS-DCF:diskConfig": "MANUAL",
      "accessIPv4": "",
      "accessIPv6": "",
      "progress": 0,
      "OS-EXT-STS:power_state": 1,
      "OS-EXT-AZ:availability_zone": "nova",
      "config_drive": "",
      "status": "ACTIVE",
      "updated": "2022-10-07T08:40:01Z",
      "hostId": "171108deac347cd8c5bcbb1ada3d928fa2f4b2d32f96322c330c5177",
      "OS-SRV-USG:terminated_at": null,
      "key_name": null,
      "name": "my-old-server2",
      "created": "2022-10-07T08:35:17Z",
      "tenant_id": "b88176b3de3f4771aa183e8bd7e1edc7",
      "os-extended-volumes:volumes_attached": [],
      "metadata": {}
    }
  ]
}

Create Instance

`POST`	https://la3.servers.api.idrivecompute.io/v2.1/servers
`X-Auth-Token`	X-Auth-Token

Prerequisites

Get the image_id from the list of images
Get the flavor_id from the list of the plans
Get the id of provider.public network from here
Get the security_group_id/firewall_idof default_firewallfrom the list of firewalls
Prepare user-data(optional) using cloud-init

Request Samples

curl -H "X-Auth-Token: ${TOKEN}" \
-H "Content-Type: application/json" \
-H "X-OpenStack-Nova-API-Version: 2.1" \
-X POST \
-d "{
  "server": {
    "name": "myserver-test1",
    "imageRef": "92c1b76b-f7bb-4b03-bbca-2180bfe3a787",
    "flavorRef": "f880292b-03f2-45c9-b126-eeb1d1ebdd52",
    "user_data": "I2Nsb3VkLWNvbm",
    "security_groups": [
      {
        "name": "9a0987de-cb0a-4c76-badb-31f7aabe4a26"
      }
    ],
    "networks": [
      {
        "uuid": "8c670f93-5870-4d25-89ed-f4e8a7feed55"
      }
    ]
  }
}" \
https://la3.servers.api.idrivecompute.io/v2.1/servers

Response Samples

{
  "server": {
    "security_groups": [
      {
        "name": "9a0987de-cb0a-4c76-badb-31f7aabe4a26"
      }
    ],
    "OS-DCF:diskConfig": "MANUAL",
    "id": "e330f226-caa5-405a-ace6-948e508ec6b4",
    "links": [
      {
        "href": "http://la3.servers.api.idrivecompute.io/v2.1/servers/
        e330f226-caa5-405a-ace6-948e508ec6b4",
        "rel": "self"
      },
      {
        "href": "http://la3.servers.api.idrivecompute.io/servers/
        e330f226-caa5-405a-ace6-948e508ec6b4",
        "rel": "bookmark"
      }
    ],
    "adminPass": "6Ao2sbumRn3Z"
  }
}

View Instance Detail

`GET`	https://la3.servers.api.idrivecompute.io/v2.1/servers/{server_id}
`X-Auth-Token`	X-Auth-Token

Request Samples

curl -H "X-Auth-Token: ${TOKEN}" \
    -X GET \
    https://la3.servers.api.idrivecompute.io/v2.1/servers/ea704c4b-c210-4712-9cd2-cfe7f0a2fd14

Response Samples

{
  "server": {
    "OS-EXT-STS:task_state": null,
    "addresses": {
      "provider.public": [
        {
          "OS-EXT-IPS-MAC:mac_addr": "fa:16:3e:76:54:37",
          "version": 6,
          "addr": "2606:6e00:8000:3:f816:3eff:fe76:5437",
          "OS-EXT-IPS:type": "fixed"
        },
        {
          "OS-EXT-IPS-MAC:mac_addr": "fa:16:3e:76:54:37",
          "version": 4,
          "addr": "72.26.117.19",
          "OS-EXT-IPS:type": "fixed"
        }
      ]
    },
    "links": [
      {
        "href": "http://la3.servers.api.idrivecompute.io/v2.1/servers/ea704c4b-c210-4712-9cd2-cfe7f0a2fd14",
        "rel": "self"
      },
      {
        "href": "http://la3.servers.api.idrivecompute.io/servers/ea704c4b-c210-4712-9cd2-cfe7f0a2fd14",
        "rel": "bookmark"
      }
    ],
    "image": {
      "id": "099f4835-575f-41d8-b287-ed12fdcf0c17",
      "links": [
        {
          "href": "http://la3.servers.api.idrivecompute.io/images/099f4835-575f-41d8-b287-ed12fdcf0c17",
          "rel": "bookmark"
        }
      ]
    },
    "OS-EXT-STS:vm_state": "active",
    "OS-SRV-USG:launched_at": "2022-10-07T07:04:13.000000",
    "flavor": {
      "id": "1468c56b-a5e4-4d84-8b2c-ded1dd22792d",
      "links": [
        {
          "href": "http://la3.servers.api.idrivecompute.io/flavors/1468c56b-a5e4-4d84-8b2c-ded1dd22792d",
          "rel": "bookmark"
        }
      ]
    },
    "id": "ea704c4b-c210-4712-9cd2-cfe7f0a2fd14",
    "security_groups": [
      {
        "name": "default"
      }
    ],
    "user_id": "191931bc755f410784fe42594c8e588d",
    "OS-DCF:diskConfig": "MANUAL",
    "accessIPv4": "",
    "accessIPv6": "",
    "progress": 0,
    "OS-EXT-STS:power_state": 1,
    "OS-EXT-AZ:availability_zone": "nova",
    "config_drive": "",
    "status": "ACTIVE",
    "updated": "2022-10-07T07:04:13Z",
    "hostId": "171108deac347cd8c5bcbb1ada3d928fa2f4b2d32f96322c330c5177",
    "OS-SRV-USG:terminated_at": null,
    "key_name": null,
    "name": "my-server",
    "created": "2022-10-07T07:04:03Z",
    "tenant_id": "b88176b3de3f4771aa183e8bd7e1edc7",
    "os-extended-volumes:volumes_attached": [],
    "metadata": {}
  }
}

Update Instance

`PUT`	https://la3.servers.api.idrivecompute.io/v2.1/servers/{server_id}
`X-Auth-Token`	X-Auth-Token

Request Samples

curl -H "X-Auth-Token: ${TOKEN}" \
    -H "Content-Type: application/json" \
    -X POST \
    -d "{
      "server": {
        "name": "My Web App Server"
      }
    }" \
    https://la3.servers.api.idrivecompute.io/v2.1/servers

Response Samples

{
  "server": {
    "status": "ACTIVE",
    "updated": "2022-10-07T08:37:38Z",
    "hostId": "171108deac347cd8c5bcbb1ada3d928fa2f4b2d32f96322c330c5177",
    "user_id": "191931bc755f410784fe42594c8e588d",
    "name": "My Web App Server",
    "links": [
      {
        "href": "http://la3.servers.api.idrivecompute.io/v2.1/servers/
         06ad3719-8c04-453c-b8d4-3b7dcc5b4fed",
        "rel": "self"
      },
      {
        "href": "http://la3.servers.api.idrivecompute.io/servers/
         06ad3719-8c04-453c-b8d4-3b7dcc5b4fed",
        "rel": "bookmark"
      }
    ],
    "created": "2022-10-07T08:35:17Z",
    "tenant_id": "b88176b3de3f4771aa183e8bd7e1edc7",
    "image": {
      "id": "099f4835-575f-41d8-b287-ed12fdcf0c17",
      "links": [
        {
          "href": "http://la3.servers.api.idrivecompute.io/images/
           099f4835-575f-41d8-b287-ed12fdcf0c17",
          "rel": "bookmark"
        }
      ]
    },
    "OS-DCF:diskConfig": "MANUAL",
    "addresses": {
      "provider.public": [
        {
          "version": 6,
          "addr": "2606:6e00:8000:3:f816:3eff:feef:5a8f"
        },
        {
          "version": 4,
          "addr": "72.26.117.23"
        }
      ]
    },
    "accessIPv4": "",
    "accessIPv6": "",
    "progress": 0,
    "flavor": {
      "id": "1468c56b-a5e4-4d84-8b2c-ded1dd22792d",
      "links": [
        {
          "href": "http://la3.servers.api.idrivecompute.io/flavors/
           1468c56b-a5e4-4d84-8b2c-ded1dd22792d",
          "rel": "bookmark"
        }
      ]
    },
    "id": "06ad3719-8c04-453c-b8d4-3b7dcc5b4fed",
    "metadata": {}
  }
}

Delete Instance

`DELETE`	https://la3.servers.api.idrivecompute.io/v2.1/servers/{server_id}
`X-Auth-Token`	X-Auth-Token

Request Samples

curl -H "X-Auth-Token: ${TOKEN}" \
    -X DELETE \
    https://la3.servers.api.idrivecompute.io/v2.1/servers/06ad3719-8c04-453c-b8d4-3b7dcc5b4fed

Response Samples

The response is empty and returns the HTTP 204 response code in the case of a successful request.

Reboot Instance

`POST`	https://la3.servers.api.idrivecompute.io/v2.1/servers/{server_id}/action
`Authorization`	X-Auth-Token

Request Samples

curl -H "X-Auth-Token: ${TOKEN}" \
    -H "Content-Type: application/json" \
    -X POST \
    -d "{
      "reboot": {
        "type": "HARD"
      }
    }" \
    https://la3.servers.api.idrivecompute.io/v2.1/servers/
    06ad3719-8c04-453c-b8d4-3b7dcc5b4fed/action

Response Samples

The response is empty and returns the HTTP 202 response code in the case of a successful request.

Power-off/Shutdown Instance

`POST`	https://la3.servers.api.idrivecompute.io/v2.1/servers/{server_id}/action
`Authorization`	X-Auth-Token

Request Samples

curl -H "X-Auth-Token: ${TOKEN}" \
    -H "Content-Type: application/json" \
    -X POST \
    -d "{
      "os-stop": null
    }" \
    https://la3.servers.api.idrivecompute.io/v2.1/servers/06ad3719-8c04-453c-b8d4-3b7dcc5b4fed/action

Response Samples

The response is empty and returns the HTTP 202 response code in the case of a successful request.

Start Instance

`POST`	https://la3.servers.api.idrivecompute.io/v2.1/servers/{server_id}/action
`Authorization`	X-Auth-Token

Request Samples

curl -H "X-Auth-Token: ${TOKEN}" \
    -H "Content-Type: application/json" \
    -X POST \
    -d "{
      "os-start": null
    }" \
    https://la3.servers.api.idrivecompute.io/v2.1/servers/06ad3719-8c04-453c-b8d4-3b7dcc5b4fed/action

Response Samples

The response is empty and returns the HTTP 202 response code in the case of a successful request.

Backup Instance

`POST`	https://la3.servers.api.idrivecompute.io/v2.1/servers/{server_id}/action
`X-Auth-Token`	X-Auth-Token

Request Samples

curl -H "X-Auth-Token: ${TOKEN}" \
    -H "Content-Type: application/json" \
    -X POST \
    -d "{
      "createBackup": {
        "name": "new-backup",
        "backup_type": "daily",
        "rotation": "1"
      }
    }" \
    https://la3.servers.api.idrivecompute.io/v2.1/servers/06ad3719-8c04-453c-b8d4-3b7dcc5b4fed/action

Response Samples

{
  "image_id": "0e7761dd-ee98-41f0-ba35-05994e446431"
}

Snapshot Instance

`POST`	https://la3.servers.api.idrivecompute.io/v2.1/servers/{server_id}/action
`X-Auth-Token`	X-Auth-Token

Request Samples

curl -H "X-Auth-Token: ${TOKEN}" \
    -H "Content-Type: application/json" \
    -X POST \
    -d "{
      "createImage": {
        "name": "new-snapshot"
      }
    }" \
    https://la3.servers.api.idrivecompute.io/v2.1/servers/06ad3719-8c04-453c-b8d4-3b7dcc5b4fed/action

Response Samples

{
  "image_id": "0e7761dd-ee98-41f0-ba35-05994e446431"
}

Resize Instance

`POST`	https://la3.servers.api.idrivecompute.io/v2.1/servers/{server_id}/action
`X-Auth-Token`	X-Auth-Token

Request Samples

curl -H "X-Auth-Token: ${TOKEN}" \
    -H "Content-Type: application/json" \
    -X POST \
    -d "{
      "reSize": {
        "flavorRef": "c7fb9c53-8a00-458c-a82f-a765bb1fe6dc"
      }
    }" \
    https://la3.servers.api.idrivecompute.io/v2.1/servers/06ad3719-8c04-453c-b8d4-3b7dcc5b4fed/action

Response Samples

The response is empty and returns the HTTP 202 response code in the case of a successful request.

Confirm Resize Instance

`POST`	https://la3.servers.api.idrivecompute.io/v2.1/servers/{server_id}/action
`X-Auth-Token`	X-Auth-Token

Request Samples

curl -H "X-Auth-Token: ${TOKEN}" \
    -H "Content-Type: application/json" \
    -X POST \
    -d "{
      "confirmResize": null
    }" \
    https://la3.servers.api.idrivecompute.io/v2.1/servers/06ad3719-8c04-453c-b8d4-3b7dcc5b4fed/action

Response Samples

The response is empty and returns the HTTP 202 response code in the case of a successful request.

Rebuild Instance

`POST`	https://la3.servers.api.idrivecompute.io/v2.1/servers/{server_id}/action
`X-Auth-Token`	X-Auth-Token

Request Samples

curl -H "X-Auth-Token: ${TOKEN}" \
    -H "Content-Type: application/json" \
    -X POST \
    -d "{
      "rebuild": {
        "imageRef": "07d43880-1df9-49ae-a89e-81e7033bbbcb"
      }
    }" \
    https://la3.servers.api.idrivecompute.io/v2.1/servers/06ad3719-8c04-453c-b8d4-3b7dcc5b4fed/action

Response Samples

{
  "server": {
    "status": "REBUILD",
    "updated": "2022-10-10T06:12:05Z",
    "hostId": "078144db3ecf174253810238458aae18e05b5ecb8b3edfb117a69598",
    "user_id": "191931bc755f410784fe42594c8e588d",
    "name": "my-server",
    "links": [
      {
        "href": "http://la3.servers.api.idrivecompute.io/v2.1/servers/d55c2044-d826-4d28-a295-e37be5519dea",
        "rel": "self"
      },
      {
        "href": "http://la3.servers.api.idrivecompute.io/servers/d55c2044-d826-4d28-a295-e37be5519dea",
        "rel": "bookmark"
      }
    ],
    "created": "2022-10-10T05:39:41Z",
    "tenant_id": "b88176b3de3f4771aa183e8bd7e1edc7",
    "image": {
      "id": "07d43880-1df9-49ae-a89e-81e7033bbbcb",
      "links": [
        {
          "href": "http://la3.servers.api.idrivecompute.io/images/07d43880-1df9-49ae-a89e-81e7033bbbcb",
          "rel": "bookmark"
        }
      ]
    },
    "adminPass": "Ldzt4mYHLna5",
    "OS-DCF:diskConfig": "MANUAL",
    "addresses": {
      "provider.public": [
        {
          "version": 6,
          "addr": "2606:6e00:8000:3:f816:3eff:fec5:c1aa"
        },
        {
          "version": 4,
          "addr": "72.26.117.57"
        }
      ]
    },
    "accessIPv4": "",
    "accessIPv6": "",
    "progress": 0,
    "flavor": {
      "id": "1468c56b-a5e4-4d84-8b2c-ded1dd22792d",
      "links": [
        {
          "href": "http://la3.servers.api.idrivecompute.io/flavors/1468c56b-a5e4-4d84-8b2c-ded1dd22792d",
          "rel": "bookmark"
        }
      ]
    },
    "id": "d55c2044-d826-4d28-a295-e37be5519dea",
    "metadata": {}
  }
}

Rescue Instance

`POST`	https://la3.servers.api.idrivecompute.io/v2.1/servers/{server_id}/action
`X-Auth-Token`	X-Auth-Token

Request Samples

curl -H "X-Auth-Token: ${TOKEN}" \
    -H "Content-Type: application/json" \
    -X POST \
    -d "{
      "rescue": {
        "rescue_image_ref": "07d43880-1df9-49ae-a89e-81e7033bbbcb"
      }
    }" \
    https://la3.servers.api.idrivecompute.io/v2.1/servers/d55c2044-d826-4d28-a295-e37be5519dea/action

Response Samples

The response is empty and returns the HTTP 200 response code in the case of a successful request.

UnRescue Instance

`POST`	https://la3.servers.api.idrivecompute.io/v2.1/servers/{server_id}/action
`X-Auth-Token`	X-Auth-Token

Request Samples

curl -H "X-Auth-Token: ${TOKEN}" \
    -H "Content-Type: application/json" \
    -X POST \
    -d "{
      "urescue": null
    }" \
    https://la3.servers.api.idrivecompute.io/v2.1/servers/d55c2044-d826-4d28-a295-e37be5519dea/action

Response Samples

The response is empty and returns the HTTP 200 response code in the case of a successful request.

List of Instance Network

`GET`	https://la3.networks.api.idrivecompute.io/v2.0/networks
`X-Auth-Token`	Provide a valid authentication token

Request Samples

curl -H "X-Auth-Token: ${TOKEN}" \
    -X GET \
    https://la3.networks.api.idrivecompute.io/v2.0/networks?router%3Aexternal=True

Response Samples

{
  "networks": [
    {
      "updated_at": "2022-08-02T06:13:15Z",
      "dns_domain": "",
      "revision_number": 5,
      "port_security_enabled": true,
      "id": "8c670f93-5870-4d25-89ed-f4e8a7feed55",
      "router:external": true,
      "availability_zone_hints": [],
      "availability_zones": [
        "nova"
      ],
      "ipv4_address_scope": null,
      "shared": true,
      "project_id": "b7e277b7d53449f9941b9ea61cae99e3",
      "status": "ACTIVE",
      "subnets": [
        "8fc12c74-73dc-4e9d-9bb1-611278463b98",
        "326c610c-d90b-4774-8c91-25ca540f7e1d"
      ],
      "description": "",
      "tags": [],
      "ipv6_address_scope": null,
      "is_default": false,
      "name": "provider.public",
      "admin_state_up": true,
      "tenant_id": "b7e277b7d53449f9941b9ea61cae99e3",
      "created_at": "2021-03-04T07:38:33Z",
      "mtu": 1500
    }
  ]
}