Skip to content

Latest commit

 

History

History
203 lines (142 loc) · 7.77 KB

TlsBulkCertificatesApi.md

File metadata and controls

203 lines (142 loc) · 7.77 KB
Raw

Fastly\Api\TlsBulkCertificatesApi

$apiInstance = new Fastly\Api\TlsBulkCertificatesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

Methods

Note

All URIs are relative to https://api.fastly.com

Method HTTP request Description
deleteBulkTlsCert() DELETE /tls/bulk/certificates/{certificate_id} Delete a certificate
getTlsBulkCert() GET /tls/bulk/certificates/{certificate_id} Get a certificate
listTlsBulkCerts() GET /tls/bulk/certificates List certificates
updateBulkTlsCert() PATCH /tls/bulk/certificates/{certificate_id} Update a certificate
uploadTlsBulkCert() POST /tls/bulk/certificates Upload a certificate

deleteBulkTlsCert()

deleteBulkTlsCert($options) // Delete a certificate

Destroy a certificate. This disables TLS for all domains listed as SAN entries.

Example

    $options['certificate_id'] = 'certificate_id_example'; // string | Alphanumeric string identifying a TLS bulk certificate.

try {
    $apiInstance->deleteBulkTlsCert($options);
} catch (Exception $e) {
    echo 'Exception when calling TlsBulkCertificatesApi->deleteBulkTlsCert: ', $e->getMessage(), PHP_EOL;
}

Options

Note: the input parameter is an associative array with the keys listed below.

Name Type Description Notes
certificate_id string Alphanumeric string identifying a TLS bulk certificate.

Return type

void (empty response body)

[Back to top] [Back to API list] [Back to README]

getTlsBulkCert()

getTlsBulkCert($options): \Fastly\Model\TlsBulkCertificateResponse // Get a certificate

Retrieve a single certificate.

Example

    $options['certificate_id'] = 'certificate_id_example'; // string | Alphanumeric string identifying a TLS bulk certificate.

try {
    $result = $apiInstance->getTlsBulkCert($options);
} catch (Exception $e) {
    echo 'Exception when calling TlsBulkCertificatesApi->getTlsBulkCert: ', $e->getMessage(), PHP_EOL;
}

Options

Note: the input parameter is an associative array with the keys listed below.

Name Type Description Notes
certificate_id string Alphanumeric string identifying a TLS bulk certificate.

Return type

\Fastly\Model\TlsBulkCertificateResponse

[Back to top] [Back to API list] [Back to README]

listTlsBulkCerts()

listTlsBulkCerts($options): \Fastly\Model\TlsBulkCertificatesResponse // List certificates

List all certificates.

Example

    $options['filter_tls_domain_id'] = 'filter_tls_domain_id_example'; // string | Filter certificates by their matching, fully-qualified domain name.
$options['page_number'] = 1; // int | Current page.
$options['page_size'] = 20; // int | Number of records per page.
$options['sort'] = created_at; // string | The order in which to list the results by creation date.

try {
    $result = $apiInstance->listTlsBulkCerts($options);
} catch (Exception $e) {
    echo 'Exception when calling TlsBulkCertificatesApi->listTlsBulkCerts: ', $e->getMessage(), PHP_EOL;
}

Options

Note: the input parameter is an associative array with the keys listed below.

Name Type Description Notes
filter_tls_domain_id string Filter certificates by their matching, fully-qualified domain name. [optional]
page_number int Current page. [optional]
page_size int Number of records per page. [optional] [defaults to 20]
sort string The order in which to list the results by creation date. [optional] [one of: 'created_at', '-created_at'] [defaults to 'created_at']

Return type

\Fastly\Model\TlsBulkCertificatesResponse

[Back to top] [Back to API list] [Back to README]

updateBulkTlsCert()

updateBulkTlsCert($options): \Fastly\Model\TlsBulkCertificateResponse // Update a certificate

Replace a certificate with a newly reissued certificate. By using this endpoint, the original certificate will cease to be used for future TLS handshakes. Thus, only SAN entries that appear in the replacement certificate will become TLS enabled. Any SAN entries that are missing in the replacement certificate will become disabled.

Example

    $options['certificate_id'] = 'certificate_id_example'; // string | Alphanumeric string identifying a TLS bulk certificate.
$options['tls_bulk_certificate'] = {"data":{"id":"cRTguUGZzb2W9Euo4moOr","type":"tls_bulk_certificate","attributes":{"allow_untrusted_root":false,"cert_blob":"-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----\n","intermediates_blob":"-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----\n"}}}; // \Fastly\Model\TlsBulkCertificate

try {
    $result = $apiInstance->updateBulkTlsCert($options);
} catch (Exception $e) {
    echo 'Exception when calling TlsBulkCertificatesApi->updateBulkTlsCert: ', $e->getMessage(), PHP_EOL;
}

Options

Note: the input parameter is an associative array with the keys listed below.

Name Type Description Notes
certificate_id string Alphanumeric string identifying a TLS bulk certificate.
tls_bulk_certificate \Fastly\Model\TlsBulkCertificate [optional]

Return type

\Fastly\Model\TlsBulkCertificateResponse

[Back to top] [Back to API list] [Back to README]

uploadTlsBulkCert()

uploadTlsBulkCert($options): \Fastly\Model\TlsBulkCertificateResponse // Upload a certificate

Upload a new certificate. TLS domains are automatically enabled upon certificate creation. If a domain is already enabled on a previously uploaded certificate, that domain will be updated to use the new certificate for all future TLS handshake requests.

Example

    $options['tls_bulk_certificate'] = {"data":{"type":"tls_bulk_certificate","attributes":{"allow_untrusted_root":false,"cert_blob":"-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----\n","intermediates_blob":"-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----\n"},"relationships":{"tls_configurations":{"data":[{"type":"tls_configuration","id":"t7CguUGZzb2W9Euo5FoKa"}]}}}}; // \Fastly\Model\TlsBulkCertificate

try {
    $result = $apiInstance->uploadTlsBulkCert($options);
} catch (Exception $e) {
    echo 'Exception when calling TlsBulkCertificatesApi->uploadTlsBulkCert: ', $e->getMessage(), PHP_EOL;
}

Options

Note: the input parameter is an associative array with the keys listed below.

Name Type Description Notes
tls_bulk_certificate \Fastly\Model\TlsBulkCertificate [optional]

Return type

\Fastly\Model\TlsBulkCertificateResponse

[Back to top] [Back to API list] [Back to README]