api

package

Go to main page

Versions in this module

v3

v3.3.0

Apr 24, 2026

Changes in this version

+ const HeaderWebhookResourceID

+ const HeaderWebhookSignature

+ const HeaderWebhookTimestamp

+ const PluginARP

+ const PluginOutscalePublicIP

+ const PluginWebhook

+ var ErrWebhookPayloadInvalid = errors.New("invalid webhook payload")

+ var ErrWebhookRequestBodyMissing = errors.New("webhook request body is required")

+ var ErrWebhookRequestNil = errors.New("webhook request is required")

+ var ErrWebhookSecretMissing = errors.New("webhook secret is required")

+ var ErrWebhookSignatureInvalid = errors.New("invalid X-Link-Webhook-Signature header")

+ var ErrWebhookSignatureMismatch = errors.New("webhook signature does not match")

+ var ErrWebhookSignatureMissing = errors.New("missing X-Link-Webhook-Signature header")

+ var ErrWebhookTimestampMissing = errors.New("missing X-Link-Webhook-Timestamp header")

+ type ARPPluginConfig struct

+ IP string

+ type OutscalePublicIPPluginConfig struct

+ AccessKey string

+ NICID string

+ PublicIPID string

+ Region string

+ SecretKey string

+ type WebhookPluginConfig struct

+ Headers map[string]string

+ ResourceID string

+ Secret string

+ URL string

+ type WebhookPluginStatusChangePayload struct

+ EndpointID string

+ Plugin string

+ ResourceID string

+ Status string

+ func ParseAndValidateWebhook(ctx context.Context, req *http.Request, secret string) (WebhookPluginStatusChangePayload, error)

v3.2.2

Apr 14, 2026

v3.2.1

Jan 2, 2026

v3.2.0

Sep 16, 2025

v3.1.0

Aug 11, 2025

Changes in this version

type Client

+ RotateEncryptionKey func(ctx context.Context) error

type ClientOpt

+ func WithUserAgent(userAgent string) ClientOpt

type HTTPClient

+ func (c HTTPClient) RotateEncryptionKey(ctx context.Context) error

v3.0.2

Jul 24, 2025

v3.0.1

Jun 20, 2025

v3.0.0

Jul 9, 2025

Changes in this version

+ const Activated

+ const Failing

+ const Standby

+ type AddEndpointParams struct

+ Checks []HealthCheck

+ HealthCheckInterval int

+ Plugin string

+ PluginConfig any

+ type Client interface

+ AddEndpoint func(ctx context.Context, params AddEndpointParams) (Endpoint, error)

+ Failover func(ctx context.Context, id string) error

+ GetEndpoint func(ctx context.Context, id string) (Endpoint, error)

+ GetEndpointHosts func(ctx context.Context, id string) ([]Host, error)

+ ListEndpoints func(ctx context.Context) ([]Endpoint, error)

+ RemoveEndpoint func(ctx context.Context, id string) error

+ UpdateEndpoint func(ctx context.Context, id string, params UpdateEndpointParams) (Endpoint, error)

+ Version func(ctx context.Context) (string, error)

+ type ClientOpt func(HTTPClient) HTTPClient

+ func WithPassword(pass string) ClientOpt

+ func WithTimeout(timeout time.Duration) ClientOpt

+ func WithURL(url string) ClientOpt

+ func WithUser(user string) ClientOpt

+ type Endpoint struct

+ Checks []HealthCheck

+ ElectionKey string

+ HealthCheckInterval int

+ ID string

+ Plugin string

+ Status string

+ type EndpointGetResponse struct

+ Endpoint Endpoint

+ type EndpointListResponse struct

+ Endpoints []Endpoint

+ type ErrNotFound struct

+ func (e ErrNotFound) Error() string

+ type GetEndpointHostsResponse struct

+ Hosts []Host

+ type HTTPClient struct

+ func NewHTTPClient(opts ...ClientOpt) HTTPClient

+ func (c HTTPClient) AddEndpoint(ctx context.Context, params AddEndpointParams) (Endpoint, error)

+ func (c HTTPClient) Failover(ctx context.Context, id string) error

+ func (c HTTPClient) GetEndpoint(ctx context.Context, id string) (Endpoint, error)

+ func (c HTTPClient) GetEndpointHosts(ctx context.Context, id string) ([]Host, error)

+ func (c HTTPClient) ListEndpoints(ctx context.Context) ([]Endpoint, error)

+ func (c HTTPClient) RemoveEndpoint(ctx context.Context, id string) error

+ func (c HTTPClient) UpdateEndpoint(ctx context.Context, id string, params UpdateEndpointParams) (Endpoint, error)

+ func (c HTTPClient) Version(ctx context.Context) (string, error)

+ type HealthCheck struct

+ Host string

+ Port int

+ Type HealthCheckType

+ type HealthCheckType string

+ const TCPHealthCheck

+ type Host struct

+ Hostname string

+ type UpdateEndpointParams struct

+ HealthChecks []HealthCheck

Other modules containing this package

github.com/Scalingo/link

github.com/Scalingo/link/v2

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL