ProductNgwafApi.md

Fastly::ProductNgwafApi

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

Methods

Note

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

Method	HTTP request	Description
disable_product_ngwaf	DELETE /enabled-products/v1/ngwaf/services/{service_id}	Disable product
enable_product_ngwaf	PUT /enabled-products/v1/ngwaf/services/{service_id}	Enable product
get_product_ngwaf	GET /enabled-products/v1/ngwaf/services/{service_id}	Get product enablement status
get_product_ngwaf_configuration	GET /enabled-products/v1/ngwaf/services/{service_id}/configuration	Get configuration
set_product_ngwaf_configuration	PATCH /enabled-products/v1/ngwaf/services/{service_id}/configuration	Update configuration

disable_product_ngwaf()

disable_product_ngwaf(opts) # Disable product

Disable the Next-Gen WAF product on a service.

Examples

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

begin
  # Disable product
  api_instance.disable_product_ngwaf(opts)
rescue Fastly::ApiError => e
  puts "Error when calling ProductNgwafApi->disable_product_ngwaf: #{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_ngwaf()

enable_product_ngwaf(opts): <NgwafResponseEnable> # Enable product

Enable the Next-Gen WAF product on a service.

Examples

api_instance = Fastly::ProductNgwafApi.new
opts = {
    service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
    ngwaf_request_enable: Fastly::NgwafRequestEnable.new({workspace_id: 'workspace_id_example'}), # NgwafRequestEnable | 
}

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

Options

Name	Type	Description	Notes
service_id	String	Alphanumeric string identifying the service.
ngwaf_request_enable	NgwafRequestEnable		[optional]

Return type

NgwafResponseEnable

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

get_product_ngwaf()

get_product_ngwaf(opts): <NgwafResponseEnable> # Get product enablement status

Get the enablement status of the Next-Gen WAF product on a service.

Examples

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

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

Options

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

Return type

NgwafResponseEnable

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

get_product_ngwaf_configuration()

get_product_ngwaf_configuration(opts): <NgwafResponseConfigure> # Get configuration

Get configuration of the Next-Gen WAF product on a service.

Examples

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

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

Options

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

Return type

NgwafResponseConfigure

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

set_product_ngwaf_configuration()

set_product_ngwaf_configuration(opts): <NgwafResponseConfigure> # Update configuration

Update configuration of the Next-Gen WAF product on a service.

Examples

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

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

Options

Name	Type	Description	Notes
service_id	String	Alphanumeric string identifying the service.
ngwaf_request_update_configuration	NgwafRequestUpdateConfiguration		[optional]

Return type

NgwafResponseConfigure

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