Skip to content

Latest commit

 

History

History
209 lines (148 loc) · 7.43 KB

EnabledProductsApi.md

File metadata and controls

209 lines (148 loc) · 7.43 KB

Fastly\Api\EnabledProductsApi

$apiInstance = new Fastly\Api\EnabledProductsApi(
    // 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
disableProduct() DELETE /enabled-products/v1/{product_id}/services/{service_id} Disable a product
enableProduct() PUT /enabled-products/v1/{product_id}/services/{service_id} Enable a product
getEnabledProduct() GET /enabled-products/v1/{product_id}/services/{service_id} Get enabled product
getProductConfiguration() GET /enabled-products/v1/{product_id}/services/{service_id}/configuration Get configuration for a product
setProductConfiguration() PATCH /enabled-products/v1/{product_id}/services/{service_id}/configuration Update configuration for a product

disableProduct()

disableProduct($options) // Disable a product

Disable a product on a service. Supported product IDs: brotli_compression,domain_inspector,fanout,image_optimizer,origin_inspector, websockets, bot_management, ngwaf, ddos_protection, and log_explorer_insights.

Example

    $options['product_id'] = ngwaf; // string
$options['service_id'] = 'service_id_example'; // string | Alphanumeric string identifying the service.

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

Options

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

Name Type Description Notes
product_id string
service_id string Alphanumeric string identifying the service.

Return type

void (empty response body)

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

enableProduct()

enableProduct($options): \Fastly\Model\EnabledProductResponse // Enable a product

Enable a product on a service. Supported product IDs: brotli_compression,domain_inspector,fanout,image_optimizer,origin_inspector, websockets, bot_management, ngwaf, ddos_protection, and log_explorer_insights.

Example

    $options['product_id'] = ngwaf; // string
$options['service_id'] = 'service_id_example'; // string | Alphanumeric string identifying the service.
$options['set_workspace_id'] = {"workspace_id":"7JFbo4RNA0OKdFWC04r6B3"}; // \Fastly\Model\SetWorkspaceId

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

Options

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

Name Type Description Notes
product_id string
service_id string Alphanumeric string identifying the service.
set_workspace_id \Fastly\Model\SetWorkspaceId [optional]

Return type

\Fastly\Model\EnabledProductResponse

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

getEnabledProduct()

getEnabledProduct($options): \Fastly\Model\EnabledProductResponse // Get enabled product

Get enabled product on a service. Supported product IDs: brotli_compression,domain_inspector,fanout,image_optimizer,origin_inspector, websockets, bot_management, ngwaf, ddos_protection, and log_explorer_insights.

Example

    $options['product_id'] = ngwaf; // string
$options['service_id'] = 'service_id_example'; // string | Alphanumeric string identifying the service.

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

Options

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

Name Type Description Notes
product_id string
service_id string Alphanumeric string identifying the service.

Return type

\Fastly\Model\EnabledProductResponse

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

getProductConfiguration()

getProductConfiguration($options): \Fastly\Model\ConfiguredProductResponse // Get configuration for a product

Get configuration for an enabled product on a service. Supported product IDs: ngwaf and ddos_protection.

Example

    $options['product_id'] = ngwaf; // string
$options['service_id'] = 'service_id_example'; // string | Alphanumeric string identifying the service.

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

Options

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

Name Type Description Notes
product_id string
service_id string Alphanumeric string identifying the service.

Return type

\Fastly\Model\ConfiguredProductResponse

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

setProductConfiguration()

setProductConfiguration($options): \Fastly\Model\ConfiguredProductResponse // Update configuration for a product

Update configuration for an enabled product on a service. Supported product IDs: ngwaf and ddos_protection.

Example

    $options['product_id'] = ngwaf; // string
$options['service_id'] = 'service_id_example'; // string | Alphanumeric string identifying the service.
$options['set_configuration'] = {"workspace_id":"7JFbo4RNA0OKdFWC04r6B3","traffic_ramp":"20"}; // \Fastly\Model\SetConfiguration

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

Options

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

Name Type Description Notes
product_id string
service_id string Alphanumeric string identifying the service.
set_configuration \Fastly\Model\SetConfiguration [optional]

Return type

\Fastly\Model\ConfiguredProductResponse

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