LeaseWeb API for launching and managing Public Cloud instances (v1)

The base URL for this API is: https://api.leaseweb.com/publicCloud/v1/

This API provides ways to launch and manage Public Cloud instances.

BETA

This API is in BETA. Documentation might be incorrect or incomplete. Functionality might change with the final release.>

Errors

The API uses standard HTTP status codes to indicate the success or failure of the API call. The response will be JSON. Most APIs use the following format:

{
    "errorCode": "APP00800",
    "errorMessage": "The connection with the DB cannot be established.",
    "correlationId": "550e8400-e29b-41d4-a716-446655440000",
    "userMessage": "Cannot handle your request at the moment. Please try again later.",
    "reference": "https://developer.leaseweb.com/errors/APP00800"
}

API Key Authentication

Authentication for the APIs is required. To authenticate your call, you will need to sent your API key as X-LSW-Auth header.

You can generate API keys in the Customer Portal.

Regions

List regions

Authorizations:

X-LSW-Auth

query Parameters

limit	integer Example: limit=20 Limit the number of results returned.
offset	integer Example: offset=10 Return results starting from the given offset.

Responses

Request samples

Shell + Curl
Python + Python3
Php + Http2
Ruby + Native
Node + Native

curl --request GET \
  --url https://api.leaseweb.com/publicCloud/v1/regions \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

200
401
403
500
503

Content type

application/json

{"_metadata": {"totalCount": 7,
"limit": 20,
"offset": 0
},
"regions": [{"name": "eu-west-3",
"location": "Amsterdam"
},
{"name": "eu-central-1",
"location": "Frankfurt"
},
{"name": "eu-west-2",
"location": "London"
},
{"name": "ap-southeast-1",
"location": "Singapore"
},
{"name": "ca-central-1",
"location": "Montreal"
},
{"name": "us-east-1",
"location": "Washington"
},
{"name": "us-west-1",
"location": "San Francisco"
}
]
}

Instance Types

List instance types

Get instance types

Authorizations:

X-LSW-Auth

query Parameters

region required	string Example: region=eu-west-3
limit	integer >= 0 Default: 50
offset	integer >= 0 Default: 0

Responses

Request samples

Shell + Curl
Python + Python3
Php + Http2
Ruby + Native
Node + Native

curl --request GET \
  --url 'https://api.leaseweb.com/publicCloud/v1/instanceTypes?region=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE&offset=SOME_INTEGER_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

200
401
403
500
503

Content type

application/json

{"_metadata": {"totalCount": 74,
"limit": 1,
"offset": 1
},
"instanceTypes": [{"name": "lsw.c3.xlarge",
"resources": {"cpu": {"value": 4,
"unit": "vCPU"
},
"memory": {"value": 7,
"unit": "GiB"
},
"publicNetworkSpeed": {"value": 1,
"unit": "Gbps"
},
"privateNetworkSpeed": {"value": 100,
"unit": "Mbps"
}
},
"prices": {"currency": "EUR",
"currencySymbol": "€",
"compute": {"hourlyPrice": "0.0798",
"monthlyPrice": "52.5"
},
"storage": {"local": {"hourlyPrice": "0.0001",
"monthlyPrice": "0.03"
},
"central": {"hourlyPrice": "0.0001",
"monthlyPrice": "0.08"
}
}
},
"storageTypes": ["CENTRAL",
"LOCAL"
]
}
]
}

Instances

Launch instance

Launch a Public Cloud instance.

Available regions can be obtained using /v1/regions.

Available Images can be obtained using /v1/images.

Available instance types for your region can be obtained using /v1/instanceTypes.

Authorizations:

X-LSW-Auth

Request Body schema: application/json
required

region required	string Region to launch the instance into
type required	string (typeName) Enum: "lsw.m3.large" "lsw.m3.xlarge" "lsw.m3.2xlarge" "lsw.m4.large" "lsw.m4.xlarge" "lsw.m4.2xlarge" "lsw.m4.4xlarge" "lsw.m5.large" "lsw.m5.xlarge" "lsw.m5.2xlarge" "lsw.m5.4xlarge" "lsw.m5a.large" "lsw.m5a.xlarge" "lsw.m5a.2xlarge" "lsw.m5a.4xlarge" "lsw.m5a.8xlarge" "lsw.m5a.12xlarge" "lsw.m6a.large" "lsw.m6a.xlarge" "lsw.m6a.2xlarge" "lsw.m6a.4xlarge" "lsw.m6a.8xlarge" "lsw.m6a.12xlarge" "lsw.m6a.16xlarge" "lsw.m6a.24xlarge" "lsw.c3.large" "lsw.c3.xlarge" "lsw.c3.2xlarge" "lsw.c3.4xlarge" "lsw.c4.large" "lsw.c4.xlarge" "lsw.c4.2xlarge" "lsw.c4.4xlarge" "lsw.c5.large" "lsw.c5.xlarge" "lsw.c5.2xlarge" "lsw.c5.4xlarge" "lsw.c5a.large" "lsw.c5a.xlarge" "lsw.c5a.2xlarge" "lsw.c5a.4xlarge" "lsw.c5a.9xlarge" "lsw.c5a.12xlarge" "lsw.c6a.large" "lsw.c6a.xlarge" "lsw.c6a.2xlarge" "lsw.c6a.4xlarge" "lsw.c6a.8xlarge" "lsw.c6a.12xlarge" "lsw.c6a.16xlarge" "lsw.c6a.24xlarge" "lsw.r3.large" "lsw.r3.xlarge" "lsw.r3.2xlarge" "lsw.r4.large" "lsw.r4.xlarge" "lsw.r4.2xlarge" "lsw.r5.large" "lsw.r5.xlarge" "lsw.r5.2xlarge" "lsw.r5a.large" "lsw.r5a.xlarge" "lsw.r5a.2xlarge" "lsw.r5a.4xlarge" "lsw.r5a.8xlarge" "lsw.r5a.12xlarge" "lsw.r6a.large" "lsw.r6a.xlarge" "lsw.r6a.2xlarge" "lsw.r6a.4xlarge" "lsw.r6a.8xlarge" "lsw.r6a.12xlarge" "lsw.r6a.16xlarge" "lsw.r6a.24xlarge" Instance/Load balancer type
imageId required	string (imageId) Enum: "ALMALINUX_8_64BIT" "ALMALINUX_9_64BIT" "ARCH_LINUX_64BIT" "CENTOS_7_64BIT" "DEBIAN_10_64BIT" "DEBIAN_11_64BIT" "DEBIAN_12_64BIT" "FREEBSD_13_64BIT" "FREEBSD_14_64BIT" "ROCKY_LINUX_8_64BIT" "ROCKY_LINUX_9_64BIT" "UBUNTU_20_04_64BIT" "UBUNTU_22_04_64BIT" "UBUNTU_24_04_64BIT" "WINDOWS_SERVER_2016_STANDARD_64BIT" "WINDOWS_SERVER_2019_STANDARD_64BIT" "WINDOWS_SERVER_2022_STANDARD_64BIT" Image ID
marketAppId	string Market App ID that must be installed into the instance
reference	string An identifying name you can refer to the instance
contractType required	string (contractType) Enum: "HOURLY" "MONTHLY" Select HOURLY for billing based on hourly usage, else MONTHLY for billing per month usage
contractTerm required	integer (contractTerm) Enum: 0 1 3 6 12 Contract commitment. Used only when contract type is MONTHLY
billingFrequency required	integer (billingFrequency) Enum: 1 3 6 12 The billing frequency (in months) of the instance.
rootDiskSize	integer (rootDiskSize) [ 5 .. 1000 ] The root disk's size in GB. Must be at least 5 GB for Linux and FreeBSD instances and 50 GB for Windows instances
rootDiskStorageType required	string (rootDiskStorageType) Enum: "LOCAL" "CENTRAL" The root disk's storage type
sshKey	string Public SSH key to be installed into the instance. Must be used only on Linux/FreeBSD instances

Responses

Request samples

Content type

application/json

{"billingFrequency": 1,
"contractTerm": 0,
"contractType": "HOURLY",
"imageId": "UBUNTU_20_04_64BIT",
"reference": "my-webserver",
"region": "eu-west-3",
"rootDiskSize": 50,
"rootDiskStorageType": "CENTRAL",
"type": "lsw.m3.large"
}

Response samples

Content type

application/json

{"autoScalingGroup": null,
"contract": {"billingFrequency": 1,
"term": 0,
"type": "HOURLY",
"endsAt": null,
"renewalsAt": "2024-04-09T15:28:28+00:00",
"createdAt": "2024-04-09T15:11:21+00:00",
"state": "ACTIVE"
},
"hasPrivateNetwork": false,
"hasPublicIpV4": true,
"id": "ace712e9-a166-47f1-9065-4af0f7e7fce1",
"image": {"id": "UBUNTU_22_04_64BIT",
"name": "Ubuntu 22.04 LTS (x86_64)",
"version": "22.04",
"family": "linux",
"flavour": "ubuntu",
"architecture": "x86_64"
},
"ips": [{"ip": "10.32.60.12",
"prefixLength": "27",
"version": 4,
"nullRouted": false,
"reverseLookup": null,
"mainIp": false,
"networkType": "INTERNAL"
}
],
"marketAppId": null,
"productType": "INSTANCE",
"reference": "my webserver",
"region": "eu-west-3",
"resources": {"cpu": {"value": 2,
"unit": "vCPU"
},
"memory": {"value": 7,
"unit": "GiB"
},
"publicNetworkSpeed": {"value": 1,
"unit": "Gbps"
},
"privateNetworkSpeed": {"value": 100,
"unit": "Mbps"
}
},
"rootDiskSize": 5,
"rootDiskStorageType": "CENTRAL",
"startedAt": null,
"state": "STOPPED",
"type": "lsw.m3.large"
}

Get instance list

List and filter instances

Authorizations:

X-LSW-Auth

query Parameters

limit	integer Example: limit=20 Limit the number of results returned.
offset	integer Example: offset=10 Return results starting from the given offset.
ip	string <ip> Example: ip=10.0.0.1
reference	string Example: reference=my-webserver
id	string <uuid> Example: id=a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11
contractType	string Enum: "HOURLY" "MONTHLY" Select HOURLY for billing based on hourly usage, else MONTHLY for billing per month usage
contractState	string Enum: "ACTIVE" "DELETE_SCHEDULED"
imageId	string Enum: "ALMALINUX_8_64BIT" "ALMALINUX_9_64BIT" "ARCH_LINUX_64BIT" "CENTOS_7_64BIT" "DEBIAN_10_64BIT" "DEBIAN_11_64BIT" "DEBIAN_12_64BIT" "FREEBSD_13_64BIT" "FREEBSD_14_64BIT" "ROCKY_LINUX_8_64BIT" "ROCKY_LINUX_9_64BIT" "UBUNTU_20_04_64BIT" "UBUNTU_22_04_64BIT" "UBUNTU_24_04_64BIT" "WINDOWS_SERVER_2016_STANDARD_64BIT" "WINDOWS_SERVER_2019_STANDARD_64BIT" "WINDOWS_SERVER_2022_STANDARD_64BIT" Example: imageId=UBUNTU_22_04_64BIT Available Images can be obtained using `/v1/images`.
state	string Enum: "CREATING" "DESTROYED" "DESTROYING" "FAILED" "RUNNING" "STARTING" "STOPPED" "STOPPING" "UNKNOWN" The instance's current state(s), separated by commas.
region	string Example: region=eu-west-3 Available regions can be obtained using `/v1/regions`
	object (instanceType) Example: type=lsw.c3.xlarge Available instance types for your region can be obtained using `/v1/instanceTypes`.

Responses

Request samples

Shell + Curl
Python + Python3
Php + Http2
Ruby + Native
Node + Native

curl --request GET \
  --url 'https://api.leaseweb.com/publicCloud/v1/instances?limit=SOME_INTEGER_VALUE&offset=SOME_INTEGER_VALUE&ip=SOME_STRING_VALUE&reference=SOME_STRING_VALUE&id=SOME_STRING_VALUE&contractType=SOME_STRING_VALUE&contractState=SOME_STRING_VALUE&imageId=UBUNTU_24_04_64BIT&state=SOME_STRING_VALUE&region=SOME_STRING_VALUE&type=SOME_OBJECT_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

200
401
403
500
503

Content type

application/json

{"_metadata": {"totalCount": 1,
"limit": 20,
"offset": 0
},
"instances": [{"marketAppId": null,
"productType": "INSTANCE",
"autoScalingGroup": {"cooldownTime": null,
"cpuThreshold": null,
"createdAt": "2024-04-26T09:22:25+00:00",
"desiredAmount": 2,
"endsAt": null,
"id": "fb769dab-3daa-47e4-89ed-06a4b6499176",
"maximumAmount": null,
"minimumAmount": null,
"reference": "Manual Auto Scaling Group",
"region": "eu-west-3",
"startsAt": null,
"state": "ACTIVE",
"type": "MANUAL",
"updatedAt": "2024-04-26T09:22:25+00:00",
"warmupTime": null
},
"id": "ace712e9-a166-47f1-9065-4af0f7e7fce1",
"type": "lsw.m3.large",
"resources": {"cpu": {"value": 16,
"unit": "vCPU"
},
"memory": {"value": 30,
"unit": "GiB"
},
"publicNetworkSpeed": {"value": 1,
"unit": "Gbps"
},
"privateNetworkSpeed": {"value": 100,
"unit": "Mbps"
}
},
"region": "eu-west-3",
"reference": "my webserver",
"image": {"id": "UBUNTU_22_04_64BIT",
"name": "Ubuntu 22.04 LTS (x86_64)",
"version": "22.04",
"family": "linux",
"flavour": "ubuntu",
"architecture": "x86_64"
},
"state": "RUNNING",
"hasPublicIpV4": true,
"hasPrivateNetwork": false,
"rootDiskStorageType": "CENTRAL",
"rootDiskSize": 10,
"ips": [{"ip": "10.32.60.12",
"prefixLength": "32",
"version": 4,
"nullRouted": false,
"reverseLookup": null,
"mainIp": false,
"networkType": "INTERNAL"
}
],
"startedAt": "2024-04-09T15:11:37+00:00",
"contract": {"billingFrequency": 1,
"term": 0,
"type": "HOURLY",
"endsAt": null,
"renewalsAt": "2024-04-09T15:28:28+00:00",
"createdAt": "2024-04-09T15:11:21+00:00",
"state": "ACTIVE"
}
}
]
}

Get instance details

Get details about the instance

Authorizations:

X-LSW-Auth

path Parameters

instanceId

required

string <uuid>

Example: 695ddd91-051f-4dd6-9120-938a927a47d0

Instance's ID

Responses

Request samples

Shell + Curl
Python + Python3
Php + Http2
Ruby + Native
Node + Native

curl --request GET \
  --url https://api.leaseweb.com/publicCloud/v1/instances/695ddd91-051f-4dd6-9120-938a927a47d0 \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type

application/json

{"autoScalingGroup": {"cooldownTime": null,
"cpuThreshold": null,
"createdAt": "2024-04-26T09:22:25+00:00",
"desiredAmount": 2,
"endsAt": null,
"id": "fb769dab-3daa-47e4-89ed-06a4b6499176",
"maximumAmount": null,
"minimumAmount": null,
"reference": "Manual Auto Scaling Group",
"region": "eu-west-3",
"startsAt": null,
"state": "ACTIVE",
"type": "MANUAL",
"updatedAt": "2024-04-26T09:22:25+00:00",
"warmupTime": null
},
"contract": {"billingFrequency": 1,
"term": 0,
"type": "HOURLY",
"endsAt": null,
"renewalsAt": "2024-04-09T15:28:28+00:00",
"createdAt": "2024-04-09T15:11:21+00:00",
"state": "ACTIVE"
},
"hasPrivateNetwork": false,
"hasPublicIpV4": true,
"id": "ace712e9-a166-47f1-9065-4af0f7e7fce1",
"image": {"id": "UBUNTU_22_04_64BIT",
"name": "Ubuntu 22.04 LTS (x86_64)",
"version": "22.04",
"family": "linux",
"flavour": "ubuntu",
"architecture": "x86_64",
"marketApps": ["LOADBALANCER"
],
"storageTypes": ["LOCAL",
"CENTRAL"
]
},
"ips": [{"ip": "10.32.60.12",
"prefixLength": "27",
"version": 4,
"nullRouted": false,
"reverseLookup": null,
"mainIp": false,
"networkType": "INTERNAL",
"ddos": {"detectionProfile": "STANDARD_DEFAULT",
"protectionType": "STANDARD"
}
}
],
"iso": null,
"marketAppId": null,
"privateNetwork": null,
"productType": "INSTANCE",
"reference": "my webserver",
"region": "eu-west-3",
"resources": {"cpu": {"value": 2,
"unit": "vCPU"
},
"memory": {"value": 7,
"unit": "GiB"
},
"publicNetworkSpeed": {"value": 1,
"unit": "Gbps"
},
"privateNetworkSpeed": {"value": 100,
"unit": "Mbps"
}
},
"rootDiskSize": 5,
"rootDiskStorageType": "CENTRAL",
"startedAt": "2024-04-11T12:59:34+00:00",
"state": "STOPPED",
"type": "lsw.m3.large"
}

Terminate instance

Terminate Public Cloud instance

Authorizations:

X-LSW-Auth

path Parameters

instanceId

required

string <uuid>

Example: 695ddd91-051f-4dd6-9120-938a927a47d0

Instance's ID

Responses

Request samples

Shell + Curl
Python + Python3
Php + Http2
Ruby + Native
Node + Native

curl --request DELETE \
  --url https://api.leaseweb.com/publicCloud/v1/instances/695ddd91-051f-4dd6-9120-938a927a47d0 \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type

application/json

{"correlationId": "289346a1-3eaf-4da4-b707-62ef12eb08be",
"errorCode": "400",
"errorDetails": { },
"errorMessage": "The API could not interpret your request correctly."
}

Update instance

Update the instance's reference, type, storage or contract type.

Eligible instance types for update can be obtained using /v1/instances/{instanceId}/instanceTypesUpdate.

Authorizations:

X-LSW-Auth

path Parameters

instanceId

required

string <uuid>

Example: 695ddd91-051f-4dd6-9120-938a927a47d0

Instance's ID

Request Body schema: application/json
required

type	string (typeName) Enum: "lsw.m3.large" "lsw.m3.xlarge" "lsw.m3.2xlarge" "lsw.m4.large" "lsw.m4.xlarge" "lsw.m4.2xlarge" "lsw.m4.4xlarge" "lsw.m5.large" "lsw.m5.xlarge" "lsw.m5.2xlarge" "lsw.m5.4xlarge" "lsw.m5a.large" "lsw.m5a.xlarge" "lsw.m5a.2xlarge" "lsw.m5a.4xlarge" "lsw.m5a.8xlarge" "lsw.m5a.12xlarge" "lsw.m6a.large" "lsw.m6a.xlarge" "lsw.m6a.2xlarge" "lsw.m6a.4xlarge" "lsw.m6a.8xlarge" "lsw.m6a.12xlarge" "lsw.m6a.16xlarge" "lsw.m6a.24xlarge" "lsw.c3.large" "lsw.c3.xlarge" "lsw.c3.2xlarge" "lsw.c3.4xlarge" "lsw.c4.large" "lsw.c4.xlarge" "lsw.c4.2xlarge" "lsw.c4.4xlarge" "lsw.c5.large" "lsw.c5.xlarge" "lsw.c5.2xlarge" "lsw.c5.4xlarge" "lsw.c5a.large" "lsw.c5a.xlarge" "lsw.c5a.2xlarge" "lsw.c5a.4xlarge" "lsw.c5a.9xlarge" "lsw.c5a.12xlarge" "lsw.c6a.large" "lsw.c6a.xlarge" "lsw.c6a.2xlarge" "lsw.c6a.4xlarge" "lsw.c6a.8xlarge" "lsw.c6a.12xlarge" "lsw.c6a.16xlarge" "lsw.c6a.24xlarge" "lsw.r3.large" "lsw.r3.xlarge" "lsw.r3.2xlarge" "lsw.r4.large" "lsw.r4.xlarge" "lsw.r4.2xlarge" "lsw.r5.large" "lsw.r5.xlarge" "lsw.r5.2xlarge" "lsw.r5a.large" "lsw.r5a.xlarge" "lsw.r5a.2xlarge" "lsw.r5a.4xlarge" "lsw.r5a.8xlarge" "lsw.r5a.12xlarge" "lsw.r6a.large" "lsw.r6a.xlarge" "lsw.r6a.2xlarge" "lsw.r6a.4xlarge" "lsw.r6a.8xlarge" "lsw.r6a.12xlarge" "lsw.r6a.16xlarge" "lsw.r6a.24xlarge" Instance/Load balancer type
reference	string An identifying name you can refer to the instance
contractType	string (contractType) Enum: "HOURLY" "MONTHLY" Select HOURLY for billing based on hourly usage, else MONTHLY for billing per month usage
contractTerm	integer (contractTerm) Enum: 0 1 3 6 12 Contract commitment. Used only when contract type is MONTHLY
billingFrequency	integer (billingFrequency) Enum: 1 3 6 12 The billing frequency (in months) of the instance.
rootDiskSize	integer (rootDiskSize) [ 5 .. 1000 ] The root disk's size in GB. Must be at least 5 GB for Linux and FreeBSD instances and 50 GB for Windows instances

Responses

Request samples

Content type

application/json

Example

Update only reference

{"reference": "new-reference"
}

Response samples

Content type

application/json

{"autoScalingGroup": null,
"contract": {"billingFrequency": 1,
"term": 0,
"type": "HOURLY",
"endsAt": null,
"renewalsAt": "2024-04-09T15:28:28+00:00",
"createdAt": "2024-04-09T15:11:21+00:00",
"state": "ACTIVE"
},
"hasPrivateNetwork": false,
"hasPublicIpV4": true,
"id": "ace712e9-a166-47f1-9065-4af0f7e7fce1",
"image": {"id": "UBUNTU_20_04_64BIT",
"name": "Ubuntu 20.04 LTS (x86_64)",
"version": "20.04",
"family": "linux",
"flavour": "ubuntu",
"architecture": "x86_64",
"marketApps": ["LOADBALANCER"
],
"storageTypes": ["LOCAL",
"CENTRAL"
]
},
"ips": [{"ip": "10.32.60.12",
"prefixLength": "27",
"version": 4,
"reverseLookup": null,
"mainIp": false,
"networkType": "INTERNAL",
"nullRouted": false,
"ddos": {"detectionProfile": "STANDARD_DEFAULT",
"protectionType": "STANDARD"
}
}
],
"iso": null,
"marketAppId": null,
"privateNetwork": null,
"productType": "INSTANCE",
"reference": "my webserver",
"region": "eu-west-3",
"resources": {"cpu": {"value": 1,
"unit": "vCPU"
},
"memory": {"value": 3,
"unit": "GiB"
},
"publicNetworkSpeed": {"value": 1,
"unit": "Gbps"
},
"privateNetworkSpeed": {"value": 100,
"unit": "Mbps"
}
},
"rootDiskSize": 5,
"rootDiskStorageType": "CENTRAL",
"startedAt": "2024-04-09T15:11:37+00:00",
"state": "RUNNING",
"type": "lsw.m3.large"
}

Cancel instance termination

Cancel the termination process of monthly instances. Must be executed prior to the instance's contractEndsAt.

Authorizations:

X-LSW-Auth

path Parameters

instanceId

required

string <uuid>

Example: 695ddd91-051f-4dd6-9120-938a927a47d0

Instance's ID

Responses

Request samples

Shell + Curl
Python + Python3
Php + Http2
Ruby + Native
Node + Native

curl --request POST \
  --url https://api.leaseweb.com/publicCloud/v1/instances/695ddd91-051f-4dd6-9120-938a927a47d0/cancelTermination \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type

application/json

{"correlationId": "289346a1-3eaf-4da4-b707-62ef12eb08be",
"errorCode": "400",
"errorDetails": { },
"errorMessage": "The API could not interpret your request correctly."
}

Get console access

Get console access to the instance

Authorizations:

X-LSW-Auth

path Parameters

instanceId

required

string <uuid>

Example: 695ddd91-051f-4dd6-9120-938a927a47d0

Instance's ID

Responses

Request samples

Shell + Curl
Python + Python3
Php + Http2
Ruby + Native
Node + Native

curl --request GET \
  --url https://api.leaseweb.com/publicCloud/v1/instances/695ddd91-051f-4dd6-9120-938a927a47d0/console \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type

application/json

{"url": "https://public-cloud.leaseweb.com/resource/noVNC/vnc.html?autoconnect=true&port=8080&token=dvoPyDxbBl8LC9OsXI55CmAUmUA50lY19b0/v/7jrA6VkrdflVWw8S2XuxDZrBaaSo4XdBAYmpfqC0kUr2aOVHjMlGFb6movdnKNxvMOEmC0spwU9XbdZJrWXzGicCLT4X4GMxgN13nn1oDQb8k9ag2rMMxENyiPZ3bbV1iGuL4cWLEMad8hHFXjJ7P2MvbnpiasXK5wKuHadrR76778ZM22xxzvjarg9S6bAWziH1u3VdKIQyJMIrDmAdjYRqL1IHqrN+uLrY6WPzv+s51lnNYd0zeQtB7YWBZup8VDcZSt5C0GrYnZx3Vh4fXWOOsFlWZgdEGKf9oM9y9RX2G/jLlVeVv4LmVCN02GRr7SAfyx8WcuWGXS7WsxpXTzdxWEm9EMZDrPQhFiZKo20PXRdgT6KbdnqCI/j8z5iPAKGO3YI5BcK5sUdhHgFUMNgJUw/qhz71/xivIP8UKrWVgZMRWXmt6hNWIeHLqrdZ0n5m9It4Os8UaKgeBvwlFTpzNTUWxvoI0+2sa8GAmW3RCe9mfK3xvW/iy1MZ651cALLVmoj6imZl7K7P33iQ=="
}

List available instance types for update

Get available instance types for update

Authorizations:

X-LSW-Auth

path Parameters

instanceId

required

string <uuid>

Example: 695ddd91-051f-4dd6-9120-938a927a47d0

Instance's ID

query Parameters

limit	integer >= 0 Default: 50
offset	integer >= 0 Default: 0

Responses

Request samples

Shell + Curl
Python + Python3
Php + Http2
Ruby + Native
Node + Native

curl --request GET \
  --url 'https://api.leaseweb.com/publicCloud/v1/instances/695ddd91-051f-4dd6-9120-938a927a47d0/instanceTypesUpdate?limit=SOME_INTEGER_VALUE&offset=SOME_INTEGER_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type

application/json

{"_metadata": {"totalCount": 74,
"limit": 1,
"offset": 1
},
"instanceTypes": [{"name": "lsw.c3.xlarge",
"resources": {"cpu": {"value": 4,
"unit": "vCPU"
},
"memory": {"value": 7,
"unit": "GiB"
},
"publicNetworkSpeed": {"value": 1,
"unit": "Gbps"
},
"privateNetworkSpeed": {"value": 100,
"unit": "Mbps"
}
},
"prices": {"currency": "EUR",
"currencySymbol": "€",
"compute": {"hourlyPrice": "0.0798",
"monthlyPrice": "52.5"
},
"storage": {"local": {"hourlyPrice": "0.0001",
"monthlyPrice": "0.03"
},
"central": {"hourlyPrice": "0.0001",
"monthlyPrice": "0.08"
}
}
},
"storageTypes": ["CENTRAL",
"LOCAL"
]
}
]
}

List OSes available for reinstall

List Images available for reinstall

Authorizations:

X-LSW-Auth

path Parameters

instanceId

required

string <uuid>

Example: 695ddd91-051f-4dd6-9120-938a927a47d0

Instance's ID

Responses

Request samples

Shell + Curl
Python + Python3
Php + Http2
Ruby + Native
Node + Native

curl --request GET \
  --url https://api.leaseweb.com/publicCloud/v1/instances/695ddd91-051f-4dd6-9120-938a927a47d0/reinstall/images \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type

application/json

[{"id": "UBUNTU_22_04_64BIT",
"name": "Ubuntu 22.04 LTS (x86_64)",
"version": "22.04",
"family": "linux",
"flavour": "ubuntu",
"architecture": "x86_64",
"marketApps": [ ],
"storageTypes": ["LOCAL",
"CENTRAL"
]
},
{"id": "UBUNTU_20_04_64BIT",
"name": "Ubuntu 20.04 LTS (x86_64)",
"version": "20.04",
"family": "linux",
"flavour": "ubuntu",
"architecture": "x86_64",
"marketApps": [ ],
"storageTypes": ["LOCAL",
"CENTRAL"
]
},
{"id": "DEBIAN_12_64BIT",
"name": "Debian 12 (x86_64)",
"version": "12",
"family": "linux",
"flavour": "debian",
"architecture": "x86_64",
"marketApps": [ ],
"storageTypes": ["LOCAL",
"CENTRAL"
]
},
{"id": "DEBIAN_11_64BIT",
"name": "Debian 11 (x86_64)",
"version": "11",
"family": "linux",
"flavour": "debian",
"architecture": "x86_64",
"marketApps": [ ],
"storageTypes": ["LOCAL",
"CENTRAL"
]
},
{"id": "DEBIAN_10_64BIT",
"name": "Debian 10 (x86_64)",
"version": "10",
"family": "linux",
"flavour": "debian",
"architecture": "x86_64",
"marketApps": [ ],
"storageTypes": ["LOCAL",
"CENTRAL"
]
},
{"id": "CENTOS_7_64BIT",
"name": "CentOS 7 (x86_64)",
"version": "7",
"family": "linux",
"flavour": "centos",
"architecture": "x86_64",
"marketApps": [ ],
"storageTypes": ["LOCAL",
"CENTRAL"
]
},
{"id": "ALMALINUX_9_64BIT",
"name": "AlmaLinux 9 (x86_64)",
"version": "9",
"family": "linux",
"flavour": "almalinux",
"architecture": "x86_64",
"marketApps": [ ],
"storageTypes": ["LOCAL",
"CENTRAL"
]
},
{"id": "ALMALINUX_8_64BIT",
"name": "AlmaLinux 8 (x86_64)",
"version": "8",
"family": "linux",
"flavour": "almalinux",
"architecture": "x86_64",
"marketApps": [ ],
"storageTypes": ["LOCAL",
"CENTRAL"
]
},
{"id": "ROCKY_LINUX_9_64BIT",
"name": "Rocky Linux 9 (x86_64)",
"version": "9",
"family": "linux",
"flavour": "rockylinux",
"architecture": "x86_64",
"marketApps": [ ],
"storageTypes": ["LOCAL",
"CENTRAL"
]
},
{"id": "ROCKY_LINUX_8_64BIT",
"name": "Rocky Linux 8 (x86_64)",
"version": "8",
"family": "linux",
"flavour": "rockylinux",
"architecture": "x86_64",
"marketApps": [ ],
"storageTypes": ["LOCAL",
"CENTRAL"
]
},
{"id": "FREEBSD_13_64BIT",
"name": "FreeBSD 13.2 (x86_64)",
"version": "13.2",
"family": "bsd",
"flavour": "freebsd",
"architecture": "x86_64",
"marketApps": [ ],
"storageTypes": ["LOCAL",
"CENTRAL"
]
},
{"id": "FREEBSD_14_64BIT",
"name": "FreeBSD 14.0 (x86_64)",
"version": "14.0",
"family": "bsd",
"flavour": "freebsd",
"architecture": "x86_64",
"marketApps": [ ],
"storageTypes": ["LOCAL",
"CENTRAL"
]
}
]

Reinstall instance

Recreates the instance, with optionally different Image and Marketplace App.

Cannot be performed when the instance has snapshots.

Available Images can be obtained using /v1/instances/{instanceId}/reinstall/images.

Available Marketplace Apps can be obtained using /v1/images/{imageId}/marketApps.

Authorizations:

X-LSW-Auth

path Parameters

instanceId

required

string <uuid>

Example: 695ddd91-051f-4dd6-9120-938a927a47d0

Instance's ID

Request Body schema: application/json
required

imageId required	string The Image ID
marketAppId	string The Market App to be installed

Responses

Request samples

Content type

application/json

{"imageId": "UBUNTU_22_04_64BIT"
}

Response samples

Content type

application/json

{"correlationId": "289346a1-3eaf-4da4-b707-62ef12eb08be",
"errorCode": "400",
"errorDetails": { },
"errorMessage": "The API could not interpret your request correctly."
}

Power

Start instance

The instance must be stopped before the execution

Authorizations:

X-LSW-Auth

path Parameters

instanceId

required

string <uuid>

Example: 695ddd91-051f-4dd6-9120-938a927a47d0

Instance's ID

Responses

Request samples

Shell + Curl
Python + Python3
Php + Http2
Ruby + Native
Node + Native

curl --request POST \
  --url https://api.leaseweb.com/publicCloud/v1/instances/695ddd91-051f-4dd6-9120-938a927a47d0/start \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type

application/json

{"correlationId": "289346a1-3eaf-4da4-b707-62ef12eb08be",
"errorCode": "400",
"errorDetails": { },
"errorMessage": "The API could not interpret your request correctly."
}

Stop instance

The instance must be running before the execution

Authorizations:

X-LSW-Auth

path Parameters

instanceId

required

string <uuid>

Example: 695ddd91-051f-4dd6-9120-938a927a47d0

Instance's ID

Responses

Request samples

Shell + Curl
Python + Python3
Php + Http2
Ruby + Native
Node + Native

curl --request POST \
  --url https://api.leaseweb.com/publicCloud/v1/instances/695ddd91-051f-4dd6-9120-938a927a47d0/stop \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type

application/json

{"correlationId": "289346a1-3eaf-4da4-b707-62ef12eb08be",
"errorCode": "400",
"errorDetails": { },
"errorMessage": "The API could not interpret your request correctly."
}

Reboot instance

The instance must be running before the execution

Authorizations:

X-LSW-Auth

path Parameters

instanceId

required

string <uuid>

Example: 695ddd91-051f-4dd6-9120-938a927a47d0

Instance's ID

Responses

Request samples

Shell + Curl
Python + Python3
Php + Http2
Ruby + Native
Node + Native

curl --request POST \
  --url https://api.leaseweb.com/publicCloud/v1/instances/695ddd91-051f-4dd6-9120-938a927a47d0/reboot \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type

application/json

{"correlationId": "289346a1-3eaf-4da4-b707-62ef12eb08be",
"errorCode": "400",
"errorDetails": { },
"errorMessage": "The API could not interpret your request correctly."
}

Credentials

List credentials stored for instance

Get all credentials stored for the instance

Authorizations:

X-LSW-Auth

path Parameters

instanceId

required

string <uuid>

Example: 695ddd91-051f-4dd6-9120-938a927a47d0

Instance's ID

Responses

Request samples

Shell + Curl
Python + Python3
Php + Http2
Ruby + Native
Node + Native

curl --request GET \
  --url https://api.leaseweb.com/publicCloud/v1/instances/695ddd91-051f-4dd6-9120-938a927a47d0/credentials \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type

application/json

{"_metadata": {"totalCount": 1,
"limit": 20,
"offset": 0
},
"credentials": [{"type": "OPERATING_SYSTEM",
"username": "root"
}
]
}

Store credentials

Store credential used for the instance

Authorizations:

X-LSW-Auth

path Parameters

instanceId

required

string <uuid>

Example: 695ddd91-051f-4dd6-9120-938a927a47d0

Instance's ID

Request Body schema: application/json
required

type required	string (credentialType) Enum: "OPERATING_SYSTEM" "CONTROL_PANEL"
username required	string Can contain only alphanumeric values and characters `@`, `.`, `-` and `_`
password required	string The password you'd like to store

Responses

Request samples

Content type

application/json

{"password": "a$Ndes-3fad2-rfas@-",
"type": "OPERATING_SYSTEM",
"username": "another-user"
}

Response samples

Content type

application/json

{"password": "a$Ndes-3fad2-rfas@-",
"type": "OPERATING_SYSTEM",
"username": "another-user"
}

Delete all instance credentials

Delete all credentials stored for a given instance

Authorizations:

X-LSW-Auth

path Parameters

instanceId

required

string <uuid>

Example: 695ddd91-051f-4dd6-9120-938a927a47d0

Instance's ID

Responses

Request samples

Shell + Curl
Python + Python3
Php + Http2
Ruby + Native
Node + Native

curl --request DELETE \
  --url https://api.leaseweb.com/publicCloud/v1/instances/695ddd91-051f-4dd6-9120-938a927a47d0/credentials \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

401
403
404
500
503

Content type

application/json

{"correlationId": "289346a1-3eaf-4da4-b707-62ef12eb08be",
"errorCode": "401",
"errorMessage": "You are not authorized to view this resource."
}

Get credentials by type

Get credentials stored for the instance by their types

Authorizations:

X-LSW-Auth

path Parameters

instanceId required	string <uuid> Example: 695ddd91-051f-4dd6-9120-938a927a47d0 Instance's ID
type required	string Example: OPERATING_SYSTEM

Responses

Request samples

Shell + Curl
Python + Python3
Php + Http2
Ruby + Native
Node + Native

curl --request GET \
  --url https://api.leaseweb.com/publicCloud/v1/instances/695ddd91-051f-4dd6-9120-938a927a47d0/credentials/OPERATING_SYSTEM \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type

application/json

{"_metadata": {"totalCount": 1,
"limit": 20,
"offset": 0
},
"credentials": [{"type": "OPERATING_SYSTEM",
"username": "root"
}
]
}

Get credentials by type and username

Authorizations:

X-LSW-Auth

path Parameters

instanceId required	string <uuid> Example: 695ddd91-051f-4dd6-9120-938a927a47d0 Instance's ID
type required	string Example: OPERATING_SYSTEM Credential type
username required	string Example: root Username

Responses

Request samples

Shell + Curl
Python + Python3
Php + Http2
Ruby + Native
Node + Native

curl --request GET \
  --url https://api.leaseweb.com/publicCloud/v1/instances/695ddd91-051f-4dd6-9120-938a927a47d0/credentials/OPERATING_SYSTEM/root \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type

application/json

{"password": "12341234",
"type": "OPERATING_SYSTEM",
"username": "root"
}

Update credentials

Update credentials for a given type and username

Authorizations:

X-LSW-Auth

path Parameters

instanceId required	string <uuid> Example: 695ddd91-051f-4dd6-9120-938a927a47d0 Instance's ID
type required	string Example: OPERATING_SYSTEM Credential type
username required	string Example: root Username

Request Body schema: application/json
required

password

required

string

The new password

Responses

Request samples

Content type

application/json

{"password": "@-n3w-Pa$$w0rD"
}

Response samples

Content type

application/json

{"password": "@-n3w-Pa$$w0rD",
"type": "OPERATING_SYSTEM",
"username": "another-user"
}

Delete credentials

Delete credential for a given type and username

Authorizations:

X-LSW-Auth

path Parameters

instanceId required	string <uuid> Example: 695ddd91-051f-4dd6-9120-938a927a47d0 Instance's ID
type required	string Example: OPERATING_SYSTEM Credential type
username required	string Example: root Username

Responses

Request samples

Shell + Curl
Python + Python3
Php + Http2
Ruby + Native
Node + Native

curl --request DELETE \
  --url https://api.leaseweb.com/publicCloud/v1/instances/695ddd91-051f-4dd6-9120-938a927a47d0/credentials/OPERATING_SYSTEM/root \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

401
403
404
500
503

Content type

application/json

{"correlationId": "289346a1-3eaf-4da4-b707-62ef12eb08be",
"errorCode": "401",
"errorMessage": "You are not authorized to view this resource."
}

Reset instance password

The operation may take a few moments to complete.

You can obtain the new credential using the credentials endpoints

Authorizations:

X-LSW-Auth

path Parameters

instanceId

required

string <uuid>

Example: 695ddd91-051f-4dd6-9120-938a927a47d0

Instance's ID

Responses

Request samples

Shell + Curl
Python + Python3
Php + Http2
Ruby + Native
Node + Native

curl --request POST \
  --url https://api.leaseweb.com/publicCloud/v1/instances/695ddd91-051f-4dd6-9120-938a927a47d0/resetPassword \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type

application/json

{"correlationId": "289346a1-3eaf-4da4-b707-62ef12eb08be",
"errorCode": "400",
"errorDetails": { },
"errorMessage": "The API could not interpret your request correctly."
}

Expenses

Get costs for a given month.

Authorizations:

X-LSW-Auth

path Parameters

equipmentId

required

string <uuid>

Example: 695ddd91-051f-4dd6-9120-938a927a47d0

Equipment's UUID

query Parameters

from required	string <date> Example: from=2023-11-01 Start date of the period to get costs for. It must be the first day of the month
to	string <date> Example: to=2023-12-01 End date of the period to get costs for. This date needs to be exactly one month after the 'from' date. If this value is not passed, it will be calculated based on 'from' parameter

Responses

Request samples

Shell + Curl
Python + Python3
Php + Http2
Ruby + Native
Node + Native

curl --request GET \
  --url 'https://api.leaseweb.com/publicCloud/v1/equipments/695ddd91-051f-4dd6-9120-938a927a47d0/expenses?from=SOME_STRING_VALUE&to=SOME_STRING_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

200
401
403
500
503

Content type

application/json

{"billing": {"instances": [{"id": "b778824a-a96e-4f6f-9713-7b7196f09c4f",
"reference": "test-instance",
"resources": {"cpu": {"value": 2,
"unit": "vCPU"
},
"memory": {"value": 8,
"unit": "GB"
},
"publicNetworkSpeed": {"value": 5,
"unit": "Gbps"
},
"privateNetworkSpeed": {"value": 1000,
"unit": "Mbps"
}
},
"contract": {"billingFrequency": 1,
"term": 0,
"type": "HOURLY",
"endsAt": null,
"renewalsAt": "2024-04-09T15:28:28+00:00",
"createdAt": "2024-04-09T15:11:21+00:00",
"state": "ACTIVE"
},
"startedAt": "2023-11-30T16:31:46+00:00",
"endedAt": "2023-11-30T16:40:46+00:00",
"rootDiskSize": 15,
"billingType": "POSTPAID",
"hours": 14,
"from": "2023-12-01T00:00:00+00:00",
"to": "2023-12-01T13:18:41+00:00",
"rootDiskStorageType": "CENTRAL",
"price": "0.72"
}
],
"traffic": {"unit": "GB",
"values": {"tier_0": {"usage": 1000,
"price": 0
},
"tier_1": {"usage": 10000,
"price": 15.54
},
"tier_2": {"usage": 10000,
"price": 13.45
},
"tier_3": {"usage": 34.5,
"price": 2.34
}
}
}
}
}

ISOs

List available ISOs

List all available ISO images

Authorizations:

X-LSW-Auth

query Parameters

limit	integer Example: limit=20 Limit the number of results returned.
offset	integer Example: offset=10 Return results starting from the given offset.

Responses

Request samples

Shell + Curl
Python + Python3
Php + Http2
Ruby + Native
Node + Native

curl --request GET \
  --url https://api.leaseweb.com/publicCloud/v1/isos \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

200
401
403
500
503

Content type

application/json

{"_metadata": {"totalCount": 2,
"limit": 20,
"offset": 0
},
"isos": [{"id": "GRML",
"name": "GRML 2022.11"
},
{"id": "ACRONIS_BOOT_MEDIA",
"name": "Acronis Boot Media"
}
]
}

Attach ISO to instance

Instance must not have ISO attached, otherwise, it will return a validation error.

Available ISOs can be obtained using /v1/isos.

Authorizations:

X-LSW-Auth

path Parameters

instanceId

required

string <uuid>

Example: 695ddd91-051f-4dd6-9120-938a927a47d0

Instance's ID

Request Body schema: application/json
required

isoId

required

string

The ISO ID, obtained using the ISO endpoints

Responses

Request samples

Content type

application/json

{"isoId": "GRML"
}

Response samples

Content type

application/json

{"correlationId": "289346a1-3eaf-4da4-b707-62ef12eb08be",
"errorCode": "400",
"errorDetails": { },
"errorMessage": "The API could not interpret your request correctly."
}

Detach ISO from instance

Instance must have ISO attached, otherwise, it will return a validation error

Authorizations:

X-LSW-Auth

path Parameters

instanceId

required

string <uuid>

Example: 695ddd91-051f-4dd6-9120-938a927a47d0

Instance's ID

Responses

Request samples

Shell + Curl
Python + Python3
Php + Http2
Ruby + Native
Node + Native

curl --request POST \
  --url https://api.leaseweb.com/publicCloud/v1/instances/695ddd91-051f-4dd6-9120-938a927a47d0/detachIso \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type

application/json

{"correlationId": "289346a1-3eaf-4da4-b707-62ef12eb08be",
"errorCode": "400",
"errorDetails": { },
"errorMessage": "The API could not interpret your request correctly."
}

Images

List all available Images

Authorizations:

X-LSW-Auth

query Parameters

limit	integer Example: limit=20 Limit the number of results returned.
offset	integer Example: offset=10 Return results starting from the given offset.

Responses

Request samples

Shell + Curl
Python + Python3
Php + Http2
Ruby + Native
Node + Native

curl --request GET \
  --url https://api.leaseweb.com/publicCloud/v1/images \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

200
401
403
500
503

Content type

application/json

{"_metadata": {"totalCount": 12,
"limit": 20,
"offset": 0
},
"images": [{"id": "UBUNTU_24_04_64BIT",
"name": "Ubuntu 24.04 LTS (x86_64)",
"version": "24.04",
"family": "linux",
"flavour": "ubuntu",
"architecture": "x86_64",
"marketApps": [ ],
"storageTypes": ["LOCAL",
"CENTRAL"
]
},
{"id": "UBUNTU_22_04_64BIT",
"name": "Ubuntu 22.04 LTS (x86_64)",
"version": "22.04",
"family": "linux",
"flavour": "ubuntu",
"architecture": "x86_64",
"marketApps": ["LOADBALANCER"
],
"storageTypes": ["LOCAL",
"CENTRAL"
]
},
{"id": "UBUNTU_20_04_64BIT",
"name": "Ubuntu 20.04 LTS (x86_64)",
"version": "20.04",
"family": "linux",
"flavour": "ubuntu",
"architecture": "x86_64",
"marketApps": [ ],
"storageTypes": ["LOCAL",
"CENTRAL"
]
},
{"id": "DEBIAN_12_64BIT",
"name": "Debian 12 (x86_64)",
"version": "12",
"family": "linux",
"flavour": "debian",
"architecture": "x86_64",
"marketApps": [ ],
"storageTypes": ["LOCAL",
"CENTRAL"
]
},
{"id": "DEBIAN_11_64BIT",
"name": "Debian 11 (x86_64)",
"version": "11",
"family": "linux",
"flavour": "debian",
"architecture": "x86_64",
"marketApps": [ ],
"storageTypes": ["LOCAL",
"CENTRAL"
]
},
{"id": "FREEBSD_13_64BIT",
"name": "FreeBSD 13.2 (x86_64)",
"version": "13.2",
"family": "bsd",
"flavour": "freebsd",
"architecture": "x86_64",
"marketApps": [ ],
"storageTypes": ["LOCAL",
"CENTRAL"
]
},
{"id": "ALMALINUX_9_64BIT",
"name": "AlmaLinux 9 (x86_64)",
"version": "9",
"family": "linux",
"flavour": "almalinux",
"architecture": "x86_64",
"marketApps": [ ],
"storageTypes": ["LOCAL",
"CENTRAL"
]
},
{"id": "ALMALINUX_8_64BIT",
"name": "AlmaLinux 8 (x86_64)",
"version": "8",
"family": "linux",
"flavour": "almalinux",
"architecture": "x86_64",
"marketApps": [ ],
"storageTypes": ["LOCAL",
"CENTRAL"
]
},
{"id": "ROCKY_LINUX_9_64BIT",
"name": "Rocky Linux 9 (x86_64)",
"version": "9",
"family": "linux",
"flavour": "rockylinux",
"architecture": "x86_64",
"marketApps": [ ],
"storageTypes": ["LOCAL",
"CENTRAL"
]
},
{"id": "ROCKY_LINUX_8_64BIT",
"name": "Rocky Linux 8 (x86_64)",
"version": "8",
"family": "linux",
"flavour": "rockylinux",
"architecture": "x86_64",
"marketApps": [ ],
"storageTypes": ["LOCAL",
"CENTRAL"
]
},
{"id": "WINDOWS_SERVER_2022_STANDARD_64BIT",
"name": "Windows Server 2022 Standard (x64)",
"version": "2022",
"family": "windows",
"flavour": "windows",
"architecture": "x86_64",
"marketApps": [ ],
"storageTypes": ["CENTRAL"
]
}
]
}

Marketplace Apps

Get marketplace apps

Get all available marketplace apps.

Authorizations:

X-LSW-Auth

Responses

Request samples

Shell + Curl
Python + Python3
Php + Http2
Ruby + Native
Node + Native

curl --request GET \
  --url https://api.leaseweb.com/publicCloud/v1/marketApps \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

200
401
403
500
503

Content type

application/json

{"_metadata": {"totalCount": 1,
"limit": 20,
"offset": 0
},
"marketApps": [{"id": "LOADBALANCER",
"name": "Load Balancer",
"category": "LOAD_BALANCER",
"version": null,
"family": "loadbalancer",
"image": {"id": "UBUNTU_22_04_64BIT",
"name": "Ubuntu 22.04 LTS (x86_64)",
"version": "22.04",
"family": "linux",
"flavour": "ubuntu",
"architecture": "x86_64"
}
}
]
}

Metrics

Get instance data traffic metrics

Authorizations:

X-LSW-Auth

path Parameters

instanceId

required

string <uuid>

Example: 695ddd91-051f-4dd6-9120-938a927a47d0

Instance's ID

query Parameters

from	string <date> The start of the interval to get the metric
to	string <date> The end of the interval to get the metric. Must be greater than the date provided in `from`
granularity	string Value: "DAY" How the metrics are grouped by
aggregation	string Value: "SUM" How the metrics are aggregated

Responses

Request samples

Shell + Curl
Python + Python3
Php + Http2
Ruby + Native
Node + Native

curl --request GET \
  --url https://api.leaseweb.com/publicCloud/v1/instances/695ddd91-051f-4dd6-9120-938a927a47d0/metrics/datatraffic \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type

application/json

{"_metadata": {"from": "2023-10-01T00:00:00+00:00",
"to": "2023-10-31T00:00:00+00:00",
"granularity": "DAY",
"aggregation": "SUM",
"summary": {"DOWN_PUBLIC": {"average": "855.28 KB",
"expected": "25.66 MB",
"total": "1.71 MB",
"peak": {"value": "1.25 MB",
"timestamp": "2023-10-28T00:00:00+00:00"
}
},
"UP_PUBLIC": {"average": "3.69 MB",
"expected": "110.64 MB",
"total": "7.38 MB",
"peak": {"value": "6.94 MB",
"timestamp": "2023-10-28T00:00:00+00:00"
}
}
}
},
"metrics": {"DOWN_PUBLIC": {"values": [{"value": 461323,
"timestamp": "2023-10-27T00:00:00+00:00"
},
{"value": 1249243,
"timestamp": "2023-10-28T00:00:00+00:00"
}
],
"unit": "B"
},
"UP_PUBLIC": {"values": [{"value": 437565,
"timestamp": "2023-10-27T00:00:00+00:00"
},
{"value": 6938590,
"timestamp": "2023-10-28T00:00:00+00:00"
}
],
"unit": "B"
}
}
}

Get instance CPU metrics

Authorizations:

X-LSW-Auth

path Parameters

instanceId

required

string <uuid>

Example: 695ddd91-051f-4dd6-9120-938a927a47d0

Instance's ID

query Parameters

from	string <date> The start of the interval to get the metric
to	string <date> The end of the interval to get the metric. Must be greater than the date provided in `from`
granularity	string Enum: "5m" "10m" "30m" "60m" How the metrics are grouped by

Responses

Request samples

Shell + Curl
Python + Python3
Php + Http2
Ruby + Native
Node + Native

curl --request GET \
  --url https://api.leaseweb.com/publicCloud/v1/instances/695ddd91-051f-4dd6-9120-938a927a47d0/metrics/cpu \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type

application/json

{"_metadata": {"from": "2023-10-27T08:00:00+00:00",
"to": "2023-10-28T08:00:00+00:00",
"granularity": "5m",
"summary": {"cpuMetrics": {"average": "8.13 %",
"expected": "8.13 %",
"peak": {"value": "9.98 %",
"timestamp": "2023-10-27T08:10:24+00:00"
}
}
}
},
"metrics": {"cpuMetrics": {"values": [{"value": 5.45,
"timestamp": "2023-10-27T08:00:00+00:00"
},
{"value": 8.98,
"timestamp": "2023-10-27T08:05:32+00:00"
},
{"value": 9.98,
"timestamp": "2023-10-27T08:10:24+00:00"
}
],
"unit": "%"
}
}
}

Snapshots

List snapshots

List instance snapshots

Authorizations:

X-LSW-Auth

path Parameters

instanceId

required

string <uuid>

Example: 695ddd91-051f-4dd6-9120-938a927a47d0

Instance's ID

query Parameters

limit	integer Example: limit=20 Limit the number of results returned.
offset	integer Example: offset=10 Return results starting from the given offset.

Responses

Request samples

Shell + Curl
Python + Python3
Php + Http2
Ruby + Native
Node + Native

curl --request GET \
  --url 'https://api.leaseweb.com/publicCloud/v1/instances/695ddd91-051f-4dd6-9120-938a927a47d0/snapshots?limit=SOME_INTEGER_VALUE&offset=SOME_INTEGER_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type

application/json

{"_metadata": {"totalCount": 1,
"limit": 20,
"offset": 0
},
"snapshots": [{"id": "624c53c3-48e9-41d1-833f-90a9abf5fd95",
"displayName": "snapshot 1",
"state": "READY",
"created": "2023-11-02T07:31:28+0000"
}
]
}

Create instance snapshot

The instance must be running before the execution.

The time taken to create the snapshot depends on several factors, including memory size and usage.

Allowed only one snapshot per instance.

Authorizations:

X-LSW-Auth

path Parameters

instanceId

required

string <uuid>

Example: 695ddd91-051f-4dd6-9120-938a927a47d0

Instance's ID

Responses

Request samples

Shell + Curl
Python + Python3
Php + Http2
Ruby + Native
Node + Native

curl --request POST \
  --url https://api.leaseweb.com/publicCloud/v1/instances/695ddd91-051f-4dd6-9120-938a927a47d0/snapshots \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type

application/json

{"correlationId": "289346a1-3eaf-4da4-b707-62ef12eb08be",
"errorCode": "400",
"errorDetails": { },
"errorMessage": "The API could not interpret your request correctly."
}

Get snapshot detail

Authorizations:

X-LSW-Auth

path Parameters

instanceId required	string <uuid> Example: 695ddd91-051f-4dd6-9120-938a927a47d0 Instance's ID
snapshotId required	string <uuid>

Responses

Request samples

Shell + Curl
Python + Python3
Php + Http2
Ruby + Native
Node + Native

curl --request GET \
  --url https://api.leaseweb.com/publicCloud/v1/instances/695ddd91-051f-4dd6-9120-938a927a47d0/snapshots/%7BsnapshotId%7D \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type

application/json

{"created": "2023-11-02T07:31:28+0000",
"displayName": "snapshot 1",
"id": "ef73e9e2-95cd-49ef-940f-a24e6ad6c4a0",
"state": "READY"
}

Restore instance snapshot

Authorizations:

X-LSW-Auth

path Parameters

instanceId required	string <uuid> Example: 695ddd91-051f-4dd6-9120-938a927a47d0 Instance's ID
snapshotId required	string <uuid>

Responses

Request samples

Shell + Curl
Python + Python3
Php + Http2
Ruby + Native
Node + Native

curl --request PUT \
  --url https://api.leaseweb.com/publicCloud/v1/instances/695ddd91-051f-4dd6-9120-938a927a47d0/snapshots/%7BsnapshotId%7D \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type

application/json

{"correlationId": "289346a1-3eaf-4da4-b707-62ef12eb08be",
"errorCode": "400",
"errorDetails": { },
"errorMessage": "The API could not interpret your request correctly."
}

Delete instance snapshot

Authorizations:

X-LSW-Auth

path Parameters

instanceId required	string <uuid> Example: 695ddd91-051f-4dd6-9120-938a927a47d0 Instance's ID
snapshotId required	string <uuid>

Responses

Request samples

Shell + Curl
Python + Python3
Php + Http2
Ruby + Native
Node + Native

curl --request DELETE \
  --url https://api.leaseweb.com/publicCloud/v1/instances/695ddd91-051f-4dd6-9120-938a927a47d0/snapshots/%7BsnapshotId%7D \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type

application/json

{"correlationId": "289346a1-3eaf-4da4-b707-62ef12eb08be",
"errorCode": "400",
"errorDetails": { },
"errorMessage": "The API could not interpret your request correctly."
}

IPs

List instance's IPs

List the instance's IPs

Authorizations:

X-LSW-Auth

path Parameters

instanceId

required

string <uuid>

Example: 695ddd91-051f-4dd6-9120-938a927a47d0

Instance's ID

query Parameters

version	integer Example: version=4
nullRouted	boolean
ips	string A list of IPs separated by `\|`

Responses

Request samples

Shell + Curl
Python + Python3
Php + Http2
Ruby + Native
Node + Native

curl --request GET \
  --url https://api.leaseweb.com/publicCloud/v1/instances/695ddd91-051f-4dd6-9120-938a927a47d0/ips \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type

application/json

{"_metadata": {"totalCount": 1,
"limit": 20,
"offset": 0
},
"ips": [{"ip": "10.0.0.1",
"prefixLength": "28",
"version": 4,
"reverseLookup": null,
"mainIp": false,
"nullRouted": false,
"networkType": "INTERNAL",
"ddos": {"detectionProfile": "STANDARD_DEFAULT",
"protectionType": "STANDARD"
}
}
]
}

Get details about an instance's IP

Authorizations:

X-LSW-Auth

path Parameters

instanceId required	string <uuid> Example: 695ddd91-051f-4dd6-9120-938a927a47d0 Instance's ID
ip required	string <ip> Example: 10.0.0.1

Responses

Request samples

Shell + Curl
Python + Python3
Php + Http2
Ruby + Native
Node + Native

curl --request GET \
  --url https://api.leaseweb.com/publicCloud/v1/instances/695ddd91-051f-4dd6-9120-938a927a47d0/ips/%7Bip%7D \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type

application/json

{"ip": "10.0.0.1",
"prefixLength": "28",
"version": 4,
"reverseLookup": "a-valid-domain.xpto",
"mainIp": false,
"networkType": "INTERNAL",
"nullRouted": true,
"ddos": {"detectionProfile": "STANDARD_DEFAULT",
"protectionType": "STANDARD"
}
}

Update IP

Allows you to set the reverse lookup for the IP

Authorizations:

X-LSW-Auth

path Parameters

instanceId required	string <uuid> Example: 695ddd91-051f-4dd6-9120-938a927a47d0 Instance's ID
ip required	string <ip> Example: 10.0.0.1

Request Body schema: application/json
required

reverseLookup

required

string

Responses

Request samples

Content type

application/json

{"reverseLookup": "a-valid-domain.xpto"
}

Response samples

Content type

application/json

{"ip": "10.0.0.1",
"prefixLength": "28",
"version": 4,
"reverseLookup": "a-valid-domain.xpto",
"mainIp": false,
"networkType": "INTERNAL",
"nullRouted": true,
"ddos": {"detectionProfile": "STANDARD_DEFAULT",
"protectionType": "STANDARD"
}
}

Null route IP

Null route an IP. It may take a few minutes before the change is propagated across the network.

Only works for IPv4.

Authorizations:

X-LSW-Auth

path Parameters

instanceId required	string <uuid> Example: 695ddd91-051f-4dd6-9120-938a927a47d0 Instance's ID
ip required	string <ip> Example: 10.0.0.1

Request Body schema: application/json
optional

comment	string The reason why the IP is being null-routed
automatedUnnulingAt	integer [ 1 .. 17520 ] If provided, reverts the operation automatically in the specified value, in hours

Responses

Request samples

Content type

application/json

{"automatedUnnulingAt": 2,
"comment": "Getting DDoS"
}

Response samples

Content type

application/json

{"ip": "10.0.0.1",
"prefixLength": "28",
"version": 4,
"reverseLookup": "a-valid-domain.xpto",
"mainIp": false,
"networkType": "INTERNAL",
"nullRouted": true,
"ddos": {"detectionProfile": "STANDARD_DEFAULT",
"protectionType": "STANDARD"
}
}

Remove an IP null route

Remove an IP null route. It may take a few minutes before the change is propagated across the network

Authorizations:

X-LSW-Auth

path Parameters

instanceId required	string <uuid> Example: 695ddd91-051f-4dd6-9120-938a927a47d0 Instance's ID
ip required	string <ip> Example: 10.0.0.1

Responses

Request samples

Shell + Curl
Python + Python3
Php + Http2
Ruby + Native
Node + Native

curl --request POST \
  --url https://api.leaseweb.com/publicCloud/v1/instances/695ddd91-051f-4dd6-9120-938a927a47d0/ips/%7Bip%7D/unnull \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type

application/json

{"ip": "10.0.0.1",
"prefixLength": "28",
"version": 4,
"reverseLookup": "a-valid-domain.xpto",
"mainIp": false,
"networkType": "INTERNAL",
"nullRouted": true,
"ddos": {"detectionProfile": "STANDARD_DEFAULT",
"protectionType": "STANDARD"
}
}

Private Networks

Add instance to Private Network

Add instance to Private Network.

Cannot be performed when the instance has snapshots.

Authorizations:

X-LSW-Auth

path Parameters

instanceId

required

string <uuid>

Example: 695ddd91-051f-4dd6-9120-938a927a47d0

Instance's ID

Responses

Request samples

Shell + Curl
Python + Python3
Php + Http2
Ruby + Native
Node + Native

curl --request PUT \
  --url https://api.leaseweb.com/publicCloud/v1/instances/695ddd91-051f-4dd6-9120-938a927a47d0/addToPrivateNetwork \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type

application/json

{"correlationId": "289346a1-3eaf-4da4-b707-62ef12eb08be",
"errorCode": "400",
"errorDetails": { },
"errorMessage": "The API could not interpret your request correctly."
}

Remove instance from Private Network

Remove instance from Private Network.

Cannot be performed when the instance has snapshots.

Authorizations:

X-LSW-Auth

path Parameters

instanceId

required

string <uuid>

Example: 695ddd91-051f-4dd6-9120-938a927a47d0

Instance's ID

Responses

Request samples

Shell + Curl
Python + Python3
Php + Http2
Ruby + Native
Node + Native

curl --request DELETE \
  --url https://api.leaseweb.com/publicCloud/v1/instances/695ddd91-051f-4dd6-9120-938a927a47d0/removeFromPrivateNetwork \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type

application/json

{"correlationId": "289346a1-3eaf-4da4-b707-62ef12eb08be",
"errorCode": "400",
"errorDetails": { },
"errorMessage": "The API could not interpret your request correctly."
}

Load Balancer

Launch Load balancer

Launch a Load balancer.

Available regions can be obtained using /v1/regions.

Available load balancer types for your region can be obtained using /v1/loadBalancerTypes.

Authorizations:

X-LSW-Auth

Request Body schema: application/json
required

region required	string Region to launch the load balancer into
type required	string (typeName) Enum: "lsw.m3.large" "lsw.m3.xlarge" "lsw.m3.2xlarge" "lsw.m4.large" "lsw.m4.xlarge" "lsw.m4.2xlarge" "lsw.m4.4xlarge" "lsw.m5.large" "lsw.m5.xlarge" "lsw.m5.2xlarge" "lsw.m5.4xlarge" "lsw.m5a.large" "lsw.m5a.xlarge" "lsw.m5a.2xlarge" "lsw.m5a.4xlarge" "lsw.m5a.8xlarge" "lsw.m5a.12xlarge" "lsw.m6a.large" "lsw.m6a.xlarge" "lsw.m6a.2xlarge" "lsw.m6a.4xlarge" "lsw.m6a.8xlarge" "lsw.m6a.12xlarge" "lsw.m6a.16xlarge" "lsw.m6a.24xlarge" "lsw.c3.large" "lsw.c3.xlarge" "lsw.c3.2xlarge" "lsw.c3.4xlarge" "lsw.c4.large" "lsw.c4.xlarge" "lsw.c4.2xlarge" "lsw.c4.4xlarge" "lsw.c5.large" "lsw.c5.xlarge" "lsw.c5.2xlarge" "lsw.c5.4xlarge" "lsw.c5a.large" "lsw.c5a.xlarge" "lsw.c5a.2xlarge" "lsw.c5a.4xlarge" "lsw.c5a.9xlarge" "lsw.c5a.12xlarge" "lsw.c6a.large" "lsw.c6a.xlarge" "lsw.c6a.2xlarge" "lsw.c6a.4xlarge" "lsw.c6a.8xlarge" "lsw.c6a.12xlarge" "lsw.c6a.16xlarge" "lsw.c6a.24xlarge" "lsw.r3.large" "lsw.r3.xlarge" "lsw.r3.2xlarge" "lsw.r4.large" "lsw.r4.xlarge" "lsw.r4.2xlarge" "lsw.r5.large" "lsw.r5.xlarge" "lsw.r5.2xlarge" "lsw.r5a.large" "lsw.r5a.xlarge" "lsw.r5a.2xlarge" "lsw.r5a.4xlarge" "lsw.r5a.8xlarge" "lsw.r5a.12xlarge" "lsw.r6a.large" "lsw.r6a.xlarge" "lsw.r6a.2xlarge" "lsw.r6a.4xlarge" "lsw.r6a.8xlarge" "lsw.r6a.12xlarge" "lsw.r6a.16xlarge" "lsw.r6a.24xlarge" Instance/Load balancer type
reference	string An identifying name you can refer to the load balancer
contractType required	string Enum: "HOURLY" "MONTHLY" The contract applicable for the load balancer
billingFrequency required	integer Enum: 1 3 6 12 How often you wish to be charged. Used only when contract type is MONTHLY. '1' means every month, '3' every three months and so on.
rootDiskStorageType required	string (rootDiskStorageType) Enum: "LOCAL" "CENTRAL" The root disk's storage type
targetPort required	integer The port that the registered instances listen to

Responses

Request samples

Content type

application/json

{"billingFrequency": 1,
"contractType": "HOURLY",
"reference": "my-loadbalancer-1",
"region": "eu-west-3",
"rootDiskStorageType": "CENTRAL",
"targetPort": 443,
"type": "lsw.m3.large"
}

Response samples

Content type

application/json

{"privateNetwork": null,
"id": "32082a93-d1e2-4bc0-8f5e-8fe4312b0844",
"type": "lsw.m3.large",
"resources": {"cpu": {"value": 2,
"unit": "vCPU"
},
"memory": {"value": 7,
"unit": "GiB"
},
"publicNetworkSpeed": {"value": 1,
"unit": "Gbps"
},
"privateNetworkSpeed": {"value": 100,
"unit": "Mbps"
}
},
"autoScalingGroup": null,
"region": "eu-west-3",
"reference": "my-loadbalancer1",
"state": "RUNNING",
"ips": [{"ip": "85.99.99.99",
"prefixLength": "28",
"version": 4,
"nullRouted": false,
"reverseLookup": null,
"mainIp": false,
"networkType": "PUBLIC",
"ddos": {"detectionProfile": "STANDARD_DEFAULT",
"protectionType": "STANDARD"
}
}
],
"startedAt": "2024-04-09T15:11:37+00:00",
"contract": {"billingFrequency": 1,
"term": 0,
"type": "HOURLY",
"endsAt": null,
"renewalsAt": "2024-04-09T15:28:28+00:00",
"createdAt": "2024-04-09T15:11:21+00:00",
"state": "ACTIVE"
},
"configuration": {"stickySession": null,
"balance": "roundrobin",
"healthCheck": null,
"xForwardedFor": false,
"idleTimeOut": 60,
"targetPort": 80
}
}

Get load balancer list

List and filter load balancers

Authorizations:

X-LSW-Auth

query Parameters

limit	integer Example: limit=20 Limit the number of results returned.
offset	integer Example: offset=10 Return results starting from the given offset.
ip	string <ip> Example: ip=10.0.0.1
reference	string Example: reference=my-lb
id	string <uuid> Example: id=a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11
contractState	string Enum: "ACTIVE" "DELETE_SCHEDULED"
contractType	string Enum: "HOURLY" "MONTHLY" Example: contractType=HOURLY
state	string Enum: "RUNNING" "STARTING" "STOPPED" "STOPPING" "CREATING" "DESTROYED" "DESTROYING" Example: state=RUNNING
region	string Example: region=eu-west-3 Available regions can be found using the List Regions endpoint.
type	string Example: type=lsw.c3.xlarge Available load balancer types can be found using the List Load Balancer Types endpoint.

Responses

Request samples

Shell + Curl
Python + Python3
Php + Http2
Ruby + Native
Node + Native

curl --request GET \
  --url 'https://api.leaseweb.com/publicCloud/v1/loadBalancers?limit=SOME_INTEGER_VALUE&offset=SOME_INTEGER_VALUE&ip=SOME_STRING_VALUE&reference=SOME_STRING_VALUE&id=SOME_STRING_VALUE&contractState=SOME_STRING_VALUE&contractType=SOME_STRING_VALUE&state=SOME_STRING_VALUE&region=SOME_STRING_VALUE&type=SOME_STRING_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

200
401
403
500
503

Content type

application/json

{"_metadata": {"totalCount": 1,
"limit": 20,
"offset": 0
},
"loadBalancers": [{"privateNetwork": null,
"id": "5fd135a9-3ff6-4794-8b92-8cd8747a3ea3",
"type": "lsw.c3.4xlarge",
"resources": {"cpu": {"value": 16,
"unit": "vCPU"
},
"memory": {"value": 30,
"unit": "GiB"
},
"publicNetworkSpeed": {"value": 1,
"unit": "Gbps"
},
"privateNetworkSpeed": {"value": 100,
"unit": "Mbps"
}
},
"region": "eu-west-3",
"reference": "my-load-balancer",
"state": "RUNNING",
"rootDiskSize": 10,
"ips": [{"ip": "85.99.99.99",
"prefixLength": "28",
"version": 4,
"nullRouted": false,
"reverseLookup": null,
"networkType": "PUBLIC",
"mainIp": false,
"ddos": null
}
],
"startedAt": "2024-04-09T15:11:37+00:00",
"contract": {"billingFrequency": 1,
"term": 0,
"type": "HOURLY",
"endsAt": null,
"renewalsAt": "2024-04-09T15:28:28+00:00",
"createdAt": "2024-04-09T15:11:21+00:00",
"state": "ACTIVE"
},
"configuration": {"stickySession": {"enabled": true,
"maxLifeTime": 1000
},
"balance": "roundrobin",
"healthCheck": {"method": "GET",
"uri": "/",
"host": null,
"port": 80
},
"xForwardedFor": false,
"idleTimeOut": 60,
"targetPort": 442
},
"autoScalingGroup": {"id": "8714e190-8ca1-49cf-8594-0d019deff809",
"type": "MANUAL",
"state": "ACTIVE",
"desiredAmount": 1,
"region": "eu-west-3",
"reference": "ono",
"createdAt": "2024-06-14T09:12:08+00:00",
"updatedAt": "2024-06-14T09:12:08+00:00",
"startsAt": null,
"endsAt": null,
"minimumAmount": null,
"maximumAmount": null,
"cpuThreshold": null,
"warmupTime": null,
"cooldownTime": null
}
}
]
}

Get load balancer details

Get details about the load balancer

Authorizations:

X-LSW-Auth

path Parameters

loadBalancerId

required

string <uuid>

Example: 695ddd91-051f-4dd6-9120-938a927a47d0

Load balancer ID

Responses

Request samples

Shell + Curl
Python + Python3
Php + Http2
Ruby + Native
Node + Native

curl --request GET \
  --url https://api.leaseweb.com/publicCloud/v1/loadBalancers/695ddd91-051f-4dd6-9120-938a927a47d0 \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type

application/json

{"privateNetwork": null,
"id": "32082a93-d1e2-4bc0-8f5e-8fe4312b0844",
"type": "lsw.m3.large",
"resources": {"cpu": {"value": 2,
"unit": "vCPU"
},
"memory": {"value": 7,
"unit": "GiB"
},
"publicNetworkSpeed": {"value": 1,
"unit": "Gbps"
},
"privateNetworkSpeed": {"value": 100,
"unit": "Mbps"
}
},
"autoScalingGroup": null,
"region": "eu-west-3",
"reference": "my-loadbalancer1",
"state": "RUNNING",
"ips": [{"ip": "85.99.99.99",
"prefixLength": "28",
"version": 4,
"nullRouted": false,
"reverseLookup": null,
"mainIp": false,
"networkType": "PUBLIC",
"ddos": {"detectionProfile": "STANDARD_DEFAULT",
"protectionType": "STANDARD"
}
}
],
"startedAt": "2024-04-09T15:11:37+00:00",
"contract": {"billingFrequency": 1,
"term": 0,
"type": "HOURLY",
"endsAt": null,
"renewalsAt": "2024-04-09T15:28:28+00:00",
"createdAt": "2024-04-09T15:11:21+00:00",
"state": "ACTIVE"
},
"configuration": {"stickySession": null,
"balance": "roundrobin",
"healthCheck": null,
"xForwardedFor": false,
"idleTimeOut": 60,
"targetPort": 80
}
}

Delete load balancer

Terminate a Load balancer

Authorizations:

X-LSW-Auth

path Parameters

loadBalancerId

required

string <uuid>

Example: 695ddd91-051f-4dd6-9120-938a927a47d0

Load balancer ID

Responses

Request samples

Shell + Curl
Python + Python3
Php + Http2
Ruby + Native
Node + Native

curl --request DELETE \
  --url https://api.leaseweb.com/publicCloud/v1/loadBalancers/695ddd91-051f-4dd6-9120-938a927a47d0 \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type

application/json

{"correlationId": "289346a1-3eaf-4da4-b707-62ef12eb08be",
"errorCode": "400",
"errorDetails": { },
"errorMessage": "The API could not interpret your request correctly."
}

Update load balancer

Update load balancer configurations

Authorizations:

X-LSW-Auth

path Parameters

loadBalancerId

required

string <uuid>

Example: 695ddd91-051f-4dd6-9120-938a927a47d0

Load balancer ID

Request Body schema: application/json
required

type	string (typeName) Enum: "lsw.m3.large" "lsw.m3.xlarge" "lsw.m3.2xlarge" "lsw.m4.large" "lsw.m4.xlarge" "lsw.m4.2xlarge" "lsw.m4.4xlarge" "lsw.m5.large" "lsw.m5.xlarge" "lsw.m5.2xlarge" "lsw.m5.4xlarge" "lsw.m5a.large" "lsw.m5a.xlarge" "lsw.m5a.2xlarge" "lsw.m5a.4xlarge" "lsw.m5a.8xlarge" "lsw.m5a.12xlarge" "lsw.m6a.large" "lsw.m6a.xlarge" "lsw.m6a.2xlarge" "lsw.m6a.4xlarge" "lsw.m6a.8xlarge" "lsw.m6a.12xlarge" "lsw.m6a.16xlarge" "lsw.m6a.24xlarge" "lsw.c3.large" "lsw.c3.xlarge" "lsw.c3.2xlarge" "lsw.c3.4xlarge" "lsw.c4.large" "lsw.c4.xlarge" "lsw.c4.2xlarge" "lsw.c4.4xlarge" "lsw.c5.large" "lsw.c5.xlarge" "lsw.c5.2xlarge" "lsw.c5.4xlarge" "lsw.c5a.large" "lsw.c5a.xlarge" "lsw.c5a.2xlarge" "lsw.c5a.4xlarge" "lsw.c5a.9xlarge" "lsw.c5a.12xlarge" "lsw.c6a.large" "lsw.c6a.xlarge" "lsw.c6a.2xlarge" "lsw.c6a.4xlarge" "lsw.c6a.8xlarge" "lsw.c6a.12xlarge" "lsw.c6a.16xlarge" "lsw.c6a.24xlarge" "lsw.r3.large" "lsw.r3.xlarge" "lsw.r3.2xlarge" "lsw.r4.large" "lsw.r4.xlarge" "lsw.r4.2xlarge" "lsw.r5.large" "lsw.r5.xlarge" "lsw.r5.2xlarge" "lsw.r5a.large" "lsw.r5a.xlarge" "lsw.r5a.2xlarge" "lsw.r5a.4xlarge" "lsw.r5a.8xlarge" "lsw.r5a.12xlarge" "lsw.r6a.large" "lsw.r6a.xlarge" "lsw.r6a.2xlarge" "lsw.r6a.4xlarge" "lsw.r6a.8xlarge" "lsw.r6a.12xlarge" "lsw.r6a.16xlarge" "lsw.r6a.24xlarge" Instance/Load balancer type
reference	string An identifying name you can refer to the load balancer
contractType	string (contractType) Enum: "HOURLY" "MONTHLY" Select HOURLY for billing based on hourly usage, else MONTHLY for billing per month usage
	object or null (stickySession)
balance	string (balance) Enum: "roundrobin" "leastconn" "source" Algorithm to be used for load balancer
	object or null (healthCheck)
xForwardedFor	boolean Is xForwardedFor enabled or not
idleTimeOut	integer Time to close the connection if load balancer is idle
targetPort	integer Port on which the backend (target) servers are listening to handle incoming requests

Responses

Request samples

Content type

application/json

{"balance": "roundrobin",
"contractType": "HOURLY",
"idleTimeOut": 60,
"reference": "foo",
"targetPort": 9000,
"type": "lsw.m3.xlarge",
"xForwardedFor": false
}

Response samples

Content type

application/json

{"privateNetwork": null,
"id": "32082a93-d1e2-4bc0-8f5e-8fe4312b0844",
"type": "lsw.m3.large",
"resources": {"cpu": {"value": 2,
"unit": "vCPU"
},
"memory": {"value": 7,
"unit": "GiB"
},
"publicNetworkSpeed": {"value": 1,
"unit": "Gbps"
},
"privateNetworkSpeed": {"value": 100,
"unit": "Mbps"
}
},
"autoScalingGroup": null,
"region": "eu-west-3",
"reference": "my-loadbalancer1",
"state": "RUNNING",
"ips": [{"ip": "85.99.99.99",
"prefixLength": "28",
"version": 4,
"nullRouted": false,
"reverseLookup": null,
"mainIp": false,
"networkType": "PUBLIC",
"ddos": {"detectionProfile": "STANDARD_DEFAULT",
"protectionType": "STANDARD"
}
}
],
"startedAt": "2024-04-09T15:11:37+00:00",
"contract": {"billingFrequency": 1,
"term": 0,
"type": "HOURLY",
"endsAt": null,
"renewalsAt": "2024-04-09T15:28:28+00:00",
"createdAt": "2024-04-09T15:11:21+00:00",
"state": "ACTIVE"
},
"configuration": {"stickySession": null,
"balance": "roundrobin",
"healthCheck": null,
"xForwardedFor": false,
"idleTimeOut": 60,
"targetPort": 80
}
}

Create listener

Authorizations:

X-LSW-Auth

path Parameters

loadBalancerId

required

string <uuid>

Example: 695ddd91-051f-4dd6-9120-938a927a47d0

Load balancer ID

Request Body schema: application/json
required

protocol required	string Enum: "HTTPS" "HTTP" "TCP"
port required	integer Port that the listener listens to
	object (certificate)

Responses

Request samples

Content type

application/json

{"protocol": "HTTPS",
"port": 443,
"certificate": {"chain": "-----BEGIN CERTIFICATE-----MIICNDCCAZ2gAwIBAgIUEby6nzM+o7vkKfzcMS/DGA8tgwQwDQYJKoZIhvcNAQELBQAwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgMClNvbWUtU3RhdGUxITAfBgNVBAoMGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZDAeFw0yNDA0MjUwODE3MjZaFw0yNTA0MjUwODE3MjZaMEUxCzAJBgNVBAYTAkFVMRMwEQYDVQQIDApTb21lLVN0YXRlMSEwHwYDVQQKDBhJbnRlcm5ldCBXaWRnaXRzIFB0eSBMdGQwgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMMiux2r1AFLVpIhdZ0bvgIvhiT9XCnfHJlGE7OarGKDKJDQ6XAquCfosLws2XAugGcMJWrsqVWtJEYSu6OMsDLYCJhh39AKqZIW0pktkr8LGlo4VLvzGPqwpHnzWthyCEFsE6p+JJQumDA/izJm2zjZL+xHDocOlNqDTB87AIdrAgMBAAGjITAfMB0GA1UdDgQWBBT3sXUrIR2vcwak0QCXoIsxHa4dDDANBgkqhkiG9w0BAQsFAAOBgQCh/l+5s713J02b8sWicUK2KjTPfyKmZFkoS+Mlo+//B/aM612ZJpGL2tAKGF3v0NDOrRYLZj0t/tlZI55pUNJI9cNj/RExvnfTSSNJIbV+8kQt5AHo50wGxj/apkuEtQre2Fpf4pyovcfIoF6HJvvp1jy96yL14UoEehZypR8FlA==-----END CERTIFICATE-----",
"certificate": "-----BEGIN CERTIFICATE-----MIIBhDCB7gIBADBFMQswCQYDVQQGEwJBVTETMBEGA1UECAwKU29tZS1TdGF0ZTEhMB8GA1UECgwYSW50ZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCtWdKNbZxvkXKAADjJMJ7VTJz6uFoMD403C+gMIF8hwqIsHggzCao6iXrW9sZoyZtUBVBiiq5RumHbbpwvOdMmXrShEB4sTJkWRMDy7yD4D91WCU1fc10E/zBJMwssAvmHZo5kGW1Pj1N9ktb+O/TMsEc6yd5suvdQj6aaJbQlTQIDAQABoAAwDQYJKoZIhvcNAQELBQADgYEAWOQ2CJLRo8MQgJgvhdoSIkHITnrbjB5hS3f/dx0lIcnyI6Q9nOyuQHXkCgkdBaV8lz7l+IbqcGc3CaIRP2ZIVFvo2252n630tOOSsqoqJS1tYIoIKsohi3T3d8T1i/s0BWbTJi8Xgd186wyUn/jHwXROKx2rq6yYsAO6fISDKw8=-----END CERTIFICATE-----",
"privateKey": "-----BEGIN EC PRIVATE KEY-----MIHcAgEBBEIBVlC0IObonfQZIQ81l/WILKfWT5Fv96eNnYmQZ7uleu73igfiVESVuPfNlbW9oNEK1XcXli4YNZMxWMkKuzC3w8CgBwYFK4EEACOhgYkDgYYABAHvOqz9d2xeSpm1FNdw0NR5j/q6PMd6whZFsTPNYNj0/PsTpsHk78ZB4MYnJUXwHJjpj+gnKkLNc02f4w/vSF8VXADX4l40XU/w82TAOCftQwoxO5o0jZcwEUIYzl02Zd7uNxhjtKJQnYFi9x8WI8L8zQ6GZB/fJKYwoHaUr0I1h/5LzQ==-----END EC PRIVATE KEY-----"
}
}

Response samples

Content type

application/json

{"protocol": "HTTPS",
"port": 443,
"id": "fac06878-6655-4956-8ea7-124a97f133ab"
}

Get listener details

Get details about a listener

Authorizations:

X-LSW-Auth

path Parameters

loadBalancerId required	string <uuid> Example: 695ddd91-051f-4dd6-9120-938a927a47d0 Load balancer ID
listenerId required	string <uuid> Example: 695ddd91-051f-4dd6-9120-938a927a47d0 Listener ID

Responses

Request samples

Shell + Curl
Python + Python3
Php + Http2
Ruby + Native
Node + Native

curl --request GET \
  --url https://api.leaseweb.com/publicCloud/v1/loadBalancers/695ddd91-051f-4dd6-9120-938a927a47d0/listeners/695ddd91-051f-4dd6-9120-938a927a47d0 \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type

application/json

{"protocol": "HTTPS",
"port": 443,
"id": "fac06878-6655-4956-8ea7-124a97f133ab"
}

Update a listener

Authorizations:

X-LSW-Auth

path Parameters

loadBalancerId required	string <uuid> Example: 695ddd91-051f-4dd6-9120-938a927a47d0 Load balancer ID
listenerId required	string <uuid> Example: 695ddd91-051f-4dd6-9120-938a927a47d0 Listener ID

Request Body schema: application/json
required

protocol required	string Enum: "HTTPS" "HTTP" "TCP"
port required	integer Port that the listener listens to
	object (certificate)

Responses

Request samples

Content type

application/json

{"protocol": "HTTPS",
"port": 443,
"certificate": {"chain": "-----BEGIN CERTIFICATE-----MIICNDCCAZ2gAwIBAgIUEby6nzM+o7vkKfzcMS/DGA8tgwQwDQYJKoZIhvcNAQELBQAwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgMClNvbWUtU3RhdGUxITAfBgNVBAoMGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZDAeFw0yNDA0MjUwODE3MjZaFw0yNTA0MjUwODE3MjZaMEUxCzAJBgNVBAYTAkFVMRMwEQYDVQQIDApTb21lLVN0YXRlMSEwHwYDVQQKDBhJbnRlcm5ldCBXaWRnaXRzIFB0eSBMdGQwgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMMiux2r1AFLVpIhdZ0bvgIvhiT9XCnfHJlGE7OarGKDKJDQ6XAquCfosLws2XAugGcMJWrsqVWtJEYSu6OMsDLYCJhh39AKqZIW0pktkr8LGlo4VLvzGPqwpHnzWthyCEFsE6p+JJQumDA/izJm2zjZL+xHDocOlNqDTB87AIdrAgMBAAGjITAfMB0GA1UdDgQWBBT3sXUrIR2vcwak0QCXoIsxHa4dDDANBgkqhkiG9w0BAQsFAAOBgQCh/l+5s713J02b8sWicUK2KjTPfyKmZFkoS+Mlo+//B/aM612ZJpGL2tAKGF3v0NDOrRYLZj0t/tlZI55pUNJI9cNj/RExvnfTSSNJIbV+8kQt5AHo50wGxj/apkuEtQre2Fpf4pyovcfIoF6HJvvp1jy96yL14UoEehZypR8FlA==-----END CERTIFICATE-----",
"certificate": "-----BEGIN CERTIFICATE-----MIIBhDCB7gIBADBFMQswCQYDVQQGEwJBVTETMBEGA1UECAwKU29tZS1TdGF0ZTEhMB8GA1UECgwYSW50ZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCtWdKNbZxvkXKAADjJMJ7VTJz6uFoMD403C+gMIF8hwqIsHggzCao6iXrW9sZoyZtUBVBiiq5RumHbbpwvOdMmXrShEB4sTJkWRMDy7yD4D91WCU1fc10E/zBJMwssAvmHZo5kGW1Pj1N9ktb+O/TMsEc6yd5suvdQj6aaJbQlTQIDAQABoAAwDQYJKoZIhvcNAQELBQADgYEAWOQ2CJLRo8MQgJgvhdoSIkHITnrbjB5hS3f/dx0lIcnyI6Q9nOyuQHXkCgkdBaV8lz7l+IbqcGc3CaIRP2ZIVFvo2252n630tOOSsqoqJS1tYIoIKsohi3T3d8T1i/s0BWbTJi8Xgd186wyUn/jHwXROKx2rq6yYsAO6fISDKw8=-----END CERTIFICATE-----",
"privateKey": "-----BEGIN EC PRIVATE KEY-----MIHcAgEBBEIBVlC0IObonfQZIQ81l/WILKfWT5Fv96eNnYmQZ7uleu73igfiVESVuPfNlbW9oNEK1XcXli4YNZMxWMkKuzC3w8CgBwYFK4EEACOhgYkDgYYABAHvOqz9d2xeSpm1FNdw0NR5j/q6PMd6whZFsTPNYNj0/PsTpsHk78ZB4MYnJUXwHJjpj+gnKkLNc02f4w/vSF8VXADX4l40XU/w82TAOCftQwoxO5o0jZcwEUIYzl02Zd7uNxhjtKJQnYFi9x8WI8L8zQ6GZB/fJKYwoHaUr0I1h/5LzQ==-----END EC PRIVATE KEY-----"
}
}

Response samples

Content type

application/json

{"protocol": "HTTPS",
"port": 443,
"id": "fac06878-6655-4956-8ea7-124a97f133ab"
}

Delete load balancer listener

Delete a listener

Authorizations:

X-LSW-Auth

path Parameters

loadBalancerId required	string <uuid> Example: 695ddd91-051f-4dd6-9120-938a927a47d0 Load balancer ID
listenerId required	string <uuid> Example: 695ddd91-051f-4dd6-9120-938a927a47d0 Listener ID

Responses

Request samples

Shell + Curl
Python + Python3
Php + Http2
Ruby + Native
Node + Native

curl --request DELETE \
  --url https://api.leaseweb.com/publicCloud/v1/loadBalancers/695ddd91-051f-4dd6-9120-938a927a47d0/listeners/695ddd91-051f-4dd6-9120-938a927a47d0 \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type

application/json

{"correlationId": "289346a1-3eaf-4da4-b707-62ef12eb08be",
"errorCode": "400",
"errorDetails": { },
"errorMessage": "The API could not interpret your request correctly."
}

List registered targets

List targets registered in a load balancer.

Authorizations:

X-LSW-Auth

path Parameters

loadBalancerId

required

string <uuid>

Example: 695ddd91-051f-4dd6-9120-938a927a47d0

Load balancer ID

Responses

Request samples

Shell + Curl
Python + Python3
Php + Http2
Ruby + Native
Node + Native

curl --request GET \
  --url https://api.leaseweb.com/publicCloud/v1/loadBalancers/695ddd91-051f-4dd6-9120-938a927a47d0/targets \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type

application/json

{"_metadata": {"totalCount": 2,
"limit": 20,
"offset": 0
},
"targets": [{"id": "0af98842-38a4-4fe5-8b6d-687730e8d8c1",
"reference": "lb instance 1",
"image": {"id": "UBUNTU_22_04_64BIT",
"name": "Ubuntu 22.04 LTS (x86_64)",
"version": "22.04",
"family": "linux",
"flavour": "ubuntu",
"architecture": "x86_64"
},
"state": "RUNNING",
"ips": [{"ip": "10.32.60.2",
"prefixLength": "32",
"version": 4,
"nullRouted": false,
"reverseLookup": null,
"networkType": "INTERNAL",
"mainIp": false
}
],
"healthCheckStatus": {"checkStatus": "Connection timeout",
"status": "DOWN"
}
},
{"id": "8be7f8c6-e8c0-4321-a01e-ac754e2f6872",
"reference": "lb instance 2",
"image": {"id": "UBUNTU_22_04_64BIT",
"name": "Ubuntu 22.04 LTS (x86_64)",
"version": "22.04",
"family": "linux",
"flavour": "ubuntu",
"architecture": "x86_64"
},
"state": "RUNNING",
"ips": [{"ip": "85.17.17.71",
"prefixLength": "32",
"version": 4,
"nullRouted": false,
"reverseLookup": null,
"networkType": "PUBLIC",
"mainIp": true
}
]
}
]
}

Register targets

Register targets in a load balancer. Instances must be running and have private network enabled so they can be registered.

Authorizations:

X-LSW-Auth

path Parameters

loadBalancerId

required

string <uuid>

Example: 695ddd91-051f-4dd6-9120-938a927a47d0

Load balancer ID

Request Body schema: application/json
required

Array of objects (loadBalancerTargetOpt)

Responses

Request samples

Content type

application/json

{"targets": [{"id": "8be7f8c6-e8c0-4321-a01e-ac754e2f6872"
},
{"id": "b05917e1-96a4-442a-900c-c41f273d95c9"
}
]
}

Response samples

400
401
403
500
503

Content type

application/json

{"correlationId": "289346a1-3eaf-4da4-b707-62ef12eb08be",
"errorCode": "400",
"errorDetails": { },
"errorMessage": "The API could not interpret your request correctly."
}

Deregister targets

Deregister targets registered in a load balancer.

Authorizations:

X-LSW-Auth

path Parameters

loadBalancerId

required

string <uuid>

Example: 695ddd91-051f-4dd6-9120-938a927a47d0

Load balancer ID

Request Body schema: application/json
required

Array of objects (loadBalancerTargetOpt)

Responses

Request samples

Content type

application/json

{"targets": [{"id": "8be7f8c6-e8c0-4321-a01e-ac754e2f6872"
},
{"id": "b05917e1-96a4-442a-900c-c41f273d95c9"
}
]
}

Response samples

400
401
403
500
503

Content type

application/json

{"correlationId": "289346a1-3eaf-4da4-b707-62ef12eb08be",
"errorCode": "400",
"errorDetails": { },
"errorMessage": "The API could not interpret your request correctly."
}

Auto Scaling Groups

Create Auto Scaling Group

Create an Auto Scaling Group.

Authorizations:

X-LSW-Auth

Request Body schema: application/json
required

desiredAmount	integer >= 1 Required for "MANUAL" and "SCHEDULED" auto scaling group. Number of instances to be launched
minimumAmount	integer >= 1 Required for "CPU_BASED". The minimum number of instances that should be running
maximumAmount	integer >= 1 Required for "CPU_BASED" auto scaling group. The maximum number of instances that can be running
cpuThreshold	integer [ 1 .. 100 ] Required for "CPU_BASED" auto scaling group. The target average CPU utilization for scaling
warmupTime	integer [ 60 .. 900 ] Required for "CPU_BASED" auto scaling group. Warm-up time in seconds for new instances
cooldownTime	integer [ 300 .. 900 ] Required for "CPU_BASED" auto scaling group. Cool-down time in seconds for new instances
instanceId required	string <uuid> The instance on which instances will be based on. This instance needs to be either Running or Stopped
reference required	string <= 255 characters The identifying name set to the auto scaling group
type required	string Enum: "MANUAL" "SCHEDULED" "CPU_BASED"
startsAt	string <date-time> Required for "SCHEDULED" auto scaling group. Date and time (UTC) that the instances need to be launched
endsAt	string <date-time> Required for "SCHEDULED" auto scaling group. Date and time (UTC) that the instances need to be terminated

Responses

Request samples

Content type

application/json

Example

Manual

{"reference": "Manual scaling",
"type": "MANUAL",
"desiredAmount": 2,
"instanceId": "6762182e-7ae9-4d0b-b3b7-bea5a49b3f94"
}

Response samples

Content type

application/json

{"cooldownTime": null,
"cpuThreshold": null,
"createdAt": "2024-05-28T11:03:31+00:00",
"desiredAmount": 2,
"endsAt": null,
"id": "4c3e9d29-9232-48af-93a7-7ec42b8c0f6d",
"loadBalancer": null,
"maximumAmount": null,
"minimumAmount": null,
"reference": "Manual Auto Scaling Group",
"region": "eu-west-3",
"startsAt": null,
"state": "CREATING",
"type": "MANUAL",
"updatedAt": "2024-05-28T11:03:31+00:00",
"warmupTime": null
}

Get Auto Scaling Group list

List and filter Auto Scaling Groups

Authorizations:

X-LSW-Auth

query Parameters

limit	integer Example: limit=20 Limit the number of results returned.
offset	integer Example: offset=10 Return results starting from the given offset.
id	string <uuid> Example: id=a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11
instanceId	string <uuid> Example: instanceId=6762182e-7ae9-4d0b-b3b7-bea5a49b3f94
type	string Enum: "MANUAL" "SCHEDULED" "CPU_BASED" The Auto Scaling Group's type
region	string Example: region=eu-west-3 The region in which the Auto Scaling Group was created
reference	string The reference used to identify identifies the Auto Scaling Group
state	string Enum: "ACTIVE" "CREATING" "CREATED" "DESTROYED" "DESTROYING" "SCALING" "UPDATING" The Auto Scaling Group's current state

Responses

Request samples

Shell + Curl
Python + Python3
Php + Http2
Ruby + Native
Node + Native

curl --request GET \
  --url 'https://api.leaseweb.com/publicCloud/v1/autoScalingGroups?limit=SOME_INTEGER_VALUE&offset=SOME_INTEGER_VALUE&id=SOME_STRING_VALUE&instanceId=SOME_STRING_VALUE&type=SOME_STRING_VALUE&region=SOME_STRING_VALUE&reference=SOME_STRING_VALUE&state=SOME_STRING_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type

application/json

{"_metadata": {"totalCount": 3,
"limit": 10,
"offset": 0
},
"autoScalingGroups": [{"id": "fb769dab-3daa-47e4-89ed-06a4b6499176",
"type": "MANUAL",
"state": "ACTIVE",
"desiredAmount": 2,
"minimumAmount": null,
"maximumAmount": null,
"cpuThreshold": null,
"warmupTime": null,
"cooldownTime": null,
"region": "eu-west-3",
"reference": "Manual Auto Scaling Group",
"createdAt": "2024-04-26T09:22:25+00:00",
"updatedAt": "2024-04-26T09:22:25+00:00",
"startsAt": null,
"endsAt": null
},
{"id": "aa0f2138-3a83-46fe-bdcf-1ad231f94a26",
"type": "SCHEDULED",
"state": "SCALING",
"desiredAmount": 2,
"minimumAmount": null,
"maximumAmount": null,
"cpuThreshold": null,
"cooldownTime": null,
"warmupTime": null,
"region": "eu-west-3",
"reference": "Scheduled Auto Scaling Group",
"createdAt": "2024-05-13T15:49:52+00:00",
"updatedAt": "2024-05-13T15:49:52+00:00",
"startsAt": "2024-05-01T08:00:00+00:00",
"endsAt": "2024-05-01T12:00:00+00:00"
},
{"id": "49e28a6c-3f2a-442e-b3b1-981856d21677",
"type": "CPU_BASED",
"state": "CREATING",
"desiredAmount": 1,
"minimumAmount": 1,
"maximumAmount": 3,
"cpuThreshold": 50,
"warmupTime": 300,
"cooldownTime": 300,
"region": "eu-west-3",
"reference": "CPU Based Auto Scaling Group",
"createdAt": "2024-05-13T15:49:52+00:00",
"updatedAt": "2024-05-13T15:49:52+00:00",
"startsAt": null,
"endsAt": null
}
]
}

Delete Auto Scaling Group

Delete an Auto Scaling Group.

Authorizations:

X-LSW-Auth

path Parameters

autoScalingGroupId

required

string <uuid>

Example: fb769dab-3daa-47e4-89ed-06a4b6499176

Auto Scaling Group ID

Responses

Request samples

Shell + Curl
Python + Python3
Php + Http2
Ruby + Native
Node + Native

curl --request DELETE \
  --url https://api.leaseweb.com/publicCloud/v1/autoScalingGroups/fb769dab-3daa-47e4-89ed-06a4b6499176 \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

400
401
403
500
503

Content type

application/json

{"correlationId": "289346a1-3eaf-4da4-b707-62ef12eb08be",
"errorCode": "400",
"errorDetails": { },
"errorMessage": "The API could not interpret your request correctly."
}

Update Auto Scaling Group

Update an Auto Scaling Group.

Authorizations:

X-LSW-Auth

path Parameters

autoScalingGroupId

required

string <uuid>

Example: fb769dab-3daa-47e4-89ed-06a4b6499176

Auto Scaling Group ID

Request Body schema: application/json
required

desiredAmount	integer >= 1 When "SCHEDULED", the number of instances that need to be running at the specified date and time. When "MANUAL", the number of instances that to be launched immediately.
minimumAmount	integer >= 1 The minimum number of instances that should be running
maximumAmount	integer >= 1 Only for "CPU_BASED" auto scaling group. The maximum number of instances that can be running
cpuThreshold	integer [ 1 .. 100 ] Only for "CPU_BASED" auto scaling group. The target average CPU utilization for scaling
warmupTime	integer [ 60 .. 900 ] Only for "CPU_BASED" auto scaling group. Warm-up time in seconds for new instances
cooldownTime	integer [ 300 .. 900 ] Only for "CPU_BASED" auto scaling group. Cool-down time in seconds for new instances
reference	string <= 255 characters The identifying name set to the auto scaling group
startsAt	string <date-time> Only for "SCHEDULED" auto scaling group. Date and time (UTC) that the instances need to be launched. Must be changed along with "endsAt"
endsAt	string <date-time> Only for "SCHEDULED" auto scaling group. Date and time (UTC) that the instances need to be terminated. Must be changed along with "startsAt"

Responses

Request samples

Content type

application/json

Example

Manual - update everything

{"reference": "Changed reference",
"desiredAmount": 4
}

Response samples

Content type

application/json

{"cooldownTime": 300,
"cpuThreshold": 60,
"createdAt": "2024-05-13T15:49:52+00:00",
"desiredAmount": 4,
"endsAt": null,
"id": "fb769dab-3daa-47e4-89ed-06a4b6499176",
"loadBalancer": {"id": "52082a93-d1e2-4bc0-8f5e-8fe4312b0846",
"type": "lsw.m3.large",
"resources": {"cpu": {"value": 2,
"unit": "vCPU"
},
"memory": {"value": 7,
"unit": "GiB"
},
"publicNetworkSpeed": {"value": 1,
"unit": "Gbps"
},
"privateNetworkSpeed": {"value": 1,
"unit": "Gbps"
}
},
"reference": "lb-integrated-with-asg",
"state": "RUNNING",
"startedAt": "2024-05-28T08:50:51+00:00"
},
"maximumAmount": 8,
"minimumAmount": 4,
"reference": "CPU Based Auto Scaling",
"region": "eu-west-3",
"startsAt": null,
"state": "SCALING",
"type": "CPU_BASED",
"updatedAt": "2024-05-13T15:49:52+00:00",
"warmupTime": 400
}

Get Auto Scaling Group details

Get details about Auto Scaling Group.

Authorizations:

X-LSW-Auth

path Parameters

autoScalingGroupId

required

string <uuid>

Example: fb769dab-3daa-47e4-89ed-06a4b6499176

Auto Scaling Group ID

Responses

Request samples

Shell + Curl
Python + Python3
Php + Http2
Ruby + Native
Node + Native

curl --request GET \
  --url https://api.leaseweb.com/publicCloud/v1/autoScalingGroups/fb769dab-3daa-47e4-89ed-06a4b6499176 \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type

application/json

{"cooldownTime": null,
"cpuThreshold": null,
"createdAt": "2024-04-26T09:22:25+00:00",
"desiredAmount": 2,
"endsAt": null,
"id": "fb769dab-3daa-47e4-89ed-06a4b6499176",
"loadBalancer": {"id": "32082a93-d1e2-4bc0-8f5e-8fe4312b0844",
"type": "lsw.m3.large",
"resources": {"cpu": {"value": 2,
"unit": "vCPU"
},
"memory": {"value": 7,
"unit": "GiB"
},
"publicNetworkSpeed": {"value": 1,
"unit": "Gbps"
},
"privateNetworkSpeed": {"value": 100,
"unit": "Mbps"
}
},
"reference": "lb-integrated-with-asg",
"state": "RUNNING",
"startedAt": "2024-05-28T08:50:51+00:00"
},
"maximumAmount": null,
"minimumAmount": null,
"reference": "Manual Auto Scaling Group",
"region": "eu-west-3",
"startsAt": null,
"state": "ACTIVE",
"type": "MANUAL",
"updatedAt": "2024-04-26T09:22:25+00:00",
"warmupTime": null
}

Register Load balancer

Associates a Load Balancer with an Auto Scaling Group to distribute incoming traffic across the instances within the group.

Authorizations:

X-LSW-Auth

path Parameters

autoScalingGroupId

required

string <uuid>

Example: fb769dab-3daa-47e4-89ed-06a4b6499176

Auto Scaling Group ID

Request Body schema: application/json
required

loadBalancerId

required

string

Load balancer ID

Responses

Request samples

Content type

application/json

{"loadBalancerId": "2b52cc0a-2de9-47c2-8ce2-eb1bb468cfcd"
}

Response samples

Content type

application/json

{"cooldownTime": null,
"cpuThreshold": null,
"createdAt": "2024-04-26T09:22:25+00:00",
"desiredAmount": 2,
"endsAt": null,
"id": "fb769dab-3daa-47e4-89ed-06a4b6499176",
"loadBalancer": {"id": "32082a93-d1e2-4bc0-8f5e-8fe4312b0844",
"type": "lsw.m3.large",
"resources": {"cpu": {"value": 2,
"unit": "vCPU"
},
"memory": {"value": 7,
"unit": "GiB"
},
"publicNetworkSpeed": {"value": 1,
"unit": "Gbps"
},
"privateNetworkSpeed": {"value": 100,
"unit": "Mbps"
}
},
"reference": "lb-integrated-with-asg",
"state": "RUNNING",
"startedAt": "2024-05-28T08:50:51+00:00"
},
"maximumAmount": null,
"minimumAmount": null,
"reference": "Manual Auto Scaling Group",
"region": "eu-west-3",
"startsAt": null,
"state": "ACTIVE",
"type": "MANUAL",
"updatedAt": "2024-04-26T09:22:25+00:00",
"warmupTime": null
}

Deregister Load balancer

Disassociates a Load Balancer from an Auto Scaling Group, stopping the distribution of incoming traffic to the instances within the group.

Authorizations:

X-LSW-Auth

path Parameters

autoScalingGroupId

required

string <uuid>

Example: fb769dab-3daa-47e4-89ed-06a4b6499176

Auto Scaling Group ID

Responses

Request samples

Shell + Curl
Python + Python3
Php + Http2
Ruby + Native
Node + Native

curl --request POST \
  --url https://api.leaseweb.com/publicCloud/v1/autoScalingGroups/fb769dab-3daa-47e4-89ed-06a4b6499176/deregisterLoadBalancer \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type

application/json

{"cooldownTime": null,
"cpuThreshold": null,
"createdAt": "2024-04-26T09:22:25+00:00",
"desiredAmount": 2,
"endsAt": null,
"id": "fb769dab-3daa-47e4-89ed-06a4b6499176",
"loadBalancer": null,
"maximumAmount": null,
"minimumAmount": null,
"reference": "Manual Auto Scaling Group",
"region": "eu-west-3",
"startsAt": null,
"state": "ACTIVE",
"type": "MANUAL",
"updatedAt": "2024-04-26T09:22:25+00:00",
"warmupTime": null
}

Get list of instances belonging to an Auto Scaling Group

List instances belonging to an Auto Scaling Group

Authorizations:

X-LSW-Auth

path Parameters

autoScalingGroupId

required

string <uuid>

Example: fb769dab-3daa-47e4-89ed-06a4b6499176

Auto Scaling Group ID

query Parameters

limit	integer Example: limit=20 Limit the number of results returned.
offset	integer Example: offset=10 Return results starting from the given offset.

Responses

Request samples

Shell + Curl
Python + Python3
Php + Http2
Ruby + Native
Node + Native

curl --request GET \
  --url 'https://api.leaseweb.com/publicCloud/v1/autoScalingGroups/fb769dab-3daa-47e4-89ed-06a4b6499176/instances?limit=SOME_INTEGER_VALUE&offset=SOME_INTEGER_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type

application/json

{"_metadata": {"totalCount": 1,
"limit": 10,
"offset": 0
},
"instances": [{"id": "59bc4aa1-7e14-42cd-848f-7de2921ffdc0",
"type": "lsw.m3.large",
"resources": {"cpu": {"value": 2,
"unit": "vCPU"
},
"memory": {"value": 7,
"unit": "GiB"
},
"publicNetworkSpeed": {"value": 1,
"unit": "Gbps"
},
"privateNetworkSpeed": {"value": 100,
"unit": "Mbps"
}
},
"region": "eu-west-3",
"reference": "My web server",
"state": "RUNNING",
"productType": "INSTANCE",
"ips": [{"ip": "0.0.0.0",
"prefixLength": "32",
"version": 4,
"reverseLookup": "www.example.com",
"mainIp": true,
"networkType": "PUBLIC",
"nullRouted": false,
"ddos": null
}
],
"hasPrivateNetwork": false
}
]
}

LeaseWeb API for launching and managing Public Cloud instances (v1)

Errors

API Key Authentication

Regions

List regions

Authorizations:

query Parameters

Responses

Request samples

Response samples

Instance Types

List instance types

Authorizations:

query Parameters

Responses

Request samples

Response samples

Instances

Launch instance

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get instance list

Authorizations:

query Parameters

Responses

Request samples

Response samples

Get instance details

Authorizations:

path Parameters

Responses

Request samples

Response samples

Terminate instance

Authorizations:

path Parameters

Responses

Request samples

Response samples

Update instance

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Cancel instance termination

Authorizations:

path Parameters

Responses

Request samples

Response samples

Get console access

Authorizations:

path Parameters

Responses

Request samples

Response samples

List available instance types for update

Authorizations:

path Parameters

query Parameters

Responses

Request samples

Response samples

List OSes available for reinstall

Authorizations:

path Parameters

Responses

Request samples

Response samples

Reinstall instance

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required