TlsPrivateKeysApi.md

Fastly\Api\TlsPrivateKeysApi

$apiInstance = new Fastly\Api\TlsPrivateKeysApi(
    // 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
createTlsKey()	POST /tls/private_keys	Create a TLS private key
deleteTlsKey()	DELETE /tls/private_keys/{tls_private_key_id}	Delete a TLS private key
getTlsKey()	GET /tls/private_keys/{tls_private_key_id}	Get a TLS private key
listTlsKeys()	GET /tls/private_keys	List TLS private keys

createTlsKey()

createTlsKey($options): \Fastly\Model\TlsPrivateKeyResponse // Create a TLS private key

Create a TLS private key.

Example

    $options['tls_private_key'] = {"data":{"type":"tls_private_key","attributes":{"key":"-----BEGIN PRIVATE KEY-----\n...\n-----END PRIVATE KEY-----\n","name":"My private key"}}}; // \Fastly\Model\TlsPrivateKey

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

Options

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

Name	Type	Description	Notes
tls_private_key	\Fastly\Model\TlsPrivateKey		[optional]

Return type

\Fastly\Model\TlsPrivateKeyResponse

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

deleteTlsKey()

deleteTlsKey($options) // Delete a TLS private key

Destroy a TLS private key. Only private keys not already matched to any certificates can be deleted.

Example

    $options['tls_private_key_id'] = 'tls_private_key_id_example'; // string | Alphanumeric string identifying a private Key.

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

Options

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

Name	Type	Description	Notes
tls_private_key_id	string	Alphanumeric string identifying a private Key.

Return type

void (empty response body)

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

getTlsKey()

getTlsKey($options): \Fastly\Model\TlsPrivateKeyResponse // Get a TLS private key

Show a TLS private key.

Example

    $options['tls_private_key_id'] = 'tls_private_key_id_example'; // string | Alphanumeric string identifying a private Key.

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

Options

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

Name	Type	Description	Notes
tls_private_key_id	string	Alphanumeric string identifying a private Key.

Return type

\Fastly\Model\TlsPrivateKeyResponse

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

listTlsKeys()

listTlsKeys($options): \Fastly\Model\TlsPrivateKeysResponse // List TLS private keys

List all TLS private keys.

Example

    $options['filter_in_use'] = 'filter_in_use_example'; // string | Limit the returned keys to those without any matching TLS certificates. The only valid value is false.
$options['page_number'] = 1; // int | Current page.
$options['page_size'] = 20; // int | Number of records per page.

try {
    $result = $apiInstance->listTlsKeys($options);
} catch (Exception $e) {
    echo 'Exception when calling TlsPrivateKeysApi->listTlsKeys: ', $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	Limit the returned keys to those without any matching TLS certificates. The only valid value is false.	[optional]
page_number	int	Current page.	[optional]
page_size	int	Number of records per page.	[optional] [defaults to 20]

Return type

\Fastly\Model\TlsPrivateKeysResponse

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