Documentation
¶
Index ¶
- Constants
- type ASN
- type ASNParam
- type AuditLog
- type AuditLogAction
- type AuditLogActor
- type AuditLogActorType
- type AuditLogOwner
- type AuditLogResource
- type AuthenticatedOriginPull
- type AuthenticatedOriginPullCERTStatus
- type AuthenticatedOriginPullStatus
- type CertificateCA
- type CertificateRequestType
- type CloudflareTunnel
- type CloudflareTunnelConnection
- type CloudflareTunnelStatus
- type CloudflareTunnelTunType
- type Error
- type ErrorData
- type ErrorDataSource
- type HostnameCertificateDeleteParams
- type HostnameCertificateDeleteResponse
- type HostnameCertificateDeleteResponseEnvelope
- type HostnameCertificateDeleteResponseEnvelopeErrors
- type HostnameCertificateDeleteResponseEnvelopeErrorsSource
- type HostnameCertificateDeleteResponseEnvelopeMessages
- type HostnameCertificateDeleteResponseEnvelopeMessagesSource
- type HostnameCertificateDeleteResponseEnvelopeSuccess
- type HostnameCertificateDeleteResponseStatus
- type HostnameCertificateGetParams
- type HostnameCertificateGetResponse
- type HostnameCertificateGetResponseEnvelope
- type HostnameCertificateGetResponseEnvelopeErrors
- type HostnameCertificateGetResponseEnvelopeErrorsSource
- type HostnameCertificateGetResponseEnvelopeMessages
- type HostnameCertificateGetResponseEnvelopeMessagesSource
- type HostnameCertificateGetResponseEnvelopeSuccess
- type HostnameCertificateGetResponseStatus
- type HostnameCertificateListParams
- type HostnameCertificateListResponse
- type HostnameCertificateNewParams
- type HostnameCertificateNewResponse
- type HostnameCertificateNewResponseEnvelope
- type HostnameCertificateNewResponseEnvelopeErrors
- type HostnameCertificateNewResponseEnvelopeErrorsSource
- type HostnameCertificateNewResponseEnvelopeMessages
- type HostnameCertificateNewResponseEnvelopeMessagesSource
- type HostnameCertificateNewResponseEnvelopeSuccess
- type HostnameCertificateNewResponseStatus
- type HostnameCertificateService
- func (r *HostnameCertificateService) Delete(ctx context.Context, certificateID string, ...) (res *HostnameCertificateDeleteResponse, err error)
- func (r *HostnameCertificateService) Get(ctx context.Context, certificateID string, query HostnameCertificateGetParams, ...) (res *HostnameCertificateGetResponse, err error)
- func (r *HostnameCertificateService) List(ctx context.Context, query HostnameCertificateListParams, ...) (res *pagination.SinglePage[HostnameCertificateListResponse], err error)
- func (r *HostnameCertificateService) ListAutoPaging(ctx context.Context, query HostnameCertificateListParams, ...) *pagination.SinglePageAutoPager[HostnameCertificateListResponse]
- func (r *HostnameCertificateService) New(ctx context.Context, params HostnameCertificateNewParams, ...) (res *HostnameCertificateNewResponse, err error)
- type HostnameGetParams
- type HostnameGetResponseEnvelope
- type HostnameGetResponseEnvelopeErrors
- type HostnameGetResponseEnvelopeErrorsSource
- type HostnameGetResponseEnvelopeMessages
- type HostnameGetResponseEnvelopeMessagesSource
- type HostnameGetResponseEnvelopeSuccess
- type HostnameService
- func (r *HostnameService) Get(ctx context.Context, hostname string, query HostnameGetParams, ...) (res *AuthenticatedOriginPull, err error)
- func (r *HostnameService) Update(ctx context.Context, params HostnameUpdateParams, opts ...option.RequestOption) (res *pagination.SinglePage[HostnameUpdateResponse], err error)
- func (r *HostnameService) UpdateAutoPaging(ctx context.Context, params HostnameUpdateParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[HostnameUpdateResponse]
- type HostnameUpdateParams
- type HostnameUpdateParamsConfig
- type HostnameUpdateResponse
- type Member
- type MemberPoliciesAccess
- type MemberPoliciesPermissionGroup
- type MemberPoliciesPermissionGroupsMeta
- type MemberPoliciesResourceGroup
- type MemberPoliciesResourceGroupsMeta
- type MemberPoliciesResourceGroupsScope
- type MemberPoliciesResourceGroupsScopeObject
- type MemberPolicy
- type MemberStatus
- type MemberUser
- type OriginTLSClientAuthDeleteParams
- type OriginTLSClientAuthDeleteResponse
- type OriginTLSClientAuthDeleteResponseEnvelope
- type OriginTLSClientAuthDeleteResponseEnvelopeErrors
- type OriginTLSClientAuthDeleteResponseEnvelopeErrorsSource
- type OriginTLSClientAuthDeleteResponseEnvelopeMessages
- type OriginTLSClientAuthDeleteResponseEnvelopeMessagesSource
- type OriginTLSClientAuthDeleteResponseEnvelopeSuccess
- type OriginTLSClientAuthGetParams
- type OriginTLSClientAuthGetResponse
- type OriginTLSClientAuthGetResponseEnvelope
- type OriginTLSClientAuthGetResponseEnvelopeErrors
- type OriginTLSClientAuthGetResponseEnvelopeErrorsSource
- type OriginTLSClientAuthGetResponseEnvelopeMessages
- type OriginTLSClientAuthGetResponseEnvelopeMessagesSource
- type OriginTLSClientAuthGetResponseEnvelopeSuccess
- type OriginTLSClientAuthListParams
- type OriginTLSClientAuthListResponse
- type OriginTLSClientAuthNewParams
- type OriginTLSClientAuthNewResponse
- type OriginTLSClientAuthNewResponseEnvelope
- type OriginTLSClientAuthNewResponseEnvelopeErrors
- type OriginTLSClientAuthNewResponseEnvelopeErrorsSource
- type OriginTLSClientAuthNewResponseEnvelopeMessages
- type OriginTLSClientAuthNewResponseEnvelopeMessagesSource
- type OriginTLSClientAuthNewResponseEnvelopeSuccess
- type OriginTLSClientAuthService
- func (r *OriginTLSClientAuthService) Delete(ctx context.Context, certificateID string, ...) (res *OriginTLSClientAuthDeleteResponse, err error)
- func (r *OriginTLSClientAuthService) Get(ctx context.Context, certificateID string, query OriginTLSClientAuthGetParams, ...) (res *OriginTLSClientAuthGetResponse, err error)
- func (r *OriginTLSClientAuthService) List(ctx context.Context, query OriginTLSClientAuthListParams, ...) (res *pagination.SinglePage[OriginTLSClientAuthListResponse], err error)
- func (r *OriginTLSClientAuthService) ListAutoPaging(ctx context.Context, query OriginTLSClientAuthListParams, ...) *pagination.SinglePageAutoPager[OriginTLSClientAuthListResponse]
- func (r *OriginTLSClientAuthService) New(ctx context.Context, params OriginTLSClientAuthNewParams, ...) (res *OriginTLSClientAuthNewResponse, err error)
- 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 SettingGetParams
- type SettingGetResponse
- type SettingGetResponseEnvelope
- type SettingGetResponseEnvelopeErrors
- type SettingGetResponseEnvelopeErrorsSource
- type SettingGetResponseEnvelopeMessages
- type SettingGetResponseEnvelopeMessagesSource
- type SettingGetResponseEnvelopeSuccess
- type SettingService
- type SettingUpdateParams
- type SettingUpdateResponse
- type SettingUpdateResponseEnvelope
- type SettingUpdateResponseEnvelopeErrors
- type SettingUpdateResponseEnvelopeErrorsSource
- type SettingUpdateResponseEnvelopeMessages
- type SettingUpdateResponseEnvelopeMessagesSource
- type SettingUpdateResponseEnvelopeSuccess
- 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 TokenStatus
- type TokenValue
- type ZoneAuthenticatedOriginPull
- type ZoneAuthenticatedOriginPullStatus
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 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 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 AuthenticatedOriginPull ¶
type AuthenticatedOriginPull struct {
// Identifier.
CERTID string `json:"cert_id"`
// Status of the certificate or the association.
CERTStatus AuthenticatedOriginPullCERTStatus `json:"cert_status"`
// The time when the certificate was updated.
CERTUpdatedAt time.Time `json:"cert_updated_at" format:"date-time"`
// The time when the certificate was uploaded.
CERTUploadedOn time.Time `json:"cert_uploaded_on" format:"date-time"`
// The hostname certificate.
Certificate string `json:"certificate"`
// The time when the certificate was created.
CreatedAt time.Time `json:"created_at" format:"date-time"`
// Indicates whether hostname-level authenticated origin pulls is enabled. A null
// value voids the association.
Enabled bool `json:"enabled,nullable"`
// The date when the certificate expires.
ExpiresOn time.Time `json:"expires_on" format:"date-time"`
// The hostname on the origin for which the client certificate uploaded will be
// used.
Hostname string `json:"hostname"`
// The certificate authority that issued the certificate.
Issuer string `json:"issuer"`
// The serial number on the uploaded certificate.
SerialNumber string `json:"serial_number"`
// The type of hash used for the certificate.
Signature string `json:"signature"`
// Status of the certificate or the association.
Status AuthenticatedOriginPullStatus `json:"status"`
// The time when the certificate was updated.
UpdatedAt time.Time `json:"updated_at" format:"date-time"`
JSON authenticatedOriginPullJSON `json:"-"`
}
func (*AuthenticatedOriginPull) UnmarshalJSON ¶
func (r *AuthenticatedOriginPull) UnmarshalJSON(data []byte) (err error)
type AuthenticatedOriginPullCERTStatus ¶
type AuthenticatedOriginPullCERTStatus string
Status of the certificate or the association.
const ( AuthenticatedOriginPullCERTStatusInitializing AuthenticatedOriginPullCERTStatus = "initializing" AuthenticatedOriginPullCERTStatusPendingDeployment AuthenticatedOriginPullCERTStatus = "pending_deployment" AuthenticatedOriginPullCERTStatusPendingDeletion AuthenticatedOriginPullCERTStatus = "pending_deletion" AuthenticatedOriginPullCERTStatusActive AuthenticatedOriginPullCERTStatus = "active" AuthenticatedOriginPullCERTStatusDeleted AuthenticatedOriginPullCERTStatus = "deleted" AuthenticatedOriginPullCERTStatusDeploymentTimedOut AuthenticatedOriginPullCERTStatus = "deployment_timed_out" AuthenticatedOriginPullCERTStatusDeletionTimedOut AuthenticatedOriginPullCERTStatus = "deletion_timed_out" )
func (AuthenticatedOriginPullCERTStatus) IsKnown ¶
func (r AuthenticatedOriginPullCERTStatus) IsKnown() bool
type AuthenticatedOriginPullStatus ¶
type AuthenticatedOriginPullStatus string
Status of the certificate or the association.
const ( AuthenticatedOriginPullStatusInitializing AuthenticatedOriginPullStatus = "initializing" AuthenticatedOriginPullStatusPendingDeployment AuthenticatedOriginPullStatus = "pending_deployment" AuthenticatedOriginPullStatusPendingDeletion AuthenticatedOriginPullStatus = "pending_deletion" AuthenticatedOriginPullStatusActive AuthenticatedOriginPullStatus = "active" AuthenticatedOriginPullStatusDeleted AuthenticatedOriginPullStatus = "deleted" AuthenticatedOriginPullStatusDeploymentTimedOut AuthenticatedOriginPullStatus = "deployment_timed_out" AuthenticatedOriginPullStatusDeletionTimedOut AuthenticatedOriginPullStatus = "deletion_timed_out" )
func (AuthenticatedOriginPullStatus) IsKnown ¶
func (r AuthenticatedOriginPullStatus) 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 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 ErrorDataSource ¶ added in v4.2.0
type ErrorDataSource = shared.ErrorDataSource
This is an alias to an internal type.
type HostnameCertificateDeleteResponse ¶
type HostnameCertificateDeleteResponse struct {
// Identifier.
ID string `json:"id"`
// The hostname certificate.
Certificate string `json:"certificate"`
// The date when the certificate expires.
ExpiresOn time.Time `json:"expires_on" format:"date-time"`
// The certificate authority that issued the certificate.
Issuer string `json:"issuer"`
// The serial number on the uploaded certificate.
SerialNumber string `json:"serial_number"`
// The type of hash used for the certificate.
Signature string `json:"signature"`
// Status of the certificate or the association.
Status HostnameCertificateDeleteResponseStatus `json:"status"`
// The time when the certificate was uploaded.
UploadedOn time.Time `json:"uploaded_on" format:"date-time"`
JSON hostnameCertificateDeleteResponseJSON `json:"-"`
}
func (*HostnameCertificateDeleteResponse) UnmarshalJSON ¶
func (r *HostnameCertificateDeleteResponse) UnmarshalJSON(data []byte) (err error)
type HostnameCertificateDeleteResponseEnvelope ¶
type HostnameCertificateDeleteResponseEnvelope struct {
Errors []HostnameCertificateDeleteResponseEnvelopeErrors `json:"errors,required"`
Messages []HostnameCertificateDeleteResponseEnvelopeMessages `json:"messages,required"`
// Whether the API call was successful.
Success HostnameCertificateDeleteResponseEnvelopeSuccess `json:"success,required"`
Result HostnameCertificateDeleteResponse `json:"result"`
JSON hostnameCertificateDeleteResponseEnvelopeJSON `json:"-"`
}
func (*HostnameCertificateDeleteResponseEnvelope) UnmarshalJSON ¶
func (r *HostnameCertificateDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type HostnameCertificateDeleteResponseEnvelopeErrors ¶ added in v4.3.0
type HostnameCertificateDeleteResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source HostnameCertificateDeleteResponseEnvelopeErrorsSource `json:"source"`
JSON hostnameCertificateDeleteResponseEnvelopeErrorsJSON `json:"-"`
}
func (*HostnameCertificateDeleteResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.3.0
func (r *HostnameCertificateDeleteResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type HostnameCertificateDeleteResponseEnvelopeErrorsSource ¶ added in v4.3.0
type HostnameCertificateDeleteResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON hostnameCertificateDeleteResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*HostnameCertificateDeleteResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v4.3.0
func (r *HostnameCertificateDeleteResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type HostnameCertificateDeleteResponseEnvelopeMessages ¶ added in v4.3.0
type HostnameCertificateDeleteResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source HostnameCertificateDeleteResponseEnvelopeMessagesSource `json:"source"`
JSON hostnameCertificateDeleteResponseEnvelopeMessagesJSON `json:"-"`
}
func (*HostnameCertificateDeleteResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.3.0
func (r *HostnameCertificateDeleteResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type HostnameCertificateDeleteResponseEnvelopeMessagesSource ¶ added in v4.3.0
type HostnameCertificateDeleteResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON hostnameCertificateDeleteResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*HostnameCertificateDeleteResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v4.3.0
func (r *HostnameCertificateDeleteResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type HostnameCertificateDeleteResponseEnvelopeSuccess ¶
type HostnameCertificateDeleteResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
HostnameCertificateDeleteResponseEnvelopeSuccessTrue HostnameCertificateDeleteResponseEnvelopeSuccess = true
)
func (HostnameCertificateDeleteResponseEnvelopeSuccess) IsKnown ¶
func (r HostnameCertificateDeleteResponseEnvelopeSuccess) IsKnown() bool
type HostnameCertificateDeleteResponseStatus ¶
type HostnameCertificateDeleteResponseStatus string
Status of the certificate or the association.
const ( HostnameCertificateDeleteResponseStatusInitializing HostnameCertificateDeleteResponseStatus = "initializing" HostnameCertificateDeleteResponseStatusPendingDeployment HostnameCertificateDeleteResponseStatus = "pending_deployment" HostnameCertificateDeleteResponseStatusPendingDeletion HostnameCertificateDeleteResponseStatus = "pending_deletion" HostnameCertificateDeleteResponseStatusActive HostnameCertificateDeleteResponseStatus = "active" HostnameCertificateDeleteResponseStatusDeleted HostnameCertificateDeleteResponseStatus = "deleted" HostnameCertificateDeleteResponseStatusDeploymentTimedOut HostnameCertificateDeleteResponseStatus = "deployment_timed_out" HostnameCertificateDeleteResponseStatusDeletionTimedOut HostnameCertificateDeleteResponseStatus = "deletion_timed_out" )
func (HostnameCertificateDeleteResponseStatus) IsKnown ¶
func (r HostnameCertificateDeleteResponseStatus) IsKnown() bool
type HostnameCertificateGetResponse ¶
type HostnameCertificateGetResponse struct {
// Identifier.
ID string `json:"id"`
// The hostname certificate.
Certificate string `json:"certificate"`
// The date when the certificate expires.
ExpiresOn time.Time `json:"expires_on" format:"date-time"`
// The certificate authority that issued the certificate.
Issuer string `json:"issuer"`
// The serial number on the uploaded certificate.
SerialNumber string `json:"serial_number"`
// The type of hash used for the certificate.
Signature string `json:"signature"`
// Status of the certificate or the association.
Status HostnameCertificateGetResponseStatus `json:"status"`
// The time when the certificate was uploaded.
UploadedOn time.Time `json:"uploaded_on" format:"date-time"`
JSON hostnameCertificateGetResponseJSON `json:"-"`
}
func (*HostnameCertificateGetResponse) UnmarshalJSON ¶
func (r *HostnameCertificateGetResponse) UnmarshalJSON(data []byte) (err error)
type HostnameCertificateGetResponseEnvelope ¶
type HostnameCertificateGetResponseEnvelope struct {
Errors []HostnameCertificateGetResponseEnvelopeErrors `json:"errors,required"`
Messages []HostnameCertificateGetResponseEnvelopeMessages `json:"messages,required"`
// Whether the API call was successful.
Success HostnameCertificateGetResponseEnvelopeSuccess `json:"success,required"`
Result HostnameCertificateGetResponse `json:"result"`
JSON hostnameCertificateGetResponseEnvelopeJSON `json:"-"`
}
func (*HostnameCertificateGetResponseEnvelope) UnmarshalJSON ¶
func (r *HostnameCertificateGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type HostnameCertificateGetResponseEnvelopeErrors ¶ added in v4.3.0
type HostnameCertificateGetResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source HostnameCertificateGetResponseEnvelopeErrorsSource `json:"source"`
JSON hostnameCertificateGetResponseEnvelopeErrorsJSON `json:"-"`
}
func (*HostnameCertificateGetResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.3.0
func (r *HostnameCertificateGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type HostnameCertificateGetResponseEnvelopeErrorsSource ¶ added in v4.3.0
type HostnameCertificateGetResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON hostnameCertificateGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*HostnameCertificateGetResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v4.3.0
func (r *HostnameCertificateGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type HostnameCertificateGetResponseEnvelopeMessages ¶ added in v4.3.0
type HostnameCertificateGetResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source HostnameCertificateGetResponseEnvelopeMessagesSource `json:"source"`
JSON hostnameCertificateGetResponseEnvelopeMessagesJSON `json:"-"`
}
func (*HostnameCertificateGetResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.3.0
func (r *HostnameCertificateGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type HostnameCertificateGetResponseEnvelopeMessagesSource ¶ added in v4.3.0
type HostnameCertificateGetResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON hostnameCertificateGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*HostnameCertificateGetResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v4.3.0
func (r *HostnameCertificateGetResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type HostnameCertificateGetResponseEnvelopeSuccess ¶
type HostnameCertificateGetResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
HostnameCertificateGetResponseEnvelopeSuccessTrue HostnameCertificateGetResponseEnvelopeSuccess = true
)
func (HostnameCertificateGetResponseEnvelopeSuccess) IsKnown ¶
func (r HostnameCertificateGetResponseEnvelopeSuccess) IsKnown() bool
type HostnameCertificateGetResponseStatus ¶
type HostnameCertificateGetResponseStatus string
Status of the certificate or the association.
const ( HostnameCertificateGetResponseStatusInitializing HostnameCertificateGetResponseStatus = "initializing" HostnameCertificateGetResponseStatusPendingDeployment HostnameCertificateGetResponseStatus = "pending_deployment" HostnameCertificateGetResponseStatusPendingDeletion HostnameCertificateGetResponseStatus = "pending_deletion" HostnameCertificateGetResponseStatusActive HostnameCertificateGetResponseStatus = "active" HostnameCertificateGetResponseStatusDeleted HostnameCertificateGetResponseStatus = "deleted" HostnameCertificateGetResponseStatusDeploymentTimedOut HostnameCertificateGetResponseStatus = "deployment_timed_out" HostnameCertificateGetResponseStatusDeletionTimedOut HostnameCertificateGetResponseStatus = "deletion_timed_out" )
func (HostnameCertificateGetResponseStatus) IsKnown ¶
func (r HostnameCertificateGetResponseStatus) IsKnown() bool
type HostnameCertificateListResponse ¶
type HostnameCertificateListResponse struct {
// Identifier.
ID string `json:"id"`
// Identifier.
CERTID string `json:"cert_id"`
// The hostname certificate.
Certificate string `json:"certificate"`
// Indicates whether hostname-level authenticated origin pulls is enabled. A null
// value voids the association.
Enabled bool `json:"enabled,nullable"`
// The hostname on the origin for which the client certificate uploaded will be
// used.
Hostname string `json:"hostname"`
// The hostname certificate's private key.
PrivateKey string `json:"private_key"`
JSON hostnameCertificateListResponseJSON `json:"-"`
AuthenticatedOriginPull
}
func (*HostnameCertificateListResponse) UnmarshalJSON ¶
func (r *HostnameCertificateListResponse) UnmarshalJSON(data []byte) (err error)
type HostnameCertificateNewParams ¶
type HostnameCertificateNewParams struct {
// Identifier.
ZoneID param.Field[string] `path:"zone_id,required"`
// The hostname certificate.
Certificate param.Field[string] `json:"certificate,required"`
// The hostname certificate's private key.
PrivateKey param.Field[string] `json:"private_key,required"`
}
func (HostnameCertificateNewParams) MarshalJSON ¶
func (r HostnameCertificateNewParams) MarshalJSON() (data []byte, err error)
type HostnameCertificateNewResponse ¶
type HostnameCertificateNewResponse struct {
// Identifier.
ID string `json:"id"`
// The hostname certificate.
Certificate string `json:"certificate"`
// The date when the certificate expires.
ExpiresOn time.Time `json:"expires_on" format:"date-time"`
// The certificate authority that issued the certificate.
Issuer string `json:"issuer"`
// The serial number on the uploaded certificate.
SerialNumber string `json:"serial_number"`
// The type of hash used for the certificate.
Signature string `json:"signature"`
// Status of the certificate or the association.
Status HostnameCertificateNewResponseStatus `json:"status"`
// The time when the certificate was uploaded.
UploadedOn time.Time `json:"uploaded_on" format:"date-time"`
JSON hostnameCertificateNewResponseJSON `json:"-"`
}
func (*HostnameCertificateNewResponse) UnmarshalJSON ¶
func (r *HostnameCertificateNewResponse) UnmarshalJSON(data []byte) (err error)
type HostnameCertificateNewResponseEnvelope ¶
type HostnameCertificateNewResponseEnvelope struct {
Errors []HostnameCertificateNewResponseEnvelopeErrors `json:"errors,required"`
Messages []HostnameCertificateNewResponseEnvelopeMessages `json:"messages,required"`
// Whether the API call was successful.
Success HostnameCertificateNewResponseEnvelopeSuccess `json:"success,required"`
Result HostnameCertificateNewResponse `json:"result"`
JSON hostnameCertificateNewResponseEnvelopeJSON `json:"-"`
}
func (*HostnameCertificateNewResponseEnvelope) UnmarshalJSON ¶
func (r *HostnameCertificateNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type HostnameCertificateNewResponseEnvelopeErrors ¶ added in v4.3.0
type HostnameCertificateNewResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source HostnameCertificateNewResponseEnvelopeErrorsSource `json:"source"`
JSON hostnameCertificateNewResponseEnvelopeErrorsJSON `json:"-"`
}
func (*HostnameCertificateNewResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.3.0
func (r *HostnameCertificateNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type HostnameCertificateNewResponseEnvelopeErrorsSource ¶ added in v4.3.0
type HostnameCertificateNewResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON hostnameCertificateNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*HostnameCertificateNewResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v4.3.0
func (r *HostnameCertificateNewResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type HostnameCertificateNewResponseEnvelopeMessages ¶ added in v4.3.0
type HostnameCertificateNewResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source HostnameCertificateNewResponseEnvelopeMessagesSource `json:"source"`
JSON hostnameCertificateNewResponseEnvelopeMessagesJSON `json:"-"`
}
func (*HostnameCertificateNewResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.3.0
func (r *HostnameCertificateNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type HostnameCertificateNewResponseEnvelopeMessagesSource ¶ added in v4.3.0
type HostnameCertificateNewResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON hostnameCertificateNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*HostnameCertificateNewResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v4.3.0
func (r *HostnameCertificateNewResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type HostnameCertificateNewResponseEnvelopeSuccess ¶
type HostnameCertificateNewResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
HostnameCertificateNewResponseEnvelopeSuccessTrue HostnameCertificateNewResponseEnvelopeSuccess = true
)
func (HostnameCertificateNewResponseEnvelopeSuccess) IsKnown ¶
func (r HostnameCertificateNewResponseEnvelopeSuccess) IsKnown() bool
type HostnameCertificateNewResponseStatus ¶
type HostnameCertificateNewResponseStatus string
Status of the certificate or the association.
const ( HostnameCertificateNewResponseStatusInitializing HostnameCertificateNewResponseStatus = "initializing" HostnameCertificateNewResponseStatusPendingDeployment HostnameCertificateNewResponseStatus = "pending_deployment" HostnameCertificateNewResponseStatusPendingDeletion HostnameCertificateNewResponseStatus = "pending_deletion" HostnameCertificateNewResponseStatusActive HostnameCertificateNewResponseStatus = "active" HostnameCertificateNewResponseStatusDeleted HostnameCertificateNewResponseStatus = "deleted" HostnameCertificateNewResponseStatusDeploymentTimedOut HostnameCertificateNewResponseStatus = "deployment_timed_out" HostnameCertificateNewResponseStatusDeletionTimedOut HostnameCertificateNewResponseStatus = "deletion_timed_out" )
func (HostnameCertificateNewResponseStatus) IsKnown ¶
func (r HostnameCertificateNewResponseStatus) IsKnown() bool
type HostnameCertificateService ¶
type HostnameCertificateService struct {
Options []option.RequestOption
}
HostnameCertificateService 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 NewHostnameCertificateService method instead.
func NewHostnameCertificateService ¶
func NewHostnameCertificateService(opts ...option.RequestOption) (r *HostnameCertificateService)
NewHostnameCertificateService 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 (*HostnameCertificateService) Delete ¶
func (r *HostnameCertificateService) Delete(ctx context.Context, certificateID string, body HostnameCertificateDeleteParams, opts ...option.RequestOption) (res *HostnameCertificateDeleteResponse, err error)
Delete Hostname Client Certificate
func (*HostnameCertificateService) Get ¶
func (r *HostnameCertificateService) Get(ctx context.Context, certificateID string, query HostnameCertificateGetParams, opts ...option.RequestOption) (res *HostnameCertificateGetResponse, err error)
Get the certificate by ID to be used for client authentication on a hostname.
func (*HostnameCertificateService) List ¶
func (r *HostnameCertificateService) List(ctx context.Context, query HostnameCertificateListParams, opts ...option.RequestOption) (res *pagination.SinglePage[HostnameCertificateListResponse], err error)
List Certificates
func (*HostnameCertificateService) ListAutoPaging ¶
func (r *HostnameCertificateService) ListAutoPaging(ctx context.Context, query HostnameCertificateListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[HostnameCertificateListResponse]
List Certificates
func (*HostnameCertificateService) New ¶
func (r *HostnameCertificateService) New(ctx context.Context, params HostnameCertificateNewParams, opts ...option.RequestOption) (res *HostnameCertificateNewResponse, err error)
Upload a certificate to be used for client authentication on a hostname. 10 hostname certificates per zone are allowed.
type HostnameGetParams ¶
type HostnameGetResponseEnvelope ¶
type HostnameGetResponseEnvelope struct {
Errors []HostnameGetResponseEnvelopeErrors `json:"errors,required"`
Messages []HostnameGetResponseEnvelopeMessages `json:"messages,required"`
// Whether the API call was successful.
Success HostnameGetResponseEnvelopeSuccess `json:"success,required"`
Result AuthenticatedOriginPull `json:"result"`
JSON hostnameGetResponseEnvelopeJSON `json:"-"`
}
func (*HostnameGetResponseEnvelope) UnmarshalJSON ¶
func (r *HostnameGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type HostnameGetResponseEnvelopeErrors ¶ added in v4.3.0
type HostnameGetResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source HostnameGetResponseEnvelopeErrorsSource `json:"source"`
JSON hostnameGetResponseEnvelopeErrorsJSON `json:"-"`
}
func (*HostnameGetResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.3.0
func (r *HostnameGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type HostnameGetResponseEnvelopeErrorsSource ¶ added in v4.3.0
type HostnameGetResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON hostnameGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*HostnameGetResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v4.3.0
func (r *HostnameGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type HostnameGetResponseEnvelopeMessages ¶ added in v4.3.0
type HostnameGetResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source HostnameGetResponseEnvelopeMessagesSource `json:"source"`
JSON hostnameGetResponseEnvelopeMessagesJSON `json:"-"`
}
func (*HostnameGetResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.3.0
func (r *HostnameGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type HostnameGetResponseEnvelopeMessagesSource ¶ added in v4.3.0
type HostnameGetResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON hostnameGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*HostnameGetResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v4.3.0
func (r *HostnameGetResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type HostnameGetResponseEnvelopeSuccess ¶
type HostnameGetResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
HostnameGetResponseEnvelopeSuccessTrue HostnameGetResponseEnvelopeSuccess = true
)
func (HostnameGetResponseEnvelopeSuccess) IsKnown ¶
func (r HostnameGetResponseEnvelopeSuccess) IsKnown() bool
type HostnameService ¶
type HostnameService struct {
Options []option.RequestOption
Certificates *HostnameCertificateService
}
HostnameService 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 NewHostnameService method instead.
func NewHostnameService ¶
func NewHostnameService(opts ...option.RequestOption) (r *HostnameService)
NewHostnameService 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 (*HostnameService) Get ¶
func (r *HostnameService) Get(ctx context.Context, hostname string, query HostnameGetParams, opts ...option.RequestOption) (res *AuthenticatedOriginPull, err error)
Get the Hostname Status for Client Authentication
func (*HostnameService) Update ¶
func (r *HostnameService) Update(ctx context.Context, params HostnameUpdateParams, opts ...option.RequestOption) (res *pagination.SinglePage[HostnameUpdateResponse], err error)
Associate a hostname to a certificate and enable, disable or invalidate the association. If disabled, client certificate will not be sent to the hostname even if activated at the zone level. 100 maximum associations on a single certificate are allowed. Note: Use a null value for parameter _enabled_ to invalidate the association.
func (*HostnameService) UpdateAutoPaging ¶ added in v4.1.0
func (r *HostnameService) UpdateAutoPaging(ctx context.Context, params HostnameUpdateParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[HostnameUpdateResponse]
Associate a hostname to a certificate and enable, disable or invalidate the association. If disabled, client certificate will not be sent to the hostname even if activated at the zone level. 100 maximum associations on a single certificate are allowed. Note: Use a null value for parameter _enabled_ to invalidate the association.
type HostnameUpdateParams ¶
type HostnameUpdateParams struct {
// Identifier.
ZoneID param.Field[string] `path:"zone_id,required"`
Config param.Field[[]HostnameUpdateParamsConfig] `json:"config,required"`
}
func (HostnameUpdateParams) MarshalJSON ¶
func (r HostnameUpdateParams) MarshalJSON() (data []byte, err error)
type HostnameUpdateParamsConfig ¶
type HostnameUpdateParamsConfig struct {
// Certificate identifier tag.
CERTID param.Field[string] `json:"cert_id"`
// Indicates whether hostname-level authenticated origin pulls is enabled. A null
// value voids the association.
Enabled param.Field[bool] `json:"enabled"`
// The hostname on the origin for which the client certificate uploaded will be
// used.
Hostname param.Field[string] `json:"hostname"`
}
func (HostnameUpdateParamsConfig) MarshalJSON ¶
func (r HostnameUpdateParamsConfig) MarshalJSON() (data []byte, err error)
type HostnameUpdateResponse ¶
type HostnameUpdateResponse struct {
// Identifier.
ID string `json:"id"`
// Identifier.
CERTID string `json:"cert_id"`
// The hostname certificate.
Certificate string `json:"certificate"`
// Indicates whether hostname-level authenticated origin pulls is enabled. A null
// value voids the association.
Enabled bool `json:"enabled,nullable"`
// The hostname on the origin for which the client certificate uploaded will be
// used.
Hostname string `json:"hostname"`
// The hostname certificate's private key.
PrivateKey string `json:"private_key"`
JSON hostnameUpdateResponseJSON `json:"-"`
AuthenticatedOriginPull
}
func (*HostnameUpdateResponse) UnmarshalJSON ¶
func (r *HostnameUpdateResponse) UnmarshalJSON(data []byte) (err error)
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 OriginTLSClientAuthDeleteResponse ¶
type OriginTLSClientAuthDeleteResponse struct {
// Identifier.
ID string `json:"id"`
// The zone's leaf certificate.
Certificate string `json:"certificate"`
// Indicates whether zone-level authenticated origin pulls is enabled.
Enabled bool `json:"enabled"`
// The zone's private key.
PrivateKey string `json:"private_key"`
JSON originTLSClientAuthDeleteResponseJSON `json:"-"`
ZoneAuthenticatedOriginPull
}
func (*OriginTLSClientAuthDeleteResponse) UnmarshalJSON ¶
func (r *OriginTLSClientAuthDeleteResponse) UnmarshalJSON(data []byte) (err error)
type OriginTLSClientAuthDeleteResponseEnvelope ¶
type OriginTLSClientAuthDeleteResponseEnvelope struct {
Errors []OriginTLSClientAuthDeleteResponseEnvelopeErrors `json:"errors,required"`
Messages []OriginTLSClientAuthDeleteResponseEnvelopeMessages `json:"messages,required"`
// Whether the API call was successful.
Success OriginTLSClientAuthDeleteResponseEnvelopeSuccess `json:"success,required"`
Result OriginTLSClientAuthDeleteResponse `json:"result"`
JSON originTLSClientAuthDeleteResponseEnvelopeJSON `json:"-"`
}
func (*OriginTLSClientAuthDeleteResponseEnvelope) UnmarshalJSON ¶
func (r *OriginTLSClientAuthDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type OriginTLSClientAuthDeleteResponseEnvelopeErrors ¶ added in v4.3.0
type OriginTLSClientAuthDeleteResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source OriginTLSClientAuthDeleteResponseEnvelopeErrorsSource `json:"source"`
JSON originTLSClientAuthDeleteResponseEnvelopeErrorsJSON `json:"-"`
}
func (*OriginTLSClientAuthDeleteResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.3.0
func (r *OriginTLSClientAuthDeleteResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type OriginTLSClientAuthDeleteResponseEnvelopeErrorsSource ¶ added in v4.3.0
type OriginTLSClientAuthDeleteResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON originTLSClientAuthDeleteResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*OriginTLSClientAuthDeleteResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v4.3.0
func (r *OriginTLSClientAuthDeleteResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type OriginTLSClientAuthDeleteResponseEnvelopeMessages ¶ added in v4.3.0
type OriginTLSClientAuthDeleteResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source OriginTLSClientAuthDeleteResponseEnvelopeMessagesSource `json:"source"`
JSON originTLSClientAuthDeleteResponseEnvelopeMessagesJSON `json:"-"`
}
func (*OriginTLSClientAuthDeleteResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.3.0
func (r *OriginTLSClientAuthDeleteResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type OriginTLSClientAuthDeleteResponseEnvelopeMessagesSource ¶ added in v4.3.0
type OriginTLSClientAuthDeleteResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON originTLSClientAuthDeleteResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*OriginTLSClientAuthDeleteResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v4.3.0
func (r *OriginTLSClientAuthDeleteResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type OriginTLSClientAuthDeleteResponseEnvelopeSuccess ¶
type OriginTLSClientAuthDeleteResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
OriginTLSClientAuthDeleteResponseEnvelopeSuccessTrue OriginTLSClientAuthDeleteResponseEnvelopeSuccess = true
)
func (OriginTLSClientAuthDeleteResponseEnvelopeSuccess) IsKnown ¶
func (r OriginTLSClientAuthDeleteResponseEnvelopeSuccess) IsKnown() bool
type OriginTLSClientAuthGetResponse ¶
type OriginTLSClientAuthGetResponse struct {
// Identifier.
ID string `json:"id"`
// The zone's leaf certificate.
Certificate string `json:"certificate"`
// Indicates whether zone-level authenticated origin pulls is enabled.
Enabled bool `json:"enabled"`
// The zone's private key.
PrivateKey string `json:"private_key"`
JSON originTLSClientAuthGetResponseJSON `json:"-"`
ZoneAuthenticatedOriginPull
}
func (*OriginTLSClientAuthGetResponse) UnmarshalJSON ¶
func (r *OriginTLSClientAuthGetResponse) UnmarshalJSON(data []byte) (err error)
type OriginTLSClientAuthGetResponseEnvelope ¶
type OriginTLSClientAuthGetResponseEnvelope struct {
Errors []OriginTLSClientAuthGetResponseEnvelopeErrors `json:"errors,required"`
Messages []OriginTLSClientAuthGetResponseEnvelopeMessages `json:"messages,required"`
// Whether the API call was successful.
Success OriginTLSClientAuthGetResponseEnvelopeSuccess `json:"success,required"`
Result OriginTLSClientAuthGetResponse `json:"result"`
JSON originTLSClientAuthGetResponseEnvelopeJSON `json:"-"`
}
func (*OriginTLSClientAuthGetResponseEnvelope) UnmarshalJSON ¶
func (r *OriginTLSClientAuthGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type OriginTLSClientAuthGetResponseEnvelopeErrors ¶ added in v4.3.0
type OriginTLSClientAuthGetResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source OriginTLSClientAuthGetResponseEnvelopeErrorsSource `json:"source"`
JSON originTLSClientAuthGetResponseEnvelopeErrorsJSON `json:"-"`
}
func (*OriginTLSClientAuthGetResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.3.0
func (r *OriginTLSClientAuthGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type OriginTLSClientAuthGetResponseEnvelopeErrorsSource ¶ added in v4.3.0
type OriginTLSClientAuthGetResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON originTLSClientAuthGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*OriginTLSClientAuthGetResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v4.3.0
func (r *OriginTLSClientAuthGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type OriginTLSClientAuthGetResponseEnvelopeMessages ¶ added in v4.3.0
type OriginTLSClientAuthGetResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source OriginTLSClientAuthGetResponseEnvelopeMessagesSource `json:"source"`
JSON originTLSClientAuthGetResponseEnvelopeMessagesJSON `json:"-"`
}
func (*OriginTLSClientAuthGetResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.3.0
func (r *OriginTLSClientAuthGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type OriginTLSClientAuthGetResponseEnvelopeMessagesSource ¶ added in v4.3.0
type OriginTLSClientAuthGetResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON originTLSClientAuthGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*OriginTLSClientAuthGetResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v4.3.0
func (r *OriginTLSClientAuthGetResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type OriginTLSClientAuthGetResponseEnvelopeSuccess ¶
type OriginTLSClientAuthGetResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
OriginTLSClientAuthGetResponseEnvelopeSuccessTrue OriginTLSClientAuthGetResponseEnvelopeSuccess = true
)
func (OriginTLSClientAuthGetResponseEnvelopeSuccess) IsKnown ¶
func (r OriginTLSClientAuthGetResponseEnvelopeSuccess) IsKnown() bool
type OriginTLSClientAuthListResponse ¶
type OriginTLSClientAuthListResponse struct {
// Identifier.
ID string `json:"id"`
// The zone's leaf certificate.
Certificate string `json:"certificate"`
// Indicates whether zone-level authenticated origin pulls is enabled.
Enabled bool `json:"enabled"`
// The zone's private key.
PrivateKey string `json:"private_key"`
JSON originTLSClientAuthListResponseJSON `json:"-"`
ZoneAuthenticatedOriginPull
}
func (*OriginTLSClientAuthListResponse) UnmarshalJSON ¶
func (r *OriginTLSClientAuthListResponse) UnmarshalJSON(data []byte) (err error)
type OriginTLSClientAuthNewParams ¶
type OriginTLSClientAuthNewParams struct {
// Identifier.
ZoneID param.Field[string] `path:"zone_id,required"`
// The zone's leaf certificate.
Certificate param.Field[string] `json:"certificate,required"`
// The zone's private key.
PrivateKey param.Field[string] `json:"private_key,required"`
}
func (OriginTLSClientAuthNewParams) MarshalJSON ¶
func (r OriginTLSClientAuthNewParams) MarshalJSON() (data []byte, err error)
type OriginTLSClientAuthNewResponse ¶
type OriginTLSClientAuthNewResponse struct {
// Identifier.
ID string `json:"id"`
// The zone's leaf certificate.
Certificate string `json:"certificate"`
// Indicates whether zone-level authenticated origin pulls is enabled.
Enabled bool `json:"enabled"`
// The zone's private key.
PrivateKey string `json:"private_key"`
JSON originTLSClientAuthNewResponseJSON `json:"-"`
ZoneAuthenticatedOriginPull
}
func (*OriginTLSClientAuthNewResponse) UnmarshalJSON ¶
func (r *OriginTLSClientAuthNewResponse) UnmarshalJSON(data []byte) (err error)
type OriginTLSClientAuthNewResponseEnvelope ¶
type OriginTLSClientAuthNewResponseEnvelope struct {
Errors []OriginTLSClientAuthNewResponseEnvelopeErrors `json:"errors,required"`
Messages []OriginTLSClientAuthNewResponseEnvelopeMessages `json:"messages,required"`
// Whether the API call was successful.
Success OriginTLSClientAuthNewResponseEnvelopeSuccess `json:"success,required"`
Result OriginTLSClientAuthNewResponse `json:"result"`
JSON originTLSClientAuthNewResponseEnvelopeJSON `json:"-"`
}
func (*OriginTLSClientAuthNewResponseEnvelope) UnmarshalJSON ¶
func (r *OriginTLSClientAuthNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type OriginTLSClientAuthNewResponseEnvelopeErrors ¶ added in v4.3.0
type OriginTLSClientAuthNewResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source OriginTLSClientAuthNewResponseEnvelopeErrorsSource `json:"source"`
JSON originTLSClientAuthNewResponseEnvelopeErrorsJSON `json:"-"`
}
func (*OriginTLSClientAuthNewResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.3.0
func (r *OriginTLSClientAuthNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type OriginTLSClientAuthNewResponseEnvelopeErrorsSource ¶ added in v4.3.0
type OriginTLSClientAuthNewResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON originTLSClientAuthNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*OriginTLSClientAuthNewResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v4.3.0
func (r *OriginTLSClientAuthNewResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type OriginTLSClientAuthNewResponseEnvelopeMessages ¶ added in v4.3.0
type OriginTLSClientAuthNewResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source OriginTLSClientAuthNewResponseEnvelopeMessagesSource `json:"source"`
JSON originTLSClientAuthNewResponseEnvelopeMessagesJSON `json:"-"`
}
func (*OriginTLSClientAuthNewResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.3.0
func (r *OriginTLSClientAuthNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type OriginTLSClientAuthNewResponseEnvelopeMessagesSource ¶ added in v4.3.0
type OriginTLSClientAuthNewResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON originTLSClientAuthNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*OriginTLSClientAuthNewResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v4.3.0
func (r *OriginTLSClientAuthNewResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type OriginTLSClientAuthNewResponseEnvelopeSuccess ¶
type OriginTLSClientAuthNewResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
OriginTLSClientAuthNewResponseEnvelopeSuccessTrue OriginTLSClientAuthNewResponseEnvelopeSuccess = true
)
func (OriginTLSClientAuthNewResponseEnvelopeSuccess) IsKnown ¶
func (r OriginTLSClientAuthNewResponseEnvelopeSuccess) IsKnown() bool
type OriginTLSClientAuthService ¶
type OriginTLSClientAuthService struct {
Options []option.RequestOption
Hostnames *HostnameService
Settings *SettingService
}
OriginTLSClientAuthService 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 NewOriginTLSClientAuthService method instead.
func NewOriginTLSClientAuthService ¶
func NewOriginTLSClientAuthService(opts ...option.RequestOption) (r *OriginTLSClientAuthService)
NewOriginTLSClientAuthService 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 (*OriginTLSClientAuthService) Delete ¶
func (r *OriginTLSClientAuthService) Delete(ctx context.Context, certificateID string, body OriginTLSClientAuthDeleteParams, opts ...option.RequestOption) (res *OriginTLSClientAuthDeleteResponse, err error)
Delete Certificate
func (*OriginTLSClientAuthService) Get ¶
func (r *OriginTLSClientAuthService) Get(ctx context.Context, certificateID string, query OriginTLSClientAuthGetParams, opts ...option.RequestOption) (res *OriginTLSClientAuthGetResponse, err error)
Get Certificate Details
func (*OriginTLSClientAuthService) List ¶
func (r *OriginTLSClientAuthService) List(ctx context.Context, query OriginTLSClientAuthListParams, opts ...option.RequestOption) (res *pagination.SinglePage[OriginTLSClientAuthListResponse], err error)
List Certificates
func (*OriginTLSClientAuthService) ListAutoPaging ¶
func (r *OriginTLSClientAuthService) ListAutoPaging(ctx context.Context, query OriginTLSClientAuthListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[OriginTLSClientAuthListResponse]
List Certificates
func (*OriginTLSClientAuthService) New ¶
func (r *OriginTLSClientAuthService) New(ctx context.Context, params OriginTLSClientAuthNewParams, opts ...option.RequestOption) (res *OriginTLSClientAuthNewResponse, err error)
Upload your own certificate you want Cloudflare to use for edge-to-origin communication to override the shared certificate. Please note that it is important to keep only one certificate active. Also, make sure to enable zone-level authenticated origin pulls by making a PUT call to settings endpoint to see the uploaded certificate in use.
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 ¶ added in v4.1.0
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 ¶ added in v4.3.0
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 SettingGetParams ¶
type SettingGetResponse ¶
type SettingGetResponse struct {
// Indicates whether zone-level authenticated origin pulls is enabled.
Enabled bool `json:"enabled"`
JSON settingGetResponseJSON `json:"-"`
}
func (*SettingGetResponse) UnmarshalJSON ¶
func (r *SettingGetResponse) UnmarshalJSON(data []byte) (err error)
type SettingGetResponseEnvelope ¶
type SettingGetResponseEnvelope struct {
Errors []SettingGetResponseEnvelopeErrors `json:"errors,required"`
Messages []SettingGetResponseEnvelopeMessages `json:"messages,required"`
// Whether the API call was successful.
Success SettingGetResponseEnvelopeSuccess `json:"success,required"`
Result SettingGetResponse `json:"result"`
JSON settingGetResponseEnvelopeJSON `json:"-"`
}
func (*SettingGetResponseEnvelope) UnmarshalJSON ¶
func (r *SettingGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type SettingGetResponseEnvelopeErrors ¶ added in v4.3.0
type SettingGetResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source SettingGetResponseEnvelopeErrorsSource `json:"source"`
JSON settingGetResponseEnvelopeErrorsJSON `json:"-"`
}
func (*SettingGetResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.3.0
func (r *SettingGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type SettingGetResponseEnvelopeErrorsSource ¶ added in v4.3.0
type SettingGetResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON settingGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*SettingGetResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v4.3.0
func (r *SettingGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type SettingGetResponseEnvelopeMessages ¶ added in v4.3.0
type SettingGetResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source SettingGetResponseEnvelopeMessagesSource `json:"source"`
JSON settingGetResponseEnvelopeMessagesJSON `json:"-"`
}
func (*SettingGetResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.3.0
func (r *SettingGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type SettingGetResponseEnvelopeMessagesSource ¶ added in v4.3.0
type SettingGetResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON settingGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*SettingGetResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v4.3.0
func (r *SettingGetResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type SettingGetResponseEnvelopeSuccess ¶
type SettingGetResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
SettingGetResponseEnvelopeSuccessTrue SettingGetResponseEnvelopeSuccess = true
)
func (SettingGetResponseEnvelopeSuccess) IsKnown ¶
func (r SettingGetResponseEnvelopeSuccess) IsKnown() bool
type SettingService ¶
type SettingService struct {
Options []option.RequestOption
}
SettingService 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 NewSettingService method instead.
func NewSettingService ¶
func NewSettingService(opts ...option.RequestOption) (r *SettingService)
NewSettingService 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 (*SettingService) Get ¶
func (r *SettingService) Get(ctx context.Context, query SettingGetParams, opts ...option.RequestOption) (res *SettingGetResponse, err error)
Get whether zone-level authenticated origin pulls is enabled or not. It is false by default.
func (*SettingService) Update ¶
func (r *SettingService) Update(ctx context.Context, params SettingUpdateParams, opts ...option.RequestOption) (res *SettingUpdateResponse, err error)
Enable or disable zone-level authenticated origin pulls. 'enabled' should be set true either before/after the certificate is uploaded to see the certificate in use.
type SettingUpdateParams ¶
type SettingUpdateParams struct {
// Identifier.
ZoneID param.Field[string] `path:"zone_id,required"`
// Indicates whether zone-level authenticated origin pulls is enabled.
Enabled param.Field[bool] `json:"enabled,required"`
}
func (SettingUpdateParams) MarshalJSON ¶
func (r SettingUpdateParams) MarshalJSON() (data []byte, err error)
type SettingUpdateResponse ¶
type SettingUpdateResponse struct {
// Indicates whether zone-level authenticated origin pulls is enabled.
Enabled bool `json:"enabled"`
JSON settingUpdateResponseJSON `json:"-"`
}
func (*SettingUpdateResponse) UnmarshalJSON ¶
func (r *SettingUpdateResponse) UnmarshalJSON(data []byte) (err error)
type SettingUpdateResponseEnvelope ¶
type SettingUpdateResponseEnvelope struct {
Errors []SettingUpdateResponseEnvelopeErrors `json:"errors,required"`
Messages []SettingUpdateResponseEnvelopeMessages `json:"messages,required"`
// Whether the API call was successful.
Success SettingUpdateResponseEnvelopeSuccess `json:"success,required"`
Result SettingUpdateResponse `json:"result"`
JSON settingUpdateResponseEnvelopeJSON `json:"-"`
}
func (*SettingUpdateResponseEnvelope) UnmarshalJSON ¶
func (r *SettingUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type SettingUpdateResponseEnvelopeErrors ¶ added in v4.3.0
type SettingUpdateResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source SettingUpdateResponseEnvelopeErrorsSource `json:"source"`
JSON settingUpdateResponseEnvelopeErrorsJSON `json:"-"`
}
func (*SettingUpdateResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.3.0
func (r *SettingUpdateResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type SettingUpdateResponseEnvelopeErrorsSource ¶ added in v4.3.0
type SettingUpdateResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON settingUpdateResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*SettingUpdateResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v4.3.0
func (r *SettingUpdateResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type SettingUpdateResponseEnvelopeMessages ¶ added in v4.3.0
type SettingUpdateResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source SettingUpdateResponseEnvelopeMessagesSource `json:"source"`
JSON settingUpdateResponseEnvelopeMessagesJSON `json:"-"`
}
func (*SettingUpdateResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.3.0
func (r *SettingUpdateResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type SettingUpdateResponseEnvelopeMessagesSource ¶ added in v4.3.0
type SettingUpdateResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON settingUpdateResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*SettingUpdateResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v4.3.0
func (r *SettingUpdateResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type SettingUpdateResponseEnvelopeSuccess ¶
type SettingUpdateResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
SettingUpdateResponseEnvelopeSuccessTrue SettingUpdateResponseEnvelopeSuccess = true
)
func (SettingUpdateResponseEnvelopeSuccess) IsKnown ¶
func (r SettingUpdateResponseEnvelopeSuccess) IsKnown() bool
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 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 ZoneAuthenticatedOriginPull ¶
type ZoneAuthenticatedOriginPull struct {
// Identifier.
ID string `json:"id"`
// The zone's leaf certificate.
Certificate string `json:"certificate"`
// When the certificate from the authority expires.
ExpiresOn time.Time `json:"expires_on" format:"date-time"`
// The certificate authority that issued the certificate.
Issuer string `json:"issuer"`
// The type of hash used for the certificate.
Signature string `json:"signature"`
// Status of the certificate activation.
Status ZoneAuthenticatedOriginPullStatus `json:"status"`
// This is the time the certificate was uploaded.
UploadedOn time.Time `json:"uploaded_on" format:"date-time"`
JSON zoneAuthenticatedOriginPullJSON `json:"-"`
}
func (*ZoneAuthenticatedOriginPull) UnmarshalJSON ¶
func (r *ZoneAuthenticatedOriginPull) UnmarshalJSON(data []byte) (err error)
type ZoneAuthenticatedOriginPullStatus ¶
type ZoneAuthenticatedOriginPullStatus string
Status of the certificate activation.
const ( ZoneAuthenticatedOriginPullStatusInitializing ZoneAuthenticatedOriginPullStatus = "initializing" ZoneAuthenticatedOriginPullStatusPendingDeployment ZoneAuthenticatedOriginPullStatus = "pending_deployment" ZoneAuthenticatedOriginPullStatusPendingDeletion ZoneAuthenticatedOriginPullStatus = "pending_deletion" ZoneAuthenticatedOriginPullStatusActive ZoneAuthenticatedOriginPullStatus = "active" ZoneAuthenticatedOriginPullStatusDeleted ZoneAuthenticatedOriginPullStatus = "deleted" ZoneAuthenticatedOriginPullStatusDeploymentTimedOut ZoneAuthenticatedOriginPullStatus = "deployment_timed_out" ZoneAuthenticatedOriginPullStatusDeletionTimedOut ZoneAuthenticatedOriginPullStatus = "deletion_timed_out" )
func (ZoneAuthenticatedOriginPullStatus) IsKnown ¶
func (r ZoneAuthenticatedOriginPullStatus) IsKnown() bool