firewall

Documentation

Index

• type CIDRBlock
• type Client
  • func (c *Client) GetCIDRBlocks() ([]CIDRBlock, error)
  • func (c *Client) GetCIDRBlocksWithContext(ctx context.Context) ([]CIDRBlock, error)
  • func (c *Client) GetService(id int) (Service, error)
  • func (c *Client) GetServiceWithContext(ctx context.Context, id int) (Service, error)
• type LastAction
• type Service

Types

type CIDRBlock

type CIDRBlock struct {
	ID            int
	ServiceID     int
	ServiceName   string
	CIDR          netip.Prefix
	Ports         []int
	CreationDate  civil.Date
	EffectiveDate civil.Date
	ChangeDate    civil.Date
	MinIP         netip.Addr
	MaxIP         netip.Addr
	LastAction    LastAction
}

CIDRBlock represents a CIDR block that is allowed to access an Akamai service under the Firewall Rules Notification API.

type Client

type Client struct {
	Credentials akamai.Credentials
}

A Client allows access to the Akamai Firewall Rules Notification API.

func (*Client) GetCIDRBlocks

func (c *Client) GetCIDRBlocks() ([]CIDRBlock, error)

GetCIDRBlocks returns all CIDR blocks for all services the client is subscribed to.

func (*Client) GetCIDRBlocksWithContext

func (c *Client) GetCIDRBlocksWithContext(ctx context.Context) ([]CIDRBlock, error)

GetCIDRBlocksWithContext returns all CIDR blocks for all services the client is subscribed to.

The context is used to determine whether debugging is enabled and to allow cancellation of the request.

func (*Client) GetService

func (c *Client) GetService(id int) (Service, error)

GetService returns information about a service by ID.

This is a compatibility wrapper around GetServiceWithContext that uses context.Background() as the context.

func (*Client) GetServiceWithContext

func (c *Client) GetServiceWithContext(ctx context.Context, id int) (Service, error)

GetServiceWithContext returns information about a service by ID.

The context is used to determine whether debugging is enabled and to allow cancellation of the request.

type LastAction

type LastAction string

const (
	LastActionOther  LastAction = "other"
	LastActionAdd    LastAction = "add"
	LastActionUpdate LastAction = "update"
	LastActionDelete LastAction = "delete"
)

type Service

type Service struct {
	ID          int    `json:"serviceId"`
	Name        string `json:"serviceName"`
	Description string `json:"description"`
}

Service represents an Akamai service that a client is subscribed to.