certificate_authorities

type ASN ¶ added in v2.1.0

type ASN = shared.ASN

This is an alias to an internal type.

type ASNParam ¶ added in v2.1.0

type ASNParam = shared.ASNParam

This is an alias to an internal type.

type AuditLog ¶

type AuditLog = shared.AuditLog

This is an alias to an internal type.

type AuditLogAction ¶

type AuditLogAction = shared.AuditLogAction

This is an alias to an internal type.

type AuditLogActor ¶

type AuditLogActor = shared.AuditLogActor

This is an alias to an internal type.

type AuditLogActorType ¶

type AuditLogActorType = shared.AuditLogActorType

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

This is an alias to an internal type.

type AuditLogOwner ¶

type AuditLogOwner = shared.AuditLogOwner

This is an alias to an internal type.

type AuditLogResource ¶

type AuditLogResource = shared.AuditLogResource

This is an alias to an internal type.

type CertificateAuthorityService ¶

type CertificateAuthorityService struct {
	Options              []option.RequestOption
	HostnameAssociations *HostnameAssociationService
}

CertificateAuthorityService 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 NewCertificateAuthorityService method instead.

func NewCertificateAuthorityService(opts ...option.RequestOption) (r *CertificateAuthorityService)

type CertificateCA ¶ added in v2.2.0

type CertificateCA = shared.CertificateCA

The Certificate Authority that will issue the certificate

This is an alias to an internal type.

type CertificateRequestType ¶ added in v2.2.0

type CertificateRequestType = shared.CertificateRequestType

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

This is an alias to an internal type.

type 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 CloudflareTunnelTunType ¶

type CloudflareTunnelTunType = shared.CloudflareTunnelTunType

The type of tunnel.

This is an alias to an internal type.

type Error ¶

type Error = apierror.Error

type ErrorData ¶

type ErrorData = shared.ErrorData

This is an alias to an internal type.

type HostnameAssociation ¶

type HostnameAssociation = string

type HostnameAssociationGetParams ¶

type HostnameAssociationGetParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// The UUID to match against for a certificate that was uploaded to the mTLS
	// Certificate Management endpoint. If no mtls_certificate_id is given, the results
	// will be the hostnames associated to your active Cloudflare Managed CA.
	MTLSCertificateID param.Field[string] `query:"mtls_certificate_id"`
}

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

type HostnameAssociationGetResponse ¶

type HostnameAssociationGetResponse struct {
	Hostnames []HostnameAssociation              `json:"hostnames"`
	JSON      hostnameAssociationGetResponseJSON `json:"-"`
}

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

type HostnameAssociationGetResponseEnvelope ¶

type HostnameAssociationGetResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful
	Success HostnameAssociationGetResponseEnvelopeSuccess `json:"success,required"`
	Result  HostnameAssociationGetResponse                `json:"result"`
	JSON    hostnameAssociationGetResponseEnvelopeJSON    `json:"-"`
}

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

type HostnameAssociationGetResponseEnvelopeSuccess ¶

type HostnameAssociationGetResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	HostnameAssociationGetResponseEnvelopeSuccessTrue HostnameAssociationGetResponseEnvelopeSuccess = true
)

func (r HostnameAssociationGetResponseEnvelopeSuccess) IsKnown() bool

type HostnameAssociationParam ¶

type HostnameAssociationParam = string

type HostnameAssociationService ¶

type HostnameAssociationService struct {
	Options []option.RequestOption
}

HostnameAssociationService 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 NewHostnameAssociationService method instead.

func NewHostnameAssociationService(opts ...option.RequestOption) (r *HostnameAssociationService)

func (r *HostnameAssociationService) Get(ctx context.Context, params HostnameAssociationGetParams, opts ...option.RequestOption) (res *HostnameAssociationGetResponse, err error)

func (r *HostnameAssociationService) Update(ctx context.Context, params HostnameAssociationUpdateParams, opts ...option.RequestOption) (res *HostnameAssociationUpdateResponse, err error)

type HostnameAssociationUpdateParams ¶

type HostnameAssociationUpdateParams struct {
	// Identifier
	ZoneID                 param.Field[string]         `path:"zone_id,required"`
	TLSHostnameAssociation TLSHostnameAssociationParam `json:"tls_hostname_association,required"`
}

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

type HostnameAssociationUpdateResponse ¶

type HostnameAssociationUpdateResponse struct {
	Hostnames []HostnameAssociation                 `json:"hostnames"`
	JSON      hostnameAssociationUpdateResponseJSON `json:"-"`
}

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

type HostnameAssociationUpdateResponseEnvelope ¶

type HostnameAssociationUpdateResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful
	Success HostnameAssociationUpdateResponseEnvelopeSuccess `json:"success,required"`
	Result  HostnameAssociationUpdateResponse                `json:"result"`
	JSON    hostnameAssociationUpdateResponseEnvelopeJSON    `json:"-"`
}

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

type HostnameAssociationUpdateResponseEnvelopeSuccess ¶

type HostnameAssociationUpdateResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	HostnameAssociationUpdateResponseEnvelopeSuccessTrue HostnameAssociationUpdateResponseEnvelopeSuccess = true
)

func (r HostnameAssociationUpdateResponseEnvelopeSuccess) IsKnown() bool

type Member ¶ added in v2.1.0

type Member = shared.Member

This is an alias to an internal type.

type MemberParam ¶ added in v2.1.0

type MemberParam = shared.MemberParam

This is an alias to an internal type.

type MemberRole ¶ added in v2.1.0

type MemberRole = shared.MemberRole

This is an alias to an internal type.

type MemberRoleParam ¶ added in v2.1.0

type MemberRoleParam = shared.MemberRoleParam

This is an alias to an internal type.

type MemberRolesPermissions ¶ added in v2.1.0

type MemberRolesPermissions = shared.MemberRolesPermissions

This is an alias to an internal type.

type MemberRolesPermissionsParam ¶ added in v2.1.0

type MemberRolesPermissionsParam = shared.MemberRolesPermissionsParam

This is an alias to an internal type.

type MemberUser ¶ added in v2.1.0

type MemberUser = shared.MemberUser

This is an alias to an internal type.

type MemberUserParam ¶ added in v2.1.0

type MemberUserParam = shared.MemberUserParam

This is an alias to an internal type.

type Permission ¶

type Permission = shared.Permission

This is an alias to an internal type.

type PermissionGrant ¶

type PermissionGrant = shared.PermissionGrant

This is an alias to an internal type.

type PermissionGrantParam ¶

type PermissionGrantParam = shared.PermissionGrantParam

This is an alias to an internal type.

type ResponseInfo ¶

type ResponseInfo = shared.ResponseInfo

This is an alias to an internal type.

type Role ¶

type Role = shared.Role

This is an alias to an internal type.

type SortDirection ¶ added in v2.2.0

type SortDirection = shared.SortDirection

Direction to order DNS records in.

This is an alias to an internal type.

type TLSHostnameAssociationParam ¶

type TLSHostnameAssociationParam struct {
	Hostnames param.Field[[]HostnameAssociationParam] `json:"hostnames"`
	// The UUID for a certificate that was uploaded to the mTLS Certificate Management
	// endpoint. If no mtls_certificate_id is given, the hostnames will be associated
	// to your active Cloudflare Managed CA.
	MTLSCertificateID param.Field[string] `json:"mtls_certificate_id"`
}

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