# Cloud SQL Admin API . sslCerts

## Instance Methods

Close httplib2 connections.

Generates a short-lived X509 certificate containing the provided public key and signed by a private key specific to the target instance. Users may use the certificate to authenticate as themselves when connecting to the database.

Deletes the SSL certificate. For First Generation instances, the certificate remains valid until the instance is restarted.

Retrieves a particular SSL certificate. Does not include the private key (required for usage). The private key must be saved from the response to initial creation.

Creates an SSL certificate and returns it along with the private key and server certificate authority. The new certificate will not be usable until the instance is restarted.

Lists all of the current SSL certificates for the instance.

### Method Details

`close()`

    Close httplib2 connections.

`createEphemeral(project, instance, body=None, x__xgafv=None)`

    Generates a short-lived X509 certificate containing the provided public key and signed by a private key specific to the target instance. Users may use the certificate to authenticate as themselves when connecting to the database.

    Args:
      project: string, Project ID of the Cloud SQL project. (required)
      instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
      body: object, The request body.
        The object takes the form of:

    { # SslCerts create ephemeral certificate request.
        "public_key": "A String", # PEM encoded public key to include in the signed certificate.
      }

      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # SslCerts Resource
        "commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.
        "selfLink": "A String", # The URI of this resource.
        "instance": "A String", # Name of the database instance.
        "expirationTime": "A String", # The time when the certificate expires in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
        "createTime": "A String", # The time when the certificate was created in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*
        "kind": "A String", # This is always *sql#sslCert*.
        "cert": "A String", # PEM representation.
        "certSerialNumber": "A String", # Serial number, as extracted from the certificate.
        "sha1Fingerprint": "A String", # Sha1 Fingerprint.
      }

`delete(project, instance, sha1Fingerprint, x__xgafv=None)`

    Deletes the SSL certificate. For First Generation instances, the certificate remains valid until the instance is restarted.

    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)
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.
        "kind": "A String", # This is always *sql#operation*.
        "name": "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.
        "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
        "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
          "errors": [ # The list of errors encountered while processing this operation.
            { # Database instance operation error.
              "code": "A String", # Identifies the specific error that occurred.
              "kind": "A String", # This is always *sql#operationError*.
              "message": "A String", # Additional information about the error encountered.
            },
          ],
          "kind": "A String", # This is always *sql#operationErrors*.
        },
        "status": "A String", # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*
        "selfLink": "A String", # The URI of this resource.
        "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
        "exportContext": { # Database instance export context. # The context for export operation, if applicable.
          "csvExportOptions": { # Options for exporting data as CSV.
            "selectQuery": "A String", # The select query used to extract the data.
          },
          "fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.
          "kind": "A String", # This is always *sql#exportContext*.
          "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form *gs: //bucketName/fileName*. If the file already exists, the requests // succeeds, but the operation fails. If *fileType* is // *SQL* and the filename ends with .gz, the contents are // compressed.
          "databases": [ # Databases to be exported. *MySQL instances:* If *fileType* is *SQL* and no database is specified, all databases are exported, except for the *mysql* system database. If *fileType* is *CSV*, you can specify one database, either by using this property or by using the *csvExportOptions.selectQuery* property, which takes precedence over this property. *PostgreSQL instances:* You must specify one database to be exported. If *fileType* is *CSV*, this database must match the one specified in the *csvExportOptions.selectQuery* property.
            "A String",
          ],
          "offload": True or False, # Option for export offload.
          "sqlExportOptions": { # Options for exporting data as SQL statements.
            "schemaOnly": True or False, # Export only schemas.
            "tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. For PostgreSQL instances, you can specify only one table.
              "A String",
            ],
            "mysqlExportOptions": { # Options for exporting from MySQL.
              "masterData": 42, # Option to include SQL statement required to set up replication. If set to *1*, the dump file includes a CHANGE MASTER TO statement with the binary log coordinates. If set to *2*, the CHANGE MASTER TO statement is written as a SQL comment, and has no effect. All other values are ignored.
            },
          },
        },
        "user": "A String", # The email address of the user who initiated this operation.
        "targetId": "A String", # Name of the database instance related to this operation.
        "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
        "operationType": "A String", # The type of the operation. Valid values are: *CREATE* *DELETE* *UPDATE* *RESTART* *IMPORT* *EXPORT* *BACKUP_VOLUME* *RESTORE_VOLUME* *CREATE_USER* *DELETE_USER* *CREATE_DATABASE* *DELETE_DATABASE*
        "targetProject": "A String", # The project ID of the target instance related to this operation.
        "targetLink": "A String",
        "importContext": { # Database instance import context. # The context for import operation, if applicable.
          "fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.
          "kind": "A String", # This is always *sql#importContext*.
          "csvImportOptions": { # Options for importing data as CSV.
            "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.
              "A String",
            ],
            "table": "A String", # The table to which CSV data is imported.
          },
          "bakImportOptions": { # Import parameters specific to SQL Server .BAK files
            "encryptionOptions": {
              "pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form *gs://bucketName/fileName*. The instance must have write permissions to the bucket and read access to the file.
              "certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form *gs://bucketName/fileName*. The instance must have write permissions to the bucket and read access to the file.
              "pvkPassword": "A String", # Password that encrypts the private key
            },
          },
          "database": "A String", # The target database for the import. If *fileType* is *SQL*, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If *fileType* is *CSV*, one database must be specified.
          "uri": "A String", # Path to the import file in Cloud Storage, in the form *gs: //bucketName/fileName*. Compressed gzip files (.gz) are supported // when *fileType* is *SQL*. The instance must have // write permissions to the bucket and read access to the file.
          "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
        },
      }

`get(project, instance, sha1Fingerprint, x__xgafv=None)`

    Retrieves a particular SSL certificate. Does not include the private key (required for usage). The private key must be saved from the response to initial creation.

    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)
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # SslCerts Resource
        "commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.
        "selfLink": "A String", # The URI of this resource.
        "instance": "A String", # Name of the database instance.
        "expirationTime": "A String", # The time when the certificate expires in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
        "createTime": "A String", # The time when the certificate was created in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*
        "kind": "A String", # This is always *sql#sslCert*.
        "cert": "A String", # PEM representation.
        "certSerialNumber": "A String", # Serial number, as extracted from the certificate.
        "sha1Fingerprint": "A String", # Sha1 Fingerprint.
      }

`insert(project, instance, body=None, x__xgafv=None)`

    Creates an SSL certificate and returns it along with the private key and server certificate authority. The new certificate will not be usable until the instance is restarted.

    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)
      body: object, The request body.
        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.
      }

      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # SslCert insert response.
        "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.
          "commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.
          "selfLink": "A String", # The URI of this resource.
          "instance": "A String", # Name of the database instance.
          "expirationTime": "A String", # The time when the certificate expires in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
          "createTime": "A String", # The time when the certificate was created in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*
          "kind": "A String", # This is always *sql#sslCert*.
          "cert": "A String", # PEM representation.
          "certSerialNumber": "A String", # Serial number, as extracted from the certificate.
          "sha1Fingerprint": "A String", # Sha1 Fingerprint.
        },
        "operation": { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. # The operation to track the ssl certs insert request.
          "kind": "A String", # This is always *sql#operation*.
          "name": "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.
          "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
          "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
            "errors": [ # The list of errors encountered while processing this operation.
              { # Database instance operation error.
                "code": "A String", # Identifies the specific error that occurred.
                "kind": "A String", # This is always *sql#operationError*.
                "message": "A String", # Additional information about the error encountered.
              },
            ],
            "kind": "A String", # This is always *sql#operationErrors*.
          },
          "status": "A String", # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*
          "selfLink": "A String", # The URI of this resource.
          "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
          "exportContext": { # Database instance export context. # The context for export operation, if applicable.
            "csvExportOptions": { # Options for exporting data as CSV.
              "selectQuery": "A String", # The select query used to extract the data.
            },
            "fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.
            "kind": "A String", # This is always *sql#exportContext*.
            "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form *gs: //bucketName/fileName*. If the file already exists, the requests // succeeds, but the operation fails. If *fileType* is // *SQL* and the filename ends with .gz, the contents are // compressed.
            "databases": [ # Databases to be exported. *MySQL instances:* If *fileType* is *SQL* and no database is specified, all databases are exported, except for the *mysql* system database. If *fileType* is *CSV*, you can specify one database, either by using this property or by using the *csvExportOptions.selectQuery* property, which takes precedence over this property. *PostgreSQL instances:* You must specify one database to be exported. If *fileType* is *CSV*, this database must match the one specified in the *csvExportOptions.selectQuery* property.
              "A String",
            ],
            "offload": True or False, # Option for export offload.
            "sqlExportOptions": { # Options for exporting data as SQL statements.
              "schemaOnly": True or False, # Export only schemas.
              "tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. For PostgreSQL instances, you can specify only one table.
                "A String",
              ],
              "mysqlExportOptions": { # Options for exporting from MySQL.
                "masterData": 42, # Option to include SQL statement required to set up replication. If set to *1*, the dump file includes a CHANGE MASTER TO statement with the binary log coordinates. If set to *2*, the CHANGE MASTER TO statement is written as a SQL comment, and has no effect. All other values are ignored.
              },
            },
          },
          "user": "A String", # The email address of the user who initiated this operation.
          "targetId": "A String", # Name of the database instance related to this operation.
          "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
          "operationType": "A String", # The type of the operation. Valid values are: *CREATE* *DELETE* *UPDATE* *RESTART* *IMPORT* *EXPORT* *BACKUP_VOLUME* *RESTORE_VOLUME* *CREATE_USER* *DELETE_USER* *CREATE_DATABASE* *DELETE_DATABASE*
          "targetProject": "A String", # The project ID of the target instance related to this operation.
          "targetLink": "A String",
          "importContext": { # Database instance import context. # The context for import operation, if applicable.
            "fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.
            "kind": "A String", # This is always *sql#importContext*.
            "csvImportOptions": { # Options for importing data as CSV.
              "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.
                "A String",
              ],
              "table": "A String", # The table to which CSV data is imported.
            },
            "bakImportOptions": { # Import parameters specific to SQL Server .BAK files
              "encryptionOptions": {
                "pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form *gs://bucketName/fileName*. The instance must have write permissions to the bucket and read access to the file.
                "certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form *gs://bucketName/fileName*. The instance must have write permissions to the bucket and read access to the file.
                "pvkPassword": "A String", # Password that encrypts the private key
              },
            },
            "database": "A String", # The target database for the import. If *fileType* is *SQL*, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If *fileType* is *CSV*, one database must be specified.
            "uri": "A String", # Path to the import file in Cloud Storage, in the form *gs: //bucketName/fileName*. Compressed gzip files (.gz) are supported // when *fileType* is *SQL*. The instance must have // write permissions to the bucket and read access to the file.
            "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
          },
        },
        "clientCert": { # SslCertDetail. # The new client certificate and private key.
          "certInfo": { # SslCerts Resource # The public information about the cert.
            "commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.
            "selfLink": "A String", # The URI of this resource.
            "instance": "A String", # Name of the database instance.
            "expirationTime": "A String", # The time when the certificate expires in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
            "createTime": "A String", # The time when the certificate was created in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*
            "kind": "A String", # This is always *sql#sslCert*.
            "cert": "A String", # PEM representation.
            "certSerialNumber": "A String", # Serial number, as extracted from the certificate.
            "sha1Fingerprint": "A String", # Sha1 Fingerprint.
          },
          "certPrivateKey": "A String", # The private key for the client cert, in pem format. Keep private in order to protect your security.
        },
        "kind": "A String", # This is always *sql#sslCertsInsert*.
      }

`list(project, instance, x__xgafv=None)`

    Lists all of the current SSL certificates for the instance.

    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)
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # SslCerts list response.
        "items": [ # List of client certificates for the instance.
          { # SslCerts Resource
            "commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.
            "selfLink": "A String", # The URI of this resource.
            "instance": "A String", # Name of the database instance.
            "expirationTime": "A String", # The time when the certificate expires in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
            "createTime": "A String", # The time when the certificate was created in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*
            "kind": "A String", # This is always *sql#sslCert*.
            "cert": "A String", # PEM representation.
            "certSerialNumber": "A String", # Serial number, as extracted from the certificate.
            "sha1Fingerprint": "A String", # Sha1 Fingerprint.
          },
        ],
        "kind": "A String", # This is always *sql#sslCertsList*.
      }