Skip to content

Latest commit

 

History

History
209 lines (148 loc) · 8.15 KB

TlsActivationsApi.md

File metadata and controls

209 lines (148 loc) · 8.15 KB
Raw

Fastly\Api\TlsActivationsApi

$apiInstance = new Fastly\Api\TlsActivationsApi(
    // 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
createTlsActivation() POST /tls/activations Enable TLS for a domain using a custom certificate
deleteTlsActivation() DELETE /tls/activations/{tls_activation_id} Disable TLS on a domain
getTlsActivation() GET /tls/activations/{tls_activation_id} Get a TLS activation
listTlsActivations() GET /tls/activations List TLS activations
updateTlsActivation() PATCH /tls/activations/{tls_activation_id} Update a certificate

createTlsActivation()

createTlsActivation($options): \Fastly\Model\TlsActivationResponse // Enable TLS for a domain using a custom certificate

Enable TLS for a particular TLS domain and certificate combination. These relationships must be specified to create the TLS activation.

Example

    $options['tls_activation'] = {"data":{"type":"tls_activation","relationships":{"tls_certificate":{"data":{"id":"cRTguUGZzb2W9Euo4moOr","type":"tls_certificate"}},"tls_configuration":{"data":{"id":"t7CguUGZzb2W9Euo5FoKa","type":"tls_configuration"}},"tls_domain":{"data":{"id":"example.com","type":"tls_domain"}}}}}; // \Fastly\Model\TlsActivation

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

Options

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

Name Type Description Notes
tls_activation \Fastly\Model\TlsActivation [optional]

Return type

\Fastly\Model\TlsActivationResponse

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

deleteTlsActivation()

deleteTlsActivation($options) // Disable TLS on a domain

Disable TLS on the domain associated with this TLS activation.

Example

    $options['tls_activation_id'] = 'tls_activation_id_example'; // string | Alphanumeric string identifying a TLS activation.

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

Options

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

Name Type Description Notes
tls_activation_id string Alphanumeric string identifying a TLS activation.

Return type

void (empty response body)

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

getTlsActivation()

getTlsActivation($options): \Fastly\Model\TlsActivationResponse // Get a TLS activation

Show a TLS activation.

Example

    $options['include'] = tls_certificate,tls_configuration,tls_domain; // string | Include related objects. Optional, comma-separated values. Permitted values: `tls_certificate`, `tls_configuration`, and `tls_domain`.
$options['tls_activation_id'] = 'tls_activation_id_example'; // string | Alphanumeric string identifying a TLS activation.

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

Options

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

Name Type Description Notes
include string Include related objects. Optional, comma-separated values. Permitted values: tls_certificate, tls_configuration, and tls_domain. [optional]
tls_activation_id string Alphanumeric string identifying a TLS activation.

Return type

\Fastly\Model\TlsActivationResponse

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

listTlsActivations()

listTlsActivations($options): \Fastly\Model\TlsActivationsResponse // List TLS activations

List all TLS activations.

Example

    $options['filter_tls_certificate_id'] = 'filter_tls_certificate_id_example'; // string | Limit the returned activations to a specific certificate.
$options['filter_tls_configuration_id'] = 'filter_tls_configuration_id_example'; // string | Limit the returned activations to a specific TLS configuration.
$options['filter_tls_domain_id'] = 'filter_tls_domain_id_example'; // string | Limit the returned rules to a specific domain name.
$options['include'] = tls_certificate,tls_configuration,tls_domain; // string | Include related objects. Optional, comma-separated values. Permitted values: `tls_certificate`, `tls_configuration`, and `tls_domain`.
$options['page_number'] = 1; // int | Current page.
$options['page_size'] = 20; // int | Number of records per page.

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

Options

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

Name Type Description Notes
filter_tls_certificate_id string Limit the returned activations to a specific certificate. [optional]
filter_tls_configuration_id string Limit the returned activations to a specific TLS configuration. [optional]
filter_tls_domain_id string Limit the returned rules to a specific domain name. [optional]
include string Include related objects. Optional, comma-separated values. Permitted values: tls_certificate, tls_configuration, and tls_domain. [optional]
page_number int Current page. [optional]
page_size int Number of records per page. [optional] [defaults to 20]

Return type

\Fastly\Model\TlsActivationsResponse

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

updateTlsActivation()

updateTlsActivation($options): \Fastly\Model\TlsActivationResponse // Update a certificate

Update the certificate used to terminate TLS traffic for the domain associated with this TLS activation.

Example

    $options['tls_activation_id'] = 'tls_activation_id_example'; // string | Alphanumeric string identifying a TLS activation.
$options['tls_activation'] = {"data":{"type":"tls_activation","relationships":{"tls_certificate":{"data":{"type":"tls_certificate","id":"cRTguUGZzb2W9Euo4moOr"}}}}}; // \Fastly\Model\TlsActivation

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

Options

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

Name Type Description Notes
tls_activation_id string Alphanumeric string identifying a TLS activation.
tls_activation \Fastly\Model\TlsActivation [optional]

Return type

\Fastly\Model\TlsActivationResponse

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