EnabledProductsApi.md

Fastly::EnabledProductsApi

require 'fastly'
api_instance = Fastly::EnabledProductsApi.new

Methods

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(opts) # Disable a product

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

Examples

api_instance = Fastly::EnabledProductsApi.new
opts = {
    product_id: 'ngwaf', # String | 
    service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
}

begin
  # Disable a product
  api_instance.disable_product(opts)
rescue Fastly::ApiError => e
  puts "Error when calling EnabledProductsApi->disable_product: #{e}"
end

Options

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

Return type

nil (empty response body)

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

enable_product()

enable_product(opts): <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, and ngwaf.

Examples

api_instance = Fastly::EnabledProductsApi.new
opts = {
    product_id: 'ngwaf', # String | 
    service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
    set_workspace_id: Fastly::SetWorkspaceId.new, # SetWorkspaceId | 
}

begin
  # Enable a product
  result = api_instance.enable_product(opts)
  p result
rescue Fastly::ApiError => e
  puts "Error when calling EnabledProductsApi->enable_product: #{e}"
end

Options

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

Return type

EnabledProductResponse

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

get_enabled_product()

get_enabled_product(opts): <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, and ngwaf.

Examples

api_instance = Fastly::EnabledProductsApi.new
opts = {
    product_id: 'ngwaf', # String | 
    service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
}

begin
  # Get enabled product
  result = api_instance.get_enabled_product(opts)
  p result
rescue Fastly::ApiError => e
  puts "Error when calling EnabledProductsApi->get_enabled_product: #{e}"
end

Options

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

Return type

EnabledProductResponse

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

get_product_configuration()

get_product_configuration(opts): <ConfiguredProductResponse> # Get configuration for a product

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

Examples

api_instance = Fastly::EnabledProductsApi.new
opts = {
    product_id: 'ngwaf', # String | 
    service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
}

begin
  # Get configuration for a product
  result = api_instance.get_product_configuration(opts)
  p result
rescue Fastly::ApiError => e
  puts "Error when calling EnabledProductsApi->get_product_configuration: #{e}"
end

Options

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

Return type

ConfiguredProductResponse

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

set_product_configuration()

set_product_configuration(opts): <ConfiguredProductResponse> # Update configuration for a product

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

Examples

api_instance = Fastly::EnabledProductsApi.new
opts = {
    product_id: 'ngwaf', # String | 
    service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
    set_configuration: Fastly::SetConfiguration.new, # SetConfiguration | 
}

begin
  # Update configuration for a product
  result = api_instance.set_product_configuration(opts)
  p result
rescue Fastly::ApiError => e
  puts "Error when calling EnabledProductsApi->set_product_configuration: #{e}"
end

Options

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

Return type

ConfiguredProductResponse

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