Skip to content

Latest commit

 

History

History
206 lines (146 loc) · 8 KB

TlsCertificatesApi.md

File metadata and controls

206 lines (146 loc) · 8 KB
Raw

Fastly\Api\TlsCertificatesApi

$apiInstance = new Fastly\Api\TlsCertificatesApi(
    // 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

Method Fastly API endpoint Description
createTlsCert() POST /tls/certificates Create a TLS certificate
deleteTlsCert() DELETE /tls/certificates/{tls_certificate_id} Delete a TLS certificate
getTlsCert() GET /tls/certificates/{tls_certificate_id} Get a TLS certificate
listTlsCerts() GET /tls/certificates List TLS certificates
updateTlsCert() PATCH /tls/certificates/{tls_certificate_id} Update a TLS certificate

createTlsCert()

createTlsCert($options): object // Create a TLS certificate

Create a TLS certificate.

Example

    $options['tls_certificate'] = {"data":{"type":"tls_certificate","attributes":{"cert_blob":"-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----\n","name":"My certificate"}}}; // \Fastly\Model\TlsCertificate

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

Options

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

Name Type Description Notes
tls_certificate \Fastly\Model\TlsCertificate [optional]

Return type

object

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

deleteTlsCert()

deleteTlsCert($options) // Delete a TLS certificate

Destroy a TLS certificate. TLS certificates already enabled for a domain cannot be destroyed.

Example

    $options['tls_certificate_id'] = 'tls_certificate_id_example'; // string | Alphanumeric string identifying a TLS certificate.

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

Options

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

Name Type Description Notes
tls_certificate_id string Alphanumeric string identifying a TLS certificate.

Return type

void (empty response body)

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

getTlsCert()

getTlsCert($options): \Fastly\Model\TlsCertificateResponse // Get a TLS certificate

Show a TLS certificate.

Example

    $options['tls_certificate_id'] = 'tls_certificate_id_example'; // string | Alphanumeric string identifying a TLS certificate.

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

Options

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

Name Type Description Notes
tls_certificate_id string Alphanumeric string identifying a TLS certificate.

Return type

\Fastly\Model\TlsCertificateResponse

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

listTlsCerts()

listTlsCerts($options): \Fastly\Model\TlsCertificatesResponse // List TLS certificates

List all TLS certificates.

Example

    $options['filter_in_use'] = 'filter_in_use_example'; // string | Optional. Limit the returned certificates to those currently using Fastly to terminate TLS (that is, certificates associated with an activation). Permitted values: true, false.
$options['filter_not_after'] = 'filter_not_after_example'; // string | Limit the returned certificates to those that expire prior to the specified date in UTC. Accepts parameters: lte (e.g., filter[not_after][lte]=2020-05-05).
$options['filter_tls_domains_id'] = 'filter_tls_domains_id_example'; // string | Limit the returned certificates to those that include the specific domain.
$options['include'] = 'include_example'; // string | Include related objects. Optional, comma-separated values. Permitted values: `tls_activations`.
$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->listTlsCerts($options);
} catch (Exception $e) {
    echo 'Exception when calling TlsCertificatesApi->listTlsCerts: ', $e->getMessage(), PHP_EOL;
}

Options

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

Name Type Description Notes
filter_in_use string Optional. Limit the returned certificates to those currently using Fastly to terminate TLS (that is, certificates associated with an activation). Permitted values: true, false. [optional]
filter_not_after string Limit the returned certificates to those that expire prior to the specified date in UTC. Accepts parameters: lte (e.g., filter[not_after][lte]=2020-05-05). [optional]
filter_tls_domains_id string Limit the returned certificates to those that include the specific domain. [optional]
include string Include related objects. Optional, comma-separated values. Permitted values: tls_activations. [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\TlsCertificatesResponse

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

updateTlsCert()

updateTlsCert($options): \Fastly\Model\TlsCertificateResponse // Update a TLS certificate

Replace a TLS certificate with a newly reissued TLS certificate, or update a TLS certificate's name. If replacing a TLS certificate, the new TLS certificate must contain all SAN entries as the current TLS certificate. It must either have an exact matching list or contain a superset.

Example

    $options['tls_certificate_id'] = 'tls_certificate_id_example'; // string | Alphanumeric string identifying a TLS certificate.
$options['tls_certificate'] = {"data":{"type":"tls_certificate","attributes":{"cert_blob":"-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----\n","name":"My certificate"}}}; // \Fastly\Model\TlsCertificate

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

Options

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

Name Type Description Notes
tls_certificate_id string Alphanumeric string identifying a TLS certificate.
tls_certificate \Fastly\Model\TlsCertificate [optional]

Return type

\Fastly\Model\TlsCertificateResponse

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