--- title: Edit SSL Configuration --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) [Custom Certificates](https://developers.cloudflare.com/api/go/resources/custom_certificates) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Edit SSL Configuration client.CustomCertificates.Edit(ctx, customCertificateID, params) (\*[CustomCertificate](), error) PATCH/zones/{zone\_id}/custom\_certificates/{custom\_certificate\_id} Upload a new private key and/or PEM/CRT for the SSL certificate. Note: PATCHing a configuration for sni\_custom certificates will result in a new resource id being returned, and the previous one being deleted. ##### Security
API Token The preferred authorization scheme for interacting with the Cloudflare API. Create a token. **Example:**Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
API Email + API Key The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key. **Example:**X-Auth-Email: user@example.com The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys. **Example:**X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
##### Accepted Permissions (at least one required) `Access: Mutual TLS Certificates Write``SSL and Certificates Write` ##### ParametersExpand Collapse customCertificateID string Custom certificate identifier tag. maxLength36 [Link to this property](<#(resource)%20custom_certificates%20%3E%20(method)%20edit%20%3E%20(params)%20default%20%3E%20(param)%20custom_certificate_id%20%3E%20(schema)>)
params CustomCertificateEditParams ZoneID param.Field\[string] Path param: Identifier. maxLength32 Link to this property BundleMethod param.Field\[BundleMethod]Optional Body param: A ubiquitous bundle has the highest probability of being verified everywhere, even by clients using outdated or unusual trust stores. An optimal bundle uses the shortest chain and newest intermediates. And the force bundle verifies the chain, but does not otherwise modify it. Link to this property Certificate param.Field\[string]Optional Body param: The zone’s SSL certificate or certificate and the intermediate(s). Link to this property CustomCsrID param.Field\[string]Optional Body param: The identifier for the Custom CSR that was used. Link to this property
Deploy param.Field\[CustomCertificateEditParamsDeploy]Optional Body param: The environment to deploy the certificate to, defaults to production. const CustomCertificateEditParamsDeployStaging CustomCertificateEditParamsDeploy = "staging" Link to this property const CustomCertificateEditParamsDeployProduction CustomCertificateEditParamsDeploy = "production" Link to this property
Link to this property GeoRestrictions param.Field\[GeoRestrictions]Optional Body param: Specify the region where your private key can be held locally for optimal TLS performance. HTTPS connections to any excluded data center will still be fully encrypted, but will incur some latency while Keyless SSL is used to complete the handshake with the nearest allowed data center. Options allow distribution to only to U.S. data centers, only to E.U. data centers, or only to highest security data centers. Default distribution is to all Cloudflare datacenters, for optimal performance. Link to this property Policy param.Field\[string]Optional Body param: Specify the policy that determines the region where your private key will be held locally. HTTPS connections to any excluded data center will still be fully encrypted, but will incur some latency while Keyless SSL is used to complete the handshake with the nearest allowed data center. Any combination of countries, specified by their two letter country code (https://en.wikipedia.org/wiki/ISO\_3166-1\_alpha-2#Officially\_assigned\_code\_elements) can be chosen, such as ‘country: IN’, as well as ‘region: EU’ which refers to the EU region. If there are too few data centers satisfying the policy, it will be rejected. Note: The API accepts this field as either “policy” or “policy\_restrictions” in requests. Responses return this field as “policy\_restrictions”. Link to this property PrivateKey param.Field\[string]Optional Body param: The zone’s private key. Not required if custom\_csr\_id is provided, in which case the private key is retrieved from the CSR record held by Cloudflare. Link to this property
[Link to this property](<#(resource)%20custom_certificates%20%3E%20(method)%20edit%20%3E%20(params)%20default>) ##### ReturnsExpand Collapse
type CustomCertificate struct{…} ID string Custom certificate identifier tag. maxLength36 Link to this property ZoneID string Identifier. maxLength32 Link to this property
BundleMethod BundleMethodOptional A ubiquitous bundle has the highest probability of being verified everywhere, even by clients using outdated or unusual trust stores. An optimal bundle uses the shortest chain and newest intermediates. And the force bundle verifies the chain, but does not otherwise modify it. One of the following: const BundleMethodUbiquitous BundleMethod = "ubiquitous" Link to this property const BundleMethodOptimal BundleMethod = "optimal" Link to this property const BundleMethodForce BundleMethod = "force" Link to this property
Link to this property CustomCsrID stringOptional The identifier for the Custom CSR that was used. Link to this property ExpiresOn TimeOptional When the certificate from the authority expires. formatdate-time Link to this property
GeoRestrictions GeoRestrictionsOptional Specify the region where your private key can be held locally for optimal TLS performance. HTTPS connections to any excluded data center will still be fully encrypted, but will incur some latency while Keyless SSL is used to complete the handshake with the nearest allowed data center. Options allow distribution to only to U.S. data centers, only to E.U. data centers, or only to highest security data centers. Default distribution is to all Cloudflare datacenters, for optimal performance.
Label GeoRestrictionsLabelOptional One of the following: const GeoRestrictionsLabelUs GeoRestrictionsLabel = "us" Link to this property const GeoRestrictionsLabelEu GeoRestrictionsLabel = "eu" Link to this property const GeoRestrictionsLabelHighestSecurity GeoRestrictionsLabel = "highest\_security" Link to this property
Link to this property
Link to this property Hosts \[]stringOptional Link to this property Issuer stringOptional The certificate authority that issued the certificate. Link to this property
KeylessServer KeylessCertificateOptional ID string Keyless certificate identifier tag. maxLength32 Link to this property CreatedOn Time When the Keyless SSL was created. formatdate-time Link to this property Enabled bool Whether or not the Keyless SSL is on or off. Link to this property Host string The keyless SSL name. formathostname maxLength253 Link to this property ModifiedOn Time When the Keyless SSL was last modified. formatdate-time Link to this property Name string The keyless SSL name. maxLength180 Link to this property Permissions \[]string Available permissions for the Keyless SSL for the current user requesting the item. Link to this property Port float64 The keyless SSL port used to communicate between Cloudflare and the client’s Keyless SSL server. maxLength65535 Link to this property
Status KeylessCertificateStatus Status of the Keyless SSL. One of the following: const KeylessCertificateStatusActive KeylessCertificateStatus = "active" Link to this property const KeylessCertificateStatusDeleted KeylessCertificateStatus = "deleted" Link to this property
Link to this property
Tunnel TunnelOptional Configuration for using Keyless SSL through a Cloudflare Tunnel. PrivateIP string Private IP of the Key Server Host. Link to this property VnetID string Cloudflare Tunnel Virtual Network ID. Link to this property
Link to this property
Link to this property ModifiedOn TimeOptional When the certificate was last modified. formatdate-time Link to this property PolicyRestrictions stringOptional The policy restrictions returned by the API. This field is returned in responses when a policy has been set. The API accepts the “policy” field in requests but returns this field as “policy\_restrictions” in responses. Specifies the region(s) where your private key can be held locally for optimal TLS performance. Format is a boolean expression, for example: “(country: US) or (region: EU)” Link to this property Priority float64Optional The order/priority in which the certificate will be used in a request. The higher priority will break ties across overlapping ‘legacy\_custom’ certificates, but ‘legacy\_custom’ certificates will always supercede ‘sni\_custom’ certificates. Link to this property Signature stringOptional The type of hash used for the certificate. Link to this property
Status CustomCertificateStatusOptional Status of the zone’s custom SSL. One of the following: const CustomCertificateStatusActive CustomCertificateStatus = "active" Link to this property const CustomCertificateStatusExpired CustomCertificateStatus = "expired" Link to this property const CustomCertificateStatusDeleted CustomCertificateStatus = "deleted" Link to this property const CustomCertificateStatusPending CustomCertificateStatus = "pending" Link to this property const CustomCertificateStatusInitializing CustomCertificateStatus = "initializing" Link to this property
Link to this property UploadedOn TimeOptional When the certificate was uploaded to Cloudflare. formatdate-time Link to this property
[Link to this property](<#(resource)%20custom_certificates%20%3E%20(model)%20custom_certificate%20%3E%20(schema)>) ### Edit SSL Configuration Go HTTPTypeScriptPythonGoTerraform ``` package main import ( "context" "fmt" "github.com/cloudflare/cloudflare-go" "github.com/cloudflare/cloudflare-go/custom_certificates" "github.com/cloudflare/cloudflare-go/option" ) func main() { client := cloudflare.NewClient( option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"), ) customCertificate, err := client.CustomCertificates.Edit( context.TODO(), "2458ce5a-0c35-4c7f-82c7-8e9487d3ff60", custom_certificates.CustomCertificateEditParams{ ZoneID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"), }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", customCertificate.ID) } ``` 200 example ``` { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "success": true, "result": { "id": "2458ce5a-0c35-4c7f-82c7-8e9487d3ff60", "zone_id": "023e105f4ecef8ad9ca31a8372d0c353", "bundle_method": "ubiquitous", "custom_csr_id": "7b163417-1d2b-4c84-a38a-2fb7a0cd7752", "expires_on": "2016-01-01T05:20:00Z", "geo_restrictions": { "label": "us" }, "hosts": [ "example.com" ], "issuer": "GlobalSign", "keyless_server": { "id": "4d2844d2ce78891c34d0b6c0535a291e", "created_on": "2014-01-01T05:20:00Z", "enabled": false, "host": "example.com", "modified_on": "2014-01-01T05:20:00Z", "name": "example.com Keyless SSL", "permissions": [ "#ssl:read", "#ssl:edit" ], "port": 24008, "status": "active", "tunnel": { "private_ip": "10.0.0.1", "vnet_id": "7365377a-85a4-4390-9480-531ef7dc7a3c" } }, "modified_on": "2014-01-01T05:20:00Z", "policy_restrictions": "(country: US) or (region: EU)", "priority": 1, "signature": "SHA256WithRSA", "status": "active", "uploaded_on": "2014-01-01T05:20:00Z" } } ``` ##### Returns Examples 200 example ``` { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "success": true, "result": { "id": "2458ce5a-0c35-4c7f-82c7-8e9487d3ff60", "zone_id": "023e105f4ecef8ad9ca31a8372d0c353", "bundle_method": "ubiquitous", "custom_csr_id": "7b163417-1d2b-4c84-a38a-2fb7a0cd7752", "expires_on": "2016-01-01T05:20:00Z", "geo_restrictions": { "label": "us" }, "hosts": [ "example.com" ], "issuer": "GlobalSign", "keyless_server": { "id": "4d2844d2ce78891c34d0b6c0535a291e", "created_on": "2014-01-01T05:20:00Z", "enabled": false, "host": "example.com", "modified_on": "2014-01-01T05:20:00Z", "name": "example.com Keyless SSL", "permissions": [ "#ssl:read", "#ssl:edit" ], "port": 24008, "status": "active", "tunnel": { "private_ip": "10.0.0.1", "vnet_id": "7365377a-85a4-4390-9480-531ef7dc7a3c" } }, "modified_on": "2014-01-01T05:20:00Z", "policy_restrictions": "(country: US) or (region: EU)", "priority": 1, "signature": "SHA256WithRSA", "status": "active", "uploaded_on": "2014-01-01T05:20:00Z" } } ```