Skip to content

Latest commit

 

History

History
287 lines (202 loc) · 9.85 KB

EnabledProductsApi.md

File metadata and controls

287 lines (202 loc) · 9.85 KB

WebService::Fastly::EnabledProductsApi

Load the API package

use WebService::Fastly::Object::EnabledProductsApi;

Note

All URIs are relative to https://api.fastly.com

Method HTTP request Description
disable_product DELETE /enabled-products/v1/{product_id}/services/{service_id} Disable a product
enable_product PUT /enabled-products/v1/{product_id}/services/{service_id} Enable a product
get_enabled_product GET /enabled-products/v1/{product_id}/services/{service_id} Get enabled product
get_product_configuration GET /enabled-products/v1/{product_id}/services/{service_id}/configuration Get configuration for a product
set_product_configuration PATCH /enabled-products/v1/{product_id}/services/{service_id}/configuration Update configuration for a product

disable_product

disable_product(product_id => $product_id, service_id => $service_id)

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

use Data::Dumper;
use WebService::Fastly::EnabledProductsApi;
my $api_instance = WebService::Fastly::EnabledProductsApi->new(

    # Configure API key authorization: token
    api_key => {'Fastly-Key' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'Fastly-Key' => 'Bearer'},
);

my $product_id = ngwaf; # string | 
my $service_id = "service_id_example"; # string | Alphanumeric string identifying the service.

eval {
    $api_instance->disable_product(product_id => $product_id, service_id => $service_id);
};
if ($@) {
    warn "Exception when calling EnabledProductsApi->disable_product: $@\n";
}

Parameters

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

Return type

void (empty response body)

Authorization

token

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

enable_product

EnabledProductResponse enable_product(product_id => $product_id, service_id => $service_id, set_workspace_id => $set_workspace_id)

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

use Data::Dumper;
use WebService::Fastly::EnabledProductsApi;
my $api_instance = WebService::Fastly::EnabledProductsApi->new(

    # Configure API key authorization: token
    api_key => {'Fastly-Key' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'Fastly-Key' => 'Bearer'},
);

my $product_id = ngwaf; # string | 
my $service_id = "service_id_example"; # string | Alphanumeric string identifying the service.
my $set_workspace_id = WebService::Fastly::Object::SetWorkspaceId->new(); # SetWorkspaceId | 

eval {
    my $result = $api_instance->enable_product(product_id => $product_id, service_id => $service_id, set_workspace_id => $set_workspace_id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EnabledProductsApi->enable_product: $@\n";
}

Parameters

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

Return type

EnabledProductResponse

Authorization

token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

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

get_enabled_product

EnabledProductResponse get_enabled_product(product_id => $product_id, service_id => $service_id)

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

use Data::Dumper;
use WebService::Fastly::EnabledProductsApi;
my $api_instance = WebService::Fastly::EnabledProductsApi->new(

    # Configure API key authorization: token
    api_key => {'Fastly-Key' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'Fastly-Key' => 'Bearer'},
);

my $product_id = ngwaf; # string | 
my $service_id = "service_id_example"; # string | Alphanumeric string identifying the service.

eval {
    my $result = $api_instance->get_enabled_product(product_id => $product_id, service_id => $service_id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EnabledProductsApi->get_enabled_product: $@\n";
}

Parameters

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

Return type

EnabledProductResponse

Authorization

token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

get_product_configuration

ConfiguredProductResponse get_product_configuration(product_id => $product_id, service_id => $service_id)

Get configuration for a product

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

Example

use Data::Dumper;
use WebService::Fastly::EnabledProductsApi;
my $api_instance = WebService::Fastly::EnabledProductsApi->new(

    # Configure API key authorization: token
    api_key => {'Fastly-Key' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'Fastly-Key' => 'Bearer'},
);

my $product_id = ngwaf; # string | 
my $service_id = "service_id_example"; # string | Alphanumeric string identifying the service.

eval {
    my $result = $api_instance->get_product_configuration(product_id => $product_id, service_id => $service_id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EnabledProductsApi->get_product_configuration: $@\n";
}

Parameters

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

Return type

ConfiguredProductResponse

Authorization

token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

set_product_configuration

ConfiguredProductResponse set_product_configuration(product_id => $product_id, service_id => $service_id, set_configuration => $set_configuration)

Update configuration for a product

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

Example

use Data::Dumper;
use WebService::Fastly::EnabledProductsApi;
my $api_instance = WebService::Fastly::EnabledProductsApi->new(

    # Configure API key authorization: token
    api_key => {'Fastly-Key' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'Fastly-Key' => 'Bearer'},
);

my $product_id = ngwaf; # string | 
my $service_id = "service_id_example"; # string | Alphanumeric string identifying the service.
my $set_configuration = WebService::Fastly::Object::SetConfiguration->new(); # SetConfiguration | 

eval {
    my $result = $api_instance->set_product_configuration(product_id => $product_id, service_id => $service_id, set_configuration => $set_configuration);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EnabledProductsApi->set_product_configuration: $@\n";
}

Parameters

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

Return type

ConfiguredProductResponse

Authorization

token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

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