api

package

Go to main page

Versions in this module

v1

v1.9.0

Feb 2, 2026

v1.8.0

Feb 11, 2025

Changes in this version

type DFUState

+ DisabledReason string

+ DownloadComplete bool

+ MinNotecardVersion string

v1.7.5

Feb 2, 2026

Changes in this version

type GetDeviceResponse

+ BestLocation *Location

v1.7.4

Nov 19, 2025

Changes in this version

+ type FleetConnectivityAssurance struct

+ Enabled bool

type FleetResponse

+ ConnectivityAssurance FleetConnectivityAssurance

v1.7.3

Oct 6, 2025

Changes in this version

+ const HubJobReconciliationMajorVersion

+ const HubJobReconciliationMinorVersion

+ const HubJobStatusCancelled

+ const HubJobStatusSubmitted

+ func IsDfuTerminal(phase note.DfuPhase) bool

+ type DeviceHealthLogEntry struct

+ Alert bool

+ Text string

+ When string

type ErrorResponse

+ func (e ErrorResponse) WithDebug(msg string) ErrorResponse

type FleetResponse

+ EnvironmentVariables map[string]string

+ SmartRule string

+ WatchdogMins int64

type GetDeviceEnvironmentVariablesResponse

+ EnvironmentVariablesEffective map[string]string

+ type GetDeviceResponse struct

+ Contact *ContactResponse

+ DFUEnv *note.DFUEnv

+ Disabled bool

+ FirmwareHost string

+ FirmwareNotecard string

+ FleetUIDs []string

+ GPSLocation *Location

+ HealthLog []DeviceHealthLogEntry

+ LastActivity *string

+ ProductUID string

+ Provisioned string

+ RecentActivityBase string

+ RecentEventCount []int

+ RecentSessionCount []int

+ RecentSessionSeconds []int

+ SKU string

+ SerialNumber string

+ Tags string

+ Temperature float64

+ TowerInfo *TowerInformation

+ TowerLocation *Location

+ TriangulatedLocation *Location

+ UID string

+ Voltage float64

+ type GetEventsResponseSelectedFields struct

+ Events []note.Event

+ HasMore bool

+ Through string

+ type HubJob struct

+ Comment string

+ Created int64

+ CreatedBy string

+ Name string

+ Type HubJobType

+ Version string

+ type HubJobReconciliation struct

+ Comment string

+ DefaultRequests HubJobReconciliationRequests

+ DeviceRequests map[string]HubJobReconciliationRequests

+ Header HubJob

+ ReportOptions HubJobReconciliationReportOptions

+ Select struct{ ... }

+ type HubJobReconciliationAppReport struct

+ Fleets *GetFleetsResponse

+ Info *GetAppResponse

+ Vars *GetAppEnvironmentVariablesResponse

+ type HubJobReconciliationDeviceReport struct

+ Info *GetDeviceResponse

+ Vars *GetDeviceEnvironmentVariablesResponse

+ type HubJobReconciliationReport struct

+ App *HubJobReconciliationAppReport

+ Devices map[string]HubJobReconciliationDeviceReport

+ type HubJobReconciliationReportOptions struct

+ AppFleets bool

+ AppInfo bool

+ AppVars bool

+ Comment string

+ DeviceActivity bool

+ DeviceHealth bool

+ DeviceInfo bool

+ DeviceVars bool

+ type HubJobReconciliationReportStatus struct

+ Actions map[string]string

+ DeviceCount int

+ Error string

+ Errors map[string]string

+ Provisioned []string

+ type HubJobReconciliationRequests struct

+ CaDisable bool

+ CaEnable bool

+ Comment string

+ Disable bool

+ Enable bool

+ FleetsToDefault []string

+ FleetsToJoin []string

+ FleetsToLeave []string

+ ProvisionProductUID string

+ SnToDefault string

+ SnToSet string

+ VarsToDefault map[string]string

+ VarsToSet map[string]string

+ type HubJobReport struct

+ Cancel bool

+ Comment string

+ Completed int64

+ DryRun bool

+ JobId string

+ JobName string

+ Started int64

+ Status string

+ Submitted int64

+ SubmittedBy string

+ Type HubJobType

+ Updated int64

+ Version string

+ type HubJobType string

+ const HubJobTypeReconciliation

+ const HubJobTypeUnspecified

+ type HubReportReconciliation struct

+ Comment string

+ Header HubJobReport

+ Report *HubJobReconciliationReport

+ Status HubJobReconciliationReportStatus

type PostFleetRequest

+ SmartRule string

+ WatchdogMins int64

type ProvisionDeviceRequest

+ FleetUIDs *[]string

type PutFleetRequest

+ SmartRule string

+ WatchdogMins int64

v1.7.2

Jun 26, 2024

Changes in this version

type DeviceResponse

+ Tags string

+ type DfuPhase string

+ const DfuPhaseCompleted

+ const DfuPhaseDownloading

+ const DfuPhaseError

+ const DfuPhaseIdle

+ const DfuPhaseReady

+ const DfuPhaseReadyRetry

+ const DfuPhaseSideloading

+ const DfuPhaseUnknown

+ const DfuPhaseUpdating

+ func ParseDfuPhase(phase string) DfuPhase

+ func (phase DfuPhase) IsTerminal() bool

v1.7.1

Apr 23, 2024

Changes in this version

type ErrorResponse

+ func ErrEventsQueryTimeout() ErrorResponse

type ProvisionDeviceRequest

+ DeviceSN string

v1.7.0

Sep 20, 2023

v1.6.11

Aug 16, 2023

Changes in this version

type DeviceResponse

+ Disabled bool

v1.6.10

Apr 19, 2023

v1.6.9

Apr 19, 2023

v1.6.8

Apr 15, 2023

v1.6.7

Apr 5, 2023

v1.6.6

Apr 4, 2023

v1.6.5

Mar 31, 2023

v1.6.4

Mar 31, 2023

v1.6.3

Mar 21, 2023

v1.6.2

Mar 8, 2023

v1.6.1

Feb 28, 2023

v1.6.0

Feb 24, 2023

v1.5.1

Feb 24, 2023

Changes in this version

+ var SuspendedBillingAccountResponse = ErrorResponse

+ type DFUEnv struct

+ Card *DFUState

+ User *DFUState

+ type DFUState struct

+ BeganSecs uint32

+ CRC32 uint32

+ ConsecutiveErrors uint32

+ File string

+ Length uint32

+ MD5 string

+ Phase string

+ ReadFromService uint32

+ RetryCount uint32

+ Status string

+ Type string

+ UpdatedSecs uint32

+ Version string

type DeviceResponse

+ DFUEnv *DFUEnv

+ SKU string

+ type GetBillingAccountResponse struct

+ Name string

+ Role string

+ UID string

+ type GetBillingAccountsResponse struct

+ BillingAccounts []GetBillingAccountResponse

type PutFleetRequest

+ AddDevices []string

+ RemoveDevices []string

v1.5.0

Mar 26, 2022

Changes in this version

+ type GenerateClientAppResponse struct

+ ClientID string

+ ClientSecret string

type GetAppResponse

+ Role *string

+ type GetEventsByCursorResponse struct

+ Events []EventResponse

+ HasMore bool

+ NextCursor string

v1.4.9

Oct 2, 2021

Changes in this version

+ type DeviceSession struct

+ Bytes uint

+ Duration uint

+ Notes uint

+ Started string

+ TowerLocation *Location

type ErrorResponse

+ func ErrMethodNotAllowed() ErrorResponse

+ type GetDeviceSessionsResponse struct

+ HasMore bool

+ Sessions []DeviceSession

v1.4.8

Aug 5, 2021

Changes in this version

+ type DeleteDeviceFleetsRequest struct

+ FleetUIDs []string

+ type DeleteDeviceFleetsResponse struct

+ Fleets []FleetResponse

+ type DevicePublicKey struct

+ PublicKey string

+ UID string

type DeviceResponse

+ FleetUIDs []string

type FleetResponse

+ Is string

+ IsLike []string

+ type GetDevicesPublicKeysResponse struct

+ DevicePublicKeys []DevicePublicKey

+ HasMore bool

+ type PostFleetRequest struct

+ Is string

+ IsLike []string

+ Label string

type PostProductRequest

+ AutoProvisionFleets []string

type PostProductResponse

+ AutoProvisionFleets *[]string

type ProductResponse

+ AutoProvisionFleets *[]string

+ type ProvisionDeviceRequest struct

+ ProductUID string

+ type PutDeviceFleetsRequest struct

+ FleetUIDs []string

+ type PutFleetRequest struct

+ Is string

+ IsLike []string

+ Label string

v1.4.7

Jul 19, 2021

v1.4.6

Jun 17, 2021

Changes in this version

+ type ContactResponse struct

+ Email string

+ Name string

+ Organization string

+ Role string

+ type DeleteAppEnvironmentVariableResponse struct

+ EnvironmentVariables map[string]string

+ type DeleteDeviceEnvironmentVariableResponse struct

+ EnvironmentVariables map[string]string

+ type DeleteFleetEnvironmentVariableResponse struct

+ EnvironmentVariables map[string]string

+ type DeviceResponse struct

+ Contact *ContactResponse

+ FleetUID string

+ GPSLocation *Location

+ LastActivity *string

+ ProductUID string

+ Provisioned string

+ SerialNumber string

+ Temperature float64

+ TowerInfo *TowerInformation

+ TowerLocation *Location

+ TriangulatedLocation *Location

+ UID string

+ Voltage float64

+ type ErrorResponse struct

+ Code int

+ Debug string

+ Details map[string]interface{}

+ Error string

+ Request string

+ Status string

+ func ErrBadRequest() ErrorResponse

+ func ErrConflict() ErrorResponse

+ func ErrForbidden() ErrorResponse

+ func ErrInternalServerError() ErrorResponse

+ func ErrNotFound() ErrorResponse

+ func ErrUnauthorized() ErrorResponse

+ func ErrUnsupportedMediaType() ErrorResponse

+ func (e ErrorResponse) WithError(err error) ErrorResponse

+ func (e ErrorResponse) WithRequest(r *http.Request) ErrorResponse

+ type EventResponse struct

+ Body *map[string]interface{}

+ Captured string

+ DeviceUID string

+ File string

+ GPSLocation *Location

+ Received string

+ TowerLocation *Location

+ UID string

+ type FleetResponse struct

+ Created string

+ Label string

+ UID string

+ type GetAppEnvironmentVariablesResponse struct

+ EnvironmentVariables map[string]string

+ type GetAppResponse struct

+ AdministrativeContact *ContactResponse

+ Created string

+ Label string

+ TechnicalContact *ContactResponse

+ UID string

+ type GetDeviceEnvironmentVariablesResponse struct

+ EnvironmentVariables map[string]string

+ EnvironmentVariablesEnvDefault map[string]string

+ type GetDeviceEnvironmentVariablesWithPINResponse struct

+ EnvironmentVariables map[string]string

+ EnvironmentVariablesEnvDefault map[string]string

+ type GetDeviceHealthLogResponse struct

+ HealthLog []HealthLogEntry

+ type GetDeviceLatestResponse struct

+ LatestEvents []LatestEvent

+ type GetDevicesResponse struct

+ Devices []DeviceResponse

+ HasMore bool

+ type GetEventsResponse struct

+ Events []EventResponse

+ HasMore bool

+ Through string

+ type GetFleetEnvironmentVariablesResponse struct

+ EnvironmentVariables map[string]string

+ type GetFleetsResponse struct

+ Fleets []FleetResponse

+ type GetProductsResponse struct

+ Products []ProductResponse

+ type HealthLogEntry struct

+ Alert bool

+ Text string

+ When string

+ type LatestEvent struct

+ Body *map[string]interface{}

+ Captured string

+ EventUID string

+ File string

+ Received string

+ type Location struct

+ Country string

+ Latitude float64

+ Longitude float64

+ Name string

+ Timezone string

+ When string

+ type PostProductRequest struct

+ AutoProvisionFleet string

+ DisableDevicesByDefault bool

+ Label string

+ ProductUID string

+ type PostProductResponse struct

+ AutoProvisionFleet *string

+ DisableDevicesByDefault bool

+ Label string

+ ProductUID string

+ type ProductResponse struct

+ AutoProvisionFleet *string

+ DisableDevicesByDefault bool

+ Label string

+ UID string

+ type PutAppEnvironmentVariablesRequest struct

+ EnvironmentVariables map[string]string

+ type PutAppEnvironmentVariablesResponse struct

+ EnvironmentVariables map[string]string

+ type PutDeviceEnvironmentVariablesRequest struct

+ EnvironmentVariables map[string]string

+ type PutDeviceEnvironmentVariablesResponse struct

+ EnvironmentVariables map[string]string

+ type PutDeviceEnvironmentVariablesWithPINRequest struct

+ EnvironmentVariables map[string]string

+ type PutDeviceEnvironmentVariablesWithPINResponse struct

+ EnvironmentVariables map[string]string

+ type PutFleetEnvironmentVariablesRequest struct

+ EnvironmentVariables map[string]string

+ type PutFleetEnvironmentVariablesResponse struct

+ EnvironmentVariables map[string]string

+ type TowerInformation struct

+ CellID int

+ LAC int

+ MCC int

+ MNC int

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL