Cloud SQL Administration API . sslCerts

Instance Methods

delete(project, instance, sha1Fingerprint)

Deletes an SSL certificate from a Cloud SQL instance.

get(project, instance, sha1Fingerprint)

Retrieves an SSL certificate as specified by its SHA-1 fingerprint.

insert(project, instance, body)

Creates an SSL certificate and returns the certificate, the associated private key, and the server certificate authority.

list(project, instance)

Lists all of the current SSL certificates defined for a Cloud SQL instance.

Method Details

delete(project, instance, sha1Fingerprint)
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.
  }
get(project, instance, sha1Fingerprint)
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.
  }
insert(project, instance, body)
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.
    },
  }
list(project, instance)
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.
  }