package
0.0.0-20230822181606-6c9a280a9428
Repository: https://github.com/kentik/dashboard-api-golang.git
Documentation: pkg.go.dev

# Functions

New creates a new devices API client.
NewBlinkDeviceLedsAccepted creates a BlinkDeviceLedsAccepted with default headers values.
NewBlinkDeviceLedsParams creates a new BlinkDeviceLedsParams object, with the default timeout for this client.
NewBlinkDeviceLedsParamsWithContext creates a new BlinkDeviceLedsParams object with the ability to set a context for a request.
NewBlinkDeviceLedsParamsWithHTTPClient creates a new BlinkDeviceLedsParams object with the ability to set a custom HTTPClient for a request.
NewBlinkDeviceLedsParamsWithTimeout creates a new BlinkDeviceLedsParams object with the ability to set a timeout on a request.
NewCreateDeviceLiveToolsPingCreated creates a CreateDeviceLiveToolsPingCreated with default headers values.
NewCreateDeviceLiveToolsPingDeviceCreated creates a CreateDeviceLiveToolsPingDeviceCreated with default headers values.
NewCreateDeviceLiveToolsPingDeviceParams creates a new CreateDeviceLiveToolsPingDeviceParams object, with the default timeout for this client.
NewCreateDeviceLiveToolsPingDeviceParamsWithContext creates a new CreateDeviceLiveToolsPingDeviceParams object with the ability to set a context for a request.
NewCreateDeviceLiveToolsPingDeviceParamsWithHTTPClient creates a new CreateDeviceLiveToolsPingDeviceParams object with the ability to set a custom HTTPClient for a request.
NewCreateDeviceLiveToolsPingDeviceParamsWithTimeout creates a new CreateDeviceLiveToolsPingDeviceParams object with the ability to set a timeout on a request.
NewCreateDeviceLiveToolsPingParams creates a new CreateDeviceLiveToolsPingParams object, with the default timeout for this client.
NewCreateDeviceLiveToolsPingParamsWithContext creates a new CreateDeviceLiveToolsPingParams object with the ability to set a context for a request.
NewCreateDeviceLiveToolsPingParamsWithHTTPClient creates a new CreateDeviceLiveToolsPingParams object with the ability to set a custom HTTPClient for a request.
NewCreateDeviceLiveToolsPingParamsWithTimeout creates a new CreateDeviceLiveToolsPingParams object with the ability to set a timeout on a request.
NewGetDeviceCellularSimsOK creates a GetDeviceCellularSimsOK with default headers values.
NewGetDeviceCellularSimsParams creates a new GetDeviceCellularSimsParams object, with the default timeout for this client.
NewGetDeviceCellularSimsParamsWithContext creates a new GetDeviceCellularSimsParams object with the ability to set a context for a request.
NewGetDeviceCellularSimsParamsWithHTTPClient creates a new GetDeviceCellularSimsParams object with the ability to set a custom HTTPClient for a request.
NewGetDeviceCellularSimsParamsWithTimeout creates a new GetDeviceCellularSimsParams object with the ability to set a timeout on a request.
NewGetDeviceClientsOK creates a GetDeviceClientsOK with default headers values.
NewGetDeviceClientsParams creates a new GetDeviceClientsParams object, with the default timeout for this client.
NewGetDeviceClientsParamsWithContext creates a new GetDeviceClientsParams object with the ability to set a context for a request.
NewGetDeviceClientsParamsWithHTTPClient creates a new GetDeviceClientsParams object with the ability to set a custom HTTPClient for a request.
NewGetDeviceClientsParamsWithTimeout creates a new GetDeviceClientsParams object with the ability to set a timeout on a request.
NewGetDeviceLiveToolsPingDeviceOK creates a GetDeviceLiveToolsPingDeviceOK with default headers values.
NewGetDeviceLiveToolsPingDeviceParams creates a new GetDeviceLiveToolsPingDeviceParams object, with the default timeout for this client.
NewGetDeviceLiveToolsPingDeviceParamsWithContext creates a new GetDeviceLiveToolsPingDeviceParams object with the ability to set a context for a request.
NewGetDeviceLiveToolsPingDeviceParamsWithHTTPClient creates a new GetDeviceLiveToolsPingDeviceParams object with the ability to set a custom HTTPClient for a request.
NewGetDeviceLiveToolsPingDeviceParamsWithTimeout creates a new GetDeviceLiveToolsPingDeviceParams object with the ability to set a timeout on a request.
NewGetDeviceLiveToolsPingOK creates a GetDeviceLiveToolsPingOK with default headers values.
NewGetDeviceLiveToolsPingParams creates a new GetDeviceLiveToolsPingParams object, with the default timeout for this client.
NewGetDeviceLiveToolsPingParamsWithContext creates a new GetDeviceLiveToolsPingParams object with the ability to set a context for a request.
NewGetDeviceLiveToolsPingParamsWithHTTPClient creates a new GetDeviceLiveToolsPingParams object with the ability to set a custom HTTPClient for a request.
NewGetDeviceLiveToolsPingParamsWithTimeout creates a new GetDeviceLiveToolsPingParams object with the ability to set a timeout on a request.
NewGetDeviceLldpCdpOK creates a GetDeviceLldpCdpOK with default headers values.
NewGetDeviceLldpCdpParams creates a new GetDeviceLldpCdpParams object, with the default timeout for this client.
NewGetDeviceLldpCdpParamsWithContext creates a new GetDeviceLldpCdpParams object with the ability to set a context for a request.
NewGetDeviceLldpCdpParamsWithHTTPClient creates a new GetDeviceLldpCdpParams object with the ability to set a custom HTTPClient for a request.
NewGetDeviceLldpCdpParamsWithTimeout creates a new GetDeviceLldpCdpParams object with the ability to set a timeout on a request.
NewGetDeviceLossAndLatencyHistoryOK creates a GetDeviceLossAndLatencyHistoryOK with default headers values.
NewGetDeviceLossAndLatencyHistoryParams creates a new GetDeviceLossAndLatencyHistoryParams object, with the default timeout for this client.
NewGetDeviceLossAndLatencyHistoryParamsWithContext creates a new GetDeviceLossAndLatencyHistoryParams object with the ability to set a context for a request.
NewGetDeviceLossAndLatencyHistoryParamsWithHTTPClient creates a new GetDeviceLossAndLatencyHistoryParams object with the ability to set a custom HTTPClient for a request.
NewGetDeviceLossAndLatencyHistoryParamsWithTimeout creates a new GetDeviceLossAndLatencyHistoryParams object with the ability to set a timeout on a request.
NewGetDeviceManagementInterfaceOK creates a GetDeviceManagementInterfaceOK with default headers values.
NewGetDeviceManagementInterfaceParams creates a new GetDeviceManagementInterfaceParams object, with the default timeout for this client.
NewGetDeviceManagementInterfaceParamsWithContext creates a new GetDeviceManagementInterfaceParams object with the ability to set a context for a request.
NewGetDeviceManagementInterfaceParamsWithHTTPClient creates a new GetDeviceManagementInterfaceParams object with the ability to set a custom HTTPClient for a request.
NewGetDeviceManagementInterfaceParamsWithTimeout creates a new GetDeviceManagementInterfaceParams object with the ability to set a timeout on a request.
NewGetDeviceOK creates a GetDeviceOK with default headers values.
NewGetDeviceParams creates a new GetDeviceParams object, with the default timeout for this client.
NewGetDeviceParamsWithContext creates a new GetDeviceParams object with the ability to set a context for a request.
NewGetDeviceParamsWithHTTPClient creates a new GetDeviceParams object with the ability to set a custom HTTPClient for a request.
NewGetDeviceParamsWithTimeout creates a new GetDeviceParams object with the ability to set a timeout on a request.
NewRebootDeviceAccepted creates a RebootDeviceAccepted with default headers values.
NewRebootDeviceParams creates a new RebootDeviceParams object, with the default timeout for this client.
NewRebootDeviceParamsWithContext creates a new RebootDeviceParams object with the ability to set a context for a request.
NewRebootDeviceParamsWithHTTPClient creates a new RebootDeviceParams object with the ability to set a custom HTTPClient for a request.
NewRebootDeviceParamsWithTimeout creates a new RebootDeviceParams object with the ability to set a timeout on a request.
NewUpdateDeviceCellularSimsOK creates a UpdateDeviceCellularSimsOK with default headers values.
NewUpdateDeviceCellularSimsParams creates a new UpdateDeviceCellularSimsParams object, with the default timeout for this client.
NewUpdateDeviceCellularSimsParamsWithContext creates a new UpdateDeviceCellularSimsParams object with the ability to set a context for a request.
NewUpdateDeviceCellularSimsParamsWithHTTPClient creates a new UpdateDeviceCellularSimsParams object with the ability to set a custom HTTPClient for a request.
NewUpdateDeviceCellularSimsParamsWithTimeout creates a new UpdateDeviceCellularSimsParams object with the ability to set a timeout on a request.
NewUpdateDeviceManagementInterfaceOK creates a UpdateDeviceManagementInterfaceOK with default headers values.
NewUpdateDeviceManagementInterfaceParams creates a new UpdateDeviceManagementInterfaceParams object, with the default timeout for this client.
NewUpdateDeviceManagementInterfaceParamsWithContext creates a new UpdateDeviceManagementInterfaceParams object with the ability to set a context for a request.
NewUpdateDeviceManagementInterfaceParamsWithHTTPClient creates a new UpdateDeviceManagementInterfaceParams object with the ability to set a custom HTTPClient for a request.
NewUpdateDeviceManagementInterfaceParamsWithTimeout creates a new UpdateDeviceManagementInterfaceParams object with the ability to set a timeout on a request.
NewUpdateDeviceOK creates a UpdateDeviceOK with default headers values.
NewUpdateDeviceParams creates a new UpdateDeviceParams object, with the default timeout for this client.
NewUpdateDeviceParamsWithContext creates a new UpdateDeviceParams object with the ability to set a context for a request.
NewUpdateDeviceParamsWithHTTPClient creates a new UpdateDeviceParams object with the ability to set a custom HTTPClient for a request.
NewUpdateDeviceParamsWithTimeout creates a new UpdateDeviceParams object with the ability to set a timeout on a request.

# Constants

UpdateDeviceCellularSimsParamsBodySimsItems0ApnsItems0AuthenticationTypeChap captures enum value "chap".
UpdateDeviceCellularSimsParamsBodySimsItems0ApnsItems0AuthenticationTypeNone captures enum value "none".
UpdateDeviceCellularSimsParamsBodySimsItems0ApnsItems0AuthenticationTypePap captures enum value "pap".
UpdateDeviceCellularSimsParamsBodySimsItems0SlotSim1 captures enum value "sim1".
UpdateDeviceCellularSimsParamsBodySimsItems0SlotSim2 captures enum value "sim2".
UpdateDeviceManagementInterfaceParamsBodyWan1WanEnabledDisabled captures enum value "disabled".
UpdateDeviceManagementInterfaceParamsBodyWan1WanEnabledEnabled captures enum value "enabled".
UpdateDeviceManagementInterfaceParamsBodyWan1WanEnabledNotConfigured captures enum value "not configured".
UpdateDeviceManagementInterfaceParamsBodyWan2WanEnabledDisabled captures enum value "disabled".
UpdateDeviceManagementInterfaceParamsBodyWan2WanEnabledEnabled captures enum value "enabled".
UpdateDeviceManagementInterfaceParamsBodyWan2WanEnabledNotConfigured captures enum value "not configured".

# Structs

BlinkDeviceLedsAccepted describes a response with status code 202, with default header values.
BlinkDeviceLedsAcceptedBody blink device leds accepted body swagger:model BlinkDeviceLedsAcceptedBody */.
BlinkDeviceLedsBody blink device leds body // Example: {"duration":20,"duty":50,"period":160} swagger:model BlinkDeviceLedsBody */.
BlinkDeviceLedsParams contains all the parameters to send to the API endpoint for the blink device leds operation.
BlinkDeviceLedsReader is a Reader for the BlinkDeviceLeds structure.
Client for devices API */.
CreateDeviceLiveToolsPingBody create device live tools ping body // Example: {"count":2,"target":"75.75.75.75"} swagger:model CreateDeviceLiveToolsPingBody */.
CreateDeviceLiveToolsPingCreated describes a response with status code 201, with default header values.
CreateDeviceLiveToolsPingCreatedBody create device live tools ping created body swagger:model CreateDeviceLiveToolsPingCreatedBody */.
CreateDeviceLiveToolsPingCreatedBodyRequest Ping request parameters swagger:model CreateDeviceLiveToolsPingCreatedBodyRequest */.
CreateDeviceLiveToolsPingDeviceBody create device live tools ping device body // Example: {"count":3} swagger:model CreateDeviceLiveToolsPingDeviceBody */.
CreateDeviceLiveToolsPingDeviceCreated describes a response with status code 201, with default header values.
CreateDeviceLiveToolsPingDeviceCreatedBody create device live tools ping device created body swagger:model CreateDeviceLiveToolsPingDeviceCreatedBody */.
CreateDeviceLiveToolsPingDeviceCreatedBodyRequest Ping request parameters swagger:model CreateDeviceLiveToolsPingDeviceCreatedBodyRequest */.
CreateDeviceLiveToolsPingDeviceParams contains all the parameters to send to the API endpoint for the create device live tools ping device operation.
CreateDeviceLiveToolsPingDeviceReader is a Reader for the CreateDeviceLiveToolsPingDevice structure.
CreateDeviceLiveToolsPingParams contains all the parameters to send to the API endpoint for the create device live tools ping operation.
CreateDeviceLiveToolsPingReader is a Reader for the CreateDeviceLiveToolsPing structure.
GetDeviceCellularSimsOK describes a response with status code 200, with default header values.
GetDeviceCellularSimsParams contains all the parameters to send to the API endpoint for the get device cellular sims operation.
GetDeviceCellularSimsReader is a Reader for the GetDeviceCellularSims structure.
GetDeviceClientsOK describes a response with status code 200, with default header values.
GetDeviceClientsParams contains all the parameters to send to the API endpoint for the get device clients operation.
GetDeviceClientsReader is a Reader for the GetDeviceClients structure.
GetDeviceLiveToolsPingDeviceOK describes a response with status code 200, with default header values.
GetDeviceLiveToolsPingDeviceOKBody get device live tools ping device o k body swagger:model GetDeviceLiveToolsPingDeviceOKBody */.
GetDeviceLiveToolsPingDeviceOKBodyRequest Ping request parameters swagger:model GetDeviceLiveToolsPingDeviceOKBodyRequest */.
GetDeviceLiveToolsPingDeviceOKBodyResults Results of the ping request.
GetDeviceLiveToolsPingDeviceOKBodyResultsLatencies Packet latency stats swagger:model GetDeviceLiveToolsPingDeviceOKBodyResultsLatencies */.
GetDeviceLiveToolsPingDeviceOKBodyResultsLoss Lost packets swagger:model GetDeviceLiveToolsPingDeviceOKBodyResultsLoss */.
GetDeviceLiveToolsPingDeviceOKBodyResultsRepliesItems0 get device live tools ping device o k body results replies items0 swagger:model GetDeviceLiveToolsPingDeviceOKBodyResultsRepliesItems0 */.
GetDeviceLiveToolsPingDeviceParams contains all the parameters to send to the API endpoint for the get device live tools ping device operation.
GetDeviceLiveToolsPingDeviceReader is a Reader for the GetDeviceLiveToolsPingDevice structure.
GetDeviceLiveToolsPingOK describes a response with status code 200, with default header values.
GetDeviceLiveToolsPingOKBody get device live tools ping o k body swagger:model GetDeviceLiveToolsPingOKBody */.
GetDeviceLiveToolsPingOKBodyRequest Ping request parameters swagger:model GetDeviceLiveToolsPingOKBodyRequest */.
GetDeviceLiveToolsPingOKBodyResults Results of the ping request.
GetDeviceLiveToolsPingOKBodyResultsLatencies Packet latency stats swagger:model GetDeviceLiveToolsPingOKBodyResultsLatencies */.
GetDeviceLiveToolsPingOKBodyResultsLoss Lost packets swagger:model GetDeviceLiveToolsPingOKBodyResultsLoss */.
GetDeviceLiveToolsPingOKBodyResultsRepliesItems0 get device live tools ping o k body results replies items0 swagger:model GetDeviceLiveToolsPingOKBodyResultsRepliesItems0 */.
GetDeviceLiveToolsPingParams contains all the parameters to send to the API endpoint for the get device live tools ping operation.
GetDeviceLiveToolsPingReader is a Reader for the GetDeviceLiveToolsPing structure.
GetDeviceLldpCdpOK describes a response with status code 200, with default header values.
GetDeviceLldpCdpParams contains all the parameters to send to the API endpoint for the get device lldp cdp operation.
GetDeviceLldpCdpReader is a Reader for the GetDeviceLldpCdp structure.
GetDeviceLossAndLatencyHistoryOK describes a response with status code 200, with default header values.
GetDeviceLossAndLatencyHistoryParams contains all the parameters to send to the API endpoint for the get device loss and latency history operation.
GetDeviceLossAndLatencyHistoryReader is a Reader for the GetDeviceLossAndLatencyHistory structure.
GetDeviceManagementInterfaceOK describes a response with status code 200, with default header values.
GetDeviceManagementInterfaceParams contains all the parameters to send to the API endpoint for the get device management interface operation.
GetDeviceManagementInterfaceReader is a Reader for the GetDeviceManagementInterface structure.
GetDeviceOK describes a response with status code 200, with default header values.
GetDeviceParams contains all the parameters to send to the API endpoint for the get device operation.
GetDeviceReader is a Reader for the GetDevice structure.
RebootDeviceAccepted describes a response with status code 202, with default header values.
RebootDeviceAcceptedBody reboot device accepted body swagger:model RebootDeviceAcceptedBody */.
RebootDeviceParams contains all the parameters to send to the API endpoint for the reboot device operation.
RebootDeviceReader is a Reader for the RebootDevice structure.
UpdateDeviceBody update device body // Example: {"lat":37.4180951010362,"lng":-122.098531723022,"mac":"00:11:22:33:44:55","name":"My AP","serial":"Q234-ABCD-5678","tags":["recently-added"]} swagger:model UpdateDeviceBody */.
UpdateDeviceCellularSimsBody update device cellular sims body // Example: {"apns":[{"allowedIpTypes":["ipv4","ipv6"],"authentication":{"password":"secret","type":"pap","username":"milesmeraki"},"name":"internet"}],"isPrimary":true,"slot":"sim1"} swagger:model UpdateDeviceCellularSimsBody */.
UpdateDeviceCellularSimsOK describes a response with status code 200, with default header values.
UpdateDeviceCellularSimsParams contains all the parameters to send to the API endpoint for the update device cellular sims operation.
UpdateDeviceCellularSimsParamsBodySimFailover SIM Failover settings.
UpdateDeviceCellularSimsParamsBodySimsItems0 update device cellular sims params body sims items0 swagger:model UpdateDeviceCellularSimsParamsBodySimsItems0 */.
UpdateDeviceCellularSimsParamsBodySimsItems0ApnsItems0 update device cellular sims params body sims items0 apns items0 swagger:model UpdateDeviceCellularSimsParamsBodySimsItems0ApnsItems0 */.
UpdateDeviceCellularSimsParamsBodySimsItems0ApnsItems0Authentication APN authentication configurations.
UpdateDeviceCellularSimsReader is a Reader for the UpdateDeviceCellularSims structure.
UpdateDeviceManagementInterfaceBody update device management interface body // Example: {"wan1":{"staticDns":["1.2.3.2","1.2.3.3"],"staticGatewayIp":"1.2.3.1","staticIp":"1.2.3.4","staticSubnetMask":"255.255.255.0","usingStaticIp":true,"vlan":7,"wanEnabled":"not configured"},"wan2":{"usingStaticIp":false,"vlan":2,"wanEnabled":"enabled"}} swagger:model UpdateDeviceManagementInterfaceBody */.
UpdateDeviceManagementInterfaceOK describes a response with status code 200, with default header values.
UpdateDeviceManagementInterfaceParams contains all the parameters to send to the API endpoint for the update device management interface operation.
UpdateDeviceManagementInterfaceParamsBodyWan1 WAN 1 settings swagger:model UpdateDeviceManagementInterfaceParamsBodyWan1 */.
UpdateDeviceManagementInterfaceParamsBodyWan2 WAN 2 settings (only for MX devices) swagger:model UpdateDeviceManagementInterfaceParamsBodyWan2 */.
UpdateDeviceManagementInterfaceReader is a Reader for the UpdateDeviceManagementInterface structure.
UpdateDeviceOK describes a response with status code 200, with default header values.
UpdateDeviceParams contains all the parameters to send to the API endpoint for the update device operation.
UpdateDeviceReader is a Reader for the UpdateDevice structure.

# Interfaces

ClientService is the interface for Client methods.

# Type aliases

ClientOption is the option for Client methods.