All URIs are relative to https://core.hivelocity.net/api/v2
| Method | HTTP request | Description |
|---|---|---|
| DeleteVlanIdResource | Delete /vlan/{vlanId} | Delete VLAN |
| GetVlanIdResource | Get /vlan/{vlanId} | Get VLAN |
| GetVlanResource | Get /vlan/ | Get all VLANs |
| PostVlanIdClearResource | Post /vlan/{vlanId}/clear | Clear all configurations on this VLAN, including Ports, IPs and associated Static Routes |
| PostVlanResource | Post /vlan/ | Create VLAN |
| PutVlanIdResource | Put /vlan/{vlanId} | Modify VLAN |
DeleteVlanIdResource(ctx, vlanId) Delete VLAN
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| vlanId | int32 | Id of the VLAN to interact with |
(empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Vlan GetVlanIdResource(ctx, vlanId, optional) Get VLAN
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| vlanId | int32 | Id of the VLAN to interact with | |
| optional | *VLANApiGetVlanIdResourceOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a VLANApiGetVlanIdResourceOpts struct
| Name | Type | Description | Notes |
|---|
xFields | optional.String| An optional fields mask |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
[]Vlan GetVlanResource(ctx, optional) Get all VLANs
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *VLANApiGetVlanResourceOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a VLANApiGetVlanResourceOpts struct
| Name | Type | Description | Notes |
|---|---|---|---|
| xFields | optional.String | An optional fields mask |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
NetworkTaskDump PostVlanIdClearResource(ctx, vlanId, optional) Clear all configurations on this VLAN, including Ports, IPs and associated Static Routes
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| vlanId | int32 | Id of the VLAN to interact with | |
| optional | *VLANApiPostVlanIdClearResourceOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a VLANApiPostVlanIdClearResourceOpts struct
| Name | Type | Description | Notes |
|---|
xFields | optional.String| An optional fields mask |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Vlan PostVlanResource(ctx, payload, optional) Create VLAN
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| payload | VlanCreate | ||
| optional | *VLANApiPostVlanResourceOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a VLANApiPostVlanResourceOpts struct
| Name | Type | Description | Notes |
|---|
xFields | optional.String| An optional fields mask |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
NetworkTaskDump PutVlanIdResource(ctx, vlanId, payload, optional) Modify VLAN
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| vlanId | int32 | Id of the VLAN to interact with | |
| payload | VlanUpdate | ||
| optional | *VLANApiPutVlanIdResourceOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a VLANApiPutVlanIdResourceOpts struct
| Name | Type | Description | Notes |
|---|
xFields | optional.String| An optional fields mask |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]