LanApi
Last updated
Last updated
All URIs are relative to https://api.ionos.com/cloudapi/v5
Method | HTTP request | Description |
---|---|---|
Delete a Lan.
Other parameters are passed through a pointer to a apiDatacentersLansDeleteRequest struct via the builder pattern
map[string]interface{}
Content-Type: Not defined
Accept: application/json
Retrieve a Lan
Other parameters are passed through a pointer to a apiDatacentersLansFindByIdRequest struct via the builder pattern
Content-Type: Not defined
Accept: application/json
List Lans
Other parameters are passed through a pointer to a apiDatacentersLansGetRequest struct via the builder pattern
Content-Type: Not defined
Accept: application/json
Retrieve a nic attached to lan
Other parameters are passed through a pointer to a apiDatacentersLansNicsFindByIdRequest struct via the builder pattern
Content-Type: Not defined
Accept: application/json
List Lan Members
Other parameters are passed through a pointer to a apiDatacentersLansNicsGetRequest struct via the builder pattern
Content-Type: Not defined
Accept: application/json
Attach a nic
Other parameters are passed through a pointer to a apiDatacentersLansNicsPostRequest struct via the builder pattern
Content-Type: application/json
Accept: application/json
Partially modify a Lan
Other parameters are passed through a pointer to a apiDatacentersLansPatchRequest struct via the builder pattern
Content-Type: application/json
Accept: application/json
Create a Lan
Other parameters are passed through a pointer to a apiDatacentersLansPostRequest struct via the builder pattern
Content-Type: application/json
Accept: application/json
Modify a Lan
Other parameters are passed through a pointer to a 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 a Lan.
Get /datacenters/{datacenterId}/lans/{lanId}
Retrieve a Lan
Get /datacenters/{datacenterId}/lans
List Lans
Get /datacenters/{datacenterId}/lans/{lanId}/nics/{nicId}
Retrieve a nic attached to lan
Get /datacenters/{datacenterId}/lans/{lanId}/nics
List Lan Members
Post /datacenters/{datacenterId}/lans/{lanId}/nics
Attach a nic
Patch /datacenters/{datacenterId}/lans/{lanId}
Partially modify a Lan
Post /datacenters/{datacenterId}/lans
Create a Lan
Put /datacenters/{datacenterId}/lans/{lanId}
Modify a Lan
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
datacenterId
string
The unique ID of the datacenter
lanId
string
The unique ID of the LAN
pretty
bool
Controls whether response is pretty-printed (with indentation and new lines)
[default to true]
depth
int32
Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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 having more than 1 contract need to provide contract number, against which all API requests should be executed
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
datacenterId
string
The unique ID of the datacenter
lanId
string
The unique ID of the LAN
pretty
bool
Controls whether response is pretty-printed (with indentation and new lines)
[default to true]
depth
int32
Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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 having more than 1 contract need to provide contract number, against which all API requests should be executed
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
datacenterId
string
The unique ID of the datacenter
pretty
bool
Controls whether response is pretty-printed (with indentation and new lines)
[default to true]
depth
int32
Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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 having more than 1 contract need to provide contract number, against which all API requests should be executed
offset
int32
the first element (of the total list of elements) to include in the response (use together with <code>limit</code> for pagination)
[default to 0]
limit
int32
the maximum number of elements to return (use together with <code>offset</code> for pagination)
[default to 1000]
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
datacenterId
string
The unique ID of the datacenter
lanId
string
The unique ID of the LAN
nicId
string
The unique ID of the NIC
pretty
bool
Controls whether response is pretty-printed (with indentation and new lines)
[default to true]
depth
int32
Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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 having more than 1 contract need to provide contract number, against which all API requests should be executed
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
datacenterId
string
The unique ID of the datacenter
lanId
string
The unique ID of the LAN
pretty
bool
Controls whether response is pretty-printed (with indentation and new lines)
[default to true]
depth
int32
Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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 having more than 1 contract need to provide contract number, against which all API requests should be executed
offset
int32
the first element (of the total list of elements) to include in the response (use together with <code>limit</code> for pagination)
[default to 0]
limit
int32
the maximum number of elements to return (use together with <code>offset</code> for pagination)
[default to 1000]
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
datacenterId
string
The unique ID of the datacenter
lanId
string
The unique ID of the LAN
nic
Nic to be attached
pretty
bool
Controls whether response is pretty-printed (with indentation and new lines)
[default to true]
depth
int32
Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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 having more than 1 contract need to provide contract number, against which all API requests should be executed
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
datacenterId
string
The unique ID of the datacenter
lanId
string
The unique ID of the LAN
lan
Modified Lan
pretty
bool
Controls whether response is pretty-printed (with indentation and new lines)
[default to true]
depth
int32
Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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 having more than 1 contract need to provide contract number, against which all API requests should be executed
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
datacenterId
string
The unique ID of the datacenter
lan
Lan to be created
pretty
bool
Controls whether response is pretty-printed (with indentation and new lines)
[default to true]
depth
int32
Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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 having more than 1 contract need to provide contract number, against which all API requests should be executed
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
datacenterId
string
The unique ID of the datacenter
lanId
string
The unique ID of the LAN
lan
Modified Lan
pretty
bool
Controls whether response is pretty-printed (with indentation and new lines)
[default to true]
depth
int32
Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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 having more than 1 contract need to provide contract number, against which all API requests should be executed