Documentation
¶
Index ¶
- Constants
- type ACMService
- type ASN
- type ASNParam
- type AuditLog
- type AuditLogAction
- type AuditLogActor
- type AuditLogActorType
- type AuditLogOwner
- type AuditLogResource
- type CertificateAuthority
- type CertificateCA
- type CertificateRequestType
- type CloudflareTunnel
- type CloudflareTunnelConfigSrc
- type CloudflareTunnelConnection
- type CloudflareTunnelStatus
- type CloudflareTunnelTunType
- type CustomTrustStore
- type CustomTrustStoreDeleteParams
- type CustomTrustStoreDeleteResponse
- type CustomTrustStoreDeleteResponseEnvelope
- type CustomTrustStoreDeleteResponseEnvelopeErrors
- type CustomTrustStoreDeleteResponseEnvelopeErrorsSource
- type CustomTrustStoreDeleteResponseEnvelopeMessages
- type CustomTrustStoreDeleteResponseEnvelopeMessagesSource
- type CustomTrustStoreDeleteResponseEnvelopeSuccess
- type CustomTrustStoreGetParams
- type CustomTrustStoreGetResponseEnvelope
- type CustomTrustStoreGetResponseEnvelopeErrors
- type CustomTrustStoreGetResponseEnvelopeErrorsSource
- type CustomTrustStoreGetResponseEnvelopeMessages
- type CustomTrustStoreGetResponseEnvelopeMessagesSource
- type CustomTrustStoreGetResponseEnvelopeSuccess
- type CustomTrustStoreListParams
- type CustomTrustStoreNewParams
- type CustomTrustStoreNewResponseEnvelope
- type CustomTrustStoreNewResponseEnvelopeErrors
- type CustomTrustStoreNewResponseEnvelopeErrorsSource
- type CustomTrustStoreNewResponseEnvelopeMessages
- type CustomTrustStoreNewResponseEnvelopeMessagesSource
- type CustomTrustStoreNewResponseEnvelopeSuccess
- type CustomTrustStoreService
- func (r *CustomTrustStoreService) Delete(ctx context.Context, customOriginTrustStoreID string, ...) (res *CustomTrustStoreDeleteResponse, err error)
- func (r *CustomTrustStoreService) Get(ctx context.Context, customOriginTrustStoreID string, ...) (res *CustomTrustStore, err error)
- func (r *CustomTrustStoreService) List(ctx context.Context, params CustomTrustStoreListParams, ...) (res *pagination.V4PagePaginationArray[CustomTrustStore], err error)
- func (r *CustomTrustStoreService) ListAutoPaging(ctx context.Context, params CustomTrustStoreListParams, ...) *pagination.V4PagePaginationArrayAutoPager[CustomTrustStore]
- func (r *CustomTrustStoreService) New(ctx context.Context, params CustomTrustStoreNewParams, ...) (res *CustomTrustStore, err error)
- type CustomTrustStoreStatus
- type Error
- type ErrorData
- type ErrorDataSource
- type Member
- type MemberPoliciesAccess
- type MemberPoliciesPermissionGroup
- type MemberPoliciesPermissionGroupsMeta
- type MemberPoliciesResourceGroup
- type MemberPoliciesResourceGroupsMeta
- type MemberPoliciesResourceGroupsScope
- type MemberPoliciesResourceGroupsScopeObject
- type MemberPolicy
- type MemberStatus
- type MemberUser
- type Permission
- type PermissionGrant
- type PermissionGrantParam
- type RatePlan
- type RatePlanID
- type RatePlanParam
- type ResponseInfo
- type ResponseInfoSource
- type Role
- type RoleParam
- type RolePermissions
- type RolePermissionsParam
- type SortDirection
- type Subscription
- type SubscriptionFrequency
- type SubscriptionParam
- type SubscriptionState
- type Token
- type TokenCondition
- type TokenConditionCIDRList
- type TokenConditionCIDRListParam
- type TokenConditionParam
- type TokenConditionRequestIP
- type TokenConditionRequestIPParam
- type TokenParam
- type TokenPolicy
- type TokenPolicyEffect
- type TokenPolicyParam
- type TokenPolicyPermissionGroup
- type TokenPolicyPermissionGroupParam
- type TokenPolicyPermissionGroupsMeta
- type TokenPolicyPermissionGroupsMetaParam
- type TokenPolicyResourcesIAMResourcesTypeObjectNested
- type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam
- type TokenPolicyResourcesIAMResourcesTypeObjectString
- type TokenPolicyResourcesIAMResourcesTypeObjectStringParam
- type TokenPolicyResourcesUnion
- type TokenPolicyResourcesUnionParam
- type TokenStatus
- type TokenValue
- type TotalTLSEditParams
- type TotalTLSEditResponse
- type TotalTLSEditResponseEnvelope
- type TotalTLSEditResponseEnvelopeErrors
- type TotalTLSEditResponseEnvelopeErrorsSource
- type TotalTLSEditResponseEnvelopeMessages
- type TotalTLSEditResponseEnvelopeMessagesSource
- type TotalTLSEditResponseEnvelopeSuccess
- type TotalTLSEditResponseValidityPeriod
- type TotalTLSGetParams
- type TotalTLSGetResponse
- type TotalTLSGetResponseEnvelope
- type TotalTLSGetResponseEnvelopeErrors
- type TotalTLSGetResponseEnvelopeErrorsSource
- type TotalTLSGetResponseEnvelopeMessages
- type TotalTLSGetResponseEnvelopeMessagesSource
- type TotalTLSGetResponseEnvelopeSuccess
- type TotalTLSGetResponseValidityPeriod
- type TotalTLSService
- func (r *TotalTLSService) Edit(ctx context.Context, params TotalTLSEditParams, opts ...option.RequestOption) (res *TotalTLSEditResponse, err error)
- func (r *TotalTLSService) Get(ctx context.Context, query TotalTLSGetParams, opts ...option.RequestOption) (res *TotalTLSGetResponse, err error)
- func (r *TotalTLSService) Update(ctx context.Context, params TotalTLSUpdateParams, opts ...option.RequestOption) (res *TotalTLSUpdateResponse, err error)
- type TotalTLSUpdateParams
- type TotalTLSUpdateResponse
- type TotalTLSUpdateResponseEnvelope
- type TotalTLSUpdateResponseEnvelopeErrors
- type TotalTLSUpdateResponseEnvelopeErrorsSource
- type TotalTLSUpdateResponseEnvelopeMessages
- type TotalTLSUpdateResponseEnvelopeMessagesSource
- type TotalTLSUpdateResponseEnvelopeSuccess
- type TotalTLSUpdateResponseValidityPeriod
Constants ¶
const AuditLogActorTypeAdmin = shared.AuditLogActorTypeAdmin
This is an alias to an internal value.
const AuditLogActorTypeCloudflare = shared.AuditLogActorTypeCloudflare
This is an alias to an internal value.
const AuditLogActorTypeUser = shared.AuditLogActorTypeUser
This is an alias to an internal value.
const CertificateCADigicert = shared.CertificateCADigicert
This is an alias to an internal value.
const CertificateCAGoogle = shared.CertificateCAGoogle
This is an alias to an internal value.
const CertificateCALetsEncrypt = shared.CertificateCALetsEncrypt
This is an alias to an internal value.
const CertificateCASSLCom = shared.CertificateCASSLCom
This is an alias to an internal value.
const CertificateRequestTypeKeylessCertificate = shared.CertificateRequestTypeKeylessCertificate
This is an alias to an internal value.
const CertificateRequestTypeOriginECC = shared.CertificateRequestTypeOriginECC
This is an alias to an internal value.
const CertificateRequestTypeOriginRSA = shared.CertificateRequestTypeOriginRSA
This is an alias to an internal value.
const CloudflareTunnelConfigSrcCloudflare = shared.CloudflareTunnelConfigSrcCloudflare
This is an alias to an internal value.
const CloudflareTunnelConfigSrcLocal = shared.CloudflareTunnelConfigSrcLocal
This is an alias to an internal value.
const CloudflareTunnelStatusDegraded = shared.CloudflareTunnelStatusDegraded
This is an alias to an internal value.
const CloudflareTunnelStatusDown = shared.CloudflareTunnelStatusDown
This is an alias to an internal value.
const CloudflareTunnelStatusHealthy = shared.CloudflareTunnelStatusHealthy
This is an alias to an internal value.
const CloudflareTunnelStatusInactive = shared.CloudflareTunnelStatusInactive
This is an alias to an internal value.
const CloudflareTunnelTunTypeCNI = shared.CloudflareTunnelTunTypeCNI
This is an alias to an internal value.
const CloudflareTunnelTunTypeCfdTunnel = shared.CloudflareTunnelTunTypeCfdTunnel
This is an alias to an internal value.
const CloudflareTunnelTunTypeGRE = shared.CloudflareTunnelTunTypeGRE
This is an alias to an internal value.
const CloudflareTunnelTunTypeIPSec = shared.CloudflareTunnelTunTypeIPSec
This is an alias to an internal value.
const CloudflareTunnelTunTypeMagic = shared.CloudflareTunnelTunTypeMagic
This is an alias to an internal value.
const CloudflareTunnelTunTypeWARP = shared.CloudflareTunnelTunTypeWARP
This is an alias to an internal value.
const CloudflareTunnelTunTypeWARPConnector = shared.CloudflareTunnelTunTypeWARPConnector
This is an alias to an internal value.
const MemberPoliciesAccessAllow = shared.MemberPoliciesAccessAllow
This is an alias to an internal value.
const MemberPoliciesAccessDeny = shared.MemberPoliciesAccessDeny
This is an alias to an internal value.
const MemberStatusAccepted = shared.MemberStatusAccepted
This is an alias to an internal value.
const MemberStatusPending = shared.MemberStatusPending
This is an alias to an internal value.
const RatePlanIDBusiness = shared.RatePlanIDBusiness
This is an alias to an internal value.
const RatePlanIDEnterprise = shared.RatePlanIDEnterprise
This is an alias to an internal value.
const RatePlanIDFree = shared.RatePlanIDFree
This is an alias to an internal value.
const RatePlanIDLite = shared.RatePlanIDLite
This is an alias to an internal value.
const RatePlanIDPartnersBusiness = shared.RatePlanIDPartnersBusiness
This is an alias to an internal value.
const RatePlanIDPartnersEnterprise = shared.RatePlanIDPartnersEnterprise
This is an alias to an internal value.
const RatePlanIDPartnersFree = shared.RatePlanIDPartnersFree
This is an alias to an internal value.
const RatePlanIDPartnersPro = shared.RatePlanIDPartnersPro
This is an alias to an internal value.
const RatePlanIDPro = shared.RatePlanIDPro
This is an alias to an internal value.
const RatePlanIDProPlus = shared.RatePlanIDProPlus
This is an alias to an internal value.
const SortDirectionAsc = shared.SortDirectionAsc
This is an alias to an internal value.
const SortDirectionDesc = shared.SortDirectionDesc
This is an alias to an internal value.
const SubscriptionFrequencyMonthly = shared.SubscriptionFrequencyMonthly
This is an alias to an internal value.
const SubscriptionFrequencyQuarterly = shared.SubscriptionFrequencyQuarterly
This is an alias to an internal value.
const SubscriptionFrequencyWeekly = shared.SubscriptionFrequencyWeekly
This is an alias to an internal value.
const SubscriptionFrequencyYearly = shared.SubscriptionFrequencyYearly
This is an alias to an internal value.
const SubscriptionStateAwaitingPayment = shared.SubscriptionStateAwaitingPayment
This is an alias to an internal value.
const SubscriptionStateCancelled = shared.SubscriptionStateCancelled
This is an alias to an internal value.
const SubscriptionStateExpired = shared.SubscriptionStateExpired
This is an alias to an internal value.
const SubscriptionStateFailed = shared.SubscriptionStateFailed
This is an alias to an internal value.
const SubscriptionStatePaid = shared.SubscriptionStatePaid
This is an alias to an internal value.
const SubscriptionStateProvisioned = shared.SubscriptionStateProvisioned
This is an alias to an internal value.
const SubscriptionStateTrial = shared.SubscriptionStateTrial
This is an alias to an internal value.
const TokenPolicyEffectAllow = shared.TokenPolicyEffectAllow
This is an alias to an internal value.
const TokenPolicyEffectDeny = shared.TokenPolicyEffectDeny
This is an alias to an internal value.
const TokenStatusActive = shared.TokenStatusActive
This is an alias to an internal value.
const TokenStatusDisabled = shared.TokenStatusDisabled
This is an alias to an internal value.
const TokenStatusExpired = shared.TokenStatusExpired
This is an alias to an internal value.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ACMService ¶
type ACMService struct {
Options []option.RequestOption
TotalTLS *TotalTLSService
CustomTrustStore *CustomTrustStoreService
}
ACMService 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 NewACMService method instead.
func NewACMService ¶
func NewACMService(opts ...option.RequestOption) (r *ACMService)
NewACMService 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 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 CertificateAuthority ¶
type CertificateAuthority string
The Certificate Authority that Total TLS certificates will be issued through.
const ( CertificateAuthorityGoogle CertificateAuthority = "google" CertificateAuthorityLetsEncrypt CertificateAuthority = "lets_encrypt" CertificateAuthoritySSLCom CertificateAuthority = "ssl_com" )
func (CertificateAuthority) IsKnown ¶
func (r CertificateAuthority) IsKnown() bool
type CertificateCA ¶
type CertificateCA = shared.CertificateCA
The Certificate Authority that will issue the certificate
This is an alias to an internal type.
type CertificateRequestType ¶
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 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 CloudflareTunnelConfigSrc ¶
type CloudflareTunnelConfigSrc = shared.CloudflareTunnelConfigSrc
Indicates if this is a locally or remotely configured tunnel. If `local`, manage the tunnel using a YAML file on the origin machine. If `cloudflare`, manage the tunnel on the Zero Trust dashboard.
This is an alias to an internal type.
type CloudflareTunnelConnection ¶
type CloudflareTunnelConnection = shared.CloudflareTunnelConnection
This is an alias to an internal type.
type CloudflareTunnelStatus ¶
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 CustomTrustStore ¶
type CustomTrustStore struct {
// Identifier.
ID string `json:"id" api:"required"`
// The root CA certificate in PEM format. Only root CA certificates are accepted;
// intermediate and leaf certificates are not supported.
Certificate string `json:"certificate" api:"required"`
// When the certificate expires.
ExpiresOn time.Time `json:"expires_on" api:"required" format:"date-time"`
// The certificate authority that issued the certificate.
Issuer string `json:"issuer" api:"required"`
// The type of hash used for the certificate.
Signature string `json:"signature" api:"required"`
// Status of the zone's custom SSL.
Status CustomTrustStoreStatus `json:"status" api:"required"`
// When the certificate was last modified.
UpdatedAt time.Time `json:"updated_at" api:"required" format:"date-time"`
// When the certificate was uploaded to Cloudflare.
UploadedOn time.Time `json:"uploaded_on" api:"required" format:"date-time"`
JSON customTrustStoreJSON `json:"-"`
}
func (*CustomTrustStore) UnmarshalJSON ¶
func (r *CustomTrustStore) UnmarshalJSON(data []byte) (err error)
type CustomTrustStoreDeleteResponse ¶
type CustomTrustStoreDeleteResponse struct {
// Identifier.
ID string `json:"id"`
JSON customTrustStoreDeleteResponseJSON `json:"-"`
}
func (*CustomTrustStoreDeleteResponse) UnmarshalJSON ¶
func (r *CustomTrustStoreDeleteResponse) UnmarshalJSON(data []byte) (err error)
type CustomTrustStoreDeleteResponseEnvelope ¶
type CustomTrustStoreDeleteResponseEnvelope struct {
Errors []CustomTrustStoreDeleteResponseEnvelopeErrors `json:"errors" api:"required"`
Messages []CustomTrustStoreDeleteResponseEnvelopeMessages `json:"messages" api:"required"`
// Whether the API call was successful.
Success CustomTrustStoreDeleteResponseEnvelopeSuccess `json:"success" api:"required"`
Result CustomTrustStoreDeleteResponse `json:"result"`
JSON customTrustStoreDeleteResponseEnvelopeJSON `json:"-"`
}
func (*CustomTrustStoreDeleteResponseEnvelope) UnmarshalJSON ¶
func (r *CustomTrustStoreDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type CustomTrustStoreDeleteResponseEnvelopeErrors ¶
type CustomTrustStoreDeleteResponseEnvelopeErrors struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source CustomTrustStoreDeleteResponseEnvelopeErrorsSource `json:"source"`
JSON customTrustStoreDeleteResponseEnvelopeErrorsJSON `json:"-"`
}
func (*CustomTrustStoreDeleteResponseEnvelopeErrors) UnmarshalJSON ¶
func (r *CustomTrustStoreDeleteResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type CustomTrustStoreDeleteResponseEnvelopeErrorsSource ¶
type CustomTrustStoreDeleteResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON customTrustStoreDeleteResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*CustomTrustStoreDeleteResponseEnvelopeErrorsSource) UnmarshalJSON ¶
func (r *CustomTrustStoreDeleteResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type CustomTrustStoreDeleteResponseEnvelopeMessages ¶
type CustomTrustStoreDeleteResponseEnvelopeMessages struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source CustomTrustStoreDeleteResponseEnvelopeMessagesSource `json:"source"`
JSON customTrustStoreDeleteResponseEnvelopeMessagesJSON `json:"-"`
}
func (*CustomTrustStoreDeleteResponseEnvelopeMessages) UnmarshalJSON ¶
func (r *CustomTrustStoreDeleteResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type CustomTrustStoreDeleteResponseEnvelopeMessagesSource ¶
type CustomTrustStoreDeleteResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON customTrustStoreDeleteResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*CustomTrustStoreDeleteResponseEnvelopeMessagesSource) UnmarshalJSON ¶
func (r *CustomTrustStoreDeleteResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type CustomTrustStoreDeleteResponseEnvelopeSuccess ¶
type CustomTrustStoreDeleteResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
CustomTrustStoreDeleteResponseEnvelopeSuccessTrue CustomTrustStoreDeleteResponseEnvelopeSuccess = true
)
func (CustomTrustStoreDeleteResponseEnvelopeSuccess) IsKnown ¶
func (r CustomTrustStoreDeleteResponseEnvelopeSuccess) IsKnown() bool
type CustomTrustStoreGetResponseEnvelope ¶
type CustomTrustStoreGetResponseEnvelope struct {
Errors []CustomTrustStoreGetResponseEnvelopeErrors `json:"errors" api:"required"`
Messages []CustomTrustStoreGetResponseEnvelopeMessages `json:"messages" api:"required"`
// Whether the API call was successful.
Success CustomTrustStoreGetResponseEnvelopeSuccess `json:"success" api:"required"`
Result CustomTrustStore `json:"result"`
JSON customTrustStoreGetResponseEnvelopeJSON `json:"-"`
}
func (*CustomTrustStoreGetResponseEnvelope) UnmarshalJSON ¶
func (r *CustomTrustStoreGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type CustomTrustStoreGetResponseEnvelopeErrors ¶
type CustomTrustStoreGetResponseEnvelopeErrors struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source CustomTrustStoreGetResponseEnvelopeErrorsSource `json:"source"`
JSON customTrustStoreGetResponseEnvelopeErrorsJSON `json:"-"`
}
func (*CustomTrustStoreGetResponseEnvelopeErrors) UnmarshalJSON ¶
func (r *CustomTrustStoreGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type CustomTrustStoreGetResponseEnvelopeErrorsSource ¶
type CustomTrustStoreGetResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON customTrustStoreGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*CustomTrustStoreGetResponseEnvelopeErrorsSource) UnmarshalJSON ¶
func (r *CustomTrustStoreGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type CustomTrustStoreGetResponseEnvelopeMessages ¶
type CustomTrustStoreGetResponseEnvelopeMessages struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source CustomTrustStoreGetResponseEnvelopeMessagesSource `json:"source"`
JSON customTrustStoreGetResponseEnvelopeMessagesJSON `json:"-"`
}
func (*CustomTrustStoreGetResponseEnvelopeMessages) UnmarshalJSON ¶
func (r *CustomTrustStoreGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type CustomTrustStoreGetResponseEnvelopeMessagesSource ¶
type CustomTrustStoreGetResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON customTrustStoreGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*CustomTrustStoreGetResponseEnvelopeMessagesSource) UnmarshalJSON ¶
func (r *CustomTrustStoreGetResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type CustomTrustStoreGetResponseEnvelopeSuccess ¶
type CustomTrustStoreGetResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
CustomTrustStoreGetResponseEnvelopeSuccessTrue CustomTrustStoreGetResponseEnvelopeSuccess = true
)
func (CustomTrustStoreGetResponseEnvelopeSuccess) IsKnown ¶
func (r CustomTrustStoreGetResponseEnvelopeSuccess) IsKnown() bool
type CustomTrustStoreListParams ¶
type CustomTrustStoreListParams struct {
// Identifier.
ZoneID param.Field[string] `path:"zone_id" api:"required"`
// Limit to the number of records returned.
Limit param.Field[int64] `query:"limit"`
// Offset the results
Offset param.Field[int64] `query:"offset"`
// Page number of paginated results.
Page param.Field[float64] `query:"page"`
// Number of records per page.
PerPage param.Field[float64] `query:"per_page"`
}
func (CustomTrustStoreListParams) URLQuery ¶
func (r CustomTrustStoreListParams) URLQuery() (v url.Values)
URLQuery serializes CustomTrustStoreListParams's query parameters as `url.Values`.
type CustomTrustStoreNewParams ¶
type CustomTrustStoreNewParams struct {
// Identifier.
ZoneID param.Field[string] `path:"zone_id" api:"required"`
// The root CA certificate in PEM format. Only root CA certificates are accepted;
// intermediate and leaf certificates are not supported.
Certificate param.Field[string] `json:"certificate" api:"required"`
}
func (CustomTrustStoreNewParams) MarshalJSON ¶
func (r CustomTrustStoreNewParams) MarshalJSON() (data []byte, err error)
type CustomTrustStoreNewResponseEnvelope ¶
type CustomTrustStoreNewResponseEnvelope struct {
Errors []CustomTrustStoreNewResponseEnvelopeErrors `json:"errors" api:"required"`
Messages []CustomTrustStoreNewResponseEnvelopeMessages `json:"messages" api:"required"`
// Whether the API call was successful.
Success CustomTrustStoreNewResponseEnvelopeSuccess `json:"success" api:"required"`
Result CustomTrustStore `json:"result"`
JSON customTrustStoreNewResponseEnvelopeJSON `json:"-"`
}
func (*CustomTrustStoreNewResponseEnvelope) UnmarshalJSON ¶
func (r *CustomTrustStoreNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type CustomTrustStoreNewResponseEnvelopeErrors ¶
type CustomTrustStoreNewResponseEnvelopeErrors struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source CustomTrustStoreNewResponseEnvelopeErrorsSource `json:"source"`
JSON customTrustStoreNewResponseEnvelopeErrorsJSON `json:"-"`
}
func (*CustomTrustStoreNewResponseEnvelopeErrors) UnmarshalJSON ¶
func (r *CustomTrustStoreNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type CustomTrustStoreNewResponseEnvelopeErrorsSource ¶
type CustomTrustStoreNewResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON customTrustStoreNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*CustomTrustStoreNewResponseEnvelopeErrorsSource) UnmarshalJSON ¶
func (r *CustomTrustStoreNewResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type CustomTrustStoreNewResponseEnvelopeMessages ¶
type CustomTrustStoreNewResponseEnvelopeMessages struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source CustomTrustStoreNewResponseEnvelopeMessagesSource `json:"source"`
JSON customTrustStoreNewResponseEnvelopeMessagesJSON `json:"-"`
}
func (*CustomTrustStoreNewResponseEnvelopeMessages) UnmarshalJSON ¶
func (r *CustomTrustStoreNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type CustomTrustStoreNewResponseEnvelopeMessagesSource ¶
type CustomTrustStoreNewResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON customTrustStoreNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*CustomTrustStoreNewResponseEnvelopeMessagesSource) UnmarshalJSON ¶
func (r *CustomTrustStoreNewResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type CustomTrustStoreNewResponseEnvelopeSuccess ¶
type CustomTrustStoreNewResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
CustomTrustStoreNewResponseEnvelopeSuccessTrue CustomTrustStoreNewResponseEnvelopeSuccess = true
)
func (CustomTrustStoreNewResponseEnvelopeSuccess) IsKnown ¶
func (r CustomTrustStoreNewResponseEnvelopeSuccess) IsKnown() bool
type CustomTrustStoreService ¶
type CustomTrustStoreService struct {
Options []option.RequestOption
}
CustomTrustStoreService 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 NewCustomTrustStoreService method instead.
func NewCustomTrustStoreService ¶
func NewCustomTrustStoreService(opts ...option.RequestOption) (r *CustomTrustStoreService)
NewCustomTrustStoreService 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 (*CustomTrustStoreService) Delete ¶
func (r *CustomTrustStoreService) Delete(ctx context.Context, customOriginTrustStoreID string, body CustomTrustStoreDeleteParams, opts ...option.RequestOption) (res *CustomTrustStoreDeleteResponse, err error)
Removes a root CA certificate from the custom origin trust store. Origins using certificates signed by this CA will no longer be trusted.
func (*CustomTrustStoreService) Get ¶
func (r *CustomTrustStoreService) Get(ctx context.Context, customOriginTrustStoreID string, query CustomTrustStoreGetParams, opts ...option.RequestOption) (res *CustomTrustStore, err error)
Retrieves details about a specific root CA certificate in the custom origin trust store, including expiration and subject information.
func (*CustomTrustStoreService) List ¶
func (r *CustomTrustStoreService) List(ctx context.Context, params CustomTrustStoreListParams, opts ...option.RequestOption) (res *pagination.V4PagePaginationArray[CustomTrustStore], err error)
Get Custom Origin Trust Store for a Zone.
func (*CustomTrustStoreService) ListAutoPaging ¶
func (r *CustomTrustStoreService) ListAutoPaging(ctx context.Context, params CustomTrustStoreListParams, opts ...option.RequestOption) *pagination.V4PagePaginationArrayAutoPager[CustomTrustStore]
Get Custom Origin Trust Store for a Zone.
func (*CustomTrustStoreService) New ¶
func (r *CustomTrustStoreService) New(ctx context.Context, params CustomTrustStoreNewParams, opts ...option.RequestOption) (res *CustomTrustStore, err error)
Upload a root CA certificate to the Custom Origin Trust Store for a Zone. Only root CA certificates are accepted.
type CustomTrustStoreStatus ¶
type CustomTrustStoreStatus string
Status of the zone's custom SSL.
const ( CustomTrustStoreStatusInitializing CustomTrustStoreStatus = "initializing" CustomTrustStoreStatusPendingDeployment CustomTrustStoreStatus = "pending_deployment" CustomTrustStoreStatusActive CustomTrustStoreStatus = "active" CustomTrustStoreStatusPendingDeletion CustomTrustStoreStatus = "pending_deletion" CustomTrustStoreStatusDeleted CustomTrustStoreStatus = "deleted" CustomTrustStoreStatusExpired CustomTrustStoreStatus = "expired" )
func (CustomTrustStoreStatus) IsKnown ¶
func (r CustomTrustStoreStatus) IsKnown() bool
type ErrorDataSource ¶
type ErrorDataSource = shared.ErrorDataSource
This is an alias to an internal type.
type MemberPoliciesAccess ¶
type MemberPoliciesAccess = shared.MemberPoliciesAccess
Allow or deny operations against the resources.
This is an alias to an internal type.
type MemberPoliciesPermissionGroup ¶
type MemberPoliciesPermissionGroup = shared.MemberPoliciesPermissionGroup
A named group of permissions that map to a group of operations against resources.
This is an alias to an internal type.
type MemberPoliciesPermissionGroupsMeta ¶
type MemberPoliciesPermissionGroupsMeta = shared.MemberPoliciesPermissionGroupsMeta
Attributes associated to the permission group.
This is an alias to an internal type.
type MemberPoliciesResourceGroup ¶
type MemberPoliciesResourceGroup = shared.MemberPoliciesResourceGroup
A group of scoped resources.
This is an alias to an internal type.
type MemberPoliciesResourceGroupsMeta ¶
type MemberPoliciesResourceGroupsMeta = shared.MemberPoliciesResourceGroupsMeta
Attributes associated to the resource group.
This is an alias to an internal type.
type MemberPoliciesResourceGroupsScope ¶
type MemberPoliciesResourceGroupsScope = shared.MemberPoliciesResourceGroupsScope
A scope is a combination of scope objects which provides additional context.
This is an alias to an internal type.
type MemberPoliciesResourceGroupsScopeObject ¶
type MemberPoliciesResourceGroupsScopeObject = shared.MemberPoliciesResourceGroupsScopeObject
A scope object represents any resource that can have actions applied against invite.
This is an alias to an internal type.
type MemberStatus ¶
type MemberStatus = shared.MemberStatus
A member's status in the account.
This is an alias to an internal type.
type MemberUser ¶
type MemberUser = shared.MemberUser
Details of the user associated to the membership.
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 RatePlanID ¶
type RatePlanID = shared.RatePlanID
The ID of the rate plan.
This is an alias to an internal type.
type RatePlanParam ¶
type RatePlanParam = shared.RatePlanParam
The rate plan applied to the subscription.
This is an alias to an internal type.
type ResponseInfoSource ¶
type ResponseInfoSource = shared.ResponseInfoSource
This is an alias to an internal type.
type RolePermissions ¶
type RolePermissions = shared.RolePermissions
This is an alias to an internal type.
type RolePermissionsParam ¶
type RolePermissionsParam = shared.RolePermissionsParam
This is an alias to an internal type.
type SortDirection ¶
type SortDirection = shared.SortDirection
Direction to order DNS records in.
This is an alias to an internal type.
type SubscriptionFrequency ¶
type SubscriptionFrequency = shared.SubscriptionFrequency
How often the subscription is renewed automatically.
This is an alias to an internal type.
type SubscriptionParam ¶
type SubscriptionParam = shared.SubscriptionParam
This is an alias to an internal type.
type SubscriptionState ¶
type SubscriptionState = shared.SubscriptionState
The state that the subscription is in.
This is an alias to an internal type.
type TokenCondition ¶
type TokenCondition = shared.TokenCondition
This is an alias to an internal type.
type TokenConditionCIDRList ¶
type TokenConditionCIDRList = shared.TokenConditionCIDRList
IPv4/IPv6 CIDR.
This is an alias to an internal type.
type TokenConditionCIDRListParam ¶
type TokenConditionCIDRListParam = shared.TokenConditionCIDRListParam
IPv4/IPv6 CIDR.
This is an alias to an internal type.
type TokenConditionParam ¶
type TokenConditionParam = shared.TokenConditionParam
This is an alias to an internal type.
type TokenConditionRequestIP ¶
type TokenConditionRequestIP = shared.TokenConditionRequestIP
Client IP restrictions.
This is an alias to an internal type.
type TokenConditionRequestIPParam ¶
type TokenConditionRequestIPParam = shared.TokenConditionRequestIPParam
Client IP restrictions.
This is an alias to an internal type.
type TokenPolicyEffect ¶
type TokenPolicyEffect = shared.TokenPolicyEffect
Allow or deny operations against the resources.
This is an alias to an internal type.
type TokenPolicyParam ¶
type TokenPolicyParam = shared.TokenPolicyParam
This is an alias to an internal type.
type TokenPolicyPermissionGroup ¶
type TokenPolicyPermissionGroup = shared.TokenPolicyPermissionGroup
A named group of permissions that map to a group of operations against resources.
This is an alias to an internal type.
type TokenPolicyPermissionGroupParam ¶
type TokenPolicyPermissionGroupParam = shared.TokenPolicyPermissionGroupParam
A named group of permissions that map to a group of operations against resources.
This is an alias to an internal type.
type TokenPolicyPermissionGroupsMeta ¶
type TokenPolicyPermissionGroupsMeta = shared.TokenPolicyPermissionGroupsMeta
Attributes associated to the permission group.
This is an alias to an internal type.
type TokenPolicyPermissionGroupsMetaParam ¶
type TokenPolicyPermissionGroupsMetaParam = shared.TokenPolicyPermissionGroupsMetaParam
Attributes associated to the permission group.
This is an alias to an internal type.
type TokenPolicyResourcesIAMResourcesTypeObjectNested ¶
type TokenPolicyResourcesIAMResourcesTypeObjectNested = shared.TokenPolicyResourcesIAMResourcesTypeObjectNested
Map of nested resource permissions
This is an alias to an internal type.
type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam ¶
type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam = shared.TokenPolicyResourcesIAMResourcesTypeObjectNestedParam
Map of nested resource permissions
This is an alias to an internal type.
type TokenPolicyResourcesIAMResourcesTypeObjectString ¶
type TokenPolicyResourcesIAMResourcesTypeObjectString = shared.TokenPolicyResourcesIAMResourcesTypeObjectString
Map of simple string resource permissions
This is an alias to an internal type.
type TokenPolicyResourcesIAMResourcesTypeObjectStringParam ¶
type TokenPolicyResourcesIAMResourcesTypeObjectStringParam = shared.TokenPolicyResourcesIAMResourcesTypeObjectStringParam
Map of simple string resource permissions
This is an alias to an internal type.
type TokenPolicyResourcesUnion ¶
type TokenPolicyResourcesUnion = shared.TokenPolicyResourcesUnion
A list of resource names that the policy applies to.
This is an alias to an internal type.
type TokenPolicyResourcesUnionParam ¶
type TokenPolicyResourcesUnionParam = shared.TokenPolicyResourcesUnionParam
A list of resource names that the policy applies to.
This is an alias to an internal type.
type TokenStatus ¶
type TokenStatus = shared.TokenStatus
Status of the token.
This is an alias to an internal type.
type TokenValue ¶
type TokenValue = shared.TokenValue
The token value.
This is an alias to an internal type.
type TotalTLSEditParams ¶
type TotalTLSEditParams struct {
// Identifier.
ZoneID param.Field[string] `path:"zone_id" api:"required"`
// If enabled, Total TLS will order a hostname specific TLS certificate for any
// proxied A, AAAA, or CNAME record in your zone.
Enabled param.Field[bool] `json:"enabled" api:"required"`
// The Certificate Authority that Total TLS certificates will be issued through.
CertificateAuthority param.Field[CertificateAuthority] `json:"certificate_authority"`
}
func (TotalTLSEditParams) MarshalJSON ¶
func (r TotalTLSEditParams) MarshalJSON() (data []byte, err error)
type TotalTLSEditResponse ¶
type TotalTLSEditResponse struct {
// The Certificate Authority that Total TLS certificates will be issued through.
CertificateAuthority CertificateAuthority `json:"certificate_authority"`
// If enabled, Total TLS will order a hostname specific TLS certificate for any
// proxied A, AAAA, or CNAME record in your zone.
Enabled bool `json:"enabled"`
// The validity period in days for the certificates ordered via Total TLS.
ValidityPeriod TotalTLSEditResponseValidityPeriod `json:"validity_period"`
JSON totalTLSEditResponseJSON `json:"-"`
}
func (*TotalTLSEditResponse) UnmarshalJSON ¶
func (r *TotalTLSEditResponse) UnmarshalJSON(data []byte) (err error)
type TotalTLSEditResponseEnvelope ¶
type TotalTLSEditResponseEnvelope struct {
Errors []TotalTLSEditResponseEnvelopeErrors `json:"errors" api:"required"`
Messages []TotalTLSEditResponseEnvelopeMessages `json:"messages" api:"required"`
// Whether the API call was successful.
Success TotalTLSEditResponseEnvelopeSuccess `json:"success" api:"required"`
Result TotalTLSEditResponse `json:"result"`
JSON totalTLSEditResponseEnvelopeJSON `json:"-"`
}
func (*TotalTLSEditResponseEnvelope) UnmarshalJSON ¶
func (r *TotalTLSEditResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type TotalTLSEditResponseEnvelopeErrors ¶
type TotalTLSEditResponseEnvelopeErrors struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source TotalTLSEditResponseEnvelopeErrorsSource `json:"source"`
JSON totalTLSEditResponseEnvelopeErrorsJSON `json:"-"`
}
func (*TotalTLSEditResponseEnvelopeErrors) UnmarshalJSON ¶
func (r *TotalTLSEditResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type TotalTLSEditResponseEnvelopeErrorsSource ¶
type TotalTLSEditResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON totalTLSEditResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*TotalTLSEditResponseEnvelopeErrorsSource) UnmarshalJSON ¶
func (r *TotalTLSEditResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type TotalTLSEditResponseEnvelopeMessages ¶
type TotalTLSEditResponseEnvelopeMessages struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source TotalTLSEditResponseEnvelopeMessagesSource `json:"source"`
JSON totalTLSEditResponseEnvelopeMessagesJSON `json:"-"`
}
func (*TotalTLSEditResponseEnvelopeMessages) UnmarshalJSON ¶
func (r *TotalTLSEditResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type TotalTLSEditResponseEnvelopeMessagesSource ¶
type TotalTLSEditResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON totalTLSEditResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*TotalTLSEditResponseEnvelopeMessagesSource) UnmarshalJSON ¶
func (r *TotalTLSEditResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type TotalTLSEditResponseEnvelopeSuccess ¶
type TotalTLSEditResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
TotalTLSEditResponseEnvelopeSuccessTrue TotalTLSEditResponseEnvelopeSuccess = true
)
func (TotalTLSEditResponseEnvelopeSuccess) IsKnown ¶
func (r TotalTLSEditResponseEnvelopeSuccess) IsKnown() bool
type TotalTLSEditResponseValidityPeriod ¶
type TotalTLSEditResponseValidityPeriod int64
The validity period in days for the certificates ordered via Total TLS.
const (
TotalTLSEditResponseValidityPeriod90 TotalTLSEditResponseValidityPeriod = 90
)
func (TotalTLSEditResponseValidityPeriod) IsKnown ¶
func (r TotalTLSEditResponseValidityPeriod) IsKnown() bool
type TotalTLSGetParams ¶
type TotalTLSGetResponse ¶
type TotalTLSGetResponse struct {
// The Certificate Authority that Total TLS certificates will be issued through.
CertificateAuthority CertificateAuthority `json:"certificate_authority"`
// If enabled, Total TLS will order a hostname specific TLS certificate for any
// proxied A, AAAA, or CNAME record in your zone.
Enabled bool `json:"enabled"`
// The validity period in days for the certificates ordered via Total TLS.
ValidityPeriod TotalTLSGetResponseValidityPeriod `json:"validity_period"`
JSON totalTLSGetResponseJSON `json:"-"`
}
func (*TotalTLSGetResponse) UnmarshalJSON ¶
func (r *TotalTLSGetResponse) UnmarshalJSON(data []byte) (err error)
type TotalTLSGetResponseEnvelope ¶
type TotalTLSGetResponseEnvelope struct {
Errors []TotalTLSGetResponseEnvelopeErrors `json:"errors" api:"required"`
Messages []TotalTLSGetResponseEnvelopeMessages `json:"messages" api:"required"`
// Whether the API call was successful.
Success TotalTLSGetResponseEnvelopeSuccess `json:"success" api:"required"`
Result TotalTLSGetResponse `json:"result"`
JSON totalTLSGetResponseEnvelopeJSON `json:"-"`
}
func (*TotalTLSGetResponseEnvelope) UnmarshalJSON ¶
func (r *TotalTLSGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type TotalTLSGetResponseEnvelopeErrors ¶
type TotalTLSGetResponseEnvelopeErrors struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source TotalTLSGetResponseEnvelopeErrorsSource `json:"source"`
JSON totalTLSGetResponseEnvelopeErrorsJSON `json:"-"`
}
func (*TotalTLSGetResponseEnvelopeErrors) UnmarshalJSON ¶
func (r *TotalTLSGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type TotalTLSGetResponseEnvelopeErrorsSource ¶
type TotalTLSGetResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON totalTLSGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*TotalTLSGetResponseEnvelopeErrorsSource) UnmarshalJSON ¶
func (r *TotalTLSGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type TotalTLSGetResponseEnvelopeMessages ¶
type TotalTLSGetResponseEnvelopeMessages struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source TotalTLSGetResponseEnvelopeMessagesSource `json:"source"`
JSON totalTLSGetResponseEnvelopeMessagesJSON `json:"-"`
}
func (*TotalTLSGetResponseEnvelopeMessages) UnmarshalJSON ¶
func (r *TotalTLSGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type TotalTLSGetResponseEnvelopeMessagesSource ¶
type TotalTLSGetResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON totalTLSGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*TotalTLSGetResponseEnvelopeMessagesSource) UnmarshalJSON ¶
func (r *TotalTLSGetResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type TotalTLSGetResponseEnvelopeSuccess ¶
type TotalTLSGetResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
TotalTLSGetResponseEnvelopeSuccessTrue TotalTLSGetResponseEnvelopeSuccess = true
)
func (TotalTLSGetResponseEnvelopeSuccess) IsKnown ¶
func (r TotalTLSGetResponseEnvelopeSuccess) IsKnown() bool
type TotalTLSGetResponseValidityPeriod ¶
type TotalTLSGetResponseValidityPeriod int64
The validity period in days for the certificates ordered via Total TLS.
const (
TotalTLSGetResponseValidityPeriod90 TotalTLSGetResponseValidityPeriod = 90
)
func (TotalTLSGetResponseValidityPeriod) IsKnown ¶
func (r TotalTLSGetResponseValidityPeriod) IsKnown() bool
type TotalTLSService ¶
type TotalTLSService struct {
Options []option.RequestOption
}
TotalTLSService 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 NewTotalTLSService method instead.
func NewTotalTLSService ¶
func NewTotalTLSService(opts ...option.RequestOption) (r *TotalTLSService)
NewTotalTLSService 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 (*TotalTLSService) Edit ¶
func (r *TotalTLSService) Edit(ctx context.Context, params TotalTLSEditParams, opts ...option.RequestOption) (res *TotalTLSEditResponse, err error)
Set Total TLS Settings or disable the feature for a Zone.
func (*TotalTLSService) Get ¶
func (r *TotalTLSService) Get(ctx context.Context, query TotalTLSGetParams, opts ...option.RequestOption) (res *TotalTLSGetResponse, err error)
Get Total TLS Settings for a Zone.
func (*TotalTLSService) Update ¶
func (r *TotalTLSService) Update(ctx context.Context, params TotalTLSUpdateParams, opts ...option.RequestOption) (res *TotalTLSUpdateResponse, err error)
Set Total TLS Settings or disable the feature for a Zone.
type TotalTLSUpdateParams ¶
type TotalTLSUpdateParams struct {
// Identifier.
ZoneID param.Field[string] `path:"zone_id" api:"required"`
// If enabled, Total TLS will order a hostname specific TLS certificate for any
// proxied A, AAAA, or CNAME record in your zone.
Enabled param.Field[bool] `json:"enabled" api:"required"`
// The Certificate Authority that Total TLS certificates will be issued through.
CertificateAuthority param.Field[CertificateAuthority] `json:"certificate_authority"`
}
func (TotalTLSUpdateParams) MarshalJSON ¶
func (r TotalTLSUpdateParams) MarshalJSON() (data []byte, err error)
type TotalTLSUpdateResponse ¶
type TotalTLSUpdateResponse struct {
// The Certificate Authority that Total TLS certificates will be issued through.
CertificateAuthority CertificateAuthority `json:"certificate_authority"`
// If enabled, Total TLS will order a hostname specific TLS certificate for any
// proxied A, AAAA, or CNAME record in your zone.
Enabled bool `json:"enabled"`
// The validity period in days for the certificates ordered via Total TLS.
ValidityPeriod TotalTLSUpdateResponseValidityPeriod `json:"validity_period"`
JSON totalTLSUpdateResponseJSON `json:"-"`
}
func (*TotalTLSUpdateResponse) UnmarshalJSON ¶
func (r *TotalTLSUpdateResponse) UnmarshalJSON(data []byte) (err error)
type TotalTLSUpdateResponseEnvelope ¶
type TotalTLSUpdateResponseEnvelope struct {
Errors []TotalTLSUpdateResponseEnvelopeErrors `json:"errors" api:"required"`
Messages []TotalTLSUpdateResponseEnvelopeMessages `json:"messages" api:"required"`
// Whether the API call was successful.
Success TotalTLSUpdateResponseEnvelopeSuccess `json:"success" api:"required"`
Result TotalTLSUpdateResponse `json:"result"`
JSON totalTLSUpdateResponseEnvelopeJSON `json:"-"`
}
func (*TotalTLSUpdateResponseEnvelope) UnmarshalJSON ¶
func (r *TotalTLSUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type TotalTLSUpdateResponseEnvelopeErrors ¶
type TotalTLSUpdateResponseEnvelopeErrors struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source TotalTLSUpdateResponseEnvelopeErrorsSource `json:"source"`
JSON totalTLSUpdateResponseEnvelopeErrorsJSON `json:"-"`
}
func (*TotalTLSUpdateResponseEnvelopeErrors) UnmarshalJSON ¶
func (r *TotalTLSUpdateResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type TotalTLSUpdateResponseEnvelopeErrorsSource ¶
type TotalTLSUpdateResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON totalTLSUpdateResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*TotalTLSUpdateResponseEnvelopeErrorsSource) UnmarshalJSON ¶
func (r *TotalTLSUpdateResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type TotalTLSUpdateResponseEnvelopeMessages ¶
type TotalTLSUpdateResponseEnvelopeMessages struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source TotalTLSUpdateResponseEnvelopeMessagesSource `json:"source"`
JSON totalTLSUpdateResponseEnvelopeMessagesJSON `json:"-"`
}
func (*TotalTLSUpdateResponseEnvelopeMessages) UnmarshalJSON ¶
func (r *TotalTLSUpdateResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type TotalTLSUpdateResponseEnvelopeMessagesSource ¶
type TotalTLSUpdateResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON totalTLSUpdateResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*TotalTLSUpdateResponseEnvelopeMessagesSource) UnmarshalJSON ¶
func (r *TotalTLSUpdateResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type TotalTLSUpdateResponseEnvelopeSuccess ¶
type TotalTLSUpdateResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
TotalTLSUpdateResponseEnvelopeSuccessTrue TotalTLSUpdateResponseEnvelopeSuccess = true
)
func (TotalTLSUpdateResponseEnvelopeSuccess) IsKnown ¶
func (r TotalTLSUpdateResponseEnvelopeSuccess) IsKnown() bool
type TotalTLSUpdateResponseValidityPeriod ¶
type TotalTLSUpdateResponseValidityPeriod int64
The validity period in days for the certificates ordered via Total TLS.
const (
TotalTLSUpdateResponseValidityPeriod90 TotalTLSUpdateResponseValidityPeriod = 90
)
func (TotalTLSUpdateResponseValidityPeriod) IsKnown ¶
func (r TotalTLSUpdateResponseValidityPeriod) IsKnown() bool