## Edit SSL Configuration `custom_certificates.edit(strcustom_certificate_id, CustomCertificateEditParams**kwargs) -> CustomCertificate` **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. ### Parameters - `zone_id: str` Identifier. - `custom_certificate_id: str` Identifier. - `bundle_method: Optional[BundleMethod]` 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. - `"ubiquitous"` - `"optimal"` - `"force"` - `certificate: Optional[str]` The zone's SSL certificate or certificate and the intermediate(s). - `custom_csr_id: Optional[str]` The identifier for the Custom CSR that was used. - `deploy: Optional[Literal["staging", "production"]]` The environment to deploy the certificate to, defaults to production - `"staging"` - `"production"` - `geo_restrictions: Optional[GeoRestrictionsParam]` 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: Optional[Literal["us", "eu", "highest_security"]]` - `"us"` - `"eu"` - `"highest_security"` - `policy: Optional[str]` 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". - `private_key: Optional[str]` The zone's private key. ### Returns - `class CustomCertificate: …` - `id: str` Identifier. - `zone_id: str` Identifier. - `bundle_method: Optional[BundleMethod]` 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. - `"ubiquitous"` - `"optimal"` - `"force"` - `custom_csr_id: Optional[str]` The identifier for the Custom CSR that was used. - `expires_on: Optional[datetime]` When the certificate from the authority expires. - `geo_restrictions: Optional[GeoRestrictions]` 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: Optional[Literal["us", "eu", "highest_security"]]` - `"us"` - `"eu"` - `"highest_security"` - `hosts: Optional[List[str]]` - `issuer: Optional[str]` The certificate authority that issued the certificate. - `keyless_server: Optional[KeylessCertificate]` - `id: str` Keyless certificate identifier tag. - `created_on: datetime` When the Keyless SSL was created. - `enabled: bool` Whether or not the Keyless SSL is on or off. - `host: str` The keyless SSL name. - `modified_on: datetime` When the Keyless SSL was last modified. - `name: str` The keyless SSL name. - `permissions: List[str]` Available permissions for the Keyless SSL for the current user requesting the item. - `port: float` The keyless SSL port used to communicate between Cloudflare and the client's Keyless SSL server. - `status: Literal["active", "deleted"]` Status of the Keyless SSL. - `"active"` - `"deleted"` - `tunnel: Optional[Tunnel]` Configuration for using Keyless SSL through a Cloudflare Tunnel - `private_ip: str` Private IP of the Key Server Host - `vnet_id: str` Cloudflare Tunnel Virtual Network ID - `modified_on: Optional[datetime]` When the certificate was last modified. - `policy_restrictions: Optional[str]` 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)" - `priority: Optional[float]` 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. - `signature: Optional[str]` The type of hash used for the certificate. - `status: Optional[Literal["active", "expired", "deleted", 2 more]]` Status of the zone's custom SSL. - `"active"` - `"expired"` - `"deleted"` - `"pending"` - `"initializing"` - `uploaded_on: Optional[datetime]` When the certificate was uploaded to Cloudflare. ### Example ```python import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) custom_certificate = client.custom_certificates.edit( custom_certificate_id="023e105f4ecef8ad9ca31a8372d0c353", zone_id="023e105f4ecef8ad9ca31a8372d0c353", ) print(custom_certificate.id) ``` #### Response ```json { "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": "023e105f4ecef8ad9ca31a8372d0c353", "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" } } ```