package
3.1.0
Repository: https://github.com/cloudflare/cloudflare-go.git
Documentation: pkg.go.dev

# Functions

NewAPIGatewayService generates a new service that applies the given options to each request.
NewConfigurationService generates a new service that applies the given options to each request.
NewDiscoveryOperationService generates a new service that applies the given options to each request.
NewDiscoveryService generates a new service that applies the given options to each request.
NewOperationSchemaValidationService generates a new service that applies the given options to each request.
NewOperationService generates a new service that applies the given options to each request.
NewSchemaService generates a new service that applies the given options to each request.
NewSettingSchemaValidationService generates a new service that applies the given options to each request.
NewSettingService generates a new service that applies the given options to each request.
NewUserSchemaOperationService generates a new service that applies the given options to each request.
NewUserSchemaService generates a new service that applies the given options to each request.

# Constants

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
This is an alias to an internal value.
This is an alias to an internal value.
This is an alias to an internal value.
This is an alias to an internal value.
This is an alias to an internal value.
This is an alias to an internal value.
This is an alias to an internal value.
This is an alias to an internal value.
This is an alias to an internal value.
This is an alias to an internal value.
This is an alias to an internal value.
This is an alias to an internal value.
This is an alias to an internal value.
This is an alias to an internal value.
This is an alias to an internal value.
This is an alias to an internal value.
This is an alias to an internal value.
This is an alias to an internal value.
This is an alias to an internal value.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
This is an alias to an internal value.
This is an alias to an internal value.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
This is an alias to an internal value.
This is an alias to an internal value.
This is an alias to an internal value.
This is an alias to an internal value.
This is an alias to an internal value.
This is an alias to an internal value.
This is an alias to an internal value.
This is an alias to an internal value.
This is an alias to an internal value.
This is an alias to an internal value.
This is an alias to an internal value.
This is an alias to an internal value.
This is an alias to an internal value.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Structs

APIGatewayService contains methods and other services that help with interacting with the cloudflare API.
No description provided by the author
No description provided by the author
No description provided by the author
API Routing settings on endpoint.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Upper and lower bound for percentile estimate.
Upper and lower bound for percentile estimate.
Upper and lower bound for percentile estimate.
No description provided by the author
No description provided by the author
An operation schema object containing a response.
No description provided by the author
No description provided by the author
Schema active on endpoint.
No description provided by the author
No description provided by the author
No description provided by the author
Auth ID Characteristic.
Auth ID Characteristic.
Auth ID Characteristic.
Auth ID Characteristic extracted from JWT Token Claims.
Auth ID Characteristic extracted from JWT Token Claims.
Auth ID Characteristic.
No description provided by the author
No description provided by the author
No description provided by the author
ConfigurationService contains methods and other services that help with interacting with the cloudflare API.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
DiscoveryOperationService contains methods and other services that help with interacting with the cloudflare API.
DiscoveryService contains methods and other services that help with interacting with the cloudflare API.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
API Routing settings on endpoint.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Upper and lower bound for percentile estimate.
Upper and lower bound for percentile estimate.
Upper and lower bound for percentile estimate.
No description provided by the author
No description provided by the author
An operation schema object containing a response.
No description provided by the author
No description provided by the author
Schema active on endpoint.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
API Routing settings on endpoint.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Upper and lower bound for percentile estimate.
Upper and lower bound for percentile estimate.
Upper and lower bound for percentile estimate.
No description provided by the author
No description provided by the author
An operation schema object containing a response.
No description provided by the author
No description provided by the author
Schema active on endpoint.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
OperationSchemaValidationService contains methods and other services that help with interacting with the cloudflare API.
No description provided by the author
No description provided by the author
OperationService contains methods and other services that help with interacting with the cloudflare API.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
SchemaService contains methods and other services that help with interacting with the cloudflare API.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
SettingSchemaValidationService contains methods and other services that help with interacting with the cloudflare API.
No description provided by the author
SettingService contains methods and other services that help with interacting with the cloudflare API.
Operation ID to mitigation action mappings.
Operation ID to mitigation action mappings.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
UserSchemaOperationService contains methods and other services that help with interacting with the cloudflare API.
UserSchemaService contains methods and other services that help with interacting with the cloudflare API.

# Interfaces

Union satisfied by [api_gateway.APIShieldFeaturesAPIShieldOperationFeatureThresholds], [api_gateway.APIShieldFeaturesAPIShieldOperationFeatureParameterSchemas], [api_gateway.APIShieldFeaturesAPIShieldOperationFeatureAPIRouting], [api_gateway.APIShieldFeaturesAPIShieldOperationFeatureConfidenceIntervals] or [api_gateway.APIShieldFeaturesAPIShieldOperationFeatureSchemaInfo].
Auth ID Characteristic Union satisfied by [api_gateway.ConfigurationAuthIDCharacteristicsAPIShieldAuthIDCharacteristic] or [api_gateway.ConfigurationAuthIDCharacteristicsAPIShieldAuthIDCharacteristicJwtClaim].
Auth ID Characteristic Satisfied by [api_gateway.ConfigurationAuthIDCharacteristicsAPIShieldAuthIDCharacteristicParam], [api_gateway.ConfigurationAuthIDCharacteristicsAPIShieldAuthIDCharacteristicJwtClaimParam], [ConfigurationAuthIDCharacteristicParam].
Union satisfied by [api_gateway.OperationGetResponseFeaturesAPIShieldOperationFeatureThresholds], [api_gateway.OperationGetResponseFeaturesAPIShieldOperationFeatureParameterSchemas], [api_gateway.OperationGetResponseFeaturesAPIShieldOperationFeatureAPIRouting], [api_gateway.OperationGetResponseFeaturesAPIShieldOperationFeatureConfidenceIntervals] or [api_gateway.OperationGetResponseFeaturesAPIShieldOperationFeatureSchemaInfo].
Union satisfied by [api_gateway.OperationListResponseFeaturesAPIShieldOperationFeatureThresholds], [api_gateway.OperationListResponseFeaturesAPIShieldOperationFeatureParameterSchemas], [api_gateway.OperationListResponseFeaturesAPIShieldOperationFeatureAPIRouting], [api_gateway.OperationListResponseFeaturesAPIShieldOperationFeatureConfidenceIntervals] or [api_gateway.OperationListResponseFeaturesAPIShieldOperationFeatureSchemaInfo].
Union satisfied by [api_gateway.APIShield] or [api_gateway.UserSchemaOperationListResponseAPIShieldBasicOperation].

# Type aliases

Action taken on requests failing validation.
The HTTP method used to access the endpoint.
This is an alias to an internal type.
This is an alias to an internal type.
This is an alias to an internal type.
This is an alias to an internal type.
This is an alias to an internal type.
The type of actor, whether a User, Cloudflare Admin, or an Automated System.
This is an alias to an internal type.
This is an alias to an internal type.
The Certificate Authority that will issue the certificate This is an alias to an internal type.
Signature type desired on certificate ("origin-rsa" (rsa), "origin-ecc" (ecdsa), or "keyless-certificate" (for Keyless SSL servers).
A Cloudflare Tunnel that connects your origin to Cloudflare's edge.
This is an alias to an internal type.
The status of the tunnel.
The type of tunnel.
The type of characteristic.
The type of characteristic.
The type of characteristic.
No description provided by the author
Whether the API call was successful.
Whether the API call was successful.
Whether the API call was successful.
Mark state of operation in API Discovery - `review` - Mark operation as for review - `ignored` - Mark operation as ignored.
Whether the API call was successful.
State of operation in API Discovery - `review` - Operation is not saved into API Shield Endpoint Management - `saved` - Operation is saved into API Shield Endpoint Management - `ignored` - Operation is marked as ignored.
Direction to order results.
Field to order by.
Filter results to only include discovery results sourced from a particular discovery engine - `ML` - Discovered operations that were sourced using ML API Discovery - `SessionIdentifier` - Discovered operations that were sourced using Session Identifier API Discovery.
Filter results to only include discovery results in a particular state.
The HTTP method used to access the endpoint.
- `ML` - Discovered operation was sourced using ML API Discovery \* `SessionIdentifier` - Discovered operation was sourced using Session Identifier API Discovery.
State of operation in API Discovery - `review` - Operation is not saved into API Shield Endpoint Management - `saved` - Operation is saved into API Shield Endpoint Management - `ignored` - Operation is marked as ignored.
No description provided by the author
This is an alias to an internal type.
This is an alias to an internal type.
This is an alias to an internal type.
This is an alias to an internal type.
A member's status in the account.
Details of the user associated to the membership.
No description provided by the author
Whether the API call was successful.
No description provided by the author
Whether the API call was successful.
Action taken on requests failing validation.
The HTTP method used to access the endpoint.
Direction to order results.
No description provided by the author
Field to order by.
Action taken on requests failing validation.
The HTTP method used to access the endpoint.
The HTTP method used to access the endpoint.
Whether the API call was successful.
Whether the API call was successful.
When set, this applies a mitigation action to this operation - `log` log request when request does not conform to schema for this operation - `block` deny access to the site when request does not conform to schema for this operation - `none` will skip mitigation for this operation - `null` indicates that no operation level mitigation is in place, see Zone Level Schema Validation Settings for mitigation action that will be applied.
When set, this applies a mitigation action to this operation - `log` log request when request does not conform to schema for this operation - `block` deny access to the site when request does not conform to schema for this operation - `none` will skip mitigation for this operation - `null` indicates that no operation level mitigation is in place, see Zone Level Schema Validation Settings for mitigation action that will be applied.
When set, this applies a mitigation action to this operation - `log` log request when request does not conform to schema for this operation - `block` deny access to the site when request does not conform to schema for this operation - `none` will skip mitigation for this operation - `null` indicates that no operation level mitigation is in place, see Zone Level Schema Validation Settings for mitigation action that will be applied.
This is an alias to an internal type.
This is an alias to an internal type.
This is an alias to an internal type.
Kind of schema.
The rate plan applied to the subscription.
The rate plan applied to the subscription.
This is an alias to an internal type.
This is an alias to an internal type.
No description provided by the author
Whether the API call was successful.
The default mitigation action used when there is no mitigation action defined on the operation Mitigation actions are as follows: - `log` - log request when request does not conform to schema - `block` - deny access to the site when request does not conform to schema A special value of of `none` will skip running schema validation entirely for the request when there is no mitigation action defined on the operation `null` will have no effect.
When set, this overrides both zone level and operation level mitigation actions.
The default mitigation action used when there is no mitigation action defined on the operation Mitigation actions are as follows: - `log` - log request when request does not conform to schema - `block` - deny access to the site when request does not conform to schema A special value of of `none` will skip running schema validation entirely for the request when there is no mitigation action defined on the operation.
When set, this overrides both zone level and operation level mitigation actions.
No description provided by the author
When set, this applies a mitigation action to this operation - `log` log request when request does not conform to schema for this operation - `block` deny access to the site when request does not conform to schema for this operation - `none` will skip mitigation for this operation - `null` indicates that no operation level mitigation is in place, see Zone Level Schema Validation Settings for mitigation action that will be applied.
No description provided by the author
The default mitigation action used when there is no mitigation action defined on the operation Mitigation actions are as follows: - `log` - log request when request does not conform to schema - `block` - deny access to the site when request does not conform to schema A special value of of `none` will skip running schema validation entirely for the request when there is no mitigation action defined on the operation.
When set, this overrides both zone level and operation level mitigation actions.
Direction to order DNS records in.
This is an alias to an internal type.
How often the subscription is renewed automatically.
This is an alias to an internal type.
The state that the subscription is in.
Whether the API call was successful.
Flag whether schema is enabled for validation.
Whether the API call was successful.
Whether the API call was successful.
Kind of schema.
Flag whether schema is enabled for validation.
Whether the API call was successful.
No description provided by the author
Filter results by whether operations exist in API Shield Endpoint Management or not.
The HTTP method used to access the endpoint.
The HTTP method used to access the endpoint.