cloudflare

package module
v2.3.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 18, 2024 License: Apache-2.0 Imports: 98 Imported by: 2

README

Cloudflare Go API Library

Go Reference

The Cloudflare Go library provides convenient access to the Cloudflare REST API from applications written in Go. The full API of this library can be found in api.md.

Installation

import (
	"github.com/cloudflare/cloudflare-go/v2" // imported as cloudflare
)

Or to pin the version:

go get -u 'github.com/cloudflare/cloudflare-go/v2@v2.3.0'

Requirements

This library requires Go 1.18+.

Usage

The full API of this library can be found in api.md.

package main

import (
	"context"
	"fmt"

	"github.com/cloudflare/cloudflare-go/v2"
	"github.com/cloudflare/cloudflare-go/v2/option"
	"github.com/cloudflare/cloudflare-go/v2/zones"
)

func main() {
	client := cloudflare.NewClient(
		option.WithAPIKey("144c9defac04969c7bfad8efaa8ea194"), // defaults to os.LookupEnv("CLOUDFLARE_API_KEY")
		option.WithAPIEmail("user@example.com"),               // defaults to os.LookupEnv("CLOUDFLARE_EMAIL")
	)
	zone, err := client.Zones.New(context.TODO(), zones.ZoneNewParams{
		Account: cloudflare.F(zones.ZoneNewParamsAccount{
			ID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
		}),
		Name: cloudflare.F("example.com"),
		Type: cloudflare.F(zones.TypeFull),
	})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", zone.ID)
}
Request fields

All request parameters are wrapped in a generic Field type, which we use to distinguish zero values from null or omitted fields.

This prevents accidentally sending a zero value if you forget a required parameter, and enables explicitly sending null, false, '', or 0 on optional parameters. Any field not specified is not sent.

To construct fields with values, use the helpers String(), Int(), Float(), or most commonly, the generic F[T](). To send a null, use Null[T](), and to send a nonconforming value, use Raw[T](any). For example:

params := FooParams{
	Name: cloudflare.F("hello"),

	// Explicitly send `"description": null`
	Description: cloudflare.Null[string](),

	Point: cloudflare.F(cloudflare.Point{
		X: cloudflare.Int(0),
		Y: cloudflare.Int(1),

		// In cases where the API specifies a given type,
		// but you want to send something else, use `Raw`:
		Z: cloudflare.Raw[int64](0.01), // sends a float
	}),
}
Response objects

All fields in response structs are value types (not pointers or wrappers).

If a given field is null, not present, or invalid, the corresponding field will simply be its zero value.

All response structs also include a special JSON field, containing more detailed information about each property, which you can use like so:

if res.Name == "" {
	// true if `"name"` is either not present or explicitly null
	res.JSON.Name.IsNull()

	// true if the `"name"` key was not present in the repsonse JSON at all
	res.JSON.Name.IsMissing()

	// When the API returns data that cannot be coerced to the expected type:
	if res.JSON.Name.IsInvalid() {
		raw := res.JSON.Name.Raw()

		legacyName := struct{
			First string `json:"first"`
			Last  string `json:"last"`
		}{}
		json.Unmarshal([]byte(raw), &legacyName)
		name = legacyName.First + " " + legacyName.Last
	}
}

These .JSON structs also include an Extras map containing any properties in the json response that were not specified in the struct. This can be useful for API features not yet present in the SDK.

body := res.JSON.ExtraFields["my_unexpected_field"].Raw()
RequestOptions

This library uses the functional options pattern. Functions defined in the option package return a RequestOption, which is a closure that mutates a RequestConfig. These options can be supplied to the client or at individual requests. For example:

client := cloudflare.NewClient(
	// Adds a header to every request made by the client
	option.WithHeader("X-Some-Header", "custom_header_info"),
)

client.Zones.New(context.TODO(), ...,
	// Override the header
	option.WithHeader("X-Some-Header", "some_other_custom_header_info"),
	// Add an undocumented field to the request body, using sjson syntax
	option.WithJSONSet("some.json.path", map[string]string{"my": "object"}),
)

See the full list of request options.

Pagination

This library provides some conveniences for working with paginated list endpoints.

You can use .ListAutoPaging() methods to iterate through items across all pages:

iter := client.Accounts.ListAutoPaging(context.TODO(), accounts.AccountListParams{})
// Automatically fetches more pages as needed.
for iter.Next() {
	accountListResponse := iter.Current()
	fmt.Printf("%+v\n", accountListResponse)
}
if err := iter.Err(); err != nil {
	panic(err.Error())
}

Or you can use simple .List() methods to fetch a single page and receive a standard response object with additional helper methods like .GetNextPage(), e.g.:

page, err := client.Accounts.List(context.TODO(), accounts.AccountListParams{})
for page != nil {
	for _, account := range page.Result {
		fmt.Printf("%+v\n", account)
	}
	page, err = page.GetNextPage()
}
if err != nil {
	panic(err.Error())
}
Errors

When the API returns a non-success status code, we return an error with type *cloudflare.Error. This contains the StatusCode, *http.Request, and *http.Response values of the request, as well as the JSON of the error body (much like other response objects in the SDK).

To handle errors, we recommend that you use the errors.As pattern:

_, err := client.Zones.Get(context.TODO(), zones.ZoneGetParams{
	ZoneID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
})
if err != nil {
	var apierr *cloudflare.Error
	if errors.As(err, &apierr) {
		println(string(apierr.DumpRequest(true)))  // Prints the serialized HTTP request
		println(string(apierr.DumpResponse(true))) // Prints the serialized HTTP response
	}
	panic(err.Error()) // GET "/zones/{zone_id}": 400 Bad Request { ... }
}

When other errors occur, they are returned unwrapped; for example, if HTTP transport fails, you might receive *url.Error wrapping *net.OpError.

Timeouts

Requests do not time out by default; use context to configure a timeout for a request lifecycle.

Note that if a request is retried, the context timeout does not start over. To set a per-retry timeout, use option.WithRequestTimeout().

// This sets the timeout for the request, including all the retries.
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Minute)
defer cancel()
client.Zones.Edit(
	ctx,
	zones.ZoneEditParams{
		ZoneID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
	},
	// This sets the per-retry timeout
	option.WithRequestTimeout(20*time.Second),
)
File uploads

Request parameters that correspond to file uploads in multipart requests are typed as param.Field[io.Reader]. The contents of the io.Reader will by default be sent as a multipart form part with the file name of "anonymous_file" and content-type of "application/octet-stream".

The file name and content-type can be customized by implementing Name() string or ContentType() string on the run-time type of io.Reader. Note that os.File implements Name() string, so a file returned by os.Open will be sent with the file name on disk.

We also provide a helper cloudflare.FileParam(reader io.Reader, filename string, contentType string) which can be used to wrap any io.Reader with the appropriate file name and content type.

Retries

Certain errors will be automatically retried 2 times by default, with a short exponential backoff. We retry by default all connection errors, 408 Request Timeout, 409 Conflict, 429 Rate Limit, and >=500 Internal errors.

You can use the WithMaxRetries option to configure or disable this:

// Configure the default for all requests:
client := cloudflare.NewClient(
	option.WithMaxRetries(0), // default is 2
)

// Override per-request:
client.Zones.Get(
	context.TODO(),
	zones.ZoneGetParams{
		ZoneID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
	},
	option.WithMaxRetries(5),
)
Making custom/undocumented requests

This library is typed for convenient access to the documented API. If you need to access undocumented endpoints, params, or response properties, the library can still be used.

Undocumented endpoints

To make requests to undocumented endpoints, you can use client.Get, client.Post, and other HTTP verbs. RequestOptions on the client, such as retries, will be respected when making these requests.

var (
    // params can be an io.Reader, a []byte, an encoding/json serializable object,
    // or a "…Params" struct defined in this library.
    params map[string]interface{}

    // result can be an []byte, *http.Response, a encoding/json deserializable object,
    // or a model defined in this library.
    result *http.Response
)
err := client.Post(context.Background(), "/unspecified", params, &result)
if err != nil {
    …
}
Undocumented request params

To make requests using undocumented parameters, you may use either the option.WithQuerySet() or the option.WithJSONSet() methods.

params := FooNewParams{
    ID:   cloudflare.F("id_xxxx"),
    Data: cloudflare.F(FooNewParamsData{
        FirstName: cloudflare.F("John"),
    }),
}
client.Foo.New(context.Background(), params, option.WithJSONSet("data.last_name", "Doe"))
Undocumented response properties

To access undocumented response properties, you may either access the raw JSON of the response as a string with result.JSON.RawJSON(), or get the raw JSON of a particular field on the result with result.JSON.Foo.Raw().

Any fields that are not present on the response struct will be saved and can be accessed by result.JSON.ExtraFields() which returns the extra fields as a map[string]Field.

Middleware

We provide option.WithMiddleware which applies the given middleware to requests.

func Logger(req *http.Request, next option.MiddlewareNext) (res *http.Response, err error) {
	// Before the request
	start := time.Now()
	LogReq(req)

	// Forward the request to the next handler
	res, err = next(req)

	// Handle stuff after the request
	end := time.Now()
	LogRes(res, err, start - end)

    return res, err
}

client := cloudflare.NewClient(
	option.WithMiddleware(Logger),
)

When multiple middlewares are provided as variadic arguments, the middlewares are applied left to right. If option.WithMiddleware is given multiple times, for example first in the client then the method, the middleware in the client will run first and the middleware given in the method will run next.

You may also replace the default http.Client with option.WithHTTPClient(client). Only one http client is accepted (this overwrites any previous client) and receives requests after any middleware has been applied.

Semantic versioning

This package generally follows SemVer conventions, though certain backwards-incompatible changes may be released as minor versions:

  1. Changes to library internals which are technically public but not intended or documented for external use. (Please open a GitHub issue to let us know if you are relying on such internals).
  2. Changes that we do not expect to impact the vast majority of users in practice.

We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.

We are keen for your feedback; please open an issue with questions, bugs, or suggestions.

Documentation

Index

Constants

View Source 
const AuditLogActorTypeAdmin = shared.AuditLogActorTypeAdmin

This is an alias to an internal value.

View Source 
const AuditLogActorTypeCloudflare = shared.AuditLogActorTypeCloudflare

This is an alias to an internal value.

View Source 
const AuditLogActorTypeUser = shared.AuditLogActorTypeUser

This is an alias to an internal value.

View Source 
const CertificateCADigicert = shared.CertificateCADigicert

This is an alias to an internal value.

View Source 
const CertificateCAGoogle = shared.CertificateCAGoogle

This is an alias to an internal value.

View Source 
const CertificateCALetsEncrypt = shared.CertificateCALetsEncrypt

This is an alias to an internal value.

View Source 
const CertificateRequestTypeKeylessCertificate = shared.CertificateRequestTypeKeylessCertificate

This is an alias to an internal value.

View Source 
const CertificateRequestTypeOriginECC = shared.CertificateRequestTypeOriginECC

This is an alias to an internal value.

View Source 
const CertificateRequestTypeOriginRSA = shared.CertificateRequestTypeOriginRSA

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusDegraded = shared.CloudflareTunnelStatusDegraded

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusDown = shared.CloudflareTunnelStatusDown

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusHealthy = shared.CloudflareTunnelStatusHealthy

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusInactive = shared.CloudflareTunnelStatusInactive

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeCNI = shared.CloudflareTunnelTunTypeCNI

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeCfdTunnel = shared.CloudflareTunnelTunTypeCfdTunnel

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeGRE = shared.CloudflareTunnelTunTypeGRE

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeIPSec = shared.CloudflareTunnelTunTypeIPSec

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeWARPConnector = shared.CloudflareTunnelTunTypeWARPConnector

This is an alias to an internal value.

View Source 
const MemberStatusAccepted = shared.MemberStatusAccepted

This is an alias to an internal value.

View Source 
const MemberStatusPending = shared.MemberStatusPending

This is an alias to an internal value.

View Source 
const SortDirectionAsc = shared.SortDirectionAsc

This is an alias to an internal value.

View Source 
const SortDirectionDesc = shared.SortDirectionDesc

This is an alias to an internal value.

Variables

This section is empty.

Functions

func Bool 

func Bool(value bool) param.Field[bool]

Bool is a param field helper which helps specify bools.

func F 

func F[T any](value T) param.Field[T]

F is a param field helper used to initialize a param.Field generic struct. This helps specify null, zero values, and overrides, as well as normal values. You can read more about this in our README.

func FileParam 

func FileParam(reader io.Reader, filename string, contentType string) param.Field[io.Reader]

FileParam is a param field helper which helps files with a mime content-type.

func Float 

func Float(value float64) param.Field[float64]

Float is a param field helper which helps specify floats.

func Int 

func Int(value int64) param.Field[int64]

Int is a param field helper which helps specify integers. This is particularly helpful when specifying integer constants for fields.

func Null 

func Null[T any]() param.Field[T]

Null is a param field helper which explicitly sends null to the API.

func Raw 

func Raw[T any](value any) param.Field[T]

Raw is a param field helper for specifying values for fields when the type you are looking to send is different from the type that is specified in the SDK. For example, if the type of the field is an integer, but you want to send a float, you could do that by setting the corresponding field with Raw[int](0.5).

func String 

func String(value string) param.Field[string]

String is a param field helper which helps specify strings.

Types

type ASN added in v2.1.0 

type ASN = shared.ASN

This is an alias to an internal type.

type ASNParam added in v2.1.0 

type ASNParam = shared.ASNParam

This is an alias to an internal type.

type AuditLog 

type AuditLog = shared.AuditLog

This is an alias to an internal type.

type AuditLogAction 

type AuditLogAction = shared.AuditLogAction

This is an alias to an internal type.

type AuditLogActor 

type AuditLogActor = shared.AuditLogActor

This is an alias to an internal type.

type AuditLogActorType 

type AuditLogActorType = shared.AuditLogActorType

The type of actor, whether a User, Cloudflare Admin, or an Automated System.

This is an alias to an internal type.

type AuditLogOwner 

type AuditLogOwner = shared.AuditLogOwner

This is an alias to an internal type.

type AuditLogResource 

type AuditLogResource = shared.AuditLogResource

This is an alias to an internal type.

type CertificateCA added in v2.2.0 

type CertificateCA = shared.CertificateCA

The Certificate Authority that will issue the certificate

This is an alias to an internal type.

type CertificateRequestType added in v2.2.0 

type CertificateRequestType = shared.CertificateRequestType

Signature type desired on certificate ("origin-rsa" (rsa), "origin-ecc" (ecdsa), or "keyless-certificate" (for Keyless SSL servers).

This is an alias to an internal type.

type Client 

type Client struct {
	Options                     []option.RequestOption
	Accounts                    *accounts.AccountService
	OriginCACertificates        *origin_ca_certificates.OriginCACertificateService
	IPs                         *ips.IPService
	Memberships                 *memberships.MembershipService
	User                        *user.UserService
	Zones                       *zones.ZoneService
	LoadBalancers               *load_balancers.LoadBalancerService
	Cache                       *cache.CacheService
	SSL                         *ssl.SSLService
	Subscriptions               *subscriptions.SubscriptionService
	ACM                         *acm.ACMService
	Argo                        *argo.ArgoService
	Plans                       *plans.PlanService
	RatePlans                   *rate_plans.RatePlanService
	CertificateAuthorities      *certificate_authorities.CertificateAuthorityService
	ClientCertificates          *client_certificates.ClientCertificateService
	CustomCertificates          *custom_certificates.CustomCertificateService
	CustomHostnames             *custom_hostnames.CustomHostnameService
	CustomNameservers           *custom_nameservers.CustomNameserverService
	DNS                         *dns.DNSService
	DNSSEC                      *dnssec.DNSSECService
	EmailRouting                *email_routing.EmailRoutingService
	Filters                     *filters.FilterService
	Firewall                    *firewall.FirewallService
	Healthchecks                *healthchecks.HealthcheckService
	KeylessCertificates         *keyless_certificates.KeylessCertificateService
	Logpush                     *logpush.LogpushService
	Logs                        *logs.LogService
	OriginTLSClientAuth         *origin_tls_client_auth.OriginTLSClientAuthService
	Pagerules                   *pagerules.PageruleService
	RateLimits                  *rate_limits.RateLimitService
	SecondaryDNS                *secondary_dns.SecondaryDNSService
	WaitingRooms                *waiting_rooms.WaitingRoomService
	Web3                        *web3.Web3Service
	Workers                     *workers.WorkerService
	KV                          *kv.KVService
	DurableObjects              *durable_objects.DurableObjectService
	Queues                      *queues.QueueService
	APIGateway                  *api_gateway.APIGatewayService
	ManagedHeaders              *managed_headers.ManagedHeaderService
	PageShield                  *page_shield.PageShieldService
	Rulesets                    *rulesets.RulesetService
	URLNormalization            *url_normalization.URLNormalizationService
	Spectrum                    *spectrum.SpectrumService
	Addressing                  *addressing.AddressingService
	AuditLogs                   *audit_logs.AuditLogService
	Billing                     *billing.BillingService
	BrandProtection             *brand_protection.BrandProtectionService
	Diagnostics                 *diagnostics.DiagnosticService
	Images                      *images.ImageService
	Intel                       *intel.IntelService
	MagicTransit                *magic_transit.MagicTransitService
	MagicNetworkMonitoring      *magic_network_monitoring.MagicNetworkMonitoringService
	MTLSCertificates            *mtls_certificates.MTLSCertificateService
	Pages                       *pages.PageService
	PCAPs                       *pcaps.PCAPService
	Registrar                   *registrar.RegistrarService
	RequestTracers              *request_tracers.RequestTracerService
	Rules                       *rules.RuleService
	Storage                     *storage.StorageService
	Stream                      *stream.StreamService
	Alerting                    *alerting.AlertingService
	D1                          *d1.D1Service
	R2                          *r2.R2Service
	WARPConnector               *warp_connector.WARPConnectorService
	WorkersForPlatforms         *workers_for_platforms.WorkersForPlatformService
	ZeroTrust                   *zero_trust.ZeroTrustService
	Challenges                  *challenges.ChallengeService
	Hyperdrive                  *hyperdrive.HyperdriveService
	RUM                         *rum.RUMService
	Vectorize                   *vectorize.VectorizeService
	URLScanner                  *url_scanner.URLScannerService
	Radar                       *radar.RadarService
	BotManagement               *bot_management.BotManagementService
	OriginPostQuantumEncryption *origin_post_quantum_encryption.OriginPostQuantumEncryptionService
	Speed                       *speed.SpeedService
	DCVDelegation               *dcv_delegation.DCVDelegationService
	Hostnames                   *hostnames.HostnameService
	Snippets                    *snippets.SnippetService
	Calls                       *calls.CallService
	CloudforceOne               *cloudforce_one.CloudforceOneService
	EventNotifications          *event_notifications.EventNotificationService
	AIGateway                   *ai_gateway.AIGatewayService
	IAM                         *IAMService
}

Client creates a struct with services and top level methods that help with interacting with the cloudflare API. You should not instantiate this client directly, and instead use the NewClient method instead.

func NewClient 

func NewClient(opts ...option.RequestOption) (r *Client)

NewClient generates a new client with the default option read from the environment (CLOUDFLARE_API_TOKEN, CLOUDFLARE_API_KEY, CLOUDFLARE_EMAIL, CLOUDFLARE_API_USER_SERVICE_KEY). The option passed in as arguments are applied after these default arguments, and all option will be passed down to the services and requests that this client makes.

func (*Client) Delete 

func (r *Client) Delete(ctx context.Context, path string, params interface{}, res interface{}, opts ...option.RequestOption) error

Delete makes a DELETE request with the given URL, params, and optionally deserializes to a response. See [Execute] documentation on the params and response.

func (*Client) Execute 

func (r *Client) Execute(ctx context.Context, method string, path string, params interface{}, res interface{}, opts ...option.RequestOption) error

Execute makes a request with the given context, method, URL, request params, response, and request options. This is useful for hitting undocumented endpoints while retaining the base URL, auth, retries, and other options from the client.

If a byte slice or an io.Reader is supplied to params, it will be used as-is for the request body.

The params is by default serialized into the body using encoding/json. If your type implements a MarshalJSON function, it will be used instead to serialize the request. If a URLQuery method is implemented, the returned url.Values will be used as query strings to the url.

If your params struct uses param.Field, you must provide either [MarshalJSON], [URLQuery], and/or [MarshalForm] functions. It is undefined behavior to use a struct uses param.Field without specifying how it is serialized.

Any "…Params" object defined in this library can be used as the request argument. Note that 'path' arguments will not be forwarded into the url.

The response body will be deserialized into the res variable, depending on its type:

  • A pointer to a *http.Response is populated by the raw response.
  • A pointer to a byte array will be populated with the contents of the request body.
  • A pointer to any other type uses this library's default JSON decoding, which respects UnmarshalJSON if it is defined on the type.
  • A nil value will not read the response body.

For even greater flexibility, see option.WithResponseInto and option.WithResponseBodyInto.

func (*Client) Get 

func (r *Client) Get(ctx context.Context, path string, params interface{}, res interface{}, opts ...option.RequestOption) error

Get makes a GET request with the given URL, params, and optionally deserializes to a response. See [Execute] documentation on the params and response.

func (*Client) Patch 

func (r *Client) Patch(ctx context.Context, path string, params interface{}, res interface{}, opts ...option.RequestOption) error

Patch makes a PATCH request with the given URL, params, and optionally deserializes to a response. See [Execute] documentation on the params and response.

func (*Client) Post 

func (r *Client) Post(ctx context.Context, path string, params interface{}, res interface{}, opts ...option.RequestOption) error

Post makes a POST request with the given URL, params, and optionally deserializes to a response. See [Execute] documentation on the params and response.

func (*Client) Put 

func (r *Client) Put(ctx context.Context, path string, params interface{}, res interface{}, opts ...option.RequestOption) error

Put makes a PUT request with the given URL, params, and optionally deserializes to a response. See [Execute] documentation on the params and response.

type CloudflareTunnel 

type CloudflareTunnel = shared.CloudflareTunnel

A Cloudflare Tunnel that connects your origin to Cloudflare's edge.

This is an alias to an internal type.

type CloudflareTunnelConnection 

type CloudflareTunnelConnection = shared.CloudflareTunnelConnection

This is an alias to an internal type.

type CloudflareTunnelStatus added in v2.3.0 

type CloudflareTunnelStatus = shared.CloudflareTunnelStatus

The status of the tunnel. Valid values are `inactive` (tunnel has never been run), `degraded` (tunnel is active and able to serve traffic but in an unhealthy state), `healthy` (tunnel is active and able to serve traffic), or `down` (tunnel can not serve traffic as it has no connections to the Cloudflare Edge).

This is an alias to an internal type.

type CloudflareTunnelTunType 

type CloudflareTunnelTunType = shared.CloudflareTunnelTunType

The type of tunnel.

This is an alias to an internal type.

type Error 

type Error = apierror.Error

type ErrorData 

type ErrorData = shared.ErrorData

This is an alias to an internal type.

type IAMPermissionGroupGetParams added in v2.3.0 

type IAMPermissionGroupGetParams struct {
	// Account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
}

type IAMPermissionGroupGetResponse added in v2.3.0 

type IAMPermissionGroupGetResponse struct {
	// Identifier of the group.
	ID string `json:"id,required"`
	// Attributes associated to the permission group.
	Meta interface{} `json:"meta"`
	// Name of the group.
	Name string                            `json:"name"`
	JSON iamPermissionGroupGetResponseJSON `json:"-"`
}

A named group of permissions that map to a group of operations against resources.

func (*IAMPermissionGroupGetResponse) UnmarshalJSON added in v2.3.0 

func (r *IAMPermissionGroupGetResponse) UnmarshalJSON(data []byte) (err error)

type IAMPermissionGroupListParams added in v2.3.0 

type IAMPermissionGroupListParams struct {
	// Account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
	// ID of the permission group to be fetched.
	ID param.Field[string] `query:"id"`
	// Label of the permission group to be fetched.
	Label param.Field[string] `query:"label"`
	// Name of the permission group to be fetched.
	Name param.Field[string] `query:"name"`
	// Page number of paginated results.
	Page param.Field[float64] `query:"page"`
	// Maximum number of results per page.
	PerPage param.Field[float64] `query:"per_page"`
}

func (IAMPermissionGroupListParams) URLQuery added in v2.3.0 

func (r IAMPermissionGroupListParams) URLQuery() (v url.Values)

URLQuery serializes IAMPermissionGroupListParams's query parameters as `url.Values`.

type IAMPermissionGroupListResponse added in v2.3.0 

type IAMPermissionGroupListResponse = interface{}

type IAMPermissionGroupService added in v2.3.0 

type IAMPermissionGroupService struct {
	Options []option.RequestOption
}

IAMPermissionGroupService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewIAMPermissionGroupService method instead.

func NewIAMPermissionGroupService added in v2.3.0 

func NewIAMPermissionGroupService(opts ...option.RequestOption) (r *IAMPermissionGroupService)

NewIAMPermissionGroupService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*IAMPermissionGroupService) Get added in v2.3.0 

func (r *IAMPermissionGroupService) Get(ctx context.Context, permissionGroupID string, query IAMPermissionGroupGetParams, opts ...option.RequestOption) (res *IAMPermissionGroupGetResponse, err error)

Get information about a specific permission group in an account.

func (*IAMPermissionGroupService) List added in v2.3.0 

func (r *IAMPermissionGroupService) List(ctx context.Context, params IAMPermissionGroupListParams, opts ...option.RequestOption) (res *pagination.V4PagePaginationArray[IAMPermissionGroupListResponse], err error)

List all the permissions groups for an account.

func (*IAMPermissionGroupService) ListAutoPaging added in v2.3.0 

func (r *IAMPermissionGroupService) ListAutoPaging(ctx context.Context, params IAMPermissionGroupListParams, opts ...option.RequestOption) *pagination.V4PagePaginationArrayAutoPager[IAMPermissionGroupListResponse]

List all the permissions groups for an account.

type IAMResourceGroupDeleteParams added in v2.3.0 

type IAMResourceGroupDeleteParams struct {
	// Account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
}

type IAMResourceGroupDeleteResponse added in v2.3.0 

type IAMResourceGroupDeleteResponse struct {
	// Identifier
	ID   string                             `json:"id,required"`
	JSON iamResourceGroupDeleteResponseJSON `json:"-"`
}

func (*IAMResourceGroupDeleteResponse) UnmarshalJSON added in v2.3.0 

func (r *IAMResourceGroupDeleteResponse) UnmarshalJSON(data []byte) (err error)

type IAMResourceGroupDeleteResponseEnvelope added in v2.3.0 

type IAMResourceGroupDeleteResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful
	Success IAMResourceGroupDeleteResponseEnvelopeSuccess `json:"success,required"`
	Result  IAMResourceGroupDeleteResponse                `json:"result,nullable"`
	JSON    iamResourceGroupDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*IAMResourceGroupDeleteResponseEnvelope) UnmarshalJSON added in v2.3.0 

func (r *IAMResourceGroupDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type IAMResourceGroupDeleteResponseEnvelopeSuccess added in v2.3.0 

type IAMResourceGroupDeleteResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	IAMResourceGroupDeleteResponseEnvelopeSuccessTrue IAMResourceGroupDeleteResponseEnvelopeSuccess = true
)

func (IAMResourceGroupDeleteResponseEnvelopeSuccess) IsKnown added in v2.3.0 

func (r IAMResourceGroupDeleteResponseEnvelopeSuccess) IsKnown() bool

type IAMResourceGroupGetParams added in v2.3.0 

type IAMResourceGroupGetParams struct {
	// Account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
}

type IAMResourceGroupGetResponse added in v2.3.0 

type IAMResourceGroupGetResponse struct {
	// Identifier of the group.
	ID string `json:"id,required"`
	// The scope associated to the resource group
	Scope []IAMResourceGroupGetResponseScope `json:"scope,required"`
	// Attributes associated to the resource group.
	Meta interface{} `json:"meta"`
	// Name of the resource group.
	Name string                          `json:"name"`
	JSON iamResourceGroupGetResponseJSON `json:"-"`
}

A group of scoped resources.

func (*IAMResourceGroupGetResponse) UnmarshalJSON added in v2.3.0 

func (r *IAMResourceGroupGetResponse) UnmarshalJSON(data []byte) (err error)

type IAMResourceGroupGetResponseScope added in v2.3.0 

type IAMResourceGroupGetResponseScope struct {
	// This is a combination of pre-defined resource name and identifier (like Account
	// ID etc.)
	Key string `json:"key,required"`
	// A list of scope objects for additional context.
	Objects []IAMResourceGroupGetResponseScopeObject `json:"objects,required"`
	JSON    iamResourceGroupGetResponseScopeJSON     `json:"-"`
}

A scope is a combination of scope objects which provides additional context.

func (*IAMResourceGroupGetResponseScope) UnmarshalJSON added in v2.3.0 

func (r *IAMResourceGroupGetResponseScope) UnmarshalJSON(data []byte) (err error)

type IAMResourceGroupGetResponseScopeObject added in v2.3.0 

type IAMResourceGroupGetResponseScopeObject struct {
	// This is a combination of pre-defined resource name and identifier (like Zone ID
	// etc.)
	Key  string                                     `json:"key,required"`
	JSON iamResourceGroupGetResponseScopeObjectJSON `json:"-"`
}

A scope object represents any resource that can have actions applied against invite.

func (*IAMResourceGroupGetResponseScopeObject) UnmarshalJSON added in v2.3.0 

func (r *IAMResourceGroupGetResponseScopeObject) UnmarshalJSON(data []byte) (err error)

type IAMResourceGroupListParams added in v2.3.0 

type IAMResourceGroupListParams struct {
	// Account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
	// ID of the resource group to be fetched.
	ID param.Field[string] `query:"id"`
	// Name of the resource group to be fetched.
	Name param.Field[string] `query:"name"`
	// Page number of paginated results.
	Page param.Field[float64] `query:"page"`
	// Maximum number of results per page.
	PerPage param.Field[float64] `query:"per_page"`
}

func (IAMResourceGroupListParams) URLQuery added in v2.3.0 

func (r IAMResourceGroupListParams) URLQuery() (v url.Values)

URLQuery serializes IAMResourceGroupListParams's query parameters as `url.Values`.

type IAMResourceGroupListResponse added in v2.3.0 

type IAMResourceGroupListResponse = interface{}

type IAMResourceGroupNewParams added in v2.3.0 

type IAMResourceGroupNewParams struct {
	// Account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
	// A scope is a combination of scope objects which provides additional context.
	Scope param.Field[IAMResourceGroupNewParamsScope] `json:"scope,required"`
	// Attributes associated to the resource group.
	Meta param.Field[interface{}] `json:"meta"`
}

func (IAMResourceGroupNewParams) MarshalJSON added in v2.3.0 

func (r IAMResourceGroupNewParams) MarshalJSON() (data []byte, err error)

type IAMResourceGroupNewParamsScope added in v2.3.0 

type IAMResourceGroupNewParamsScope struct {
	// This is a combination of pre-defined resource name and identifier (like Account
	// ID etc.)
	Key param.Field[string] `json:"key,required"`
	// A list of scope objects for additional context. The number of Scope objects
	// should not be zero.
	Objects param.Field[[]IAMResourceGroupNewParamsScopeObject] `json:"objects,required"`
}

A scope is a combination of scope objects which provides additional context.

func (IAMResourceGroupNewParamsScope) MarshalJSON added in v2.3.0 

func (r IAMResourceGroupNewParamsScope) MarshalJSON() (data []byte, err error)

type IAMResourceGroupNewParamsScopeObject added in v2.3.0 

type IAMResourceGroupNewParamsScopeObject struct {
	// This is a combination of pre-defined resource name and identifier (like Zone ID
	// etc.)
	Key param.Field[string] `json:"key,required"`
}

A scope object represents any resource that can have actions applied against invite.

func (IAMResourceGroupNewParamsScopeObject) MarshalJSON added in v2.3.0 

func (r IAMResourceGroupNewParamsScopeObject) MarshalJSON() (data []byte, err error)

type IAMResourceGroupNewResponse added in v2.3.0 

type IAMResourceGroupNewResponse struct {
	// Identifier of the group.
	ID string `json:"id"`
	// Attributes associated to the resource group.
	Meta interface{} `json:"meta"`
	// A scope is a combination of scope objects which provides additional context.
	Scope IAMResourceGroupNewResponseScope `json:"scope"`
	JSON  iamResourceGroupNewResponseJSON  `json:"-"`
}

A group of scoped resources.

func (*IAMResourceGroupNewResponse) UnmarshalJSON added in v2.3.0 

func (r *IAMResourceGroupNewResponse) UnmarshalJSON(data []byte) (err error)

type IAMResourceGroupNewResponseScope added in v2.3.0 

type IAMResourceGroupNewResponseScope struct {
	// This is a combination of pre-defined resource name and identifier (like Account
	// ID etc.)
	Key string `json:"key,required"`
	// A list of scope objects for additional context. The number of Scope objects
	// should not be zero.
	Objects []IAMResourceGroupNewResponseScopeObject `json:"objects,required"`
	JSON    iamResourceGroupNewResponseScopeJSON     `json:"-"`
}

A scope is a combination of scope objects which provides additional context.

func (*IAMResourceGroupNewResponseScope) UnmarshalJSON added in v2.3.0 

func (r *IAMResourceGroupNewResponseScope) UnmarshalJSON(data []byte) (err error)

type IAMResourceGroupNewResponseScopeObject added in v2.3.0 

type IAMResourceGroupNewResponseScopeObject struct {
	// This is a combination of pre-defined resource name and identifier (like Zone ID
	// etc.)
	Key  string                                     `json:"key,required"`
	JSON iamResourceGroupNewResponseScopeObjectJSON `json:"-"`
}

A scope object represents any resource that can have actions applied against invite.

func (*IAMResourceGroupNewResponseScopeObject) UnmarshalJSON added in v2.3.0 

func (r *IAMResourceGroupNewResponseScopeObject) UnmarshalJSON(data []byte) (err error)

type IAMResourceGroupService added in v2.3.0 

type IAMResourceGroupService struct {
	Options []option.RequestOption
}

IAMResourceGroupService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewIAMResourceGroupService method instead.

func NewIAMResourceGroupService added in v2.3.0 

func NewIAMResourceGroupService(opts ...option.RequestOption) (r *IAMResourceGroupService)

NewIAMResourceGroupService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*IAMResourceGroupService) Delete added in v2.3.0 

func (r *IAMResourceGroupService) Delete(ctx context.Context, resourceGroupID string, body IAMResourceGroupDeleteParams, opts ...option.RequestOption) (res *IAMResourceGroupDeleteResponse, err error)

Remove a resource group from an account.

func (*IAMResourceGroupService) Get added in v2.3.0 

func (r *IAMResourceGroupService) Get(ctx context.Context, resourceGroupID string, query IAMResourceGroupGetParams, opts ...option.RequestOption) (res *IAMResourceGroupGetResponse, err error)

Get information about a specific resource group in an account.

func (*IAMResourceGroupService) List added in v2.3.0 

func (r *IAMResourceGroupService) List(ctx context.Context, params IAMResourceGroupListParams, opts ...option.RequestOption) (res *pagination.V4PagePaginationArray[IAMResourceGroupListResponse], err error)

List all the resource groups for an account.

func (*IAMResourceGroupService) ListAutoPaging added in v2.3.0 

func (r *IAMResourceGroupService) ListAutoPaging(ctx context.Context, params IAMResourceGroupListParams, opts ...option.RequestOption) *pagination.V4PagePaginationArrayAutoPager[IAMResourceGroupListResponse]

List all the resource groups for an account.

func (*IAMResourceGroupService) New added in v2.3.0 

func (r *IAMResourceGroupService) New(ctx context.Context, params IAMResourceGroupNewParams, opts ...option.RequestOption) (res *IAMResourceGroupNewResponse, err error)

Create a new Resource Group under the specified account.

func (*IAMResourceGroupService) Update added in v2.3.0 

func (r *IAMResourceGroupService) Update(ctx context.Context, resourceGroupID string, params IAMResourceGroupUpdateParams, opts ...option.RequestOption) (res *IAMResourceGroupUpdateResponse, err error)

Modify an existing resource group.

type IAMResourceGroupUpdateParams added in v2.3.0 

type IAMResourceGroupUpdateParams struct {
	// Account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
	// A scope is a combination of scope objects which provides additional context.
	Scope param.Field[IAMResourceGroupUpdateParamsScope] `json:"scope,required"`
	// Attributes associated to the resource group.
	Meta param.Field[interface{}] `json:"meta"`
}

func (IAMResourceGroupUpdateParams) MarshalJSON added in v2.3.0 

func (r IAMResourceGroupUpdateParams) MarshalJSON() (data []byte, err error)

type IAMResourceGroupUpdateParamsScope added in v2.3.0 

type IAMResourceGroupUpdateParamsScope struct {
	// This is a combination of pre-defined resource name and identifier (like Account
	// ID etc.)
	Key param.Field[string] `json:"key,required"`
	// A list of scope objects for additional context. The number of Scope objects
	// should not be zero.
	Objects param.Field[[]IAMResourceGroupUpdateParamsScopeObject] `json:"objects,required"`
}

A scope is a combination of scope objects which provides additional context.

func (IAMResourceGroupUpdateParamsScope) MarshalJSON added in v2.3.0 

func (r IAMResourceGroupUpdateParamsScope) MarshalJSON() (data []byte, err error)

type IAMResourceGroupUpdateParamsScopeObject added in v2.3.0 

type IAMResourceGroupUpdateParamsScopeObject struct {
	// This is a combination of pre-defined resource name and identifier (like Zone ID
	// etc.)
	Key param.Field[string] `json:"key,required"`
}

A scope object represents any resource that can have actions applied against invite.

func (IAMResourceGroupUpdateParamsScopeObject) MarshalJSON added in v2.3.0 

func (r IAMResourceGroupUpdateParamsScopeObject) MarshalJSON() (data []byte, err error)

type IAMResourceGroupUpdateResponse added in v2.3.0 

type IAMResourceGroupUpdateResponse struct {
	// Identifier of the group.
	ID string `json:"id,required"`
	// The scope associated to the resource group
	Scope []IAMResourceGroupUpdateResponseScope `json:"scope,required"`
	// Attributes associated to the resource group.
	Meta interface{} `json:"meta"`
	// Name of the resource group.
	Name string                             `json:"name"`
	JSON iamResourceGroupUpdateResponseJSON `json:"-"`
}

A group of scoped resources.

func (*IAMResourceGroupUpdateResponse) UnmarshalJSON added in v2.3.0 

func (r *IAMResourceGroupUpdateResponse) UnmarshalJSON(data []byte) (err error)

type IAMResourceGroupUpdateResponseScope added in v2.3.0 

type IAMResourceGroupUpdateResponseScope struct {
	// This is a combination of pre-defined resource name and identifier (like Account
	// ID etc.)
	Key string `json:"key,required"`
	// A list of scope objects for additional context.
	Objects []IAMResourceGroupUpdateResponseScopeObject `json:"objects,required"`
	JSON    iamResourceGroupUpdateResponseScopeJSON     `json:"-"`
}

A scope is a combination of scope objects which provides additional context.

func (*IAMResourceGroupUpdateResponseScope) UnmarshalJSON added in v2.3.0 

func (r *IAMResourceGroupUpdateResponseScope) UnmarshalJSON(data []byte) (err error)

type IAMResourceGroupUpdateResponseScopeObject added in v2.3.0 

type IAMResourceGroupUpdateResponseScopeObject struct {
	// This is a combination of pre-defined resource name and identifier (like Zone ID
	// etc.)
	Key  string                                        `json:"key,required"`
	JSON iamResourceGroupUpdateResponseScopeObjectJSON `json:"-"`
}

A scope object represents any resource that can have actions applied against invite.

func (*IAMResourceGroupUpdateResponseScopeObject) UnmarshalJSON added in v2.3.0 

func (r *IAMResourceGroupUpdateResponseScopeObject) UnmarshalJSON(data []byte) (err error)

type IAMService added in v2.3.0 

type IAMService struct {
	Options          []option.RequestOption
	PermissionGroups *IAMPermissionGroupService
	ResourceGroups   *IAMResourceGroupService
}

IAMService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewIAMService method instead.

func NewIAMService added in v2.3.0 

func NewIAMService(opts ...option.RequestOption) (r *IAMService)

NewIAMService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

type MemberParam added in v2.1.0 

type MemberParam = shared.MemberParam

This is an alias to an internal type.

type MemberRoleParam added in v2.1.0 

type MemberRoleParam = shared.MemberRoleParam

This is an alias to an internal type.

type MemberRolesPermissionsParam added in v2.1.0 

type MemberRolesPermissionsParam = shared.MemberRolesPermissionsParam

This is an alias to an internal type.

type MemberStatus added in v2.3.0 

type MemberStatus = shared.MemberStatus

A member's status in the account.

This is an alias to an internal type.

type MemberUserParam added in v2.1.0 

type MemberUserParam = shared.MemberUserParam

Details of the user associated to the membership.

This is an alias to an internal type.

type Permission 

type Permission = shared.Permission

This is an alias to an internal type.

type PermissionGrant 

type PermissionGrant = shared.PermissionGrant

This is an alias to an internal type.

type PermissionGrantParam 

type PermissionGrantParam = shared.PermissionGrantParam

This is an alias to an internal type.

type ResponseInfo 

type ResponseInfo = shared.ResponseInfo

This is an alias to an internal type.

type Role 

type Role = shared.Role

This is an alias to an internal type.

type SortDirection added in v2.2.0 

type SortDirection = shared.SortDirection

Direction to order DNS records in.

This is an alias to an internal type.

Source Files

View all Source files

Directories

Path Synopsis
apierror
apiform
apijson
apiquery
pagination
param
requestconfig
testutil

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.