Skip to content

Latest commit

 

History

History
244 lines (168 loc) · 8 KB

ProductBotManagementApi.md

File metadata and controls

244 lines (168 loc) · 8 KB

fastly.ProductBotManagementApi

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

disable_product_bot_management

disable_product_bot_management(service_id)

Disable product

Disable the Bot Management product on a service.

Example

  • Api Key Authentication (token):
import time
import fastly
from fastly.api import product_bot_management_api
from pprint import pprint
# Defining the host is optional and defaults to https://api.fastly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = fastly.Configuration(
    host = "https://api.fastly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: token
configuration.api_key['token'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['token'] = 'Bearer'

# Enter a context with an instance of the API client
with fastly.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = product_bot_management_api.ProductBotManagementApi(api_client)
    service_id = "SU1Z0isxPaozGVKXdv0eY" # str | Alphanumeric string identifying the service.

    # example passing only required values which don't have defaults set
    try:
        # Disable product
        api_instance.disable_product_bot_management(service_id)
    except fastly.ApiException as e:
        print("Exception when calling ProductBotManagementApi->disable_product_bot_management: %s\n" % e)

Parameters

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

Return type

void (empty response body)

Authorization

token

HTTP request headers

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

HTTP response details

Status code Description Response headers
204 No Content -

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

enable_product_bot_management

BotManagementResponseBodyEnable enable_product_bot_management(service_id)

Enable product

Enable the Bot Management product on a service.

Example

  • Api Key Authentication (token):
import time
import fastly
from fastly.api import product_bot_management_api
from fastly.model.bot_management_response_body_enable import BotManagementResponseBodyEnable
from pprint import pprint
# Defining the host is optional and defaults to https://api.fastly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = fastly.Configuration(
    host = "https://api.fastly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: token
configuration.api_key['token'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['token'] = 'Bearer'

# Enter a context with an instance of the API client
with fastly.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = product_bot_management_api.ProductBotManagementApi(api_client)
    service_id = "SU1Z0isxPaozGVKXdv0eY" # str | Alphanumeric string identifying the service.

    # example passing only required values which don't have defaults set
    try:
        # Enable product
        api_response = api_instance.enable_product_bot_management(service_id)
        pprint(api_response)
    except fastly.ApiException as e:
        print("Exception when calling ProductBotManagementApi->enable_product_bot_management: %s\n" % e)

Parameters

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

Return type

BotManagementResponseBodyEnable

Authorization

token

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -

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

get_product_bot_management

BotManagementResponseBodyEnable get_product_bot_management(service_id)

Get product enablement status

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

Example

  • Api Key Authentication (token):
import time
import fastly
from fastly.api import product_bot_management_api
from fastly.model.bot_management_response_body_enable import BotManagementResponseBodyEnable
from pprint import pprint
# Defining the host is optional and defaults to https://api.fastly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = fastly.Configuration(
    host = "https://api.fastly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: token
configuration.api_key['token'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['token'] = 'Bearer'

# Enter a context with an instance of the API client
with fastly.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = product_bot_management_api.ProductBotManagementApi(api_client)
    service_id = "SU1Z0isxPaozGVKXdv0eY" # str | Alphanumeric string identifying the service.

    # example passing only required values which don't have defaults set
    try:
        # Get product enablement status
        api_response = api_instance.get_product_bot_management(service_id)
        pprint(api_response)
    except fastly.ApiException as e:
        print("Exception when calling ProductBotManagementApi->get_product_bot_management: %s\n" % e)

Parameters

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

Return type

BotManagementResponseBodyEnable

Authorization

token

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -

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