Skip to content

ConfigStoreApi.md

Latest commit

 

History

History
261 lines (179 loc) · 7.74 KB

ConfigStoreApi.md

File metadata and controls

261 lines (179 loc) · 7.74 KB

Fastly\Api\ConfigStoreApi

$apiInstance = new Fastly\Api\ConfigStoreApi(
    // 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
createConfigStore() POST /resources/stores/config Create a config store
deleteConfigStore() DELETE /resources/stores/config/{config_store_id} Delete a config store
getConfigStore() GET /resources/stores/config/{config_store_id} Describe a config store
getConfigStoreInfo() GET /resources/stores/config/{config_store_id}/info Get config store metadata
listConfigStoreServices() GET /resources/stores/config/{config_store_id}/services List linked services
listConfigStores() GET /resources/stores/config List config stores
updateConfigStore() PUT /resources/stores/config/{config_store_id} Update a config store

createConfigStore()

createConfigStore($options): \Fastly\Model\ConfigStoreResponse // Create a config store

Create a config store.

Example

    $options['name'] = 'name_example'; // string | The name of the config store.

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

Options

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

Name Type Description Notes
name string The name of the config store. [optional]

Return type

\Fastly\Model\ConfigStoreResponse

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

deleteConfigStore()

deleteConfigStore($options): \Fastly\Model\InlineResponse200 // Delete a config store

Delete a config store.

Example

    $options['config_store_id'] = 'config_store_id_example'; // string | An alphanumeric string identifying the config store.

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

Options

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

Name Type Description Notes
config_store_id string An alphanumeric string identifying the config store.

Return type

\Fastly\Model\InlineResponse200

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

getConfigStore()

getConfigStore($options): \Fastly\Model\ConfigStoreResponse // Describe a config store

Describe a config store by its identifier.

Example

    $options['config_store_id'] = 'config_store_id_example'; // string | An alphanumeric string identifying the config store.

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

Options

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

Name Type Description Notes
config_store_id string An alphanumeric string identifying the config store.

Return type

\Fastly\Model\ConfigStoreResponse

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

getConfigStoreInfo()

getConfigStoreInfo($options): \Fastly\Model\ConfigStoreInfoResponse // Get config store metadata

Retrieve metadata for a single config store.

Example

    $options['config_store_id'] = 'config_store_id_example'; // string | An alphanumeric string identifying the config store.

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

Options

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

Name Type Description Notes
config_store_id string An alphanumeric string identifying the config store.

Return type

\Fastly\Model\ConfigStoreInfoResponse

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

listConfigStoreServices()

listConfigStoreServices($options): object // List linked services

List services linked to a config store

Example

    $options['config_store_id'] = 'config_store_id_example'; // string | An alphanumeric string identifying the config store.

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

Options

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

Name Type Description Notes
config_store_id string An alphanumeric string identifying the config store.

Return type

object

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

listConfigStores()

listConfigStores($options): \Fastly\Model\ConfigStoreResponse[] // List config stores

List config stores.

Example

    
try {
    $result = $apiInstance->listConfigStores($options);
} catch (Exception $e) {
    echo 'Exception when calling ConfigStoreApi->listConfigStores: ', $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\ConfigStoreResponse[]

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

updateConfigStore()

updateConfigStore($options): \Fastly\Model\ConfigStoreResponse // Update a config store

Update a config store.

Example

    $options['config_store_id'] = 'config_store_id_example'; // string | An alphanumeric string identifying the config store.
$options['name'] = 'name_example'; // string | The name of the config store.

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

Options

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

Name Type Description Notes
config_store_id string An alphanumeric string identifying the config store.
name string The name of the config store. [optional]

Return type

\Fastly\Model\ConfigStoreResponse

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