LANsApi

All URIs are relative to https://api.ionos.com/cloudapi/v6

Method
HTTP request
Description

Delete /datacenters/{datacenterId}/lans/{lanId}

Delete LANs

Get /datacenters/{datacenterId}/lans/{lanId}

Retrieve LANs

Get /datacenters/{datacenterId}/lans

List LANs

Get /datacenters/{datacenterId}/lans/{lanId}/nics/{nicId}

Retrieve attached NICs

Get /datacenters/{datacenterId}/lans/{lanId}/nics

List LAN members

Post /datacenters/{datacenterId}/lans/{lanId}/nics

Attach NICs

Patch /datacenters/{datacenterId}/lans/{lanId}

Partially modify LANs

Post /datacenters/{datacenterId}/lans

Create LANs

Put /datacenters/{datacenterId}/lans/{lanId}

Modify LANs

DatacentersLansDelete

var result  = DatacentersLansDelete(ctx, datacenterId, lanId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Delete LANs

Example

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the data center.

lanId

string

The unique ID of the LAN.

Other Parameters

Other parameters are passed through a pointer to an apiDatacentersLansDeleteRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether the response is pretty-printed (with indentations and new lines).

[default to true]

depth

int32

Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on

[default to 0]

xContractNumber

int32

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

Return type

(empty response body)

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

DatacentersLansFindById

Retrieve LANs

Example

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the data center.

lanId

string

The unique ID of the LAN.

Other Parameters

Other parameters are passed through a pointer to an apiDatacentersLansFindByIdRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether the response is pretty-printed (with indentations and new lines).

[default to true]

depth

int32

Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on

[default to 0]

xContractNumber

int32

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

Return type

Lan

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

DatacentersLansGet

List LANs

Example

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the data center.

Other Parameters

Other parameters are passed through a pointer to an apiDatacentersLansGetRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether the response is pretty-printed (with indentations and new lines).

[default to true]

depth

int32

Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on

[default to 0]

xContractNumber

int32

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

offset

int32

The first element (from the complete list of the elements) to include in the response (used together with <b><i>limit</i></b> for pagination).

[default to 0]

limit

int32

The maximum number of elements to return (use together with offset for pagination).

[default to 1000]

Return type

Lans

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

DatacentersLansNicsFindById

Retrieve attached NICs

Example

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the data center.

lanId

string

The unique ID of the LAN.

nicId

string

The unique ID of the NIC.

Other Parameters

Other parameters are passed through a pointer to an apiDatacentersLansNicsFindByIdRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether the response is pretty-printed (with indentations and new lines).

[default to true]

depth

int32

Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on

[default to 0]

xContractNumber

int32

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

Return type

Nic

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

DatacentersLansNicsGet

List LAN members

Example

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the data center.

lanId

string

The unique ID of the LAN.

Other Parameters

Other parameters are passed through a pointer to an apiDatacentersLansNicsGetRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether the response is pretty-printed (with indentations and new lines).

[default to true]

depth

int32

Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on

[default to 0]

xContractNumber

int32

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

offset

int32

The first element (from the complete list of the elements) to include in the response (used together with <b><i>limit</i></b> for pagination).

[default to 0]

limit

int32

The maximum number of elements to return (use together with offset for pagination).

[default to 1000]

Return type

LanNics

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

DatacentersLansNicsPost

Attach NICs

Example

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the data center.

lanId

string

The unique ID of the LAN.

Other Parameters

Other parameters are passed through a pointer to an apiDatacentersLansNicsPostRequest struct via the builder pattern

Name
Type
Description
Notes

nic

The NIC to be attached.

pretty

bool

Controls whether the response is pretty-printed (with indentations and new lines).

[default to true]

depth

int32

Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on

[default to 0]

xContractNumber

int32

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

Return type

Nic

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

DatacentersLansPatch

Partially modify LANs

Example

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the data center.

lanId

string

The unique ID of the LAN.

Other Parameters

Other parameters are passed through a pointer to an apiDatacentersLansPatchRequest struct via the builder pattern

Name
Type
Description
Notes

lan

The properties of the LAN to be updated.

pretty

bool

Controls whether the response is pretty-printed (with indentations and new lines).

[default to true]

depth

int32

Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on

[default to 0]

xContractNumber

int32

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

Return type

Lan

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

DatacentersLansPost

Create LANs

Example

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the data center.

Other Parameters

Other parameters are passed through a pointer to an apiDatacentersLansPostRequest struct via the builder pattern

Name
Type
Description
Notes

lan

The LAN to create.

pretty

bool

Controls whether the response is pretty-printed (with indentations and new lines).

[default to true]

depth

int32

Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on

[default to 0]

xContractNumber

int32

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

Return type

Lan

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

DatacentersLansPut

Modify LANs

Example

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the data center.

lanId

string

The unique ID of the LAN.

Other Parameters

Other parameters are passed through a pointer to an apiDatacentersLansPutRequest struct via the builder pattern

Name
Type
Description
Notes

lan

The modified LAN

pretty

bool

Controls whether the response is pretty-printed (with indentations and new lines).

[default to true]

depth

int32

Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on

[default to 0]

xContractNumber

int32

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

Return type

Lan

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

Last updated