fastly-go

fastly-go

A Go client library for interacting with most facets of the Fastly API.

[!WARNING] This API client is auto-generated from Fastly's OpenAPI specification and may not function correctly when used on the Compute platform. Support for Compute is on the roadmap but has not yet been prioritized.

[!TIP] If you'd like to use the hand-written API client instead, see go-fastly.

Requirements

Go version 1.18

Installation

Add the following to your project's go.mod:

require (
	github.com/fastly/fastly-go 1.0.0-beta.44
)

Usage

[!NOTE] The Fastly API requires an API token for most operations.

package main

import (
	"context"
	"fmt"
	"os"

	"github.com/fastly/fastly-go/fastly"
)

func main() {
  cfg := fastly.NewConfiguration()
  apiClient := fastly.NewAPIClient(cfg)
  ctx := fastly.NewAPIKeyContextFromEnv("FASTLY_API_TOKEN")

  req := apiClient.ServiceAPI.CreateService(ctx)

  res, httpResp, err := req.Comment("comment_example").Name("name_example").CustomerID(os.Getenv("FASTLY_CUSTOMER_ID")).ResourceType("vcl").Execute()
  if err != nil {
    fmt.Fprintf(os.Stderr, "Error when calling `ServiceAPI.CreateService`: %+v\n", err)
    fmt.Fprintf(os.Stderr, "Full HTTP response: %+v\n", httpResp)
    return
  }

  fmt.Fprintf(os.Stdout, "Response from `ServiceAPI.CreateService`:\n\n%+v\n\n", res)

  serviceID = *res.ID
  fmt.Printf("Service Name: %s\nService ID: %s\n\n", *res.Name, serviceID)
}

API Endpoints

The main documentation for the Fastly API can be found on our Developer Hub.

Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

• PtrBool
• PtrInt
• PtrInt32
• PtrInt64
• PtrFloat
• PtrFloat32
• PtrFloat64
• PtrString
• PtrTime

Issues

The fastly-go API client currently does not support the following endpoints:

• /alerts/definitions/{definition_id} (DELETE, GET, PUT)
• /alerts/definitions (GET, POST)
• /alerts/history (GET)
• /dns/configurations/{dns_configuration_id} (DELETE, GET, PATCH)
• /dns/configurations (GET, POST)
• /domain-management/v1/domains/{domain_id} (DELETE, GET, PATCH)
• /domain-management/v1/domains (GET, POST)
• /domains/v1/tools/status (GET)
• /domains/v1/tools/suggest (GET)
• /ngwaf/v1/lists/{listID} (DELETE, GET, PATCH)
• /ngwaf/v1/lists (GET, POST)
• /ngwaf/v1/signals/{signal_id} (DELETE, GET, PATCH)
• /ngwaf/v1/signals (GET, POST)
• /ngwaf/v1/timeseries (GET)
• /ngwaf/v1/workspaces/{workspaceID}/lists/{listID} (DELETE, GET, PATCH)
• /ngwaf/v1/workspaces/{workspaceID}/lists (GET, POST)
• /ngwaf/v1/workspaces/{workspace_id}/alerts/{alert_id}/signing-key (GET, POST)
• /ngwaf/v1/workspaces/{workspace_id}/alerts/{alert_id} (DELETE, GET, PATCH)
• /ngwaf/v1/workspaces/{workspace_id}/alerts (GET, POST)
• /ngwaf/v1/workspaces/{workspace_id}/events/{event_id} (GET, PATCH)
• /ngwaf/v1/workspaces/{workspace_id}/events (GET)
• /ngwaf/v1/workspaces/{workspace_id}/redactions/{redaction_id} (DELETE, GET, PATCH)
• /ngwaf/v1/workspaces/{workspace_id}/redactions (GET, POST)
• /ngwaf/v1/workspaces/{workspace_id}/requests/{request_id} (GET)
• /ngwaf/v1/workspaces/{workspace_id}/requests (GET)
• /ngwaf/v1/workspaces/{workspace_id}/rules/{rule_id} (DELETE, GET, PATCH)
• /ngwaf/v1/workspaces/{workspace_id}/rules (GET, POST)
• /ngwaf/v1/workspaces/{workspace_id}/timeseries (GET)
• /ngwaf/v1/workspaces/{workspace_id}/virtual-patches/{virtual_patch_id} (GET, PATCH)
• /ngwaf/v1/workspaces/{workspace_id}/virtual-patches (GET)
• /ngwaf/v1/workspaces/{workspace_id} (DELETE, GET, PATCH)
• /ngwaf/v1/workspaces (GET, POST)
• /notifications/integration-types (GET)
• /notifications/integrations/{integration_id}/rotateSigningKey (POST)
• /notifications/integrations/{integration_id}/signingKey (GET)
• /notifications/integrations/{integration_id} (DELETE, GET, PATCH)
• /notifications/integrations (GET, POST)
• /notifications/mailinglist-confirmations (POST)
• /observability/aggregations (GET)
• /observability/log-explorer (GET)
• /observability/timeseries (GET)
• /observability/timeseries (GET)
• /resources/stores/kv/{store_id}/batch (PUT)
• /security/workspaces/{workspace_id}/events/{event_id} (GET, PATCH)
• /security/workspaces/{workspace_id}/events (GET)
• /security/workspaces/{workspace_id}/redactions/{redaction_id} (DELETE, GET, PATCH)
• /security/workspaces/{workspace_id}/redactions (GET, POST)
• /security/workspaces/{workspace_id}/requests/{request_id} (GET)
• /security/workspaces/{workspace_id}/requests (GET)
• /security/workspaces/{workspace_id}/rules/{rule_id} (DELETE, GET, PATCH)
• /security/workspaces/{workspace_id}/rules (GET, POST)
• /security/workspaces/{workspace_id}/timeseries (GET)
• /security/workspaces/{workspace_id}/virtual-patches/{virtual_patch_id} (GET, PATCH)
• /security/workspaces/{workspace_id}/virtual-patches (GET)
• /security/workspaces/{workspace_id} (DELETE, GET, PATCH)
• /security/workspaces (GET, POST)
• /tls/activations/{tls_activation_id} (GET, PATCH)
• /tls/activations (GET)
• /tls/configurations/{tls_configuration_id} (DELETE, GET, PATCH)
• /tls/configurations (GET, POST)
• /v1/channel/{service_id}/ts/h/limit/{max_entries} (GET)
• /v1/channel/{service_id}/ts/h (GET)
• /v1/channel/{service_id}/ts/{start_timestamp} (GET)

If you encounter any non-security-related bug or unexpected behavior, please file an issue using the bug report template.

Security issues

Please see our SECURITY.md for guidance on reporting security-related issues.

License

MIT.