# Functions
Helper function to get a pointer to bool.
DefaultClient instantiates a new Fastly API client.
NewClient creates a new API client with the given key and the default API endpoint.
NewClientForEndpoint creates a new API client with the given key and API endpoint.
NewHTTPError creates a new HTTP error from the given code.
NewRealtimeStatsClient instantiates a new Fastly API client for the realtime stats.
# Constants
APIKeyEnvVar is the name of the environment variable where the Fastly API key should be read from.
APIKeyHeader is the name of the header that contains the Fastly API key.
CacheSettingActionCache sets the cache to cache.
CacheSettingActionPass sets the cache to pass through.
CacheSettingActionRestart sets the cache to restart the request.
DefaultEndpoint is the default endpoint for Fastly.
DirectorTypeClient is a director that does client direction.
DirectorTypeHash is a director that does hash direction.
DirectorTypeRandom is a director that does random direction.
DirectorTypeRoundRobin is a director that does round-robin direction.
HeaderActionAppend is a header action that appends to an existing header.
HeaderActionDelete is a header action that deletes a header.
HeaderActionRegex is a header action that performs a single regex replacement on a header.
HeaderActionRegexRepeat is a header action that performs a global regex replacement on a header.
HeaderActionSet is a header action that sets or resets a header.
HeaderTypeCache is a header type that performs on the response before it's store in the cache.
HeaderTypeFetch is a header type that performs on the request to the origin server.
HeaderTypeRequest is a header type that performs on the request before lookups.
HeaderTypeResponse is a header type that performs on the response before delivering to the client.
RealtimeStatsEndpoint is the realtime stats endpoint for Fastly.
RequestSettingActionLookup sets request handling to lookup via the cache.
RequestSettingActionPass sets request handling to pass the cache.
RequestSettingXFFAppend adds Fastly X-Forwarded-For headers.
RequestSettingXFFAppendAll appends all Fastly X-Forwarded-For headers.
RequestSettingXFFClear clears any X-Forwarded-For headers.
RequestSettingXFFLeave leaves any X-Forwarded-For headers untouched.
RequestSettingXFFOverwrite clears any X-Forwarded-For headers and replaces with Fastly ones.
No description provided by the author
No description provided by the author
# Variables
ErrMissingAcl is an error that is returned when an unout struct required an "Acl" key, but one is not set.
ErrMissingBackend is an error that is returned when an input struct requires a "Backend" key, but one was not set.
ErrMissingDictionary is an error that is returned when an input struct requires a "Dictionary" key, but one was not set.
ErrMissingDirector is an error that is returned when an input struct requires a "From" key, but one was not set.
ErrMissingFrom is an error that is returned when an input struct requires a "From" key, but one was not set.
ErrMissingID is an error that is returned when an input struct requires an "ID" key, but one was not set.
ErrMissingIP is an error that is returned when an unout struct required an "IP" key, but one is not set.
ErrMissingItemKey is an error that is returned when an input struct requires a "ItemKey" key, but one was not set.
ErrMissingKey is an error that is returned when an input struct requires a "Name" key, but one was not set.
ErrMissingMonth is an error that is returned when an input struct requires a "Month" key, but one was not set.
ErrMissingName is an error that is returned when an input struct requires a "Name" key, but one was not set.
ErrMissingNewName is an erorr that is returned when an input struct requires a "NewName" key, but one was not set.
ErrMissingService is an error that is returned when an input struct requires a "Service" key, but one was not set.
ErrMissingTo is an error that is returned when an input struct requires a "To" key, but one was not set.
ErrMissingURL is an error that is returned when an input struct requires a "Name" key, but one was not set.
ErrMissingVersion is an error that is returned when an input struct requires a "Version" key, but one was not set.
ErrMissingWafID is an error that is returned was an input struct requires a "WafID" key, but one was not set.
ErrMissingYear is an error that is returned when an input struct requires a "Year" key, but one was not set.
ProjectURL is the url for this library.
ProjectVersion is the version of this library.
UserAgent is the user agent for this particular client.
# Structs
No description provided by the author
No description provided by the author
ActivateVCLInput is used as input to the ActivateVCL function.
ActivateVersionInput is the input to the ActivateVersion function.
Backend represents a backend response from the Fastly API.
Billing is the top-level representation of a billing response from the Fastly API.
BillingExtra is a representation of extras (such as SSL addons) from the Fastly API.
BillingStatus is a representation of the status of the bill from the Fastly API.
BillingTotal is a repsentation of the status of the usage for this bill from the Fastly API.
CacheSetting represents a response from Fastly's API for cache settings.
Client is the main entrypoint to the Fastly golang API library.
CloneVersionInput is the input to the CloneVersion function.
Condition represents a condition response from the Fastly API.
CreateACLEntryInput the input parameter to CreateACLEntry function.
CreateACLInput is used as input to the CreateACL function.
CreateBackendInput is used as input to the CreateBackend function.
CreateCacheSettingInput is used as input to the CreateCacheSetting function.
CreateConditionInput is used as input to the CreateCondition function.
CreateDictionaryInput is used as input to the CreateDictionary function.
CreateDictionaryItemInput is used as input to the CreateDictionaryItem function.
CreateDirectorBackendInput is used as input to the CreateDirectorBackend function.
CreateDirectorInput is used as input to the CreateDirector function.
CreateDomainInput is used as input to the CreateDomain function.
CreateFTPInput is used as input to the CreateFTP function.
CreateGCSInput is used as input to the CreateGCS function.
CreateGzipInput is used as input to the CreateGzip function.
CreateHeaderInput is used as input to the CreateHeader function.
CreateHealthCheckInput is used as input to the CreateHealthCheck function.
CreateLogentriesInput is used as input to the CreateLogentries function.
CreatePapertrailInput is used as input to the CreatePapertrail function.
CreateRequestSettingInput is used as input to the CreateRequestSetting function.
CreateResponseObjectInput is used as input to the CreateResponseObject function.
CreateS3Input is used as input to the CreateS3 function.
CreateServiceInput is used as input to the CreateService function.
CreateSumologicInput is used as input to the CreateSumologic function.
CreateSyslogInput is used as input to the CreateSyslog function.
CreateVCLInput is used as input to the CreateVCL function.
CreateVersionInput is the input to the CreateVersion function.
CreateWAFInput is used as input to the CreateWAF function.
DeactivateVersionInput is the input to the DeactivateVersion function.
DeleteACLEntryInput the input parameter to DeleteACLEntry function.
DeleteACLInput is the input parameter to DeleteACL function.
DeleteBackendInput is the input parameter to DeleteBackend.
DeleteCacheSettingInput is the input parameter to DeleteCacheSetting.
DeleteConditionInput is the input parameter to DeleteCondition.
DeleteDictionaryInput is the input parameter to DeleteDictionary.
DeleteDictionaryItemInput is the input parameter to DeleteDictionaryItem.
DeleteDirectorBackendInput is the input parameter to DeleteDirectorBackend.
DeleteDirectorInput is the input parameter to DeleteDirector.
DeleteDomainInput is used as input to the DeleteDomain function.
DeleteFTPInput is the input parameter to DeleteFTP.
DeleteGCSInput is the input parameter to DeleteGCS.
DeleteGzipInput is the input parameter to DeleteGzip.
DeleteHeaderInput is the input parameter to DeleteHeader.
DeleteHealthCheckInput is the input parameter to DeleteHealthCheck.
DeleteLogentriesInput is the input parameter to DeleteLogentries.
DeletePapertrailInput is the input parameter to DeletePapertrail.
DeleteRequestSettingInput is the input parameter to DeleteRequestSetting.
DeleteResponseObjectInput is the input parameter to DeleteResponseObject.
DeleteS3Input is the input parameter to DeleteS3.
DeleteServiceInput is used as input to the DeleteService function.
DeleteSumologicInput is the input parameter to DeleteSumologic.
DeleteSyslogInput is the input parameter to DeleteSyslog.
DeleteVCLInput is the input parameter to DeleteVCL.
DeleteWAFInput is used as input to the GetWAF function.
Dictionary represents a dictionary response from the Fastly API.
DictionaryItem represents a dictionary item response from the Fastly API.
Diff represents a diff of two versions as a response from the Fastly API.
Director represents a director response from the Fastly API.
DirectorBackend is the relationship between a director and a backend in the Fastly API.
Domain represents the the domain name Fastly will serve content for.
EdgeCheck represents an edge check response from the Fastly API.
EdgeCheckInput is used as input to the EdgeCheck function.
EdgeCheckRequest is the request part of an EdgeCheck response.
EdgeCheckResponse is the response part of an EdgeCheck response.
ErrorObject is a single error.
FTP represents an FTP logging response from the Fastly API.
GCS represents an GCS logging response from the Fastly API.
GetACLEntryInput is the input parameter to GetACLEntry function.
GetACLInput is the input parameter to GetACL function.
GetBackendInput is used as input to the GetBackend function.
GetBillingInput is used as input to the GetBilling function.
GetCacheSettingInput is used as input to the GetCacheSetting function.
GetConditionInput is used as input to the GetCondition function.
GetDictionaryInput is used as input to the GetDictionary function.
GetDictionaryItemInput is used as input to the GetDictionaryItem function.
GetDiffInput is used as input to the GetDiff function.
GetDirectorBackendInput is used as input to the GetDirectorBackend function.
GetDirectorInput is used as input to the GetDirector function.
GetDomainInput is used as input to the GetDomain function.
GetFTPInput is used as input to the GetFTP function.
GetGCSInput is used as input to the GetGCS function.
GetGeneratedVCLInput is used as input to the GetGeneratedVCL function.
GetGzipInput is used as input to the GetGzip function.
GetHeaderInput is used as input to the GetHeader function.
GetHealthCheckInput is used as input to the GetHealthCheck function.
GetLogentriesInput is used as input to the GetLogentries function.
GetPapertrailInput is used as input to the GetPapertrail function.
GetRealtimeStatsInput is an input parameter to GetRealtimeStats function.
GetRequestSettingInput is used as input to the GetRequestSetting function.
GetResponseObjectInput is used as input to the GetResponseObject function.
GetS3Input is used as input to the GetS3 function.
GetServiceInput is used as input to the GetService function.
GetSettingsInput is used as input to the GetSettings function.
GetStatsInput is an input to the GetStats function.
GetSumologicInput is used as input to the GetSumologic function.
GetSyslogInput is used as input to the GetSyslog function.
GetUsageInput is used as an input to the GetUsage function Value for the input are described at https://docs.fastly.com/api/stats.
GetVCLInput is used as input to the GetVCL function.
GetVersionInput is the input to the GetVersion function.
GetWAFInput is used as input to the GetWAF function.
Gzip represents an Gzip logging response from the Fastly API.
Header represents a header response from the Fastly API.
HealthCheck represents a health check response from the Fastly API.
HTTPError is a custom error type that wraps an HTTP status code with some helper functions.
LatestVersionInput is the input to the LatestVersion function.
ListACLEntriesInput is the input parameter to ListACLEntries function.
ListACLsInput is used as input to the ListACLs function.
ListBackendsInput is used as input to the ListBackends function.
ListCacheSettingsInput is used as input to the ListCacheSettings function.
ListConditionsInput is used as input to the ListConditions function.
ListDictionariesInput is used as input to the ListDictionaries function.
ListDictionaryItemsInput is used as input to the ListDictionaryItems function.
ListDirectorsInput is used as input to the ListDirectors function.
ListDomainsInput is used as input to the ListDomains function.
ListFTPsInput is used as input to the ListFTPs function.
ListGCSsInput is used as input to the ListGCSs function.
ListGzipsInput is used as input to the ListGzips function.
ListHeadersInput is used as input to the ListHeaders function.
ListHealthChecksInput is used as input to the ListHealthChecks function.
ListLogentriesInput is used as input to the ListLogentries function.
ListPapertrailsInput is used as input to the ListPapertrails function.
ListRequestSettingsInput is used as input to the ListRequestSettings function.
ListResponseObjectsInput is used as input to the ListResponseObjects function.
ListS3sInput is used as input to the ListS3s function.
ListServicesInput is used as input to the ListServices function.
ListSumologicsInput is used as input to the ListSumologics function.
ListSyslogsInput is used as input to the ListSyslogs function.
ListVCLsInput is used as input to the ListVCLs function.
ListVersionsInput is the input to the ListVersions function.
ListWAFsInput is used as input to the ListWAFs function.
LockVersionInput is the input to the LockVersion function.
Logentries represents a logentries response from the Fastly API.
Papertrail represents a papertrail response from the Fastly API.
Purge is a response from a purge request.
PurgeAllInput is used as input to the Purge function.
PurgeInput is used as input to the Purge function.
PurgeKeyInput is used as input to the Purge function.
RealtimeData represents combined stats for all Fastly's POPs and aggregate of them.
RealtimeStats is a response from Fastly's real-time analytics endpoint.
RegionsResponse is a response from Fastly regions API endpoint.
RequestOptions is the list of options to pass to the request.
RequestSetting represents a request setting response from the Fastly API.
ResponseObject represents a response object response from the Fastly API.
RTSClient is the entrypoint to the Fastly's Realtime Stats API.
S3 represents a S3 response from the Fastly API.
SearchServiceInput is used as input to the SearchService function.
Service represents a single service for the Fastly account.
No description provided by the author
Settings represents a backend response from the Fastly API.
Stats represent metrics of a Fastly service.
StatsResponse is a response from the service stats API endpoint.
Sumologic represents a sumologic response from the Fastly API.
Syslog represents a syslog response from the Fastly API.
UpdateACLEntryInput is the input parameter to UpdateACLEntry function.
UpdateACLInput is the input parameter to UpdateACL function.
UpdateBackendInput is used as input to the UpdateBackend function.
UpdateCacheSettingInput is used as input to the UpdateCacheSetting function.
UpdateConditionInput is used as input to the UpdateCondition function.
UpdateDictionaryInput is used as input to the UpdateDictionary function.
UpdateDictionaryItemInput is used as input to the UpdateDictionaryItem function.
UpdateDirectorInput is used as input to the UpdateDirector function.
UpdateDomainInput is used as input to the UpdateDomain function.
UpdateFTPInput is used as input to the UpdateFTP function.
UpdateGCSInput is used as input to the UpdateGCS function.
UpdateGzipInput is used as input to the UpdateGzip function.
UpdateHeaderInput is used as input to the UpdateHeader function.
UpdateHealthCheckInput is used as input to the UpdateHealthCheck function.
UpdateLogentriesInput is used as input to the UpdateLogentries function.
UpdatePapertrailInput is used as input to the UpdatePapertrail function.
UpdateRequestSettingInput is used as input to the UpdateRequestSetting function.
UpdateResponseObjectInput is used as input to the UpdateResponseObject function.
UpdateS3Input is used as input to the UpdateS3 function.
UpdateServiceInput is used as input to the UpdateService function.
UpdateSettingsInput is used as input to the UpdateSettings function.
UpdateSumologicInput is used as input to the UpdateSumologic function.
UpdateSyslogInput is used as input to the UpdateSyslog function.
UpdateVCLInput is used as input to the UpdateVCL function.
UpdateVersionInput is the input to the UpdateVersion function.
UpdateWAFInput is used as input to the UpdateWAF function.
Usage represents usage data of a single service or region.
UsageStatsResponse is a response from the account usage API endpoint.
UsageStatsResponse is a response from the account usage API endpoint.
UsageStatsResponse is a response from the account usage API endpoint.
ValidateVersionInput is the input to the ValidateVersion function.
VCL represents a response about VCL from the Fastly API.
Version represents a distinct configuration version.
WAF is the information about a firewall object.
WAFConfigurationSet represents information about a configuration_set.
# Type aliases
ACLsByName is a sortable list of ACLs.
CacheSettingAction is the type of cache action.
Compatibool is a boolean value that marshalls to 0/1 instead of true/false for compatability with Fastly's API.
DirectorType is a type of director.
HeaderAction is a type of header action.
HeaderType is a type of header.
IPAddrs is a sortable list of IP addresses returned by the Fastly API.
RegionsUsage is a list of aggregated usage data by Fastly's region.
RequestSettingAction is a type of request setting action.
RequestSettingXFF is a type of X-Forwarded-For value to set.
No description provided by the author
ServicesByRegionsUsage is a list of ServicesUsage by Fastly's region.
ServicesUsage is a list of usage data by a service.