{
  "opencollection": "1.0.0",
  "info": {
    "name": "Exoscale ai-api-key instance API",
    "version": "2.0.0"
  },
  "items": [
    {
      "info": {
        "name": "instance",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Create a Snapshot of a Compute instance",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-{zone}.exoscale.com/v2/instance/:id:create-snapshot",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Create a Snapshot of a Compute instance"
        },
        {
          "info": {
            "name": "Reveal the password used during instance creation or the latest password reset.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-{zone}.exoscale.com/v2/instance/:id:password",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Reveal the password used during instance creation or the latest password reset.\n            This is only available for VMs created against templates having the `password-enabled`\n            property set to `true`.\n\n            Passwords are transiently stored for at most 24 hours and intended to be retrieved shortly after\n            creation or resets."
        },
        {
          "info": {
            "name": "Resize a Compute instance disk",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api-{zone}.exoscale.com/v2/instance/:id:resize-disk",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This operation resizes a Compute instance's disk volume. Note: the disk can only grow, cannot be shrunk."
        },
        {
          "info": {
            "name": "Reset a compute instance password",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api-{zone}.exoscale.com/v2/instance/:id:reset-password",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Reset a compute instance password"
        },
        {
          "info": {
            "name": "Start a Compute instance",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api-{zone}.exoscale.com/v2/instance/:id:start",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This operation starts a virtual machine, potentially using a rescue profile if specified"
        },
        {
          "info": {
            "name": "Enable tpm for the instance.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-{zone}.exoscale.com/v2/instance/:id:enable-tpm",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Enable tpm for the instance."
        },
        {
          "info": {
            "name": "Scale a Compute instance to a new Instance Type",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api-{zone}.exoscale.com/v2/instance/:id:scale",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This operation changes the Compute instance's type. Note: the new Instance Type must be within the same family (e.g. a standard instance cannot be scaled to gpu2 or storage)."
        },
        {
          "info": {
            "name": "Stop a Compute instance",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api-{zone}.exoscale.com/v2/instance/:id:stop",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Stop a Compute instance"
        },
        {
          "info": {
            "name": "Set instance destruction protection",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api-{zone}.exoscale.com/v2/instance/:id:add-protection",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Set instance destruction protection"
        },
        {
          "info": {
            "name": "Reset Instance field",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api-{zone}.exoscale.com/v2/instance/:id/:field",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              },
              {
                "name": "field",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Reset Instance field"
        },
        {
          "info": {
            "name": "Remove instance destruction protection",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api-{zone}.exoscale.com/v2/instance/:id:remove-protection",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Remove instance destruction protection"
        },
        {
          "info": {
            "name": "Reset a Compute instance to a base/target template",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api-{zone}.exoscale.com/v2/instance/:id:reset",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This operation re-installs a Compute instance to a base template. If target template is provided it will be used to recreated instance from. Warning: the operation wipes all data stored on the disk."
        },
        {
          "info": {
            "name": "Retrieve signed url valid for 60 seconds to connect via console-proxy websocket to VM VNC console.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-{zone}.exoscale.com/v2/console/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Retrieve signed url valid for 60 seconds to connect via console-proxy websocket to VM VNC console."
        },
        {
          "info": {
            "name": "Retrieve Compute instance details",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-{zone}.exoscale.com/v2/instance/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Retrieve Compute instance details"
        },
        {
          "info": {
            "name": "Update a Compute instance",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api-{zone}.exoscale.com/v2/instance/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update a Compute instance"
        },
        {
          "info": {
            "name": "Delete a Compute instance",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api-{zone}.exoscale.com/v2/instance/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Delete a Compute instance"
        },
        {
          "info": {
            "name": "Reboot a Compute instance",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api-{zone}.exoscale.com/v2/instance/:id:reboot",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Reboot a Compute instance"
        },
        {
          "info": {
            "name": "List Compute instances",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-{zone}.exoscale.com/v2/instance",
            "params": [
              {
                "name": "manager-id",
                "value": "",
                "type": "query"
              },
              {
                "name": "manager-type",
                "value": "",
                "type": "query"
              },
              {
                "name": "ip-address",
                "value": "",
                "type": "query"
              },
              {
                "name": "labels",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "List Compute instances"
        },
        {
          "info": {
            "name": "Create a Compute instance",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-{zone}.exoscale.com/v2/instance",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a Compute instance"
        },
        {
          "info": {
            "name": "Revert a snapshot for an instance",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-{zone}.exoscale.com/v2/instance/:instance-id:revert-snapshot",
            "params": [
              {
                "name": "instance-id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This operation reverts the snapshot to the Compute instance volume, restoring stored data as it was at the time of the snapshot.\nThe Compute instance must be previously stopped."
        }
      ]
    }
  ],
  "bundled": true
}