ProductBotManagementApi.md

Fastly::ProductBotManagementApi

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

Methods

Note

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

Method	HTTP request	Description
disable_product_bot_management	DELETE /enabled-products/v1/bot_management/services/{service_id}	Disable product
enable_product_bot_management	PUT /enabled-products/v1/bot_management/services/{service_id}	Enable product
get_product_bot_management	GET /enabled-products/v1/bot_management/services/{service_id}	Get product enablement status
get_product_bot_management_configuration	GET /enabled-products/v1/bot_management/services/{service_id}/configuration	Get configuration
get_services_product_bot_management	GET /enabled-products/v1/bot_management/services	Get services with product enabled
set_product_bot_management_configuration	PATCH /enabled-products/v1/bot_management/services/{service_id}/configuration	Update configuration

disable_product_bot_management()

disable_product_bot_management(opts) # Disable product

Disable the Bot Management product on a service.

Examples

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

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

Options

Name	Type	Description	Notes
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_bot_management()

enable_product_bot_management(opts): <BotManagementResponseBodyEnable> # Enable product

Enable the Bot Management product on a service.

Examples

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

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

Options

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

Return type

BotManagementResponseBodyEnable

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

get_product_bot_management()

get_product_bot_management(opts): <BotManagementResponseBodyEnable> # Get product enablement status

Get the enablement status of the Bot Management product on a service.

Examples

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

begin
  # Get product enablement status
  result = api_instance.get_product_bot_management(opts)
  p result
rescue Fastly::ApiError => e
  puts "Error when calling ProductBotManagementApi->get_product_bot_management: #{e}"
end

Options

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

Return type

BotManagementResponseBodyEnable

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

get_product_bot_management_configuration()

get_product_bot_management_configuration(opts): <BotManagementResponseConfigure> # Get configuration

Get the configuration of the Bot Management product on a service.

Examples

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

begin
  # Get configuration
  result = api_instance.get_product_bot_management_configuration(opts)
  p result
rescue Fastly::ApiError => e
  puts "Error when calling ProductBotManagementApi->get_product_bot_management_configuration: #{e}"
end

Options

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

Return type

BotManagementResponseConfigure

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

get_services_product_bot_management()

get_services_product_bot_management: <BotManagementResponseBodyGetAllServices> # Get services with product enabled

Get all the services which have the Bot Management product enabled.

Examples

api_instance = Fastly::ProductBotManagementApi.new

begin
  # Get services with product enabled
  result = api_instance.get_services_product_bot_management
  p result
rescue Fastly::ApiError => e
  puts "Error when calling ProductBotManagementApi->get_services_product_bot_management: #{e}"
end

Options

This endpoint does not need any parameter.

Return type

BotManagementResponseBodyGetAllServices

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

set_product_bot_management_configuration()

set_product_bot_management_configuration(opts): <BotManagementResponseConfigure> # Update configuration

Update the configuration of the Bot Management product on a service.

Examples

api_instance = Fastly::ProductBotManagementApi.new
opts = {
    service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
    bot_management_request_update_configuration: Fastly::BotManagementRequestUpdateConfiguration.new({contentguard: 'false'}), # BotManagementRequestUpdateConfiguration | 
}

begin
  # Update configuration
  result = api_instance.set_product_bot_management_configuration(opts)
  p result
rescue Fastly::ApiError => e
  puts "Error when calling ProductBotManagementApi->set_product_bot_management_configuration: #{e}"
end

Options

Name	Type	Description	Notes
service_id	String	Alphanumeric string identifying the service.
bot_management_request_update_configuration	BotManagementRequestUpdateConfiguration		[optional]

Return type

BotManagementResponseConfigure

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