client

Documentation

Index

• type APIClient
  • func NewAPIClient(options ...option.ClientOption) *APIClient

Types

type APIClient

type APIClient struct {
	IPAddressManagementAPI *ipam.APIClient
	DNSConfigurationAPI    *dnsconfig.APIClient
	DNSDataAPI             *dnsdata.APIClient
	HostActivationAPI      *infraprovision.APIClient
	InfraManagementAPI     *inframgmt.APIClient
	KeysAPI                *keys.APIClient
	DNSForwardingProxyAPI  *dfp.APIClient
	FWAPI                  *fw.APIClient
	AnycastAPI             *anycast.APIClient
	RedirectAPI            *redirect.APIClient
	UpgradePolicyClientAPI *upgradepolicy.APIClient
}

APIClient is an aggregation of different BloxOne API clients.

func NewAPIClient

func NewAPIClient(options ...option.ClientOption) *APIClient

NewAPIClient creates a new BloxOne API Client. This is an aggregation of different BloxOne API clients. The following clients are available: - IPAddressManagementAPI - DNSConfigurationAPI - DNSDataAPI - HostActivationAPI - InfraManagementAPI - KeysAPI - DNSForwardingProxyAPI - FWAPI - AnycastAPI - UpgradePolicyClientAPI

The client can be configured with a variadic option. The following options are available: - WithClientName(string) sets the name of the client using the SDK. - WithCSPUrl(string) sets the URL for BloxOne Cloud Services Portal. - WithAPIKey(string) sets the APIKey for accessing the BloxOne API. - WithHTTPClient(*http.Client) sets the HTTPClient to use for the SDK. - WithDefaultTags(map[string]string) sets the tags the client can set by default for objects that has tags support. - WithDebug() sets the debug mode.