Skip to main content

certificates

Creates, updates, deletes, gets or lists a certificates resource.

Overview​

Namecertificates
TypeResource
Idoci.load_balancer.certificates

Fields​

The following fields are returned by SELECT queries:

The configuration details of a certificate bundle.<br />For more information on SSL certficate configuration, see<br />[Managing SSL Certificates](/Content/Balance/Tasks/managingcertificates.htm).<br /><br />Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.<br />

NameDatatypeDescription
caCertificatestringThe Certificate Authority certificate, or any interim certificate, that you received from your SSL certificate provider. Example: -----BEGIN CERTIFICATE----- MIIEczCCA1ugAwIBAgIBADANBgkqhkiG9w0BAQQFAD..AkGA1UEBhMCR0Ix EzARBgNVBAgTClNvbWUtU3RhdGUxFDASBgNVBAoTC0..0EgTHRkMTcwNQYD VQQLEy5DbGFzcyAxIFB1YmxpYyBQcmltYXJ5IENlcn..XRpb24gQXV0aG9y aXR5MRQwEgYDVQQDEwtCZXN0IENBIEx0ZDAeFw0wMD..TUwMTZaFw0wMTAy ... -----END CERTIFICATE-----
certificateNamestringA friendly name for the certificate bundle. It must be unique and it cannot be changed. Valid certificate bundle names include only alphanumeric characters, dashes, and underscores. Certificate bundle names cannot contain spaces. Avoid entering confidential information. Example: example_certificate_bundle (pattern: <code>^[a-zA-Z0-9_.-]*$</code>)
publicCertificatestringThe public certificate, in PEM format, that you received from your SSL certificate provider. Example: -----BEGIN CERTIFICATE----- MIIC2jCCAkMCAg38MA0GCSqGSIb3DQEBBQUAMIGbMQswCQYDVQQGEwJKUDEOMAwG A1UECBMFVG9reW8xEDAOBgNVBAcTB0NodW8ta3UxETAPBgNVBAoTCEZyYW5rNERE MRgwFgYDVQQLEw9XZWJDZXJ0IFN1cHBvcnQxGDAWBgNVBAMTD0ZyYW5rNEREIFdl YiBDQTEjMCEGCSqGSIb3DQEJARYUc3VwcG9ydEBmcmFuazRkZC5jb20wHhcNMTIw ... -----END CERTIFICATE-----

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
listselectloadBalancerId, regionopc-request-idLists all SSL certificates bundles associated with a given load balancer.
createinsertloadBalancerId, region, certificateNameopc-request-id, opc-retry-tokenCreates an asynchronous request to add an SSL certificate bundle.
deletedeleteloadBalancerId, certificateName, regionopc-request-idDeletes an SSL certificate bundle from a load balancer.

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
certificateNamestringThe name of the certificate bundle to delete. Example: example_certificate_bundle
loadBalancerIdstringThe [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer associated with the certificate bundle to be deleted.
regionstringOCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. (default: us-ashburn-1, x-stackQL-envVar: OCI_REGION)
opc-request-idstringThe unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
opc-retry-tokenstringA token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

SELECT examples​

Lists all SSL certificates bundles associated with a given load balancer.

SELECT
caCertificate,
certificateName,
publicCertificate
FROM oci.load_balancer.certificates
WHERE loadBalancerId = '{{ loadBalancerId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
;

INSERT examples​

Creates an asynchronous request to add an SSL certificate bundle.

INSERT INTO oci.load_balancer.certificates (
caCertificate,
certificateName,
passphrase,
privateKey,
publicCertificate,
loadBalancerId,
region,
opc-request-id,
opc-retry-token
)
SELECT 
'{{ caCertificate }}',
'{{ certificateName }}' /* required */,
'{{ passphrase }}',
'{{ privateKey }}',
'{{ publicCertificate }}',
'{{ loadBalancerId }}',
'{{ region }}',
'{{ opc-request-id }}',
'{{ opc-retry-token }}'
;

DELETE examples​

Deletes an SSL certificate bundle from a load balancer.

DELETE FROM oci.load_balancer.certificates
WHERE loadBalancerId = '{{ loadBalancerId }}' --required
AND certificateName = '{{ certificateName }}' --required
AND region = '{{ region }}' --required
AND opc-request-id = '{{ opc-request-id }}'
;