Documentation
¶
Index ¶
- type AddAlertsRequest
- type AddAlertsResponse
- type AddSignalsRequest
- type AddSignalsRequestItem
- type Alert
- type Decision
- type DecisionsStreamResponse
- type DeleteAlertsResponse
- type DeleteDecisionResponse
- type ErrorResponse
- type Event
- type FlushDecisionResponse
- type GetAlertsResponse
- type GetDecisionsResponse
- type Meta
- type MetaItems0
- type Metrics
- type MetricsSoftInfo
- type Source
- type TopxResponse
- type WatcherAuthRequest
- type WatcherAuthResponse
- type WatcherRegistrationRequest
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AddAlertsRequest ¶
type AddAlertsRequest []*Alert
AddAlertsRequest AddAlertsRequest
swagger:model AddAlertsRequest
type AddAlertsResponse ¶
type AddAlertsResponse []string
AddAlertsResponse AddAlertsResponse
swagger:model AddAlertsResponse
type AddSignalsRequest ¶
type AddSignalsRequest []*AddSignalsRequestItem
AddSignalsRequest add signals request
All signals request model ¶
swagger:model AddSignalsRequest
type AddSignalsRequestItem ¶
type AddSignalsRequestItem struct { // created at CreatedAt string `json:"created_at,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 version // Required: true ScenarioVersion *string `json:"scenario_version"` // 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"` }
AddSignalsRequestItem Signal
swagger:model AddSignalsRequestItem
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 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 APIL->APIC, ignored for cscli->APIL and crowdsec->APIL // 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"` }
Alert Alert
swagger:model Alert
func (*Alert) GetEventsCount ¶ added in v1.2.1
func (*Alert) GetScenario ¶
func (*Alert) HasRemediation ¶
func (*Alert) MarshalBinary ¶
MarshalBinary interface implementation
func (*Alert) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Decision ¶
type Decision struct { // duration // 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 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) MarshalBinary ¶
MarshalBinary interface implementation
func (*Decision) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type DecisionsStreamResponse ¶
type DecisionsStreamResponse struct { // deleted Deleted GetDecisionsResponse `json:"deleted,omitempty"` // new New GetDecisionsResponse `json:"new,omitempty"` }
DecisionsStreamResponse DecisionsStreamResponse
swagger:model DecisionsStreamResponse
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) 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) MarshalBinary ¶
func (m *DeleteDecisionResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeleteDecisionResponse) UnmarshalBinary ¶
func (m *DeleteDecisionResponse) 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) 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) 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
type GetDecisionsResponse ¶
type GetDecisionsResponse []*Decision
GetDecisionsResponse GetDecisionsResponse
swagger:model GetDecisionsResponse
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) 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 []*MetricsSoftInfo `json:"bouncers"` // machines // Required: true Machines []*MetricsSoftInfo `json:"machines"` }
Metrics Metrics
swagger:model Metrics
func (*Metrics) MarshalBinary ¶
MarshalBinary interface implementation
func (*Metrics) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type MetricsSoftInfo ¶
type MetricsSoftInfo struct { // name of the component Name string `json:"name,omitempty"` // software version Version string `json:"version,omitempty"` }
MetricsSoftInfo MetricsSoftInfo
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 MetricsSoftInfo
func (*MetricsSoftInfo) MarshalBinary ¶
func (m *MetricsSoftInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*MetricsSoftInfo) UnmarshalBinary ¶
func (m *MetricsSoftInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
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) MarshalBinary ¶
MarshalBinary interface implementation
func (*Source) UnmarshalBinary ¶
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) 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) 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"` }
WatcherRegistrationRequest WatcherRegistrationRequest
swagger:model WatcherRegistrationRequest
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
- alert.go
- decision.go
- decisions_stream_response.go
- delete_alerts_response.go
- delete_decision_response.go
- error_response.go
- event.go
- flush_decision_response.go
- get_alerts_response.go
- get_decisions_response.go
- helpers.go
- meta.go
- metrics.go
- metrics_soft_info.go
- source.go
- topx_response.go
- watcher_auth_request.go
- watcher_auth_response.go
- watcher_registration_request.go