leaseweb
API Documentation
Developer API
API docs by Redocly

Developer API

Customer Care: customercare@leaseweb.com URL: https://kb.leaseweb.com/kb/support/support-contacting-customer-care/ License: Apache 2.0 Terms of Service

This API provides ways to manage the Leaseweb infrastructure.

The Leaseweb API offers comprehensive tools to effectively manage and interact with the Leaseweb infrastructure. It enables users to automate infrastructure-related tasks, such as provisioning, monitoring, and scaling resources. With its robust functionality, this API simplifies infrastructure management, enhances operational efficiency, and supports seamless integration into your existing workflows.

Error

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"
}

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.

Public Clouds

BETA

Leaseweb Public Cloud is a cloud computing service that provides virtualized infrastructure, allowing businesses and developers to deploy and manage cloud-based resources efficiently. It is designed to offer scalability, flexibility, and high performance at a competitive price.

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

curl --request GET \
  --url 'https://api.leaseweb.com/publicCloud/v1/regions?limit=20&offset=10' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "regions": [
    ]
}

List instance types

Get instance types

Authorizations:
X-LSW-Auth
query Parameters
region
required
string (regionName)
Enum: "eu-west-3" "us-east-1" "eu-central-1" "ap-southeast-1" "us-west-1" "eu-west-2" "ca-central-1" "ap-northeast-1"
Example: region=eu-west-3

region name

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

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "instanceTypes": [
    ],
  • "_metadata": {
    }
}

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 (regionName)
Enum: "eu-west-3" "us-east-1" "eu-central-1" "ap-southeast-1" "us-west-1" "eu-west-2" "ca-central-1" "ap-northeast-1"

region name

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)

imageId can be either an Operating System or a UUID in case of a Custom Image

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
integer (contractTerm)
Enum: 0 1 3 6 12 24 36

Contract commitment. Used only when contract type is MONTHLY

billingFrequency
integer (billingFrequency)
Enum: 1 3 6 12 24

The billing frequency (in months) of the instance. Used only when contract type is MONTHLY

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 (storageType)
Enum: "LOCAL" "CENTRAL"

Storage type

sshKey
string

Public SSH key to be installed into the instance. Must be used only on Linux/FreeBSD instances

userData
string

User data to be installed into the instance. Please note that this setting cannot be used in combination with the 'sshKey' setting. Send the user data as plain text, not encoded as base64.

Responses

Request samples

Content type
application/json
{
  • "billingFrequency": 1,
  • "contractTerm": 12,
  • "contractType": "MONTHLY",
  • "imageId": "UBUNTU_20_04_64BIT",
  • "reference": "my-webserver",
  • "region": "eu-west-3",
  • "rootDiskSize": 50,
  • "rootDiskStorageType": "CENTRAL",
  • "type": "lsw.m3.large",
  • "userData": "#cloud-config\n# vim: syntax=yaml\n#\n# This is the configuration syntax that the write_files module\n# will know how to understand. Encoding can be given b64 or gzip or (gz+b64).\n# The content will be decoded accordingly and then written to the path that is\n# provided. \n#\n# Note: Content strings here are truncated for example purposes.\nwrite_files:\n- encoding: b64\n content: TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3Rll1cyBtYXhpbXVzLg==\n owner: root:root\n path: /tmp/3.txt\n permissions: '0644'\n"
}

Response samples

Content type
application/json
{
  • "autoScalingGroup": null,
  • "contract": {
    },
  • "hasPrivateNetwork": false,
  • "hasPublicIpV4": true,
  • "hasUserData": true,
  • "id": "ace712e9-a166-47f1-9065-4af0f7e7fce1",
  • "image": {
    },
  • "ips": [
    ],
  • "marketAppId": null,
  • "productType": "INSTANCE",
  • "reference": "my webserver",
  • "region": "eu-west-3",
  • "resources": {
    },
  • "rootDiskSize": 5,
  • "rootDiskStorageType": "CENTRAL",
  • "startedAt": null,
  • "state": "RUNNING",
  • "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" "PENDING" "INACTIVE" "CANCELLED"
imageId
string (imageId)
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 (regionName)
Enum: "eu-west-3" "us-east-1" "eu-central-1" "ap-southeast-1" "us-west-1" "eu-west-2" "ca-central-1" "ap-northeast-1"
Example: region=eu-west-3

Available regions can be obtained using /v1/regions

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"
Example: type=lsw.c3.xlarge

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

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/publicCloud/v1/instances?limit=20&offset=10&ip=10.0.0.1&reference=my-webserver&id=a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11&contractType=SOME_STRING_VALUE&contractState=SOME_STRING_VALUE&imageId=UBUNTU_22_04_64BIT&state=SOME_STRING_VALUE&region=eu-west-3&type=lsw.c3.xlarge' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "instances": [
    ]
}

Get instance details

Get details about the instance

Authorizations:
X-LSW-Auth
path Parameters
instanceId
required
string <uuid>
Example: ace712e9-a166-47f1-9065-4af0f7e7fce1

Instance's ID

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/publicCloud/v1/instances/ace712e9-a166-47f1-9065-4af0f7e7fce1 \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "autoScalingGroup": null,
  • "contract": {
    },
  • "hasPrivateNetwork": false,
  • "hasPublicIpV4": true,
  • "hasUserData": false,
  • "id": "ace712e9-a166-47f1-9065-4af0f7e7fce1",
  • "image": {
    },
  • "ips": [
    ],
  • "iso": {
    },
  • "marketAppId": null,
  • "privateNetwork": null,
  • "productType": "INSTANCE",
  • "reference": "my webserver",
  • "region": "eu-west-3",
  • "resources": {
    },
  • "rootDiskSize": 5,
  • "rootDiskStorageType": "CENTRAL",
  • "startedAt": "2024-04-09T15:11:37+00:00",
  • "state": "RUNNING",
  • "type": "lsw.m3.large"
}

Terminate instance

Terminate Public Cloud instance

Authorizations:
X-LSW-Auth
path Parameters
instanceId
required
string <uuid>
Example: ace712e9-a166-47f1-9065-4af0f7e7fce1

Instance's ID

Request Body schema: application/json
reasonCode
string

The reason code for terminating the instance. This is a required field if contract type is Monthly. Please refer at this page for the valid options: Cancel Reasons

reason
string

Required only when reasonCode is CANCEL_OTHER.

Responses

Request samples

Content type
application/json
{
  • "reasonCode": "CANCEL_TRIAL_PERIOD"
}

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: ace712e9-a166-47f1-9065-4af0f7e7fce1

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 24 36

Contract commitment. Used only when contract type is MONTHLY

billingFrequency
integer (billingFrequency)
Enum: 1 3 6 12 24

The billing frequency (in months) of the instance. Used only when contract type is MONTHLY

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
{
  • "reference": "new-reference"
}

Response samples

Content type
application/json
{
  • "autoScalingGroup": null,
  • "contract": {
    },
  • "hasPrivateNetwork": false,
  • "hasPublicIpV4": true,
  • "hasUserData": false,
  • "id": "ace712e9-a166-47f1-9065-4af0f7e7fce1",
  • "image": {
    },
  • "ips": [
    ],
  • "iso": {
    },
  • "marketAppId": null,
  • "privateNetwork": null,
  • "productType": "INSTANCE",
  • "reference": "my webserver",
  • "region": "eu-west-3",
  • "resources": {
    },
  • "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: ace712e9-a166-47f1-9065-4af0f7e7fce1

Instance's ID

Responses

Request samples

curl --request POST \
  --url https://api.leaseweb.com/publicCloud/v1/instances/ace712e9-a166-47f1-9065-4af0f7e7fce1/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."
}

Start a specific resource Instance

The Instance must be stopped before the execution

Authorizations:
X-LSW-Auth
path Parameters
instanceId
required
string <uuid>
Example: ace712e9-a166-47f1-9065-4af0f7e7fce1

Instance's ID

Responses

Request samples

curl --request POST \
  --url https://api.leaseweb.com/publicCloud/v1/instances/ace712e9-a166-47f1-9065-4af0f7e7fce1/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."
}

Start a specific resource Load Balancer

The Load Balancer must be stopped before the execution

Authorizations:
X-LSW-Auth
path Parameters
loadBalancerId
required
string <uuid>
Example: 695ddd91-051f-4dd6-9120-938a927a47d0

Load balancer ID

Responses

Request samples

curl --request POST \
  --url https://api.leaseweb.com/publicCloud/v1/loadBalancers/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 a specific Instance

The Instance must be running before the execution

Authorizations:
X-LSW-Auth
path Parameters
instanceId
required
string <uuid>
Example: ace712e9-a166-47f1-9065-4af0f7e7fce1

Instance's ID

Responses

Request samples

curl --request POST \
  --url https://api.leaseweb.com/publicCloud/v1/instances/ace712e9-a166-47f1-9065-4af0f7e7fce1/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."
}

Stop a specific Load Balancer

The Load Balancer must be running before the execution

Authorizations:
X-LSW-Auth
path Parameters
loadBalancerId
required
string <uuid>
Example: 695ddd91-051f-4dd6-9120-938a927a47d0

Load balancer ID

Responses

Request samples

curl --request POST \
  --url https://api.leaseweb.com/publicCloud/v1/loadBalancers/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 a specific Instance

The Instance must be running before the execution

Authorizations:
X-LSW-Auth
path Parameters
instanceId
required
string <uuid>
Example: ace712e9-a166-47f1-9065-4af0f7e7fce1

Instance's ID

Responses

Request samples

curl --request POST \
  --url https://api.leaseweb.com/publicCloud/v1/instances/ace712e9-a166-47f1-9065-4af0f7e7fce1/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."
}

Reboot a specific Load Balancer

The Load Balancer must be running before the execution

Authorizations:
X-LSW-Auth
path Parameters
loadBalancerId
required
string <uuid>
Example: 695ddd91-051f-4dd6-9120-938a927a47d0

Load balancer ID

Responses

Request samples

curl --request POST \
  --url https://api.leaseweb.com/publicCloud/v1/loadBalancers/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."
}

Get console access

Get console access to the instance

Authorizations:
X-LSW-Auth
path Parameters
instanceId
required
string <uuid>
Example: ace712e9-a166-47f1-9065-4af0f7e7fce1

Instance's ID

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/publicCloud/v1/instances/ace712e9-a166-47f1-9065-4af0f7e7fce1/console \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

List available instance types for update

Get available instance types for update

Authorizations:
X-LSW-Auth
path Parameters
instanceId
required
string <uuid>
Example: ace712e9-a166-47f1-9065-4af0f7e7fce1

Instance's ID

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

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/publicCloud/v1/instances/ace712e9-a166-47f1-9065-4af0f7e7fce1/instanceTypesUpdate?limit=SOME_INTEGER_VALUE&offset=SOME_INTEGER_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "instanceTypes": [
    ],
  • "_metadata": {
    }
}

List credentials stored for a specific Instance

Authorizations:
X-LSW-Auth
path Parameters
instanceId
required
string <uuid>
Example: ace712e9-a166-47f1-9065-4af0f7e7fce1

Instance's ID

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/publicCloud/v1/instances/ace712e9-a166-47f1-9065-4af0f7e7fce1/credentials \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "credentials": [
    ]
}

Store credentials for a specific Instance

Authorizations:
X-LSW-Auth
path Parameters
instanceId
required
string <uuid>
Example: ace712e9-a166-47f1-9065-4af0f7e7fce1

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": "12341234",
  • "type": "OPERATING_SYSTEM",
  • "username": "root"
}

Response samples

Content type
application/json
{
  • "password": "12341234",
  • "type": "OPERATING_SYSTEM",
  • "username": "root"
}

Delete all credentials associated with a specific Instance

Authorizations:
X-LSW-Auth
path Parameters
instanceId
required
string <uuid>
Example: ace712e9-a166-47f1-9065-4af0f7e7fce1

Instance's ID

Responses

Request samples

curl --request DELETE \
  --url https://api.leaseweb.com/publicCloud/v1/instances/ace712e9-a166-47f1-9065-4af0f7e7fce1/credentials \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

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 for a specific Instance

Authorizations:
X-LSW-Auth
path Parameters
instanceId
required
string <uuid>
Example: ace712e9-a166-47f1-9065-4af0f7e7fce1

Instance's ID

type
required
string (credentialType)
Enum: "OPERATING_SYSTEM" "CONTROL_PANEL"

Type of credential

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/publicCloud/v1/instances/ace712e9-a166-47f1-9065-4af0f7e7fce1/credentials/%7Btype%7D \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "credentials": [
    ]
}

Get Instance credentials by type and username.

Authorizations:
X-LSW-Auth
path Parameters
instanceId
required
string <uuid>
Example: ace712e9-a166-47f1-9065-4af0f7e7fce1

Instance's ID

type
required
string (credentialType)
Enum: "OPERATING_SYSTEM" "CONTROL_PANEL"

Type of credential

username
required
string
Example: root

Username

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/publicCloud/v1/instances/ace712e9-a166-47f1-9065-4af0f7e7fce1/credentials/%7Btype%7D/root \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "password": "12341234",
  • "type": "OPERATING_SYSTEM",
  • "username": "root"
}

Update credentials for a given type and username

Authorizations:
X-LSW-Auth
path Parameters
instanceId
required
string <uuid>
Example: ace712e9-a166-47f1-9065-4af0f7e7fce1

Instance's ID

type
required
string (credentialType)
Enum: "OPERATING_SYSTEM" "CONTROL_PANEL"

Type of credential

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": "12341234"
}

Response samples

Content type
application/json
{
  • "password": "12341234",
  • "type": "OPERATING_SYSTEM",
  • "username": "root"
}

Delete Instance credential for a given type and username

Authorizations:
X-LSW-Auth
path Parameters
instanceId
required
string <uuid>
Example: ace712e9-a166-47f1-9065-4af0f7e7fce1

Instance's ID

type
required
string (credentialType)
Enum: "OPERATING_SYSTEM" "CONTROL_PANEL"

Type of credential

username
required
string
Example: root

Username

Responses

Request samples

curl --request DELETE \
  --url https://api.leaseweb.com/publicCloud/v1/instances/ace712e9-a166-47f1-9065-4af0f7e7fce1/credentials/%7Btype%7D/root \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

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

Reset the password for a specific Instance

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: ace712e9-a166-47f1-9065-4af0f7e7fce1

Instance's ID

Responses

Request samples

curl --request POST \
  --url https://api.leaseweb.com/publicCloud/v1/instances/ace712e9-a166-47f1-9065-4af0f7e7fce1/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."
}

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

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

Response samples

Content type
application/json
{
  • "billing": {
    }
}

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

curl --request GET \
  --url 'https://api.leaseweb.com/publicCloud/v1/isos?limit=20&offset=10' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "isos": [
    ]
}

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.

custom
boolean

Filters the list to include only custom images.

standard
boolean
Example: standard=true

Filters the list to include only standard images.

state
string (imageState)
Enum: "CREATING" "READY" "DESTROYED" "DESTROYING" "FAILED"

Filters the list by the state of custom images.

marketAppId
string (marketAppId)
Enum: "CPANEL_30" "CPANEL_100" "CPANEL_ADMIN" "CPANEL_PRO" "CPANEL_PLUS" "CPANEL_PREMIER" "PLESK_WEB_PRO" "PLESK_WEB_ADMIN" "PLESK_WEB_HOST"

Filters the list by the market app of standard images.

storageType
string
Enum: "LOCAL" "CENTRAL"

Filters the list by the market app of standard images.

name
string
Example: name=Ubuntu 20.04 LTS (x86_64)

Filters the list by the name of images.

flavour
string (flavour)
Enum: "ubuntu" "debian" "freebsd" "centos" "almalinux" "rockylinux" "archlinux" "windows"

Filters the list by the flavour of standard images.

region
string
Example: region=eu-west-3

Available regions can be found using the List Regions endpoint.

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/publicCloud/v1/images?limit=20&offset=10&custom=SOME_BOOLEAN_VALUE&standard=true&state=SOME_STRING_VALUE&marketAppId=SOME_STRING_VALUE&storageType=SOME_STRING_VALUE&name=Ubuntu%2020.04%20LTS%20(x86_64)&flavour=SOME_STRING_VALUE&region=eu-west-3' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "images": [
    ],
  • "_metadata": {
    }
}

Create Custom Image

Create a Custom Image

Authorizations:
X-LSW-Auth
Request Body schema: application/json
required
name
required
string

The name of the custom image to be created.

instanceId
required
string

The id of the instance from which the custom image will be created.

Responses

Request samples

Content type
application/json
{
  • "name": "New custom image",
  • "instanceId": "695ddd91-051f-4dd6-9120-938a927a47d0"
}

Response samples

Content type
application/json
{
  • "architecture": null,
  • "createdAt": "2024-07-05T10:54:27+00:00",
  • "custom": true,
  • "family": "linux",
  • "flavour": "ubuntu",
  • "id": "ace712e9-a166-47f1-9065-4af0f7e7fce1",
  • "marketApps": [ ],
  • "minDiskSize": null,
  • "name": "Custom image - 03",
  • "region": "eu-west-3",
  • "state": "READY",
  • "stateReason": null,
  • "storageSize": {
    },
  • "storageTypes": [ ],
  • "updatedAt": "2024-07-17T13:14:01+00:00",
  • "version": null
}

Update Custom Image

Update a Custom Image

Authorizations:
X-LSW-Auth
path Parameters
imageId
required
string <uuid>
Example: 695ddd91-051f-4dd6-9120-938a927a47d0

Image's ID

Request Body schema: application/json
required
name
required
string

The name of the custom image to be updated.

Responses

Request samples

Content type
application/json
{
  • "name": "Custom image"
}

Response samples

Content type
application/json
{
  • "architecture": null,
  • "createdAt": "2024-07-05T10:54:27+00:00",
  • "custom": true,
  • "family": "linux",
  • "flavour": "ubuntu",
  • "id": "ace712e9-a166-47f1-9065-4af0f7e7fce1",
  • "marketApps": [ ],
  • "minDiskSize": null,
  • "name": "Custom image - 03",
  • "region": "eu-west-3",
  • "state": "READY",
  • "stateReason": null,
  • "storageSize": {
    },
  • "storageTypes": [ ],
  • "updatedAt": "2024-07-17T13:14:01+00:00",
  • "version": null
}

Get marketplace apps

Get all available marketplace apps.

Authorizations:
X-LSW-Auth

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "marketApps": [
    ]
}

Attach ISO to a specific 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: ace712e9-a166-47f1-9065-4af0f7e7fce1

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 a specific Instance

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

Authorizations:
X-LSW-Auth
path Parameters
instanceId
required
string <uuid>
Example: ace712e9-a166-47f1-9065-4af0f7e7fce1

Instance's ID

Responses

Request samples

curl --request POST \
  --url https://api.leaseweb.com/publicCloud/v1/instances/ace712e9-a166-47f1-9065-4af0f7e7fce1/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."
}

List images available for reinstall

Authorizations:
X-LSW-Auth
path Parameters
instanceId
required
string <uuid>
Example: ace712e9-a166-47f1-9065-4af0f7e7fce1

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.

custom
boolean

Filters the list to include only custom images.

standard
boolean
Example: standard=true

Filters the list to include only standard images.

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/publicCloud/v1/instances/ace712e9-a166-47f1-9065-4af0f7e7fce1/reinstall/images?limit=20&offset=10&custom=SOME_BOOLEAN_VALUE&standard=true' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "images": [
    ],
  • "_metadata": {
    }
}

Reinstall an 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/{resource}/{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: ace712e9-a166-47f1-9065-4af0f7e7fce1

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."
}

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 (regionName)
Enum: "eu-west-3" "us-east-1" "eu-central-1" "ap-southeast-1" "us-west-1" "eu-west-2" "ca-central-1" "ap-northeast-1"

region name

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 (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 24 36

Contract commitment. Used only when contract type is MONTHLY

billingFrequency
integer (billingFrequency)
Enum: 1 3 6 12 24

The billing frequency (in months) of the instance. Used only when contract type is MONTHLY

Responses

Request samples

Content type
application/json
{
  • "billingFrequency": 1,
  • "contractTerm": 0,
  • "contractType": "HOURLY",
  • "reference": "my-loadbalancer-1",
  • "region": "eu-west-3",
  • "type": "lsw.m3.large"
}

Response samples

Content type
application/json
{
  • "privateNetwork": null,
  • "id": "32082a93-d1e2-4bc0-8f5e-8fe4312b0844",
  • "type": "lsw.m3.large",
  • "resources": {
    },
  • "autoScalingGroup": null,
  • "region": "eu-west-3",
  • "reference": "my-loadbalancer1",
  • "state": "RUNNING",
  • "ips": [
    ],
  • "startedAt": "2024-04-09T15:11:37+00:00",
  • "contract": {
    },
  • "configuration": {
    }
}

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" "PENDING" "INACTIVE" "CANCELLED"
contractType
string
Enum: "HOURLY" "MONTHLY"
Example: contractType=HOURLY
state
string
Enum: "RUNNING" "STARTING" "STOPPED" "STOPPING" "CREATING" "DESTROYED" "DESTROYING"
Example: state=RUNNING
region
string (regionName)
Enum: "eu-west-3" "us-east-1" "eu-central-1" "ap-southeast-1" "us-west-1" "eu-west-2" "ca-central-1" "ap-northeast-1"
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

curl --request GET \
  --url 'https://api.leaseweb.com/publicCloud/v1/loadBalancers?limit=20&offset=10&ip=10.0.0.1&reference=my-lb&id=a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11&contractState=SOME_STRING_VALUE&contractType=HOURLY&state=RUNNING&region=eu-west-3&type=lsw.c3.xlarge' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "loadBalancers": [
    ]
}

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

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": {
    },
  • "autoScalingGroup": null,
  • "region": "eu-west-3",
  • "reference": "my-loadbalancer1",
  • "state": "RUNNING",
  • "ips": [
    ],
  • "startedAt": "2024-04-09T15:11:37+00:00",
  • "contract": {
    },
  • "configuration": {
    }
}

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

Request Body schema: application/json
required
reasonCode
required
string

The reason code for terminating the instance. This is a required field. Please refer at this page for the valid options: Cancel Reasons

reason
string

Required only when reasonCode is CANCEL_OTHER.

Responses

Request samples

Content type
application/json
{
  • "reasonCode": "CANCEL_TRIAL_PERIOD"
}

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

xForwardedFor
boolean

Is xForwardedFor enabled or not

idleTimeOut
integer

Time to close the connection if load balancer is idle

Responses

Request samples

Content type
application/json
{
  • "balance": "roundrobin",
  • "contractType": "HOURLY",
  • "idleTimeOut": 60,
  • "reference": "foo",
  • "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": {
    },
  • "autoScalingGroup": null,
  • "region": "eu-west-3",
  • "reference": "my-loadbalancer1",
  • "state": "RUNNING",
  • "ips": [
    ],
  • "startedAt": "2024-04-09T15:11:37+00:00",
  • "contract": {
    },
  • "configuration": {
    }
}

Get listener list

List listeners

Authorizations:
X-LSW-Auth
path Parameters
loadBalancerId
required
string <uuid>
Example: 695ddd91-051f-4dd6-9120-938a927a47d0

Load balancer 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

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

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "listeners": [
    ]
}

Create listener

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 (protocol)
Enum: "HTTP" "HTTPS" "TCP"
port
required
integer

Port that the listener listens to

object (sslCertificate)
required
object (loadBalancerListenerDefaultRule)

Responses

Request samples

Content type
application/json
{
  • "protocol": "HTTPS",
  • "port": 443,
  • "defaultRule": {
    },
  • "certificate": {
    }
}

Response samples

Content type
application/json
{
  • "protocol": "HTTPS",
  • "port": 443,
  • "id": "fac06878-6655-4956-8ea7-124a97f133ab",
  • "rules": [
    ]
}

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

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",
  • "rules": [
    ],
  • "sslCertificates": [
    ]
}

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
string (protocol)
Enum: "HTTP" "HTTPS" "TCP"
port
integer

Port that the listener listens to

object (sslCertificate)
object (loadBalancerListenerDefaultRule)

Responses

Request samples

Content type
application/json
{
  • "protocol": "HTTPS",
  • "port": 443,
  • "defaultRule": {
    },
  • "certificate": {
    }
}

Response samples

Content type
application/json
{
  • "protocol": "HTTPS",
  • "port": 443,
  • "id": "fac06878-6655-4956-8ea7-124a97f133ab",
  • "rules": [
    ]
}

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

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 IP addresses associated with a specific Instance

List the Instance's IPs

Authorizations:
X-LSW-Auth
path Parameters
instanceId
required
string <uuid>
Example: ace712e9-a166-47f1-9065-4af0f7e7fce1

Instance's ID

query Parameters
version
integer
Enum: 4 6

Ip version

nullRouted
boolean
ips
string

A list of IPs separated by |

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/publicCloud/v1/instances/ace712e9-a166-47f1-9065-4af0f7e7fce1/ips?version=SOME_INTEGER_VALUE&nullRouted=SOME_BOOLEAN_VALUE&ips=SOME_STRING_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "ips": [
    ]
}

List IP addresses associated with a specific Load Balancer

List the Load Balancers IPs

Authorizations:
X-LSW-Auth
path Parameters
loadBalancerId
required
string <uuid>
Example: 695ddd91-051f-4dd6-9120-938a927a47d0

Load balancer ID

query Parameters
version
integer
Enum: 4 6

Ip version

nullRouted
boolean
ips
string

A list of IPs separated by |

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/publicCloud/v1/loadBalancers/695ddd91-051f-4dd6-9120-938a927a47d0/ips?version=SOME_INTEGER_VALUE&nullRouted=SOME_BOOLEAN_VALUE&ips=SOME_STRING_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "ips": [
    ]
}

Get IP details for a specific Instance

Authorizations:
X-LSW-Auth
path Parameters
instanceId
required
string <uuid>
Example: ace712e9-a166-47f1-9065-4af0f7e7fce1

Instance's ID

ip
required
string <ip>
Example: 10.0.0.1

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/publicCloud/v1/instances/ace712e9-a166-47f1-9065-4af0f7e7fce1/ips/10.0.0.1 \
  --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": {
    }
}

Update the IP address for a specific Instance

Allows you to set the reverse lookup for the IP

Authorizations:
X-LSW-Auth
path Parameters
instanceId
required
string <uuid>
Example: ace712e9-a166-47f1-9065-4af0f7e7fce1

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": {
    }
}

Get IP details for a specific Load Balancer

Authorizations:
X-LSW-Auth
path Parameters
loadBalancerId
required
string <uuid>
Example: 695ddd91-051f-4dd6-9120-938a927a47d0

Load balancer ID

ip
required
string <ip>
Example: 10.0.0.1

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/publicCloud/v1/loadBalancers/695ddd91-051f-4dd6-9120-938a927a47d0/ips/10.0.0.1 \
  --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": {
    }
}

Update the IP address for a specific Load Balancer

Allows you to set the reverse lookup for the IP

Authorizations:
X-LSW-Auth
path Parameters
loadBalancerId
required
string <uuid>
Example: 695ddd91-051f-4dd6-9120-938a927a47d0

Load balancer 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": {
    }
}

Null route IP address for a specific resource Instance

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: ace712e9-a166-47f1-9065-4af0f7e7fce1

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": {
    }
}

Null route IP address for a specific resource Load Balancer

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
loadBalancerId
required
string <uuid>
Example: 695ddd91-051f-4dd6-9120-938a927a47d0

Load balancer 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": {
    }
}

Remove an IP null route for a specific Instance

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: ace712e9-a166-47f1-9065-4af0f7e7fce1

Instance's ID

ip
required
string <ip>
Example: 10.0.0.1

Responses

Request samples

curl --request POST \
  --url https://api.leaseweb.com/publicCloud/v1/instances/ace712e9-a166-47f1-9065-4af0f7e7fce1/ips/10.0.0.1/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": {
    }
}

Remove an IP null route for a specific Load Balancer

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
loadBalancerId
required
string <uuid>
Example: 695ddd91-051f-4dd6-9120-938a927a47d0

Load balancer ID

ip
required
string <ip>
Example: 10.0.0.1

Responses

Request samples

curl --request POST \
  --url https://api.leaseweb.com/publicCloud/v1/loadBalancers/695ddd91-051f-4dd6-9120-938a927a47d0/ips/10.0.0.1/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": {
    }
}

Get data traffic metrics for a specific Instance

Authorizations:
X-LSW-Auth
path Parameters
instanceId
required
string <uuid>
Example: ace712e9-a166-47f1-9065-4af0f7e7fce1

Instance's ID

query Parameters
from
string <date>
Example: from=2025-01-28

The start of the interval to get the metric

to
string <date>
Example: to=2025-01-28

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

curl --request GET \
  --url 'https://api.leaseweb.com/publicCloud/v1/instances/ace712e9-a166-47f1-9065-4af0f7e7fce1/metrics/datatraffic?from=2025-01-28&to=2025-01-28&granularity=SOME_STRING_VALUE&aggregation=SOME_STRING_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "metrics": {
    }
}

Get data traffic metrics for a specific Load Balancer

Authorizations:
X-LSW-Auth
path Parameters
loadBalancerId
required
string <uuid>
Example: 695ddd91-051f-4dd6-9120-938a927a47d0

Load balancer ID

query Parameters
from
string <date>
Example: from=2025-01-28

The start of the interval to get the metric

to
string <date>
Example: to=2025-01-28

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

curl --request GET \
  --url 'https://api.leaseweb.com/publicCloud/v1/loadBalancers/695ddd91-051f-4dd6-9120-938a927a47d0/metrics/datatraffic?from=2025-01-28&to=2025-01-28&granularity=SOME_STRING_VALUE&aggregation=SOME_STRING_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "metrics": {
    }
}

Get instance CPU metrics

Authorizations:
X-LSW-Auth
path Parameters
instanceId
required
string <uuid>
Example: ace712e9-a166-47f1-9065-4af0f7e7fce1

Instance's ID

query Parameters
from
string <date>
Example: from=2025-01-28

The start of the interval to get the metric

to
string <date>
Example: to=2025-01-28

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"

The interval for each metric

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/publicCloud/v1/instances/ace712e9-a166-47f1-9065-4af0f7e7fce1/metrics/cpu?from=2025-01-28&to=2025-01-28&granularity=SOME_STRING_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "metrics": {
    }
}

Get load balancer requests metrics. Not available for listeners with TCP protocol

Authorizations:
X-LSW-Auth
path Parameters
loadBalancerId
required
string <uuid>
Example: 695ddd91-051f-4dd6-9120-938a927a47d0

Load balancer ID

query Parameters
from
string <datetime>
Example: from=2025-01-28T10:34:01+00:00

The start of the interval to get the metric, in ISO 8601 format

to
string <datetime>
Example: to=2025-01-28T11:44:01+00:00

The end of the interval to get the metric in format ISO 8601. Must be greater than the date provided in from.

granularity
string
Enum: "5m" "10m" "30m" "1h" "1d" "1w"

The interval for each metric

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/publicCloud/v1/loadBalancers/695ddd91-051f-4dd6-9120-938a927a47d0/metrics/requests?from=2025-01-28T10%3A34%3A01%2B00%3A00&to=2025-01-28T11%3A44%3A01%2B00%3A00&granularity=SOME_STRING_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "metrics": {
    }
}

Get load balancer requests per second metrics. Not available for listeners with TCP protocol

Authorizations:
X-LSW-Auth
path Parameters
loadBalancerId
required
string <uuid>
Example: 695ddd91-051f-4dd6-9120-938a927a47d0

Load balancer ID

query Parameters
from
string <datetime>
Example: from=2025-01-28T10:34:01+00:00

The start of the interval to get the metric, in ISO 8601 format

to
string <datetime>
Example: to=2025-01-28T11:44:01+00:00

The end of the interval to get the metric in format ISO 8601. Must be greater than the date provided in from.

granularity
string
Enum: "5m" "10m" "30m" "1h" "1d" "1w"

The interval for each metric

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/publicCloud/v1/loadBalancers/695ddd91-051f-4dd6-9120-938a927a47d0/metrics/requestsPerSecond?from=2025-01-28T10%3A34%3A01%2B00%3A00&to=2025-01-28T11%3A44%3A01%2B00%3A00&granularity=SOME_STRING_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "metrics": {
    }
}

Get load balancer data transferred metrics

Authorizations:
X-LSW-Auth
path Parameters
loadBalancerId
required
string <uuid>
Example: 695ddd91-051f-4dd6-9120-938a927a47d0

Load balancer ID

query Parameters
from
string <datetime>
Example: from=2025-01-28T10:34:01+00:00

The start of the interval to get the metric, in ISO 8601 format

to
string <datetime>
Example: to=2025-01-28T11:44:01+00:00

The end of the interval to get the metric in format ISO 8601. Must be greater than the date provided in from.

granularity
string
Enum: "5m" "10m" "30m" "1h" "1d" "1w"

The interval for each metric

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/publicCloud/v1/loadBalancers/695ddd91-051f-4dd6-9120-938a927a47d0/metrics/dataTransferred?from=2025-01-28T10%3A34%3A01%2B00%3A00&to=2025-01-28T11%3A44%3A01%2B00%3A00&granularity=SOME_STRING_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "metrics": {
    }
}

Get load balancer data transferred per second metrics

Authorizations:
X-LSW-Auth
path Parameters
loadBalancerId
required
string <uuid>
Example: 695ddd91-051f-4dd6-9120-938a927a47d0

Load balancer ID

query Parameters
from
string <datetime>
Example: from=2025-01-28T10:34:01+00:00

The start of the interval to get the metric, in ISO 8601 format

to
string <datetime>
Example: to=2025-01-28T11:44:01+00:00

The end of the interval to get the metric in format ISO 8601. Must be greater than the date provided in from.

granularity
string
Enum: "5m" "10m" "30m" "1h" "1d" "1w"

The interval for each metric

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/publicCloud/v1/loadBalancers/695ddd91-051f-4dd6-9120-938a927a47d0/metrics/dataTransferredPerSecond?from=2025-01-28T10%3A34%3A01%2B00%3A00&to=2025-01-28T11%3A44%3A01%2B00%3A00&granularity=SOME_STRING_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "metrics": {
    }
}

Get connections metrics

Authorizations:
X-LSW-Auth
path Parameters
loadBalancerId
required
string <uuid>
Example: 695ddd91-051f-4dd6-9120-938a927a47d0

Load balancer ID

query Parameters
from
string <datetime>
Example: from=2025-01-28T10:34:01+00:00

The start of the interval to get the metric, in ISO 8601 format

to
string <datetime>
Example: to=2025-01-28T11:44:01+00:00

The end of the interval to get the metric in format ISO 8601. Must be greater than the date provided in from.

granularity
string
Enum: "5m" "10m" "30m" "1h" "1d" "1w"

The interval for each metric

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/publicCloud/v1/loadBalancers/695ddd91-051f-4dd6-9120-938a927a47d0/metrics/connections?from=2025-01-28T10%3A34%3A01%2B00%3A00&to=2025-01-28T11%3A44%3A01%2B00%3A00&granularity=SOME_STRING_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "metrics": {
    }
}

Get connections per second metrics

Authorizations:
X-LSW-Auth
path Parameters
loadBalancerId
required
string <uuid>
Example: 695ddd91-051f-4dd6-9120-938a927a47d0

Load balancer ID

query Parameters
from
string <datetime>
Example: from=2025-01-28T10:34:01+00:00

The start of the interval to get the metric, in ISO 8601 format

to
string <datetime>
Example: to=2025-01-28T11:44:01+00:00

The end of the interval to get the metric in format ISO 8601. Must be greater than the date provided in from.

granularity
string
Enum: "5m" "10m" "30m" "1h" "1d" "1w"

The interval for each metric

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/publicCloud/v1/loadBalancers/695ddd91-051f-4dd6-9120-938a927a47d0/metrics/connectionsPerSecond?from=2025-01-28T10%3A34%3A01%2B00%3A00&to=2025-01-28T11%3A44%3A01%2B00%3A00&granularity=SOME_STRING_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "metrics": {
    }
}

Get response codes metrics

Authorizations:
X-LSW-Auth
path Parameters
loadBalancerId
required
string <uuid>
Example: 695ddd91-051f-4dd6-9120-938a927a47d0

Load balancer ID

query Parameters
from
string <datetime>
Example: from=2025-01-28T10:34:01+00:00

The start of the interval to get the metric, in ISO 8601 format

to
string <datetime>
Example: to=2025-01-28T11:44:01+00:00

The end of the interval to get the metric in format ISO 8601. Must be greater than the date provided in from.

granularity
string
Enum: "5m" "10m" "30m" "1h" "1d" "1w"

The interval for each metric

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/publicCloud/v1/loadBalancers/695ddd91-051f-4dd6-9120-938a927a47d0/metrics/responseCodes?from=2025-01-28T10%3A34%3A01%2B00%3A00&to=2025-01-28T11%3A44%3A01%2B00%3A00&granularity=SOME_STRING_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "metrics": {
    }
}

Get response codes per second metrics

Authorizations:
X-LSW-Auth
path Parameters
loadBalancerId
required
string <uuid>
Example: 695ddd91-051f-4dd6-9120-938a927a47d0

Load balancer ID

query Parameters
from
string <datetime>
Example: from=2025-01-28T10:34:01+00:00

The start of the interval to get the metric, in ISO 8601 format

to
string <datetime>
Example: to=2025-01-28T11:44:01+00:00

The end of the interval to get the metric in format ISO 8601. Must be greater than the date provided in from.

granularity
string
Enum: "5m" "10m" "30m" "1h" "1d" "1w"

The interval for each metric

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/publicCloud/v1/loadBalancers/695ddd91-051f-4dd6-9120-938a927a47d0/metrics/responseCodesPerSecond?from=2025-01-28T10%3A34%3A01%2B00%3A00&to=2025-01-28T11%3A44%3A01%2B00%3A00&granularity=SOME_STRING_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "metrics": {
    }
}

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: ace712e9-a166-47f1-9065-4af0f7e7fce1

Instance's ID

Responses

Request samples

curl --request PUT \
  --url https://api.leaseweb.com/publicCloud/v1/instances/ace712e9-a166-47f1-9065-4af0f7e7fce1/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: ace712e9-a166-47f1-9065-4af0f7e7fce1

Instance's ID

Responses

Request samples

curl --request DELETE \
  --url https://api.leaseweb.com/publicCloud/v1/instances/ace712e9-a166-47f1-9065-4af0f7e7fce1/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."
}

List snapshots

List instance snapshots

Authorizations:
X-LSW-Auth
path Parameters
instanceId
required
string <uuid>
Example: ace712e9-a166-47f1-9065-4af0f7e7fce1

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

curl --request GET \
  --url 'https://api.leaseweb.com/publicCloud/v1/instances/ace712e9-a166-47f1-9065-4af0f7e7fce1/snapshots?limit=20&offset=10' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "snapshots": [
    ]
}

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: ace712e9-a166-47f1-9065-4af0f7e7fce1

Instance's ID

Request Body schema: application/json
required
name
required
string

A name to identify your snapshot

Responses

Request samples

Content type
application/json
{
  • "name": "my snapshot"
}

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: ace712e9-a166-47f1-9065-4af0f7e7fce1

Instance's ID

snapshotId
required
string <uuid>

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/publicCloud/v1/instances/ace712e9-a166-47f1-9065-4af0f7e7fce1/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: ace712e9-a166-47f1-9065-4af0f7e7fce1

Instance's ID

snapshotId
required
string <uuid>

Responses

Request samples

curl --request PUT \
  --url https://api.leaseweb.com/publicCloud/v1/instances/ace712e9-a166-47f1-9065-4af0f7e7fce1/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: ace712e9-a166-47f1-9065-4af0f7e7fce1

Instance's ID

snapshotId
required
string <uuid>

Responses

Request samples

curl --request DELETE \
  --url https://api.leaseweb.com/publicCloud/v1/instances/ace712e9-a166-47f1-9065-4af0f7e7fce1/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."
}

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
{
  • "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",
  • "maximumAmount": null,
  • "minimumAmount": null,
  • "reference": "Manual Auto Scaling Group",
  • "region": "eu-west-3",
  • "startsAt": null,
  • "state": "CREATING",
  • "targetGroups": [ ],
  • "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 (regionName)
Enum: "eu-west-3" "us-east-1" "eu-central-1" "ap-southeast-1" "us-west-1" "eu-west-2" "ca-central-1" "ap-northeast-1"
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

curl --request GET \
  --url 'https://api.leaseweb.com/publicCloud/v1/autoScalingGroups?limit=20&offset=10&id=a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11&instanceId=6762182e-7ae9-4d0b-b3b7-bea5a49b3f94&type=SOME_STRING_VALUE&region=eu-west-3&reference=SOME_STRING_VALUE&state=SOME_STRING_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "autoScalingGroups": [
    ]
}

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

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

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
{
  • "reference": "Changed reference",
  • "desiredAmount": 4
}

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",
  • "maximumAmount": null,
  • "minimumAmount": null,
  • "reference": "Manual Auto Scaling Group",
  • "region": "eu-west-3",
  • "startsAt": null,
  • "state": "ACTIVE",
  • "targetGroups": [
    ],
  • "type": "MANUAL",
  • "updatedAt": "2024-04-26T09:22:25+00:00",
  • "warmupTime": null
}

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

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",
  • "maximumAmount": null,
  • "minimumAmount": null,
  • "reference": "Manual Auto Scaling Group",
  • "region": "eu-west-3",
  • "startsAt": null,
  • "state": "ACTIVE",
  • "targetGroups": [
    ],
  • "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

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

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "instances": [
    ]
}

Register Target Group

Associates an auto scaling group with a target 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
targetGroupId
required
string <uuid>

The target group unique identifier

Responses

Request samples

Content type
application/json
{
  • "targetGroupId": "b05917e1-96a4-442a-900c-c41f273d95c9"
}

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",
  • "maximumAmount": null,
  • "minimumAmount": null,
  • "reference": "Manual Auto Scaling Group",
  • "region": "eu-west-3",
  • "startsAt": null,
  • "state": "ACTIVE",
  • "targetGroups": [
    ],
  • "type": "MANUAL",
  • "updatedAt": "2024-04-26T09:22:25+00:00",
  • "warmupTime": null
}

Deregister Target Group

Disassociate a target group from 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
targetGroupId
required
string <uuid>

The target group unique identifier

Responses

Request samples

Content type
application/json
{
  • "targetGroupId": "b05917e1-96a4-442a-900c-c41f273d95c9"
}

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",
  • "maximumAmount": null,
  • "minimumAmount": null,
  • "reference": "Manual Auto Scaling Group",
  • "region": "eu-west-3",
  • "startsAt": null,
  • "state": "ACTIVE",
  • "targetGroups": [
    ],
  • "type": "MANUAL",
  • "updatedAt": "2024-04-26T09:22:25+00:00",
  • "warmupTime": null
}

Get Target Group list

List and filter Target 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
name
string
Example: name=Foo bar
protocol
string
Enum: "HTTP" "HTTPS" "TCP"
Example: protocol=HTTP
port
integer
Example: port=80
region
string (regionName)
Enum: "eu-west-3" "us-east-1" "eu-central-1" "ap-southeast-1" "us-west-1" "eu-west-2" "ca-central-1" "ap-northeast-1"

region name

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/publicCloud/v1/targetGroups?limit=20&offset=10&id=a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11&name=Foo%20bar&protocol=HTTP&port=80&region=SOME_STRING_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "targetGroups": [
    ]
}

Create Target Group

Create a Target Group

Authorizations:
X-LSW-Auth
Request Body schema: application/json
required
name
required
string

The name of the target group

protocol
required
string (protocol)
Enum: "HTTP" "HTTPS" "TCP"
port
required
integer

The port of the target group

region
required
string (regionName)
Enum: "eu-west-3" "us-east-1" "eu-central-1" "ap-southeast-1" "us-west-1" "eu-west-2" "ca-central-1" "ap-northeast-1"

region name

object (healthCheckOpts)

Responses

Request samples

Content type
application/json
{
  • "name": "Target group name",
  • "protocol": "HTTP",
  • "port": 80,
  • "region": "eu-west-2",
  • "healthCheck": {
    }
}

Response samples

Content type
application/json
{
  • "id": "7e59b33d-05f3-4078-b251-c7831ae8fe14",
  • "name": "Target group name",
  • "protocol": "HTTP",
  • "port": 80,
  • "region": "eu-west-2",
  • "healthCheck": {
    }
}

Get Target Group details

Get Target Group details.

Authorizations:
X-LSW-Auth
path Parameters
targetGroupId
required
string <uuid>
Example: fb769dab-3daa-47e4-89ed-06a4b6499176

Target Group ID

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": "7e59b33d-05f3-4078-b251-c7831ae8fe14",
  • "name": "Target group name",
  • "protocol": "HTTP",
  • "port": 80,
  • "region": "eu-west-2",
  • "healthCheck": {
    }
}

Update Target Group

Update a Target Group

Authorizations:
X-LSW-Auth
path Parameters
targetGroupId
required
string <uuid>
Example: fb769dab-3daa-47e4-89ed-06a4b6499176

Target Group ID

Request Body schema: application/json
required
name
string

The name of the target group

port
integer

The port of the target group

object (healthCheckOpts)

Responses

Request samples

Content type
application/json
{
  • "name": "Target group name",
  • "port": 80,
  • "healthCheck": {
    }
}

Response samples

Content type
application/json
{
  • "id": "7e59b33d-05f3-4078-b251-c7831ae8fe14",
  • "name": "Target group name",
  • "protocol": "HTTP",
  • "port": 80,
  • "region": "eu-west-2",
  • "healthCheck": {
    }
}

Delete Target Group

Delete a Target Group.

Authorizations:
X-LSW-Auth
path Parameters
targetGroupId
required
string <uuid>
Example: fb769dab-3daa-47e4-89ed-06a4b6499176

Target Group ID

Responses

Request samples

curl --request DELETE \
  --url https://api.leaseweb.com/publicCloud/v1/targetGroups/fb769dab-3daa-47e4-89ed-06a4b6499176 \
  --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 Targets

Get targets in a Target Group

Authorizations:
X-LSW-Auth
path Parameters
targetGroupId
required
string <uuid>
Example: fb769dab-3daa-47e4-89ed-06a4b6499176

Target 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

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

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "targets": [
    ]
}

Register Targets

Register Targets in a Target Group

Authorizations:
X-LSW-Auth
path Parameters
targetGroupId
required
string <uuid>
Example: fb769dab-3daa-47e4-89ed-06a4b6499176

Target Group ID

Request Body schema: application/json
required
Array
string <uuid>

Responses

Request samples

Content type
application/json
[
  • "695ddd91-051f-4dd6-9120-938a927a47d0"
]

Response samples

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 in a Target Group

Authorizations:
X-LSW-Auth
path Parameters
targetGroupId
required
string <uuid>
Example: fb769dab-3daa-47e4-89ed-06a4b6499176

Target Group ID

Request Body schema: application/json
required
Array
string <uuid>

Responses

Request samples

Content type
application/json
[
  • "695ddd91-051f-4dd6-9120-938a927a47d0"
]

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 the notification settings of a customer

Authorizations:
X-LSW-Auth
path Parameters
instanceId
required
string <uuid>
Example: ace712e9-a166-47f1-9065-4af0f7e7fce1

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

curl --request GET \
  --url 'https://api.leaseweb.com/publicCloud/v1/instances/ace712e9-a166-47f1-9065-4af0f7e7fce1/notificationSettings/dataTraffic?limit=20&offset=10' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "notificationSettings": [
    ]
}

Get details of a notification Setting

Authorizations:
X-LSW-Auth
path Parameters
instanceId
required
string <uuid>
Example: ace712e9-a166-47f1-9065-4af0f7e7fce1

Instance's ID

notificationSettingId
required
string <uuid>
Example: 3a042956-0689-45dc-8322-8b8325464182

Notification Setting ID

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/publicCloud/v1/instances/ace712e9-a166-47f1-9065-4af0f7e7fce1/notificationSettings/dataTraffic/3a042956-0689-45dc-8322-8b8325464182 \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "action": "POWER_OFF",
  • "channels": [
    ],
  • "id": "ff6bbd04-c24c-4ecf-b09d-e6c415a65d63",
  • "threshold": {
    },
  • "timePeriod": "DAY",
  • "type": "DATA_TRAFFIC"
}

Create a notification setting

Create a notification setting

Authorizations:
X-LSW-Auth
path Parameters
instanceId
required
string <uuid>
Example: ace712e9-a166-47f1-9065-4af0f7e7fce1

Instance's ID

notificationSettingId
required
string <uuid>
Example: 3a042956-0689-45dc-8322-8b8325464182

Notification Setting ID

Request Body schema: application/json
required
required
object
timePeriod
required
string (timePeriod)
Enum: "DAY" "WEEK" "MONTH"

Frequency of the notification setting

action
required
string or null (action)
Enum: "POWER_OFF" null

The action for when the threshold is exceeded

required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "action": "POWER_OFF",
  • "channels": [
    ],
  • "threshold": {
    },
  • "timePeriod": "DAY"
}

Response samples

Content type
application/json
{
  • "action": "POWER_OFF",
  • "channels": [
    ],
  • "id": "ff6bbd04-c24c-4ecf-b09d-e6c415a65d63",
  • "threshold": {
    },
  • "timePeriod": "DAY",
  • "type": "DATA_TRAFFIC"
}

Update Notification Setting details

Authorizations:
X-LSW-Auth
path Parameters
instanceId
required
string <uuid>
Example: ace712e9-a166-47f1-9065-4af0f7e7fce1

Instance's ID

notificationSettingId
required
string <uuid>
Example: 3a042956-0689-45dc-8322-8b8325464182

Notification Setting ID

Request Body schema: application/json
required
object
timePeriod
string (timePeriod)
Enum: "DAY" "WEEK" "MONTH"

Frequency of the notification setting

action
string or null (action)
Enum: "POWER_OFF" null

The action for when the threshold is exceeded

Array of objects

Responses

Request samples

Content type
application/json
{
  • "action": "POWER_OFF",
  • "channels": [
    ],
  • "threshold": {
    },
  • "timePeriod": "DAY"
}

Response samples

Content type
application/json
{
  • "action": "POWER_OFF",
  • "channels": [
    ],
  • "id": "ff6bbd04-c24c-4ecf-b09d-e6c415a65d63",
  • "threshold": {
    },
  • "timePeriod": "DAY",
  • "type": "DATA_TRAFFIC"
}

Delete a notification setting setting

Authorizations:
X-LSW-Auth
path Parameters
instanceId
required
string <uuid>
Example: ace712e9-a166-47f1-9065-4af0f7e7fce1

Instance's ID

notificationSettingId
required
string <uuid>
Example: 3a042956-0689-45dc-8322-8b8325464182

Notification Setting ID

Responses

Request samples

curl --request DELETE \
  --url https://api.leaseweb.com/publicCloud/v1/instances/ace712e9-a166-47f1-9065-4af0f7e7fce1/notificationSettings/dataTraffic/3a042956-0689-45dc-8322-8b8325464182 \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

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

VPS

BETA

Leaseweb VPS (Virtual Private Server) is a hosting solution that provides dedicated virtualized resources within a physical server. It offers a balance between shared hosting and dedicated servers, making it a cost-effective option for businesses, developers, and enterprises that need more control, scalability, and performance.

Start a specific VPS

The VPS must be stopped before the execution

Authorizations:
X-LSW-Auth
path Parameters
vpsId
required
string
Example: 999999999

VPS ID

Responses

Request samples

curl --request POST \
  --url https://api.leaseweb.com/publicCloud/v1/vps/999999999/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 a specific VPS

The VPS must be running before the execution

Authorizations:
X-LSW-Auth
path Parameters
vpsId
required
string
Example: 999999999

VPS ID

Responses

Request samples

curl --request POST \
  --url https://api.leaseweb.com/publicCloud/v1/vps/999999999/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 a specific VPS

The VPS must be running before the execution

Authorizations:
X-LSW-Auth
path Parameters
vpsId
required
string
Example: 999999999

VPS ID

Responses

Request samples

curl --request POST \
  --url https://api.leaseweb.com/publicCloud/v1/vps/999999999/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."
}

Get console access

Get console access to the VPS

Authorizations:
X-LSW-Auth
path Parameters
vpsId
required
string
Example: 999999999

VPS ID

Responses

Request samples

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

List credentials stored for a specific VPS

Authorizations:
X-LSW-Auth
path Parameters
vpsId
required
string
Example: 999999999

VPS ID

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "credentials": [
    ]
}

Store credentials for a specific VPS

Authorizations:
X-LSW-Auth
path Parameters
vpsId
required
string
Example: 999999999

VPS 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": "12341234",
  • "type": "OPERATING_SYSTEM",
  • "username": "root"
}

Response samples

Content type
application/json
{
  • "password": "12341234",
  • "type": "OPERATING_SYSTEM",
  • "username": "root"
}

Delete all credentials associated with a specific VPS

Delete all credentials stored for a given VPS.

Authorizations:
X-LSW-Auth
path Parameters
vpsId
required
string
Example: 999999999

VPS ID

Responses

Request samples

curl --request DELETE \
  --url https://api.leaseweb.com/publicCloud/v1/vps/999999999/credentials \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

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 for a specific VPS

Authorizations:
X-LSW-Auth
path Parameters
vpsId
required
string
Example: 999999999

VPS ID

type
required
string (credentialType)
Enum: "OPERATING_SYSTEM" "CONTROL_PANEL"

Type of credential

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/publicCloud/v1/vps/999999999/credentials/%7Btype%7D \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "credentials": [
    ]
}

Get VPS credential by type and username.

Authorizations:
X-LSW-Auth
path Parameters
vpsId
required
string
Example: 999999999

VPS ID

type
required
string (credentialType)
Enum: "OPERATING_SYSTEM" "CONTROL_PANEL"

Type of credential

username
required
string
Example: root

Username

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/publicCloud/v1/vps/999999999/credentials/%7Btype%7D/root \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "password": "12341234",
  • "type": "OPERATING_SYSTEM",
  • "username": "root"
}

Update credentials for a given type and username

Authorizations:
X-LSW-Auth
path Parameters
vpsId
required
string
Example: 999999999

VPS ID

type
required
string (credentialType)
Enum: "OPERATING_SYSTEM" "CONTROL_PANEL"

Type of credential

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": "12341234"
}

Response samples

Content type
application/json
{
  • "password": "12341234",
  • "type": "OPERATING_SYSTEM",
  • "username": "root"
}

Delete VPS credential

Authorizations:
X-LSW-Auth
path Parameters
vpsId
required
string
Example: 999999999

VPS ID

type
required
string (credentialType)
Enum: "OPERATING_SYSTEM" "CONTROL_PANEL"

Type of credential

username
required
string
Example: root

Username

Responses

Request samples

curl --request DELETE \
  --url https://api.leaseweb.com/publicCloud/v1/vps/999999999/credentials/%7Btype%7D/root \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

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

Reset the password for a specific VPS

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
vpsId
required
string
Example: 999999999

VPS ID

Responses

Request samples

curl --request POST \
  --url https://api.leaseweb.com/publicCloud/v1/vps/999999999/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."
}

Attach ISO to a specific VPS

VPS 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
vpsId
required
string
Example: 999999999

VPS 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 a specific VPS

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

Authorizations:
X-LSW-Auth
path Parameters
vpsId
required
string
Example: 999999999

VPS ID

Responses

Request samples

curl --request POST \
  --url https://api.leaseweb.com/publicCloud/v1/vps/999999999/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."
}

List images available for reinstall

Authorizations:
X-LSW-Auth
path Parameters
vpsId
required
string
Example: 999999999

VPS 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.

standard
boolean
Example: standard=true

Filters the list to include only standard images.

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/publicCloud/v1/vps/999999999/reinstall/images?limit=20&offset=10&standard=true' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "images": [
    ],
  • "_metadata": {
    }
}

Reinstall a VPS

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

Cannot be performed when the VPS has snapshots.

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

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

Authorizations:
X-LSW-Auth
path Parameters
vpsId
required
string
Example: 999999999

VPS 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."
}

List IP addresses associated with a specific VPS

List the VPS's IPs

Authorizations:
X-LSW-Auth
path Parameters
vpsId
required
string
Example: 999999999

VPS ID

query Parameters
version
integer
Enum: 4 6

Ip version

nullRouted
boolean
ips
string

A list of IPs separated by |

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/publicCloud/v1/vps/999999999/ips?version=SOME_INTEGER_VALUE&nullRouted=SOME_BOOLEAN_VALUE&ips=SOME_STRING_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "ips": [
    ]
}

Get IP details for a specific VPS

Authorizations:
X-LSW-Auth
path Parameters
vpsId
required
string
Example: 999999999

VPS ID

ip
required
string <ip>
Example: 10.0.0.1

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/publicCloud/v1/vps/999999999/ips/10.0.0.1 \
  --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": {
    }
}

Update the IP address for a specific VPS

Allows you to set the reverse lookup for the IP

Authorizations:
X-LSW-Auth
path Parameters
vpsId
required
string
Example: 999999999

VPS 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": {
    }
}

Null route IP address for a specific resource VPS

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
vpsId
required
string
Example: 999999999

VPS 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": {
    }
}

Remove an IP null route for a specific VPS

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
vpsId
required
string
Example: 999999999

VPS ID

ip
required
string <ip>
Example: 10.0.0.1

Responses

Request samples

curl --request POST \
  --url https://api.leaseweb.com/publicCloud/v1/vps/999999999/ips/10.0.0.1/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": {
    }
}

Get data traffic metrics for a specific VPS

Authorizations:
X-LSW-Auth
path Parameters
vpsId
required
string
Example: 999999999

VPS ID

query Parameters
from
string <date>
Example: from=2025-01-28

The start of the interval to get the metric

to
string <date>
Example: to=2025-01-28

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

curl --request GET \
  --url 'https://api.leaseweb.com/publicCloud/v1/vps/999999999/metrics/datatraffic?from=2025-01-28&to=2025-01-28&granularity=SOME_STRING_VALUE&aggregation=SOME_STRING_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "metrics": {
    }
}

List snapshots

List VPS snapshots

Authorizations:
X-LSW-Auth
path Parameters
vpsId
required
string
Example: 999999999

VPS 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

curl --request GET \
  --url 'https://api.leaseweb.com/publicCloud/v1/vps/999999999/snapshots?limit=20&offset=10' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "snapshots": [
    ]
}

Create VPS snapshot

The VPS 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 VPS.

Authorizations:
X-LSW-Auth
path Parameters
vpsId
required
string
Example: 999999999

VPS ID

Request Body schema: application/json
required
name
required
string

A name to identify your snapshot

Responses

Request samples

Content type
application/json
{
  • "name": "my snapshot"
}

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
vpsId
required
string
Example: 999999999

VPS ID

snapshotId
required
string <uuid>

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/publicCloud/v1/vps/999999999/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 VPS snapshot

Authorizations:
X-LSW-Auth
path Parameters
vpsId
required
string
Example: 999999999

VPS ID

snapshotId
required
string <uuid>

Responses

Request samples

curl --request PUT \
  --url https://api.leaseweb.com/publicCloud/v1/vps/999999999/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 VPS snapshot

Authorizations:
X-LSW-Auth
path Parameters
vpsId
required
string
Example: 999999999

VPS ID

snapshotId
required
string <uuid>

Responses

Request samples

curl --request DELETE \
  --url https://api.leaseweb.com/publicCloud/v1/vps/999999999/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."
}

Get VPS list

List and filter VPS

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
Example: id=999999999

VPS Equipment Id

reference
string
Example: reference=Foo bar
ip
string <ip>
Example: ip=10.0.0.1
state
string
Enum: "RUNNING" "STARTING" "STOPPED" "STOPPING"

The current state

pack
string
Enum: "Leaseweb VPS 1" "Leaseweb VPS 2" "Leaseweb VPS 3" "Leaseweb VPS 4" "Leaseweb VPS 5" "Leaseweb VPS 6"

Vps package type

region
string (regionName)
Enum: "eu-west-3" "us-east-1" "eu-central-1" "ap-southeast-1" "us-west-1" "eu-west-2" "ca-central-1" "ap-northeast-1"

region name

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/publicCloud/v1/vps/?limit=20&offset=10&id=999999999&reference=Foo%20bar&ip=10.0.0.1&state=SOME_STRING_VALUE&pack=SOME_STRING_VALUE&region=SOME_STRING_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "vps": [
    ]
}

Get VPS details

Get VPS details.

Authorizations:
X-LSW-Auth
path Parameters
vpsId
required
string
Example: 999999999

VPS ID

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "contract": {
    },
  • "datacenter": "FRA-01",
  • "hasPublicIpV4": true,
  • "id": "123581321",
  • "image": {
    },
  • "ips": [
    ],
  • "iso": null,
  • "marketAppId": null,
  • "pack": "Leaseweb VPS 2",
  • "reference": "testing",
  • "region": "eu-central-1",
  • "resources": {
    },
  • "rootDiskSize": 50,
  • "startedAt": "2024-10-24T21:13:25+00:00",
  • "state": "RUNNING"
}

Update VPS details

Authorizations:
X-LSW-Auth
path Parameters
vpsId
required
string
Example: 999999999

VPS ID

Request Body schema: application/json
required
reference
string

An identifying name you can refer to the VPS

Responses

Request samples

Content type
application/json
{
  • "reference": "updated reference"
}

Response samples

Content type
application/json
{
  • "contract": {
    },
  • "datacenter": "FRA-01",
  • "hasPublicIpV4": true,
  • "id": "123581321",
  • "image": {
    },
  • "ips": [
    ],
  • "iso": null,
  • "marketAppId": null,
  • "pack": "Leaseweb VPS 2",
  • "reference": "testing",
  • "region": "eu-central-1",
  • "resources": {
    },
  • "rootDiskSize": 50,
  • "startedAt": "2024-10-24T21:13:25+00:00",
  • "state": "RUNNING"
}

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.

custom
boolean

Filters the list to include only custom images.

standard
boolean
Example: standard=true

Filters the list to include only standard images.

state
string (imageState)
Enum: "CREATING" "READY" "DESTROYED" "DESTROYING" "FAILED"

Filters the list by the state of custom images.

marketAppId
string (marketAppId)
Enum: "CPANEL_30" "CPANEL_100" "CPANEL_ADMIN" "CPANEL_PRO" "CPANEL_PLUS" "CPANEL_PREMIER" "PLESK_WEB_PRO" "PLESK_WEB_ADMIN" "PLESK_WEB_HOST"

Filters the list by the market app of standard images.

storageType
string
Enum: "LOCAL" "CENTRAL"

Filters the list by the market app of standard images.

name
string
Example: name=Ubuntu 20.04 LTS (x86_64)

Filters the list by the name of images.

flavour
string (flavour)
Enum: "ubuntu" "debian" "freebsd" "centos" "almalinux" "rockylinux" "archlinux" "windows"

Filters the list by the flavour of standard images.

region
string
Example: region=eu-west-3

Available regions can be found using the List Regions endpoint.

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/publicCloud/v1/vps/images?limit=20&offset=10&custom=SOME_BOOLEAN_VALUE&standard=true&state=SOME_STRING_VALUE&marketAppId=SOME_STRING_VALUE&storageType=SOME_STRING_VALUE&name=Ubuntu%2020.04%20LTS%20(x86_64)&flavour=SOME_STRING_VALUE&region=eu-west-3' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "images": [
    ],
  • "_metadata": {
    }
}

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

curl --request GET \
  --url 'https://api.leaseweb.com/publicCloud/v1/vps/isos?limit=20&offset=10' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "isos": [
    ]
}

List the notification settings of a customer

Authorizations:
X-LSW-Auth
path Parameters
vpsId
required
string
Example: 999999999

VPS 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

curl --request GET \
  --url 'https://api.leaseweb.com/publicCloud/v1/vps/vps/999999999/notificationSettings/dataTraffic?limit=20&offset=10' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "notificationSettings": [
    ]
}

Get details of a notification Setting

Authorizations:
X-LSW-Auth
path Parameters
vpsId
required
string
Example: 999999999

VPS ID

notificationSettingId
required
string <uuid>
Example: 3a042956-0689-45dc-8322-8b8325464182

Notification Setting ID

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/publicCloud/v1/vps/vps/999999999/notificationSettings/dataTraffic/3a042956-0689-45dc-8322-8b8325464182 \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "action": "POWER_OFF",
  • "channels": [
    ],
  • "id": "ff6bbd04-c24c-4ecf-b09d-e6c415a65d63",
  • "threshold": {
    },
  • "timePeriod": "DAY",
  • "type": "DATA_TRAFFIC"
}

Create a notification setting

Create a notification setting

Authorizations:
X-LSW-Auth
path Parameters
vpsId
required
string
Example: 999999999

VPS ID

notificationSettingId
required
string <uuid>
Example: 3a042956-0689-45dc-8322-8b8325464182

Notification Setting ID

Request Body schema: application/json
required
required
object
timePeriod
required
string (timePeriod)
Enum: "DAY" "WEEK" "MONTH"

Frequency of the notification setting

action
required
string or null (action)
Enum: "POWER_OFF" null

The action for when the threshold is exceeded

required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "action": "POWER_OFF",
  • "channels": [
    ],
  • "threshold": {
    },
  • "timePeriod": "DAY"
}

Response samples

Content type
application/json
{
  • "action": "POWER_OFF",
  • "channels": [
    ],
  • "id": "ff6bbd04-c24c-4ecf-b09d-e6c415a65d63",
  • "threshold": {
    },
  • "timePeriod": "DAY",
  • "type": "DATA_TRAFFIC"
}

Update Notification Setting details

Authorizations:
X-LSW-Auth
path Parameters
vpsId
required
string
Example: 999999999

VPS ID

notificationSettingId
required
string <uuid>
Example: 3a042956-0689-45dc-8322-8b8325464182

Notification Setting ID

Request Body schema: application/json
required
object
timePeriod
string (timePeriod)
Enum: "DAY" "WEEK" "MONTH"

Frequency of the notification setting

action
string or null (action)
Enum: "POWER_OFF" null

The action for when the threshold is exceeded

Array of objects

Responses

Request samples

Content type
application/json
{
  • "action": "POWER_OFF",
  • "channels": [
    ],
  • "threshold": {
    },
  • "timePeriod": "DAY"
}

Response samples

Content type
application/json
{
  • "action": "POWER_OFF",
  • "channels": [
    ],
  • "id": "ff6bbd04-c24c-4ecf-b09d-e6c415a65d63",
  • "threshold": {
    },
  • "timePeriod": "DAY",
  • "type": "DATA_TRAFFIC"
}

Delete a notification setting setting

Authorizations:
X-LSW-Auth
path Parameters
vpsId
required
string
Example: 999999999

VPS ID

notificationSettingId
required
string <uuid>
Example: 3a042956-0689-45dc-8322-8b8325464182

Notification Setting ID

Responses

Request samples

curl --request DELETE \
  --url https://api.leaseweb.com/publicCloud/v1/vps/vps/999999999/notificationSettings/dataTraffic/3a042956-0689-45dc-8322-8b8325464182 \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

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

Get service monitoring status

Get monitoring status

Authorizations:
X-LSW-Auth
path Parameters
vpsId
required
string
Example: 999999999

VPS ID

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "description": "Service is Up",
  • "status": "UP"
}

Enable monitoring

Enable service monitoring

Authorizations:
X-LSW-Auth
path Parameters
vpsId
required
string
Example: 999999999

VPS ID

Responses

Request samples

curl --request POST \
  --url https://api.leaseweb.com/publicCloud/v1/vps/vps/999999999/monitoring \
  --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."
}

GP VPS

Leaseweb GP VPS is a hosting solution that provides dedicated virtualized resources.

List virtual servers DEPRECATED

Authorizations:
X-LSW-Auth
query Parameters
limit
integer
Default: 10

Limit the number of results returned

offset
integer
Default: 0

Return results starting from the given offset

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/cloud/v2/virtualServers?limit=SOME_INTEGER_VALUE&offset=SOME_INTEGER_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "virtualServers": [
    ],
  • "_metadata": {
    }
}

Inspect a virtual server DEPRECATED

Authorizations:
X-LSW-Auth
path Parameters
virtualServerId
required
string
Example: 123242

Id of the virtual server

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/cloud/v2/virtualServers/123242 \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "id": "222903",
  • "reference": "Web server",
  • "customerId": "1301178860",
  • "dataCenter": "AMS-01",
  • "cloudServerId": null,
  • "state": "STOPPED",
  • "firewallState": "DISABLED",
  • "template": "Ubuntu 14.04 64 40 20140707T1340",
  • "serviceOffering": "S",
  • "sla": "Bronze",
  • "contract": {
    },
  • "hardware": {
    },
  • "iso": {
    },
  • "ips": [
    ]
}

Update a virtual server DEPRECATED

Authorizations:
X-LSW-Auth
path Parameters
virtualServerId
required
string
Example: 123242

Id of the virtual server

Request Body schema: application/json
required
reference
required
string

The reference description for the virtual server

Responses

Request samples

Content type
application/json
{
  • "reference": "My reference"
}

Response samples

Content type
application/json
{
  • "id": "222903",
  • "reference": "Web server",
  • "customerId": "1301178860",
  • "dataCenter": "AMS-01",
  • "cloudServerId": null,
  • "state": "STOPPED",
  • "firewallState": "DISABLED",
  • "template": "Ubuntu 14.04 64 40 20140707T1340",
  • "serviceOffering": "S",
  • "sla": "Bronze",
  • "contract": {
    },
  • "hardware": {
    },
  • "iso": {
    },
  • "ips": [
    ]
}

Power on DEPRECATED

The power on call is an asynchronous call, meaning the power on will be performed as soon as possible.

Authorizations:
X-LSW-Auth
path Parameters
virtualServerId
required
string
Example: 123242

Id of the virtual server

Responses

Request samples

curl --request POST \
  --url https://api.leaseweb.com/cloud/v2/virtualServers/123242/powerOn \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "id": "cs01.237daad0-2aed-4260-b0e4-488d9cd55607",
  • "name": "virtualServers.powerOn",
  • "status": "PENDING",
  • "createdAt": "2016-12-31T01:00:59+00:00"
}

Power off DEPRECATED

The power off call is an asynchronous call, meaning the power off will be performed as soon as possible.

Authorizations:
X-LSW-Auth
path Parameters
virtualServerId
required
string
Example: 123242

Id of the virtual server

Responses

Request samples

curl --request POST \
  --url https://api.leaseweb.com/cloud/v2/virtualServers/123242/powerOff \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "id": "cs01.237daad0-2aed-4260-b0e4-488d9cd55607",
  • "name": "virtualServers.powerOff",
  • "status": "PENDING",
  • "createdAt": "2016-12-31T01:00:59+00:00"
}

Reboot DEPRECATED

The reboot call is an asynchronous call, meaning the reboot will be performed as soon as possible.

Authorizations:
X-LSW-Auth
path Parameters
virtualServerId
required
string
Example: 123242

Id of the virtual server

Responses

Request samples

curl --request POST \
  --url https://api.leaseweb.com/cloud/v2/virtualServers/123242/reboot \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "id": "cs01.237daad0-2aed-4260-b0e4-488d9cd55607",
  • "name": "virtualServers.reboot",
  • "status": "PENDING",
  • "createdAt": "2016-12-31T01:00:59+00:00"
}

Reinstall DEPRECATED

The virtual server will be reinstalled with any supported operating system. The reinstall call is an asynchronous call, meaning the reinstall will be performed as soon as possible. To get the list of supported operating system please check the api documentation for templates.

Authorizations:
X-LSW-Auth
path Parameters
virtualServerId
required
string
Example: 123242

Id of the virtual server

Request Body schema: application/json
operatingSystemId
required
string

Id of the operating system that needs to be used for reinstallation.

Responses

Request samples

Content type
application/json
{
  • "operatingSystemId": "CENTOS_7_64_PLESK"
}

Response samples

Content type
application/json
{
  • "id": "cs01.237daad0-2aed-4260-b0e4-488d9cd55607",
  • "name": "virtualServers.reinstall",
  • "status": "PENDING",
  • "createdAt": "2016-12-31T01:00:59+00:00"
}

Update credentials of a virtual machine DEPRECATED

This API call will only update the password displayed for your machine in the customer portal. It will not make any changes to the root password of your machine.

Authorizations:
X-LSW-Auth
path Parameters
virtualServerId
required
string
Example: 123242

Id of the virtual server

Request Body schema: application/json
username
required
string

Username of the virtual server (mostly root)

password
required
string

Password of the virtual server

type
required
string
Enum: "OPERATING_SYSTEM" "CONTROL_PANEL"

Type of credentials

Responses

Request samples

Content type
application/json
{
  • "username": "root",
  • "password": "my_secret_password",
  • "type": "OPERATING_SYSTEM"
}

Response samples

Content type
application/json
{
  • "errorCode": "ACCESS_DENIED",
  • "errorMessage": "The access token is expired or invalid."
}

List credentials DEPRECATED

You will only be able to retrieve the last password that we configured in your server or control panel. If you changed it, the information retrieved by this API call will not work.

The password is not returned in this call, you must use the endpoint to get a credential by the username to retrieve it.

Authorizations:
X-LSW-Auth
path Parameters
virtualServerId
required
string
Example: 123242

Id of the virtual server

credentialType
required
string
Enum: "OPERATING_SYSTEM" "CONTROL_PANEL"

Type of credential pair

query Parameters
limit
integer
Default: 10

Limit the number of results returned

offset
integer
Default: 0

Return results starting from the given offset

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/cloud/v2/virtualServers/123242/credentials/%7BcredentialType%7D?limit=SOME_INTEGER_VALUE&offset=SOME_INTEGER_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "credentials": [
    ],
  • "_metadata": {
    }
}

Inspect user credentials DEPRECATED

You will only be able to retrieve the last password that we configured in your server or control panel. If you changed it, the information retrieved by this API call will not work.

Authorizations:
X-LSW-Auth
path Parameters
virtualServerId
required
string
Example: 123242

Id of the virtual server

credentialType
required
string
Enum: "OPERATING_SYSTEM" "CONTROL_PANEL"

Type of credential pair

username
required
string

Name of the user in your server.

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/cloud/v2/virtualServers/123242/credentials/%7BcredentialType%7D/%7Busername%7D \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "type": "OPERATING_SYSTEM",
  • "username": "root",
  • "password": "password123"
}

Inspect datatraffic metrics DEPRECATED

Authorizations:
X-LSW-Auth
path Parameters
virtualServerId
required
string
Example: 123242

Id of the virtual server

query Parameters
granularity
string
Enum: "NONE" "5MIN" "HOUR" "DAY" "MONTH" "YEAR"

Specify the preferred interval for each metric. If granularity is omitted from the request, only one metric is returned.

aggregation
string
Value: "SUM"

Aggregate each metric using the given aggregation function.

from
date

Start of date interval in RFC3339 format.

The returned data will include everything up from - and including - the specified date time.

to
date

End of date interval in RFC3339 format.

The returned data will include everything up until - but not including - the specified date time.

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/cloud/v2/virtualServers/123242/metrics/datatraffic?granularity=SOME_STRING_VALUE&aggregation=SOME_STRING_VALUE&from=SOME_DATE_VALUE&to=SOME_DATE_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "metrics": {
    }
}

List templates DEPRECATED

Retrieves all the supported operating system templates for the specified virtual server

Authorizations:
X-LSW-Auth
path Parameters
virtualServerId
required
string

Id of the virtual server

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/cloud/v2/virtualServers/%7BvirtualServerId%7D/templates \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "templates": [
    ]
}

List snapshots DEPRECATED

Authorizations:
X-LSW-Auth
path Parameters
virtualServerId
required
string
Example: 123242

Id of the virtual server

query Parameters
limit
integer
Default: 10

Limit the number of results returned

offset
integer
Default: 0

Return results starting from the given offset

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/cloud/v2/virtualServers/123242/snapshots?limit=SOME_INTEGER_VALUE&offset=SOME_INTEGER_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "snapshots": [
    ],
  • "_metadata": {
    }
}

Create snapshot DEPRECATED

To create a snapshot, the VPS must be Running and have a General Purpose (GP) pack

Authorizations:
X-LSW-Auth
path Parameters
virtualServerId
required
string
Example: 123242

Id of the virtual server

Request Body schema: application/json
required
name
required
string

The snapshot name, starting with letters, containing only letters, numbers and spaces

Responses

Request samples

Content type
application/json
{
  • "name": "Snapshot 1"
}

Response samples

Content type
application/json
{
  • "id": "2e78c712-ba58-4078-95ad-ba86617c9f54",
  • "name": "virtualServer.createVMSnapshot",
  • "status": "PENDING",
  • "createdAt": "2023-02-23T15:52:54+00:00"
}

Get snapshot DEPRECATED

Authorizations:
X-LSW-Auth
path Parameters
virtualServerId
required
string
Example: 123242

Id of the virtual server

snapshotId
required
string
Example: 8083e330-9888-4ae6-8f11-d372c5a50e63

The snapshot's UUID

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/cloud/v2/virtualServers/123242/snapshots/8083e330-9888-4ae6-8f11-d372c5a50e63 \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "id": "8083e330-9888-4ae6-8f11-d372c5a50e63",
  • "name": "Snapshot 1",
  • "state": "READY",
  • "created_at": "2023-02-24T09:33:01+00:00"
}

Delete snapshot DEPRECATED

Authorizations:
X-LSW-Auth
path Parameters
virtualServerId
required
string
Example: 123242

Id of the virtual server

snapshotId
required
string
Example: 8083e330-9888-4ae6-8f11-d372c5a50e63

The snapshot's UUID

Responses

Request samples

curl --request DELETE \
  --url https://api.leaseweb.com/cloud/v2/virtualServers/123242/snapshots/8083e330-9888-4ae6-8f11-d372c5a50e63 \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "id": "2e78c712-ba58-4078-95ad-ba86617c9f54",
  • "name": "virtualServer.deleteVMSnapshot",
  • "status": "PENDING",
  • "createdAt": "2023-02-23T15:52:54+00:00"
}

Restore snapshot DEPRECATED

Restore the VPS state (disk and memory) to the snapshot. The VPS must be running in order to have its snapshot restored

Authorizations:
X-LSW-Auth
path Parameters
virtualServerId
required
string
Example: 123242

Id of the virtual server

snapshotId
required
string

The snapshot's UUID

Responses

Request samples

curl --request POST \
  --url https://api.leaseweb.com/cloud/v2/virtualServers/123242/snapshots/%7BsnapshotId%7D/restore \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "id": "2e78c712-ba58-4078-95ad-ba86617c9f54",
  • "name": "virtualServer.restoreVMSnapshot",
  • "status": "PENDING",
  • "createdAt": "2023-02-23T15:52:54+00:00"
}

Private Clouds

Leaseweb Private Cloud is a dedicated cloud solution that provides a secure, high-performance, and customizable cloud environment for businesses. Unlike public cloud services, a private cloud ensures that all resources are dedicated to a single organization, enhancing security, performance, and compliance.

List private clouds

Authorizations:
X-LSW-Auth
query Parameters
limit
integer
Default: 10
Example: limit=10

Limit the number of results returned

offset
integer
Default: 0

Return results starting from the given offset

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/cloud/v2/privateClouds?limit=10&offset=0' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "privateClouds": [
    ],
  • "_metadata": {
    }
}

Inspect a private cloud

Authorizations:
X-LSW-Auth
path Parameters
privateCloudId
required
string
Example: 123242

Id of the private cloud

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/cloud/v2/privateClouds/123242 \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "id": "218030",
  • "customerId": "1301178860",
  • "dataCenter": "AMS-01",
  • "serviceOffering": "FLAT_FEE",
  • "sla": "Bronze",
  • "contract": {
    },
  • "hardware": {
    },
  • "ips": [
    ],
  • "networkTraffic": {
    }
}

List credentials

Please note that this feature is only available for CloudStack Private Clouds.

Also note that you will only be able to retrieve the last password that we configured in your remote management tool. If you changed it, the information retrieved by this API call will not work.

NameTypeDescription
typestringType of credential pair. Possible values are REMOTE_MANAGEMENT.
usernamestringName of the user in the remote management tool.
domainstringDomain name to log in to the remote management tool.
Please note that the password is not returned in this call, you must use the endpoint to get a credential by the username to retrieve it.

The _metadata object contains the following attributes:

NameTypeDescription
totalCountintegerTotal amount of credentials that were found.
limitintegerMaximum amount of credentials that will be included in the credentials array.
offsetintegerOffset of the request.
Authorizations:
X-LSW-Auth
path Parameters
credentialType
required
string
Value: "REMOTE_MANAGEMENT"

Type of credential pair

privateCloudId
required
string
Example: 123242

Id of the private cloud

query Parameters
limit
integer
Default: 10
Example: limit=10

Limit the number of results returned

offset
integer
Default: 0

Return results starting from the given offset

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/cloud/v2/privateClouds/123242/credentials/%7BcredentialType%7D?limit=10&offset=0' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "credentials": [
    ],
  • "_metadata": {
    }
}

Inspect user credentials

Please note that this feature is only available for CloudStack Private Clouds.

Also note that you will only be able to retrieve the last password that we configured in your server or control panel. If you changed it, the information retrieved by this API call will not work.

Authorizations:
X-LSW-Auth
path Parameters
credentialType
required
string
Value: "REMOTE_MANAGEMENT"

Type of credential pair

username
required
string

Name of the user in the remote management tool

privateCloudId
required
string
Example: 123242

Id of the private cloud

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/cloud/v2/privateClouds/123242/credentials/%7BcredentialType%7D/%7Busername%7D \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "type": "REMOTE_MANAGEMENT",
  • "username": "root",
  • "password": "password123",
  • "domain": "123456"
}

Inspect datatraffic metrics

Authorizations:
X-LSW-Auth
path Parameters
privateCloudId
required
string
Example: 123242

Id of the private cloud

query Parameters
granularity
string
Enum: "NONE" "5MIN" "HOUR" "DAY" "MONTH" "YEAR"

Specify the preferred interval for each metric. If granularity is omitted from the request, only one metric is returned.

aggregation
string
Value: "SUM"

Aggregate each metric using the given aggregation function.

from
date

Start of date interval in RFC3339 format.

The returned data will include everything up from - and including - the specified date time.

to
date

End of date interval in RFC3339 format.

The returned data will include everything up until - but not including - the specified date time.

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/cloud/v2/privateClouds/%7B[privateCloudId%7D/metrics/datatraffic?granularity=SOME_STRING_VALUE&aggregation=SOME_STRING_VALUE&from=SOME_DATE_VALUE&to=SOME_DATE_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "metrics": {
    }
}

Inspect bandwidth metrics

Authorizations:
X-LSW-Auth
path Parameters
privateCloudId
required
string
Example: 123242

Id of the private cloud

query Parameters
granularity
string
Enum: "NONE" "5MIN" "HOUR" "DAY" "MONTH" "YEAR"

Specify the preferred interval for each metric. If granularity is omitted from the request, only one metric is returned.

aggregation
string
Value: "AVG"

Aggregate each metric using the given aggregation function.

from
date

Start of date interval in RFC3339 format.

The returned data will include everything up from - and including - the specified date time.

to
date

End of date interval in RFC3339 format.

The returned data will include everything up until - but not including - the specified date time.

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/cloud/v2/privateClouds/123242/metrics/bandwidth?granularity=SOME_STRING_VALUE&aggregation=SOME_STRING_VALUE&from=SOME_DATE_VALUE&to=SOME_DATE_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "metrics": {
    }
}

Inspect CPU metrics

Authorizations:
X-LSW-Auth
path Parameters
privateCloudId
required
string
query Parameters
granularity
string
Enum: "NONE" "5MIN" "HOUR" "DAY" "MONTH" "YEAR"

Specify the preferred interval for each metric. If granularity is omitted from the request, only one metric is returned.

aggregation
string
Value: "AVG"

Aggregate each metric using the given aggregation function.

from
date

Start of date interval in RFC3339 format.

The returned data will include everything up from - and including - the specified date time.

to
date

End of date interval in RFC3339 format.

The returned data will include everything up until - but not including - the specified date time.

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/cloud/v2/privateClouds/%7BprivateCloudId%7D/metrics/cpu?granularity=SOME_STRING_VALUE&aggregation=SOME_STRING_VALUE&from=SOME_DATE_VALUE&to=SOME_DATE_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "metrics": {
    }
}

Inspect memory metrics

Authorizations:
X-LSW-Auth
path Parameters
privateCloudId
required
string
Example: 123242

Id of the private cloud

query Parameters
granularity
string
Enum: "NONE" "5MIN" "HOUR" "DAY" "MONTH" "YEAR"

Specify the preferred interval for each metric. If granularity is omitted from the request, only one metric is returned.

aggregation
string
Value: "AVG"

Aggregate each metric using the given aggregation function.

from
date

Start of date interval in RFC3339 format.

The returned data will include everything up from - and including - the specified date time.

to
date

End of date interval in RFC3339 format.

The returned data will include everything up until - but not including - the specified date time.

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/cloud/v2/privateClouds/123242/metrics/memory?granularity=SOME_STRING_VALUE&aggregation=SOME_STRING_VALUE&from=SOME_DATE_VALUE&to=SOME_DATE_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "metrics": {
    }
}

Inspect storage metrics

Authorizations:
X-LSW-Auth
path Parameters
privateCloudId
required
string
Example: 123242

Id of the private cloud

query Parameters
granularity
string
Enum: "NONE" "5MIN" "HOUR" "DAY" "MONTH" "YEAR"

Specify the preferred interval for each metric. If granularity is omitted from the request, only one metric is returned.

aggregation
string
Value: "MAX"

Aggregate each metric using the given aggregation function.

from
date

Start of date interval in RFC3339 format.

The returned data will include everything up from - and including - the specified date time.

to
date

End of date interval in RFC3339 format.

The returned data will include everything up until - but not including - the specified date time.

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/cloud/v2/privateClouds/123242/metrics/storage?granularity=SOME_STRING_VALUE&aggregation=SOME_STRING_VALUE&from=SOME_DATE_VALUE&to=SOME_DATE_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "metrics": {
    }
}

Storage

BETA LIMITED ACCESS

Leaseweb Storage is a storage solution that provides scalable and reliable storage for businesses. It offers a range of storage options, including block storage, object storage, and file storage, to meet different storage needs and requirements.

List storages

Show all storages for the given customer.

Authorizations:
X-LSW-Auth
query Parameters
limit
integer
Default: 10

Limit the number of results returned.

offset
integer
Default: 0

Return results starting from the given offset.

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "storages": [
    ]
}

List StorageVMs

Show all StorageVMs for the given customer.

Authorizations:
X-LSW-Auth
query Parameters
limit
integer
Default: 10

Limit the number of results returned.

offset
integer
Default: 0

Return results starting from the given offset.

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "storageVMs": [
    ]
}

List volumes

Show all the volumes in a StorageVM.

Authorizations:
X-LSW-Auth
path Parameters
storageVMId
required
string
Example: 1575dd1c-dddf-11ed-af62-000c299d72cd

UUID of the Storage VM.

query Parameters
limit
integer
Default: 10

Limit the number of results returned.

offset
integer
Default: 0

Return results starting from the given offset.

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/storage/v1/storageVMs/1575dd1c-dddf-11ed-af62-000c299d72cd/volumes?limit=SOME_INTEGER_VALUE&offset=SOME_INTEGER_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "volumes": [
    ]
}

Grow volume

Grow the size of a volume in StorageVM.

Authorizations:
X-LSW-Auth
path Parameters
storageVMId
required
string
Example: 1575dd1c-dddf-11ed-af62-000c299d72cd

UUID of the Storage VM.

volumeId
required
string
Example: 1575dd1c-dddf-11ed-af62-000c299d72cd

UUID of a storage volume.

Request Body schema: application/json
growSize
required
integer

The amount by which the volume will be grown in GB.

Responses

Request samples

Content type
application/json
{
  • "growSize": 5
}

Response samples

Content type
application/json
{
  • "id": "d385ae54-3763-11ee-af62-000c299d72cd",
  • "status": "PENDING"
}

Show a job

Gets status details about a job running in the specified storage VM.

Authorizations:
X-LSW-Auth
path Parameters
storageVMId
required
string
Example: 1575dd1c-dddf-11ed-af62-000c299d72cd

UUID of the Storage VM.

jobId
required
string
Example: d385ae54-3763-11ee-af62-000c299d72cd

UUID of a queue job.

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/storage/v1/storageVMs/1575dd1c-dddf-11ed-af62-000c299d72cd/jobs/d385ae54-3763-11ee-af62-000c299d72cd \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "id": "d385ae54-3763-11ee-af62-000c299d72cd",
  • "status": "COMPLETED",
  • "startedAt": "2023-07-31T12:39:23+00:00",
  • "completedAt": "2023-07-31T12:39:24+00:00"
}

Dedicated Servers

Leaseweb Dedicated Servers are physical servers that are dedicated to a single customer, providing high performance, scalability, and security. They are ideal for businesses that require a dedicated environment for their critical applications.

List servers

List your Dedicated Servers. This api call supports pagination. Use the limit and offset query string parameters to paginate through all your dedicated servers.

Every server object in the json response lists a few properties of a server. Use the single resource api call to get more details for a single server.

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.

reference
string
Example: reference=my-db

Filter the list of servers by reference.

ip
string <ipv4>
Example: ip=127.0.0.4

Filter the list of servers by ip address.

macAddress
string([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})|([0-9...
Example: macAddress=aa:bb:cc:dd:ee:ff

Filter the list of servers by mac address.

site
string
Example: site=FRA-10

Filter the list of servers by site (location).

privateRackId
string
Example: privateRackId=123

Filter the list of servers by dedicated rack id.

privateNetworkCapable
string
Enum: "true" "false"

Filter the list for private network capable servers

privateNetworkEnabled
string
Enum: "true" "false"

Filter the list for private network enabled servers

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/bareMetals/v2/servers?limit=20&offset=10&reference=my-db&ip=127.0.0.4&macAddress=aa%3Abb%3Acc%3Add%3Aee%3Aff&site=FRA-10&privateRackId=123&privateNetworkCapable=SOME_STRING_VALUE&privateNetworkEnabled=SOME_STRING_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "servers": [
    ]
}

Get server

Use this API to get information about a single server.

Authorizations:
X-LSW-Auth
path Parameters
serverId
required
string
Example: 12345

The ID of a server

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/bareMetals/v2/servers/12345 \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "assetId": "1234561882",
  • "contract": {
    },
  • "featureAvailability": {
    },
  • "id": "123456",
  • "isPrivateNetworkCapable": true,
  • "isPrivateNetworkEnabled": true,
  • "isRedundantPrivateNetworkCapable": false,
  • "location": {
    },
  • "networkInterfaces": {
    },
  • "powerPorts": [
    ],
  • "privateNetworks": [
    ],
  • "rack": {
    },
  • "serialNumber": "HN2XGHSD02H04",
  • "specs": {
    }
}

Update server

Update the reference for a server.

Authorizations:
X-LSW-Auth
path Parameters
serverId
required
string
Example: 12345

The ID of a server

Request Body schema: application/json
required
reference
required
string

The reference for this server

Responses

Request samples

Content type
application/json
{
  • "reference": "database-server"
}

Response samples

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

List IPs

List all IP Addresses associated with this server. Optionally filtered.

Authorizations:
X-LSW-Auth
path Parameters
serverId
required
string
Example: 12345

The ID of a server

query Parameters
networkType
string
Enum: "INTERNAL" "PUBLIC" "REMOTE_MANAGEMENT"
Example: networkType=INTERNAL

Filter the collection of ip addresses by network type

version
string

Filter the collection by ip version

nullRouted
string

Filter Ips by Nulled-Status

ips
string

Filter the collection of Ips for the comma separated list of Ips

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

curl --request GET \
  --url 'https://api.leaseweb.com/bareMetals/v2/servers/12345/ips?networkType=INTERNAL&version=SOME_STRING_VALUE&nullRouted=SOME_STRING_VALUE&ips=SOME_STRING_VALUE&limit=20&offset=10' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "ips": [
    ]
}

Show a server IP

Get a single IP address associated with this server.

Authorizations:
X-LSW-Auth
path Parameters
serverId
required
string
Example: 12345

The ID of a server

ip
required
string
Example: 127.0.0.6

The IP Address

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/bareMetals/v2/servers/12345/ips/127.0.0.6 \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "ddos": {
    },
  • "floatingIp": false,
  • "gateway": "12.123.123.254",
  • "ip": "12.123.123.1/24",
  • "mainIp": true,
  • "networkType": "PUBLIC",
  • "nullRouted": false,
  • "reverseLookup": "domain.example.com",
  • "version": 4
}

Update an IP

Update the reverse lookup or DDoS detection profile for the ip address.

DDoS detection profiles can only be changed if the IP address is protected using Advanced DDoS protection.

For more information about DDoS detection profiles click here for our KB related article.

Authorizations:
X-LSW-Auth
path Parameters
serverId
required
string
Example: 12345

The ID of a server

ip
required
string
Example: 127.0.0.6

The IP Address

Request Body schema: application/json
detectionProfile
string
Enum: "ADVANCED_DEFAULT" "ADVANCED_LOW_UDP" "ADVANCED_MED_UDP"

The detection profile value

reverseLookup
string

The reverse lookup value

Responses

Request samples

Content type
application/json
{
  • "detectionProfile": "ADVANCED_LOW_UDP",
  • "reverseLookup": "domain.example.com"
}

Response samples

Content type
application/json
{
  • "ddos": {
    },
  • "floatingIp": false,
  • "gateway": "12.123.123.254",
  • "ip": "12.123.123.1/24",
  • "mainIp": true,
  • "networkType": "PUBLIC",
  • "nullRouted": false,
  • "reverseLookup": "domain.example.com",
  • "version": 4
}

Null route an IP

Null the given IP address. It might take a few minutes before the change is propagated across the network.

Authorizations:
X-LSW-Auth
path Parameters
serverId
required
string
Example: 12345

The ID of a server

ip
required
string
Example: 127.0.0.6

The IP Address

Responses

Request samples

curl --request POST \
  --url https://api.leaseweb.com/bareMetals/v2/servers/12345/ips/127.0.0.6/null \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "ddos": {
    },
  • "floatingIp": false,
  • "gateway": "12.123.123.254",
  • "ip": "12.123.123.1/24",
  • "mainIp": true,
  • "networkType": "PUBLIC",
  • "nullRouted": false,
  • "reverseLookup": "domain.example.com",
  • "version": 4
}

Remove a null route

Remove an existing null route for the given IP address. It might take a few minutes before the change is propagated across the network.

Authorizations:
X-LSW-Auth
path Parameters
serverId
required
string
Example: 12345

The ID of a server

ip
required
string
Example: 127.0.0.6

The IP Address

Responses

Request samples

curl --request POST \
  --url https://api.leaseweb.com/bareMetals/v2/servers/12345/ips/127.0.0.6/unnull \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "ddos": {
    },
  • "floatingIp": false,
  • "gateway": "12.123.123.254",
  • "ip": "12.123.123.1/24",
  • "mainIp": true,
  • "networkType": "PUBLIC",
  • "nullRouted": false,
  • "reverseLookup": "domain.example.com",
  • "version": 4
}

Show null route history

Show all null route history for any ips associated with this server.

Authorizations:
X-LSW-Auth
path Parameters
serverId
required
string
Example: 12345

The ID of a server

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

curl --request GET \
  --url 'https://api.leaseweb.com/bareMetals/v2/servers/12345/nullRouteHistory?limit=20&offset=10' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "nullRoutes": [
    ]
}

Delete a server from a private network

This API call will remove the dedicated server from the private network.

It takes a few minutes before the server has been removed from the private network.

To get the current status of the server you can call /bareMetals/v2/servers/{serverId}.

While the server is being removed the status changes to REMOVING.

Authorizations:
X-LSW-Auth
path Parameters
serverId
required
string
Example: 12345

The ID of a server

privateNetworkId
required
string
Example: 892

The ID of a Private Network

Responses

Request samples

curl --request DELETE \
  --url https://api.leaseweb.com/bareMetals/v2/servers/12345/privateNetworks/892 \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "correlationId": "f8d84555-9822-49fb-919a-d4945b201fe3",
  • "errorCode": "400",
  • "errorMessage": "Equipment 27072 is not part of private network 3943"
}

Add a server to private network

It takes a few minutes before the server has access to the private network.

To get the current status of the server you can call /bareMetals/v2/servers/{serverId}.

Once the server is added to the private network the status changes from CONFIGURING to CONFIGURED.

Authorizations:
X-LSW-Auth
path Parameters
serverId
required
string
Example: 12345

The ID of a server

privateNetworkId
required
string
Example: 892

The ID of a Private Network

Request Body schema: application/json
linkSpeed
required
integer (linkSpeed)
Enum: 100 1000 10000 25000 40000 100000

The port speed in Mbps

Responses

Request samples

Content type
application/json
{
  • "linkSpeed": 100
}

Response samples

Content type
application/json
{
  • "correlationId": "f8d84555-9822-49fb-919a-d4945b201fe3",
  • "errorCode": "400",
  • "errorMessage": "Equipment 27072 is not part of private network 3943"
}

List network interfaces

List all network interfaces for this server, including their current status.

Authorizations:
X-LSW-Auth
path Parameters
serverId
required
string
Example: 12345

The ID of a server

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/bareMetals/v2/servers/12345/networkInterfaces \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "networkInterfaces": [
    ]
}

Close all network interfaces

Close all network interfaces for this server.

Authorizations:
X-LSW-Auth
path Parameters
serverId
required
string
Example: 12345

The ID of a server

Responses

Request samples

curl --request POST \
  --url https://api.leaseweb.com/bareMetals/v2/servers/12345/networkInterfaces/close \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

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

Open all network interfaces

Open all network interfaces of this server.

Authorizations:
X-LSW-Auth
path Parameters
serverId
required
string
Example: 12345

The ID of a server

Responses

Request samples

curl --request POST \
  --url https://api.leaseweb.com/bareMetals/v2/servers/12345/networkInterfaces/open \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

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

Show a network interface

Show the network interface of the given type of this server, including its status.

Authorizations:
X-LSW-Auth
path Parameters
serverId
required
string
Example: 12345

The ID of a server

networkTypeURL
required
string
Enum: "internal" "public" "remoteManagement"
Example: internal

Type of network

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/bareMetals/v2/servers/12345/networkInterfaces/internal \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "linkSpeed": "100Mbps",
  • "operStatus": "OPEN",
  • "status": "OPEN",
  • "switchInterface": "33",
  • "switchName": "EVO-JV12-1",
  • "type": "PUBLIC"
}

Close network interface

Close the network interface of this type of this server.

Authorizations:
X-LSW-Auth
path Parameters
serverId
required
string
Example: 12345

The ID of a server

networkTypeURL
required
string
Enum: "internal" "public" "remoteManagement"
Example: internal

Type of network

Responses

Request samples

curl --request POST \
  --url https://api.leaseweb.com/bareMetals/v2/servers/12345/networkInterfaces/internal/close \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

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

Open network interface

Open all network interfaces of the given type for this server.

Authorizations:
X-LSW-Auth
path Parameters
serverId
required
string
Example: 12345

The ID of a server

networkTypeURL
required
string
Enum: "internal" "public" "remoteManagement"
Example: internal

Type of network

Responses

Request samples

curl --request POST \
  --url https://api.leaseweb.com/bareMetals/v2/servers/12345/networkInterfaces/internal/open \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

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

Inspect DDoS notification settings

Show all DDoS Protection related notification settings for this server. These settings control if you want to be notified via email in case a DDoS was mitigated.

Authorizations:
X-LSW-Auth
path Parameters
serverId
required
string
Example: 12345

The ID of a server

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/bareMetals/v2/servers/12345/notificationSettings/ddos \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "nulling": "ENABLED",
  • "scrubbing": "DISABLED"
}

Update DDoS notification settings

Update your DDoS notification settings for this server.

Authorizations:
X-LSW-Auth
path Parameters
serverId
required
string
Example: 12345

The ID of a server

Request Body schema: application/json
nulling
string
Enum: "ENABLED" "DISABLED"

Enable or disable email notifications for nulling events

scrubbing
string
Enum: "ENABLED" "DISABLED"

Enable or disable email notifications for nulling events

Responses

Request samples

Content type
application/json
{
  • "nulling": "DISABLED",
  • "scrubbing": "ENABLED"
}

Response samples

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

Show bandwidth metrics

At this moment only bandwidth information for the public interface is supported.

Authorizations:
X-LSW-Auth
path Parameters
serverId
required
string
Example: 12345

The ID of a server

query Parameters
from
required
string <date-time>
Example: from=2019-06-01T00:00:00Z

Start of date interval in ISO-8601 format. The returned data will include everything up from - and including - the specified date time.

to
required
string <date-time>
Example: to=2019-06-05T00:00:00Z

End of date interval in ISO-8601 format. The returned data will include everything up until - but not including - the specified date time.

granularity
string
Enum: "5MIN" "HOUR" "DAY" "WEEK" "MONTH" "YEAR"

Specify the preferred interval for each metric. If granularity is omitted from the request, only one metric is returned.

aggregation
required
string
Enum: "AVG" "95TH"

Aggregate each metric using the given aggregation function. When the aggregation type 95TH is specified the granularity parameter should be omitted from the request.

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/bareMetals/v2/servers/12345/metrics/bandwidth?from=2019-06-01T00%3A00%3A00Z&to=2019-06-05T00%3A00%3A00Z&granularity=SOME_STRING_VALUE&aggregation=SOME_STRING_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "metrics": {
    }
}

Show datatraffic metrics

At this moment only bandwidth information for the public interface is supported.

Authorizations:
X-LSW-Auth
path Parameters
serverId
required
string
Example: 12345

The ID of a server

query Parameters
from
required
string <date-time>
Example: from=2019-06-01T00:00:00Z

Start of date interval in ISO-8601 format. The returned data will include everything up from - and including - the specified date time.

to
required
string <date-time>
Example: to=2019-06-05T00:00:00Z

End of date interval in ISO-8601 format. The returned data will include everything up until - but not including - the specified date time.

granularity
string
Enum: "DAY" "WEEK" "MONTH" "YEAR"

Specify the preferred interval for each metric. If granularity is omitted from the request, only one metric is returned.

aggregation
required
string
Value: "SUM"

Aggregate each metric using the given aggregation function.

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/bareMetals/v2/servers/12345/metrics/datatraffic?from=2019-06-01T00%3A00%3A00Z&to=2019-06-05T00%3A00%3A00Z&granularity=SOME_STRING_VALUE&aggregation=SOME_STRING_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "metrics": {
    }
}

List bandwidth notification settings

List all bandwidth notification settings for this server.

Authorizations:
X-LSW-Auth
path Parameters
serverId
required
string
Example: 12345

The ID of a server

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

curl --request GET \
  --url 'https://api.leaseweb.com/bareMetals/v2/servers/12345/notificationSettings/bandwidth?limit=20&offset=10' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "bandwidthNotificationSettings": [
    ]
}

Create a bandwidth notification setting

Create a new bandwidth notification setting for this server.

Authorizations:
X-LSW-Auth
path Parameters
serverId
required
string
Example: 12345

The ID of a server

Request Body schema: application/json
frequency
required
string
Enum: "DAILY" "WEEKLY" "MONTHLY"

Frequency for the Bandwidth Notification

threshold
required
string

Threshold Value for the Bandwidth Notification

unit
required
string
Enum: "Gbps" "Mbps"

Unit for the Bandwidth Notification

Responses

Request samples

Content type
application/json
{
  • "frequency": "DAILY",
  • "threshold": "1",
  • "unit": "Gbps"
}

Response samples

Content type
application/json
{
  • "actions": [
    ],
  • "frequency": "WEEKLY",
  • "id": "12345",
  • "lastCheckedAt": "2021-03-16T01:01:41+00:00",
  • "threshold": "1",
  • "thresholdExceededAt": "2021-03-16T01:01:41+00:00",
  • "unit": "Gbps"
}

Delete a bandwidth notification setting

Remove a Bandwidth Notification setting for this server.

Authorizations:
X-LSW-Auth
path Parameters
serverId
required
string
Example: 12345

The ID of a server

notificationSettingId
required
string
Example: 839111

The ID of a notification setting

Responses

Request samples

curl --request DELETE \
  --url https://api.leaseweb.com/bareMetals/v2/servers/12345/notificationSettings/bandwidth/839111 \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

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

Show a bandwidth notification setting

Get a bandwidth notification setting for this server.

Authorizations:
X-LSW-Auth
path Parameters
serverId
required
string
Example: 12345

The ID of a server

notificationSettingId
required
string
Example: 839111

The ID of a notification setting

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/bareMetals/v2/servers/12345/notificationSettings/bandwidth/839111 \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "actions": [
    ],
  • "frequency": "WEEKLY",
  • "id": "12345",
  • "lastCheckedAt": "2021-03-16T01:01:41+00:00",
  • "threshold": "1",
  • "thresholdExceededAt": "2021-03-16T01:01:41+00:00",
  • "unit": "Gbps"
}

Update a bandwidth notification setting

Update an existing bandwidth notification setting for this server.

Authorizations:
X-LSW-Auth
path Parameters
serverId
required
string
Example: 12345

The ID of a server

notificationSettingId
required
string
Example: 839111

The ID of a notification setting

Request Body schema: application/json
frequency
required
string
Enum: "DAILY" "WEEKLY" "MONTHLY"

Frequency for the Bandwidth Notification

threshold
required
string

Threshold Value for the Bandwidth Notification

unit
required
string
Enum: "Gbps" "Mbps"

Unit for the Bandwidth Notification

Responses

Request samples

Content type
application/json
{
  • "frequency": "DAILY",
  • "threshold": "1",
  • "unit": "Gbps"
}

Response samples

Content type
application/json
{
  • "actions": [
    ],
  • "frequency": "WEEKLY",
  • "id": "12345",
  • "lastCheckedAt": "2021-03-16T01:01:41+00:00",
  • "threshold": "1",
  • "thresholdExceededAt": "2021-03-16T01:01:41+00:00",
  • "unit": "Gbps"
}

List data traffic notification settings

List all datatraffic notification settings for this server.

Authorizations:
X-LSW-Auth
path Parameters
serverId
required
string
Example: 12345

The ID of a server

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

curl --request GET \
  --url 'https://api.leaseweb.com/bareMetals/v2/servers/12345/notificationSettings/datatraffic?limit=20&offset=10' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "datatrafficNotificationSettings": [
    ]
}

Create a data traffic notification setting

Create a new data traffic notification setting for this server.

Authorizations:
X-LSW-Auth
path Parameters
serverId
required
string
Example: 12345

The ID of a server

Request Body schema: application/json
frequency
required
string
Enum: "DAILY" "WEEKLY" "MONTHLY"

Frequency for the Data Traffic Notification

threshold
required
string

Threshold Value for the Data Traffic Notification

unit
required
string
Enum: "MB" "GB" "TB"

Unit for the Data Traffic Notification

Responses

Request samples

Content type
application/json
{
  • "frequency": "DAILY",
  • "threshold": "1",
  • "unit": "MB"
}

Response samples

Content type
application/json
{
  • "actions": [
    ],
  • "frequency": "WEEKLY",
  • "id": "12345",
  • "lastCheckedAt": "2021-03-16T01:01:41+00:00",
  • "threshold": "1",
  • "thresholdExceededAt": "2021-03-16T01:01:41+00:00",
  • "unit": "GB"
}

Delete a data traffic notification setting

Delete the given data traffic notification setting for this server.

Authorizations:
X-LSW-Auth
path Parameters
serverId
required
string
Example: 12345

The ID of a server

notificationSettingId
required
string
Example: 839111

The ID of a notification setting

Responses

Request samples

curl --request DELETE \
  --url https://api.leaseweb.com/bareMetals/v2/servers/12345/notificationSettings/datatraffic/839111 \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

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

Show a data traffic notification setting

Get a datatraffic notification setting for this server.

Authorizations:
X-LSW-Auth
path Parameters
serverId
required
string
Example: 12345

The ID of a server

notificationSettingId
required
string
Example: 839111

The ID of a notification setting

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/bareMetals/v2/servers/12345/notificationSettings/datatraffic/839111 \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "actions": [
    ],
  • "frequency": "WEEKLY",
  • "id": "12345",
  • "lastCheckedAt": "2021-03-16T01:01:41+00:00",
  • "threshold": "1",
  • "thresholdExceededAt": "2021-03-16T01:01:41+00:00",
  • "unit": "GB"
}

Update a data traffic notification setting

Update an existing data traffic notification setting for this server.

Authorizations:
X-LSW-Auth
path Parameters
serverId
required
string
Example: 12345

The ID of a server

notificationSettingId
required
string
Example: 839111

The ID of a notification setting

Request Body schema: application/json
frequency
required
string
Enum: "DAILY" "WEEKLY" "MONTHLY"

Frequency for the Data Traffic Notification

threshold
required
string

Threshold Value for the Data Traffic Notification

unit
required
string
Enum: "MB" "GB" "TB"

Unit for the Data Traffic Notification

Responses

Request samples

Content type
application/json
{
  • "frequency": "DAILY",
  • "threshold": "1",
  • "unit": "GB"
}

Response samples

Content type
application/json
{
  • "frequency": "DAILY",
  • "threshold": "1",
  • "unit": "MB"
}

Show hardware information

This information is generated when running a hardware scan for your server. A hardware scan collects hardware information about your system.

Authorizations:
X-LSW-Auth
path Parameters
serverId
required
string
Example: 12345

The ID of a server

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/bareMetals/v2/servers/12345/hardwareInfo \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "id": "2378237",
  • "parserVersion": "3.6",
  • "result": {
    },
  • "scannedAt": "2017-09-27T14:21:01Z",
  • "serverId": "62264"
}

List control panels

An id of a control panel can be supplied when (re)installing a dedicated server (for more information on how to install dedicated servers via the API refer to the API documentation).

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

curl --request GET \
  --url 'https://api.leaseweb.com/bareMetals/v2/controlPanels?limit=20&offset=10' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "controlPanels": [
    ]
}

List Operating Systems

An id of a operating system can be supplied when (re)installing a dedicated server (for more information on how to install dedicated servers via the API refer to the API documentation).

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.

controlPanelId
string

Filter operating systems by control panel id

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/bareMetals/v2/operatingSystems?limit=20&offset=10&controlPanelId=SOME_STRING_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "operatingSystems": [
    ]
}

Show an operating system

This detailed information shows default options when installing the given operating system on a dedicated server.

For some operating systems these defaults can be adjusted when making the POST request to /install. If the configurable parameter is true these defaults can be adjusted by the client.

Authorizations:
X-LSW-Auth
path Parameters
operatingSystemId
required
string
Example: UBUNTU_22_04_64BIT

Operating system ID

query Parameters
controlPanelId
required
string

The Control Panel ID

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/bareMetals/v2/operatingSystems/UBUNTU_22_04_64BIT?controlPanelId=SOME_STRING_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "architecture": "64bit",
  • "configurable": true,
  • "defaults": {
    },
  • "family": "centos",
  • "features": [
    ],
  • "id": "CENTOS_7_64BIT",
  • "name": "CentOS 7 (x86_64)",
  • "supportedBootDevices": [
    ],
  • "supportedFileSystems": [
    ],
  • "type": "linux",
  • "version": "7"
}

List control panels by Operating System

An id of a control panel can be supplied when (re)installing a dedicated server (for more information on how to install dedicated servers via the API refer to the API documentation).

Not all operating systems support all control panels. Some operating systems do not allow for installation of a control panel. To filter the list of control panels which are supported for an operating system use the operatingSystemId query string parameter to filter this list.

Authorizations:
X-LSW-Auth
path Parameters
operatingSystemId
required
string
Example: UBUNTU_22_04_64BIT

Operating system 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.

operatingSystemId
string

Filter control panels by operating system id

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/bareMetals/v2/operatingSystems/UBUNTU_22_04_64BIT/controlPanels?limit=20&offset=10&operatingSystemId=SOME_STRING_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "controlPanels": [
    ]
}

Rescue Images

Lists all Rescue Images which are available for launching a dedicated server into rescue mode.

A rescueImageId can be supplied to the POST /rescueMode API call and will reboot your server into rescue mode.

Launching rescue mode for a server is often used to troubleshoot an existing installation.

Note that launching rescue mode does not modify any data on the disks of your server. It will require your server to be rebooted.

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

curl --request GET \
  --url 'https://api.leaseweb.com/bareMetals/v2/rescueImages?limit=20&offset=10' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "rescueImages": [
    ]
}

Cancel active job

Canceling an active job will trigger the onfail flow of the current job often resulting in a server reboot. If you do not want the server state to change expire the active job instead.

Authorizations:
X-LSW-Auth
path Parameters
serverId
required
string
Example: 12345

The ID of a server

Responses

Request samples

curl --request POST \
  --url https://api.leaseweb.com/bareMetals/v2/servers/12345/cancelActiveJob \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "bareMetalId": "123",
  • "createdAt": "2025-03-17T13:24:25+00:00",
  • "currentTask": {
    },
  • "flow": "finally",
  • "isRunning": true,
  • "metadata": {
    },
  • "node": "00:11:22:AA:BB:CC",
  • "payload": {
    },
  • "progress": {
    },
  • "serverId": "123",
  • "status": "CANCELED",
  • "tasks": [
    ],
  • "type": "install",
  • "updatedAt": "2025-03-17T13:24:34+00:00",
  • "uuid": "a1234567-ab0b-4ff1-af43-c4ca551ee3ff"
}

List server credentials

The credentials API allows you to store usernames and passwords securely.

During (re)installations, rescue modes and ipmi resets the newly generated passwords are stored and can be retrieved using this API.

Authorizations:
X-LSW-Auth
path Parameters
serverId
required
string
Example: 12345

The ID of a server

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

curl --request GET \
  --url 'https://api.leaseweb.com/bareMetals/v2/servers/12345/credentials?limit=20&offset=10' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "credentials": [
    ]
}

Create new server credentials

Password will NOT be updated on the server. The ability to update credentials is for convenience only. It provides a secure way to communicate passwords with Leaseweb engineers in case support is required.

Authorizations:
X-LSW-Auth
path Parameters
serverId
required
string
Example: 12345

The ID of a server

Request Body schema: application/json
password
required
string

The password for the credentials

type
required
string (credentialType2)
Enum: "OPERATING_SYSTEM" "RESCUE_MODE" "REMOTE_MANAGEMENT" "CONTROL_PANEL" "SWITCH" "PDU" "FIREWALL" "LOAD_BALANCER" "VNC" "TEMPORARY_OPERATING_SYSTEM" "VPN_USER" "COMBINATION_LOCK" "DATABASE"

The type of the credential.

username
required
string

The username for the credentials

Responses

Request samples

Content type
application/json
{
  • "password": "mys3cr3tp@ssw0rd",
  • "type": "OPERATING_SYSTEM",
  • "username": "root"
}

Response samples

Content type
application/json
{
  • "password": "mys3cr3tp@ssw0rd",
  • "type": "OPERATING_SYSTEM",
  • "username": "root"
}

List server credentials by type

List all the credentials filtered by the specified type that are associated with this server.

Authorizations:
X-LSW-Auth
path Parameters
serverId
required
string
Example: 12345

The ID of a server

type
required
string
Enum: "OPERATING_SYSTEM" "RESCUE_MODE" "REMOTE_MANAGEMENT" "CONTROL_PANEL" "SWITCH" "PDU" "FIREWALL" "LOAD_BALANCER" "VNC" "TEMPORARY_OPERATING_SYSTEM" "VPN_USER" "COMBINATION_LOCK" "DATABASE"

The type of the credential.

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

curl --request GET \
  --url 'https://api.leaseweb.com/bareMetals/v2/servers/12345/credentials/%7Btype%7D?limit=20&offset=10' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "credentials": [
    ]
}

Delete server credentials

This action is purely administrative and will only remove the username and password associated with this resource from our database.

Authorizations:
X-LSW-Auth
path Parameters
serverId
required
string
Example: 12345

The ID of a server

type
required
string
Enum: "OPERATING_SYSTEM" "RESCUE_MODE" "REMOTE_MANAGEMENT" "CONTROL_PANEL" "SWITCH" "PDU" "FIREWALL" "LOAD_BALANCER" "VNC" "TEMPORARY_OPERATING_SYSTEM" "VPN_USER" "COMBINATION_LOCK" "DATABASE"

The type of the credential.

username
required
string
Example: root

Username

Responses

Request samples

curl --request DELETE \
  --url https://api.leaseweb.com/bareMetals/v2/servers/12345/credentials/%7Btype%7D/root \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

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

Show server credentials

View the password for the given credential, identified by type and username. Auto generated credentials (during a re-install, rescue mode or ipmi reset can be found here).

Authorizations:
X-LSW-Auth
path Parameters
serverId
required
string
Example: 12345

The ID of a server

type
required
string
Enum: "OPERATING_SYSTEM" "RESCUE_MODE" "REMOTE_MANAGEMENT" "CONTROL_PANEL" "SWITCH" "PDU" "FIREWALL" "LOAD_BALANCER" "VNC" "TEMPORARY_OPERATING_SYSTEM" "VPN_USER" "COMBINATION_LOCK" "DATABASE"

The type of the credential.

username
required
string
Example: root

Username

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/bareMetals/v2/servers/12345/credentials/%7Btype%7D/root \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "password": "mys3cr3tp@ssw0rd",
  • "type": "OPERATING_SYSTEM",
  • "username": "root"
}

Update server credentials

The usernames or types cannot be changed. In order to change those remove this credentials and create a new one.

This action is purely administrative and will only update the password associated with this resource in our database.

Authorizations:
X-LSW-Auth
path Parameters
serverId
required
string
Example: 12345

The ID of a server

type
required
string
Enum: "OPERATING_SYSTEM" "RESCUE_MODE" "REMOTE_MANAGEMENT" "CONTROL_PANEL" "SWITCH" "PDU" "FIREWALL" "LOAD_BALANCER" "VNC" "TEMPORARY_OPERATING_SYSTEM" "VPN_USER" "COMBINATION_LOCK" "DATABASE"

The type of the credential.

username
required
string
Example: root

Username

Request Body schema: application/json
password
required
string

The password for the credentials

Responses

Request samples

Content type
application/json
{
  • "password": "mys3cr3tp@ssw0rd"
}

Response samples

Content type
application/json
{
  • "password": "mys3cr3tp@ssw0rd",
  • "type": "OPERATING_SYSTEM",
  • "username": "root"
}

Expire active job

Expiring an active job will not have any influence on the current state of the server and is merely an administrative action.

Often you want to cancel the job, resulting in a server reboot. In that case\nuse the /cancelActiveJob API call instead.

Authorizations:
X-LSW-Auth
path Parameters
serverId
required
string
Example: 12345

The ID of a server

Responses

Request samples

curl --request POST \
  --url https://api.leaseweb.com/bareMetals/v2/servers/12345/expireActiveJob \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "bareMetalId": "123",
  • "createdAt": "2025-03-17T13:33:25+00:00",
  • "currentTask": {
    },
  • "flow": "finally",
  • "isRunning": true,
  • "metadata": {
    },
  • "node": "00:11:22:AA:BB:CC",
  • "payload": {
    },
  • "progress": {
    },
  • "serverId": "123",
  • "status": "EXPIRED",
  • "tasks": [
    ],
  • "type": "install",
  • "updatedAt": "2025-03-17T13:33:37+00:00",
  • "uuid": "a1b28bfd1-da4c-451b-b82e-b382b9063d94"
}

Launch hardware scan

A hardware scan collects hardware related information from your server.

A hardware scan will require a reboot of your server. The contents of your hard drive won't be altered in any way. After a successful hardware scan your server is booted back into the original operating system.

Authorizations:
X-LSW-Auth
path Parameters
serverId
required
string
Example: 12345

The ID of a server

Request Body schema: application/json
callbackUrl
string <uri>

Url which will receive callbacks

powerCycle
boolean
Default: true

If set to true, server will be power cycled in order to complete the operation

Responses

Request samples

Content type
application/json
{
  • "powerCycle": false
}

Response samples

Content type
application/json
{
  • "bareMetalId": "519",
  • "createdAt": "2025-03-17T13:37:19+00:00",
  • "currentTask": {
    },
  • "flow": "main",
  • "isRunning": true,
  • "metadata": {
    },
  • "node": "00:11:22:AA:BB:CC",
  • "payload": {
    },
  • "progress": {
    },
  • "serverId": "519",
  • "status": "ACTIVE",
  • "tasks": [
    ],
  • "type": "hardwareScan",
  • "updatedAt": "2025-03-17T13:37:19+00:00",
  • "uuid": "43758e50-fb34-4c0a-9ab5-772c4e47208c"
}

Launch installation

Install your server with an Operating System and optional Control Panel.

To retrieve a list of available operating systems use the /v2/operatingSystems endpoint.

To retrieve a list of available control panels use the /v2/controlPanels endpoint.

The default device / partitions to be used are operating system depended and can be retrieved via the /v2/operatingSystems/{operatingSystemId} endpoint.

You are now able to target a specific diskset, like SATA1TB, SATA2TB, SSD256GB, etc. To see which disksets are available in your server check the /v2/servers/{serverId} endpoint and look for the corresponding diskset id from the hdd array.

For more information about Dedicated Server installation, click here for our related Knowledge Base article.

Authorizations:
X-LSW-Auth
path Parameters
serverId
required
string
Example: 12345

The ID of a server

Request Body schema: application/json
callbackUrl
string <uri>

Url which will receive callbacks when the installation is finished or failed

controlPanelId
string

Control panel identifier

device
string

Block devices in a disk set in which the partitions will be installed. Supported values are any disk set id, SATA_SAS or NVME

hostname
string

Hostname to be used in your installation

operatingSystemId
required
string

Operating system identifier

Array of objects (partition)

Array of partition objects that should be installed per partition

password
string

Server root password. If not provided, it would be automatically generated

postInstallScript
string

Base64 Encoded string containing a valid bash script to be run right after the installation

powerCycle
boolean

If true, allows system reboots to happen automatically within the process. Otherwise, you should do them manually

object (raid)

Contains RAID related information about the installation request

sshKeys
string

List of public sshKeys to be setup in your installation, separated by new lines

aiFrameworks
Array of strings or null

The AI frameworks that are being installed on the server

timezone
string

Timezone represented as Geographical_Area/City

Responses

Request samples

Content type
application/json
{
  • "aiFrameworks": [
    ],
  • "controlPanelId": "PLESK_12",
  • "device": "SATA2TB",
  • "hostname": "ubuntu22.local",
  • "operatingSystemId": "UBUNTU_22_04_64BIT",
  • "partitions": [
    ],
  • "sshKeys": "ssh-rsa AAAAB3NzaC1y... user@domain.com"
}

Response samples

Content type
application/json
{
  • "bareMetalId": "123",
  • "createdAt": "2025-03-17T13:44:47+00:00",
  • "currentTask": {
    },
  • "flow": "main",
  • "isRunning": true,
  • "metadata": {
    },
  • "node": "00:11:22:AA:BB:CC",
  • "payload": {
    },
  • "progress": {
    },
  • "serverId": "123",
  • "status": "ACTIVE",
  • "tasks": [
    ],
  • "type": "install",
  • "updatedAt": "2025-03-17T13:44:47+00:00",
  • "uuid": "a1b22827-b6aa-47ce-abad-6bc28a70223d"
}

Launch IPMI reset

A reset makes sure that your IPMI interface of your server is compatible with Leaseweb automation.

An IPMI reset will require a reboot of your server. The contents of your hard drive won't be altered in any way. After a successful IPMI reset your server is booted back into the original operating system.",

Authorizations:
X-LSW-Auth
path Parameters
serverId
required
string
Example: 12345

The ID of a server

Request Body schema: application/json
callbackUrl
string <uri>

Url which will receive callbacks

powerCycle
boolean
Default: true

If set to true, server will be power cycled in order to complete the operation

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "bareMetalId": "123",
  • "createdAt": "2025-03-17T13:48:15+00:00",
  • "currentTask": {
    },
  • "flow": "main",
  • "isRunning": true,
  • "metadata": {
    },
  • "node": "00:11:22:AA:BB:CC",
  • "payload": {
    },
  • "progress": {
    },
  • "serverId": "123",
  • "status": "ACTIVE",
  • "tasks": [
    ],
  • "type": "ipmiReset",
  • "updatedAt": "2025-03-17T13:48:15+00:00",
  • "uuid": "101e3a46-e878-4807-bf03-d3d796f42ecf"
}

List jobs

List all jobs for this server.

Authorizations:
X-LSW-Auth
path Parameters
serverId
required
string
Example: 12345

The ID of a server

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.

type
string
Example: type=install

Filter the list of jobs by type.

status
string
Example: status=CANCELED

Filter the list of jobs by status.

isRunning
string
Enum: "true" "false"
Example: isRunning=true

Filter the list for running jobs

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/bareMetals/v2/servers/12345/jobs?limit=20&offset=10&type=install&status=CANCELED&isRunning=true' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "jobs": [
    ]
}

Show a job

Get a single job for this server.

Authorizations:
X-LSW-Auth
path Parameters
serverId
required
string
Example: 12345

The ID of a server

jobId
required
string
Example: 3a867358-5b4b-44ee-88ac-4274603ef641

The ID of a Job

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/bareMetals/v2/servers/12345/jobs/3a867358-5b4b-44ee-88ac-4274603ef641 \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "bareMetalId": "123",
  • "createdAt": "2025-03-17T13:44:47+00:00",
  • "currentTask": {
    },
  • "flow": "main",
  • "isRunning": true,
  • "metadata": {
    },
  • "node": "00:11:22:AA:BB:CC",
  • "payload": {
    },
  • "progress": {
    },
  • "serverId": "123",
  • "status": "ACTIVE",
  • "tasks": [
    ],
  • "type": "install",
  • "updatedAt": "2025-03-17T13:44:51+00:00",
  • "uuid": "42df2827-b6aa-47ce-abad-6bc28a70223d"
}

Retry a job

Retry a job for a specific server.

Authorizations:
X-LSW-Auth
path Parameters
serverId
required
string
Example: 12345

The ID of a server

jobId
required
string
Example: 3a867358-5b4b-44ee-88ac-4274603ef641

The ID of a Job

Responses

Request samples

curl --request POST \
  --url https://api.leaseweb.com/bareMetals/v2/servers/12345/jobs/3a867358-5b4b-44ee-88ac-4274603ef641/retry \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "bareMetalId": "123",
  • "createdAt": "2025-03-17T14:01:43+00:00",
  • "currentTask": {
    },
  • "flow": "main",
  • "isRunning": true,
  • "metadata": {
    },
  • "node": "00:11:22:AA:BB:CC",
  • "payload": {
    },
  • "progress": {
    },
  • "serverId": "123",
  • "status": "ACTIVE",
  • "tasks": [
    ],
  • "type": "install",
  • "updatedAt": "2025-03-17T14:01:43+00:00",
  • "uuid": "80d991c8-1bf5-40b9-8b99-cb65255065a5"
}

Delete a DHCP reservation

Delete a DHCP reservation for this server.

Authorizations:
X-LSW-Auth
path Parameters
serverId
required
string
Example: 12345

The ID of a server

Responses

Request samples

curl --request DELETE \
  --url https://api.leaseweb.com/bareMetals/v2/servers/12345/leases \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

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

List DHCP reservations

Please note that this will only show reservations for the public network interface.

Authorizations:
X-LSW-Auth
path Parameters
serverId
required
string
Example: 12345

The ID of a server

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/bareMetals/v2/servers/12345/leases \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "leases": [
    ]
}

Create a DHCP reservation

After rebooting your server it will acquire this DHCP reservation and boot from the specified bootfile url.

Please note that this API call will not reboot or power cycle your server.

Authorizations:
X-LSW-Auth
path Parameters
serverId
required
string
Example: 12345

The ID of a server

Request Body schema: application/json
bootfile
required
string

The URL of PXE boot you want your server to boot from

hostname
string

The hostname for the server

Responses

Request samples

Content type
application/json
{}

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 cycle a server

Powercyle the server.

Authorizations:
X-LSW-Auth
path Parameters
serverId
required
string
Example: 12345

The ID of a server

Responses

Request samples

curl --request POST \
  --url https://api.leaseweb.com/bareMetals/v2/servers/12345/powerCycle \
  --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."
}

Show power status

The server can either be ON or OFF. Servers can be powered on or off by using the respective /powerOn and /powerOff API calls. In addition servers can also be rebooted using the /powerCycle API call.

The pdu object describes the power status from the power distribution unit (PDU) point of view. If your server is connected to multiple PDU ports the status property will report on if at least one PDU port has power.

The ipmi object describes the power status by quering the remote management interface of your server.

Note that pdu.status can report on but your server can still be powered off if it was shutdown via IPMI for example.

Authorizations:
X-LSW-Auth
path Parameters
serverId
required
string
Example: 12345

The ID of a server

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/bareMetals/v2/servers/12345/powerInfo \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "ipmi": {
    },
  • "pdu": {
    }
}

Power off server

Power off the given server.

Authorizations:
X-LSW-Auth
path Parameters
serverId
required
string
Example: 12345

The ID of a server

Responses

Request samples

curl --request POST \
  --url https://api.leaseweb.com/bareMetals/v2/servers/12345/powerOff \
  --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."
}

Power on server

Power on the given server.

Authorizations:
X-LSW-Auth
path Parameters
serverId
required
string
Example: 12345

The ID of a server

Responses

Request samples

curl --request POST \
  --url https://api.leaseweb.com/bareMetals/v2/servers/12345/powerOn \
  --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."
}

Launch rescue mode

Rescue mode allows you to trouble shoot your server in case your installed operating system is no longer reachable.

You can supply a postInstallScript key in the body of the request which should contain a base64 encoded string with a valid script. This script will be executed as soon as rescue mode is launched and can be used to further automate the process. A requirement for the post install script is that it starts with a shebang line like #!/usr/bin/env bash.

After a rescue mode is launched you can manually reboot the server. After this reboot the server will boot into the existing operating system.

To get a list of available rescue images, you could do so by sending a GET request to /bareMetals/v2/rescueImages.

Authorizations:
X-LSW-Auth
path Parameters
serverId
required
string
Example: 12345

The ID of a server

Request Body schema: application/json
callbackUrl
string <uri>

Url which will receive callbacks

password
string non-empty

Rescue mode password. If not provided, it would be automatically generated

postInstallScript
string

Base64 Encoded string containing a valid bash script to be run right after rescue mode is launched

powerCycle
boolean
Default: true

If set to true, server will be power cycled in order to complete the operation

rescueImageId
required
string
Default: "GRML"

Rescue image identifier

sshKeys
string

User ssh keys

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "bareMetalId": "123",
  • "createdAt": "2025-03-17T14:06:12+00:00",
  • "currentTask": {
    },
  • "flow": "main",
  • "isRunning": true,
  • "metadata": {
    },
  • "node": "00:11:22:33:44:55",
  • "payload": {
    },
  • "progress": {
    },
  • "serverId": "123",
  • "status": "ACTIVE",
  • "tasks": [
    ],
  • "type": "rescueMode",
  • "updatedAt": "2025-03-17T14:06:12+00:00",
  • "uuid": "7f869a99-2c26-4281-bd75-a45786a8c2d2"
}

Dedicated Network Equipments

Leaseweb Dedicated Network Equipments are network devices that are dedicated to a single customer, providing high performance, scalability, and security. They are ideal for businesses that require a dedicated environment for their critical applications.

List network equipment

List your Dedicated Network Equipment. This api call supports pagination. Use the limit and offset query string parameters to paginate through all your dedicated network equipment.

Every network equipment object in the json response lists a few properties of a network equipment. Use the single resource api call to get more details for a single network equipment.

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.

reference
string
Example: reference=my-switch

Filter the list of network equipment by reference.

ip
string <ipv4>
Example: ip=127.0.0.4

Filter the list of network equipment by ip address.

macAddress
string([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})|([0-9...
Example: macAddress=aa:bb:cc:dd:ee:ff

Filter the list of network equipment by mac address.

site
string
Example: site=FRA-10

Filter the list of network equipment by site (location).

privateRackId
string
Example: privateRackId=123

Filter the list of network equipment by dedicated rack id.

privateNetworkCapable
string
Enum: "true" "false"

Filter the list for private network capable network equipment

privateNetworkEnabled
string
Enum: "true" "false"

Filter the list for private network enabled network equipment

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/bareMetals/v2/networkEquipments?limit=20&offset=10&reference=my-switch&ip=127.0.0.4&macAddress=aa%3Abb%3Acc%3Add%3Aee%3Aff&site=FRA-10&privateRackId=123&privateNetworkCapable=SOME_STRING_VALUE&privateNetworkEnabled=SOME_STRING_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "networkEquipments": [
    ]
}

Get network equipment

Use this API to get information about a single network equipment.

Authorizations:
X-LSW-Auth
path Parameters
networkEquipmentId
required
string
Example: 12345

The ID of a dedicated network equipment

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/bareMetals/v2/networkEquipments/12345 \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "contract": {
    },
  • "featureAvailability": {
    },
  • "id": "12345",
  • "location": {
    },
  • "name": "ABC-DE-001",
  • "networkInterfaces": {
    },
  • "powerPorts": [
    ],
  • "rack": {
    },
  • "serialNumber": "XN51FPD0QX",
  • "specs": {
    },
  • "type": "SWITCH"
}

Update network equipment

Update the reference for a network equipment.

Authorizations:
X-LSW-Auth
path Parameters
networkEquipmentId
required
string
Example: 12345

The ID of a dedicated network equipment

Request Body schema: application/json
required
reference
required
string

The reference for this network equipment

Responses

Request samples

Content type
application/json
{
  • "reference": "my-private-switch"
}

Response samples

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

List IPs

List all IP Addresses associated with this network equipment. Optionally filtered.

Authorizations:
X-LSW-Auth
path Parameters
networkEquipmentId
required
string
Example: 12345

The ID of a dedicated network equipment

query Parameters
networkType
string
Enum: "INTERNAL" "PUBLIC" "REMOTE_MANAGEMENT"
Example: networkType=INTERNAL

Filter the collection of ip addresses by network type

version
string

Filter the collection by ip version

nullRouted
string

Filter Ips by Nulled-Status

ips
string

Filter the collection of Ips for the comma separated list of Ips

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

curl --request GET \
  --url 'https://api.leaseweb.com/bareMetals/v2/networkEquipments/12345/ips?networkType=INTERNAL&version=SOME_STRING_VALUE&nullRouted=SOME_STRING_VALUE&ips=SOME_STRING_VALUE&limit=20&offset=10' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "ips": [
    ]
}

Show a network equipment IP

Get a single IP address associated with this network equipment.

Authorizations:
X-LSW-Auth
path Parameters
networkEquipmentId
required
string
Example: 12345

The ID of a dedicated network equipment

ip
required
string
Example: 127.0.0.6

The IP Address

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/bareMetals/v2/networkEquipments/12345/ips/127.0.0.6 \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "ddos": {
    },
  • "floatingIp": false,
  • "gateway": "12.123.123.254",
  • "ip": "12.123.123.1/24",
  • "mainIp": true,
  • "networkType": "PUBLIC",
  • "nullRouted": false,
  • "reverseLookup": "domain.example.com",
  • "version": 4
}

Update an IP

Update the reverse lookup or DDoS detection profile for the ip address.

DDoS detection profiles can only be changed if the IP address is protected using Advanced DDoS protection.

For more information about DDoS detection profiles click here for our KB related article.

Authorizations:
X-LSW-Auth
path Parameters
networkEquipmentId
required
string
Example: 12345

The ID of a dedicated network equipment

ip
required
string
Example: 127.0.0.6

The IP Address

Request Body schema: application/json
detectionProfile
string
Enum: "ADVANCED_DEFAULT" "ADVANCED_LOW_UDP" "ADVANCED_MED_UDP"

The detection profile value

reverseLookup
string

The reverse lookup value

Responses

Request samples

Content type
application/json
{
  • "detectionProfile": "ADVANCED_LOW_UDP",
  • "reverseLookup": "domain.example.com"
}

Response samples

Content type
application/json
{
  • "ddos": {
    },
  • "floatingIp": false,
  • "gateway": "12.123.123.254",
  • "ip": "12.123.123.1/24",
  • "mainIp": true,
  • "networkType": "PUBLIC",
  • "nullRouted": false,
  • "reverseLookup": "domain.example.com",
  • "version": 4
}

Null route an IP

Null the given IP address. It might take a few minutes before the change is propagated across the network.

Authorizations:
X-LSW-Auth
path Parameters
networkEquipmentId
required
string
Example: 12345

The ID of a dedicated network equipment

ip
required
string
Example: 127.0.0.6

The IP Address

Responses

Request samples

curl --request POST \
  --url https://api.leaseweb.com/bareMetals/v2/networkEquipments/12345/ips/127.0.0.6/null \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "ddos": {
    },
  • "floatingIp": false,
  • "gateway": "12.123.123.254",
  • "ip": "12.123.123.1/24",
  • "mainIp": true,
  • "networkType": "PUBLIC",
  • "nullRouted": false,
  • "reverseLookup": "domain.example.com",
  • "version": 4
}

Remove a null route

Remove an existing null route for the given IP address. It might take a few minutes before the change is propagated across the network.

Authorizations:
X-LSW-Auth
path Parameters
networkEquipmentId
required
string
Example: 12345

The ID of a dedicated network equipment

ip
required
string
Example: 127.0.0.6

The IP Address

Responses

Request samples

curl --request POST \
  --url https://api.leaseweb.com/bareMetals/v2/networkEquipments/12345/ips/127.0.0.6/unnull \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "ddos": {
    },
  • "floatingIp": false,
  • "gateway": "12.123.123.254",
  • "ip": "12.123.123.1/24",
  • "mainIp": true,
  • "networkType": "PUBLIC",
  • "nullRouted": false,
  • "reverseLookup": "domain.example.com",
  • "version": 4
}

Show null route history

Show all null route history for any ips associated with this a network equipment.

Authorizations:
X-LSW-Auth
path Parameters
networkEquipmentId
required
string
Example: 12345

The ID of a dedicated network equipment

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

curl --request GET \
  --url 'https://api.leaseweb.com/bareMetals/v2/networkEquipments/12345/nullRouteHistory?limit=20&offset=10' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "nullRoutes": [
    ]
}

List network equipment credentials

The credentials API allows you to store usernames and passwords securely.

Authorizations:
X-LSW-Auth
path Parameters
networkEquipmentId
required
string
Example: 12345

The ID of a dedicated network equipment

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

curl --request GET \
  --url 'https://api.leaseweb.com/bareMetals/v2/networkEquipments/12345/credentials?limit=20&offset=10' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "credentials": [
    ]
}

Create new network equipment credentials

Password will NOT be updated on the network equipment. The ability to update credentials is for convenience only. It provides a secure way to communicate passwords with Leaseweb engineers in case support is required.

Authorizations:
X-LSW-Auth
path Parameters
networkEquipmentId
required
string
Example: 12345

The ID of a dedicated network equipment

Request Body schema: application/json
password
required
string

The password for the credentials

type
required
string (credentialType2)
Enum: "OPERATING_SYSTEM" "RESCUE_MODE" "REMOTE_MANAGEMENT" "CONTROL_PANEL" "SWITCH" "PDU" "FIREWALL" "LOAD_BALANCER" "VNC" "TEMPORARY_OPERATING_SYSTEM" "VPN_USER" "COMBINATION_LOCK" "DATABASE"

The type of the credential.

username
required
string

The username for the credentials

Responses

Request samples

Content type
application/json
{
  • "password": "mys3cr3tp@ssw0rd",
  • "type": "OPERATING_SYSTEM",
  • "username": "root"
}

Response samples

Content type
application/json
{
  • "password": "mys3cr3tp@ssw0rd",
  • "type": "OPERATING_SYSTEM",
  • "username": "root"
}

List network equipment credentials by type

List all the credentials filtered by the specified type that are associated with this network equipment.

Authorizations:
X-LSW-Auth
path Parameters
networkEquipmentId
required
string
Example: 12345

The ID of a dedicated network equipment

type
required
string
Enum: "OPERATING_SYSTEM" "RESCUE_MODE" "REMOTE_MANAGEMENT" "CONTROL_PANEL" "SWITCH" "PDU" "FIREWALL" "LOAD_BALANCER" "VNC" "TEMPORARY_OPERATING_SYSTEM" "VPN_USER" "COMBINATION_LOCK" "DATABASE"

The type of the credential.

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

curl --request GET \
  --url 'https://api.leaseweb.com/bareMetals/v2/networkEquipments/12345/credentials/%7Btype%7D?limit=20&offset=10' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "credentials": [
    ]
}

Delete network equipment credentials

This action is purely administrative and will only remove the username and password associated with this resource from our database.

Authorizations:
X-LSW-Auth
path Parameters
networkEquipmentId
required
string
Example: 12345

The ID of a dedicated network equipment

type
required
string
Enum: "OPERATING_SYSTEM" "RESCUE_MODE" "REMOTE_MANAGEMENT" "CONTROL_PANEL" "SWITCH" "PDU" "FIREWALL" "LOAD_BALANCER" "VNC" "TEMPORARY_OPERATING_SYSTEM" "VPN_USER" "COMBINATION_LOCK" "DATABASE"

The type of the credential.

username
required
string
Example: root

Username

Responses

Request samples

curl --request DELETE \
  --url https://api.leaseweb.com/bareMetals/v2/networkEquipments/12345/credentials/%7Btype%7D/root \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

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

Show network equipment credentials

View the password for the given credential, identified by type and username.

Authorizations:
X-LSW-Auth
path Parameters
networkEquipmentId
required
string
Example: 12345

The ID of a dedicated network equipment

type
required
string
Enum: "OPERATING_SYSTEM" "RESCUE_MODE" "REMOTE_MANAGEMENT" "CONTROL_PANEL" "SWITCH" "PDU" "FIREWALL" "LOAD_BALANCER" "VNC" "TEMPORARY_OPERATING_SYSTEM" "VPN_USER" "COMBINATION_LOCK" "DATABASE"

The type of the credential.

username
required
string
Example: root

Username

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/bareMetals/v2/networkEquipments/12345/credentials/%7Btype%7D/root \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "password": "mys3cr3tp@ssw0rd",
  • "type": "OPERATING_SYSTEM",
  • "username": "root"
}

Update network equipment credentials

The usernames or types cannot be changed. In order to change those remove this credentials and create a new one.

This action is purely administrative and will only update the password associated with this resource in our database.

Authorizations:
X-LSW-Auth
path Parameters
networkEquipmentId
required
string
Example: 12345

The ID of a dedicated network equipment

type
required
string
Enum: "OPERATING_SYSTEM" "RESCUE_MODE" "REMOTE_MANAGEMENT" "CONTROL_PANEL" "SWITCH" "PDU" "FIREWALL" "LOAD_BALANCER" "VNC" "TEMPORARY_OPERATING_SYSTEM" "VPN_USER" "COMBINATION_LOCK" "DATABASE"

The type of the credential.

username
required
string
Example: root

Username

Request Body schema: application/json
password
required
string

The password for the credentials

Responses

Request samples

Content type
application/json
{
  • "password": "mys3cr3tp@ssw0rd"
}

Response samples

Content type
application/json
{
  • "password": "mys3cr3tp@ssw0rd",
  • "type": "OPERATING_SYSTEM",
  • "username": "root"
}

Power cycle a network equipment

Powercyle the network equipment.

Authorizations:
X-LSW-Auth
path Parameters
networkEquipmentId
required
string
Example: 12345

The ID of a dedicated network equipment

Responses

Request samples

curl --request POST \
  --url https://api.leaseweb.com/bareMetals/v2/networkEquipments/12345/powerCycle \
  --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."
}

Show power status

The network equipment can either be ON or OFF. Network Equipment can be powered on or off by using the respective /powerOn and /powerOff API calls. In addition network equipment can also be rebooted using the /powerCycle API call.

The pdu object describes the power status from the power distribution unit (PDU) point of view. If your network equipment is connected to multiple PDU ports the status property will report on if at least one PDU port has power.

Authorizations:
X-LSW-Auth
path Parameters
networkEquipmentId
required
string
Example: 12345

The ID of a dedicated network equipment

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/bareMetals/v2/networkEquipments/12345/powerInfo \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "pdu": {
    }
}

Power off network equipment

Power off the given network equipment.

Authorizations:
X-LSW-Auth
path Parameters
networkEquipmentId
required
string
Example: 12345

The ID of a dedicated network equipment

Responses

Request samples

curl --request POST \
  --url https://api.leaseweb.com/bareMetals/v2/networkEquipments/12345/powerOff \
  --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."
}

Power on network equipment

Power on the given network equipment.

Authorizations:
X-LSW-Auth
path Parameters
networkEquipmentId
required
string
Example: 12345

The ID of a dedicated network equipment

Responses

Request samples

curl --request POST \
  --url https://api.leaseweb.com/bareMetals/v2/networkEquipments/12345/powerOn \
  --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."
}

Dedicated Racks

Leaseweb Dedicated Racks are physical racks that are dedicated to a single customer, providing high performance, scalability, and security. They are ideal for businesses that require a dedicated environment for their critical applications.

List dedicated racks

This API returns a paginated list of all dedicated racks.

Authorizations:
X-LSW-Auth
query Parameters
limit
integer
Default: 10

Limit the number of results returned

offset
integer
Default: 0

Return results starting from the given offset

reference
string
Example: reference=my-db

Filter the list of dedicated racks by reference.

privateNetworkCapable
boolean
Enum: true false

Filter the list of private network capable dedicated racks

privateNetworkEnabled
boolean
Enum: true false

Filter the list of private network enabled dedicated racks

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/bareMetals/v2/privateRacks?limit=SOME_INTEGER_VALUE&offset=SOME_INTEGER_VALUE&reference=my-db&privateNetworkCapable=SOME_BOOLEAN_VALUE&privateNetworkEnabled=SOME_BOOLEAN_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "privateRacks": [
    ]
}

Inspect a dedicated rack

Retrieve information about a single dedicated rack.

Authorizations:
X-LSW-Auth
path Parameters
privateRackId
required
string
Example: 2314213

Id of the dedicated rack

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/bareMetals/v2/privateRacks/2314213 \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "contract": {
    },
  • "featureAvailability": {
    },
  • "id": "2893829",
  • "location": {
    },
  • "networkInterfaces": {
    },
  • "powerPorts": [ ],
  • "units": [
    ]
}

Update a dedicated rack

A reference can be used to uniquely identify a dedicated rack with a name, such as production.

Authorizations:
X-LSW-Auth
path Parameters
privateRackId
required
string
Example: 2314213

Id of the dedicated rack

Request Body schema: application/json
reference
required
string

The reference for this dedicated rack

Responses

Request samples

Content type
application/json
{
  • "reference": "production"
}

Response samples

Content type
application/json
{
  • "correlationId": "945bef2e-1caf-4027-bd0a-8976848f3dee",
  • "errorCode": 400,
  • "errorDetails": { },
  • "errorMessage": "Validation Failed"
}

Inspect null route history

Authorizations:
X-LSW-Auth
path Parameters
privateRackId
required
string
Example: 2314213

Id of the dedicated rack

query Parameters
limit
integer
Default: 10

Limit the number of results returned

offset
integer
Default: 0

Return results starting from the given offset

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/bareMetals/v2/privateRacks/2314213/nullRouteHistory?limit=SOME_INTEGER_VALUE&offset=SOME_INTEGER_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "nullRoutes": [
    ]
}

List IPs

Authorizations:
X-LSW-Auth
path Parameters
privateRackId
required
string
Example: 2314213

Id of the dedicated rack

query Parameters
networkType
string

Filter the collection of ip addresses by network type

version
string

Filter the collection by ip version

nullRouted
string

Filter Ips by Nulled-Status

ips
string

Filter the collection of Ips for the comma separated list of Ips

limit
integer
Default: 10

Limit the number of results returned

offset
integer
Default: 0

Return results starting from the given offset

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/bareMetals/v2/privateRacks/2314213/ips?networkType=SOME_STRING_VALUE&version=SOME_STRING_VALUE&nullRouted=SOME_STRING_VALUE&ips=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE&offset=SOME_INTEGER_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "ips": [
    ]
}

Inspect an IP

Authorizations:
X-LSW-Auth
path Parameters
ip
required
string
Example: 192.168.0.1

IP Address

privateRackId
required
string
Example: 2314213

Id of the dedicated rack

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/bareMetals/v2/privateRacks/2314213/ips/192.168.0.1 \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "ip": "12.123.123.1/24",
  • "gateway": "12.123.123.254",
  • "floatingIp": false,
  • "version": 4,
  • "nullRouted": false,
  • "reverseLookup": "domain.example.com",
  • "mainIp": true,
  • "networkType": "PUBLIC",
  • "ddos": {
    }
}

Update an IP

Update the reverse lookup or DDoS detection profile for the ip address. For more information about DDoS detection profiles click here for our KB related article.

Authorizations:
X-LSW-Auth
path Parameters
ip
required
string
Example: 192.168.0.1

IP Address

privateRackId
required
string
Example: 2314213

Id of the dedicated rack

Request Body schema: application/json
reverseLookup
string

The reverse lookup value

detectionProfile
string
Enum: "ADVANCED_DEFAULT" "ADVANCED_LOW_UDP" "ADVANCED_MED_UDP"

The detection profile value

Responses

Request samples

Content type
application/json
{
  • "reverseLookup": "domain.example.com",
  • "detectionProfile": "ADVANCED_LOW_UDP"
}

Response samples

Content type
application/json
{
  • "ip": "12.123.123.1/24",
  • "gateway": "12.123.123.254",
  • "floatingIp": false,
  • "version": 4,
  • "nullRouted": false,
  • "reverseLookup": "domain.example.com",
  • "mainIp": true,
  • "networkType": "PUBLIC",
  • "ddos": {
    }
}

Null route an IP

It might take a few minutes before the null route is propagated across the network.

Authorizations:
X-LSW-Auth
path Parameters
privateRackId
required
string
Example: 2314213

Id of the dedicated rack

ip
required
string
Example: 192.168.0.1

IP Address

Responses

Request samples

curl --request POST \
  --url https://api.leaseweb.com/bareMetals/v2/privateRacks/2314213/ips/192.168.0.1/null \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "ip": "12.123.123.1/24",
  • "gateway": "12.123.123.254",
  • "floatingIp": false,
  • "version": 4,
  • "nullRouted": false,
  • "reverseLookup": "domain.example.com",
  • "mainIp": true,
  • "networkType": "PUBLIC",
  • "ddos": {
    }
}

Remove a null route

It might take a few minutes before the change is propagated across the network.

Authorizations:
X-LSW-Auth
path Parameters
privateRackId
required
string
Example: 2314213

Id of the dedicated rack

ip
required
string
Example: 192.168.0.1

IP Address

Responses

Request samples

curl --request POST \
  --url https://api.leaseweb.com/bareMetals/v2/privateRacks/2314213/ips/192.168.0.1/unnull \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "ip": "12.123.123.1/24",
  • "gateway": "12.123.123.254",
  • "floatingIp": false,
  • "version": 4,
  • "nullRouted": false,
  • "reverseLookup": "domain.example.com",
  • "mainIp": true,
  • "networkType": "PUBLIC",
  • "ddos": {
    }
}

List credentials

Authorizations:
X-LSW-Auth
path Parameters
privateRackId
required
string
Example: 2314213

Id of the dedicated rack

query Parameters
limit
integer
Default: 10

Limit the number of results returned

offset
integer
Default: 0

Return results starting from the given offset

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/bareMetals/v2/privateRacks/2314213/credentials?limit=SOME_INTEGER_VALUE&offset=SOME_INTEGER_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "credentials": [
    ]
}

Create new credentials

Authorizations:
X-LSW-Auth
path Parameters
privateRackId
required
string
Example: 2314213

Id of the dedicated rack

Request Body schema: application/json
type
required
string
Enum: "OPERATING_SYSTEM" "CONTROL_PANEL" "REMOTE_MANAGEMENT" "RESCUE_MODE" "SWITCH" "PDU" "FIREWALL" "LOAD_BALANCER"

The type of the credential

username
required
string

The username for the credentials

password
required
string

The password for the credentials

Responses

Request samples

Content type
application/json
{
  • "type": "OPERATING_SYSTEM",
  • "username": "root",
  • "password": "my-secret-password"
}

Response samples

Content type
application/json
{
  • "password": "mys3cr3tp@ssw0rd",
  • "type": "OPERATING_SYSTEM",
  • "username": "root"
}

List credentials by type

Authorizations:
X-LSW-Auth
path Parameters
type
required
string
privateRackId
required
string
Example: 2314213

Id of the dedicated rack

query Parameters
limit
integer
Default: 10

Limit the number of results returned

offset
integer
Default: 0

Return results starting from the given offset

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/bareMetals/v2/privateRacks/2314213/credentials/%7Btype%7D?limit=SOME_INTEGER_VALUE&offset=SOME_INTEGER_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "credentials": [
    ]
}

Inspect user credentials

Authorizations:
X-LSW-Auth
path Parameters
privateRackId
required
string
Example: 2314213

Id of the dedicated rack

username
required
string
type
required
string

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/bareMetals/v2/privateRacks/2314213/credentials/%7Btype%7D/%7Busername%7D \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "password": "mys3cr3tp@ssw0rd",
  • "type": "OPERATING_SYSTEM",
  • "username": "root"
}

Update user credentials

This action is purely administrative and will only update the password associated with this resource in our database.

Authorizations:
X-LSW-Auth
path Parameters
privateRackId
required
string
Example: 2314213

Id of the dedicated rack

username
required
string
type
required
string
Request Body schema: application/json
password
required
string

The password for the credentials

Responses

Request samples

Content type
application/json
{
  • "password": "Y5TurbBQtP5OzvduSH6g"
}

Response samples

Content type
application/json
{
  • "password": "mys3cr3tp@ssw0rd",
  • "type": "OPERATING_SYSTEM",
  • "username": "root"
}

Delete user credentials

This action is purely administrative and will only remove the username and password associated with this resource from our database.

Authorizations:
X-LSW-Auth
path Parameters
privateRackId
required
string
Example: 2314213

Id of the dedicated rack

username
required
string
type
required
string

Responses

Request samples

curl --request DELETE \
  --url https://api.leaseweb.com/bareMetals/v2/privateRacks/2314213/credentials/%7Btype%7D/%7Busername%7D \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "errorCode": "ACCESS_DENIED",
  • "errorMessage": "The access token is expired or invalid."
}

Inspect datatraffic metrics

At this moment only bandwidth information for the public interface is supported.

Authorizations:
X-LSW-Auth
path Parameters
privateRackId
required
string
Example: 2314213

Id of the dedicated rack

query Parameters
from
date

Start of date interval in ISO-8601 format

The returned data will include everything up from - and including - the specified date time.

to
date

End of date interval in ISO-8601 format.

The returned data will include everything up until - but not including - the specified date time.

granularity
string
Enum: "DAY" "WEEK" "MONTH" "YEAR"

Specify the preferred interval for each metric. If granularity is omitted from the request, only one metric is returned.

aggregation
string
Value: "SUM"

Aggregate each metric using the given aggregation function.

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/bareMetals/v2/privateRacks/2314213/metrics/datatraffic?from=SOME_DATE_VALUE&to=SOME_DATE_VALUE&granularity=SOME_STRING_VALUE&aggregation=SOME_STRING_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "metrics": {
    }
}

Inspect bandwidth metrics

At this moment only bandwidth information for the public interface is supported.

Authorizations:
X-LSW-Auth
path Parameters
privateRackId
required
string
Example: 2314213

Id of the dedicated rack

query Parameters
from
date

Start of date interval in ISO-8601 format

The returned data will include everything up from - and including - the specified date time.

to
date

End of date interval in ISO-8601 format.

The returned data will include everything up until - but not including - the specified date time.

granularity
string
Enum: "5MIN" "HOUR" "DAY" "WEEK" "MONTH" "YEAR"

Specify the preferred interval for each metric. If granularity is omitted from the request, only one metric is returned.

aggregation
string
Enum: "AVG" "95TH"

Aggregate each metric using the given aggregation function. When the aggregation type 95TH is specified the granularity parameter should be omitted from the request.

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/bareMetals/v2/privateRacks/2314213/metrics/bandwidth?from=SOME_DATE_VALUE&to=SOME_DATE_VALUE&granularity=SOME_STRING_VALUE&aggregation=SOME_STRING_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "metrics": {
    }
}

Inspect DDos notification settings

Authorizations:
X-LSW-Auth
path Parameters
privateRackId
required
string
Example: 2314213

Id of the dedicated rack

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/bareMetals/v2/privateRacks/2314213/notificationSettings/ddos \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "nulling": "ENABLED",
  • "scrubbing": "DISABLED"
}

Update DDos notification settings

To configure DDoS notification for this resource, send a PUT request. On success the response will be a HTTP 204 No Content.

Notifications will be sent to all technical contact email addresses of the customer.

Authorizations:
X-LSW-Auth
path Parameters
privateRackId
required
string
Example: 2314213

Id of the dedicated rack

Request Body schema: application/json
scrubbing
required
string
Enum: "ENABLED" "DISABLED"

Enable or disable email notifications for nulling events

nulling
required
string
Enum: "ENABLED" "DISABLED"

Enable or disable email notifications for nulling events

Responses

Request samples

Content type
application/json
{
  • "scrubbing": "ENABLED",
  • "nulling": "DISABLED"
}

Response samples

Content type
application/json
{
  • "correlationId": "945bef2e-1caf-4027-bd0a-8976848f3dee",
  • "errorCode": 400,
  • "errorDetails": { },
  • "errorMessage": "Validation Failed"
}

List bandwidth notification settings

Authorizations:
X-LSW-Auth
path Parameters
privateRackId
required
string
Example: 2314213

Id of the dedicated rack

query Parameters
limit
integer
Default: 10

Limit the number of results returned

offset
integer
Default: 0

Return results starting from the given offset

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/bareMetals/v2/privateRacks/2314213/notificationSettings/bandwidth?limit=SOME_INTEGER_VALUE&offset=SOME_INTEGER_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "bandwidthNotificationSettings": [
    ]
}

Create new bandwidth notification setting

Authorizations:
X-LSW-Auth
path Parameters
privateRackId
required
string
Example: 2314213

Id of the dedicated rack

Request Body schema: application/json
frequency
required
string
Enum: "DAILY" "WEEKLY" "MONTHLY"

Frequency for the Bandwidth Notification

unit
required
string
Enum: "Gbps" "Mbps"

Unit for the Bandwidth Notification

threshold
required
string

Threshold Value for the Bandwidth Notification

Responses

Request samples

Content type
application/json
{
  • "frequency": "DAILY",
  • "unit": "Gbps",
  • "threshold": "1"
}

Response samples

Content type
application/json
{
  • "actions": [
    ],
  • "frequency": "WEEKLY",
  • "id": "12345",
  • "lastCheckedAt": "2021-03-16T01:01:41+00:00",
  • "threshold": "1",
  • "thresholdExceededAt": "2021-03-16T01:01:41+00:00",
  • "unit": "Gbps"
}

Inspect bandwidth notification settings

Retrieve a single Bandwidth Notification that is associated with the given resource.

A Bandwidth Notification can be updated and deleted.

Authorizations:
X-LSW-Auth
path Parameters
notificationId
required
string
privateRackId
required
string
Example: 2314213

Id of the dedicated rack

query Parameters
limit
integer
Default: 10

Limit the number of results returned

offset
integer
Default: 0

Return results starting from the given offset

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/bareMetals/v2/privateRacks/2314213/notificationSettings/bandwidth/%7BnotificationId%7D?limit=SOME_INTEGER_VALUE&offset=SOME_INTEGER_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "actions": [
    ],
  • "frequency": "WEEKLY",
  • "id": "12345",
  • "lastCheckedAt": "2021-03-16T01:01:41+00:00",
  • "threshold": "1",
  • "thresholdExceededAt": "2021-03-16T01:01:41+00:00",
  • "unit": "Gbps"
}

Update bandwidth notification settings

Authorizations:
X-LSW-Auth
path Parameters
notificationId
required
string
privateRackId
required
string
Example: 2314213

Id of the dedicated rack

Request Body schema: application/json
frequency
required
string
Enum: "DAILY" "WEEKLY" "MONTHLY"

Frequency for the Bandwidth Notification

unit
required
string
Enum: "Gbps" "Mbps"

Unit for the Bandwidth Notification

threshold
required
string

Threshold Value for the Bandwidth Notification

Responses

Request samples

Content type
application/json
{
  • "frequency": "DAILY",
  • "unit": "Gbps",
  • "threshold": "1"
}

Response samples

Content type
application/json
{
  • "actions": [
    ],
  • "frequency": "WEEKLY",
  • "id": "12345",
  • "lastCheckedAt": "2021-03-16T01:01:41+00:00",
  • "threshold": "1",
  • "thresholdExceededAt": "2021-03-16T01:01:41+00:00",
  • "unit": "Gbps"
}

Delete bandwidth notification settings

Authorizations:
X-LSW-Auth
path Parameters
notificationId
required
string
privateRackId
required
string
Example: 2314213

Id of the dedicated rack

Responses

Request samples

curl --request DELETE \
  --url https://api.leaseweb.com/bareMetals/v2/privateRacks/2314213/notificationSettings/bandwidth/%7BnotificationId%7D \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "errorCode": "ACCESS_DENIED",
  • "errorMessage": "The access token is expired or invalid."
}

List datatraffic notification settings

Authorizations:
X-LSW-Auth
path Parameters
privateRackId
required
string
Example: 2314213

Id of the dedicated rack

query Parameters
limit
integer
Default: 10

Limit the number of results returned

offset
integer
Default: 0

Return results starting from the given offset

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/bareMetals/v2/privateRacks/2314213/notificationSettings/datatraffic?limit=SOME_INTEGER_VALUE&offset=SOME_INTEGER_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "datatrafficNotificationSettings": [
    ]
}

Create datatraffic notification settings

Authorizations:
X-LSW-Auth
path Parameters
privateRackId
required
string
Example: 2314213

Id of the dedicated rack

Request Body schema: application/json
frequency
required
string
Enum: "DAILY" "WEEKLY" "MONTHLY"

Frequency for the Datatraffic Notification

unit
required
string
Enum: "MB" "GB" "TB"

Unit for the Datatraffic Notification

threshold
required
string

Threshold Value for the Datatraffic Notification

Responses

Request samples

Content type
application/json
{
  • "frequency": "DAILY",
  • "unit": "MB",
  • "threshold": "1"
}

Response samples

Content type
application/json
{
  • "actions": [
    ],
  • "frequency": "WEEKLY",
  • "id": "12345",
  • "lastCheckedAt": "2021-03-16T01:01:41+00:00",
  • "threshold": "1",
  • "thresholdExceededAt": "2021-03-16T01:01:41+00:00",
  • "unit": "GB"
}

Inspect datatraffic notification settings

Authorizations:
X-LSW-Auth
path Parameters
notificationId
required
string
privateRackId
required
string
Example: 2314213

Id of the dedicated rack

query Parameters
limit
integer
Default: 10

Limit the number of results returned

offset
integer
Default: 0

Return results starting from the given offset

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/bareMetals/v2/privateRacks/2314213/notificationSettings/datatraffic/%7BnotificationId%7D?limit=SOME_INTEGER_VALUE&offset=SOME_INTEGER_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "actions": [
    ],
  • "frequency": "WEEKLY",
  • "id": "12345",
  • "lastCheckedAt": "2021-03-16T01:01:41+00:00",
  • "threshold": "1",
  • "thresholdExceededAt": "2021-03-16T01:01:41+00:00",
  • "unit": "GB"
}

Update datatraffic notification settings

Authorizations:
X-LSW-Auth
path Parameters
notificationId
required
string
privateRackId
required
string
Example: 2314213

Id of the dedicated rack

Request Body schema: application/json
frequency
required
string
Enum: "DAILY" "WEEKLY" "MONTHLY"

Frequency for the Datatraffic Notification

unit
required
string
Enum: "MB" "GB" "TB"

Unit for the Datatraffic Notification

threshold
required
string

Threshold Value for the Datatraffic Notification

Responses

Request samples

Content type
application/json
{
  • "frequency": "DAILY",
  • "unit": "GB",
  • "threshold": "1"
}

Response samples

Content type
application/json
{
  • "actions": [
    ],
  • "frequency": "WEEKLY",
  • "id": "12345",
  • "lastCheckedAt": "2021-03-16T01:01:41+00:00",
  • "threshold": "1",
  • "thresholdExceededAt": "2021-03-16T01:01:41+00:00",
  • "unit": "GB"
}

Delete datatraffic notification settings

Authorizations:
X-LSW-Auth
path Parameters
notificationId
required
string
privateRackId
required
string
Example: 2314213

Id of the dedicated rack

Responses

Request samples

curl --request DELETE \
  --url https://api.leaseweb.com/bareMetals/v2/privateRacks/2314213/notificationSettings/datatraffic/%7BnotificationId%7D \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "errorCode": "ACCESS_DENIED",
  • "errorMessage": "The access token is expired or invalid."
}

Colocations

Leaseweb colocation provides you with a dependable hosting environment for your essential, mission-critical servers, storage, and Internet infrastructure. Colocation allows you to locate servers, network equipment, and storage in Leaseweb’s state-of-the-art data centers. You can connect your privately-owned servers to a variety of telecommunications and network service providers easily, and at reduced operational expenses.

List colocations

Authorizations:
X-LSW-Auth
query Parameters
limit
integer
Default: 10

Limit the number of results returned

offset
integer
Default: 0

Return results starting from the given offset

reference
string
Example: reference=my-db

Filter the list of colocations by reference.

privateNetworkCapable
boolean
Enum: true false

Filter the list of private network capable colocations

privateNetworkEnabled
boolean
Enum: true false

Filter the list of private network enabled colocations

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/bareMetals/v2/colocations?limit=SOME_INTEGER_VALUE&offset=SOME_INTEGER_VALUE&reference=my-db&privateNetworkCapable=SOME_BOOLEAN_VALUE&privateNetworkEnabled=SOME_BOOLEAN_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "colocations": [
    ]
}

Inspect a colocation

Authorizations:
X-LSW-Auth
path Parameters
colocationId
required
string
Example: 12312

Colocation Id

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/bareMetals/v2/colocations/12312 \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "contract": {
    },
  • "featureAvailability": {
    },
  • "id": "654321",
  • "location": {
    },
  • "networkInterfaces": {
    },
  • "powerPorts": [ ],
  • "units": [
    ]
}

Update a colocation

A reference can be set to uniquely identify a colocation with a name, such as production.

Authorizations:
X-LSW-Auth
path Parameters
colocationId
required
string
Example: 12312

Colocation Id

Request Body schema: application/json
reference
required
string

The reference for this colocation

Responses

Request samples

Content type
application/json
{
  • "reference": "production"
}

Response samples

Content type
application/json
{
  • "correlationId": "945bef2e-1caf-4027-bd0a-8976848f3dee",
  • "errorCode": 400,
  • "errorDetails": { },
  • "errorMessage": "Validation Failed"
}

Inspect null route history

Authorizations:
X-LSW-Auth
path Parameters
colocationId
required
string
Example: 12312

Colocation Id

query Parameters
limit
integer
Default: 10

Limit the number of results returned

offset
integer
Default: 0

Return results starting from the given offset

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/bareMetals/v2/colocations/12312/nullRouteHistory?limit=SOME_INTEGER_VALUE&offset=SOME_INTEGER_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "nullRoutes": [
    ]
}

List IPs

Authorizations:
X-LSW-Auth
path Parameters
colocationId
required
string
Example: 12312

Colocation Id

query Parameters
networkType
string

Filter the collection of ip addresses by network type

version
string

Filter the collection by ip version

nullRouted
string

Filter Ips by Nulled-Status

ips
string

Filter the collection of Ips for the comma separated list of Ips

limit
integer
Default: 10

Limit the number of results returned

offset
integer
Default: 0

Return results starting from the given offset

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/bareMetals/v2/colocations/12312/ips?networkType=SOME_STRING_VALUE&version=SOME_STRING_VALUE&nullRouted=SOME_STRING_VALUE&ips=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE&offset=SOME_INTEGER_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "ips": [
    ]
}

Inspect an IP

Authorizations:
X-LSW-Auth
path Parameters
ip
required
string
Example: 192.168.0.1

IP Address

colocationId
required
string
Example: 12312

Colocation Id

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/bareMetals/v2/colocations/12312/ips/192.168.0.1 \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "ip": "12.123.123.1/24",
  • "gateway": "12.123.123.254",
  • "floatingIp": false,
  • "version": 4,
  • "nullRouted": false,
  • "reverseLookup": "domain.example.com",
  • "mainIp": true,
  • "networkType": "PUBLIC",
  • "ddos": {
    }
}

Update an IP

Update the reverse lookup or DDoS detection profile for the ip address. For more information about DDoS detection profiles click here for our KB related article.

Authorizations:
X-LSW-Auth
path Parameters
ip
required
string
Example: 192.168.0.1

IP Address

colocationId
required
string
Example: 12312

Colocation Id

Request Body schema: application/json
reverseLookup
string

The reverse lookup value

detectionProfile
string
Enum: "ADVANCED_DEFAULT" "ADVANCED_LOW_UDP" "ADVANCED_MED_UDP"

The detection profile value

Responses

Request samples

Content type
application/json
{
  • "reverseLookup": "domain.example.com",
  • "detectionProfile": "ADVANCED_LOW_UDP"
}

Response samples

Content type
application/json
{
  • "ip": "12.123.123.1/24",
  • "gateway": "12.123.123.254",
  • "floatingIp": false,
  • "version": 4,
  • "nullRouted": false,
  • "reverseLookup": "domain.example.com",
  • "mainIp": true,
  • "networkType": "PUBLIC",
  • "ddos": {
    }
}

Null route an IP

It might take a few minutes before the null route is propagated across the network.

Authorizations:
X-LSW-Auth
path Parameters
colocationId
required
string
Example: 12312

Colocation Id

ip
required
string
Example: 192.168.0.1

IP Address

Responses

Request samples

curl --request POST \
  --url https://api.leaseweb.com/bareMetals/v2/colocations/12312/ips/192.168.0.1/null \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "ip": "12.123.123.1/24",
  • "gateway": "12.123.123.254",
  • "floatingIp": false,
  • "version": 4,
  • "nullRouted": false,
  • "reverseLookup": "domain.example.com",
  • "mainIp": true,
  • "networkType": "PUBLIC",
  • "ddos": {
    }
}

Remove a null route

It might take a few minutes before the removal is propagated across the network.

Authorizations:
X-LSW-Auth
path Parameters
ip
required
string
Example: 192.168.0.1

IP Address

colocationId
required
string
Example: 12312

Colocation Id

Responses

Request samples

curl --request POST \
  --url https://api.leaseweb.com/bareMetals/v2/colocations/12312/ips/192.168.0.1/unnull \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "ip": "12.123.123.1/24",
  • "gateway": "12.123.123.254",
  • "floatingIp": false,
  • "version": 4,
  • "nullRouted": false,
  • "reverseLookup": "domain.example.com",
  • "mainIp": true,
  • "networkType": "PUBLIC",
  • "ddos": {
    }
}

List credentials

Authorizations:
X-LSW-Auth
path Parameters
colocationId
required
string
Example: 12312

Colocation Id

query Parameters
limit
integer
Default: 10

Limit the number of results returned

offset
integer
Default: 0

Return results starting from the given offset

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/bareMetals/v2/colocations/12312/credentials?limit=SOME_INTEGER_VALUE&offset=SOME_INTEGER_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "credentials": [
    ]
}

Create new credentials

Authorizations:
X-LSW-Auth
path Parameters
colocationId
required
string
Example: 12312

Colocation Id

Request Body schema: application/json
type
required
string
Enum: "OPERATING_SYSTEM" "CONTROL_PANEL" "REMOTE_MANAGEMENT" "RESCUE_MODE" "SWITCH" "PDU" "FIREWALL" "LOAD_BALANCER"

The type of the credential

username
required
string

The username for the credentials

password
required
string

The password for the credentials

Responses

Request samples

Content type
application/json
{
  • "type": "OPERATING_SYSTEM",
  • "username": "root",
  • "password": "my-secret-password"
}

Response samples

Content type
application/json
{
  • "password": "mys3cr3tp@ssw0rd",
  • "type": "OPERATING_SYSTEM",
  • "username": "root"
}

List credentials by type

Authorizations:
X-LSW-Auth
path Parameters
type
required
string
Example: OPERATING_SYSTEM
colocationId
required
string
Example: 12312

Colocation Id

query Parameters
limit
integer
Default: 10

Limit the number of results returned

offset
integer
Default: 0

Return results starting from the given offset

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/bareMetals/v2/colocations/12312/credentials/OPERATING_SYSTEM?limit=SOME_INTEGER_VALUE&offset=SOME_INTEGER_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "credentials": [
    ]
}

Inspect user credentials

Authorizations:
X-LSW-Auth
path Parameters
type
required
string
username
required
string
colocationId
required
string
Example: 12312

Colocation Id

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/bareMetals/v2/colocations/12312/credentials/%7Btype%7D/%7Busername%7D \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "password": "mys3cr3tp@ssw0rd",
  • "type": "OPERATING_SYSTEM",
  • "username": "root"
}

Update user credentials

The usernames or types cannot be changed. In order to change those remove this credentials and create a new one.

This action is purely administrative and will only update the password associated with this resource in our database.

Authorizations:
X-LSW-Auth
path Parameters
type
required
string
username
required
string
colocationId
required
string
Example: 12312

Colocation Id

Request Body schema: application/json
password
required
string

The password for the credentials

Responses

Request samples

Content type
application/json
{
  • "password": "Y5TurbBQtP5OzvduSH6g"
}

Response samples

Content type
application/json
{
  • "password": "mys3cr3tp@ssw0rd",
  • "type": "OPERATING_SYSTEM",
  • "username": "root"
}

Delete user credentials

This action is purely administrative and will only remove the username and password associated with this resource from our database.

Authorizations:
X-LSW-Auth
path Parameters
type
required
string
username
required
string
colocationId
required
string
Example: 12312

Colocation Id

Responses

Request samples

curl --request DELETE \
  --url https://api.leaseweb.com/bareMetals/v2/colocations/12312/credentials/%7Btype%7D/%7Busername%7D \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "errorCode": "ACCESS_DENIED",
  • "errorMessage": "The access token is expired or invalid."
}

Inspect datatraffic metrics

At this moment only bandwidth information for the public interface is supported.

Authorizations:
X-LSW-Auth
path Parameters
colocationId
required
string
Example: 12312

Colocation Id

query Parameters
from
date

Start of date interval in ISO-8601 format

The returned data will include everything up from - and including - the specified date time.

to
date

End of date interval in ISO-8601 format.

The returned data will include everything up until - but not including - the specified date time.

granularity
string
Enum: "DAY" "WEEK" "MONTH" "YEAR"

Specify the preferred interval for each metric. If granularity is omitted from the request, only one metric is returned.

aggregation
string
Value: "SUM"

Aggregate each metric using the given aggregation function.

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/bareMetals/v2/colocations/12312/metrics/datatraffic?from=SOME_DATE_VALUE&to=SOME_DATE_VALUE&granularity=SOME_STRING_VALUE&aggregation=SOME_STRING_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "metrics": {
    }
}

Inspect bandwidth metrics

At this moment only bandwidth information for the public interface is supported.

Authorizations:
X-LSW-Auth
path Parameters
colocationId
required
string
Example: 12312

Colocation Id

query Parameters
from
date

Start of date interval in ISO-8601 format

The returned data will include everything up from - and including - the specified date time.

to
date

End of date interval in ISO-8601 format.

The returned data will include everything up until - but not including - the specified date time.

granularity
string
Enum: "5MIN" "HOUR" "DAY" "WEEK" "MONTH" "YEAR"

Specify the preferred interval for each metric. If granularity is omitted from the request, only one metric is returned.

aggregation
string
Enum: "AVG" "95TH"

Aggregate each metric using the given aggregation function. When the aggregation type 95TH is specified the granularity parameter should be omitted from the request.

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/bareMetals/v2/colocations/12312/metrics/bandwidth?from=SOME_DATE_VALUE&to=SOME_DATE_VALUE&granularity=SOME_STRING_VALUE&aggregation=SOME_STRING_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "metrics": {
    }
}

Inspect public network interface

Authorizations:
X-LSW-Auth
path Parameters
colocationId
required
string
Example: 12312

Colocation Id

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/bareMetals/v2/colocations/12312/networkInterfaces/public \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "linkSpeed": "100Mbps",
  • "status": "OPEN",
  • "switchInterface": "33",
  • "switchName": "EVO-JV12-1",
  • "type": "PUBLIC"
}

Open or close public network interface

Authorizations:
X-LSW-Auth
path Parameters
action
required
string
colocationId
required
string
Example: 12312

Colocation Id

Responses

Request samples

curl --request POST \
  --url https://api.leaseweb.com/bareMetals/v2/colocations/12312/networkInterfaces/public/%7Baction%7D \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "errorCode": "ACCESS_DENIED",
  • "errorMessage": "The access token is expired or invalid."
}

Inspect DDoS notification settings

Authorizations:
X-LSW-Auth
path Parameters
colocationId
required
string
Example: 12312

Colocation Id

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/bareMetals/v2/colocations/12312/notificationSettings/ddos \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "nulling": "ENABLED",
  • "scrubbing": "DISABLED"
}

Update DDoS notifications settings

Authorizations:
X-LSW-Auth
path Parameters
colocationId
required
string
Example: 12312

Colocation Id

Request Body schema: application/json
scrubbing
required
string
Enum: "ENABLED" "DISABLED"

Enable or disable email notifications for nulling events

nulling
required
string
Enum: "ENABLED" "DISABLED"

Enable or disable email notifications for nulling events

Responses

Request samples

Content type
application/json
{
  • "scrubbing": "ENABLED",
  • "nulling": "DISABLED"
}

Response samples

Content type
application/json
{
  • "correlationId": "945bef2e-1caf-4027-bd0a-8976848f3dee",
  • "errorCode": 400,
  • "errorDetails": { },
  • "errorMessage": "Validation Failed"
}

List bandwidth notification settings

Authorizations:
X-LSW-Auth
path Parameters
colocationId
required
string
Example: 12312

Colocation Id

query Parameters
limit
integer
Default: 10

Limit the number of results returned

offset
integer
Default: 0

Return results starting from the given offset

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/bareMetals/v2/colocations/12312/notificationSettings/bandwidth?limit=SOME_INTEGER_VALUE&offset=SOME_INTEGER_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "bandwidthNotificationSettings": [
    ]
}

Create new bandwidth notification settings

Authorizations:
X-LSW-Auth
path Parameters
colocationId
required
string
Example: 12312

Colocation Id

Request Body schema: application/json
frequency
required
string
Enum: "DAILY" "WEEKLY" "MONTHLY"

Frequency for the Bandwidth Notification

unit
required
string
Enum: "Gbps" "Mbps"

Unit for the Bandwidth Notification

threshold
required
string

Threshold Value for the Bandwidth Notification

Responses

Request samples

Content type
application/json
{
  • "frequency": "DAILY",
  • "unit": "Gbps",
  • "threshold": "1"
}

Response samples

Content type
application/json
{
  • "actions": [
    ],
  • "frequency": "WEEKLY",
  • "id": "12345",
  • "lastCheckedAt": "2021-03-16T01:01:41+00:00",
  • "threshold": "1",
  • "thresholdExceededAt": "2021-03-16T01:01:41+00:00",
  • "unit": "Gbps"
}

Inspect bandwidth notification settings

Authorizations:
X-LSW-Auth
path Parameters
notificationId
required
string
colocationId
required
string
Example: 12312

Colocation Id

query Parameters
limit
integer
Default: 10

Limit the number of results returned

offset
integer
Default: 0

Return results starting from the given offset

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/bareMetals/v2/colocations/12312/notificationSettings/bandwidth/%7BnotificationId%7D?limit=SOME_INTEGER_VALUE&offset=SOME_INTEGER_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "actions": [
    ],
  • "frequency": "WEEKLY",
  • "id": "12345",
  • "lastCheckedAt": "2021-03-16T01:01:41+00:00",
  • "threshold": "1",
  • "thresholdExceededAt": "2021-03-16T01:01:41+00:00",
  • "unit": "Gbps"
}

Update bandwidth notification settings

Authorizations:
X-LSW-Auth
path Parameters
notificationId
required
string
colocationId
required
string
Example: 12312

Colocation Id

Request Body schema: application/json
frequency
required
string
Enum: "DAILY" "WEEKLY" "MONTHLY"

Frequency for the Bandwidth Notification

unit
required
string
Enum: "Gbps" "Mbps"

Unit for the Bandwidth Notification

threshold
required
string

Threshold Value for the Bandwidth Notification

Responses

Request samples

Content type
application/json
{
  • "frequency": "DAILY",
  • "unit": "Gbps",
  • "threshold": "1"
}

Response samples

Content type
application/json
{
  • "actions": [
    ],
  • "frequency": "WEEKLY",
  • "id": "12345",
  • "lastCheckedAt": "2021-03-16T01:01:41+00:00",
  • "threshold": "1",
  • "thresholdExceededAt": "2021-03-16T01:01:41+00:00",
  • "unit": "Gbps"
}

Delete bandwidth notification settings

Authorizations:
X-LSW-Auth
path Parameters
notificationId
required
string
colocationId
required
string
Example: 12312

Colocation Id

Responses

Request samples

curl --request DELETE \
  --url https://api.leaseweb.com/bareMetals/v2/colocations/12312/notificationSettings/bandwidth/%7BnotificationId%7D \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "errorCode": "ACCESS_DENIED",
  • "errorMessage": "The access token is expired or invalid."
}

List datatraffic notification settings

Authorizations:
X-LSW-Auth
path Parameters
colocationId
required
string
Example: 12312

Colocation Id

query Parameters
limit
integer
Default: 10

Limit the number of results returned

offset
integer
Default: 0

Return results starting from the given offset

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/bareMetals/v2/colocations/12312/notificationSettings/datatraffic?limit=SOME_INTEGER_VALUE&offset=SOME_INTEGER_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "datatrafficNotificationSettings": [
    ]
}

Create new datatraffic notification settings

Authorizations:
X-LSW-Auth
path Parameters
colocationId
required
string
Example: 12312

Colocation Id

Request Body schema: application/json
frequency
required
string
Enum: "DAILY" "WEEKLY" "MONTHLY"

Frequency for the Datatraffic Notification

unit
required
string
Enum: "MB" "GB" "TB"

Unit for the Datatraffic Notification

threshold
required
string

Threshold Value for the Datatraffic Notification

Responses

Request samples

Content type
application/json
{
  • "frequency": "DAILY",
  • "unit": "MB",
  • "threshold": "1"
}

Response samples

Content type
application/json
{
  • "actions": [
    ],
  • "frequency": "WEEKLY",
  • "id": "12345",
  • "lastCheckedAt": "2021-03-16T01:01:41+00:00",
  • "threshold": "1",
  • "thresholdExceededAt": "2021-03-16T01:01:41+00:00",
  • "unit": "GB"
}

Inspect datatraffic notification settings

Authorizations:
X-LSW-Auth
path Parameters
notificationId
required
string
colocationId
required
string
Example: 12312

Colocation Id

query Parameters
limit
integer
Default: 10

Limit the number of results returned

offset
integer
Default: 0

Return results starting from the given offset

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/bareMetals/v2/colocations/12312/notificationSettings/datatraffic/%7BnotificationId%7D?limit=SOME_INTEGER_VALUE&offset=SOME_INTEGER_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "actions": [
    ],
  • "frequency": "WEEKLY",
  • "id": "12345",
  • "lastCheckedAt": "2021-03-16T01:01:41+00:00",
  • "threshold": "1",
  • "thresholdExceededAt": "2021-03-16T01:01:41+00:00",
  • "unit": "GB"
}

Update datatraffic notification settings

Authorizations:
X-LSW-Auth
path Parameters
notificationId
required
string
colocationId
required
string
Example: 12312

Colocation Id

Request Body schema: application/json
frequency
required
string
Enum: "DAILY" "WEEKLY" "MONTHLY"

Frequency for the Datatraffic Notification

unit
required
string
Enum: "MB" "GB" "TB"

Unit for the Datatraffic Notification

threshold
required
string

Threshold Value for the Datatraffic Notification

Responses

Request samples

Content type
application/json
{
  • "frequency": "DAILY",
  • "unit": "GB",
  • "threshold": "1"
}

Response samples

Content type
application/json
{
  • "actions": [
    ],
  • "frequency": "WEEKLY",
  • "id": "12345",
  • "lastCheckedAt": "2021-03-16T01:01:41+00:00",
  • "threshold": "1",
  • "thresholdExceededAt": "2021-03-16T01:01:41+00:00",
  • "unit": "GB"
}

Delete datatraffic notification settings

Authorizations:
X-LSW-Auth
path Parameters
notificationId
required
string
colocationId
required
string
Example: 12312

Colocation Id

Responses

Request samples

curl --request DELETE \
  --url https://api.leaseweb.com/bareMetals/v2/colocations/12312/notificationSettings/datatraffic/%7BnotificationId%7D \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "errorCode": "ACCESS_DENIED",
  • "errorMessage": "The access token is expired or invalid."
}

Datacenter Access

The Leaseweb Access Management APIs allow co-location customers to manage access cards and request on-site data center access, ensuring secure and flexible control over physical entry.

Get a list of access cards

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.

email
string

Filter access cards by email address

sort
string

Sort field and order. Sort order is specified by prefixing the field name with a '+' (for ascending) or '-' (for descending). Ascending order is default. Multiple sort fields should be separated with comma. Sortable fields: createdAt

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/datacenterAccess/v1/accessCards?limit=20&offset=10&email=SOME_STRING_VALUE&sort=SOME_STRING_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "accessCards": [
    ]
}

Create an access card

Authorizations:
X-LSW-Auth
Request Body schema: application/json
email
required
string[^\s@]+@[^\s@]+\.[^\s@]

Customer Email

hasUser
required
boolean

Whether or not this user should be allowed to log in to Customer Portal.

firstName
required
string

First Name

lastName
required
string

Last Name

phoneNumber
string

Phone Number

multipleAccess
required
boolean

Whether or not this user can bring visitors

allowedItems
Array of strings

Allowed equipments

allItemsAllowed
required
boolean

Are all equipments allowed. If true then allowedItems must be empty.

hasPermanentBadge
boolean

If true then a permanent badge will be requested for this user

Responses

Request samples

Content type
application/json
{
  • "allItemsAllowed": false,
  • "allowedItems": [
    ],
  • "email": "customer@mail.com",
  • "firstName": "John",
  • "hasPermanentBadge": false,
  • "hasUser": true,
  • "lastName": "Doe",
  • "multipleAccess": true,
  • "phoneNumber": "+441134960000"
}

Response samples

Content type
application/json
{
  • "id": "43f0747e-32ce-4f19-b35e-b8cc1420c921",
  • "hasUser": true,
  • "customerId": "123456789",
  • "salesOrgId": "2000",
  • "firstName": "John",
  • "lastName": "Smith",
  • "phoneNumber": "+441134960000",
  • "email": "john.smith@example.com",
  • "multipleAccess": false,
  • "approved": true,
  • "enabled": false,
  • "allowedItems": [
    ],
  • "allItemsAllowed": false,
  • "hasPermanentBadge": false,
  • "isAccessCardHolder": true,
  • "createdBy": "john.doe@example.com",
  • "createdAt": "2015-01-19T12:32:05Z",
  • "updatedBy": "john.doe@example.com",
  • "updatedAt": "2015-01-19T12:32:05Z",
  • "badgeStatus": "PENDING",
  • "accessBadgeNumber": null
}

Get an access card by User Id

Authorizations:
X-LSW-Auth
path Parameters
id
required
string

User Id

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/datacenterAccess/v1/accessCards/%7Bid%7D \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "id": "43f0747e-32ce-4f19-b35e-b8cc1420c921",
  • "hasUser": true,
  • "customerId": "123456789",
  • "salesOrgId": "2000",
  • "firstName": "John",
  • "lastName": "Smith",
  • "phoneNumber": "+441134960000",
  • "email": "john.smith@example.com",
  • "multipleAccess": false,
  • "approved": true,
  • "enabled": false,
  • "allowedItems": [
    ],
  • "allItemsAllowed": false,
  • "hasPermanentBadge": false,
  • "isAccessCardHolder": true,
  • "createdBy": "john.doe@example.com",
  • "createdAt": "2015-01-19T12:32:05Z",
  • "updatedBy": "john.doe@example.com",
  • "updatedAt": "2015-01-19T12:32:05Z",
  • "badgeStatus": "PENDING",
  • "accessBadgeNumber": null
}

Update an access card

Authorizations:
X-LSW-Auth
path Parameters
id
required
string

User Id

Request Body schema: application/json
firstName
string

First Name

lastName
string

Last Name

phoneNumber
string

Phone Number

multipleAccess
boolean

Is multiple access allowed

allowedItems
Array of strings

Allowed equipments

allItemsAllowed
boolean

Are all equipments allowed

enabled
boolean

Is access card enabled

hasPermanentBadge
boolean

If true then, unless they already have one, a permanent badge will be requested for this user. If false then the permanent badge, if any, will be deactivated.

hasUser
boolean

Whether or not this person has a Customer Portal login

Responses

Request samples

Content type
application/json
{
  • "allItemsAllowed": true,
  • "allowedItems": [ ],
  • "enabled": false,
  • "firstName": "John",
  • "hasPermanentBadge": false,
  • "hasUser": true,
  • "lastName": "Doe",
  • "multipleAccess": true,
  • "phoneNumber": "+441134960000"
}

Response samples

Content type
application/json
{
  • "id": "43f0747e-32ce-4f19-b35e-b8cc1420c921",
  • "hasUser": true,
  • "customerId": "123456789",
  • "salesOrgId": "2000",
  • "firstName": "John",
  • "lastName": "Smith",
  • "phoneNumber": "+441134960000",
  • "email": "john.smith@example.com",
  • "multipleAccess": false,
  • "approved": true,
  • "enabled": false,
  • "allowedItems": [
    ],
  • "allItemsAllowed": false,
  • "hasPermanentBadge": false,
  • "isAccessCardHolder": true,
  • "createdBy": "john.doe@example.com",
  • "createdAt": "2015-01-19T12:32:05Z",
  • "updatedBy": "john.doe@example.com",
  • "updatedAt": "2015-01-19T12:32:05Z",
  • "badgeStatus": "PENDING",
  • "accessBadgeNumber": null
}

Delete an access card

Authorizations:
X-LSW-Auth
path Parameters
id
required
string

User Id

Responses

Request samples

curl --request DELETE \
  --url https://api.leaseweb.com/datacenterAccess/v1/accessCards/%7Bid%7D \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

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

Get a list of access requests

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.

fromDate
string

Show requests with visit date from this date. Time should be given in UTC.

toDate
string

Show requests with visit date ending on this date. Time should be given in UTC.

site
string

Show requests for this datacenter

email
string

Filter access requests by email

createdBy
string

Filter by createdBy

q
string

Search for access request by site (e.g. "AMS-01") or email or createdBy (e.g. "test@example.com") or first name (e.g. "John") or last name

sort
string

Sort field and order. Sort order is specified by prefixing the field name with a '+' (for ascending) or '-' (for descending). Ascending order is default. Multiple sort fields should be separated with comma. Sortable fields: id, firstName, lastName, createdByUser, requestDate, email, phoneNumber, visitDateStart, visitDateEnd, requestCode, site

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/datacenterAccess/v1/visitRequests?limit=20&offset=10&fromDate=SOME_STRING_VALUE&toDate=SOME_STRING_VALUE&site=SOME_STRING_VALUE&email=SOME_STRING_VALUE&createdBy=SOME_STRING_VALUE&q=SOME_STRING_VALUE&sort=SOME_STRING_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "requests": [
    ]
}

Create access request

Authorizations:
X-LSW-Auth
Request Body schema: application/json
required
object (request)

Object describing the request

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "requests": [
    ]
}

Get access request by ID

Authorizations:
X-LSW-Auth
path Parameters
id
required
string

Request Id

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/datacenterAccess/v1/visitRequests/%7Bid%7D \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "id": "1",
  • "requestCode": "ASDF1234",
  • "ticketId": "1001",
  • "salesOrgId": "2000",
  • "customerId": "123456789",
  • "customerName": "ACME",
  • "firstName": "John",
  • "lastName": "Doe",
  • "email": "john.doe@example.com",
  • "phoneNumber": "+441134960000",
  • "smsConfirmation": true,
  • "visitDateStart": "2015-01-20T18:08:00Z",
  • "visitDateEnd": "2015-01-20T18:10:00Z",
  • "requestDate": "2015-01-19T12:32:05Z",
  • "site": "AMS-01",
  • "createdByUser": "john.doe@example.com",
  • "allowedItems": [
    ]
}

IP management

Leaseweb IP management is a service that allows businesses to manage their IP addresses efficiently. It offers a range of IP management options, including IP address allocation, IP address management, and IP address monitoring, to meet different IP management needs and requirements.

List IPs

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.

subnetId
string

Filter by subnet

version
integer
Enum: 4 6

Filter by protocol version

type
string
Enum: "NORMAL_IP" "NETWORK" "BROADCAST" "GATEWAY" "ROUTER1" "ROUTER2" "IPMI"

Filter by IP type

nullRouted
boolean

Filter by whether or not the IP has an active null route (true or false)

primary
boolean

Filter by whether or not the IP is primary (true or false)

fromIp
string

Return only IPs greater or equal to the specified address

toIp
string

Return only IPs lower or equal to the specified address

ips
string

Return only IPs specified as a comma-separated list

equipmentIds
string

Return only IPs assigned to equipment items specified as a comma-separated list of IDs

assignedContractIds
string

Return only IPs assigned to contracts specified as a comma-separated list of IDs

sort
string

Comma-separated list of sort field names. Prepend the field name with '-' for descending order. E.g. sort=ip,-nullrouted. Sortable field names are ip, nullRouted, reverseLookup.

reverseLookup
string
Example: reverseLookup=mydomain1.example.com

Filter by reverse lookup.

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/ipMgmt/v2/ips?limit=20&offset=10&subnetId=SOME_STRING_VALUE&version=SOME_INTEGER_VALUE&type=SOME_STRING_VALUE&nullRouted=SOME_BOOLEAN_VALUE&primary=SOME_BOOLEAN_VALUE&fromIp=SOME_STRING_VALUE&toIp=SOME_STRING_VALUE&ips=SOME_STRING_VALUE&equipmentIds=SOME_STRING_VALUE&assignedContractIds=SOME_STRING_VALUE&sort=SOME_STRING_VALUE&reverseLookup=mydomain1.example.com' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "ips": [
    ]
}

Inspect an IP

Authorizations:
X-LSW-Auth
path Parameters
ip
required
string
Example: 192.0.2.1

IP address or IP address with prefixLength {ip}_{prefix}. If prefixLength is not given, then we assume 32 (for IPv4) or 128 (for IPv6). PrefixLength is mandatory for IP range, for example, the IPv6 address range with prefixLength = 112

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/ipMgmt/v2/ips/192.0.2.1 \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "ip": "192.0.2.1",
  • "version": 4,
  • "type": "NORMAL_IP",
  • "prefixLength": 32,
  • "primary": true,
  • "reverseLookup": "mydomain1.example.com",
  • "nullRouted": false,
  • "nullLevel": null,
  • "unnullingAllowed": false,
  • "equipmentId": "1234",
  • "assignedContract": {
    },
  • "subnet": {
    }
}

Update an IP

Use this operation to set reverse lookup for IPv4 IP addresses.

Authorizations:
X-LSW-Auth
path Parameters
ip
required
string <ipv4>

IP address or IP address with prefixLength {ip}_{prefix}. If prefixLength is not given, then we assume 32

Request Body schema: application/json
reverseLookup
required
string

Responses

Request samples

Content type
application/json
{
  • "reverseLookup": "mydomain1.example.com"
}

Response samples

Content type
application/json
{
  • "ip": "192.0.2.1",
  • "version": 4,
  • "type": "NORMAL_IP",
  • "prefixLength": 32,
  • "primary": true,
  • "reverseLookup": "mydomain1.example.com",
  • "nullRouted": false,
  • "nullLevel": null,
  • "unnullingAllowed": false,
  • "equipmentId": "1234",
  • "assignedContract": {
    },
  • "subnet": {
    }
}

List reverse lookup records for an IPv6 range

Get reverse lookup values set for IPs in the specified range

Authorizations:
X-LSW-Auth
path Parameters
ip
required
string
Example: 192.0.2.1

IP address or IP address with prefixLength {ip}_{prefix}. If prefixLength is not given, then we assume 32 (for IPv4) or 128 (for IPv6). PrefixLength is mandatory for IP range, for example, the IPv6 address range with prefixLength = 112

query Parameters
ip
string

Filter the list by IP address

reverseLookup
string
Example: reverseLookup=mydomain1.example.com

Filter by reverse lookup.

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

curl --request GET \
  --url 'https://api.leaseweb.com/ipMgmt/v2/ips/192.0.2.1/reverseLookup?ip=SOME_STRING_VALUE&reverseLookup=mydomain1.example.com&limit=20&offset=10' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "reverseLookups": [
    ]
}

Set or remove reverse lookup records for an IPv6 range

This endpoint allows to set or unset reverse lookup for multiple IPv6 IPs in a specific IP range. To remove reverse lookup for an IP address set it to null or "". Reverse lookup values of IPs not listed in the request body will not be affected. You can set up to 20 records in a single request.

Authorizations:
X-LSW-Auth
path Parameters
ip
required
string
Example: 192.0.2.1

IP address or IP address with prefixLength {ip}_{prefix}. If prefixLength is not given, then we assume 32 (for IPv4) or 128 (for IPv6). PrefixLength is mandatory for IP range, for example, the IPv6 address range with prefixLength = 112

Request Body schema: application/json
required
Array of objects (reverseLookup)

Responses

Request samples

Content type
application/json
{
  • "reverseLookups": [
    ]
}

Response samples

Content type
application/json
{
  • "reverseLookups": [
    ]
}

Null route an IP

Authorizations:
X-LSW-Auth
path Parameters
ip
required
string
Example: 192.0.2.1

IP address or IP address with prefixLength {ip}_{prefix}. If prefixLength is not given, then we assume 32 (for IPv4) or 128 (for IPv6). PrefixLength is mandatory for IP range, for example, the IPv6 address range with prefixLength = 112

Request Body schema: application/json
automatedUnnullingAt
string <date-time>

The date and time when the null route is to be deactivated. The date and time should be specified using the format yyyy-mm-ddThh:mm:ss±hh:mm (with time zone designator) or yyyy-mm-ddThh:mm:ssZ (UTC). If this field is not present then the null route will not be automatically removed.

comment
string

A comment to be stored with the null route (e.g. null route reason)

ticketId
string

A reference to be stored with the null route

Responses

Request samples

Content type
application/json
{
  • "automatedUnnullingAt": "2015-06-25T11:13:00Z",
  • "comment": "This IP is evil",
  • "ticketId": "188612"
}

Response samples

Content type
application/json
{
  • "assignedContract": {
    },
  • "automatedUnnullingAt": "2015-06-25T11:13:00Z",
  • "comment": "This IP is evil",
  • "equipmentId": "456",
  • "id": "4534536",
  • "ip": "192.0.2.1",
  • "nullLevel": 1,
  • "nulledAt": "2015-06-28T12:00:00Z",
  • "nulledBy": "john.doe@example.com",
  • "ticketId": "188612",
  • "unnulledAt": null,
  • "unnulledBy": null
}

Remove a null route

Authorizations:
X-LSW-Auth
path Parameters
ip
required
string
Example: 192.0.2.1

IP address or IP address with prefixLength {ip}_{prefix}. If prefixLength is not given, then we assume 32 (for IPv4) or 128 (for IPv6). PrefixLength is mandatory for IP range, for example, the IPv6 address range with prefixLength = 112

Responses

Request samples

curl --request DELETE \
  --url https://api.leaseweb.com/ipMgmt/v2/ips/192.0.2.1/nullRoute \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

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

Inspect null route history

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.

fromIp
string

Return only IPs greater or equal to the specified address

toIp
string

Return only IPs lower or equal to the specified address

fromDate
string <date>

Return only null routes active after the specified date and time

toDate
string <date>

Return only null routes active before the specified date and time

nulledBy
string

Filter by the email address of the user who created the null route

unnulledBy
string

Filter by the email address of the user who removed the null route

ticketId
string

Filter by the reference stored with the null route

contractId
string

Filter by ID of the contract assigned to the IP at the time of null route creation

equipmentId
string

Filter by ID of the server assigned to the IP at the time of null route creation

sort
string

Comma-separated list of sort field names. Prepend the field name with '-' for descending order. E.g. sort=ip,-nullrouted. Sortable field names are ip, nullRouted, reverseLookup.

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/ipMgmt/v2/nullRoutes?limit=20&offset=10&fromIp=SOME_STRING_VALUE&toIp=SOME_STRING_VALUE&fromDate=SOME_STRING_VALUE&toDate=SOME_STRING_VALUE&nulledBy=SOME_STRING_VALUE&unnulledBy=SOME_STRING_VALUE&ticketId=SOME_STRING_VALUE&contractId=SOME_STRING_VALUE&equipmentId=SOME_STRING_VALUE&sort=SOME_STRING_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "nullroutes": [
    ]
}

Inspect null route history

Authorizations:
X-LSW-Auth
path Parameters
id
required
string
Example: 23234

Null route ID

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/ipMgmt/v2/nullRoutes/23234 \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "assignedContract": {
    },
  • "automatedUnnullingAt": "2015-06-25T11:13:00Z",
  • "comment": "This IP is evil",
  • "equipmentId": "456",
  • "id": "4534536",
  • "ip": "192.0.2.1",
  • "nullLevel": 1,
  • "nulledAt": "2015-06-28T12:00:00Z",
  • "nulledBy": "john.doe@example.com",
  • "ticketId": "188612",
  • "unnulledAt": null,
  • "unnulledBy": null
}

Update a null route

Authorizations:
X-LSW-Auth
path Parameters
id
required
string
Example: 23234

Null route ID

Request Body schema: application/json
automatedUnnullingAt
string <date-time>

The date and time when the null route is to be deactivated. The date and time should be specified using the format yyyy-mm-ddThh:mm:ss±hh:mm (with time zone designator) or yyyy-mm-ddThh:mm:ssZ (UTC). If this field is not present then the null route will not be automatically removed.

comment
string

A comment to be stored with the null route (e.g. null route reason)

ticketId
string

A reference to be stored with the null route

Responses

Request samples

Content type
application/json
{
  • "automatedUnnullingAt": "2015-06-25T11:13:00Z",
  • "comment": "This IP is evil",
  • "ticketId": "188612"
}

Response samples

Content type
application/json
{
  • "assignedContract": {
    },
  • "automatedUnnullingAt": "2015-06-25T11:13:00Z",
  • "comment": "This IP is evil",
  • "equipmentId": "456",
  • "id": "4534536",
  • "ip": "192.0.2.1",
  • "nullLevel": 1,
  • "nulledAt": "2015-06-28T12:00:00Z",
  • "nulledBy": "john.doe@example.com",
  • "ticketId": "188612",
  • "unnulledAt": null,
  • "unnulledBy": null
}

Floating IPs

Leaseweb Floating IPs are IP addresses that are dedicated to a single customer, providing high performance, scalability, and security. They are ideal for businesses that require a dedicated environment for their critical applications.

List ranges

A Floating IP range is bound to a particular site or metro.

If you have services in multiple data centers and want to use the Floating IP feature in each of those locations you will need to order a range per site or metro.

Authorizations:
X-LSW-Auth
query Parameters
limit
integer
Default: 10

Limit the number of results returned

offset
integer
Default: 0

Return results starting from the given offset

type
string
Enum: "SITE" "METRO"

Filter ranges by range type

location
string

Filter ranges by range location

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/floatingIps/v2/ranges?limit=SOME_INTEGER_VALUE&offset=SOME_INTEGER_VALUE&type=SOME_STRING_VALUE&location=SOME_STRING_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "ranges": [
    ],
  • "_metadata": {
    }
}

Inspect a range

A Floating IP range is identified by is network IP and the prefix length, separated by a underscore; for example 10.0.0.0_29.

Be aware that every IP address of a Floating IP range is usable and routable. A Floating IP range does not have a network IP, broadcast IP or gateway IP.

So for every IP in the range you can create a Floating IP Definition.

Authorizations:
X-LSW-Auth
path Parameters
rangeId
required
string
Example: 10.0.0.0_29

ID of a Floating IP Range, consisting of network IP and prefix length (separated by an underscore)

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/floatingIps/v2/ranges/10.0.0.0_29 \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "id": "88.17.0.0_17",
  • "range": "88.17.0.0/17",
  • "customerId": "10001234",
  • "salesOrgId": "2000",
  • "location": "AMS-01",
  • "type": "SITE"
}

List range definitions

A Floating IP definition describes a mapping between one or more Floating IPs (a.k.a Floating IP) to an anchor IP. Traffic destined for all the Floating IPs will be rerouted to the anchor IP.

The anchor IP is an ip address that belongs to a service you have with Leaseweb. At this moment only dedicated servers, dedicated racks and colocations are supported.

Authorizations:
X-LSW-Auth
path Parameters
rangeId
required
string
Example: 10.0.0.0_29

ID of a Floating IP Range, consisting of network IP and prefix length (separated by an underscore)

query Parameters
limit
integer
Default: 10

Limit the number of results returned

offset
integer
Default: 0

Return results starting from the given offset

location
string

Filter range definations by range location

type
string
Enum: "SITE" "METRO"

Filter range definations by range type

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/floatingIps/v2/ranges/10.0.0.0_29/floatingIpDefinitions?limit=SOME_INTEGER_VALUE&offset=SOME_INTEGER_VALUE&location=SOME_STRING_VALUE&type=SOME_STRING_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "floatingIpDefinitions": [
    ],
  • "_metadata": {
    }
}

Create a range definition

When a Floating IP definition is created, the Floating IP address is then made to route all traffic to the anchor IP address, Hence all services on the server become reachable via the Floating IP. This works in the background by maintaining BGP sessions in each site which announce the Floating IP routes through the border routers.

Floating IP addresses which do not have an anchor IP address have no route, and are thus effectively nullrouted.

How to configure Floating IPs on a server

On the server, Floating IPs should be setup like any other additional IP address. However, the same Floating IP will have to be setup on all servers that you want to be able to route it to.

Note: Currently, Floating IPs does not work on VPS or Cloud servers.

Authorizations:
X-LSW-Auth
path Parameters
rangeId
required
string
Example: 10.0.0.0_29

ID of a Floating IP Range, consisting of network IP and prefix length (separated by an underscore)

Request Body schema: application/json
floatingIp
required
string

The Floating IP address

anchorIp
required
string

The Anchor IP address

passiveAnchorIp
string

The Passive anchor IP address used for Anchor IP toggling

Responses

Request samples

Content type
application/json
{
  • "floatingIp": "88.17.0.5/32",
  • "anchorIp": "95.10.126.1",
  • "passiveAnchorIp": "95.10.126.2"
}

Response samples

Content type
application/json
{
  • "id": "88.17.34.108_32",
  • "rangeId": "88.17.0.0_17",
  • "location": "AMS-01",
  • "type": "SITE",
  • "customerId": "10001234",
  • "salesOrgId": "2000",
  • "floatingIp": "88.17.34.108/32",
  • "anchorIp": "95.10.126.1",
  • "passiveAnchorIp": "95.10.126.2",
  • "status": "ACTIVE",
  • "createdAt": "2019-03-13T09:10:02+0000",
  • "updatedAt": "2019-03-13T09:10:02+0000"
}

Inspect a range definition

Authorizations:
X-LSW-Auth
path Parameters
rangeId
required
string
Example: 10.0.0.0_29

ID of a Floating IP Range, consisting of network IP and prefix length (separated by an underscore)

floatingIpDefinitionId
required
string

ID of a Floating IP Definition, consisting of network IP and prefix length (separated by an underscore)

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/floatingIps/v2/ranges/10.0.0.0_29/floatingIpDefinitions/%7BfloatingIpDefinitionId%7D \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "id": "88.17.34.108_32",
  • "rangeId": "88.17.0.0_17",
  • "location": "AMS-01",
  • "type": "SITE",
  • "customerId": "10001234",
  • "salesOrgId": "2000",
  • "floatingIp": "88.17.34.108/32",
  • "anchorIp": "95.10.126.1",
  • "passiveAnchorIp": "95.10.126.2",
  • "status": "ACTIVE",
  • "createdAt": "2019-03-13T09:10:02+0000",
  • "updatedAt": "2019-03-13T09:10:02+0000"
}

Update a range definition

Imagine you have 2 dedicated servers in AMS-01, in different racks. And you have a Floating IP definition for Floating IP 10.0.0.0_32. You have configured the ip address 10.0.0.0/32 on both dedicated servers.

If the anchor IP in the Floating IP definition is pointing to your first server, all traffic goes to that server. With this PUT request you can change the Anchor IP address to point to, for example, your second server. Within a matter of seconds all the traffic destined for the Floating IP will now end up at the new Anchor IP. In the above example, your second server.

Authorizations:
X-LSW-Auth
path Parameters
rangeId
required
string
Example: 10.0.0.0_29

ID of a Floating IP Range, consisting of network IP and prefix length (separated by an underscore)

floatingIpDefinitionId
required
string

ID of a Floating IP Definition, consisting of network IP and prefix length (separated by an underscore)

Request Body schema: application/json
anchorIp
required
string

The Anchor IP address

passiveAnchorIp
string

The Passive anchor IP address used for Anchor IP toggling

Responses

Request samples

Content type
application/json
{
  • "anchorIp": "95.10.126.1"
}

Response samples

Content type
application/json
{
  • "id": "88.17.34.108_32",
  • "rangeId": "88.17.0.0_17",
  • "location": "AMS-01",
  • "type": "SITE",
  • "customerId": "10001234",
  • "salesOrgId": "2000",
  • "floatingIp": "88.17.34.108/32",
  • "anchorIp": "95.10.126.1",
  • "passiveAnchorIp": "95.10.126.2",
  • "status": "ACTIVE",
  • "createdAt": "2019-03-13T09:10:02+0000",
  • "updatedAt": "2019-03-13T09:10:02+0000"
}

Remove a range definition

Authorizations:
X-LSW-Auth
path Parameters
rangeId
required
string
Example: 10.0.0.0_29

ID of a Floating IP Range, consisting of network IP and prefix length (separated by an underscore)

floatingIpDefinitionId
required
string

ID of a Floating IP Definition, consisting of network IP and prefix length (separated by an underscore)

Responses

Request samples

curl --request DELETE \
  --url https://api.leaseweb.com/floatingIps/v2/ranges/10.0.0.0_29/floatingIpDefinitions/%7BfloatingIpDefinitionId%7D \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "id": "88.17.34.108_32",
  • "rangeId": "88.17.0.0_17",
  • "location": "AMS-01",
  • "type": "SITE",
  • "customerId": "10001234",
  • "salesOrgId": "2000",
  • "floatingIp": "88.17.34.108/32",
  • "anchorIp": "95.10.126.1",
  • "passiveAnchorIp": "95.10.126.2",
  • "status": "ACTIVE",
  • "createdAt": "2019-03-13T09:10:02+0000",
  • "updatedAt": "2019-03-13T09:10:02+0000"
}

Toggle the anchor IP with the passive anchor IP

Imagine you have 2 dedicated servers in AMS-01, in different racks. And you have a Floating IP definition for Floating IP 10.0.0.0_32. You have configured the ip address 10.0.0.0/32 on both dedicated servers.

If the Anchor IP in the Floating IP definition is pointing to your first server, all traffic goes to that server. With this PUT request you can toggle the Anchor IP address to point to, for example, your second server, or any other server registered as the Passive Anchor IP. Within a matter of seconds the Anchor IP and the Passive Anchor IP will switch places and all the traffic destined for the Floating IP will now end up at the new Anchor IP. In the above example, your second server.

Authorizations:
X-LSW-Auth
path Parameters
rangeId
required
string
Example: 10.0.0.0_29

ID of a Floating IP Range, consisting of network IP and prefix length (separated by an underscore)

floatingIpDefinitionId
required
string

ID of a Floating IP Definition, consisting of network IP and prefix length (separated by an underscore)

Responses

Request samples

curl --request POST \
  --url https://api.leaseweb.com/floatingIps/v2/ranges/10.0.0.0_29/floatingIpDefinitions/%7BfloatingIpDefinitionId%7D/toggleAnchorIp \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "id": "88.17.34.108_32",
  • "rangeId": "88.17.0.0_17",
  • "location": "AMS-01",
  • "type": "SITE",
  • "customerId": "10001234",
  • "salesOrgId": "2000",
  • "floatingIp": "88.17.34.108/32",
  • "anchorIp": "95.10.126.2",
  • "passiveAnchorIp": "95.10.126.1",
  • "status": "ACTIVE",
  • "createdAt": "2019-03-13T09:10:02+0000",
  • "updatedAt": "2019-03-13T09:10:02+0000"
}

Private Networks

Leaseweb Private Networks is a service that allows customers to connect multiple servers and cloud instances within a secure, isolated, and high-speed private network. This eliminates the need to use public internet connections for internal communications, improving security, reducing latency, and enhancing data transfer efficiency.

List private networks

Authorizations:
X-LSW-Auth
query Parameters
limit
integer
Default: 10

Limit the number of results returned

offset
integer
Default: 0

Return results starting from the given offset

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/bareMetals/v2/privateNetworks?limit=SOME_INTEGER_VALUE&offset=SOME_INTEGER_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "privateNetworks": [
    ]
}

Create a private network

Currently only one Private Network is allowed per customer.

Optionally you can give your Private Network a name by supplying the name parameter in the request.

Once a Private Network is created you can add dedicated servers to this private network.

Authorizations:
X-LSW-Auth
Request Body schema: application/json
name
string

A name to describe this private network

Responses

Request samples

Content type
application/json
{
  • "name": "production"
}

Response samples

Content type
application/json
{
  • "id": "12345",
  • "name": "default",
  • "createdAt": "2015-01-21T14:34:12+0000",
  • "updatedAt": "2015-01-21T14:34:12+0000",
  • "equipmentCount": 0,
  • "servers": [ ]
}

Inspect a private network

Every dedicated server in your private network contains a status key explaining the current state of your server in your private network.

Possible state values are:

  • CONFIGURING Your server is currently being added to the private network (can take ~5 minute)
  • REMOVING Your server is currently being removed from the private network (can take ~5 minute)
  • CONFIGURED Your server is part of the private network.
Authorizations:
X-LSW-Auth
path Parameters
privateNetworkId
required
string

Id of the privateNetwork

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/bareMetals/v2/privateNetworks/%7BprivateNetworkId%7D \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "id": "12345",
  • "name": "default",
  • "createdAt": "2015-01-21T14:34:12+0000",
  • "updatedAt": "2015-01-21T14:34:12+0000"
}

Update a private network

Authorizations:
X-LSW-Auth
path Parameters
privateNetworkId
required
string

Id of the privateNetwork

Request Body schema: application/json
name
string

A name to describe this private network

Responses

Request samples

Content type
application/json
{
  • "name": "production"
}

Response samples

Content type
application/json
{
  • "id": "12345",
  • "name": "default",
  • "createdAt": "2015-01-21T14:34:12+0000",
  • "updatedAt": "2015-01-21T14:34:12+0000",
  • "servers": [ ]
}

Delete a private network

You can only delete a private network if it has no equipments attached to it anymore.

Authorizations:
X-LSW-Auth
path Parameters
privateNetworkId
required
string

Id of the privateNetwork

Responses

Request samples

curl --request DELETE \
  --url https://api.leaseweb.com/bareMetals/v2/privateNetworks/%7BprivateNetworkId%7D \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "correlationId": "36ddff0b-0fc5-4bc5-cb4f-4a16a3895204",
  • "errorCode": 400,
  • "errorMessage": "You can only delete a private network if all equipments are removed from it."
}

Get DHCP reservations

Use this API to get DHCP the reservations of a private network.

Authorizations:
X-LSW-Auth
path Parameters
privateNetworkId
required
string
Example: 892

The ID of a Private Network

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/bareMetals/v2/privateNetworks/892/reservations \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "reservations": [
    ]
}

Create a DHCP reservation

Create a DHCP reservation for a private network.

Authorizations:
X-LSW-Auth
path Parameters
privateNetworkId
required
string
Example: 892

The ID of a Private Network

Request Body schema: application/json
required
ip
required
string

The IP address for this DHCP reservation

mac
required
string

The Mac address for this DHCP reservation

sticky
required
boolean

If false, this DHCP reservation will be automatically removed if not used for a longer period

Responses

Request samples

Content type
application/json
{
  • "ip": "127.0.0.1",
  • "mac": "D8:87:03:52:0A:0F",
  • "sticky": true
}

Response samples

Content type
application/json
{
  • "ip": "127.0.0.1",
  • "mac": "d8:87:03:52:0a:0f",
  • "sticky": true
}

Delete a DHCP reservation

This API call will delete a DHCP reservation from a private network.

Authorizations:
X-LSW-Auth
path Parameters
privateNetworkId
required
string
Example: 892

The ID of a Private Network

ip
required
string
Example: 127.0.0.6

The IP Address

Responses

Request samples

curl --request DELETE \
  --url https://api.leaseweb.com/bareMetals/v2/privateNetworks/892/reservations/127.0.0.6 \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "correlationId": "289346a1-3eaf-4da4-b707-62ef12eb08be",
  • "errorCode": "400",
  • "errorDetails": { },
  • "errorMessage": "Validation Failed."
}

Remote Management

Leaseweb Remote Management is a service that allows businesses to manage their servers remotely. It offers a range of remote management options, including remote management, remote monitoring, and remote management, to meet different remote management needs and requirements.

Change OpenVPN credentials

Users can change their OpenVPN credentials. These credentials are stored using one way encryption so the user is responsible for storing and/or remembering this password.

If the password is lost a new one can be generated using this API call. If a new password is generated it will replace the old password.

Authorizations:
X-LSW-Auth
Request Body schema: application/json
password
string >= 8 characters

The password should be at least 8 characters and consisting of uppercase, lowercase, digits and special characters

Responses

Request samples

Content type
application/json
{
  • "password": "mys3cretp@ssw0rd"
}

Response samples

Content type
application/json
{
  • "errorCode": "ACCESS_DENIED",
  • "errorMessage": "The access token is expired or invalid."
}

List OpenVPN profiles

These profiles are used to establish a OpenVPN connection to a data center which will give you access to the IPMI interface of your dedicated server. Access to this interface allows a user to remotely administer the server in case it is not reachable.

Authorizations:
X-LSW-Auth

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/bareMetals/v2/remoteManagement/profiles \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{}

Inspect an OpenVPN profile

Retrieve a OpenVPN profile for the given data center.

On success the response will be a pop specific OpenVPN profile containing a certificate and configuration.

This file can be used with OpenVPN clients to initiate a connection to Leaseweb Remote Management network.

Authorizations:
X-LSW-Auth
path Parameters
datacenter
required
string

Datacenter location

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/bareMetals/v2/remoteManagement/profiles/lsw-rmvpn-%7Bdatacenter%7D.ovpn \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/x-openvpn-profile
client

proto udp
port 1194
dev tun

remote-random
remote

keepalive 10 60

remote-cert-tls server
resolv-retry infinite

comp-lzo
auth-user-pass
auth-retry interact
explicit-exit-notify 2

<ca>
-----BEGIN CERTIFICATE-----
AAAAAAAAAAAAAA.................
-----END CERTIFICATE-----
</ca>

Aggregation Packs

Leaseweb Aggregation Packs are a service that allows businesses to manage their servers remotely. It offers a range of aggregation packs options, including aggregation packs, aggregation packs monitoring, and aggregation packs management, to meet different aggregation packs needs and requirements.

List aggregation packs

List your Aggregation Packs. This api call supports pagination. Use the limit and offset query string parameters to paginate through all your aggregation packs.

Every aggregation pack object in the json response lists a few properties of a aggregation pack. Use the single resource api call to get more details for a single aggregation pack.

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

curl --request GET \
  --url 'https://api.leaseweb.com/bareMetals/v2/aggregationPacks?limit=20&offset=10' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "connectContractItems": [
    ]
}

Get aggregation pack

Use this API to get information about a single aggregation pack.

Authorizations:
X-LSW-Auth
path Parameters
aggregationPackId
required
string

The ID of aggregation pack

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/bareMetals/v2/aggregationPacks/%7BaggregationPackId%7D \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "aggregationType": "Hybrid",
  • "billingType": "95TH",
  • "connectivityType": "BANDWIDTH_POOL",
  • "contractStartDate": "2022-07-01T00:00:00Z",
  • "contractTerm": 36,
  • "customerId": "1234",
  • "dataTrafficCommit": 20000,
  • "dataTrafficCommitUnit": "Mbps",
  • "id": "123456",
  • "networkPerformanceType": "VOLUME",
  • "salesOrgId": "2000"
}

CDN

Leaseweb CDN is a service that allows businesses to manage their servers remotely. It offers a range of CDN options, including CDN, CDN monitoring, and CDN management, to meet different CDN needs and requirements.

Create Origin

Create origin resouces to be used within distributions.

There are 2 types of origins:

  • Simple Origin
  • Advanced Origin
Authorizations:
X-LSW-Auth
Request Body schema: application/json
required
resourceType
required
string
Enum: "SIMPLE_ORIGIN" "ADVANCED_ORIGIN" "OBJECT_STORAGE_ORIGIN"
required
Array of items

Responses

Request samples

Content type
application/json
{
  • "resourceType": "SIMPLE_ORIGIN",
  • "data": [
    ]
}

Response samples

Content type
application/json
{
  • "resourceType": "SIMPLE_ORIGIN",
  • "data": [
    ]
}

Get All Origins

Get the list of origins including all of the origin types. Types are specified in each record.

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

curl --request GET \
  --url 'https://api.leaseweb.com/cdn/v2/origins?limit=20&offset=10' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "origins": [
    ],
  • "_metadata": {
    }
}

Get Origin By Id

Get an origin by its ID.

Authorizations:
X-LSW-Auth
path Parameters
origin_id
required
string (Origin Id)

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/cdn/v2/origins/%7Borigin_id%7D \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
Example
{
  • "resourceType": "SIMPLE_ORIGIN",
  • "data": [
    ]
}

Update Origin By Id

Update the options available in an origin.

Note: Type of the origin can't be changed since it's considered a different type of entity.

Authorizations:
X-LSW-Auth
path Parameters
origin_id
required
string (Origin Id)
Request Body schema: application/json
required
resourceType
required
string (Resourcetype)
required
Array of objects (Data)

Responses

Request samples

Content type
application/json
{
  • "resourceType": "SIMPLE_ORIGIN",
  • "data": [
    ]
}

Response samples

Content type
application/json
{
  • "resourceType": "SIMPLE_ORIGIN",
  • "data": [
    ]
}

Delete Origin By Id

Authorizations:
X-LSW-Auth
path Parameters
origin_id
required
string (Origin Id)

Responses

Request samples

curl --request DELETE \
  --url https://api.leaseweb.com/cdn/v2/origins/%7Borigin_id%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."
}

Create Origin Group

Using origin groups you can define loadbalancers on top of your origins.

Available loadbalancing methods:

  • ROUNDROBIN
  • CONSISTENT
  • STICKY
  • FAILOVER
Authorizations:
X-LSW-Auth
Request Body schema: application/json
required
resourceType
required
string (Resourcetype)
required
Array of objects (Data)

Responses

Request samples

Content type
application/json
{
  • "resourceType": "ORIGIN_GROUP",
  • "data": [
    ]
}

Response samples

Content type
application/json
{
  • "resourceType": "ORIGIN_GROUP",
  • "data": [
    ]
}

Get All Origin Groups

Get the list of your origin 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.

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/cdn/v2/originGroups?limit=20&offset=10' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "originGroups": [
    ],
  • "_metadata": {
    }
}

Get Origin Group By Id

Get the details of an origin group by its ID.

Authorizations:
X-LSW-Auth
path Parameters
origin_group_id
required
string (Origin Group Id)

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/cdn/v2/originGroups/%7Borigin_group_id%7D \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "resourceType": "ORIGIN_GROUP",
  • "data": [
    ]
}

Update Origin Group By Id

Update the parameters in an origin group.

Note: members are managed by another endpoint.

Authorizations:
X-LSW-Auth
path Parameters
origin_group_id
required
string (Origin Group Id)
Request Body schema: application/json
required
resourceType
required
string (Resourcetype)
required
Array of objects (Data)

Responses

Request samples

Content type
application/json
{
  • "resourceType": "ORIGIN_GROUP",
  • "data": [
    ]
}

Response samples

Content type
application/json
{
  • "resourceType": "ORIGIN_GROUP",
  • "data": [
    ]
}

Delete Origin Group By Id

Delete an origin group by its ID.

Authorizations:
X-LSW-Auth
path Parameters
origin_group_id
required
string (Origin Group Id)

Responses

Request samples

curl --request DELETE \
  --url https://api.leaseweb.com/cdn/v2/originGroups/%7Borigin_group_id%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."
}

Create Origin Group Member

Add members (origins) to your origin group.

These are the backend servers that are going to be used within the loadbalancer.

Authorizations:
X-LSW-Auth
path Parameters
origin_group_id
required
string (Origin Group Id)
Request Body schema: application/json
required
resourceType
required
string (Resourcetype)
required
Array of objects (Data)

Responses

Request samples

Content type
application/json
{
  • "resourceType": "ORIGIN_GROUP_MEMBER",
  • "data": [
    ]
}

Response samples

Content type
application/json
{
  • "resourceType": "ORIGIN_GROUP_MEMBER",
  • "data": [
    ]
}

Get All Origin Group Members

Get all of the members belonging to an origin group.

Authorizations:
X-LSW-Auth
path Parameters
origin_group_id
required
string (Origin 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

curl --request GET \
  --url 'https://api.leaseweb.com/cdn/v2/originGroups/%7Borigin_group_id%7D/members?limit=20&offset=10' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "originGroupMembers": [
    ],
  • "_metadata": {
    }
}

Get Origin Group Member By Id

Get the details of an origin group member by its ID.

Authorizations:
X-LSW-Auth
path Parameters
origin_group_id
required
string (Origin Group Id)
origin_group_member_id
required
string (Origin Group Member Id)

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/cdn/v2/originGroups/%7Borigin_group_id%7D/members/%7Borigin_group_member_id%7D \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "resourceType": "ORIGIN_GROUP_MEMBER",
  • "data": [
    ]
}

Update Origin Group Member By Id

Update the parameters in an origin group member.

Authorizations:
X-LSW-Auth
path Parameters
origin_group_id
required
string (Origin Group Id)
origin_group_member_id
required
string (Origin Group Member Id)
Request Body schema: application/json
required
resourceType
required
string (Resourcetype)
required
Array of objects (Data)

Responses

Request samples

Content type
application/json
{
  • "resourceType": "ORIGIN_GROUP_MEMBER",
  • "data": [
    ]
}

Response samples

Content type
application/json
{
  • "resourceType": "ORIGIN_GROUP_MEMBER",
  • "data": [
    ]
}

Delete Origin Group Member By Id

Authorizations:
X-LSW-Auth
path Parameters
origin_group_id
required
string (Origin Group Id)
origin_group_member_id
required
string (Origin Group Member Id)

Responses

Request samples

curl --request DELETE \
  --url https://api.leaseweb.com/cdn/v2/originGroups/%7Borigin_group_id%7D/members/%7Borigin_group_member_id%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."
}

Debug Url

You can use this endpoint to debug your distributions on each CDN provider independently. All of the returned headers per provider are included in the response.

Note: Use the specific domain you want to debug since each distribution can have multiple custom domains.

Authorizations:
X-LSW-Auth
Request Body schema: application/json
required
url
required
string <uri> (Url) [ 1 .. 2083 ] characters

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{}

Do Invalidation

You can submit multiple URLs to be invalidated and purged on all of the CDN PoPs. The time to finish the purge depends on the CDN providers and the number of cached files.

Authorizations:
X-LSW-Auth
Request Body schema: application/json
required
files
Array of strings (Files)

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "type": "INVALIDATION",
  • "resource": {
    },
  • "status": "PENDING",
  • "id": "0533396e-e5c6-4de2-bd08-06dfa91a3ab6",
  • "customerId": "47927462",
  • "created": "2024-07-11T12:14:43Z",
  • "updated": ""
}

Create Certificate

Using this endpoint, you can upload your custom TLS certificates to be used in your distributions.

Note: some CDN providers need more time to apply your new certificate to your newly created distribution. Please be aware and always try to upload your certificates as soon as possible.

Authorizations:
X-LSW-Auth
Request Body schema: application/json
required
Any of
Description (string) or Description (null) (Description)
certificate
required
string (Certificate)
privateKey
required
string (Privatekey)
caBundle
required
string (Cabundle)
validation
boolean (Validation)
Default: true

Responses

Request samples

Content type
application/json
{
  • "description": "Main LSW Certificate 2024",
  • "certificate": "-----BEGIN CERTIFICATE----- {***} -----END CERTIFICATE-----",
  • "privateKey": "-----BEGIN PRIVATE KEY----- {***} -----END PRIVATE KEY-----",
  • "caBundle": "-----BEGIN CERTIFICATE----- {***} -----END CERTIFICATE-----",
  • "validation": true
}

Response samples

Content type
application/json
{
  • "description": "Main LSW Certificate 2024",
  • "certificate": "Hidden for security reasons",
  • "privateKey": "Hidden for security reasons",
  • "caBundle": "Hidden for security reasons",
  • "validation": true,
  • "id": "ce-5g8wbh25",
  • "commonName": "c1",
  • "issuer": "c1",
  • "valid": true,
  • "trusted": true,
  • "daysLeft": 364,
  • "validFrom": 1723118047,
  • "validUntil": 1754646847,
  • "created": "2024-03-19T08:15:23",
  • "updated": "2024-03-19T08:15:23"
}

Get All Certificates

Get the list of your certificates.

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

curl --request GET \
  --url 'https://api.leaseweb.com/cdn/v2/certificates?limit=20&offset=10' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "certificates": [
    ],
  • "_metadata": {
    }
}

Get Certificate By Id

Get the details of a certificate by its ID

Authorizations:
X-LSW-Auth
path Parameters
certificate_id
required
string (Certificate Id)

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/cdn/v2/certificates/%7Bcertificate_id%7D \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "description": "Main LSW Certificate 2024",
  • "certificate": "Hidden for security reasons",
  • "privateKey": "Hidden for security reasons",
  • "caBundle": "Hidden for security reasons",
  • "validation": true,
  • "id": "ce-5g8wbh25",
  • "commonName": "c1",
  • "issuer": "c1",
  • "valid": true,
  • "trusted": true,
  • "daysLeft": 364,
  • "validFrom": 1723118047,
  • "validUntil": 1754646847,
  • "created": "2024-03-19T08:15:23",
  • "updated": "2024-03-19T08:15:23"
}

Delete Certificate By Id

Authorizations:
X-LSW-Auth
path Parameters
certificate_id
required
string (Certificate Id)

Responses

Request samples

curl --request DELETE \
  --url https://api.leaseweb.com/cdn/v2/certificates/%7Bcertificate_id%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."
}

Get All Actions

Get the list of all of the actions to monitor the progress of your background jobs.

Authorizations:
X-LSW-Auth
query Parameters
filters
Array of strings (Filters)
Items Enum: "INVALIDATION" "CREATE_DIST" "UPDATE_DIST" "DELETE_DIST"
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

curl --request GET \
  --url 'https://api.leaseweb.com/cdn/v2/actions?filters=SOME_ARRAY_VALUE&limit=20&offset=10' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "actions": [
    ],
  • "_metadata": {
    }
}

Get Action By Id

Get an action by ID to monitor the progress.

Authorizations:
X-LSW-Auth
path Parameters
action_id
required
string <uuid> (Action Id)

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/cdn/v2/actions/%7Baction_id%7D \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "type": "INVALIDATION",
  • "status": "PENDING",
  • "id": "50ea5204-4827-41d2-a940-cb5afdfb2426",
  • "customerId": "215468472",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z"
}

Create Distribution

Create any kind of distribution using this endpoint.

Available distribution types:

  • DISTRIBUTION_VOLUME
  • DISTRIBUTION_PREMIUM
  • SHIELD_CDN
Authorizations:
X-LSW-Auth
Request Body schema: application/json
required
resourceType
required
string (Resourcetype)
required
Array of objects (Data)

Responses

Request samples

Content type
application/json
Example
{
  • "resourceType": "DISTRIBUTION_VOLUME",
  • "data": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "resourceType": "DISTRIBUTION_VOLUME",
  • "data": [
    ]
}

Get All Distributions

Get the list of your distributions.

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

curl --request GET \
  --url 'https://api.leaseweb.com/cdn/v2/distributions?limit=20&offset=10' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "distributions": [
    ],
  • "_metadata": {
    }
}

Get Distribution By Id

Get the general details of a distribution by its ID.

Authorizations:
X-LSW-Auth
path Parameters
distribution_id
required
string (Distribution Id)

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/cdn/v2/distributions/%7Bdistribution_id%7D \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "resourceType": "DISTRIBUTION_VOLUME",
  • "data": [
    ]
}

Update Distribution By Id

Authorizations:
X-LSW-Auth
path Parameters
distribution_id
required
string (Distribution Id)
Request Body schema: application/json
required
resourceType
required
string (Resourcetype)
required
Array of objects (Data)

Responses

Request samples

Content type
application/json
{
  • "resourceType": "DISTRIBUTION_VOLUME",
  • "data": [
    ]
}

Response samples

Content type
application/json
{
  • "resourceType": "DISTRIBUTION_VOLUME",
  • "data": [
    ]
}

Delete Distribution By Id

Authorizations:
X-LSW-Auth
path Parameters
distribution_id
required
string (Distribution Id)

Responses

Request samples

curl --request DELETE \
  --url https://api.leaseweb.com/cdn/v2/distributions/%7Bdistribution_id%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."
}

Create Domain

Add custom domains to a distribution.

Authorizations:
X-LSW-Auth
path Parameters
distribution_id
required
string (Distribution Id)
Request Body schema: application/json
required
domain
required
string (Domain)

Responses

Request samples

Content type
application/json
{
  • "domain": "test2.com"
}

Response samples

Content type
application/json
{
  • "domain": "test2.com",
  • "id": "test2.com",
  • "distributionId": "di-yt84vrj",
  • "created": "2024-07-31T02:15:32",
  • "updated": "2024-08-04T23:24:29"
}

Get All Domains

Get the list of custom domains attached to a distribution.

Authorizations:
X-LSW-Auth
path Parameters
distribution_id
required
string (Distribution 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

curl --request GET \
  --url 'https://api.leaseweb.com/cdn/v2/distributions/%7Bdistribution_id%7D/domains?limit=20&offset=10' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "domains": [
    ],
  • "_metadata": {
    }
}

Get Domain By Id

Get the details of a custom domain attached to a dsitribution.

Authorizations:
X-LSW-Auth
path Parameters
distribution_id
required
string (Distribution Id)
domain_id
required
string (Domain Id)

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/cdn/v2/distributions/%7Bdistribution_id%7D/domains/%7Bdomain_id%7D \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "domain": "test2.com",
  • "id": "test2.com",
  • "distributionId": "di-yt84vrj",
  • "created": "2024-07-31T02:15:32",
  • "updated": "2024-08-04T23:24:29"
}

Delete Domain By Id

Authorizations:
X-LSW-Auth
path Parameters
distribution_id
required
string (Distribution Id)
domain_id
required
string (Domain Id)

Responses

Request samples

curl --request DELETE \
  --url https://api.leaseweb.com/cdn/v2/distributions/%7Bdistribution_id%7D/domains/%7Bdomain_id%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."
}

Create Policy

Apply custom configurations using policies.

Note: Policies only exist for Volume and Shield distributions and only one policy can be added for volume distributions.

Authorizations:
X-LSW-Auth
path Parameters
distribution_id
required
string (Distribution Id)
Request Body schema: application/json
required
securityToken
boolean (Securitytoken)
Default: false
"LEASEWEB" (any) or Securitytokenvendor (null) (Securitytokenvendor)
securityTokenMethod
string or null (Securitytokenmethod)
Enum: "SIMPLE" "ENCRYPTED"
securityTokenSecret
string or null (Securitytokensecret) <= 125 characters
securityTokenAesKey
string or null (Securitytokenaeskey)
securityTokenShaKey
string or null (Securitytokenshakey)
securityTokenClientIp
boolean (Securitytokenclientip)
Default: false
securityTokenExpirationParam
string or null (Securitytokenexpirationparam)
securityTokenParam
string or null (Securitytokenparam)
securityTokenNumberOfPathComponents
integer (Securitytokennumberofpathcomponents) [ -1 .. 10 ]
Default: -1
securityTokenEmbedIntoPath
boolean (Securitytokenembedintopath)
Default: false
securityGeoAcl
boolean (Securitygeoacl)
Default: false
Securitygeoacldefault (string) or Securitygeoacldefault (null) (Securitygeoacldefault)
securityIpAcl
boolean (Securityipacl)
Default: false
Securityipacldefault (string) or Securityipacldefault (null) (Securityipacldefault)
securityReferrerAcl
boolean (Securityreferreracl)
Default: false
Securityreferreracldefault (string) or Securityreferreracldefault (null) (Securityreferreracldefault)
originPullProtocol
string (Originpullprotocol)
Default: "HTTP"
Enum: "HTTP" "HTTPS"
Originpullcompressed (boolean) or Originpullcompressed (null) (Originpullcompressed)
Originpullhostheader (string) or Originpullhostheader (null) (Originpullhostheader)
Originpullid (string) or Originpullid (null) (Originpullid)
Originpullgroupid (string) or Originpullgroupid (null) (Originpullgroupid)
Originpullshieldid (string) or Originpullshieldid (null) (Originpullshieldid)
originPullXff
boolean (Originpullxff)
Default: false
originPullPassCookie
boolean (Originpullpasscookie)
Default: false
originPullPassVary
boolean (Originpullpassvary)
Default: false
cacheQueryString
boolean (Cachequerystring)
Default: false
Cachedefaultttl (integer) or Cachedefaultttl (null) (Cachedefaultttl)
cacheHonorOriginTtl
boolean (Cachehonororiginttl)
Default: false
cacheStale
boolean (Cachestale)
Default: false
cacheByPass
boolean (Cachebypass)
Default: false
cacheSegmented
boolean (Cachesegmented)
Default: true
deliveryTtlInherit
boolean (Deliveryttlinherit)
Default: false
deliveryTtlOverride
integer (Deliveryttloverride)
Default: 0
deliveryCompress
boolean (Deliverycompress)
Default: false
deliveryRateLimit
boolean (Deliveryratelimit)
Default: false
Deliverytransferrate (integer) or Deliverytransferrate (null) (Deliverytransferrate)
Deliveryburstsize (integer) or Deliveryburstsize (null) (Deliveryburstsize)
deliveryForceHttps
boolean (Deliveryforcehttps)
Default: false
deliveryPassThroughAllHeaders
boolean (Deliverypassthroughallheaders)
Default: false
description
string (Description)
Allowedmethods (string) or Allowedmethods (null) (Allowedmethods)
Default: "GET,HEAD"
path
string (Path)
Default: "/"
templateId
string or null (Template ID)

Responses

Request samples

Content type
application/json
{
  • "description": "test-policy-1",
  • "allowedMethods": "GET,POST,HEAD,PUT,OPTIONS",
  • "securityGeoAcl": false,
  • "securityIpAcl": false,
  • "securityReferrerAcl": false,
  • "originPullProtocol": "HTTP",
  • "originPullCompressed": false,
  • "originPullHostHeader": "test.invalid",
  • "originPullId": "or-r81jws",
  • "originPullGroupId": null,
  • "originPullXff": false,
  • "cacheQueryString": false,
  • "cacheDefaultTtl": 86400,
  • "cacheHonorOriginTtl": false,
  • "cacheStale": false,
  • "deliveryTtlInherit": false,
  • "deliveryTtlOverride": 0,
  • "deliveryCompress": false,
  • "deliveryForceHttps": false
}

Response samples

Content type
application/json
{
  • "securityToken": false,
  • "securityTokenVendor": null,
  • "securityTokenMethod": null,
  • "securityTokenSecret": null,
  • "securityTokenAesKey": null,
  • "securityTokenShaKey": null,
  • "securityTokenClientIp": false,
  • "securityTokenExpirationParam": null,
  • "securityTokenParam": null,
  • "securityTokenNumberOfPathComponents": -1,
  • "securityTokenEmbedIntoPath": false,
  • "securityGeoAcl": false,
  • "securityGeoAclDefault": null,
  • "securityIpAcl": true,
  • "securityIpAclDefault": null,
  • "securityReferrerAcl": false,
  • "securityReferrerAclDefault": null,
  • "originPullProtocol": "HTTP",
  • "originPullCompressed": false,
  • "originPullHostHeader": "test.invalid",
  • "originPullId": "or-r8n157f",
  • "originPullGroupId": null,
  • "originPullShieldId": null,
  • "originPullXff": false,
  • "originPullPassCookie": false,
  • "originPullPassVary": false,
  • "cacheQueryString": false,
  • "cacheDefaultTtl": 86400,
  • "cacheHonorOriginTtl": false,
  • "cacheStale": false,
  • "cacheByPass": false,
  • "cacheSegmented": true,
  • "deliveryTtlInherit": false,
  • "deliveryTtlOverride": 0,
  • "deliveryCompress": false,
  • "deliveryRateLimit": false,
  • "deliveryTransferRate": null,
  • "deliveryBurstSize": null,
  • "deliveryForceHttps": false,
  • "deliveryPassThroughAllHeaders": false,
  • "description": "test-policy-4",
  • "allowedMethods": "GET,POST,HEAD,PUT,OPTIONS",
  • "path": "/",
  • "id": "po-48nwon",
  • "customerId": "cu-a4c79393",
  • "created": "2024-08-06T08:55:37",
  • "updated": "2024-08-07T23:31:44"
}

Get All Policies

Get the list of policies for a distribution.

Note: Policies only exist for Volume and Shield distributions.

Authorizations:
X-LSW-Auth
path Parameters
distribution_id
required
string (Distribution 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

curl --request GET \
  --url 'https://api.leaseweb.com/cdn/v2/distributions/%7Bdistribution_id%7D/policies?limit=20&offset=10' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "policies": [
    ],
  • "_metadata": {
    }
}

Get Policy By Id

Get the details of a policy using its ID.

Authorizations:
X-LSW-Auth
path Parameters
distribution_id
required
string (Distribution Id)
policy_id
required
string (Policy Id)

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/cdn/v2/distributions/%7Bdistribution_id%7D/policies/%7Bpolicy_id%7D \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "securityToken": false,
  • "securityTokenVendor": null,
  • "securityTokenMethod": null,
  • "securityTokenSecret": null,
  • "securityTokenAesKey": null,
  • "securityTokenShaKey": null,
  • "securityTokenClientIp": false,
  • "securityTokenExpirationParam": null,
  • "securityTokenParam": null,
  • "securityTokenNumberOfPathComponents": -1,
  • "securityTokenEmbedIntoPath": false,
  • "securityGeoAcl": false,
  • "securityGeoAclDefault": null,
  • "securityIpAcl": true,
  • "securityIpAclDefault": null,
  • "securityReferrerAcl": false,
  • "securityReferrerAclDefault": null,
  • "originPullProtocol": "HTTP",
  • "originPullCompressed": false,
  • "originPullHostHeader": "test.invalid",
  • "originPullId": "or-r8n157f",
  • "originPullGroupId": null,
  • "originPullShieldId": null,
  • "originPullXff": false,
  • "originPullPassCookie": false,
  • "originPullPassVary": false,
  • "cacheQueryString": false,
  • "cacheDefaultTtl": 86400,
  • "cacheHonorOriginTtl": false,
  • "cacheStale": false,
  • "cacheByPass": false,
  • "cacheSegmented": true,
  • "deliveryTtlInherit": false,
  • "deliveryTtlOverride": 0,
  • "deliveryCompress": false,
  • "deliveryRateLimit": false,
  • "deliveryTransferRate": null,
  • "deliveryBurstSize": null,
  • "deliveryForceHttps": false,
  • "deliveryPassThroughAllHeaders": false,
  • "description": "test-policy-4",
  • "allowedMethods": "GET,POST,HEAD,PUT,OPTIONS",
  • "path": "/",
  • "id": "po-48nwon",
  • "customerId": "cu-a4c79393",
  • "created": "2024-08-06T08:55:37",
  • "updated": "2024-08-07T23:31:44"
}

Update Policy By Id

Authorizations:
X-LSW-Auth
path Parameters
distribution_id
required
string (Distribution Id)
policy_id
required
string (Policy Id)
Request Body schema: application/json
required

Update the options available in each policy.

securityToken
boolean (Securitytoken)
Default: false
"LEASEWEB" (any) or Securitytokenvendor (null) (Securitytokenvendor)
securityTokenMethod
string or null (Securitytokenmethod)
Enum: "SIMPLE" "ENCRYPTED"
securityTokenSecret
string or null (Securitytokensecret) <= 125 characters
securityTokenAesKey
string or null (Securitytokenaeskey)
securityTokenShaKey
string or null (Securitytokenshakey)
securityTokenClientIp
boolean (Securitytokenclientip)
Default: false
securityTokenExpirationParam
string or null (Securitytokenexpirationparam)
securityTokenParam
string or null (Securitytokenparam)
securityTokenNumberOfPathComponents
integer (Securitytokennumberofpathcomponents) [ -1 .. 10 ]
Default: -1
securityTokenEmbedIntoPath
boolean (Securitytokenembedintopath)
Default: false
securityGeoAcl
boolean (Securitygeoacl)
Default: false
Securitygeoacldefault (string) or Securitygeoacldefault (null) (Securitygeoacldefault)
securityIpAcl
boolean (Securityipacl)
Default: false
Securityipacldefault (string) or Securityipacldefault (null) (Securityipacldefault)
securityReferrerAcl
boolean (Securityreferreracl)
Default: false
Securityreferreracldefault (string) or Securityreferreracldefault (null) (Securityreferreracldefault)
originPullProtocol
string (Originpullprotocol)
Default: "HTTP"
Enum: "HTTP" "HTTPS"
Originpullcompressed (boolean) or Originpullcompressed (null) (Originpullcompressed)
Originpullhostheader (string) or Originpullhostheader (null) (Originpullhostheader)
Originpullid (string) or Originpullid (null) (Originpullid)
Originpullgroupid (string) or Originpullgroupid (null) (Originpullgroupid)
Originpullshieldid (string) or Originpullshieldid (null) (Originpullshieldid)
originPullXff
boolean (Originpullxff)
Default: false
originPullPassCookie
boolean (Originpullpasscookie)
Default: false
originPullPassVary
boolean (Originpullpassvary)
Default: false
cacheQueryString
boolean (Cachequerystring)
Default: false
Cachedefaultttl (integer) or Cachedefaultttl (null) (Cachedefaultttl)
cacheHonorOriginTtl
boolean (Cachehonororiginttl)
Default: false
cacheStale
boolean (Cachestale)
Default: false
cacheByPass
boolean (Cachebypass)
Default: false
cacheSegmented
boolean (Cachesegmented)
Default: true
deliveryTtlInherit
boolean (Deliveryttlinherit)
Default: false
deliveryTtlOverride
integer (Deliveryttloverride)
Default: 0
deliveryCompress
boolean (Deliverycompress)
Default: false
deliveryRateLimit
boolean (Deliveryratelimit)
Default: false
Deliverytransferrate (integer) or Deliverytransferrate (null) (Deliverytransferrate)
Deliveryburstsize (integer) or Deliveryburstsize (null) (Deliveryburstsize)
deliveryForceHttps
boolean (Deliveryforcehttps)
Default: false
deliveryPassThroughAllHeaders
boolean (Deliverypassthroughallheaders)
Default: false
description
string (Description)
Allowedmethods (string) or Allowedmethods (null) (Allowedmethods)
Default: "GET,HEAD"
path
string (Path)
Default: "/"

Responses

Request samples

Content type
application/json
{
  • "securityToken": false,
  • "securityTokenVendor": null,
  • "securityTokenMethod": null,
  • "securityTokenSecret": null,
  • "securityTokenAesKey": null,
  • "securityTokenShaKey": null,
  • "securityTokenClientIp": false,
  • "securityTokenExpirationParam": null,
  • "securityTokenParam": null,
  • "securityTokenNumberOfPathComponents": -1,
  • "securityTokenEmbedIntoPath": false,
  • "securityGeoAcl": false,
  • "securityGeoAclDefault": null,
  • "securityIpAcl": true,
  • "securityIpAclDefault": null,
  • "securityReferrerAcl": false,
  • "securityReferrerAclDefault": null,
  • "originPullProtocol": "HTTP",
  • "originPullCompressed": false,
  • "originPullHostHeader": "test.invalid",
  • "originPullId": "or-r8n157f",
  • "originPullGroupId": null,
  • "originPullShieldId": null,
  • "originPullXff": false,
  • "originPullPassCookie": false,
  • "originPullPassVary": false,
  • "cacheQueryString": false,
  • "cacheDefaultTtl": 86400,
  • "cacheHonorOriginTtl": false,
  • "cacheStale": false,
  • "cacheByPass": false,
  • "cacheSegmented": true,
  • "deliveryTtlInherit": false,
  • "deliveryTtlOverride": 0,
  • "deliveryCompress": false,
  • "deliveryRateLimit": false,
  • "deliveryTransferRate": null,
  • "deliveryBurstSize": null,
  • "deliveryForceHttps": false,
  • "deliveryPassThroughAllHeaders": false,
  • "description": "test-policy-4-upated",
  • "allowedMethods": "GET,POST,HEAD,PUT",
  • "path": "/"
}

Response samples

Content type
application/json
{
  • "securityToken": false,
  • "securityTokenVendor": null,
  • "securityTokenMethod": null,
  • "securityTokenSecret": null,
  • "securityTokenAesKey": null,
  • "securityTokenShaKey": null,
  • "securityTokenClientIp": false,
  • "securityTokenExpirationParam": null,
  • "securityTokenParam": null,
  • "securityTokenNumberOfPathComponents": -1,
  • "securityTokenEmbedIntoPath": false,
  • "securityGeoAcl": false,
  • "securityGeoAclDefault": null,
  • "securityIpAcl": true,
  • "securityIpAclDefault": null,
  • "securityReferrerAcl": false,
  • "securityReferrerAclDefault": null,
  • "originPullProtocol": "HTTP",
  • "originPullCompressed": false,
  • "originPullHostHeader": "test.invalid",
  • "originPullId": "or-r8n157f",
  • "originPullGroupId": null,
  • "originPullShieldId": null,
  • "originPullXff": false,
  • "originPullPassCookie": false,
  • "originPullPassVary": false,
  • "cacheQueryString": false,
  • "cacheDefaultTtl": 86400,
  • "cacheHonorOriginTtl": false,
  • "cacheStale": false,
  • "cacheByPass": false,
  • "cacheSegmented": true,
  • "deliveryTtlInherit": false,
  • "deliveryTtlOverride": 0,
  • "deliveryCompress": false,
  • "deliveryRateLimit": false,
  • "deliveryTransferRate": null,
  • "deliveryBurstSize": null,
  • "deliveryForceHttps": false,
  • "deliveryPassThroughAllHeaders": false,
  • "description": "test-policy-4-updated",
  • "allowedMethods": "GET,POST,HEAD,PUT",
  • "path": "/",
  • "id": "po-48nwon",
  • "customerId": "cu-a4c79393",
  • "created": "2024-08-06T08:55:37",
  • "updated": "2024-08-07T23:31:44"
}

Delete Policy By Id

Authorizations:
X-LSW-Auth
path Parameters
distribution_id
required
string (Distribution Id)
policy_id
required
string (Policy Id)

Responses

Request samples

curl --request DELETE \
  --url https://api.leaseweb.com/cdn/v2/distributions/%7Bdistribution_id%7D/policies/%7Bpolicy_id%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."
}

Get All Templates

Authorizations:
X-LSW-Auth

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/cdn/v2/policyTemplates \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
[
  • {
    }
]

Create Acl

Create an ACL to control the traffic to a policy.

There are 3 types of ACLs:

  • IP_ACL: Reject or allow certain IP subnets.
  • GEO_ACL: Reject or allow certain countries.
  • REFERRER_ACL: Reject or allow certain referrers.
Authorizations:
X-LSW-Auth
path Parameters
distribution_id
required
string (Distribution Id)
policy_id
required
string (Policy Id)
Request Body schema: application/json
required
action
string (Action)
Default: "REJECT"
Enum: "REJECT" "ALLOW"
value
required
string (Value)
type
required
string (Type)
Enum: "IP_ACL" "GEO_ACL" "REFERRER_ACL"

Responses

Request samples

Content type
application/json
{
  • "action": "REJECT",
  • "value": "1.1.1.5/32",
  • "type": "IP_ACL"
}

Response samples

Content type
application/json
{
  • "action": "REJECT",
  • "value": "1.1.1.5/32",
  • "type": "IP_ACL",
  • "id": "iacl-2",
  • "policyId": "po-wk0ksi0x",
  • "created": "2024-08-06T08:55:37",
  • "updated": "2024-08-07T23:31:44"
}

Get All Acls

Get the list of active ACLs in a policy.

Authorizations:
X-LSW-Auth
path Parameters
distribution_id
required
string (Distribution Id)
policy_id
required
string (Policy 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

curl --request GET \
  --url 'https://api.leaseweb.com/cdn/v2/distributions/%7Bdistribution_id%7D/policies/%7Bpolicy_id%7D/acls?limit=20&offset=10' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "acls": [
    ],
  • "_metadata": {
    }
}

Get Acl By Id

Get an ACL by its ID.

Authorizations:
X-LSW-Auth
path Parameters
distribution_id
required
string (Distribution Id)
policy_id
required
string (Policy Id)
acl_id
required
string (Acl Id)

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/cdn/v2/distributions/%7Bdistribution_id%7D/policies/%7Bpolicy_id%7D/acls/%7Bacl_id%7D \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "action": "REJECT",
  • "value": "1.1.1.5/32",
  • "type": "IP_ACL",
  • "id": "iacl-2",
  • "policyId": "po-wk0ksi0x",
  • "created": "2024-08-06T08:55:37",
  • "updated": "2024-08-07T23:31:44"
}

Delete Acl By Id

Authorizations:
X-LSW-Auth
path Parameters
distribution_id
required
string (Distribution Id)
policy_id
required
string (Policy Id)
acl_id
required
string (Acl Id)

Responses

Request samples

curl --request DELETE \
  --url https://api.leaseweb.com/cdn/v2/distributions/%7Bdistribution_id%7D/policies/%7Bpolicy_id%7D/acls/%7Bacl_id%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."
}

Get Statistics For Reseller Customer

Query statistics for reseller customer This endpoint is intended to be used for getting various statistics from the reporting backend

It currently supports DATATRANSFER, BANDWIDTH, REQUESTS, STATUS_2XX, STATUS_4XX, STATUS_5XX, CACHEHIT and 95TH as a metric.

DATATRANSFER: used to get the consumed amount of traffic (in bytes) in the queried period.
BANDWIDTH: used to get the mean amount of bits per second in the queried period.
STATUS_2XX/4XX/5XX: used to get a percentage of the amount of response codes in the queried period.
CACHEHIT: used to get the mean cache-hit ratio in the queried period.
REQUESTS: used to get the total amount of serviced requests in the queried period.
95TH: used to get the 95th percentile in bits per second for the queried period.

The fromDt and toDt must use the format YYYY-MM-ddTHH:mm:ss eg.. 2024-07-14T13:40:00.

Using the 'groupBy' parameter will allow you to group results together. Supported groupings are PROVIDER, DISTRIBUTION, CUSTOMER and REGION.

By specifying the distributionId as an additional filter the query will run just for the specified distribution. The granularity of the data can be specified in 5MIN (5 minutes), 15MIN (15 minutes), HOUR (1 hour), DAY (1 day) and WEEK (1 Week).

Authorizations:
X-LSW-Auth
query Parameters
fromDt
required
string <date-time> (fromDt)
toDt
required
string <date-time> (toDt)
metric
required
string (metric)
Enum: "DATATRANSFER" "BANDWIDTH" "REQUESTS" "STATUS_2XX" "STATUS_4XX" "STATUS_5XX" "CACHEHIT" "95TH"
distributionId
string (distributionId)
groupBy
string (groupBy)
Enum: "PROVIDER" "DISTRIBUTION" "CUSTOMER" "REGION"
granularity
string (granularity)
Default: "5MIN"
Enum: "5MIN" "15MIN" "HOUR" "DAY" "WEEK"

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/cdn/v2/statistics/reseller?fromDt=SOME_STRING_VALUE&toDt=SOME_STRING_VALUE&metric=SOME_STRING_VALUE&distributionId=SOME_STRING_VALUE&groupBy=SOME_STRING_VALUE&granularity=SOME_STRING_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "fromTs": "2024-07-13T14:45:00",
  • "toTs": "2024-07-13T14:55:00",
  • "service": "cdn",
  • "granularity": "5MIN",
  • "groupBy": null,
  • "distributionId": null,
  • "series": [
    ]
}

Get Total Statistics For Reseller Customer

Query total statistics for reseller customer This endpoint is intended to be used for getting the summed (total) statistics from the reporting backend

It currently supports DATATRANSFER, BANDWIDTH, REQUESTS, STATUS_2XX, STATUS_4XX, STATUS_5XX, CACHEHIT and 95TH as a metric.

DATATRANSFER: used to get the consumed amount of traffic (in bytes) in the queried period.
BANDWIDTH: used to get the mean amount of bits per second in the queried period.
STATUS_2XX/4XX/5XX: used to get a percentage of the amount of response codes in the queried period.
CACHEHIT: used to get the mean cache-hit ratio in the queried period.
REQUESTS: used to get the total amount of serviced requests in the queried period.
95TH: used to get the 95th percentile in bits per second for the queried period.

The fromDt and toDt must use the format YYYY-MM-ddTHH:mm:ss eg.. 2024-07-14T13:40:00.

Using the 'groupBy' parameter will allow you to group results together. Supported groupings are PROVIDER, DISTRIBUTION, CUSTOMER and REGION. By specifying the distributionId as an additional filter the query will run just for the specified distribution.

Authorizations:
X-LSW-Auth
query Parameters
fromDt
required
string <date-time> (fromDt)
toDt
required
string <date-time> (toDt)
metric
required
string (metric)
Enum: "DATATRANSFER" "BANDWIDTH" "REQUESTS" "STATUS_2XX" "STATUS_4XX" "STATUS_5XX" "CACHEHIT" "95TH"
distributionId
string (distributionId)
groupBy
string (groupBy)
Enum: "PROVIDER" "DISTRIBUTION" "CUSTOMER" "REGION"

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/cdn/v2/statistics/reseller/totals?fromDt=SOME_STRING_VALUE&toDt=SOME_STRING_VALUE&metric=SOME_STRING_VALUE&distributionId=SOME_STRING_VALUE&groupBy=SOME_STRING_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "fromTs": "2024-07-13T14:45:00",
  • "toTs": "2024-07-13T14:55:00",
  • "service": "cdn",
  • "granularity": "5MIN",
  • "groupBy": "PROVIDER",
  • "distributionId": null,
  • "series": [
    ]
}

Get Statistics For Customer

Query statistics for customer This endpoint is intended to be used for getting various statistics from the reporting backend

It currently supports DATATRANSFER, BANDWIDTH, REQUESTS, STATUS_2XX, STATUS_4XX, STATUS_5XX, CACHEHIT and 95TH as a metric.

DATATRANSFER: used to get the consumed amount of traffic (in bytes) in the queried period.
BANDWIDTH: used to get the mean amount of bits per second in the queried period.
STATUS_2XX/4XX/5XX: used to get a percentage of the amount of response codes in the queried period.
CACHEHIT: used to get the mean cache-hit ratio in the queried period.
REQUESTS: used to get the total amount of serviced requests in the queried period.
95TH: used to get the 95th percentile in bits per second for the queried period.

The fromDt and toDt must use the format YYYY-MM-ddTHH:mm:ss eg.. 2024-07-14T13:40:00.

Using the 'groupBy' parameter will allow you to group results together. Supported groupings are PROVIDER, DISTRIBUTION, CUSTOMER and REGION.

By specifying the distributionId as an additional filter the query will run just for the specified distribution. The granularity of the data can be specified in 5MIN (5 minutes), 15MIN (15 minutes), HOUR (1 hour), DAY (1 day) and WEEK (1 Week).

Authorizations:
X-LSW-Auth
query Parameters
fromDt
required
string <date-time> (fromDt)
toDt
required
string <date-time> (toDt)
metric
required
string (metric)
Enum: "DATATRANSFER" "BANDWIDTH" "REQUESTS" "STATUS_2XX" "STATUS_4XX" "STATUS_5XX" "CACHEHIT" "95TH"
distributionId
string (distributionId)
groupBy
string (groupBy)
Enum: "PROVIDER" "DISTRIBUTION" "CUSTOMER" "REGION"
granularity
string (granularity)
Default: "5MIN"
Enum: "5MIN" "15MIN" "HOUR" "DAY" "WEEK"

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/cdn/v2/statistics/customer?fromDt=SOME_STRING_VALUE&toDt=SOME_STRING_VALUE&metric=SOME_STRING_VALUE&distributionId=SOME_STRING_VALUE&groupBy=SOME_STRING_VALUE&granularity=SOME_STRING_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "fromTs": "2024-08-20T09:28:38",
  • "toTs": "2024-08-20T09:40:00",
  • "service": "cdn",
  • "granularity": "5MIN",
  • "groupBy": "REGION",
  • "distributionId": null,
  • "series": [
    ]
}

Get Total Statistics For Customer

Query total statistics for customer This endpoint is intended to be used for getting the summed (total) statistics from the reporting backend

It currently supports DATATRANSFER, BANDWIDTH, REQUESTS, STATUS_2XX, STATUS_4XX, STATUS_5XX, CACHEHIT and 95TH as a metric.

DATATRANSFER: used to get the consumed amount of traffic (in bytes) in the queried period.
BANDWIDTH: used to get the mean amount of bits per second in the queried period.
STATUS_2XX/4XX/5XX: used to get a percentage of the amount of response codes in the queried period.
CACHEHIT: used to get the mean cache-hit ratio in the queried period.
REQUESTS: used to get the total amount of serviced requests in the queried period.
95TH: used to get the 95th percentile in bits per second for the queried period.

The fromDt and toDt must use the format YYYY-MM-ddTHH:mm:ss eg.. 2024-07-14T13:40:00.

Using the 'groupBy' parameter will allow you to group results together. Supported groupings are PROVIDER, DISTRIBUTION, CUSTOMER and REGION. By specifying the distributionId as an additional filter the query will run just for the specified distribution.

Authorizations:
X-LSW-Auth
query Parameters
fromDt
required
string <date-time> (fromDt)
toDt
required
string <date-time> (toDt)
metric
required
string (metric)
Enum: "DATATRANSFER" "BANDWIDTH" "REQUESTS" "STATUS_2XX" "STATUS_4XX" "STATUS_5XX" "CACHEHIT" "95TH"
distributionId
string (distributionId)
groupBy
string (groupBy)
Enum: "PROVIDER" "DISTRIBUTION" "CUSTOMER" "REGION"

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/cdn/v2/statistics/customer/totals?fromDt=SOME_STRING_VALUE&toDt=SOME_STRING_VALUE&metric=SOME_STRING_VALUE&distributionId=SOME_STRING_VALUE&groupBy=SOME_STRING_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "fromTs": "2024-07-13T14:45:00",
  • "toTs": "2024-07-13T14:55:00",
  • "service": "cdn",
  • "granularity": "5MIN",
  • "groupBy": "PROVIDER",
  • "distributionId": null,
  • "series": [
    ]
}

Domains

Leaseweb Domains are a service that allows businesses to manage their domains efficiently. It offers a range of domain options, including domain registration, domain management, and domain monitoring, to meet different domain needs and requirements.

List domains

Authorizations:
X-LSW-Auth
query Parameters
limit
integer
Default: 10
Example: limit=10

Limit the number of results returned

offset
integer
Default: 0

Return results starting from the given offset

type
string
Enum: "dns" "email" "overview"
Example: type=overview

Supplement the domain listing with statistics about either DNS and Email

domainName
string
Example: domainName=example.com

Filter the domains listing based on the domainName

status
string
Enum: "ACTIVE" "SUSPENDED" "PROVISIONED" "SCHEDULED" "TO BE SUSPENDED" "RECONNECTED"
Example: status=ACTIVE

Filter the domains listing based on the domain status

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/hosting/v2/domains?limit=10&offset=0&type=overview&domainName=example.com&status=ACTIVE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
{
  • "domains": [
    ],
  • "_links": {
    },
  • "_metadata": {
    }
}

Inspect a domain

Authorizations:
X-LSW-Auth
path Parameters
domainName
required
string
Example: example.com

Domain name

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/hosting/v2/domains/example.com \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "domainName": "example.com",
  • "suspended": true,
  • "dnsOnly": true,
  • "status": "SUSPENDED",
  • "contractStartDate": "2017-04-01T00:00:00+02:00",
  • "contractEndDate": "2018-04-01T00:00:00+02:00",
  • "_links": {
    }
}

Check availability

Authorizations:
X-LSW-Auth
path Parameters
domainName
required
string
Example: example.com

Domain name

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/hosting/v2/domains/example.com/available \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "domainName": "example.com",
  • "available": true,
  • "_links": {
    }
}

List nameservers

Authorizations:
X-LSW-Auth
path Parameters
domainName
required
string
Example: example.com

Domain name

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/hosting/v2/domains/example.com/nameservers \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "nameservers": [
    ],
  • "status": "Nameservers update request is accepted. This request will be processed after 24 hours.",
  • "isLeasewebNameserver": false,
  • "_links": {
    },
  • "_metadata": {
    }
}

Update nameservers

Full replacement of all nameservers for a domain.

Please note that the request body should contain at least two nameservers.

Authorizations:
X-LSW-Auth
path Parameters
domainName
required
string
Example: example.com

Domain name

Request Body schema: application/json
required
Array of objects

Array of nameservers

Responses

Request samples

Content type
application/json
{
  • "nameservers": [
    ]
}

Response samples

Content type
application/json
{
  • "nameservers": [
    ],
  • "status": "Nameservers update request is accepted. This request will be processed after 24 hours.",
  • "_links": {
    },
  • "_metadata": {
    }
}

Inspect DNS Security (DNSSEC)

Retrieve the DNSSEC status for your domain.

Authorizations:
X-LSW-Auth
path Parameters
domainName
required
string
Example: example.com

Domain name

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/hosting/v2/domains/example.com/dnssec \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
Example
{
  • "status": "ENABLED",
  • "nsec3": {
    },
  • "keyRollover": {
    },
  • "_links": {
    }
}

Update DNS Security (DNSSEC)

Enable or Disable DNSSEC for your domain.

Please note : If you are using Leaseweb nameservers we will add DNSSEC keys automatically when enabling DNSSEC. If you are managing your own nameservers (non-leaseweb nameservers) then you can add your own keys as shown in example.

Authorizations:
X-LSW-Auth
path Parameters
domainName
required
string
Example: example.com

Domain name

Request Body schema: application/json
status
required
string
Enum: "ENABLED" "DISABLED"

Domain DNSSEC status

object

NSEC3 is an extension to DNSSEC and it requires DNSSEC to be enabled.

Array of objects

Add DNSSEC keys only when you have non-leaseweb nameservers.

Responses

Request samples

Content type
application/json
Example
{
  • "status": "DISABLED"
}

Response samples

Content type
application/json
Example
{
  • "infoMessage": "DNSSEC disabled successfully. It may take up to 25 hours to reflect."
}

DNS

Leaseweb DNS is a service that allows businesses to manage their DNS efficiently. It offers a range of DNS options, including DNS registration, DNS management, and DNS monitoring, to meet different DNS needs and requirements.

List resource record sets

Authorizations:
X-LSW-Auth
path Parameters
domainName
required
string
Example: example.com

Domain name

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/hosting/v2/domains/example.com/resourceRecordSets \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
{
  • "_links": {
    },
  • "infoMessage": "EXAMPLE: Sorry, but your domain is not yet listed on our nameservers. Please create a DNS record first so we can add your domain.",
  • "resourceRecordSets": [
    ]
}

Create a resource record set

Authorizations:
X-LSW-Auth
path Parameters
domainName
required
string
Example: example.com

Domain name

Request Body schema:
name
required
string (name)

Name of the resource record set

type
required
string (resourceRecordSetType)
Enum: "A" "AAAA" "CAA" "CNAME" "MX" "NS" "SRV" "TXT" "SOA" "DS" "TLSA"

Type of the resource record set

content
required
Array of strings (resourceRecordSetContent)

Array of resource record set content entries

ttl
required
integer (ttl)
Enum: 60 300 1800 3600 14400 28800 43200 86400

Time to live of the resource record set

Responses

Request samples

Content type
{
  • "content": [
    ],
  • "name": "example.com.",
  • "ttl": 3600,
  • "type": "A"
}

Response samples

Content type
{
  • "_links": {
    },
  • "content": [
    ],
  • "editable": true,
  • "name": "example.com.",
  • "ttl": 3600,
  • "type": "A"
}

Update all DNS records

This is a full replacement of all editable resource records sets for a domain.

Authorizations:
X-LSW-Auth
path Parameters
domainName
required
string
Example: example.com

Domain name

Request Body schema:
required
Array of objects (resourceRecordSet)

Array of resource record sets

Responses

Request samples

Content type
{
  • "resourceRecordSets": [
    ]
}

Response samples

Content type
{
  • "_links": {
    },
  • "content": [
    ],
  • "editable": true,
  • "name": "example.com.",
  • "ttl": 3600,
  • "type": "A"
}

Delete all DNS records

Delete all editable resource record sets for a domain.

Please note that this action will keep the domain's zone in place.

Authorizations:
X-LSW-Auth
path Parameters
domainName
required
string
Example: example.com

Domain name

Responses

Request samples

curl --request DELETE \
  --url https://api.leaseweb.com/hosting/v2/domains/example.com/resourceRecordSets \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

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

Inspect resource record set

Authorizations:
X-LSW-Auth
path Parameters
domainName
required
string
Example: example.com

Domain name

name
required
string
Example: example.com.

Record name

type
required
string
Enum: "A" "AAA" "CAA" "CNAME" "MX" "TLSA" "NS" "SRV" "TXT" "SOA" "DS"
Example: A

Record type

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/hosting/v2/domains/example.com/resourceRecordSets/example.com./A \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
{
  • "_links": {
    },
  • "content": [
    ],
  • "editable": true,
  • "name": "example.com.",
  • "ttl": 3600,
  • "type": "A"
}

Update a specific DNS record

Authorizations:
X-LSW-Auth
path Parameters
domainName
required
string
Example: example.com

Domain name

name
required
string
Example: example.com.

Record name

type
required
string
Enum: "A" "AAA" "CAA" "CNAME" "MX" "TLSA" "NS" "SRV" "TXT" "SOA" "DS"
Example: A

Record type

Request Body schema:
content
required
Array of strings (resourceRecordSetContent)

Array of resource record set content entries

ttl
required
integer (ttl)
Enum: 60 300 1800 3600 14400 28800 43200 86400

Time to live of the resource record set

Responses

Request samples

Content type
{
  • "content": [
    ],
  • "ttl": 3600
}

Response samples

Content type
{
  • "_links": {
    },
  • "content": [
    ],
  • "editable": true,
  • "name": "example.com.",
  • "ttl": 3600,
  • "type": "A"
}

Delete a specific DNS record

Authorizations:
X-LSW-Auth
path Parameters
domainName
required
string
Example: example.com

Domain name

name
required
string
Example: example.com.

Record name

type
required
string
Enum: "A" "AAA" "CAA" "CNAME" "MX" "TLSA" "NS" "SRV" "TXT" "SOA" "DS"
Example: A

Record type

Responses

Request samples

curl --request DELETE \
  --url https://api.leaseweb.com/hosting/v2/domains/example.com/resourceRecordSets/example.com./A \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

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

Import dns records from bind file content

Authorizations:
X-LSW-Auth
path Parameters
domainName
required
string
Example: example.com

Domain name

Request Body schema: application/json
content
required
string

Dns bind file content as string

Responses

Request samples

Content type
application/json
{
  • "content": "$ORIGIN example.com. \r\n$TTL 86400 \r\n\tIN\tMX\t10\tmail.example.com. \r\n\r\n\t\r\ndns1\tIN\tA\t10.0.1.1"
}

Response samples

Content type
application/json
{
  • "resourceRecordSets": [
    ]
}

Export dns records as a bind file content

Authorizations:
X-LSW-Auth
path Parameters
domainName
required
string
Example: example.com

Domain name

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/hosting/v2/domains/example.com/resourceRecordSets/import \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
text/plain
example.com 3600 IN NS ns0.nameserver.com.
example.com. 3600 IN NS ns1.nameserver.com.
example.com. 3600 IN SOA ns0.nameserver.com. postmaster.nameserver.com. 2024101701 10800 3600 1209600 3600

Validate a resource record set

This endpoint may be used to validate whether a resource record set is valid, without actually creating it.

Authorizations:
X-LSW-Auth
path Parameters
domainName
required
string
Example: example.com

Domain name

Request Body schema:
name
required
string (name)

Name of the resource record set

type
required
string (resourceRecordSetType)
Enum: "A" "AAAA" "CAA" "CNAME" "MX" "NS" "SRV" "TXT" "SOA" "DS" "TLSA"

Type of the resource record set

content
required
Array of strings (resourceRecordSetContent)

Array of resource record set content entries

ttl
required
integer (ttl)
Enum: 60 300 1800 3600 14400 28800 43200 86400

Time to live of the resource record set

Responses

Request samples

Content type
{
  • "content": [
    ],
  • "name": "example.com.",
  • "ttl": 3600,
  • "type": "A"
}

Response samples

Content type
application/json
{
  • "infoMessage": "Resource record set is valid."
}

Validate zone

This endpoint may be used to validate whether a collection of resource record sets constitute a valid zone, without creating them.

Authorizations:
X-LSW-Auth
path Parameters
domainName
required
string
Example: example.com

Domain name

Request Body schema: application/json
required
Array of objects (resourceRecordSet)

Array of resource record sets

Responses

Request samples

Content type
application/json
{
  • "resourceRecordSets": [
    ]
}

Response samples

Content type
application/json
{
  • "infoMessage": "Zone example.com is valid."
}

Emails

Leaseweb Email is a service that allows businesses to manage their email efficiently. It offers a range of email options, including email registration, email management, and email monitoring, to meet different email needs and requirements.

List mailboxes

Authorizations:
X-LSW-Auth
path Parameters
domainName
required
string
Example: example.com

Domain name

query Parameters
limit
integer
Default: 10
Example: limit=10

Limit the number of results returned

offset
integer
Default: 0

Return results starting from the given offset

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/hosting/v2/domains/example.com/mailboxes?limit=10&offset=0' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "mailboxes": [
    ],
  • "catchAll": false,
  • "_links": {
    },
  • "nameservers": "LEASEWEB",
  • "_metadata": {
    }
}

Create a mailbox

Please note that it is only possible to create mailboxes when you have a web hosting pack with Leaseweb. Per web hosting pack it is possible to have up to 250 mailboxes.

Authorizations:
X-LSW-Auth
path Parameters
domainName
required
string
Example: example.com

Domain name

Request Body schema: application/json
emailAddress
required
string

The email address of the mailbox

active
required
boolean

Boolean indicating whether the mailbox is active

password
required
string

The password of the mailbox

spamChecksEnabled
required
boolean

Boolean indicating whether spam checks are enabled

virusChecksEnabled
required
boolean

Boolean indicating whether virus checks are enabled

localDelivery
required
boolean

Boolean indicating whether email to be stored as a local copy when there is a forward

setMxRecord
boolean

Boolean indicating whether MX record needs to be updated for mailbox

Responses

Request samples

Content type
application/json
{
  • "emailAddress": "mailbox@example.com",
  • "active": true,
  • "password": "CHANGETHIS",
  • "spamChecksEnabled": true,
  • "virusChecksEnabled": false,
  • "localDelivery": true,
  • "setMxRecord": true
}

Response samples

Content type
application/json
{
  • "active": true,
  • "currentSize": 123456789,
  • "emailAddress": "mailbox@example.com",
  • "maximumSize": 5368709120,
  • "spamChecksEnabled": true,
  • "suspended": false,
  • "virusChecksEnabled": false,
  • "localDelivery": true,
  • "_embedded": {
    },
  • "_links": {
    }
}

Inspect a mailbox

Authorizations:
X-LSW-Auth
path Parameters
domainName
required
string
Example: example.com

Domain name

emailAddress
required
string

Email address

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/hosting/v2/domains/example.com/mailboxes/%7BemailAddress%7D \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "active": true,
  • "currentSize": 123456789,
  • "emailAddress": "mailbox@example.com",
  • "maximumSize": 5368709120,
  • "spamChecksEnabled": true,
  • "suspended": false,
  • "virusChecksEnabled": false,
  • "localDelivery": false,
  • "createdAt": "2023-05-08T10:01:25+00:00",
  • "modifiedAt": "2023-05-08T10:01:25+00:00",
  • "_embedded": {
    },
  • "_links": {
    }
}

Update a mailbox

Authorizations:
X-LSW-Auth
path Parameters
domainName
required
string
Example: example.com

Domain name

emailAddress
required
string

Email address

Request Body schema: application/json
active
required
boolean

Boolean indicating whether the mailbox is active

password
string

The password of the mailbox

spamChecksEnabled
required
boolean

Boolean indicating whether spam checks are enabled

virusChecksEnabled
required
boolean

Boolean indicating whether virus checks are enabled

localDelivery
required
boolean

Boolean indicating whether email to be stored as a local copy when there is a forward

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "password": "CHANGETHIS",
  • "spamChecksEnabled": true,
  • "virusChecksEnabled": false,
  • "localDelivery": false
}

Response samples

Content type
application/json
{
  • "active": true,
  • "currentSize": 123456789,
  • "emailAddress": "mailbox@example.com",
  • "maximumSize": 5368709120,
  • "spamChecksEnabled": true,
  • "suspended": false,
  • "virusChecksEnabled": false,
  • "localDelivery": false,
  • "_embedded": {
    },
  • "_links": {
    }
}

Delete a mailbox

Please note that deleting a mailbox also removes all associated alias and forwards

Authorizations:
X-LSW-Auth
path Parameters
domainName
required
string
Example: example.com

Domain name

emailAddress
required
string

Email address

Responses

Request samples

curl --request DELETE \
  --url https://api.leaseweb.com/hosting/v2/domains/example.com/mailboxes/%7BemailAddress%7D \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "value": {
    }
}

Retrieve catch all information

Authorizations:
X-LSW-Auth
path Parameters
domainName
required
string
Example: example.com

Domain name

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/hosting/v2/domains/example.com/catchAll \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "destination": "destination@example.org",
  • "spamChecksEnabled": true,
  • "virusChecksEnabled": false,
  • "_links": {
    }
}

Change/create catch all

Authorizations:
X-LSW-Auth
path Parameters
domainName
required
string
Example: example.com

Domain name

Request Body schema: application/json
destination
required
string

The email address to which email messages will be delivered for the catch all

spamChecksEnabled
required
boolean

Boolean indicating whether spam checks are enabled

virusChecksEnabled
required
boolean

Boolean indicating whether virus checks are enabled

Responses

Request samples

Content type
application/json
{
  • "destination": "destination@example.org",
  • "spamChecksEnabled": true,
  • "virusChecksEnabled": false
}

Response samples

Content type
application/json
{
  • "destination": "destination@example.org",
  • "spamChecksEnabled": true,
  • "virusChecksEnabled": false,
  • "_links": {
    }
}

Delete a catch all

Authorizations:
X-LSW-Auth
path Parameters
domainName
required
string
Example: example.com

Domain name

Responses

Request samples

curl --request DELETE \
  --url https://api.leaseweb.com/hosting/v2/domains/example.com/catchAll \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "value": {
    }
}

List email aliases

Authorizations:
X-LSW-Auth
path Parameters
domainName
required
string
Example: example.com

Domain name

query Parameters
limit
integer
Default: 10
Example: limit=10

Limit the number of results returned

offset
integer
Default: 0

Return results starting from the given offset

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/hosting/v2/domains/example.com/emailAliases?limit=10&offset=0' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "emailAliases": [
    ],
  • "_links": {
    },
  • "nameserver": "EXTERNAL",
  • "_metadata": {
    }
}

Create an email alias

Please note that the source address should always be part of the domain it is created for.

Authorizations:
X-LSW-Auth
path Parameters
domainName
required
string
Example: example.com

Domain name

Request Body schema: application/json
active
required
boolean

Boolean indicating whether the email alias is active

destination
required
string

The email address to which email messages will be delivered

source
required
string

The email address for which email messages will be forwarded

spamChecksEnabled
required
boolean

Boolean indicating whether spam checks are enabled

virusChecksEnabled
required
boolean

Boolean indicating whether virus checks are enabled

setMxRecord
boolean

Boolean indicating whether MX record needs to be created for email alias

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "destination": "destination@example.com",
  • "source": "source@test.example.com",
  • "spamChecksEnabled": true,
  • "virusChecksEnabled": true,
  • "setMxRecord": true
}

Response samples

Content type
application/json
{
  • "active": true,
  • "destination": "destination@example.com",
  • "source": "source@example.com",
  • "spamChecksEnabled": true,
  • "virusChecksEnabled": true,
  • "_links": {
    }
}

Inspect email alias

Authorizations:
X-LSW-Auth
path Parameters
domainName
required
string
Example: example.com

Domain name

source
required
string
destination
required
string

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/hosting/v2/domains/example.com/emailAliases/%7Bsource%7D/%7Bdestination%7D \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "active": true,
  • "destination": "destination@example.com",
  • "source": "source@example.com",
  • "spamChecksEnabled": true,
  • "virusChecksEnabled": true,
  • "createdAt": "2023-05-08T10:01:11+00:00",
  • "modifiedAt": "2023-05-08T10:01:11+00:00"
}

Update an email alias

Authorizations:
X-LSW-Auth
path Parameters
domainName
required
string
Example: example.com

Domain name

source
required
string
destination
required
string
Request Body schema: application/json
active
required
boolean

Boolean indicating whether the email alias is active

spamChecksEnabled
required
boolean

Boolean indicating whether spam checks are enabled

virusChecksEnabled
required
boolean

Boolean indicating whether virus checks are enabled

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "spamChecksEnabled": true,
  • "virusChecksEnabled": true
}

Response samples

Content type
application/json
{
  • "active": true,
  • "destination": "destination@example.com",
  • "source": "source@example.com",
  • "spamChecksEnabled": true,
  • "virusChecksEnabled": true
}

Delete an email alias

Authorizations:
X-LSW-Auth
path Parameters
domainName
required
string
Example: example.com

Domain name

source
required
string
destination
required
string

Responses

Request samples

curl --request DELETE \
  --url https://api.leaseweb.com/hosting/v2/domains/example.com/emailAliases/%7Bsource%7D/%7Bdestination%7D \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "value": {
    }
}

List domain forwards

Authorizations:
X-LSW-Auth
path Parameters
domainName
required
string
Example: example.com

Domain name

query Parameters
limit
integer
Default: 10
Example: limit=10

Limit the number of results returned

offset
integer
Default: 0

Return results starting from the given offset

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/hosting/v2/domains/example.com/forwards?limit=10&offset=0' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "forwards": [
    ],
  • "_links": {
    },
  • "_metadata": {
    }
}

List forwards

Authorizations:
X-LSW-Auth
path Parameters
domainName
required
string
Example: example.com

Domain name

emailAddress
required
string

Email address

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/hosting/v2/domains/example.com/mailboxes/%7BemailAddress%7D/forwards \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "forwards": [
    ],
  • "_links": {
    },
  • "_metadata": {
    }
}

Create a forward

Authorizations:
X-LSW-Auth
path Parameters
domainName
required
string
Example: example.com

Domain name

emailAddress
required
string

Email address

Request Body schema: application/json
active
required
boolean

Boolean indicating whether the forward is active

destination
required
string

The email address to which email messages will be forwarded

source
required
string

The email address of the mailbox for which email messages will be forwarded

spamChecksEnabled
required
boolean

Boolean indicating whether spam checks are enabled

virusChecksEnabled
required
boolean

Boolean indicating whether virus checks are enabled

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "destination": "destination@example.org",
  • "source": "originating@example.com",
  • "spamChecksEnabled": false,
  • "virusChecksEnabled": true
}

Response samples

Content type
application/json
{
  • "active": true,
  • "destination": "destination@example.org",
  • "source": "mailbox@example.com",
  • "spamChecksEnabled": false,
  • "virusChecksEnabled": true,
  • "_links": {
    }
}

Inspect a forward

Authorizations:
X-LSW-Auth
path Parameters
domainName
required
string
Example: example.com

Domain name

emailAddress
required
string

Email address

destination
required
string

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/hosting/v2/domains/example.com/mailboxes/%7BemailAddress%7D/forwards/%7Bdestination%7D \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "active": true,
  • "destination": "destination@example.org",
  • "source": "mailbox@example.com",
  • "spamChecksEnabled": false,
  • "virusChecksEnabled": true,
  • "createdAt": "2023-05-08T10:01:25+00:00",
  • "modifiedAt": "2023-05-08T10:01:25+00:00",
  • "_links": {
    }
}

Update a forward

Authorizations:
X-LSW-Auth
path Parameters
domainName
required
string
Example: example.com

Domain name

emailAddress
required
string

Email address

destination
required
string
Request Body schema: application/json
active
required
boolean

Boolean indicating whether the forward is active

spamChecksEnabled
required
boolean

Boolean indicating whether spam checks are enabled

virusChecksEnabled
required
boolean

Boolean indicating whether virus checks are enabled

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "spamChecksEnabled": false,
  • "virusChecksEnabled": true
}

Response samples

Content type
application/json
{
  • "active": true,
  • "destination": "destination@example.org",
  • "source": "mailbox@example.com",
  • "spamChecksEnabled": false,
  • "virusChecksEnabled": true,
  • "_links": {
    }
}

Delete a forward

Authorizations:
X-LSW-Auth
path Parameters
domainName
required
string
Example: example.com

Domain name

emailAddress
required
string

Email address

destination
required
string

Responses

Request samples

curl --request DELETE \
  --url https://api.leaseweb.com/hosting/v2/domains/example.com/mailboxes/%7BemailAddress%7D/forwards/%7Bdestination%7D \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "value": {
    }
}

Inspect an auto responder

Authorizations:
X-LSW-Auth
path Parameters
domainName
required
string
Example: example.com

Domain name

emailAddress
required
string

Email address

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/hosting/v2/domains/example.com/mailboxes/%7BemailAddress%7D/autoResponder \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "active": true,
  • "body": "I will be out of office until 14-12-2020. Please contact the reception desk for urgent matters.",
  • "subject": "Out of office",
  • "_links": {
    }
}

Change an auto responder

Authorizations:
X-LSW-Auth
path Parameters
domainName
required
string
Example: example.com

Domain name

emailAddress
required
string

Email address

Request Body schema: application/json
active
required
boolean

Boolean indicating whether the auto responder is active

body
required
string

The body of the auto responder email message

subject
required
string

The subject of the auto responder email message

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "body": "I will be out of office until 14-12-2020. Please contact the reception desk for urgent matters.",
  • "subject": "Out of office"
}

Response samples

Content type
application/json
{
  • "active": true,
  • "body": "I will be out of office until 14-12-2020. Please contact the reception desk for urgent matters.",
  • "subject": "Out of office",
  • "_links": {
    }
}

Delete an auto responder

Authorizations:
X-LSW-Auth
path Parameters
domainName
required
string
Example: example.com

Domain name

emailAddress
required
string

Email address

Responses

Request samples

curl --request DELETE \
  --url https://api.leaseweb.com/hosting/v2/domains/example.com/mailboxes/%7BemailAddress%7D/autoResponder \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "value": {
    }
}

Abuse Reports

LIMITED ACCESS

Leaseweb has a strict Abuse Handling Policy to prevent misuse of its services. If someone is using Leaseweb’s network for illegal, unethical, or unauthorized activities, you can submit an Abuse Report to notify Leaseweb’s compliance team.

List reports

List reports

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.

status
string
Default: "OPEN,WAITING,CLOSED"
Example: status=OPEN,WAITING,CLOSED

Comma separated list of report statuses to filter on.

ticketId
string

Optional ticket ID to filter results

ip
string <ipv4>

Optional IP address to filter results

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/abuse/v1/reports?limit=20&offset=10&status=OPEN%2CWAITING%2CCLOSED&ticketId=SOME_STRING_VALUE&ip=SOME_STRING_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "reports": [
    ]
}

Inspect a report

Authorizations:
X-LSW-Auth
path Parameters
reportId
required
string
Example: abc123

Report Id

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "abuseType": "MALLWARE",
  • "attachments": [
    ],
  • "body": "string with content",
  • "customerId": "10000001",
  • "deadline": "2015-01-01T00:00:00+0100",
  • "detectedDomainNames": [
    ],
  • "detectedIpAddresses": [
    ],
  • "id": "000005",
  • "latestMessages": [
    ],
  • "legalEntityId": "2000",
  • "notifier": "notifier@email.com",
  • "reopened": false,
  • "reportedAt": "2015-01-01T00:00:00+0100",
  • "status": "CLOSED",
  • "subject": "Report description",
  • "totalMessagesCount": 2,
  • "updatedAt": "2015-01-01T00:00:00+0100"
}

List report messages

Authorizations:
X-LSW-Auth
path Parameters
reportId
required
string
Example: abc123

Report 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

curl --request GET \
  --url 'https://api.leaseweb.com/abuse/v1/reports/abc123/messages?limit=20&offset=10' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "messages": [
    ]
}

Create new message

Sent a new message to the Leaseweb compliance team related to an abuse report.

Authorizations:
X-LSW-Auth
path Parameters
reportId
required
string
Example: abc123

Report Id

Request Body schema: application/json
body
required
string

Plain text body of the message, for newlines use ' '.

Responses

Request samples

Content type
application/json
{
  • "body": "Hello, this is my first message."
}

Response samples

Content type
application/json
[
  • "To make sure the request has been processed please see if the message is added to the list."
]

Inspect a message attachment

The compliance team sometimes add an attachment to a message. You can use this endpoint to get the attachment. The content-type of the response depends on the content of the attachment.

Authorizations:
X-LSW-Auth
path Parameters
reportId
required
string
Example: abc123

Report Id

fileId
required
string
Example: sdfa73-adsfs-4fadf-sdfasdfa

File Id

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/abuse/v1/reports/abc123/messageAttachments/sdfa73-adsfs-4fadf-sdfasdfa \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

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

Inspect a report attachment

Use this endpoint to get an attachment which was created with the abuse report. The content-type of the response depends on the content of the attachment.

Authorizations:
X-LSW-Auth
path Parameters
reportId
required
string
Example: abc123

Report Id

fileId
required
string
Example: sdfa73-adsfs-4fadf-sdfasdfa

File Id

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/abuse/v1/reports/abc123/reportAttachments/sdfa73-adsfs-4fadf-sdfasdfa \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

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

List resolution options

In order to resolve a report, you need to specify a resolution. Use this endpoint to retrieve a list of all possible resolution options for this report.

Authorizations:
X-LSW-Auth
path Parameters
reportId
required
string
Example: abc123

Report Id

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/abuse/v1/reports/abc123/resolutions \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "isMessageRequired": false,
  • "resolutions": [
    ]
}

Resolve a report

Resolve a report

Authorizations:
X-LSW-Auth
path Parameters
reportId
required
string
Example: abc123

Report Id

Request Body schema: application/json
resolutions
required
Array of strings (resolutionList)

List of selected resolution ID's to explain how the report is resolved.

message
string

Message is required and only allowed if any of the IP(s) related to this report are null routed.

Responses

Request samples

Content type
application/json
{
  • "message": "The IP address associated with this report has been null routed due to policy violations. Further access will be restricted until the issue is resolved.",
  • "resolutions": [
    ]
}

Response samples

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

Api Keys

The Leaseweb Api Key management API is a part of Leaseweb’s API suite that allows customers to manage and retrieve API key-related data programmatically.

List API keys

Get a list of api keys for a customer

Authorizations:
X-LSW-Auth

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "keys": [
    ]
}

Get API key

Get the specified key.

Authorizations:
X-LSW-Auth
path Parameters
apiKeyId
required
string
Example: 1a2b3c

API Key id

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/apiKeys/v1/keys/1a2b3c \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "id": "u71abd",
  • "username": "c071b507",
  • "reference": "the new reference",
  • "createdAt": "2020-02-26T09:35:22+0100",
  • "generatedAt": "2020-02-26T09:35:22+0100",
  • "generatedBy": "email@foo.bar",
  • "requestMethods": [
    ],
  • "whiteListedIps": [
    ],
  • "expiresAt": "2021-02-26T09:35:22+0100"
}

List allowed IPs

Get a list of whiteListedIps.

Authorizations:
X-LSW-Auth
path Parameters
apiKeyId
required
string
Example: 1a2b3c

API Key id

Responses

Request samples

curl --request GET \
  --url https://api.leaseweb.com/apiKeys/v1/keys/1a2b3c/whiteListedIps \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "whiteListedIps": [
    ]
}

Add IP to allowed IP list

Add IP to allowed IP list for an API Key.

Authorizations:
X-LSW-Auth
path Parameters
apiKeyId
required
string
Example: 1a2b3c

API Key id

Request Body schema: application/json
whiteListedIp
string <ipv4>

An ip address to whitelist for an api key

Responses

Request samples

Content type
application/json
{
  • "whiteListedIp": "123.123.123.123"
}

Response samples

Content type
application/json
{
  • "whiteListedIps": [
    ]
}

Replace allowed IP list

Replace allowed IP list of an API Key.

Authorizations:
X-LSW-Auth
path Parameters
apiKeyId
required
string
Example: 1a2b3c

API Key id

Request Body schema: application/json
whiteListedIps
Array of strings <ipv4> [ items <ipv4 > ]

List of whitelisted ips to update for an api key

Responses

Request samples

Content type
application/json
{
  • "whiteListedIps": [
    ]
}

Response samples

Content type
application/json
{
  • "whiteListedIps": [
    ]
}

Delete all whitelisted ips for an API key.

Delete all whitelisted ips for an API key.

Authorizations:
X-LSW-Auth
path Parameters
apiKeyId
required
string
Example: 1a2b3c

API Key id

Responses

Request samples

curl --request DELETE \
  --url https://api.leaseweb.com/apiKeys/v1/keys/1a2b3c/whiteListedIps \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

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

Delete allowed IP

Delete allowed IP of an API Key.

Authorizations:
X-LSW-Auth
path Parameters
apiKeyId
required
string
Example: 1a2b3c

API Key id

ip
required
string

Whitelisted IP

Responses

Request samples

curl --request DELETE \
  --url https://api.leaseweb.com/apiKeys/v1/keys/1a2b3c/whiteListedIps/%7Bip%7D \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

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

Invoices

The Leaseweb Invoices API is a part of Leaseweb’s API suite that allows customers to manage and retrieve invoice-related data programmatically. This API is useful for businesses that need to automate billing processes, track financial transactions, and integrate invoice management with their internal accounting systems.

List invoices

This endpoint will return an overview of all the invoices for the customer.

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

curl --request GET \
  --url 'https://api.leaseweb.com/invoices/v1/invoices?limit=20&offset=10' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "invoices": [
    ]
}

Pro Forma

This endpoint will return an overview of contract items that will be invoiced as of the 1st of the upcoming month.

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

curl --request GET \
  --url 'https://api.leaseweb.com/invoices/v1/invoices/proforma?limit=20&offset=10' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "contractItems": [
    ],
  • "currency": "EUR",
  • "proformaDate": "2020-06-01T00: 00: 00+00: 00",
  • "subTotal": 300.04,
  • "total": 352.55,
  • "vatAmount": 52.51
}

Inspect an invoice

This endpoint will return a single invoice for the customer.

Authorizations:
X-LSW-Auth
path Parameters
invoiceId
required
string
Example: 00000001

Invoice Id

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "credits": [
    ],
  • "currency": "EUR",
  • "date": "2019-05-06T00:00:00+00:00",
  • "dueDate": "2019-05-30T00:00:00+00:00",
  • "id": "00000001",
  • "isPartialPaymentAllowed": true,
  • "lineItems": [
    ],
  • "openAmount": 1756.21,
  • "status": "OPEN",
  • "taxAmount": 0,
  • "total": 1756.21
}

Get invoice PDF

This endpoint will return a PDf of a single invoice for the customer.

Authorizations:
X-LSW-Auth
path Parameters
invoiceId
required
string
Example: 00000001

Invoice Id

Responses

Request samples

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

Response samples

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

Ordering

BETA

With this API, you can order dedicated servers. It allows you to browse available servers, retrieve pricing details, and place the orders.

List available dedicated server configurations.

List available dedicated server configurations.

Authorizations:
X-LSW-Auth
query Parameters
location
string
Example: location=AMS-01

The datacenter location

ram
string
Example: ram=64GB

The ram information

diskSize
string
Example: diskSize=SSD480GB

The disk size information

diskAmount
string
Example: diskAmount=2

The amount of disks

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/ordering/v1/products/dedicatedServers?location=AMS-01&ram=64GB&diskSize=SSD480GB&diskAmount=2' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "_metadata": {
    },
  • "dedicatedServers": [
    ]
}

Get a single dedicated server and its price.

Get a single dedicated server and its price.

Authorizations:
X-LSW-Auth
path Parameters
dedicatedServerId
required
string
Example: 27f38ef06cf3bf62e21e75401feac6cd

The ID of a dedicated server

query Parameters
location
required
string
Example: location=AMS-01

The datacenter location

connectedToAggregationPool
boolean
Default: "false"
Example: connectedToAggregationPool=true

To add the dedicated server in the connectivity aggregation pool

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/ordering/v1/products/dedicatedServers/27f38ef06cf3bf62e21e75401feac6cd?location=AMS-01&connectedToAggregationPool=true' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "chassis": "Dell R730XD (12xLFF)",
  • "cpu": {
    },
  • "deliveryMethod": "1 hour",
  • "hdd": [
    ],
  • "id": "dd41f6fa95aa88bcea58eddd15eb0fa0",
  • "location": [
    ],
  • "name": "Dell R730XD (12xLFF) 2x Intel Xeon E5-2650v4",
  • "price": {
    },
  • "ram": {
    }
}

Dedicated Server ordering.

Dedicated Server ordering.

Authorizations:
X-LSW-Auth
path Parameters
dedicatedServerId
required
string
Example: 27f38ef06cf3bf62e21e75401feac6cd

The ID of a dedicated server

Request Body schema: application/json
location
required
string

The location of the server

connectedToAggregationPool
boolean
Default: false

Whether the server is connected to an aggregation pool

contractTerm
string
Default: "1_MONTH"
Enum: "1_MONTH" "3_MONTHS" "6_MONTHS" "1_YEAR" "2_YEARS" "3_YEARS"

The contract term of the server

Responses

Request samples

Content type
application/json
{
  • "connectedToAggregationPool": true,
  • "contractTerm": "1_MONTH",
  • "location": "AMS-01"
}

Response samples

Content type
application/json
{
  • "orderId": 44011723
}

Services

The Leaseweb Services API is part of Leaseweb’s suite of APIs that allow customers to programmatically manage their hosted services, including dedicated servers, cloud instances, and network configurations. This API enables automation, monitoring, and control of Leaseweb services without needing to interact with the Leaseweb customer portal manually.

Get all your Services

This endpoint returns all your Services.

Authorizations:
X-LSW-Auth
query Parameters
limit
integer
Default: 10

Limit the number of results returned

offset
integer
Default: 0

Return results starting from the given offset

productId
string

Filter the services endpoint with a productId

reference
string

Filter the services endpoint with a reference

equipmentId
string

Filter the services endpoint with an equipmentId

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/services/v1/services?limit=SOME_INTEGER_VALUE&offset=SOME_INTEGER_VALUE&productId=SOME_STRING_VALUE&reference=SOME_STRING_VALUE&equipmentId=SOME_STRING_VALUE' \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "services": [
    ]
}

Get cancellation reasons

This endpoint will return our predefined cancellation reasons.

Authorizations:
X-LSW-Auth

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "cancellationReasons": [
    ]
}

Inspect a service

This endpoint will return a single service for the customer.

Authorizations:
X-LSW-Auth
path Parameters
id
required
string
Example: 41000000000000

The ID of a service

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "billingCycle": "1 MONTH",
  • "cancellable": false,
  • "contractId": "00000110",
  • "contractTerm": "1 YEAR",
  • "contractTermEndDate": "2020-01-31T00:00:00+00:00",
  • "currency": "EUR",
  • "deliveryDate": "2019-01-01T00:00:00+00:00",
  • "deliveryEstimate": "5 - 7 business days",
  • "endDate": "2020-01-31T00:00:00+00:00",
  • "equipmentId": "12345678",
  • "id": "10000000000010",
  • "orderDate": "2019-01-01T00:00:00+00:00",
  • "pricePerFrequency": 396.01,
  • "productId": "DEDICATED_SERVER",
  • "reference": "this is a reference",
  • "startDate": "2019-01-01T00:00:00+00:00",
  • "status": "ACTIVE",
  • "uncancellable": true
}

Update a service

This endpoint allows you to update the reference of a service.

Additionally, if you're already using other product API's, you have the flexibility to modify the reference not only via this endpoint but also through their respective APIs. Please note that not all services have a corresponding product API.

Authorizations:
X-LSW-Auth
path Parameters
id
required
string
Example: 41000000000000

The ID of a service

Request Body schema: application/json
reference
string non-empty

The reference of the service

Responses

Request samples

Content type
application/json
{
  • "reference": "Awesome service reference"
}

Response samples

Content type
application/json
{
  • "billingCycle": "1 MONTH",
  • "cancellable": false,
  • "contractId": "00000110",
  • "contractTerm": "1 YEAR",
  • "contractTermEndDate": "2020-01-31T00:00:00+00:00",
  • "currency": "EUR",
  • "deliveryDate": "2019-01-01T00:00:00+00:00",
  • "deliveryEstimate": "5 - 7 business days",
  • "endDate": "2020-01-31T00:00:00+00:00",
  • "equipmentId": "12345678",
  • "id": "10000000000010",
  • "orderDate": "2019-01-01T00:00:00+00:00",
  • "pricePerFrequency": 396.01,
  • "productId": "DEDICATED_SERVER",
  • "reference": "Awesome service reference",
  • "startDate": "2019-01-01T00:00:00+00:00",
  • "status": "ACTIVE",
  • "uncancellable": true
}

Cancel a service

This endpoint will cancel a specified service.

Authorizations:
X-LSW-Auth
path Parameters
id
required
string
Example: 41000000000000

The ID of a service

Request Body schema: application/json
reason
string

If reasonCode is set to CANCEL_OTHER, this field is required and respresents the reason.

reasonCode
string

The reason code respresents a defined reason.

Responses

Request samples

Content type
application/json
{
  • "reason": "I am scaling down",
  • "reasonCode": "CANCEL_OTHER"
}

Response samples

Content type
application/json
{
  • "correlationId": "289346a1-3eaf-4da4-b707-62ef12eb08be",
  • "errorCode": "404",
  • "errorMessage": "Resource not found"
}

Uncancel a service

This endpoint will uncancel an already cancelled service.

Authorizations:
X-LSW-Auth
path Parameters
id
required
string
Example: 41000000000000

The ID of a service

Responses

Request samples

curl --request POST \
  --url https://api.leaseweb.com/services/v1/services/41000000000000/uncancel \
  --header 'X-LSW-Auth: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "correlationId": "289346a1-3eaf-4da4-b707-62ef12eb08be",
  • "errorCode": "404",
  • "errorMessage": "Resource not found"
}

Aws Ec2 Wrapper

BETA

This is the AWS compatible Public Cloud API Reference. It provides descriptions, API request parameters, and the XML response for each of the API actions that Leaseweb supports. The purpose of the AWS compatible Public Cloud API is to make the migration easy for the users to switch from the AWS EC2 to the Leaseweb Public Cloud APIs.

DescribeInstances

Describes the specified instances or all instances.

If you specify instance IDs, the output includes information for only the specified instances.

If you specify filters, the output includes information for only those instances that meet the filter criteria.

If you do not specify instance IDs or filters, the output includes information for all instances, which can affect performance. We recommend that you use pagination to ensure that the operation returns quickly and successfully.

If you specify an instance ID that is not valid, an error is returned. If you specify an instance that you do not own, it is not included in the output.

AWS CLI example

aws ec2 describe-instances --filters "Name=<FILTER_NAME>,Values=<FILTER_VALUE>" --endpoint-url <LEASEWEB_AWS_EC2_SERVER_URL>
Authorizations:
None
query Parameters
Filter.N.instance-id
string
Example: Filter.N.instance-id=29145c92-4a68-4c63-aaeb-f2212d85a74a

The ID of the instance.

Filter.N.ip-address
string
Example: Filter.N.ip-address=123.456.7.8

The public IPv4 address of the instance.

Filter.N.tag:reference
string
Example: Filter.N.tag:reference=reference

The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key reference and the value TeamA, specify tag:reference for the filter name and TeamA for the filter value.

Filter.N.instance-state-name
string
Enum: "pending" "running" "shutting-down" "terminated" "stopping" "stopped"
Example: Filter.N.instance-state-name=pending

The state of the instance.

Filter.N.instance-type
string
Example: Filter.N.instance-type=t2.micro

The type of instance. The documentation has a complete list.

Filter.N.availability-zone
string
Example: Filter.N.availability-zone=eu-west-1

The Availability Zone of the instance.

MaxResults
integer
Example: MaxResults=10

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.

NextToken
integer
Example: NextToken=1

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/aws/ec2/?Filter.N.instance-id=29145c92-4a68-4c63-aaeb-f2212d85a74a&Filter.N.ip-address=123.456.7.8&Filter.N.tag%3Areference=reference&Filter.N.instance-state-name=pending&Filter.N.instance-type=t2.micro&Filter.N.availability-zone=eu-west-1&MaxResults=10&NextToken=1&Action=DescribeInstances' \
  --header 'Authorization: REPLACE_KEY_VALUE'

Response samples

Content type
application/xml
<?xml version='1.0' encoding='UTF-8'?>
<DescribeInstancesResponse xmlns='http://ec2.amazonaws.com/doc/2016-11-15/'>
    <nextToken>1</nextToken>
    <requestId>f7f55139-53d4-4b5f-bd7f-dbeddee039c0</requestId>
    <reservationSet>
        <item>
            <reservationId></reservationId>
            <instancesSet>
                <item>
                    <instanceId>10a6163b-03c6-4303-a274-c96fa2217503</instanceId>
                    <imageId>UBUNTU_22_04_64BIT</imageId>
                    <instanceState>
                        <code>16</code>
                        <name>RUNNING</name>
                    </instanceState>
                    <amiLaunchIndex>-1</amiLaunchIndex>
                    <instanceType>lsw.m3.large</instanceType>
                    <launchTime>2024-05-07T12:02:49+0000</launchTime>
                    <placement>
                        <availabilityZone>eu-west-3</availabilityZone>
                        <groupName></groupName>
                        <tenancy></tenancy>
                    </placement>
                    <subnetId></subnetId>
                    <vpcId></vpcId>
                    <privateIpAddress></privateIpAddress>
                    <ipAddress>85.17.17.88</ipAddress>
                    <architecture>x86_64</architecture>
                    <rootDeviceType></rootDeviceType>
                    <virtualizationType></virtualizationType>
                    <tagSet>
                        <item>
                            <key>reference</key>
                            <value>test ono 3</value>
                        </item>
                    </tagSet>
                    <cpuOptions>
                        <coreCount>2</coreCount>
                        <threadsPerCore>-1</threadsPerCore>
                    </cpuOptions>
                    <networkInterfaceSet>
                        <item>
                            <networkInterfaceId></networkInterfaceId>
                            <subnetId></subnetId>
                            <vpcId></vpcId>
                            <description></description>
                            <ownerId></ownerId>
                            <status></status>
                            <macAddress></macAddress>
                            <privateIpAddress></privateIpAddress>
                            <privateDnsName></privateDnsName>
                            <sourceDestCheck></sourceDestCheck>
                            <groupSet>
                                <item>
                                    <groupId></groupId>
                                    <groupName></groupName>
                                </item>
                            </groupSet>
                            <attachment>
                                <attachmentId></attachmentId>
                                <deviceIndex>-1</deviceIndex>
                                <status></status>
                                <attachTime>2000-01-01T00:00:00+0000</attachTime>
                                <deleteOnTermination></deleteOnTermination>
                            </attachment>
                            <association>
                                <publicIp>85.17.17.88</publicIp>
                                <publicDnsName></publicDnsName>
                                <ipOwnerId></ipOwnerId>
                            </association>
                            <privateIpAddressesSet>
                                <item>
                                    <privateIpAddress></privateIpAddress>
                                    <privateDnsName></privateDnsName>
                                    <primary></primary>
                                    <association>
                                        <publicIp></publicIp>
                                        <publicDnsName></publicDnsName>
                                        <ipOwnerId></ipOwnerId>
                                    </association>
                                </item>
                            </privateIpAddressesSet>
                            <ipv6AddressesSet>
                                <item>
                                    <ipv6Address>85.17.17.88</ipv6Address>
                                </item>
                            </ipv6AddressesSet>
                        </item>
                    </networkInterfaceSet>
                </item>
            </instancesSet>
        </item>
    </reservationSet>
</DescribeInstancesResponse>

RunInstances

Launches an instance using an image for which you have permissions.

AWS CLI example

aws ec2 run-instances --image-id <IMAGE_ID> --placement AvailabilityZone=<REGION> --instance-type <INSTANCE_TYPE> --endpoint-url <LEASEWEB_AWS_EC2_SERVER_URL>
Authorizations:
None
query Parameters
InstanceType
required
string
Example: InstanceType=lsw.t2.micro

The instance type.

ImageId
required
string
Example: ImageId=UBUNTU_22_04_64BIT

The name of the image. An image is required to launch an instance and must be specified here. The documentation has a complete list.

Placement
required
string
Example: Placement=eu-west-1

The placement for the instance.

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/aws/ec2/?InstanceType=lsw.t2.micro&ImageId=UBUNTU_22_04_64BIT&Placement=eu-west-1&Action=RunInstances' \
  --header 'Authorization: REPLACE_KEY_VALUE'

Response samples

Content type
application/xml
<?xml version='1.0' encoding='UTF-8'?>
<RunInstancesResponse xmlns='http: //ec2.amazonaws.com/doc/2016-11-15/'>
    <groupSet/>
    <instancesSet>
    <item>
        <instanceId>10a6163b-03c6-4303-a274-c96fa2217503</instanceId>
        <imageId>UBUNTU_22_04_64BIT</imageId>
        <instanceState>
            <code>0</code>
            <name>CREATING</name>
        </instanceState>
        <amiLaunchIndex>-1</amiLaunchIndex>
        <instanceType>lsw.m3.large</instanceType>
        <launchTime>2024-05-07T12: 02: 49+0000</launchTime>
        <placement>
            <availabilityZone>eu-west-3</availabilityZone>
            <groupName></groupName>
            <tenancy></tenancy>
        </placement>
        <subnetId></subnetId>
        <vpcId></vpcId>
        <privateIpAddress></privateIpAddress>
        <ipAddress>85.17.17.88</ipAddress>
        <architecture>x86_64</architecture>
        <rootDeviceType></rootDeviceType>
        <virtualizationType></virtualizationType>
        <tagSet>
            <item>
                <key>reference</key>
                <value></value>
            </item>
        </tagSet>
        <cpuOptions>
            <coreCount>2</coreCount>
            <threadsPerCore>-1</threadsPerCore>
        </cpuOptions>
        <networkInterfaceSet>
            <item>
                <networkInterfaceId></networkInterfaceId>
                <subnetId></subnetId>
                <vpcId></vpcId>
                <description></description>
                <ownerId></ownerId>
                <status></status>
                <macAddress></macAddress>
                <privateIpAddress></privateIpAddress>
                <privateDnsName></privateDnsName>
                <sourceDestCheck></sourceDestCheck>
                <groupSet>
                    <item>
                        <groupId></groupId>
                        <groupName></groupName>
                    </item>
                </groupSet>
                <attachment>
                    <attachmentId></attachmentId>
                    <deviceIndex>-1</deviceIndex>
                    <status></status>
                    <attachTime>2000-01-01T00: 00: 00+0000</attachTime>
                    <deleteOnTermination></deleteOnTermination>
                </attachment>
                <association>
                    <publicIp>85.17.17.88</publicIp>
                    <publicDnsName></publicDnsName>
                    <ipOwnerId></ipOwnerId>
                </association>
                <privateIpAddressesSet>
                    <item>
                    <privateIpAddress></privateIpAddress>
                    <privateDnsName></privateDnsName>
                    <primary></primary>
                    <association>
                        <publicIp></publicIp>
                        <publicDnsName></publicDnsName>
                    <ipOwnerId></ipOwnerId>
                </association>
            </item>
                </privateIpAddressesSet>
                <ipv6AddressesSet>
                    <item/>
                </ipv6AddressesSet>
            </item>
        </networkInterfaceSet>
    </item>
    </instancesSet>
    <requesterId></requesterId>
    <requestId></requestId>
    <reservationId></reservationId>
</RunInstancesResponse>

StartInstances

Starts a Public Cloud instance that you've previously stopped.

AWS CLI example

aws ec2 start-instances --endpoint-url <LEASEWEB_AWS_EC2_SERVER_URL> --instance-ids <INSTANCE_ID>
Authorizations:
None
query Parameters
InstanceId.1
required
string
Example: InstanceId.1=29145c92-4a68-4c63-aaeb-f2212d85a74a

The instance id.

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/aws/ec2/?InstanceId.1=29145c92-4a68-4c63-aaeb-f2212d85a74a&Action=StartInstances' \
  --header 'Authorization: REPLACE_KEY_VALUE'

Response samples

Content type
application/xml
<?xml version='1.0' encoding='UTF-8'?>
<StartInstancesResponse xmlns='http: //ec2.amazonaws.com/doc/2016-11-15/'>
    <instancesSet>
        <item>
            <instanceId>10a6163b-03c6-4303-a274-c96fa2217503</instanceId>
        </item>
    </instancesSet>
    <requestId>10a6163b-03c6-4303-a274</requestId>
</StartInstancesResponse>

StopInstances

Stops a Public Cloud instance that you've previously started.

AWS CLI example

aws ec2 stop-instances --endpoint-url <LEASEWEB_AWS_EC2_SERVER_URL> --instance-ids <INSTANCE_ID>
Authorizations:
None
query Parameters
InstanceId.1
required
string
Example: InstanceId.1=29145c92-4a68-4c63-aaeb-f2212d85a74a

The instance id.

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/aws/ec2/?InstanceId.1=29145c92-4a68-4c63-aaeb-f2212d85a74a&Action=StopInstances' \
  --header 'Authorization: REPLACE_KEY_VALUE'

Response samples

Content type
application/xml
<?xml version='1.0' encoding='UTF-8'?>
<StopInstancesResponse xmlns='http: //ec2.amazonaws.com/doc/2016-11-15/'>
    <instancesSet>
        <item>
            <instanceId>10a6163b-03c6-4303-a274-c96fa2217503</instanceId>
        </item>
    </instancesSet>
    <requestId>10a6163b-03c6-4303-a274</requestId>
</StopInstancesResponse>

RebootInstances

Reboot a Public Cloud instance.

AWS CLI example

aws ec2 reboot-instances --endpoint-url <LEASEWEB_AWS_EC2_SERVER_URL> --instance-ids <INSTANCE_ID>
Authorizations:
None
query Parameters
InstanceId.1
required
string
Example: InstanceId.1=29145c92-4a68-4c63-aaeb-f2212d85a74a

The instance id.

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/aws/ec2/?InstanceId.1=29145c92-4a68-4c63-aaeb-f2212d85a74a&Action=RebootInstances' \
  --header 'Authorization: REPLACE_KEY_VALUE'

Response samples

Content type
application/xml
<?xml version='1.0' encoding='UTF-8'?>
<RebootInstancesResponse xmlns='http: //ec2.amazonaws.com/doc/2016-11-15/'>
    <return>true</return>
    <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId>
</RebootInstancesResponse>

CreateLoadBalancer

Create a load balancer, by providing the type, subnet, and a name.

AWS CLI example

aws elbv2 create-load-balancer --type <TYPE> --name <NAME> --subnets <REGION> --endpoint-url <LEASEWEB_AWS_EC2_SERVER_URL>
Authorizations:
None
query Parameters
Name
required
string
Example: Name=Test-Load-Blancer

An identifying name you can refer to the load balancer.

Type
required
string
Example: Type=lsw.m3.large

Load balancer type. The documentation has a complete list

Subnets.member.1
required
string
Example: Subnets.member.1=eu-west-3

Region to launch the load balancer into. The documentation has a complete list

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/aws/ec2/?Name=Test-Load-Blancer&Type=lsw.m3.large&Subnets.member.1=eu-west-3&Action=CreateLoadBalancer' \
  --header 'Authorization: REPLACE_KEY_VALUE'

Response samples

Content type
application/xml
<?xml version='1.0' encoding='UTF-8'?>
<CreateLoadBalancerResponse xmlns='http://elasticloadbalancing.amazonaws.com/doc/2015-12-01/'>
    <CreateLoadBalancerResult>
        <LoadBalancers>
            <member>
                <LoadBalancerArn>1ac942f4-cdd9-4c00-973f-ed82a92940cb</LoadBalancerArn>
                <LoadBalancerName>Test-Load-Blancer</LoadBalancerArn>
                <CreatedTime>2024-06-14T09:02,:31+00:00</CreatedTime>,
                <Type>lsw.m3.large</Type>
                <State>
                    <Code>provisioning</Code>
                </State>
                <AvailabilityZones>
                    <member>
                        <ZoneName>eu-west-3</ZoneName>
                    </member>
                </AvailabilityZones>
            </member>
        </LoadBalancers>
    </CreateLoadBalancerResult>
    <ResponseMetadata>
        <RequestId>8008e3fb-f671-46ab-ade4-871ca5508845</RequestId>
    </ResponseMetadata>
</CreateLoadBalancerResponse>

DescribeLoadBalancers

Describes the specified load balancer or all load balancers.

If you specify load balancer IDs, the output includes information for only the specified load balancer.

If you specify names, the output includes information for only those load balancers that meet the name criteria.

If you do not specify load balancer IDs or names, the output includes information for all load balancers, which can affect performance. We recommend that you use pagination to ensure that the operation returns quickly and successfully.

If you specify a load balancer ID that is not valid, an error is returned. If you specify a load balancer that you do not own, it is not included in the output.

AWS CLI example

aws elbv2 describe-load-balancers --load-balancer-arns <LOAD_BALANCER_ID>  --names <NAME> --endpoint-url <LEASEWEB_AWS_EC2_SERVER_URL>
Authorizations:
None
query Parameters
LoadBalancerArns.member.N
string
Example: LoadBalancerArns.member.N=29145c92-4a68-4c63-aaeb-f2212d85a74a

The ID of the load balancer.

Names.member.N
string
Example: Names.member.N=test-name

The name of the load balancer.

PageSize
integer
Example: PageSize=10

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.

Marker
integer
Example: Marker=1

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/aws/ec2/?LoadBalancerArns.member.N=29145c92-4a68-4c63-aaeb-f2212d85a74a&Names.member.N=test-name&PageSize=10&Marker=1&Action=DescribeLoadBalancers' \
  --header 'Authorization: REPLACE_KEY_VALUE'

Response samples

Content type
application/xml
<?xml version='1.0' encoding='UTF-8'?>
<DescribeLoadBalancersResponse xmlns='http://elasticloadbalancing.amazonaws.com/doc/2015-12-01/'>
    <DescribeLoadBalancersResult>
        <NextMarker>1</NextMarker>
        <LoadBalancers>
            <member>
                <LoadBalancerArn>1ac942f4-cdd9-4c00-973f-ed82a92940cb</LoadBalancerArn>
                <LoadBalancerName>Test</LoadBalancerArn>
                <CreatedTime>2024-06-14T09:02,:31+00:00</CreatedTime>,
                <Type>lsw.m3.large</Type>
                <State>
                    <Code>active</Code>
                </State>
                <AvailabilityZones>
                    <member>
                        <ZoneName>eu-west-3</ZoneName>
                    </member>
                </AvailabilityZones>
            </member>
        </LoadBalancers>
    </DescribeLoadBalancersResult>
    <ResponseMetadata>
        <RequestId>8008e3fb-f671-46ab-ade4-871ca5508845</RequestId>
    </ResponseMetadata>
</DescribeLoadBalancersResponse>

RegisterTargets

Register one/multiple instance(s) to load balancer.

AWS CLI example

aws elbv2 register-targets --target-group-arn <LOAD_BALANCER_ID> --targets Id=<INSTANCE_ID> Id=<ANOTHER_INSTANCE_ID> --endpoint-url <LEASEWEB_AWS_EC2_SERVER_URL>
Authorizations:
None
query Parameters
TargetGroupArn
required
string
Example: TargetGroupArn=29145c92-4a68-4c63-aaeb-f2212d85a74a

The ID of the load balancer.

Targets.member.N.Id
required
string
Example: Targets.member.N.Id=Targets.member.1.Id=800c43a4-8c74-4f92-9cd0-5fa883c8ca35&Targets.member.2.Id=810c43a4-8c74-4f92-9cd0-5fa883c8ca35

Instance ID(s) register to load balancer.

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/aws/ec2/?TargetGroupArn=29145c92-4a68-4c63-aaeb-f2212d85a74a&Targets.member.N.Id=Targets.member.1.Id%3D800c43a4-8c74-4f92-9cd0-5fa883c8ca35%26Targets.member.2.Id%3D810c43a4-8c74-4f92-9cd0-5fa883c8ca35&Action=RegisterTargets' \
  --header 'Authorization: REPLACE_KEY_VALUE'

Response samples

Content type
application/xml
<?xml version='1.0' encoding='UTF-8'?>
<Empty/>

CreateListener

Create a listener for a load balancer.

The Load Balancer ID is required.

The default-actions parameter is required.

The protocol and port are optional. If not specified, a listener with "HTTP" and port "80" will be created by default.

AWS CLI example

aws elbv2 create-listener --load-balancer-arn <LOAD_BALANCER_ID> --protocol <PROTOCOL> --port <PORT> --default-actions --endpoint-url <LEASEWEB_AWS_EC2_SERVER_URL>
Authorizations:
None
query Parameters
LoadBalancerArn
required
string
Example: LoadBalancerArn=29145c92-4a68-4c63-aaeb-f2212d85a74a

The ID of the load balancer.

Protocol
string
Enum: "HTTPS" "HTTP" "TCP"
Example: Protocol=HTTP

Protocol of the listener.

Port
integer
Example: Port=80

Port of the listener.

Responses

Request samples

curl --request GET \
  --url 'https://api.leaseweb.com/aws/ec2/?LoadBalancerArn=29145c92-4a68-4c63-aaeb-f2212d85a74a&Protocol=HTTP&Port=80&Action=CreateListener' \
  --header 'Authorization: REPLACE_KEY_VALUE'

Response samples

Content type
application/xml
<?xml version='1.0' encoding='UTF-8'?>
<CreateListenerResponse xmlns='http://elasticloadbalancing.amazonaws.com/doc/2015-12-01/'>
    <CreateListenerResult>
        <Listeners>
            <member>
                <LoadBalancerArn>1ac942f4-cdd9-4c00-973f-ed82a92940cb</LoadBalancerArn>
                <Protocol>HTTP</Protocol>
                <Port>80</Port>,
                <ListenerArn>2ac942f4-cdd9-4c00-973f-ed82a92940cb</ListenerArn>
            </member>
        </Listeners>
    </CreateListenerResult>
    <ResponseMetadata>
        <RequestId>8008e3fb-f671-46ab-ade4-871ca5508845</RequestId>
    </ResponseMetadata>
</CreateListenerResponse>