Skip to content

Latest commit

 

History

History
228 lines (156 loc) · 6.48 KB

SecretStoreApi.md

File metadata and controls

228 lines (156 loc) · 6.48 KB

Fastly\Api\SecretStoreApi

$apiInstance = new Fastly\Api\SecretStoreApi(
    // 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
clientKey() POST /resources/stores/secret/client-key Create new client key
createSecretStore() POST /resources/stores/secret Create new secret store
deleteSecretStore() DELETE /resources/stores/secret/{store_id} Delete secret store
getSecretStore() GET /resources/stores/secret/{store_id} Get secret store by ID
getSecretStores() GET /resources/stores/secret Get all secret stores
signingKey() GET /resources/stores/secret/signing-key Get public key

clientKey()

clientKey($options): \Fastly\Model\ClientKey // Create new client key

Create a new client key for encrypting secrets locally before uploading.

Example

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

Options

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

This endpoint does not need any parameters.

Return type

\Fastly\Model\ClientKey

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

createSecretStore()

createSecretStore($options): \Fastly\Model\SecretStoreResponse // Create new secret store

Create a new secret store.

Example

    $options['secret_store'] = new \Fastly\Model\SecretStore(); // \Fastly\Model\SecretStore

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

Options

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

Name Type Description Notes
secret_store \Fastly\Model\SecretStore [optional]

Return type

\Fastly\Model\SecretStoreResponse

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

deleteSecretStore()

deleteSecretStore($options) // Delete secret store

Delete a secret store and all of its contents.

Example

    $options['store_id'] = 'store_id_example'; // string

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

Options

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

Name Type Description Notes
store_id string

Return type

void (empty response body)

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

getSecretStore()

getSecretStore($options): \Fastly\Model\SecretStoreResponse // Get secret store by ID

Get a secret store by ID.

Example

    $options['store_id'] = 'store_id_example'; // string

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

Options

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

Name Type Description Notes
store_id string

Return type

\Fastly\Model\SecretStoreResponse

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

getSecretStores()

getSecretStores($options): \Fastly\Model\InlineResponse2005 // Get all secret stores

Get all secret stores.

Example

    $options['cursor'] = 'cursor_example'; // string | Cursor value from the `next_cursor` field of a previous response, used to retrieve the next page. To request the first page, this should be empty.
$options['limit'] = '100'; // string | Number of results per page. The maximum is 200.
$options['name'] = 'name_example'; // string | Returns a one-element array containing the details for the named secret store.

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

Options

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

Name Type Description Notes
cursor string Cursor value from the next_cursor field of a previous response, used to retrieve the next page. To request the first page, this should be empty. [optional]
limit string Number of results per page. The maximum is 200. [optional] [defaults to '100']
name string Returns a one-element array containing the details for the named secret store. [optional]

Return type

\Fastly\Model\InlineResponse2005

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

signingKey()

signingKey($options): \Fastly\Model\SigningKey // Get public key

Get the public key used for signing client keys.

Example

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

Options

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

This endpoint does not need any parameters.

Return type

\Fastly\Model\SigningKey

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