SSL

SSLAnalyze

Analyze Certificate

client.SSL.Analyze.New(ctx, params) (*AnalyzeNewResponse, error)

POST/zones/{zone_id}/ssl/analyze

SSLCertificate Packs

List Certificate Packs

client.SSL.CertificatePacks.List(ctx, params) (*V4PagePaginationArray[CertificatePackListResponse], error)

GET/zones/{zone_id}/ssl/certificate_packs

Get Certificate Pack

client.SSL.CertificatePacks.Get(ctx, certificatePackID, query) (*CertificatePackGetResponse, error)

GET/zones/{zone_id}/ssl/certificate_packs/{certificate_pack_id}

Order Advanced Certificate Manager Certificate Pack

client.SSL.CertificatePacks.New(ctx, params) (*CertificatePackNewResponse, error)

POST/zones/{zone_id}/ssl/certificate_packs/order

Restart Validation or Update Advanced Certificate Manager Certificate Pack

client.SSL.CertificatePacks.Edit(ctx, certificatePackID, params) (*CertificatePackEditResponse, error)

PATCH/zones/{zone_id}/ssl/certificate_packs/{certificate_pack_id}

Delete Advanced Certificate Manager Certificate Pack

client.SSL.CertificatePacks.Delete(ctx, certificatePackID, body) (*CertificatePackDeleteResponse, error)

DELETE/zones/{zone_id}/ssl/certificate_packs/{certificate_pack_id}

ModelsExpand Collapse

type Host string

type RequestValidity float64

The number of days for which the certificate should be valid.

One of the following:

const RequestValidity7 RequestValidity = 7

const RequestValidity30 RequestValidity = 30

const RequestValidity90 RequestValidity = 90

const RequestValidity365 RequestValidity = 365

const RequestValidity730 RequestValidity = 730

const RequestValidity1095 RequestValidity = 1095

const RequestValidity5475 RequestValidity = 5475

type Status string

Status of certificate pack.

One of the following:

const StatusInitializing Status = "initializing"

const StatusPendingValidation Status = "pending_validation"

const StatusDeleted Status = "deleted"

const StatusPendingIssuance Status = "pending_issuance"

const StatusPendingDeployment Status = "pending_deployment"

const StatusPendingDeletion Status = "pending_deletion"

const StatusPendingExpiration Status = "pending_expiration"

const StatusExpired Status = "expired"

const StatusActive Status = "active"

const StatusInitializingTimedOut Status = "initializing_timed_out"

const StatusValidationTimedOut Status = "validation_timed_out"

const StatusIssuanceTimedOut Status = "issuance_timed_out"

const StatusDeploymentTimedOut Status = "deployment_timed_out"

const StatusDeletionTimedOut Status = "deletion_timed_out"

const StatusPendingCleanup Status = "pending_cleanup"

const StatusStagingDeployment Status = "staging_deployment"

const StatusStagingActive Status = "staging_active"

const StatusDeactivating Status = "deactivating"

const StatusInactive Status = "inactive"

const StatusBackupIssued Status = "backup_issued"

const StatusHoldingDeployment Status = "holding_deployment"

type ValidationMethod string

Validation method in use for a certificate pack order.

One of the following:

const ValidationMethodHTTP ValidationMethod = "http"

const ValidationMethodCNAME ValidationMethod = "cname"

const ValidationMethodTXT ValidationMethod = "txt"

SSLCertificate PacksQuota

Get Certificate Pack Quotas

client.SSL.CertificatePacks.Quota.Get(ctx, query) (*CertificatePackQuotaGetResponse, error)

GET/zones/{zone_id}/ssl/certificate_packs/quota

SSLRecommendations

SSL/TLS Recommendation

Deprecated

client.SSL.Recommendations.Get(ctx, query) (*RecommendationGetResponse, error)

GET/zones/{zone_id}/ssl/recommendation

SSLAutomatic Upgrader

SSLUniversal

SSLUniversalSettings

Universal SSL Settings Details

client.SSL.Universal.Settings.Get(ctx, query) (*UniversalSSLSettings, error)

GET/zones/{zone_id}/ssl/universal/settings

Edit Universal SSL Settings

client.SSL.Universal.Settings.Edit(ctx, params) (*UniversalSSLSettings, error)

PATCH/zones/{zone_id}/ssl/universal/settings

ModelsExpand Collapse

type UniversalSSLSettings struct{…}

Enabled booloptional

Disabling Universal SSL removes any currently active Universal SSL certificates for your zone from the edge and prevents any future Universal SSL certificates from being ordered. If there are no advanced certificates or custom certificates uploaded for the domain, visitors will be unable to access the domain over HTTPS.

By disabling Universal SSL, you understand that the following Cloudflare settings and preferences will result in visitors being unable to visit your domain unless you have uploaded a custom certificate or purchased an advanced certificate.

HSTS
Always Use HTTPS
Opportunistic Encryption
Onion Routing
Any Page Rules redirecting traffic to HTTPS

Similarly, any HTTP redirect to HTTPS at the origin while the Cloudflare proxy is enabled will result in users being unable to visit your site without a valid certificate at Cloudflare's edge.

If you do not have a valid custom or advanced certificate at Cloudflare's edge and are unsure if any of the above Cloudflare settings are enabled, or if any HTTP redirects exist at your origin, we advise leaving Universal SSL enabled for your domain.

SSLVerification

SSL Verification Details

client.SSL.Verification.Get(ctx, params) (*[]Verification, error)

GET/zones/{zone_id}/ssl/verification

Edit SSL Certificate Pack Validation Method

client.SSL.Verification.Edit(ctx, certificatePackID, params) (*VerificationEditResponse, error)

PATCH/zones/{zone_id}/ssl/verification/{certificate_pack_id}

ModelsExpand Collapse

type Verification struct{…}

CertificateStatus VerificationCertificateStatus

Current status of certificate.

One of the following:

const VerificationCertificateStatusInitializing VerificationCertificateStatus = "initializing"

const VerificationCertificateStatusAuthorizing VerificationCertificateStatus = "authorizing"

const VerificationCertificateStatusActive VerificationCertificateStatus = "active"

const VerificationCertificateStatusExpired VerificationCertificateStatus = "expired"

const VerificationCertificateStatusIssuing VerificationCertificateStatus = "issuing"

const VerificationCertificateStatusTimingOut VerificationCertificateStatus = "timing_out"

const VerificationCertificateStatusPendingDeployment VerificationCertificateStatus = "pending_deployment"

BrandCheck booloptional

Certificate Authority is manually reviewing the order.

CERTPackUUID stringoptional

Certificate Pack UUID.

Signature VerificationSignatureoptional

Certificate's signature algorithm.

One of the following:

const VerificationSignatureEcdsaWithSha256 VerificationSignature = "ECDSAWithSHA256"

const VerificationSignatureSha1WithRSA VerificationSignature = "SHA1WithRSA"

const VerificationSignatureSha256WithRSA VerificationSignature = "SHA256WithRSA"

ValidationMethod ValidationMethodoptional

Validation method in use for a certificate pack order.

VerificationInfo VerificationVerificationInfooptional

Certificate's required verification information.

RecordName VerificationVerificationInfoRecordNameoptional

Name of CNAME record.

formathostname

One of the following:

const VerificationVerificationInfoRecordNameRecordName VerificationVerificationInfoRecordName = "record_name"

const VerificationVerificationInfoRecordNameHTTPURL VerificationVerificationInfoRecordName = "http_url"

const VerificationVerificationInfoRecordNameCNAME VerificationVerificationInfoRecordName = "cname"

const VerificationVerificationInfoRecordNameTXTName VerificationVerificationInfoRecordName = "txt_name"

RecordTarget VerificationVerificationInfoRecordTargetoptional

Target of CNAME record.

formathostname

One of the following:

const VerificationVerificationInfoRecordTargetRecordValue VerificationVerificationInfoRecordTarget = "record_value"

const VerificationVerificationInfoRecordTargetHTTPBody VerificationVerificationInfoRecordTarget = "http_body"

const VerificationVerificationInfoRecordTargetCNAMETarget VerificationVerificationInfoRecordTarget = "cname_target"

const VerificationVerificationInfoRecordTargetTXTValue VerificationVerificationInfoRecordTarget = "txt_value"

VerificationStatus booloptional

Status of the required verification information, omitted if verification status is unknown.

VerificationType VerificationVerificationTypeoptional

Method of verification.

One of the following:

const VerificationVerificationTypeCNAME VerificationVerificationType = "cname"

const VerificationVerificationTypeMetaTag VerificationVerificationType = "meta tag"