Documentation
¶
Index ¶
- Constants
- type AddAlertsRequest
- type AddAlertsResponse
- type AddSignalsRequest
- type AddSignalsRequestItem
- type AddSignalsRequestItemContextItems0
- func (m *AddSignalsRequestItemContextItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *AddSignalsRequestItemContextItems0) MarshalBinary() ([]byte, error)
- func (m *AddSignalsRequestItemContextItems0) UnmarshalBinary(b []byte) error
- func (m *AddSignalsRequestItemContextItems0) Validate(formats strfmt.Registry) error
- type AddSignalsRequestItemDecisions
- type AddSignalsRequestItemDecisionsItem
- func (m *AddSignalsRequestItemDecisionsItem) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *AddSignalsRequestItemDecisionsItem) MarshalBinary() ([]byte, error)
- func (m *AddSignalsRequestItemDecisionsItem) UnmarshalBinary(b []byte) error
- func (m *AddSignalsRequestItemDecisionsItem) Validate(formats strfmt.Registry) error
- type AddSignalsRequestItemSource
- func (m *AddSignalsRequestItemSource) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *AddSignalsRequestItemSource) MarshalBinary() ([]byte, error)
- func (m *AddSignalsRequestItemSource) UnmarshalBinary(b []byte) error
- func (m *AddSignalsRequestItemSource) Validate(formats strfmt.Registry) error
- type Alert
- func (m *Alert) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (a *Alert) FormatAsStrings(machineID string, logger *log.Logger) []string
- func (a *Alert) GetEventsCount() int32
- func (a *Alert) GetMeta(key string) string
- func (a *Alert) GetScenario() string
- func (a *Alert) GetScope() string
- func (a *Alert) GetValue() string
- func (m *Alert) MarshalBinary() ([]byte, error)
- func (m *Alert) UnmarshalBinary(b []byte) error
- func (m *Alert) Validate(formats strfmt.Registry) error
- type AllMetrics
- type AllowlistItem
- type BaseMetrics
- type BulkCheckAllowlistRequest
- func (m *BulkCheckAllowlistRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *BulkCheckAllowlistRequest) MarshalBinary() ([]byte, error)
- func (m *BulkCheckAllowlistRequest) UnmarshalBinary(b []byte) error
- func (m *BulkCheckAllowlistRequest) Validate(formats strfmt.Registry) error
- type BulkCheckAllowlistResponse
- func (m *BulkCheckAllowlistResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *BulkCheckAllowlistResponse) MarshalBinary() ([]byte, error)
- func (m *BulkCheckAllowlistResponse) UnmarshalBinary(b []byte) error
- func (m *BulkCheckAllowlistResponse) Validate(formats strfmt.Registry) error
- type BulkCheckAllowlistResult
- func (m *BulkCheckAllowlistResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *BulkCheckAllowlistResult) MarshalBinary() ([]byte, error)
- func (m *BulkCheckAllowlistResult) UnmarshalBinary(b []byte) error
- func (m *BulkCheckAllowlistResult) Validate(formats strfmt.Registry) error
- type CheckAllowlistResponse
- func (m *CheckAllowlistResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *CheckAllowlistResponse) MarshalBinary() ([]byte, error)
- func (m *CheckAllowlistResponse) UnmarshalBinary(b []byte) error
- func (m *CheckAllowlistResponse) Validate(formats strfmt.Registry) error
- type ConsoleOptions
- type Decision
- type DecisionsDeleteRequest
- type DecisionsDeleteRequestItem
- type DecisionsStreamResponse
- func (m *DecisionsStreamResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *DecisionsStreamResponse) MarshalBinary() ([]byte, error)
- func (m *DecisionsStreamResponse) UnmarshalBinary(b []byte) error
- func (m *DecisionsStreamResponse) Validate(formats strfmt.Registry) error
- type DeleteAlertsResponse
- type DeleteDecisionResponse
- func (m *DeleteDecisionResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *DeleteDecisionResponse) MarshalBinary() ([]byte, error)
- func (m *DeleteDecisionResponse) UnmarshalBinary(b []byte) error
- func (m *DeleteDecisionResponse) Validate(formats strfmt.Registry) error
- type DetailedMetrics
- type ErrorResponse
- type Event
- type FlushDecisionResponse
- type GetAlertsResponse
- type GetAllowlistResponse
- type GetAllowlistsResponse
- type GetDecisionsResponse
- type HubItem
- type HubItems
- type LapiMetrics
- func (m *LapiMetrics) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *LapiMetrics) MarshalBinary() ([]byte, error)
- func (m LapiMetrics) MarshalJSON() ([]byte, error)
- func (m *LapiMetrics) UnmarshalBinary(b []byte) error
- func (m *LapiMetrics) UnmarshalJSON(raw []byte) error
- func (m *LapiMetrics) Validate(formats strfmt.Registry) error
- type LogProcessorsMetrics
- func (m *LogProcessorsMetrics) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *LogProcessorsMetrics) MarshalBinary() ([]byte, error)
- func (m LogProcessorsMetrics) MarshalJSON() ([]byte, error)
- func (m *LogProcessorsMetrics) UnmarshalBinary(b []byte) error
- func (m *LogProcessorsMetrics) UnmarshalJSON(raw []byte) error
- func (m *LogProcessorsMetrics) Validate(formats strfmt.Registry) error
- type Meta
- type MetaItems0
- type Metrics
- type MetricsAgentInfo
- type MetricsBouncerInfo
- type MetricsDetailItem
- type MetricsLabels
- type MetricsMeta
- type OSversion
- type ProfileAlert
- type RemediationComponentsMetrics
- func (m *RemediationComponentsMetrics) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *RemediationComponentsMetrics) MarshalBinary() ([]byte, error)
- func (m RemediationComponentsMetrics) MarshalJSON() ([]byte, error)
- func (m *RemediationComponentsMetrics) UnmarshalBinary(b []byte) error
- func (m *RemediationComponentsMetrics) UnmarshalJSON(raw []byte) error
- func (m *RemediationComponentsMetrics) Validate(formats strfmt.Registry) error
- type Source
- func (m *Source) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (s Source) GetAsNumberName() string
- func (s Source) GetScope() string
- func (s Source) GetValue() string
- func (m *Source) MarshalBinary() ([]byte, error)
- func (s *Source) String() string
- func (m *Source) UnmarshalBinary(b []byte) error
- func (m *Source) Validate(formats strfmt.Registry) error
- type SuccessResponse
- type TopxResponse
- type WatcherAuthRequest
- type WatcherAuthResponse
- type WatcherRegistrationRequest
- func (m *WatcherRegistrationRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *WatcherRegistrationRequest) MarshalBinary() ([]byte, error)
- func (m *WatcherRegistrationRequest) UnmarshalBinary(b []byte) error
- func (m *WatcherRegistrationRequest) Validate(formats strfmt.Registry) error
Constants ¶
const ( // these are duplicated from pkg/types // TODO XXX: de-duplicate Ip = "Ip" Range = "Range" CscliImportOrigin = "cscli-import" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AddAlertsRequest ¶
type AddAlertsRequest []*Alert
AddAlertsRequest AddAlertsRequest
swagger:model AddAlertsRequest
func (AddAlertsRequest) ContextValidate ¶ added in v1.3.0
ContextValidate validate this add alerts request based on the context it is used
type AddAlertsResponse ¶
type AddAlertsResponse []string
AddAlertsResponse AddAlertsResponse
swagger:model AddAlertsResponse
func (AddAlertsResponse) ContextValidate ¶ added in v1.3.0
ContextValidate validates this add alerts response based on context it is used
type AddSignalsRequest ¶
type AddSignalsRequest []*AddSignalsRequestItem
AddSignalsRequest add signals request
All signals request model ¶
swagger:model AddSignalsRequest
func (AddSignalsRequest) ContextValidate ¶ added in v1.3.0
ContextValidate validate this add signals request based on the context it is used
type AddSignalsRequestItem ¶
type AddSignalsRequestItem struct {
// alert id
AlertID int64 `json:"alert_id,omitempty"`
// context
Context []*AddSignalsRequestItemContextItems0 `json:"context"`
// created at
CreatedAt string `json:"created_at,omitempty"`
// decisions
Decisions AddSignalsRequestItemDecisions `json:"decisions,omitempty"`
// machine id
MachineID string `json:"machine_id,omitempty"`
// a human readable message
// Required: true
Message *string `json:"message"`
// scenario
// Required: true
Scenario *string `json:"scenario"`
// scenario hash
// Required: true
ScenarioHash *string `json:"scenario_hash"`
// scenario trust
ScenarioTrust string `json:"scenario_trust,omitempty"`
// scenario version
// Required: true
ScenarioVersion *string `json:"scenario_version"`
// source
// Required: true
Source *AddSignalsRequestItemSource `json:"source"`
// start at
// Required: true
StartAt *string `json:"start_at"`
// stop at
// Required: true
StopAt *string `json:"stop_at"`
// uuid
// Read Only: true
UUID string `json:"uuid,omitempty"`
}
AddSignalsRequestItem Signal
swagger:model AddSignalsRequestItem
func (*AddSignalsRequestItem) ContextValidate ¶ added in v1.3.0
ContextValidate validate this add signals request item based on the context it is used
func (*AddSignalsRequestItem) MarshalBinary ¶
func (m *AddSignalsRequestItem) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AddSignalsRequestItem) UnmarshalBinary ¶
func (m *AddSignalsRequestItem) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AddSignalsRequestItemContextItems0 ¶ added in v1.5.0
type AddSignalsRequestItemContextItems0 struct {
// key
Key string `json:"key,omitempty"`
// value
Value string `json:"value,omitempty"`
}
AddSignalsRequestItemContextItems0 add signals request item context items0
swagger:model AddSignalsRequestItemContextItems0
func (*AddSignalsRequestItemContextItems0) ContextValidate ¶ added in v1.5.0
func (m *AddSignalsRequestItemContextItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this add signals request item context items0 based on context it is used
func (*AddSignalsRequestItemContextItems0) MarshalBinary ¶ added in v1.5.0
func (m *AddSignalsRequestItemContextItems0) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AddSignalsRequestItemContextItems0) UnmarshalBinary ¶ added in v1.5.0
func (m *AddSignalsRequestItemContextItems0) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AddSignalsRequestItemDecisions ¶ added in v1.5.0
type AddSignalsRequestItemDecisions []*AddSignalsRequestItemDecisionsItem
AddSignalsRequestItemDecisions Decisions list
swagger:model AddSignalsRequestItemDecisions
func (AddSignalsRequestItemDecisions) ContextValidate ¶ added in v1.5.0
func (m AddSignalsRequestItemDecisions) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this add signals request item decisions based on the context it is used
type AddSignalsRequestItemDecisionsItem ¶ added in v1.5.0
type AddSignalsRequestItemDecisionsItem struct {
// duration
// Required: true
Duration *string `json:"duration"`
// (only relevant for GET ops) the unique id
// Required: true
ID *int64 `json:"id"`
// the origin of the decision : cscli, crowdsec
// Required: true
Origin *string `json:"origin"`
// scenario
// Required: true
Scenario *string `json:"scenario"`
// the scope of decision : does it apply to an IP, a range, a username, etc
// Required: true
Scope *string `json:"scope"`
// simulated
Simulated bool `json:"simulated,omitempty"`
// the type of decision, might be 'ban', 'captcha' or something custom. Ignored when watcher (cscli/crowdsec) is pushing to APIL.
// Required: true
Type *string `json:"type"`
// until
Until string `json:"until,omitempty"`
// only relevant for LAPI->CAPI, ignored for cscli->LAPI and crowdsec->LAPI
// Read Only: true
UUID string `json:"uuid,omitempty"`
// the value of the decision scope : an IP, a range, a username, etc
// Required: true
Value *string `json:"value"`
}
AddSignalsRequestItemDecisionsItem Decision
swagger:model AddSignalsRequestItemDecisionsItem
func (*AddSignalsRequestItemDecisionsItem) ContextValidate ¶ added in v1.5.0
func (m *AddSignalsRequestItemDecisionsItem) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this add signals request item decisions item based on the context it is used
func (*AddSignalsRequestItemDecisionsItem) MarshalBinary ¶ added in v1.5.0
func (m *AddSignalsRequestItemDecisionsItem) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AddSignalsRequestItemDecisionsItem) UnmarshalBinary ¶ added in v1.5.0
func (m *AddSignalsRequestItemDecisionsItem) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AddSignalsRequestItemSource ¶ added in v1.5.0
type AddSignalsRequestItemSource struct {
// provided as a convenience when the source is an IP
AsName string `json:"as_name,omitempty"`
// provided as a convenience when the source is an IP
AsNumber string `json:"as_number,omitempty"`
// cn
Cn string `json:"cn,omitempty"`
// provided as a convenience when the source is an IP
IP string `json:"ip,omitempty"`
// latitude
Latitude float32 `json:"latitude,omitempty"`
// longitude
Longitude float32 `json:"longitude,omitempty"`
// provided as a convenience when the source is an IP
Range string `json:"range,omitempty"`
// the scope of a source : ip,range,username,etc
// Required: true
Scope *string `json:"scope"`
// the value of a source : the ip, the range, the username,etc
// Required: true
Value *string `json:"value"`
}
AddSignalsRequestItemSource Source
swagger:model AddSignalsRequestItemSource
func (*AddSignalsRequestItemSource) ContextValidate ¶ added in v1.5.0
func (m *AddSignalsRequestItemSource) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this add signals request item source based on context it is used
func (*AddSignalsRequestItemSource) MarshalBinary ¶ added in v1.5.0
func (m *AddSignalsRequestItemSource) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AddSignalsRequestItemSource) UnmarshalBinary ¶ added in v1.5.0
func (m *AddSignalsRequestItemSource) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Alert ¶
type Alert struct {
// capacity
// Required: true
Capacity *int32 `json:"capacity"`
// only relevant for GET, ignored in POST requests
// Read Only: true
CreatedAt string `json:"created_at,omitempty"`
// decisions
Decisions []*Decision `json:"decisions"`
// the Meta of the events leading to overflow
// Required: true
Events []*Event `json:"events"`
// events count
// Required: true
EventsCount *int32 `json:"events_count"`
// only relevant for GET, ignored in POST requests
// Read Only: true
ID int64 `json:"id,omitempty"`
// labels
Labels []string `json:"labels"`
// leakspeed
// Required: true
Leakspeed *string `json:"leakspeed"`
// only relevant for LAPI->CAPI, ignored for cscli->LAPI and crowdsec->LAPI
// Read Only: true
MachineID string `json:"machine_id,omitempty"`
// a human readable message
// Required: true
Message *string `json:"message"`
// meta
Meta Meta `json:"meta,omitempty"`
// remediation
Remediation bool `json:"remediation,omitempty"`
// scenario
// Required: true
Scenario *string `json:"scenario"`
// scenario hash
// Required: true
ScenarioHash *string `json:"scenario_hash"`
// scenario version
// Required: true
ScenarioVersion *string `json:"scenario_version"`
// simulated
// Required: true
Simulated *bool `json:"simulated"`
// source
// Required: true
Source *Source `json:"source"`
// start at
// Required: true
StartAt *string `json:"start_at"`
// stop at
// Required: true
StopAt *string `json:"stop_at"`
// only relevant for LAPI->CAPI, ignored for cscli->LAPI and crowdsec->LAPI
// Read Only: true
UUID string `json:"uuid,omitempty"`
}
Alert Alert
swagger:model Alert
func (*Alert) ContextValidate ¶ added in v1.3.0
ContextValidate validate this alert based on the context it is used
func (*Alert) FormatAsStrings ¶ added in v1.6.3
func (*Alert) GetEventsCount ¶ added in v1.2.1
func (*Alert) GetScenario ¶
func (*Alert) MarshalBinary ¶
MarshalBinary interface implementation
func (*Alert) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type AllMetrics ¶ added in v1.6.3
type AllMetrics struct {
// lapi
Lapi *LapiMetrics `json:"lapi,omitempty"`
// log processors metrics
LogProcessors []*LogProcessorsMetrics `json:"log_processors"`
// remediation components metrics
RemediationComponents []*RemediationComponentsMetrics `json:"remediation_components"`
}
AllMetrics AllMetrics
swagger:model AllMetrics
func (*AllMetrics) ContextValidate ¶ added in v1.6.3
ContextValidate validate this all metrics based on the context it is used
func (*AllMetrics) MarshalBinary ¶ added in v1.6.3
func (m *AllMetrics) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AllMetrics) UnmarshalBinary ¶ added in v1.6.3
func (m *AllMetrics) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AllowlistItem ¶ added in v1.6.6
type AllowlistItem struct {
// creation date of the allowlist item
// Format: date-time
CreatedAt strfmt.DateTime `json:"created_at,omitempty"`
// description of the allowlist item
Description string `json:"description,omitempty"`
// expiration date of the allowlist item
// Format: date-time
Expiration strfmt.DateTime `json:"expiration,omitempty"`
// value of the allowlist item
Value string `json:"value,omitempty"`
}
AllowlistItem AllowlistItem
swagger:model AllowlistItem
func (*AllowlistItem) ContextValidate ¶ added in v1.6.6
ContextValidate validates this allowlist item based on context it is used
func (*AllowlistItem) MarshalBinary ¶ added in v1.6.6
func (m *AllowlistItem) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AllowlistItem) UnmarshalBinary ¶ added in v1.6.6
func (m *AllowlistItem) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type BaseMetrics ¶ added in v1.6.3
type BaseMetrics struct {
// feature flags (expected to be empty for remediation components)
FeatureFlags []string `json:"feature_flags"`
// metrics details
Metrics []*DetailedMetrics `json:"metrics"`
// os
Os *OSversion `json:"os,omitempty"`
// UTC timestamp of the startup of the software
// Required: true
UtcStartupTimestamp *int64 `json:"utc_startup_timestamp"`
// version of the remediation component
// Required: true
// Max Length: 255
Version *string `json:"version"`
}
BaseMetrics BaseMetrics
swagger:model BaseMetrics
func (*BaseMetrics) ContextValidate ¶ added in v1.6.3
ContextValidate validate this base metrics based on the context it is used
func (*BaseMetrics) MarshalBinary ¶ added in v1.6.3
func (m *BaseMetrics) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*BaseMetrics) UnmarshalBinary ¶ added in v1.6.3
func (m *BaseMetrics) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type BulkCheckAllowlistRequest ¶ added in v1.6.9
type BulkCheckAllowlistRequest struct {
// Array of IP addresses or CIDR ranges to check
// Required: true
Targets []string `json:"targets"`
}
BulkCheckAllowlistRequest bulk check allowlist request
swagger:model BulkCheckAllowlistRequest
func (*BulkCheckAllowlistRequest) ContextValidate ¶ added in v1.6.9
func (m *BulkCheckAllowlistRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this bulk check allowlist request based on context it is used
func (*BulkCheckAllowlistRequest) MarshalBinary ¶ added in v1.6.9
func (m *BulkCheckAllowlistRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*BulkCheckAllowlistRequest) UnmarshalBinary ¶ added in v1.6.9
func (m *BulkCheckAllowlistRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type BulkCheckAllowlistResponse ¶ added in v1.6.9
type BulkCheckAllowlistResponse struct {
// Per-target allowlist membership results
// Required: true
Results []*BulkCheckAllowlistResult `json:"results"`
}
BulkCheckAllowlistResponse bulk check allowlist response
swagger:model BulkCheckAllowlistResponse
func (*BulkCheckAllowlistResponse) ContextValidate ¶ added in v1.6.9
func (m *BulkCheckAllowlistResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this bulk check allowlist response based on the context it is used
func (*BulkCheckAllowlistResponse) MarshalBinary ¶ added in v1.6.9
func (m *BulkCheckAllowlistResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*BulkCheckAllowlistResponse) UnmarshalBinary ¶ added in v1.6.9
func (m *BulkCheckAllowlistResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type BulkCheckAllowlistResult ¶ added in v1.6.9
type BulkCheckAllowlistResult struct {
// Matching ip or range, name of the allowlist and comment related to the target
// Required: true
Allowlists []string `json:"allowlists"`
// The IP or range that is allowlisted
// Required: true
Target *string `json:"target"`
}
BulkCheckAllowlistResult bulk check allowlist result
swagger:model BulkCheckAllowlistResult
func (*BulkCheckAllowlistResult) ContextValidate ¶ added in v1.6.9
func (m *BulkCheckAllowlistResult) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this bulk check allowlist result based on context it is used
func (*BulkCheckAllowlistResult) MarshalBinary ¶ added in v1.6.9
func (m *BulkCheckAllowlistResult) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*BulkCheckAllowlistResult) UnmarshalBinary ¶ added in v1.6.9
func (m *BulkCheckAllowlistResult) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CheckAllowlistResponse ¶ added in v1.6.6
type CheckAllowlistResponse struct {
// true if the IP or range is in the allowlist
Allowlisted bool `json:"allowlisted,omitempty"`
// item that matched the provided value
Reason string `json:"reason,omitempty"`
}
CheckAllowlistResponse CheckAllowlistResponse
swagger:model CheckAllowlistResponse
func (*CheckAllowlistResponse) ContextValidate ¶ added in v1.6.6
func (m *CheckAllowlistResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this check allowlist response based on context it is used
func (*CheckAllowlistResponse) MarshalBinary ¶ added in v1.6.6
func (m *CheckAllowlistResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CheckAllowlistResponse) UnmarshalBinary ¶ added in v1.6.6
func (m *CheckAllowlistResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ConsoleOptions ¶ added in v1.6.3
type ConsoleOptions []string
ConsoleOptions ConsoleOptions
swagger:model ConsoleOptions
func (ConsoleOptions) ContextValidate ¶ added in v1.6.3
ContextValidate validates this console options based on context it is used
type Decision ¶
type Decision struct {
// the duration of the decisions
// Required: true
Duration *string `json:"duration"`
// (only relevant for GET ops) the unique id
// Read Only: true
ID int64 `json:"id,omitempty"`
// the origin of the decision : cscli, crowdsec
// Required: true
Origin *string `json:"origin"`
// scenario
// Required: true
Scenario *string `json:"scenario"`
// the scope of decision : does it apply to an IP, a range, a username, etc
// Required: true
Scope *string `json:"scope"`
// true if the decision result from a scenario in simulation mode
// Read Only: true
Simulated *bool `json:"simulated,omitempty"`
// the type of decision, might be 'ban', 'captcha' or something custom. Ignored when watcher (cscli/crowdsec) is pushing to APIL.
// Required: true
Type *string `json:"type"`
// the date until the decisions must be active
Until string `json:"until,omitempty"`
// only relevant for LAPI->CAPI, ignored for cscli->LAPI and crowdsec->LAPI
// Read Only: true
UUID string `json:"uuid,omitempty"`
// the value of the decision scope : an IP, a range, a username, etc
// Required: true
Value *string `json:"value"`
}
Decision Decision
swagger:model Decision
func (*Decision) ContextValidate ¶ added in v1.3.0
ContextValidate validate this decision based on the context it is used
func (*Decision) MarshalBinary ¶
MarshalBinary interface implementation
func (*Decision) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type DecisionsDeleteRequest ¶ added in v1.5.0
type DecisionsDeleteRequest []DecisionsDeleteRequestItem
DecisionsDeleteRequest delete decisions
delete decision model
swagger:model DecisionsDeleteRequest
func (DecisionsDeleteRequest) ContextValidate ¶ added in v1.5.0
ContextValidate validate this decisions delete request based on the context it is used
type DecisionsDeleteRequestItem ¶ added in v1.5.0
type DecisionsDeleteRequestItem string
DecisionsDeleteRequestItem decisionsIDs
swagger:model DecisionsDeleteRequestItem
func (DecisionsDeleteRequestItem) ContextValidate ¶ added in v1.5.0
func (m DecisionsDeleteRequestItem) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this decisions delete request item based on context it is used
type DecisionsStreamResponse ¶
type DecisionsStreamResponse struct {
// deleted
Deleted GetDecisionsResponse `json:"deleted,omitempty"`
// new
New GetDecisionsResponse `json:"new,omitempty"`
}
DecisionsStreamResponse DecisionsStreamResponse
swagger:model DecisionsStreamResponse
func (*DecisionsStreamResponse) ContextValidate ¶ added in v1.3.0
func (m *DecisionsStreamResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this decisions stream response based on the context it is used
func (*DecisionsStreamResponse) MarshalBinary ¶
func (m *DecisionsStreamResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DecisionsStreamResponse) UnmarshalBinary ¶
func (m *DecisionsStreamResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeleteAlertsResponse ¶
type DeleteAlertsResponse struct {
// number of deleted alerts
NbDeleted string `json:"nbDeleted,omitempty"`
}
DeleteAlertsResponse DeleteAlertsResponse
swagger:model DeleteAlertsResponse
func (*DeleteAlertsResponse) ContextValidate ¶ added in v1.3.0
ContextValidate validates this delete alerts response based on context it is used
func (*DeleteAlertsResponse) MarshalBinary ¶
func (m *DeleteAlertsResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeleteAlertsResponse) UnmarshalBinary ¶
func (m *DeleteAlertsResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeleteDecisionResponse ¶
type DeleteDecisionResponse struct {
// number of deleted decisions
NbDeleted string `json:"nbDeleted,omitempty"`
}
DeleteDecisionResponse DeleteDecisionResponse
swagger:model DeleteDecisionResponse
func (*DeleteDecisionResponse) ContextValidate ¶ added in v1.3.0
func (m *DeleteDecisionResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this delete decision response based on context it is used
func (*DeleteDecisionResponse) MarshalBinary ¶
func (m *DeleteDecisionResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeleteDecisionResponse) UnmarshalBinary ¶
func (m *DeleteDecisionResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DetailedMetrics ¶ added in v1.6.3
type DetailedMetrics struct {
// items
// Required: true
Items []*MetricsDetailItem `json:"items"`
// meta
// Required: true
Meta *MetricsMeta `json:"meta"`
}
DetailedMetrics DetailedMetrics
swagger:model DetailedMetrics
func (*DetailedMetrics) ContextValidate ¶ added in v1.6.3
ContextValidate validate this detailed metrics based on the context it is used
func (*DetailedMetrics) MarshalBinary ¶ added in v1.6.3
func (m *DetailedMetrics) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DetailedMetrics) UnmarshalBinary ¶ added in v1.6.3
func (m *DetailedMetrics) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ErrorResponse ¶
type ErrorResponse struct {
// more detail on individual errors
Errors string `json:"errors,omitempty"`
// Error message
// Required: true
Message *string `json:"message"`
}
ErrorResponse error response
error response return by the API
swagger:model ErrorResponse
func (*ErrorResponse) ContextValidate ¶ added in v1.3.0
ContextValidate validates this error response based on context it is used
func (*ErrorResponse) MarshalBinary ¶
func (m *ErrorResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ErrorResponse) UnmarshalBinary ¶
func (m *ErrorResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Event ¶
type Event struct {
// meta
// Required: true
Meta Meta `json:"meta"`
// timestamp
// Required: true
Timestamp *string `json:"timestamp"`
}
Event Event
swagger:model Event
func (*Event) ContextValidate ¶ added in v1.3.0
ContextValidate validate this event based on the context it is used
func (*Event) MarshalBinary ¶
MarshalBinary interface implementation
func (*Event) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type FlushDecisionResponse ¶
type FlushDecisionResponse struct {
// decision id
DecisionID string `json:"decision_id,omitempty"`
}
FlushDecisionResponse FlushDecisionResponse
swagger:model FlushDecisionResponse
func (*FlushDecisionResponse) MarshalBinary ¶
func (m *FlushDecisionResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*FlushDecisionResponse) UnmarshalBinary ¶
func (m *FlushDecisionResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type GetAlertsResponse ¶
type GetAlertsResponse []*Alert
GetAlertsResponse AlertsResponse
swagger:model GetAlertsResponse
func (GetAlertsResponse) ContextValidate ¶ added in v1.3.0
ContextValidate validate this get alerts response based on the context it is used
type GetAllowlistResponse ¶ added in v1.6.6
type GetAllowlistResponse struct {
// id of the allowlist
AllowlistID string `json:"allowlist_id,omitempty"`
// true if the allowlist is managed by the console
ConsoleManaged bool `json:"console_managed,omitempty"`
// creation date of the allowlist
// Format: date-time
CreatedAt strfmt.DateTime `json:"created_at,omitempty"`
// description of the allowlist
Description string `json:"description,omitempty"`
// items in the allowlist
Items []*AllowlistItem `json:"items"`
// name of the allowlist
Name string `json:"name,omitempty"`
// last update date of the allowlist
// Format: date-time
UpdatedAt strfmt.DateTime `json:"updated_at,omitempty"`
}
GetAllowlistResponse GetAllowlistResponse
swagger:model GetAllowlistResponse
func (*GetAllowlistResponse) ContextValidate ¶ added in v1.6.6
ContextValidate validate this get allowlist response based on the context it is used
func (*GetAllowlistResponse) MarshalBinary ¶ added in v1.6.6
func (m *GetAllowlistResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*GetAllowlistResponse) UnmarshalBinary ¶ added in v1.6.6
func (m *GetAllowlistResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type GetAllowlistsResponse ¶ added in v1.6.6
type GetAllowlistsResponse []*GetAllowlistResponse
GetAllowlistsResponse GetAllowlistsResponse
swagger:model GetAllowlistsResponse
func (GetAllowlistsResponse) ContextValidate ¶ added in v1.6.6
ContextValidate validate this get allowlists response based on the context it is used
type GetDecisionsResponse ¶
type GetDecisionsResponse []*Decision
GetDecisionsResponse GetDecisionsResponse
swagger:model GetDecisionsResponse
func (GetDecisionsResponse) ContextValidate ¶ added in v1.3.0
ContextValidate validate this get decisions response based on the context it is used
type HubItem ¶ added in v1.6.3
type HubItem struct {
// name of the hub item
Name string `json:"name,omitempty"`
// status of the hub item (official, custom, tainted, etc.)
Status string `json:"status,omitempty"`
// version of the hub item
Version string `json:"version,omitempty"`
}
HubItem HubItem
swagger:model HubItem
func (*HubItem) ContextValidate ¶ added in v1.6.3
ContextValidate validates this hub item based on context it is used
func (*HubItem) MarshalBinary ¶ added in v1.6.3
MarshalBinary interface implementation
func (*HubItem) UnmarshalBinary ¶ added in v1.6.3
UnmarshalBinary interface implementation
type HubItems ¶ added in v1.6.3
HubItems HubItems
swagger:model HubItems
func (HubItems) ContextValidate ¶ added in v1.6.3
ContextValidate validate this hub items based on the context it is used
type LapiMetrics ¶ added in v1.6.3
type LapiMetrics struct {
BaseMetrics
// console options
ConsoleOptions ConsoleOptions `json:"console_options,omitempty"`
}
LapiMetrics LapiMetrics
swagger:model LapiMetrics
func (*LapiMetrics) ContextValidate ¶ added in v1.6.3
ContextValidate validate this lapi metrics based on the context it is used
func (*LapiMetrics) MarshalBinary ¶ added in v1.6.3
func (m *LapiMetrics) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (LapiMetrics) MarshalJSON ¶ added in v1.6.3
func (m LapiMetrics) MarshalJSON() ([]byte, error)
MarshalJSON marshals this object to a JSON structure
func (*LapiMetrics) UnmarshalBinary ¶ added in v1.6.3
func (m *LapiMetrics) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
func (*LapiMetrics) UnmarshalJSON ¶ added in v1.6.3
func (m *LapiMetrics) UnmarshalJSON(raw []byte) error
UnmarshalJSON unmarshals this object from a JSON structure
type LogProcessorsMetrics ¶ added in v1.6.3
type LogProcessorsMetrics struct {
BaseMetrics
// Number of datasources per type
// Required: true
Datasources map[string]int64 `json:"datasources"`
// hub items
// Required: true
HubItems HubItems `json:"hub_items"`
// last push date
LastPush int64 `json:"last_push,omitempty"`
// last update date
LastUpdate int64 `json:"last_update,omitempty"`
// name of the log processor
Name string `json:"name,omitempty"`
}
LogProcessorsMetrics LogProcessorsMetrics
swagger:model LogProcessorsMetrics
func (*LogProcessorsMetrics) ContextValidate ¶ added in v1.6.3
ContextValidate validate this log processors metrics based on the context it is used
func (*LogProcessorsMetrics) MarshalBinary ¶ added in v1.6.3
func (m *LogProcessorsMetrics) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (LogProcessorsMetrics) MarshalJSON ¶ added in v1.6.3
func (m LogProcessorsMetrics) MarshalJSON() ([]byte, error)
MarshalJSON marshals this object to a JSON structure
func (*LogProcessorsMetrics) UnmarshalBinary ¶ added in v1.6.3
func (m *LogProcessorsMetrics) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
func (*LogProcessorsMetrics) UnmarshalJSON ¶ added in v1.6.3
func (m *LogProcessorsMetrics) UnmarshalJSON(raw []byte) error
UnmarshalJSON unmarshals this object from a JSON structure
type Meta ¶
type Meta []*MetaItems0
Meta Meta
the Meta data of the Alert itself
swagger:model Meta
func (Meta) ContextValidate ¶ added in v1.3.0
ContextValidate validate this meta based on the context it is used
type MetaItems0 ¶
type MetaItems0 struct {
// key
Key string `json:"key,omitempty"`
// value
Value string `json:"value,omitempty"`
}
MetaItems0 meta items0
swagger:model MetaItems0
func (*MetaItems0) ContextValidate ¶ added in v1.3.0
ContextValidate validates this meta items0 based on context it is used
func (*MetaItems0) MarshalBinary ¶
func (m *MetaItems0) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*MetaItems0) UnmarshalBinary ¶
func (m *MetaItems0) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Metrics ¶
type Metrics struct {
// the local version of crowdsec/apil
// Required: true
ApilVersion *string `json:"apil_version"`
// bouncers
// Required: true
Bouncers []*MetricsBouncerInfo `json:"bouncers"`
// machines
// Required: true
Machines []*MetricsAgentInfo `json:"machines"`
}
Metrics Metrics
swagger:model Metrics
func (*Metrics) ContextValidate ¶ added in v1.3.0
ContextValidate validate this metrics based on the context it is used
func (*Metrics) MarshalBinary ¶
MarshalBinary interface implementation
func (*Metrics) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type MetricsAgentInfo ¶ added in v1.3.0
type MetricsAgentInfo struct {
// last agent push date
LastPush string `json:"last_push,omitempty"`
// last agent update date
LastUpdate string `json:"last_update,omitempty"`
// name of the component
Name string `json:"name,omitempty"`
// software version
Version string `json:"version,omitempty"`
}
MetricsAgentInfo MetricsAgentInfo
Software version info (so we can warn users about out-of-date software). The software name and the version are "guessed" from the user-agent
swagger:model MetricsAgentInfo
func (*MetricsAgentInfo) ContextValidate ¶ added in v1.3.0
ContextValidate validates this metrics agent info based on context it is used
func (*MetricsAgentInfo) MarshalBinary ¶ added in v1.3.0
func (m *MetricsAgentInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*MetricsAgentInfo) UnmarshalBinary ¶ added in v1.3.0
func (m *MetricsAgentInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type MetricsBouncerInfo ¶ added in v1.3.0
type MetricsBouncerInfo struct {
// name of the component
CustomName string `json:"custom_name,omitempty"`
// last bouncer pull date
LastPull string `json:"last_pull,omitempty"`
// bouncer type (firewall, php ...)
Name string `json:"name,omitempty"`
// software version
Version string `json:"version,omitempty"`
}
MetricsBouncerInfo MetricsBouncerInfo
Software version info (so we can warn users about out-of-date software). The software name and the version are "guessed" from the user-agent
swagger:model MetricsBouncerInfo
func (*MetricsBouncerInfo) ContextValidate ¶ added in v1.3.0
ContextValidate validates this metrics bouncer info based on context it is used
func (*MetricsBouncerInfo) MarshalBinary ¶ added in v1.3.0
func (m *MetricsBouncerInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*MetricsBouncerInfo) UnmarshalBinary ¶ added in v1.3.0
func (m *MetricsBouncerInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type MetricsDetailItem ¶ added in v1.6.3
type MetricsDetailItem struct {
// labels of the metric
Labels MetricsLabels `json:"labels,omitempty"`
// name of the metric
// Required: true
// Max Length: 255
Name *string `json:"name"`
// unit of the metric
// Required: true
// Max Length: 255
Unit *string `json:"unit"`
// value of the metric
// Required: true
Value *float64 `json:"value"`
}
MetricsDetailItem MetricsDetailItem
swagger:model MetricsDetailItem
func (*MetricsDetailItem) ContextValidate ¶ added in v1.6.3
ContextValidate validate this metrics detail item based on the context it is used
func (*MetricsDetailItem) MarshalBinary ¶ added in v1.6.3
func (m *MetricsDetailItem) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*MetricsDetailItem) UnmarshalBinary ¶ added in v1.6.3
func (m *MetricsDetailItem) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type MetricsLabels ¶ added in v1.6.3
MetricsLabels MetricsLabels
swagger:model MetricsLabels
func (MetricsLabels) ContextValidate ¶ added in v1.6.3
ContextValidate validates this metrics labels based on context it is used
type MetricsMeta ¶ added in v1.6.3
type MetricsMeta struct {
// UTC timestamp of the current time
// Required: true
UtcNowTimestamp *int64 `json:"utc_now_timestamp"`
// Size, in seconds, of the window used to compute the metric
// Required: true
WindowSizeSeconds *int64 `json:"window_size_seconds"`
}
MetricsMeta MetricsMeta
swagger:model MetricsMeta
func (*MetricsMeta) ContextValidate ¶ added in v1.6.3
ContextValidate validates this metrics meta based on context it is used
func (*MetricsMeta) MarshalBinary ¶ added in v1.6.3
func (m *MetricsMeta) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*MetricsMeta) UnmarshalBinary ¶ added in v1.6.3
func (m *MetricsMeta) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type OSversion ¶ added in v1.6.3
type OSversion struct {
// name of the OS
// Required: true
// Max Length: 255
Name *string `json:"name"`
// version of the OS
// Required: true
// Max Length: 255
Version *string `json:"version"`
}
OSversion OSversion
swagger:model OSversion
func (*OSversion) ContextValidate ¶ added in v1.6.3
ContextValidate validates this o sversion based on context it is used
func (*OSversion) MarshalBinary ¶ added in v1.6.3
MarshalBinary interface implementation
func (*OSversion) UnmarshalBinary ¶ added in v1.6.3
UnmarshalBinary interface implementation
type ProfileAlert ¶ added in v1.6.10
type RemediationComponentsMetrics ¶ added in v1.6.3
type RemediationComponentsMetrics struct {
BaseMetrics
// last pull date
LastPull int64 `json:"last_pull,omitempty"`
// name of the remediation component
Name string `json:"name,omitempty"`
// type of the remediation component
Type string `json:"type,omitempty"`
}
RemediationComponentsMetrics RemediationComponentsMetrics
swagger:model RemediationComponentsMetrics
func (*RemediationComponentsMetrics) ContextValidate ¶ added in v1.6.3
func (m *RemediationComponentsMetrics) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this remediation components metrics based on the context it is used
func (*RemediationComponentsMetrics) MarshalBinary ¶ added in v1.6.3
func (m *RemediationComponentsMetrics) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (RemediationComponentsMetrics) MarshalJSON ¶ added in v1.6.3
func (m RemediationComponentsMetrics) MarshalJSON() ([]byte, error)
MarshalJSON marshals this object to a JSON structure
func (*RemediationComponentsMetrics) UnmarshalBinary ¶ added in v1.6.3
func (m *RemediationComponentsMetrics) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
func (*RemediationComponentsMetrics) UnmarshalJSON ¶ added in v1.6.3
func (m *RemediationComponentsMetrics) UnmarshalJSON(raw []byte) error
UnmarshalJSON unmarshals this object from a JSON structure
type Source ¶
type Source struct {
// provided as a convenience when the source is an IP
AsName string `json:"as_name,omitempty"`
// provided as a convenience when the source is an IP
AsNumber string `json:"as_number,omitempty"`
// cn
Cn string `json:"cn,omitempty"`
// provided as a convenience when the source is an IP
IP string `json:"ip,omitempty"`
// latitude
Latitude float32 `json:"latitude,omitempty"`
// longitude
Longitude float32 `json:"longitude,omitempty"`
// provided as a convenience when the source is an IP
Range string `json:"range,omitempty"`
// the scope of a source : ip,range,username,etc
// Required: true
Scope *string `json:"scope"`
// the value of a source : the ip, the range, the username,etc
// Required: true
Value *string `json:"value"`
}
Source Source
swagger:model Source
func (*Source) ContextValidate ¶ added in v1.3.0
ContextValidate validates this source based on context it is used
func (Source) GetAsNumberName ¶ added in v1.4.2
func (*Source) MarshalBinary ¶
MarshalBinary interface implementation
func (*Source) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type SuccessResponse ¶ added in v1.6.3
type SuccessResponse struct {
// message
// Required: true
Message *string `json:"message"`
}
SuccessResponse success response
success response return by the API
swagger:model SuccessResponse
func (*SuccessResponse) ContextValidate ¶ added in v1.6.3
ContextValidate validates this success response based on context it is used
func (*SuccessResponse) MarshalBinary ¶ added in v1.6.3
func (m *SuccessResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SuccessResponse) UnmarshalBinary ¶ added in v1.6.3
func (m *SuccessResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TopxResponse ¶
type TopxResponse struct {
// We keep the deleted array for the duration of the initial decision. So that when the initial decision is expired, it won't be present in deleted array anymore.
Deleted [][]GetDecisionsResponse `json:"deleted"`
// new
New [][]GetDecisionsResponse `json:"new"`
}
TopxResponse TopxResponse
swagger:model TopxResponse
func (*TopxResponse) MarshalBinary ¶
func (m *TopxResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TopxResponse) UnmarshalBinary ¶
func (m *TopxResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type WatcherAuthRequest ¶
type WatcherAuthRequest struct {
// machine id
// Required: true
MachineID *string `json:"machine_id"`
// password
// Required: true
// Format: password
Password *strfmt.Password `json:"password"`
// the list of scenarios enabled on the watcher
Scenarios []string `json:"scenarios"`
}
WatcherAuthRequest WatcherAuthRequest
swagger:model WatcherAuthRequest
func (*WatcherAuthRequest) ContextValidate ¶ added in v1.3.0
ContextValidate validates this watcher auth request based on context it is used
func (*WatcherAuthRequest) MarshalBinary ¶
func (m *WatcherAuthRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*WatcherAuthRequest) UnmarshalBinary ¶
func (m *WatcherAuthRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type WatcherAuthResponse ¶
type WatcherAuthResponse struct {
// code
Code int64 `json:"code,omitempty"`
// expire
Expire string `json:"expire,omitempty"`
// token
Token string `json:"token,omitempty"`
}
WatcherAuthResponse WatcherAuthResponse
the response of a successful authentication
swagger:model WatcherAuthResponse
func (*WatcherAuthResponse) ContextValidate ¶ added in v1.3.0
ContextValidate validates this watcher auth response based on context it is used
func (*WatcherAuthResponse) MarshalBinary ¶
func (m *WatcherAuthResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*WatcherAuthResponse) UnmarshalBinary ¶
func (m *WatcherAuthResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type WatcherRegistrationRequest ¶
type WatcherRegistrationRequest struct {
// machine id
// Required: true
MachineID *string `json:"machine_id"`
// password
// Required: true
// Format: password
Password *strfmt.Password `json:"password"`
// registration token
// Max Length: 255
// Min Length: 32
RegistrationToken string `json:"registration_token,omitempty"`
}
WatcherRegistrationRequest WatcherRegistrationRequest
swagger:model WatcherRegistrationRequest
func (*WatcherRegistrationRequest) ContextValidate ¶ added in v1.3.0
func (m *WatcherRegistrationRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this watcher registration request based on context it is used
func (*WatcherRegistrationRequest) MarshalBinary ¶
func (m *WatcherRegistrationRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*WatcherRegistrationRequest) UnmarshalBinary ¶
func (m *WatcherRegistrationRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
Source Files
¶
- add_alerts_request.go
- add_alerts_response.go
- add_signals_request.go
- add_signals_request_item.go
- add_signals_request_item_decisions.go
- add_signals_request_item_decisions_item.go
- add_signals_request_item_source.go
- alert.go
- all_metrics.go
- allowlist_item.go
- base_metrics.go
- bulk_check_allowlist_request.go
- bulk_check_allowlist_response.go
- bulk_check_allowlist_result.go
- check_allowlist_response.go
- console_options.go
- decision.go
- decisions_delete_request.go
- decisions_delete_request_item.go
- decisions_stream_response.go
- delete_alerts_response.go
- delete_decision_response.go
- detailed_metrics.go
- error_response.go
- event.go
- flush_decision_response.go
- generate.go
- get_alerts_response.go
- get_allowlist_response.go
- get_allowlists_response.go
- get_decisions_response.go
- helpers.go
- hub_item.go
- hub_items.go
- lapi_metrics.go
- log_processors_metrics.go
- meta.go
- metrics.go
- metrics_agent_info.go
- metrics_bouncer_info.go
- metrics_detail_item.go
- metrics_labels.go
- metrics_meta.go
- o_sversion.go
- remediation_components_metrics.go
- source.go
- success_response.go
- topx_response.go
- watcher_auth_request.go
- watcher_auth_response.go
- watcher_registration_request.go