Target Nodes

Resize target node instance type

Changed on

Modify the instance type of a target node session. The session must be in stopped state.

put/api/target_nodes/resize

Request

  • The document declares no server URL.
  • Auth
    socaAuth (a scheme the document does not define) and socaToken (a scheme the document does not define)

Headers

X-EDH-USERstring required
Example:john.doe

SOCA username for authentication

X-EDH-TOKENstring required
Example:abc123def456

SOCA authentication token

Request body application/x-www-form-urlencoded

session_uuidstring uuid required

UUID of the target node session to resize

instance_typestring required

New EC2 instance type for the target node (must be allowed by the associated software stack profile)

Example request

{
  "session_uuid": "12345678-1234-1234-1234-123456789abc",
  "instance_type": "m5.large"
}

Response

Target node successfully resized

successboolean required
messagestring required

Example response

{
  "success": true,
  "message": "Your virtual desktop has been updated"
}

Changes

    • breaking

      removed the enum value c5.large of the request property

    • breaking

      removed the enum value c5.xlarge of the request property

    • breaking

      removed the enum value m5.large of the request property

    • breaking

      removed the enum value m5.xlarge of the request property

    • breaking

      removed the enum value t3.large of the request property

    • breaking

      removed the enum value t3.medium of the request property

    • breaking

      removed the enum value t3.micro of the request property

    • breaking

      removed the enum value t3.small of the request property

    • info

      the endpoint scheme security socaAuth AND socaToken was added to the API

    • info

      the endpoint scheme security edhAuth AND edhToken was removed from the API

    • info

      the endpoint scheme security edhAuth AND edhToken was added to the API

    • info

      the endpoint scheme security socaAuth AND socaToken was removed from the API