LANsApi
Last updated
Last updated
All URIs are relative to https://api.ionos.com/cloudapi/v6
Method | HTTP request | Description |
---|---|---|
Delete LANs
Other parameters are passed through a pointer to an apiDatacentersLansDeleteRequest struct via the builder pattern
(empty response body)
Content-Type: Not defined
Accept: application/json
Retrieve LANs
Other parameters are passed through a pointer to an apiDatacentersLansFindByIdRequest struct via the builder pattern
Content-Type: Not defined
Accept: application/json
List LANs
Other parameters are passed through a pointer to an apiDatacentersLansGetRequest struct via the builder pattern
Content-Type: Not defined
Accept: application/json
Retrieve attached NICs
Other parameters are passed through a pointer to an apiDatacentersLansNicsFindByIdRequest struct via the builder pattern
Content-Type: Not defined
Accept: application/json
List LAN members
Other parameters are passed through a pointer to an apiDatacentersLansNicsGetRequest struct via the builder pattern
Content-Type: Not defined
Accept: application/json
Attach NICs
Other parameters are passed through a pointer to an apiDatacentersLansNicsPostRequest struct via the builder pattern
Content-Type: application/json
Accept: application/json
Partially modify LANs
Other parameters are passed through a pointer to an apiDatacentersLansPatchRequest struct via the builder pattern
Content-Type: application/json
Accept: application/json
Create LANs
Other parameters are passed through a pointer to an apiDatacentersLansPostRequest struct via the builder pattern
Content-Type: application/json
Accept: application/json
Modify LANs
Other parameters are passed through a pointer to an apiDatacentersLansPutRequest struct via the builder pattern
Content-Type: application/json
Accept: application/json
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
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
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.
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.
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.
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.
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
datacenterId
string
The unique ID of the data center.
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]
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.
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.
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.
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]
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.
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.
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.
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.
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
datacenterId
string
The unique ID of the data center.
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.
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.
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.