Windows Servers

These endpoints allow you to manage your Windows Servers, including provisioning, configuring, and monitoring server instances.

The Server object

The server object contains all information about a Windows Server instance, including its configuration and current status.

Properties

  • Name
    id
    Type
    string
    Description

    Unique identifier for the server

  • Name
    name
    Type
    string
    Description

    Custom name for the server

  • Name
    project_id
    Type
    string
    Description

    Project identifier the server belongs to

  • Name
    status
    Type
    integer
    Description

    Current server status (see Status Types)

  • Name
    provider
    Type
    integer
    Description

    Cloud provider identifier (see Provider Types)

  • Name
    region
    Type
    integer
    Description

    Region identifier where server is deployed (see Region Types)

  • Name
    version
    Type
    integer
    Description

    Operating system version identifier (see Version Types)

  • Name
    cpu
    Type
    integer
    Description

    Number of CPU cores

  • Name
    memory
    Type
    integer
    Description

    RAM in GB

  • Name
    disk
    Type
    integer
    Description

    Storage in GB

  • Name
    disk_type
    Type
    string
    Description

    Type of storage disk (see Disk Type)

  • Name
    auto_scale_cpu
    Type
    boolean
    Description

    Whether CPU auto-scaling is enabled

  • Name
    auto_scale_memory
    Type
    boolean
    Description

    Whether memory auto-scaling is enabled

  • Name
    ip
    Type
    string
    Description

    Server's public IP address

  • Name
    has_static_ip
    Type
    boolean
    Description

    Whether the server has a static IP

  • Name
    ip_version
    Type
    string
    Description

    IP address version

  • Name
    admin_username
    Type
    string
    Description

    Administrator username

  • Name
    vm_class
    Type
    string
    Description

    Virtual machine class (see VM Class Types)

  • Name
    charge
    Type
    number
    Description

    Server usage charge

  • Name
    soft_limit
    Type
    number
    Description

    Soft resource limit

  • Name
    hard_limit
    Type
    number
    Description

    Hard resource limit

  • Name
    synced_at
    Type
    timestamp
    Description

    When the server was last synced

  • Name
    created_at
    Type
    timestamp
    Description

    When the server was created

  • Name
    updated_at
    Type
    timestamp
    Description

    When the server was last updated


VM Class Types

The vm_class field indicates the performance class of the Windows Server.

ClassIDDescriptionDefault CPUDefault Memory (GB)Max CPUMax Memory (GB)
REGULAR0Standard performance class suitable for basic workloads24816
PRO1Professional class with enhanced performance for moderate workloads283264
PREMIUM2Premium class with high performance for demanding applications483264
ADVANCE3Advanced class with superior performance for intensive workloads41664128
ENTERPRISE4Enterprise-grade class with maximum performance for critical applications832128256

Provider Types

The provider field indicates the cloud provider where the Windows Server is hosted. Here are the possible values:

  • Name
    0
    Type
    info
    Description

    Microsoft Azure cloud provider

  • Name
    1
    Type
    info
    Description

    CtrlCloud provider

  • Name
    2
    Type
    info
    Description

    Linode cloud provider

  • Name
    3
    Type
    info
    Description

    Amazon Web Services (AWS) cloud provider

  • Name
    4
    Type
    info
    Description

    Google Cloud Platform provider

  • Name
    5
    Type
    info
    Description

    Microsoft Azure cloud provider (alternative)

  • Name
    6
    Type
    info
    Description

    Alibaba Cloud provider

  • Name
    7
    Type
    info
    Description

    Hetzner cloud provider

  • Name
    8
    Type
    info
    Description

    Bare metal server provider


Region Types

The region field indicates the geographical location where the Windows Server is deployed. Here are the possible values:

  • Name
    0
    Type
    info
    Description

    New York, United States

  • Name
    1
    Type
    info
    Description

    Amsterdam, Netherlands

  • Name
    2
    Type
    info
    Description

    Frankfurt, Germany

  • Name
    3
    Type
    info
    Description

    London, United Kingdom


Version Types

The version field indicates the Windows operating system version installed on the server. Here are the possible values:

  • Name
    0
    Type
    info
    Description

    Windows Server 2008 R2

  • Name
    1
    Type
    info
    Description

    Windows Server 2012

  • Name
    2
    Type
    info
    Description

    Windows Server 2012 R2

  • Name
    3
    Type
    info
    Description

    Windows Server 2016

  • Name
    4
    Type
    info
    Description

    Windows Server 2019

  • Name
    5
    Type
    info
    Description

    Windows Server 2022

  • Name
    6
    Type
    info
    Description

    Windows 11 Pro

  • Name
    7
    Type
    info
    Description

    Windows 11 Pro N

  • Name
    8
    Type
    info
    Description

    Windows 10 Pro

  • Name
    9
    Type
    info
    Description

    Windows 10 Pro N


Status Types

The status field indicates the current state of the Windows Server. Here are the possible values:

  • Name
    0
    Type
    info
    Description

    PENDING - Server creation has been requested but not yet started

  • Name
    1
    Type
    warning
    Description

    CREATING - Server is being created

  • Name
    2
    Type
    success
    Description

    CREATED - Server has been successfully created

  • Name
    3
    Type
    warning
    Description

    DELETING - Server is being deleted

  • Name
    4
    Type
    danger
    Description

    DELETED - Server has been deleted

  • Name
    5
    Type
    danger
    Description

    ERROR - An error occurred with the server

  • Name
    6
    Type
    success
    Description

    RUNNING - Server is running and operational

  • Name
    7
    Type
    warning
    Description

    STOPPED - Server is stopped

  • Name
    8
    Type
    warning
    Description

    STARTING - Server is starting up

  • Name
    9
    Type
    warning
    Description

    STOPPING - Server is shutting down

  • Name
    10
    Type
    warning
    Description

    RESTARTING - Server is restarting

  • Name
    11
    Type
    warning
    Description

    UPDATING - Server is being updated


Disk Type

The disk_type field indicates the type of storage disk used by the Windows Server. Here are the possible values:

  • Name
    0
    Type
    info
    Description

    SSD - Solid State Drive storage

  • Name
    1
    Type
    info
    Description

    NVME - NVMe (Non-Volatile Memory Express) storage


GET/my/trading/windows-servers

List Windows Servers

Retrieve a paginated list of all your Windows servers.

Optional Query Parameters

  • Name
    date_from
    Type
    string
    Description

    Start date for filtering (format: YYYY-MM-DD)

  • Name
    date_to
    Type
    string
    Description

    End date for filtering (format: YYYY-MM-DD)

  • Name
    per_page
    Type
    integer
    Description

    Number of items per page (1-100). Defaults to 15

  • Name
    page
    Type
    integer
    Description

    Page number to retrieve (min: 1)

  • Name
    search
    Type
    string
    Description

    Search term to filter servers by name (max: 255 characters)

  • Name
    sort_by
    Type
    string
    Description

    Field to sort by. Options: created_at, name, status. Defaults to created_at

  • Name
    sort_direction
    Type
    string
    Description

    Sort direction. Options: asc, desc. Defaults to desc

  • Name
    status
    Type
    integer
    Description

    Filter by status. See Status Types

  • Name
    region
    Type
    integer
    Description

    Filter by region ID. See Region Types

  • Name
    project_id
    Type
    string
    Description

    Filter by project ID

  • Name
    version
    Type
    integer
    Description

    Filter by OS version ID. See Version Types

Request

GET
/my/trading/windows-servers
curl -X GET "https://api.tradevps.net/v1/my/trading/windows-servers?date_from=2024-01-01&date_to=2024-01-31&search=trading&sort_by=created_at&sort_direction=desc&status=1&region=2&project_id=9eacd37f-ca6d-4d6f-9079-938fb858433b&version=1&per_page=15&page=1" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {token}"

Response 200

{
  "ok": true,
  "msg": "Windows servers fetched",
  "data": [
    {
      "id": "9ed52f4c-bdf2-4d76-a9d7-0f760c22d0b4",
      "name": "Trading Server 1",
      "project_id": "9eacd37f-ca6d-4d6f-9079-938fb858433b",
      "admin_username": null,
      "vm_class": null,
      "provider": 1,
      "region": 2,
      "version": 1,
      "cpu": 4,
      "memory": 16,
      "disk": 200,
      "disk_type": null,
      "auto_scale_cpu": null,
      "auto_scale_memory": null,
      "charge": 0,
      "soft_limit": null,
      "hard_limit": null,
      "ip": "123.45.67.89",
      "has_static_ip": false,
      "ip_version": null,
      "synced_at": null,
      "status": 1,
      "created_at": "2025-05-04T18:49:47.000000Z",
      "updated_at": "2025-05-04T18:49:51.000000Z"
    }
    // ... more servers
  ],
  "pagination": {
    "current_page": 1,
    "last_page": 2,
    "per_page": 15,
    "total": 17,
    "first_page_url": "https://api.tradevps.net/v1/my/trading/windows-servers?page=1",
    "from": 1,
    "last_page_url": "https://api.tradevps.net/v1/my/trading/windows-servers?page=2",
    "next_page_url": "https://api.tradevps.net/v1/my/trading/windows-servers?page=2",
    "prev_page_url": null
  }
}

GET/my/trading/windows/regions

List Available Regions

Retrieve a list of available regions for Windows Server deployment.

Response

Returns an array of available regions with their identifiers, labels, and flag icons.

Request

GET
/my/trading/windows/regions
curl -X GET https://api.tradevps.net/v1/my/trading/windows/regions \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {token}"

Response 200

{
  "ok": true,
  "msg": "Available regions fetched",
  "data": [
    {
      "id": 0,
      "label": "New York",
      "icon": "https://api.tradevps.net/assets/media/flags/united-states.svg"
    },
    {
      "id": 1,
      "label": "Amsterdam",
      "icon": "https://api.tradevps.net/assets/media/flags/netherlands.svg"
    },
    {
      "id": 2,
      "label": "Frankfurt",
      "icon": "https://api.tradevps.net/assets/media/flags/germany.svg"
    },
    {
      "id": 3,
      "label": "London",
      "icon": "https://api.tradevps.net/assets/media/flags/united-kingdom.svg"
    }
  ]
}

POST/my/trading/windows-servers

Create Windows Server

Provision a new Windows Server instance.

Required Parameters

  • Name
    name
    Type
    string
    Description

    Custom name for the server

  • Name
    region
    Type
    integer
    Description

    Region identifier for server deployment. See Region Types

  • Name
    project_id
    Type
    string
    Description

    Project identifier the server belongs to

Optional Parameters

  • Name
    provider
    Type
    integer
    Description

    Cloud provider identifier. See Provider Types

  • Name
    version
    Type
    integer
    Description

    Operating system version identifier. See Version Types

  • Name
    cpu
    Type
    integer
    Description

    Number of CPU cores

  • Name
    memory
    Type
    integer
    Description

    RAM in GB

  • Name
    disk
    Type
    integer
    Description

    Storage in GB

  • Name
    disk_type
    Type
    string
    Description

    Type of storage disk. See Disk Type

  • Name
    auto_scale_cpu
    Type
    boolean
    Description

    Whether CPU auto-scaling is enabled

  • Name
    auto_scale_memory
    Type
    boolean
    Description

    Whether memory auto-scaling is enabled

  • Name
    has_static_ip
    Type
    boolean
    Description

    Whether to assign a static IP

Request

POST
/my/trading/windows-servers
curl -X POST https://api.tradevps.net/v1/my/trading/windows-servers \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {token}" \
  -d '{
    "name": "Trading Server 1",
    "region": 2,
    "project_id": "9eacd37f-ca6d-4d6f-9079-938fb858433b",
    "provider": 1,
    "version": 1,
    "cpu": 4,
    "memory": 16,
    "disk": 200
  }'

Response 200

{
  "ok": true,
  "msg": "Server provisioning started",
  "data": {
    "id": "9ed52f4c-bdf2-4d76-a9d7-0f760c22d0b4",
    "name": "Trading Server 1",
    "project_id": "9eacd37f-ca6d-4d6f-9079-938fb858433b",
    "provider": 1,
    "region": 2,
    "version": 1,
    "status": 0,
    "created_at": "2025-05-04T18:49:47.000000Z",
    "updated_at": "2025-05-04T18:49:47.000000Z"
  }
}

GET/my/trading/windows-servers/{server_id}

Get Server Details

Retrieve details for a specific Windows Server.

URL Parameters

  • Name
    server_id
    Type
    string
    Description

    The unique identifier of the server

Request

GET
/my/trading/windows-servers/{server_id}
curl -X GET https://api.tradevps.net/v1/my/trading/windows-servers/{server_id} \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {token}"

Response 200

{
  "ok": true,
  "msg": "Server details retrieved",
  "data": {
    "id": "9ed52f4c-bdf2-4d76-a9d7-0f760c22d0b4",
    "name": "Trading Server 1",
    "project_id": "9eacd37f-ca6d-4d6f-9079-938fb858433b",
    "admin_username": null,
    "vm_class": null,
    "provider": 1,
    "region": 2,
    "version": 1,
    "cpu": 4,
    "memory": 16,
    "disk": 200,
    "disk_type": null,
    "auto_scale_cpu": null,
    "auto_scale_memory": null,
    "charge": 0,
    "soft_limit": null,
    "hard_limit": null,
    "ip": "123.45.67.89",
    "has_static_ip": false,
    "ip_version": null,
    "synced_at": null,
    "status": 1,
    "created_at": "2025-05-04T18:49:47.000000Z",
    "updated_at": "2025-05-04T18:49:51.000000Z"
  }
}

DELETE/my/trading/windows-servers/{server_id}

Delete Server

Delete a specific Windows Server.

URL Parameters

  • Name
    server_id
    Type
    string
    Description

    The unique identifier of the server to delete

Request

DELETE
/my/trading/windows-servers/{server_id}
curl -X DELETE https://api.tradevps.net/v1/my/trading/windows-servers/{server_id} \
  -H "Authorization: Bearer {token}"

Response 200

{
  "ok": true,
  "msg": "Server deletion initiated",
  "data": "9ed52f4c-bdf2-4d76-a9d7-0f760c22d0b4"
}

POST/my/trading/windows-servers/{server_id}/action

Server Actions

Perform actions on a Windows Server instance.

URL Parameters

  • Name
    server_id
    Type
    string
    Description

    The unique identifier of the server

Required Parameters

  • Name
    action
    Type
    string
    Description

    Action to perform: "start", "stop", "restart"

Request

POST
/my/trading/windows-servers/{server_id}/action
curl -X POST https://api.tradevps.net/v1/my/trading/windows-servers/{server_id}/action \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {token}" \
  -d '{
    "action": "restart"
  }'

Response 200

{
  "ok": true,
  "msg": "Server restart initiated",
  "data": {
    "id": "9ed52f4c-bdf2-4d76-a9d7-0f760c22d0b4",
    "status": 10,
    "updated_at": "2025-05-04T19:00:00.000000Z"
  }
}