api

package
v0.5.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 15, 2021 License: GPL-3.0 Imports: 0 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AllowlistCIDR added in v0.5.0 

type AllowlistCIDR struct {
	Cidr        string `json:"cidr"`
	Description string `json:"description"`
}

type AppDetails added in v0.5.0 

type AppDetails struct {
	AppDefinition appDefinition `json:"appDefinition"`
	AppManifest   appManifest   `json:"appManifest"`
}

type CollectorResponse 

type CollectorResponse struct {
	Collector CollectorsResponse `json:"collector"`
}

type Collectors 

type Collectors struct {
	Data []CollectorsResponse `json:"collectors"`
}

type CollectorsResponse 

type CollectorsResponse struct {
	Alive              bool              `json:"alive"`
	Category           string            `json:"category,omitempty"`
	CollectorType      string            `json:"collectorType"`
	CollectorVersion   string            `json:"collectorVersion"`
	CutoffRelativeTime string            `json:"cutoffRelativeTime,omitempty"`
	CutoffTimestamp    int               `json:"cutoffTimestamp,omitempty"`
	Description        string            `json:"description,omitempty"`
	Ephemeral          bool              `json:"ephemeral"`
	Fields             map[string]string `json:"fields,omitempty"`
	Links              []collectorLinks  `json:"links,omitempty"`
	HostName           string            `json:"hostName,omitempty"`
	Id                 int               `json:"id"`
	LastSeenAlive      int               `json:"lastSeenAlive,omitempty"`
	Name               string            `json:"name"`
	SourceSyncMode     string            `json:"sourceSyncMode,omitempty"`
	TimeZone           string            `json:"timeZone,omitempty"`
	TargetCpu          int               `json:"targetCpu,omitempty"`
	OsName             string            `json:"osName,omitempty"`
	OsVersion          string            `json:"osVersion,omitempty"`
	OsArch             string            `json:"osArch,omitempty"`
	OsTime             int               `json:"osTime,omitempty"`
}

type CreateAccessKeysRequest added in v0.5.0 

type CreateAccessKeysRequest struct {
	Label       string   `json:"label"`
	CorsHeaders []string `json:"corsHeaders"`
}

type CreateCollector 

type CreateCollector struct {
	CollectorType string            `json:"collectorType"`
	Name          string            `json:"name"`
	Description   string            `json:"description,omitempty"`
	Category      string            `json:"category,omitempty"`
	Fields        map[string]string `json:"fields,omitempty"`
}

type CreateCollectorRequest 

type CreateCollectorRequest struct {
	Collector CreateCollector `json:"collector"`
}

type CreateDashboard added in v0.5.0 

type CreateDashboard struct {
	Title            string                    `json:"title"`
	Description      string                    `json:"description"`
	FolderId         string                    `json:"folderId"`
	TopologyLabelMap topologyLabelMap          `json:"topologyLabelMap"`
	Domain           string                    `json:"domain"`
	RefreshInterval  int                       `json:"refreshInterval"`
	TimeRange        timeRangeDefinition       `json:"timeRange"`
	Panels           []panelsDefinition        `json:"panels"`
	Layout           layout                    `json:"layout"`
	Variables        []variablesDefinition     `json:"variables"`
	Theme            string                    `json:"theme"`
	ColoringRules    []coloringRulesDefinition `json:"coloringRules"`
}

type CreateFolderRequest added in v0.5.0 

type CreateFolderRequest struct {
	Name        string `json:"name"`
	Description string `json:"description"`
	ParentId    string `json:"parentId"`
}

type CreateHTTPSource 

type CreateHTTPSource struct {
	ApiVersion string     `json:"api.version"`
	Source     HttpSource `json:"source"`
}

type CreateLookupTableRequest added in v0.5.0 

type CreateLookupTableRequest struct {
	Description     string              `json:"description"`
	Fields          []LookupTableFields `json:"fields"`
	PrimaryKeys     []string            `json:"primaryKeys"`
	Ttl             int                 `json:"ttl"`
	SizeLimitAction string              `json:"sizeLimitAction"`
	Name            string              `json:"name"`
	ParentFolderId  string              `json:"parentFolderId"`
}

type CreateRoleRequest 

type CreateRoleRequest struct {
	Name                 string   `json:"name"`
	Description          string   `json:"description,omitempty"`
	FilterPredicate      string   `json:"filterPredicate,omitempty"`
	Users                []string `json:"users,omitempty"`
	Capabilities         []string `json:"capabilities,omitempty"`
	AutoFillDependencies bool     `json:"autoFillDependencies,omitempty"`
}

type CreateSourceResponse 

type CreateSourceResponse struct {
	Source SourcesResponse `json:"source"`
}

type CreateTokenRequest added in v0.5.0 

type CreateTokenRequest struct {
	Name        string `json:"name"`
	Description string `json:"description"`
	Status      string `json:"status"`
	Type        string `json:"type"`
}

type CreateUserRequest 

type CreateUserRequest struct {
	Firstname    string   `json:"firstName"`
	Lastname     string   `json:"lastName"`
	Emailaddress string   `json:"email"`
	Roleids      []string `json:"roleIds"`
}

type DashboardSyncDefinition added in v0.4.0 

type DashboardSyncDefinition struct {
	Type        string                      `json:"type"`
	Name        string                      `json:"name"`
	Description string                      `json:"description"`
	DetailLevel int                         `json:"detailLevel"`
	Properties  string                      `json:"properties"`
	Panels      []reportPanelSyncDefinition `json:"panels"`
	Filters     []filtersSyncDefinition     `json:"filters"`
}

type DataSourceValue added in v0.5.0 

type DataSourceValue struct {
	LogSrc string `json:"logsrc"`
}

type DisableUserMfa 

type DisableUserMfa struct {
	Email    string `json:"email"`
	Password string `json:"password"`
}

type EditLookupTable added in v0.5.0 

type EditLookupTable struct {
	Description     string `json:"description"`
	Ttl             int    `json:"ttl"`
	SizeLimitAction string `json:"sizeLimitAction"`
}

type Errors 

type Errors struct {
	Code    string `json:"code"`
	Message string `json:"message"`
}

type ExportStatusResponse added in v0.4.0 

type ExportStatusResponse struct {
	Status        string      `json:"status"`
	StatusMessage string      `json:"statusMessage,omitempty"`
	Error         exportError `json:"error,omitempty"`
}

type FolderResponse added in v0.5.0 

type FolderResponse struct {
	CreatedAt   string           `json:"createdAt"`
	CreatedBy   string           `json:"createdBy"`
	ModifiedAt  string           `json:"modifiedAt"`
	ModifiedBy  string           `json:"modifiedBy"`
	Id          string           `json:"id"`
	Name        string           `json:"name"`
	ItemType    string           `json:"itemType"`
	ParentId    string           `json:"parentId"`
	Permissions []string         `json:"permissions"`
	Description string           `json:"description"`
	Children    []folderChildren `json:"children"`
}

type FolderSyncDefinition added in v0.4.0 

type FolderSyncDefinition struct {
	Type        string                  `json:"type"`
	Name        string                  `json:"name"`
	Description string                  `json:"description"`
	Children    []contentSyncDefinition `json:"children"`
}

type GetAccessKeysResponse added in v0.5.0 

type GetAccessKeysResponse struct {
	Id          string   `json:"id"`
	Label       string   `json:"label"`
	CorsHeaders []string `json:"corsHeaders"`
	Disabled    bool     `json:"disabled"`
	CreatedAt   string   `json:"createdAt"`
	CreatedBy   string   `json:"createdBy"`
	ModifiedAt  string   `json:"modifiedAt"`
}

type GetAllowlistStatus added in v0.5.0 

type GetAllowlistStatus struct {
	ContentEnabled bool `json:"contentEnabled"`
	LoginEnabled   bool `json:"loginEnabled"`
}

type GetContentResponse added in v0.4.0 

type GetContentResponse struct {
	CreatedAt   string   `json:"createdAt"`
	CreatedBy   string   `json:"createdBy"`
	ModifiedAt  string   `json:"modifiedAt"`
	ModifiedBy  string   `json:"modifiedBy"`
	Id          string   `json:"id"`
	Name        string   `json:"name"`
	ItemType    string   `json:"itemType"`
	ParentId    string   `json:"parentId"`
	Permissions []string `json:"permissions"`
}

type GetDashboard added in v0.5.0 

type GetDashboard struct {
	Title            string                    `json:"title"`
	Description      string                    `json:"description"`
	FolderId         string                    `json:"folderId"`
	TopologyLabelMap topologyLabelMap          `json:"topologyLabelMap"`
	Domain           string                    `json:"domain"`
	RefreshInterval  int                       `json:"refreshInterval"`
	TimeRange        timeRangeDefinition       `json:"timeRange"`
	Panels           []panelsDefinition        `json:"panels"`
	Layout           layout                    `json:"layout"`
	Variables        []variablesDefinition     `json:"variables"`
	Theme            string                    `json:"theme"`
	ColoringRules    []coloringRulesDefinition `json:"coloringRules"`
	Id               string                    `json:"id"`
}

type GetPathResponse added in v0.4.0 

type GetPathResponse struct {
	Path string `json:"path"`
}

type GetPermissions added in v0.5.0 

type GetPermissions struct {
	ExplicitPermissions []PermissionsDetail `json:"explicitPermissions"`
	ImplicitPermissions []PermissionsDetail `json:"implicitPermissions"`
}

type GetSourcesResponse 

type GetSourcesResponse struct {
	Id                         int             `json:"id"`
	Name                       string          `json:"name"`
	Category                   string          `json:"category"`
	HostName                   string          `json:"hostName"`
	AutomaticDateParsing       bool            `json:"automaticDateParsing"`
	MultilineProcessingEnabled bool            `json:"multilineProcessingEnabled"`
	UseAutolineMatching        bool            `json:"useAutolineMatching"`
	ForceTimeZone              bool            `json:"forceTimeZone"`
	Filters                    []sourceFilters `json:"filters"`
	CutoffTimestamp            int             `json:"cutoffTimestamp"`
	Encoding                   string          `json:"encoding"`
	PathExpression             string          `json:"pathExpression"`
	Blacklist                  []string        `json:"blacklist"`
	SourceType                 string          `json:"sourceType"`
	Alive                      bool            `json:"alive"`
}

type GetTokenResponse added in v0.5.0 

type GetTokenResponse struct {
	Id                 string `json:"id"`
	Name               string `json:"name"`
	Description        string `json:"description"`
	Status             string `json:"status"`
	Type               string `json:"type"`
	Version            int    `json:"version"`
	CreatedAt          string `json:"createdAt"`
	CreatedBy          string `json:"createdBy"`
	ModifiedAt         string `json:"modifiedAt"`
	ModifiedBy         string `json:"modifiedBy"`
	EncodedTokenAndUrl string `json:"encodedTokenAndUrl"`
}

type GlobalFolderResponse added in v0.5.0 

type GlobalFolderResponse struct {
	Id string `json:"id"`
}

type GlobalFolderResultResponse added in v0.5.0 

type GlobalFolderResultResponse struct {
	Data []folderChildren `json:"data"`
}

type GlobalFolderStatusRequest added in v0.5.0 

type GlobalFolderStatusRequest struct {
	JobId string `json:"jobId"`
}

type GlobalFolderStatusResponse added in v0.5.0 

type GlobalFolderStatusResponse struct {
	Status        string `json:"status"`
	StatusMessage string `json:"statusMessage"`
}

type HttpSource 

type HttpSource struct {
	SourceType                 string            `json:"sourceType"`
	Name                       string            `json:"name"`
	Category                   string            `json:"category"`
	Fields                     map[string]string `json:"fields"`
	MessagePerRequest          bool              `json:"messagePerRequest"`
	MultilineProcessingEnabled bool              `json:"multilineProcessingEnabled"`
}

type InstallAppRequest added in v0.5.0 

type InstallAppRequest struct {
	Name                string          `json:"name"`
	Description         string          `json:"description"`
	DestinationFolderId string          `json:"destinationFolderId"`
	DataSourceValues    DataSourceValue `json:"dataSourceValues"`
}

type InstallAppResponse added in v0.5.0 

type InstallAppResponse struct {
	Id string `json:"id"`
}

type InstallStatusResponse added in v0.5.0 

type InstallStatusResponse struct {
	Status        string `json:"status"`
	StatusMessage string `json:"statusMessage"`
}

type ListAccessKeysResponse added in v0.5.0 

type ListAccessKeysResponse struct {
	Data []GetAccessKeysResponse `json:"data"`
}

type ListApps added in v0.5.0 

type ListApps struct {
	Apps []AppDetails `json:"apps"`
}

type ListServiceAllowlist added in v0.5.0 

type ListServiceAllowlist struct {
	Data []AllowlistCIDR `json:"data"`
}

type ListSources 

type ListSources struct {
	Sources []GetSourcesResponse `json:"sources"`
}

type ListTokenResponse added in v0.5.0 

type ListTokenResponse struct {
	Data []GetTokenResponse `json:"data"`
}

type LookupTableFields added in v0.5.0 

type LookupTableFields struct {
	FieldName string `json:"fieldName"`
	FieldType string `json:"fieldType"`
}

type LookupTableRemoveRowRequest added in v0.5.0 

type LookupTableRemoveRowRequest struct {
	PrimaryKey []LookupTableRow `json:"primaryKey"`
}

type LookupTableRequestId added in v0.5.0 

type LookupTableRequestId struct {
	Id string `json:"id"`
}

type LookupTableResponse added in v0.5.0 

type LookupTableResponse struct {
	CreatedAt       string              `json:"createdAt"`
	CreatedBy       string              `json:"createdBy"`
	ModifiedAt      string              `json:"modifiedAt"`
	ModifiedBy      string              `json:"modifiedBy"`
	Description     string              `json:"description"`
	Fields          []LookupTableFields `json:"fields"`
	PrimaryKeys     []string            `json:"primaryKeys"`
	Ttl             int                 `json:"ttl"`
	SizeLimitAction string              `json:"sizeLimitAction"`
	Name            string              `json:"name"`
	ParentFolderId  string              `json:"parentFolderId"`
	Id              string              `json:"id"`
	ContentPath     string              `json:"contentPath"`
	Size            int                 `json:"size"`
}

type LookupTableRow added in v0.5.0 

type LookupTableRow struct {
	ColumnName  string `json:"columnName"`
	ColumnValue string `json:"columnValue"`
}

type LookupTableRowRequest added in v0.5.0 

type LookupTableRowRequest struct {
	Row []LookupTableRow `json:"row"`
}

type LookupTableStatusResponse added in v0.5.0 

type LookupTableStatusResponse struct {
	JobId             string                      `json:"jobId"`
	Status            string                      `json:"status"`
	StatusMessages    []string                    `json:"statusMessages"`
	Errors            []lookupTableStatusErrors   `json:"errors"`
	Warnings          []lookupTableStatusWarnings `json:"warnings"`
	LookupContentId   string                      `json:"lookupContentId"`
	LookupName        string                      `json:"lookupName"`
	LookupContentPath string                      `json:"lookupContentPath"`
	RequestType       string                      `json:"requestType"`
	UserId            string                      `json:"userId"`
	CreatedAt         string                      `json:"createdAt"`
	ModifiedAt        string                      `json:"modifiedAt"`
}

type LookupTableSyncDefinition added in v0.4.0 

type LookupTableSyncDefinition struct {
	Type            string   `json:"type"`
	Name            string   `json:"name"`
	Description     string   `json:"description"`
	Fields          []fields `json:"fields"`
	PrimaryKeys     []string `json:"primaryKeys"`
	TTL             int      `json:"ttl"`
	SizeLimitAction string   `json:"sizeLimitAction"`
}

type MetricsSavedSearchSyncDefinition added in v0.4.0 

type MetricsSavedSearchSyncDefinition struct {
	Type                      string                     `json:"type"`
	Name                      string                     `json:"name"`
	Description               string                     `json:"description"`
	TimeRange                 timeRangeDefinition        `json:"timeRange"`
	LogQuery                  string                     `json:"logQuery"`
	MetricsQueries            []metricsQueriesDefinition `json:"metricsQueries"`
	DesiredQuantizationInSecs int                        `json:"desiredQuantizationInSecs"`
	Properties                string                     `json:"properties"`
}

type MetricsSearchSyncDefinition added in v0.4.0 

type MetricsSearchSyncDefinition struct {
	Type           string              `json:"type"`
	Name           string              `json:"name"`
	TimeRange      timeRangeDefinition `json:"timeRange"`
	Description    string              `json:"description"`
	Queries        []queries           `json:"queries"`
	VisualSettings string              `json:"visualSettings"`
}

type MewboardSyncDefinition added in v0.4.0 

type MewboardSyncDefinition struct {
	Type             string                  `json:"type"`
	Name             string                  `json:"name"`
	Description      string                  `json:"description"`
	Title            string                  `json:"title"`
	RootPanel        rootPanelDefinition     `json:"rootPanel"`
	Theme            string                  `json:"theme"`
	TopologyLabelMap topologyLabelMap        `json:"topologyLabelMap"`
	RefreshInterval  int                     `json:"refreshInterval"`
	TimeRange        timeRangeDefinition     `json:"timeRange"`
	Layout           layout                  `json:"layout"`
	Panels           panelsDefinition        `json:"panels"`
	Variables        variablesDefinition     `json:"variables"`
	ColoringRules    coloringRulesDefinition `json:"coloringRules"`
}

type ModifyPermissionsRequest added in v0.5.0 

type ModifyPermissionsRequest struct {
	ContentPermissionAssignments []PermissionsDetail `json:"contentPermissionAssignments"`
	NotifyRecipients             bool                `json:"notifyRecipients"`
	NotificationMessage          string              `json:"notificationMessage"`
}

type MoveResponse added in v0.4.0 

type MoveResponse struct {
	Id     string       `json:"id"`
	Errors []moveErrors `json:"errors"`
}

type PermissionsDetail added in v0.5.0 

type PermissionsDetail struct {
	PermissionName string `json:"permissionName"`
	SourceType     string `json:"sourceType"`
	SourceId       string `json:"sourceId"`
	ContentId      string `json:"contentId"`
}

type ResponseError 

type ResponseError struct {
	Id     string   `json:"id"`
	Errors []Errors `json:"errors"`
}

type ResponseType added in v0.4.0 

type ResponseType struct {
	Type string `json:"type"`
}

type Role 

type Role struct {
	Data []RoleData `json:"data"`
}

type RoleData 

type RoleData struct {
	Name                 string   `json:"name"`
	Description          string   `json:"description"`
	FilterPredicate      string   `json:"filterPredicate"`
	Users                []string `json:"users"`
	Capabilities         []string `json:"capabilities"`
	AutofillDependencies bool     `json:"autofillDependencies"`
	CreatedAt            string   `json:"createdAt"`
	CreatedBy            string   `json:"createdBy"`
	ModifiedAt           string   `json:"modifiedAt"`
	ModifiedBy           string   `json:"modifiedBy"`
	Id                   string   `json:"id"`
	SystemDefined        bool     `json:"systemDefined"`
}

type SavedSearchWithScheduleSyncDefinition added in v0.4.0 

type SavedSearchWithScheduleSyncDefinition struct {
	Type           string         `json:"type"`
	Name           string         `json:"name"`
	Search         search         `json:"search"`
	SearchSchedule searchSchedule `json:"searchSchedule"`
	Description    string         `json:"description"`
}

type SourcesResponse 

type SourcesResponse struct {
	Id                         int               `json:"id"`
	Name                       string            `json:"name"`
	HostName                   string            `json:"hostName,omitempty"`
	AutomaticDateParsing       bool              `json:"automaticDateParsing"`
	MultilineProcessingEnabled bool              `json:"multilineProcessingEnabled"`
	UseAutolineMatching        bool              `json:"useAutolineMatching"`
	ContentType                string            `json:"contentType"`
	ForceTimezone              bool              `json:"forceTimezome"`
	Filters                    []sourceFilters   `json:"filters"`
	CutoffTimestamp            int               `json:"cutoffTimestamp"`
	Encoding                   string            `json:"encoding"`
	Interval                   int               `json:"interval"`
	Metrics                    []string          `json:"metrics"`
	SourceType                 string            `json:"sourceType"`
	Alive                      bool              `json:"alive"`
	Url                        string            `json:"url,omitempty"`
	Category                   string            `json:"category,omitempty"`
	Fields                     map[string]string `json:"fields,omitempty"`
	MessagePerRequest          bool              `json:"messagePerRequest"`
}

type StartExportResponse added in v0.4.0 

type StartExportResponse struct {
	Id string `json:"id"`
}

type SumoApiEndpoint 

type SumoApiEndpoint struct {
	Name     string
	Code     string
	Endpoint string
}

type SumoAuth 

type SumoAuth struct {
	AccessId  string `json:"accessid"`
	AccessKey string `json:"accesskey"`
	Region    string `json:"region"`
	Endpoint  string `json:"endpoint"`
}

type Targets added in v0.3.0 

type Targets struct {
	Targets []targetsResponse `json:"targets"`
}

type UpdateAccessKeysRequest added in v0.5.0 

type UpdateAccessKeysRequest struct {
	Disabled    bool     `json:"disabled"`
	CorsHeaders []string `json:"corsHeaders"`
}

type UpdateFolderRequest added in v0.5.0 

type UpdateFolderRequest struct {
	Name        string `json:"name"`
	Description string `json:"description"`
}

type UpdateRoleRequest 

type UpdateRoleRequest struct {
	Name                 string   `json:"name"`
	Description          string   `json:"description"`
	FilterPredicate      string   `json:"filterPredicate"`
	Users                []string `json:"users,omitempty"`
	Capabilities         []string `json:"capabilities,omitempty"`
	AutoFillDependencies bool     `json:"autoFillDependencies,omitempty"`
}

type UpdateTokenRequest added in v0.5.0 

type UpdateTokenRequest struct {
	Name        string `json:"name"`
	Description string `json:"description"`
	Status      string `json:"status"`
	Type        string `json:"type"`
	Version     int    `json:"version"`
}

type UpdateUserEmail 

type UpdateUserEmail struct {
	Email string `json:"email"`
}

type UpdateUserRequest 

type UpdateUserRequest struct {
	Firstname string   `json:"firstName"`
	Lastname  string   `json:"lastName"`
	IsActive  bool     `json:"isActive"`
	Roleids   []string `json:"roleIds"`
}

type UpgradeTask added in v0.3.0 

type UpgradeTask struct {
	CollectorId int    `json:"collectorId"`
	ToVersion   string `json:"toVersion"`
}

type UpgradeTaskResponse added in v0.3.0 

type UpgradeTaskResponse struct {
	Id   string          `json:"id"`
	Link upgradeTaskLink `json:"link"`
}

type UpgradeTaskStatus added in v0.3.0 

type UpgradeTaskStatus struct {
	Upgrade upgradeTaskProgress `json:"upgrade"`
}

type UserResponse 

type UserResponse struct {
	Firstname          string   `json:"firstName"`
	Lastname           string   `json:"lastName"`
	Email              string   `json:"email"`
	RoleIds            []string `json:"roleIds"`
	CreatedAt          string   `json:"createdAt"`
	CreatedBy          string   `json:"createdBy"`
	ModifiedAt         string   `json:"modifiedAt"`
	ModifiedBy         string   `json:"modifiedBy"`
	Id                 string   `json:"id"`
	IsActive           bool     `json:"isActive"`
	IsLocked           bool     `json:"isLocked"`
	IsMfaEnabled       bool     `json:"isMfaEnabled"`
	LastLoginTimestamp string   `json:"lastLoginTimestamp"`
}

type Users 

type Users struct {
	Data []UserResponse `json:"data"`
	Next string         `json:"next"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.