<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="sqladmin_v1beta3.html">Cloud SQL Administration API</a> . <a href="sqladmin_v1beta3.sslCerts.html">sslCerts</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#delete">delete(project, instance, sha1Fingerprint)</a></code></p>
<p class="firstline">Deletes an SSL certificate from a Cloud SQL instance.</p>
<p class="toc_element">
<code><a href="#get">get(project, instance, sha1Fingerprint)</a></code></p>
<p class="firstline">Retrieves an SSL certificate as specified by its SHA-1 fingerprint.</p>
<p class="toc_element">
<code><a href="#insert">insert(project, instance, body)</a></code></p>
<p class="firstline">Creates an SSL certificate and returns the certificate, the associated private key, and the server certificate authority.</p>
<p class="toc_element">
<code><a href="#list">list(project, instance)</a></code></p>
<p class="firstline">Lists all of the current SSL certificates defined for a Cloud SQL instance.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="delete">delete(project, instance, sha1Fingerprint)</code>
<pre>Deletes an SSL certificate from a Cloud SQL instance.
Args:
project: string, Project ID of the project that contains the instance to be deleted. (required)
instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
sha1Fingerprint: string, Sha1 FingerPrint. (required)
Returns:
An object of the form:
{ # SslCert delete response.
"kind": "sql#sslCertsDelete", # This is always sql#sslCertsDelete.
"operation": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(project, instance, sha1Fingerprint)</code>
<pre>Retrieves an SSL certificate as specified by its SHA-1 fingerprint.
Args:
project: string, Project ID of the project that contains the instance. (required)
instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
sha1Fingerprint: string, Sha1 FingerPrint. (required)
Returns:
An object of the form:
{ # SslCerts Resource
"certSerialNumber": "A String", # Serial number, as extracted from the certificate.
"kind": "sql#sslCert", # This is always sql#sslCert.
"sha1Fingerprint": "A String", # Sha1 Fingerprint.
"commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.
"instance": "A String", # Name of the database instance.
"cert": "A String", # PEM representation.
"expirationTime": "A String", # Time when the certificate expires.
"createTime": "A String", # Time when the certificate was created.
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(project, instance, body)</code>
<pre>Creates an SSL certificate and returns the certificate, the associated private key, and the server certificate authority.
Args:
project: string, Project ID of the project to which the newly created Cloud SQL instances should belong. (required)
instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
body: object, The request body. (required)
The object takes the form of:
{ # SslCerts insert request.
"commonName": "A String", # User supplied name. Must be a distinct name from the other certificates for this instance. New certificates will not be usable until the instance is restarted.
}
Returns:
An object of the form:
{ # SslCert insert response.
"kind": "sql#sslCertsInsert", # This is always sql#sslCertsInsert.
"clientCert": { # SslCertDetail. # The new client certificate and private key. The new certificate will not work until the instance is restarted.
"certPrivateKey": "A String", # The private key for the client cert, in pem format. Keep private in order to protect your security.
"certInfo": { # SslCerts Resource # The public information about the cert.
"certSerialNumber": "A String", # Serial number, as extracted from the certificate.
"kind": "sql#sslCert", # This is always sql#sslCert.
"sha1Fingerprint": "A String", # Sha1 Fingerprint.
"commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.
"instance": "A String", # Name of the database instance.
"cert": "A String", # PEM representation.
"expirationTime": "A String", # Time when the certificate expires.
"createTime": "A String", # Time when the certificate was created.
},
},
"serverCaCert": { # SslCerts Resource # The server Certificate Authority's certificate. If this is missing you can force a new one to be generated by calling resetSslConfig method on instances resource..
"certSerialNumber": "A String", # Serial number, as extracted from the certificate.
"kind": "sql#sslCert", # This is always sql#sslCert.
"sha1Fingerprint": "A String", # Sha1 Fingerprint.
"commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.
"instance": "A String", # Name of the database instance.
"cert": "A String", # PEM representation.
"expirationTime": "A String", # Time when the certificate expires.
"createTime": "A String", # Time when the certificate was created.
},
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(project, instance)</code>
<pre>Lists all of the current SSL certificates defined for a Cloud SQL instance.
Args:
project: string, Project ID of the project for which to list Cloud SQL instances. (required)
instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
Returns:
An object of the form:
{ # SslCerts list response.
"items": [ # List of client certificates for the instance.
{ # SslCerts Resource
"certSerialNumber": "A String", # Serial number, as extracted from the certificate.
"kind": "sql#sslCert", # This is always sql#sslCert.
"sha1Fingerprint": "A String", # Sha1 Fingerprint.
"commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.
"instance": "A String", # Name of the database instance.
"cert": "A String", # PEM representation.
"expirationTime": "A String", # Time when the certificate expires.
"createTime": "A String", # Time when the certificate was created.
},
],
"kind": "sql#sslCertsList", # This is always sql#sslCertsList.
}</pre>
</div>
</body></html>