modelscapi

type AddSignalsRequest []*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"`
}

type AddSignalsRequestItemContextItems0 struct {

	// key
	Key string `json:"key,omitempty"`

	// value
	Value string `json:"value,omitempty"`
}

type AddSignalsRequestItemDecisions []*AddSignalsRequestItemDecisionsItem

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"`

	// the value of the decision scope : an IP, a range, a username, etc
	// Required: true
	Value *string `json:"value"`
}

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"`
}

type BlocklistLink struct {

	// duration
	// Required: true
	Duration *string `json:"duration"`

	// the name of the blocklist
	// Required: true
	Name *string `json:"name"`

	// the remediation that should be used for the blocklist
	// Required: true
	Remediation *string `json:"remediation"`

	// the scope of decisions in the blocklist
	// Required: true
	Scope *string `json:"scope"`

	// the url from which the blocklist content can be downloaded
	// Required: true
	URL *string `json:"url"`
}

type DecisionsDeleteRequest []DecisionsDeleteRequestItem

type DecisionsDeleteRequestItem string

type DecisionsSyncRequest []*DecisionsSyncRequestItem

type DecisionsSyncRequestItem struct {

	// alert id
	AlertID int64 `json:"alert_id,omitempty"`

	// created at
	CreatedAt string `json:"created_at,omitempty"`

	// decisions
	Decisions DecisionsSyncRequestItemDecisions `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 *DecisionsSyncRequestItemSource `json:"source"`

	// start at
	// Required: true
	StartAt *string `json:"start_at"`

	// stop at
	// Required: true
	StopAt *string `json:"stop_at"`
}

type DecisionsSyncRequestItemDecisions []*DecisionsSyncRequestItemDecisionsItem

type DecisionsSyncRequestItemDecisionsItem 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"`

	// the value of the decision scope : an IP, a range, a username, etc
	// Required: true
	Value *string `json:"value"`
}

type DecisionsSyncRequestItemSource 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"`
}

type EnrollRequest struct {

	// attachment_key is generated in your crowdsec backoffice account and allows you to enroll your machines to your BO account
	// Required: true
	// Pattern: ^[a-zA-Z0-9]+$
	AttachmentKey *string `json:"attachment_key"`

	// The name that will be display in the console for the instance
	Name string `json:"name,omitempty"`

	// To force enroll the instance
	Overwrite bool `json:"overwrite,omitempty"`

	// Tags to apply on the console for the instance
	Tags []string `json:"tags"`
}

type ErrorResponse struct {

	// more detail on individual errors
	Errors string `json:"errors,omitempty"`

	// Error message
	// Required: true
	Message *string `json:"message"`
}

type GetDecisionsStreamResponse struct {

	// deleted
	Deleted GetDecisionsStreamResponseDeleted `json:"deleted,omitempty"`

	// links
	Links *GetDecisionsStreamResponseLinks `json:"links,omitempty"`

	// new
	New GetDecisionsStreamResponseNew `json:"new,omitempty"`
}

type GetDecisionsStreamResponseDeleted []*GetDecisionsStreamResponseDeletedItem

type GetDecisionsStreamResponseDeletedItem struct {

	// decisions
	// Required: true
	Decisions []string `json:"decisions"`

	// the scope of decision : does it apply to an IP, a range, a username, etc
	// Required: true
	Scope *string `json:"scope"`
}

type GetDecisionsStreamResponseLinks struct {

	// blocklists
	Blocklists []*BlocklistLink `json:"blocklists"`
}

type GetDecisionsStreamResponseNew []*GetDecisionsStreamResponseNewItem

type GetDecisionsStreamResponseNewItem struct {

	// decisions
	// Required: true
	Decisions []*GetDecisionsStreamResponseNewItemDecisionsItems0 `json:"decisions"`

	// 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"`
}

type GetDecisionsStreamResponseNewItemDecisionsItems0 struct {

	// duration
	// Required: true
	Duration *string `json:"duration"`

	// the value of the decision scope : an IP, a range, a username, etc
	// Required: true
	Value *string `json:"value"`
}

type LoginRequest struct {

	// machine_id is a (username) generated by crowdsec
	// Required: true
	// Max Length: 48
	// Min Length: 48
	// Pattern: ^[a-zA-Z0-9]+$
	MachineID *string `json:"machine_id"`

	// Password, should respect the password policy (link to add)
	// Required: true
	Password *string `json:"password"`

	// all scenarios installed
	Scenarios []string `json:"scenarios"`
}

type LoginResponse struct {

	// code
	Code int64 `json:"code,omitempty"`

	// expire
	Expire string `json:"expire,omitempty"`

	// token
	Token string `json:"token,omitempty"`
}

type MetricsRequest struct {

	// bouncers
	// Required: true
	Bouncers []*MetricsRequestBouncersItem `json:"bouncers"`

	// machines
	// Required: true
	Machines []*MetricsRequestMachinesItem `json:"machines"`
}

type MetricsRequestBouncersItem struct {

	// bouncer name
	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"`

	// bouncer version
	Version string `json:"version,omitempty"`
}

type MetricsRequestMachinesItem struct {

	// last agent push date
	LastPush string `json:"last_push,omitempty"`

	// last agent update date
	LastUpdate string `json:"last_update,omitempty"`

	// agent name
	Name string `json:"name,omitempty"`

	// agent version
	Version string `json:"version,omitempty"`
}

type RegisterRequest struct {

	// machine_id is a (username) generated by crowdsec
	// Required: true
	// Pattern: ^[a-zA-Z0-9]+$
	MachineID *string `json:"machine_id"`

	// Password, should respect the password policy (link to add)
	// Required: true
	Password *string `json:"password"`
}

type ResetPasswordRequest struct {

	// machine_id is a (username) generated by crowdsec
	// Required: true
	// Max Length: 48
	// Min Length: 48
	// Pattern: ^[a-zA-Z0-9]+$
	MachineID *string `json:"machine_id"`

	// Password, should respect the password policy (link to add)
	// Required: true
	Password *string `json:"password"`
}

type SuccessResponse struct {

	// message
	// Required: true
	Message *string `json:"message"`
}