Skip to content

feat: add ACLP monitor list entities method #923

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
yec-akamai merged 2 commits into from
Apr 9, 2026
Merged

feat: add ACLP monitor list entities method #923

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
68a5ffc
feat: add ACLP list entities method
shkaruna Mar 27, 2026
ed81c6f
Merge branch 'main' of https://github.com/linode/linodego into feat/a…
shkaruna Apr 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
77 changes: 60 additions & 17 deletions monitor_alert_definitions.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,25 +19,54 @@ const (
AlertDefinitionStatusFailed AlertDefinitionStatus = "failed"
)

// AlertDefinitionScope represents the scope of an alert definition: "account", "entity", or "region". Defaults to "entity".
type AlertDefinitionScope string

const (
AlertDefinitionScopeAccount AlertDefinitionScope = "account"
AlertDefinitionScopeEntity AlertDefinitionScope = "entity"
AlertDefinitionScopeRegion AlertDefinitionScope = "region"
)

// AlertDefinitionEntities represents entity metadata for an alert definition.
// For entity scoped alerts, entities contains the URL to list entities, a count, and a has_more_resources flag.
// For region/account scoped alerts, the entities are returned as an empty object.
type AlertDefinitionEntities struct {
URL string `json:"url"`
Count int `json:"count"`
HasMoreResources bool `json:"has_more_resources"`
}

// AlertDefinitionEntity represents a single entity associated with an alert definition.
type AlertDefinitionEntity struct {
ID string `json:"id"`
Label string `json:"label"`
URL string `json:"url"`
Type string `json:"type"`
}

// AlertDefinition represents an ACLP Alert Definition object
type AlertDefinition struct {
ID int `json:"id"`
Label string `json:"label"`
Severity int `json:"severity"`
Type string `json:"type"`
ServiceType string `json:"service_type"`
Status AlertDefinitionStatus `json:"status"`
HasMoreResources bool `json:"has_more_resources"`
RuleCriteria RuleCriteria `json:"rule_criteria"`
TriggerConditions TriggerConditions `json:"trigger_conditions"`
AlertChannels []AlertChannelEnvelope `json:"alert_channels"`
Created *time.Time `json:"-"`
Updated *time.Time `json:"-"`
UpdatedBy string `json:"updated_by"`
CreatedBy string `json:"created_by"`
EntityIDs []string `json:"entity_ids"`
Description string `json:"description"`
Class string `json:"class"`
ID int `json:"id"`
Label string `json:"label"`
Severity int `json:"severity"`
Type string `json:"type"`
ServiceType string `json:"service_type"`
Status AlertDefinitionStatus `json:"status"`
HasMoreResources bool `json:"has_more_resources"` // Deprecated: use Entities.HasMoreResources.
RuleCriteria RuleCriteria `json:"rule_criteria"`
TriggerConditions TriggerConditions `json:"trigger_conditions"`
AlertChannels []AlertChannelEnvelope `json:"alert_channels"`
Created *time.Time `json:"-"`
Updated *time.Time `json:"-"`
UpdatedBy string `json:"updated_by"`
CreatedBy string `json:"created_by"`
EntityIDs []string `json:"entity_ids"` // Deprecated: use Entities.url to list associated entities.
Description string `json:"description"`
Class string `json:"class"`
Scope AlertDefinitionScope `json:"scope"`
Regions []string `json:"regions"`
Entities AlertDefinitionEntities `json:"entities"`
}

// Backwards-compatible alias
Expand Down Expand Up @@ -143,6 +172,8 @@ type AlertDefinitionCreateOptions struct {
TriggerConditions *TriggerConditions `json:"trigger_conditions,omitempty"`
EntityIDs []string `json:"entity_ids,omitempty"`
Description *string `json:"description,omitempty"`
Scope AlertDefinitionScope `json:"scope,omitempty"`
Regions []string `json:"regions,omitzero"`
}

// AlertDefinitionUpdateOptions are the options used to update an alert definition.
Expand All @@ -155,6 +186,7 @@ type AlertDefinitionUpdateOptions struct {
EntityIDs []string `json:"entity_ids,omitempty"`
Description *string `json:"description,omitempty"`
Status *AlertDefinitionStatus `json:"status,omitempty"`
Regions []string `json:"regions,omitzero"`
}

// UnmarshalJSON implements the json.Unmarshaler interface
Expand Down Expand Up @@ -268,3 +300,14 @@ func (c *Client) DeleteMonitorAlertDefinition(ctx context.Context, serviceType s
e := formatAPIPath("monitor/services/%s/alert-definitions/%d", serviceType, alertID)
return doDELETERequest(ctx, c, e)
}

// ListMonitorAlertDefinitionEntities gets the entities associated with an ACLP Monitor Alert Definition.
func (c *Client) ListMonitorAlertDefinitionEntities(
ctx context.Context,
serviceType string,
alertID int,
opts *ListOptions,
) ([]AlertDefinitionEntity, error) {
e := formatAPIPath("monitor/services/%s/alert-definitions/%d/entities", serviceType, alertID)
return getPaginatedResults[AlertDefinitionEntity](ctx, c, e, opts)
}
Loading
Loading