Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 69a9c0748a602583d79069840ec45677fb9331f9 / . / docs / dyn / sqladmin_v1beta3.sslCerts.html
blob: 7e88b2ba6713efe99400e7df001b4d50b9f49db5 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="sqladmin_v1beta3.html">Cloud SQL Administration API</a> . <a href="sqladmin_v1beta3.sslCerts.html">sslCerts</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#delete">delete(project, instance, sha1Fingerprint)</a></code></p>
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]79<p class="firstline">Deletes an SSL certificate from a Cloud SQL instance.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]80<p class="toc_element">
81 <code><a href="#get">get(project, instance, sha1Fingerprint)</a></code></p>
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]82<p class="firstline">Retrieves an SSL certificate as specified by its SHA-1 fingerprint.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]83<p class="toc_element">
84 <code><a href="#insert">insert(project, instance, body)</a></code></p>
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]85<p class="firstline">Creates an SSL certificate and returns the certificate, the associated private key, and the server certificate authority.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]86<p class="toc_element">
87 <code><a href="#list">list(project, instance)</a></code></p>
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]88<p class="firstline">Lists all of the current SSL certificates defined for a Cloud SQL instance.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]89<h3>Method Details</h3>
90<div class="method">
91 <code class="details" id="delete">delete(project, instance, sha1Fingerprint)</code>
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]92 <pre>Deletes an SSL certificate from a Cloud SQL instance.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]93
94Args:
95 project: string, Project ID of the project that contains the instance to be deleted. (required)
96 instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
97 sha1Fingerprint: string, Sha1 FingerPrint. (required)
98
99Returns:
100 An object of the form:
101
102 { # SslCert delete response.
103 "kind": "sql#sslCertsDelete", # This is always sql#sslCertsDelete.
104 "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.
105 }</pre>
106</div>
107
108<div class="method">
109 <code class="details" id="get">get(project, instance, sha1Fingerprint)</code>
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]110 <pre>Retrieves an SSL certificate as specified by its SHA-1 fingerprint.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]111
112Args:
113 project: string, Project ID of the project that contains the instance. (required)
114 instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
115 sha1Fingerprint: string, Sha1 FingerPrint. (required)
116
117Returns:
118 An object of the form:
119
120 { # SslCerts Resource
121 "certSerialNumber": "A String", # Serial number, as extracted from the certificate.
122 "kind": "sql#sslCert", # This is always sql#sslCert.
123 "sha1Fingerprint": "A String", # Sha1 Fingerprint.
124 "commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.
125 "instance": "A String", # Name of the database instance.
126 "cert": "A String", # PEM representation.
127 "expirationTime": "A String", # Time when the certificate expires.
128 "createTime": "A String", # Time when the certificate was created.
129 }</pre>
130</div>
131
132<div class="method">
133 <code class="details" id="insert">insert(project, instance, body)</code>
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]134 <pre>Creates an SSL certificate and returns the certificate, the associated private key, and the server certificate authority.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]135
136Args:
137 project: string, Project ID of the project to which the newly created Cloud SQL instances should belong. (required)
138 instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
139 body: object, The request body. (required)
140 The object takes the form of:
141
142{ # SslCerts insert request.
143 "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.
144 }
145
146
147Returns:
148 An object of the form:
149
150 { # SslCert insert response.
151 "kind": "sql#sslCertsInsert", # This is always sql#sslCertsInsert.
152 "clientCert": { # SslCertDetail. # The new client certificate and private key. The new certificate will not work until the instance is restarted.
153 "certPrivateKey": "A String", # The private key for the client cert, in pem format. Keep private in order to protect your security.
154 "certInfo": { # SslCerts Resource # The public information about the cert.
155 "certSerialNumber": "A String", # Serial number, as extracted from the certificate.
156 "kind": "sql#sslCert", # This is always sql#sslCert.
157 "sha1Fingerprint": "A String", # Sha1 Fingerprint.
158 "commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.
159 "instance": "A String", # Name of the database instance.
160 "cert": "A String", # PEM representation.
161 "expirationTime": "A String", # Time when the certificate expires.
162 "createTime": "A String", # Time when the certificate was created.
163 },
164 },
165 "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..
166 "certSerialNumber": "A String", # Serial number, as extracted from the certificate.
167 "kind": "sql#sslCert", # This is always sql#sslCert.
168 "sha1Fingerprint": "A String", # Sha1 Fingerprint.
169 "commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.
170 "instance": "A String", # Name of the database instance.
171 "cert": "A String", # PEM representation.
172 "expirationTime": "A String", # Time when the certificate expires.
173 "createTime": "A String", # Time when the certificate was created.
174 },
175 }</pre>
176</div>
177
178<div class="method">
179 <code class="details" id="list">list(project, instance)</code>
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]180 <pre>Lists all of the current SSL certificates defined for a Cloud SQL instance.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]181
182Args:
183 project: string, Project ID of the project for which to list Cloud SQL instances. (required)
184 instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
185
186Returns:
187 An object of the form:
188
189 { # SslCerts list response.
190 "items": [ # List of client certificates for the instance.
191 { # SslCerts Resource
192 "certSerialNumber": "A String", # Serial number, as extracted from the certificate.
193 "kind": "sql#sslCert", # This is always sql#sslCert.
194 "sha1Fingerprint": "A String", # Sha1 Fingerprint.
195 "commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.
196 "instance": "A String", # Name of the database instance.
197 "cert": "A String", # PEM representation.
198 "expirationTime": "A String", # Time when the certificate expires.
199 "createTime": "A String", # Time when the certificate was created.
200 },
201 ],
202 "kind": "sql#sslCertsList", # This is always sql#sslCertsList.
203 }</pre>
204</div>
205
206</body></html>