RulesApi.md

# quantcdn.RulesApi

All URIs are relative to *https://dashboard.quantcdn.io*

Method | HTTP request | Description
------------- | ------------- | -------------
[**rules_auth_create**](RulesApi.md#rules_auth_create) | **POST** /api/v2/organizations/{organization}/projects/{project}/rules/auth | Create an authentication rule
[**rules_auth_delete**](RulesApi.md#rules_auth_delete) | **DELETE** /api/v2/organizations/{organization}/projects/{project}/rules/auth/{rule} | Delete an authentication rule
[**rules_auth_list**](RulesApi.md#rules_auth_list) | **GET** /api/v2/organizations/{organization}/projects/{project}/rules/auth | List authentication rules
[**rules_auth_read**](RulesApi.md#rules_auth_read) | **GET** /api/v2/organizations/{organization}/projects/{project}/rules/auth/{rule} | Get details of an authentication rule
[**rules_auth_update**](RulesApi.md#rules_auth_update) | **PATCH** /api/v2/organizations/{organization}/projects/{project}/rules/auth/{rule} | Update an authentication rule
[**rules_bot_challenge_create**](RulesApi.md#rules_bot_challenge_create) | **POST** /api/v2/organizations/{organization}/projects/{project}/rules/bot-challenge | Create a bot challenge rule
[**rules_bot_challenge_delete**](RulesApi.md#rules_bot_challenge_delete) | **DELETE** /api/v2/organizations/{organization}/projects/{project}/rules/bot-challenge/{rule} | Delete a bot challenge rule
[**rules_bot_challenge_list**](RulesApi.md#rules_bot_challenge_list) | **GET** /api/v2/organizations/{organization}/projects/{project}/rules/bot-challenge | List bot challenge rules
[**rules_bot_challenge_read**](RulesApi.md#rules_bot_challenge_read) | **GET** /api/v2/organizations/{organization}/projects/{project}/rules/bot-challenge/{rule} | Get details of a bot challenge rule
[**rules_bot_challenge_update**](RulesApi.md#rules_bot_challenge_update) | **PATCH** /api/v2/organizations/{organization}/projects/{project}/rules/bot-challenge/{rule} | Update a bot challenge rule
[**rules_content_filter_create**](RulesApi.md#rules_content_filter_create) | **POST** /api/v2/organizations/{organization}/projects/{project}/rules/content-filter | Create a content filter rule
[**rules_content_filter_delete**](RulesApi.md#rules_content_filter_delete) | **DELETE** /api/v2/organizations/{organization}/projects/{project}/rules/content-filter/{rule} | Delete a content filter rule
[**rules_content_filter_list**](RulesApi.md#rules_content_filter_list) | **GET** /api/v2/organizations/{organization}/projects/{project}/rules/content-filter | List content filter rules
[**rules_content_filter_read**](RulesApi.md#rules_content_filter_read) | **GET** /api/v2/organizations/{organization}/projects/{project}/rules/content-filter/{rule} | Get details of a content filter rule
[**rules_content_filter_update**](RulesApi.md#rules_content_filter_update) | **PATCH** /api/v2/organizations/{organization}/projects/{project}/rules/content-filter/{rule} | Update a content filter rule
[**rules_custom_response_create**](RulesApi.md#rules_custom_response_create) | **POST** /api/v2/organizations/{organization}/projects/{project}/rules/custom-response | Create a custom response rule
[**rules_custom_response_delete**](RulesApi.md#rules_custom_response_delete) | **DELETE** /api/v2/organizations/{organization}/projects/{project}/rules/custom-response/{rule} | Delete a custom response rule
[**rules_custom_response_list**](RulesApi.md#rules_custom_response_list) | **GET** /api/v2/organizations/{organization}/projects/{project}/rules/custom-response | List custom response rules
[**rules_custom_response_read**](RulesApi.md#rules_custom_response_read) | **GET** /api/v2/organizations/{organization}/projects/{project}/rules/custom-response/{rule} | Get details of a custom response rule
[**rules_custom_response_update**](RulesApi.md#rules_custom_response_update) | **PATCH** /api/v2/organizations/{organization}/projects/{project}/rules/custom-response/{rule} | Update a custom response rule
[**rules_function_create**](RulesApi.md#rules_function_create) | **POST** /api/v2/organizations/{organization}/projects/{project}/rules/function | Create an edge function rule
[**rules_function_delete**](RulesApi.md#rules_function_delete) | **DELETE** /api/v2/organizations/{organization}/projects/{project}/rules/function/{rule} | Delete an edge function rule
[**rules_function_list**](RulesApi.md#rules_function_list) | **GET** /api/v2/organizations/{organization}/projects/{project}/rules/function | List edge function rules
[**rules_function_read**](RulesApi.md#rules_function_read) | **GET** /api/v2/organizations/{organization}/projects/{project}/rules/function/{rule} | Get details of an edge function rule
[**rules_function_update**](RulesApi.md#rules_function_update) | **PATCH** /api/v2/organizations/{organization}/projects/{project}/rules/function/{rule} | Update an edge function rule
[**rules_headers_create**](RulesApi.md#rules_headers_create) | **POST** /api/v2/organizations/{organization}/projects/{project}/rules/headers | Create a header rule
[**rules_headers_delete**](RulesApi.md#rules_headers_delete) | **DELETE** /api/v2/organizations/{organization}/projects/{project}/rules/headers/{rule} | Delete a header rule
[**rules_headers_list**](RulesApi.md#rules_headers_list) | **GET** /api/v2/organizations/{organization}/projects/{project}/rules/headers | List header rules
[**rules_headers_read**](RulesApi.md#rules_headers_read) | **GET** /api/v2/organizations/{organization}/projects/{project}/rules/headers/{rule} | Get details of a header rule
[**rules_headers_update**](RulesApi.md#rules_headers_update) | **PATCH** /api/v2/organizations/{organization}/projects/{project}/rules/headers/{rule} | Update a header rule
[**rules_proxy_create**](RulesApi.md#rules_proxy_create) | **POST** /api/v2/organizations/{organization}/projects/{project}/rules/proxy | Create a proxy rule
[**rules_proxy_delete**](RulesApi.md#rules_proxy_delete) | **DELETE** /api/v2/organizations/{organization}/projects/{project}/rules/proxy/{rule} | Delete a proxy rule
[**rules_proxy_list**](RulesApi.md#rules_proxy_list) | **GET** /api/v2/organizations/{organization}/projects/{project}/rules/proxy | List proxy rules
[**rules_proxy_read**](RulesApi.md#rules_proxy_read) | **GET** /api/v2/organizations/{organization}/projects/{project}/rules/proxy/{rule} | Get details of a proxy rule
[**rules_proxy_update**](RulesApi.md#rules_proxy_update) | **PATCH** /api/v2/organizations/{organization}/projects/{project}/rules/proxy/{rule} | Update a proxy rule
[**rules_redirect_create**](RulesApi.md#rules_redirect_create) | **POST** /api/v2/organizations/{organization}/projects/{project}/rules/redirect | Create a redirect rule
[**rules_redirect_delete**](RulesApi.md#rules_redirect_delete) | **DELETE** /api/v2/organizations/{organization}/projects/{project}/rules/redirect/{rule} | Delete a redirect rule
[**rules_redirect_list**](RulesApi.md#rules_redirect_list) | **GET** /api/v2/organizations/{organization}/projects/{project}/rules/redirect | List redirect rules
[**rules_redirect_read**](RulesApi.md#rules_redirect_read) | **GET** /api/v2/organizations/{organization}/projects/{project}/rules/redirect/{rule} | Get details of a redirect rule
[**rules_redirect_update**](RulesApi.md#rules_redirect_update) | **PATCH** /api/v2/organizations/{organization}/projects/{project}/rules/redirect/{rule} | Update a redirect rule
[**rules_serve_static_create**](RulesApi.md#rules_serve_static_create) | **POST** /api/v2/organizations/{organization}/projects/{project}/rules/serve-static | Create a serve static rule
[**rules_serve_static_delete**](RulesApi.md#rules_serve_static_delete) | **DELETE** /api/v2/organizations/{organization}/projects/{project}/rules/serve-static/{rule} | Delete a serve static rule
[**rules_serve_static_list**](RulesApi.md#rules_serve_static_list) | **GET** /api/v2/organizations/{organization}/projects/{project}/rules/serve-static | List serve static rules
[**rules_serve_static_read**](RulesApi.md#rules_serve_static_read) | **GET** /api/v2/organizations/{organization}/projects/{project}/rules/serve-static/{rule} | Get details of a serve static rule
[**rules_serve_static_update**](RulesApi.md#rules_serve_static_update) | **PATCH** /api/v2/organizations/{organization}/projects/{project}/rules/serve-static/{rule} | Update a serve static rule


# **rules_auth_create**
> V2RuleAuth rules_auth_create(organization, project, v2_rule_auth_request)

Create an authentication rule

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
import quantcdn
from quantcdn.models.v2_rule_auth import V2RuleAuth
from quantcdn.models.v2_rule_auth_request import V2RuleAuthRequest
from quantcdn.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://dashboard.quantcdn.io
# See configuration.py for a list of all supported configuration parameters.
configuration = quantcdn.Configuration(
    host = "https://dashboard.quantcdn.io"
)

# 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 Bearer authorization (JWT): BearerAuth
configuration = quantcdn.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with quantcdn.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = quantcdn.RulesApi(api_client)
    organization = 'organization_example' # str | Organization identifier
    project = 'project_example' # str | Project identifier
    v2_rule_auth_request = quantcdn.V2RuleAuthRequest() # V2RuleAuthRequest | 

    try:
        # Create an authentication rule
        api_response = api_instance.rules_auth_create(organization, project, v2_rule_auth_request)
        print("The response of RulesApi->rules_auth_create:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RulesApi->rules_auth_create: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **organization** | **str**| Organization identifier | 
 **project** | **str**| Project identifier | 
 **v2_rule_auth_request** | [**V2RuleAuthRequest**](V2RuleAuthRequest.md)|  | 

### Return type

[**V2RuleAuth**](V2RuleAuth.md)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

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

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | The request has succeeded. |  -  |
**400** | The server could not understand the request due to invalid syntax. |  -  |
**403** | Access is forbidden. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **rules_auth_delete**
> rules_auth_delete(organization, project, rule)

Delete an authentication rule

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
import quantcdn
from quantcdn.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://dashboard.quantcdn.io
# See configuration.py for a list of all supported configuration parameters.
configuration = quantcdn.Configuration(
    host = "https://dashboard.quantcdn.io"
)

# 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 Bearer authorization (JWT): BearerAuth
configuration = quantcdn.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with quantcdn.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = quantcdn.RulesApi(api_client)
    organization = 'organization_example' # str | Organization identifier
    project = 'project_example' # str | Project identifier
    rule = 'rule_example' # str | Rule identifier

    try:
        # Delete an authentication rule
        api_instance.rules_auth_delete(organization, project, rule)
    except Exception as e:
        print("Exception when calling RulesApi->rules_auth_delete: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **organization** | **str**| Organization identifier | 
 **project** | **str**| Project identifier | 
 **rule** | **str**| Rule identifier | 

### Return type

void (empty response body)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

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

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**204** | The request has succeeded. |  -  |
**400** | The server could not understand the request due to invalid syntax. |  -  |
**403** | Access is forbidden. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **rules_auth_list**
> List[V2RuleAuth] rules_auth_list(organization, project)

List authentication rules

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
import quantcdn
from quantcdn.models.v2_rule_auth import V2RuleAuth
from quantcdn.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://dashboard.quantcdn.io
# See configuration.py for a list of all supported configuration parameters.
configuration = quantcdn.Configuration(
    host = "https://dashboard.quantcdn.io"
)

# 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 Bearer authorization (JWT): BearerAuth
configuration = quantcdn.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with quantcdn.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = quantcdn.RulesApi(api_client)
    organization = 'organization_example' # str | Organization identifier
    project = 'project_example' # str | Project identifier

    try:
        # List authentication rules
        api_response = api_instance.rules_auth_list(organization, project)
        print("The response of RulesApi->rules_auth_list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RulesApi->rules_auth_list: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **organization** | **str**| Organization identifier | 
 **project** | **str**| Project identifier | 

### Return type

[**List[V2RuleAuth]**](V2RuleAuth.md)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

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

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | The request has succeeded. |  -  |
**400** | The server could not understand the request due to invalid syntax. |  -  |
**403** | Access is forbidden. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **rules_auth_read**
> V2RuleAuth rules_auth_read(organization, project, rule)

Get details of an authentication rule

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
import quantcdn
from quantcdn.models.v2_rule_auth import V2RuleAuth
from quantcdn.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://dashboard.quantcdn.io
# See configuration.py for a list of all supported configuration parameters.
configuration = quantcdn.Configuration(
    host = "https://dashboard.quantcdn.io"
)

# 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 Bearer authorization (JWT): BearerAuth
configuration = quantcdn.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with quantcdn.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = quantcdn.RulesApi(api_client)
    organization = 'organization_example' # str | Organization identifier
    project = 'project_example' # str | Project identifier
    rule = 'rule_example' # str | Rule identifier

    try:
        # Get details of an authentication rule
        api_response = api_instance.rules_auth_read(organization, project, rule)
        print("The response of RulesApi->rules_auth_read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RulesApi->rules_auth_read: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **organization** | **str**| Organization identifier | 
 **project** | **str**| Project identifier | 
 **rule** | **str**| Rule identifier | 

### Return type

[**V2RuleAuth**](V2RuleAuth.md)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

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

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | The request has succeeded. |  -  |
**400** | The server could not understand the request due to invalid syntax. |  -  |
**403** | Access is forbidden. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **rules_auth_update**
> V2RuleAuth rules_auth_update(organization, project, rule, v2_rule_auth_request)

Update an authentication rule

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
import quantcdn
from quantcdn.models.v2_rule_auth import V2RuleAuth
from quantcdn.models.v2_rule_auth_request import V2RuleAuthRequest
from quantcdn.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://dashboard.quantcdn.io
# See configuration.py for a list of all supported configuration parameters.
configuration = quantcdn.Configuration(
    host = "https://dashboard.quantcdn.io"
)

# 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 Bearer authorization (JWT): BearerAuth
configuration = quantcdn.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with quantcdn.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = quantcdn.RulesApi(api_client)
    organization = 'organization_example' # str | Organization identifier
    project = 'project_example' # str | Project identifier
    rule = 'rule_example' # str | Rule identifier
    v2_rule_auth_request = quantcdn.V2RuleAuthRequest() # V2RuleAuthRequest | 

    try:
        # Update an authentication rule
        api_response = api_instance.rules_auth_update(organization, project, rule, v2_rule_auth_request)
        print("The response of RulesApi->rules_auth_update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RulesApi->rules_auth_update: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **organization** | **str**| Organization identifier | 
 **project** | **str**| Project identifier | 
 **rule** | **str**| Rule identifier | 
 **v2_rule_auth_request** | [**V2RuleAuthRequest**](V2RuleAuthRequest.md)|  | 

### Return type

[**V2RuleAuth**](V2RuleAuth.md)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

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

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | The request has succeeded. |  -  |
**400** | The server could not understand the request due to invalid syntax. |  -  |
**403** | Access is forbidden. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **rules_bot_challenge_create**
> V2RuleBotChallenge rules_bot_challenge_create(organization, project, v2_rule_bot_challenge_request)

Create a bot challenge rule

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
import quantcdn
from quantcdn.models.v2_rule_bot_challenge import V2RuleBotChallenge
from quantcdn.models.v2_rule_bot_challenge_request import V2RuleBotChallengeRequest
from quantcdn.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://dashboard.quantcdn.io
# See configuration.py for a list of all supported configuration parameters.
configuration = quantcdn.Configuration(
    host = "https://dashboard.quantcdn.io"
)

# 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 Bearer authorization (JWT): BearerAuth
configuration = quantcdn.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with quantcdn.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = quantcdn.RulesApi(api_client)
    organization = 'organization_example' # str | Organization identifier
    project = 'project_example' # str | Project identifier
    v2_rule_bot_challenge_request = quantcdn.V2RuleBotChallengeRequest() # V2RuleBotChallengeRequest | 

    try:
        # Create a bot challenge rule
        api_response = api_instance.rules_bot_challenge_create(organization, project, v2_rule_bot_challenge_request)
        print("The response of RulesApi->rules_bot_challenge_create:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RulesApi->rules_bot_challenge_create: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **organization** | **str**| Organization identifier | 
 **project** | **str**| Project identifier | 
 **v2_rule_bot_challenge_request** | [**V2RuleBotChallengeRequest**](V2RuleBotChallengeRequest.md)|  | 

### Return type

[**V2RuleBotChallenge**](V2RuleBotChallenge.md)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

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

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | The request has succeeded. |  -  |
**400** | The server could not understand the request due to invalid syntax. |  -  |
**403** | Access is forbidden. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **rules_bot_challenge_delete**
> rules_bot_challenge_delete(organization, project, rule)

Delete a bot challenge rule

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
import quantcdn
from quantcdn.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://dashboard.quantcdn.io
# See configuration.py for a list of all supported configuration parameters.
configuration = quantcdn.Configuration(
    host = "https://dashboard.quantcdn.io"
)

# 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 Bearer authorization (JWT): BearerAuth
configuration = quantcdn.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with quantcdn.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = quantcdn.RulesApi(api_client)
    organization = 'organization_example' # str | Organization identifier
    project = 'project_example' # str | Project identifier
    rule = 'rule_example' # str | Rule identifier

    try:
        # Delete a bot challenge rule
        api_instance.rules_bot_challenge_delete(organization, project, rule)
    except Exception as e:
        print("Exception when calling RulesApi->rules_bot_challenge_delete: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **organization** | **str**| Organization identifier | 
 **project** | **str**| Project identifier | 
 **rule** | **str**| Rule identifier | 

### Return type

void (empty response body)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

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

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**204** | The request has succeeded. |  -  |
**400** | The server could not understand the request due to invalid syntax. |  -  |
**403** | Access is forbidden. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **rules_bot_challenge_list**
> List[V2RuleBotChallenge] rules_bot_challenge_list(organization, project)

List bot challenge rules

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
import quantcdn
from quantcdn.models.v2_rule_bot_challenge import V2RuleBotChallenge
from quantcdn.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://dashboard.quantcdn.io
# See configuration.py for a list of all supported configuration parameters.
configuration = quantcdn.Configuration(
    host = "https://dashboard.quantcdn.io"
)

# 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 Bearer authorization (JWT): BearerAuth
configuration = quantcdn.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with quantcdn.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = quantcdn.RulesApi(api_client)
    organization = 'organization_example' # str | Organization identifier
    project = 'project_example' # str | Project identifier

    try:
        # List bot challenge rules
        api_response = api_instance.rules_bot_challenge_list(organization, project)
        print("The response of RulesApi->rules_bot_challenge_list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RulesApi->rules_bot_challenge_list: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **organization** | **str**| Organization identifier | 
 **project** | **str**| Project identifier | 

### Return type

[**List[V2RuleBotChallenge]**](V2RuleBotChallenge.md)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

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

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | The request has succeeded. |  -  |
**400** | The server could not understand the request due to invalid syntax. |  -  |
**403** | Access is forbidden. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **rules_bot_challenge_read**
> V2RuleBotChallenge rules_bot_challenge_read(organization, project, rule)

Get details of a bot challenge rule

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
import quantcdn
from quantcdn.models.v2_rule_bot_challenge import V2RuleBotChallenge
from quantcdn.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://dashboard.quantcdn.io
# See configuration.py for a list of all supported configuration parameters.
configuration = quantcdn.Configuration(
    host = "https://dashboard.quantcdn.io"
)

# 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 Bearer authorization (JWT): BearerAuth
configuration = quantcdn.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with quantcdn.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = quantcdn.RulesApi(api_client)
    organization = 'organization_example' # str | Organization identifier
    project = 'project_example' # str | Project identifier
    rule = 'rule_example' # str | Rule identifier

    try:
        # Get details of a bot challenge rule
        api_response = api_instance.rules_bot_challenge_read(organization, project, rule)
        print("The response of RulesApi->rules_bot_challenge_read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RulesApi->rules_bot_challenge_read: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **organization** | **str**| Organization identifier | 
 **project** | **str**| Project identifier | 
 **rule** | **str**| Rule identifier | 

### Return type

[**V2RuleBotChallenge**](V2RuleBotChallenge.md)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

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

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | The request has succeeded. |  -  |
**400** | The server could not understand the request due to invalid syntax. |  -  |
**403** | Access is forbidden. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **rules_bot_challenge_update**
> V2RuleBotChallenge rules_bot_challenge_update(organization, project, rule, v2_rule_bot_challenge_request)

Update a bot challenge rule

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
import quantcdn
from quantcdn.models.v2_rule_bot_challenge import V2RuleBotChallenge
from quantcdn.models.v2_rule_bot_challenge_request import V2RuleBotChallengeRequest
from quantcdn.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://dashboard.quantcdn.io
# See configuration.py for a list of all supported configuration parameters.
configuration = quantcdn.Configuration(
    host = "https://dashboard.quantcdn.io"
)

# 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 Bearer authorization (JWT): BearerAuth
configuration = quantcdn.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with quantcdn.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = quantcdn.RulesApi(api_client)
    organization = 'organization_example' # str | Organization identifier
    project = 'project_example' # str | Project identifier
    rule = 'rule_example' # str | Rule identifier
    v2_rule_bot_challenge_request = quantcdn.V2RuleBotChallengeRequest() # V2RuleBotChallengeRequest | 

    try:
        # Update a bot challenge rule
        api_response = api_instance.rules_bot_challenge_update(organization, project, rule, v2_rule_bot_challenge_request)
        print("The response of RulesApi->rules_bot_challenge_update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RulesApi->rules_bot_challenge_update: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **organization** | **str**| Organization identifier | 
 **project** | **str**| Project identifier | 
 **rule** | **str**| Rule identifier | 
 **v2_rule_bot_challenge_request** | [**V2RuleBotChallengeRequest**](V2RuleBotChallengeRequest.md)|  | 

### Return type

[**V2RuleBotChallenge**](V2RuleBotChallenge.md)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

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

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | The request has succeeded. |  -  |
**400** | The server could not understand the request due to invalid syntax. |  -  |
**403** | Access is forbidden. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **rules_content_filter_create**
> V2RuleContentFilter rules_content_filter_create(organization, project, v2_rule_content_filter_request)

Create a content filter rule

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
import quantcdn
from quantcdn.models.v2_rule_content_filter import V2RuleContentFilter
from quantcdn.models.v2_rule_content_filter_request import V2RuleContentFilterRequest
from quantcdn.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://dashboard.quantcdn.io
# See configuration.py for a list of all supported configuration parameters.
configuration = quantcdn.Configuration(
    host = "https://dashboard.quantcdn.io"
)

# 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 Bearer authorization (JWT): BearerAuth
configuration = quantcdn.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with quantcdn.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = quantcdn.RulesApi(api_client)
    organization = 'organization_example' # str | Organization identifier
    project = 'project_example' # str | Project identifier
    v2_rule_content_filter_request = quantcdn.V2RuleContentFilterRequest() # V2RuleContentFilterRequest | 

    try:
        # Create a content filter rule
        api_response = api_instance.rules_content_filter_create(organization, project, v2_rule_content_filter_request)
        print("The response of RulesApi->rules_content_filter_create:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RulesApi->rules_content_filter_create: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **organization** | **str**| Organization identifier | 
 **project** | **str**| Project identifier | 
 **v2_rule_content_filter_request** | [**V2RuleContentFilterRequest**](V2RuleContentFilterRequest.md)|  | 

### Return type

[**V2RuleContentFilter**](V2RuleContentFilter.md)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

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

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | The request has succeeded. |  -  |
**400** | The server could not understand the request due to invalid syntax. |  -  |
**403** | Access is forbidden. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **rules_content_filter_delete**
> rules_content_filter_delete(organization, project, rule)

Delete a content filter rule

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
import quantcdn
from quantcdn.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://dashboard.quantcdn.io
# See configuration.py for a list of all supported configuration parameters.
configuration = quantcdn.Configuration(
    host = "https://dashboard.quantcdn.io"
)

# 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 Bearer authorization (JWT): BearerAuth
configuration = quantcdn.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with quantcdn.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = quantcdn.RulesApi(api_client)
    organization = 'organization_example' # str | Organization identifier
    project = 'project_example' # str | Project identifier
    rule = 'rule_example' # str | Rule identifier

    try:
        # Delete a content filter rule
        api_instance.rules_content_filter_delete(organization, project, rule)
    except Exception as e:
        print("Exception when calling RulesApi->rules_content_filter_delete: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **organization** | **str**| Organization identifier | 
 **project** | **str**| Project identifier | 
 **rule** | **str**| Rule identifier | 

### Return type

void (empty response body)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

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

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**204** | The request has succeeded. |  -  |
**400** | The server could not understand the request due to invalid syntax. |  -  |
**403** | Access is forbidden. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **rules_content_filter_list**
> List[V2RuleContentFilter] rules_content_filter_list(organization, project)

List content filter rules

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
import quantcdn
from quantcdn.models.v2_rule_content_filter import V2RuleContentFilter
from quantcdn.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://dashboard.quantcdn.io
# See configuration.py for a list of all supported configuration parameters.
configuration = quantcdn.Configuration(
    host = "https://dashboard.quantcdn.io"
)

# 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 Bearer authorization (JWT): BearerAuth
configuration = quantcdn.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with quantcdn.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = quantcdn.RulesApi(api_client)
    organization = 'organization_example' # str | Organization identifier
    project = 'project_example' # str | Project identifier

    try:
        # List content filter rules
        api_response = api_instance.rules_content_filter_list(organization, project)
        print("The response of RulesApi->rules_content_filter_list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RulesApi->rules_content_filter_list: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **organization** | **str**| Organization identifier | 
 **project** | **str**| Project identifier | 

### Return type

[**List[V2RuleContentFilter]**](V2RuleContentFilter.md)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

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

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | The request has succeeded. |  -  |
**400** | The server could not understand the request due to invalid syntax. |  -  |
**403** | Access is forbidden. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **rules_content_filter_read**
> V2RuleContentFilter rules_content_filter_read(organization, project, rule)

Get details of a content filter rule

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
import quantcdn
from quantcdn.models.v2_rule_content_filter import V2RuleContentFilter
from quantcdn.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://dashboard.quantcdn.io
# See configuration.py for a list of all supported configuration parameters.
configuration = quantcdn.Configuration(
    host = "https://dashboard.quantcdn.io"
)

# 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 Bearer authorization (JWT): BearerAuth
configuration = quantcdn.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with quantcdn.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = quantcdn.RulesApi(api_client)
    organization = 'organization_example' # str | Organization identifier
    project = 'project_example' # str | Project identifier
    rule = 'rule_example' # str | Rule identifier

    try:
        # Get details of a content filter rule
        api_response = api_instance.rules_content_filter_read(organization, project, rule)
        print("The response of RulesApi->rules_content_filter_read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RulesApi->rules_content_filter_read: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **organization** | **str**| Organization identifier | 
 **project** | **str**| Project identifier | 
 **rule** | **str**| Rule identifier | 

### Return type

[**V2RuleContentFilter**](V2RuleContentFilter.md)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

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

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | The request has succeeded. |  -  |
**400** | The server could not understand the request due to invalid syntax. |  -  |
**403** | Access is forbidden. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **rules_content_filter_update**
> V2RuleContentFilter rules_content_filter_update(organization, project, rule, v2_rule_content_filter_request)

Update a content filter rule

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
import quantcdn
from quantcdn.models.v2_rule_content_filter import V2RuleContentFilter
from quantcdn.models.v2_rule_content_filter_request import V2RuleContentFilterRequest
from quantcdn.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://dashboard.quantcdn.io
# See configuration.py for a list of all supported configuration parameters.
configuration = quantcdn.Configuration(
    host = "https://dashboard.quantcdn.io"
)

# 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 Bearer authorization (JWT): BearerAuth
configuration = quantcdn.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with quantcdn.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = quantcdn.RulesApi(api_client)
    organization = 'organization_example' # str | Organization identifier
    project = 'project_example' # str | Project identifier
    rule = 'rule_example' # str | Rule identifier
    v2_rule_content_filter_request = quantcdn.V2RuleContentFilterRequest() # V2RuleContentFilterRequest | 

    try:
        # Update a content filter rule
        api_response = api_instance.rules_content_filter_update(organization, project, rule, v2_rule_content_filter_request)
        print("The response of RulesApi->rules_content_filter_update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RulesApi->rules_content_filter_update: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **organization** | **str**| Organization identifier | 
 **project** | **str**| Project identifier | 
 **rule** | **str**| Rule identifier | 
 **v2_rule_content_filter_request** | [**V2RuleContentFilterRequest**](V2RuleContentFilterRequest.md)|  | 

### Return type

[**V2RuleContentFilter**](V2RuleContentFilter.md)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

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

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | The request has succeeded. |  -  |
**400** | The server could not understand the request due to invalid syntax. |  -  |
**403** | Access is forbidden. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **rules_custom_response_create**
> V2RuleCustomResponse rules_custom_response_create(organization, project, v2_rule_custom_response_request)

Create a custom response rule

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
import quantcdn
from quantcdn.models.v2_rule_custom_response import V2RuleCustomResponse
from quantcdn.models.v2_rule_custom_response_request import V2RuleCustomResponseRequest
from quantcdn.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://dashboard.quantcdn.io
# See configuration.py for a list of all supported configuration parameters.
configuration = quantcdn.Configuration(
    host = "https://dashboard.quantcdn.io"
)

# 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 Bearer authorization (JWT): BearerAuth
configuration = quantcdn.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with quantcdn.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = quantcdn.RulesApi(api_client)
    organization = 'organization_example' # str | Organization identifier
    project = 'project_example' # str | Project identifier
    v2_rule_custom_response_request = quantcdn.V2RuleCustomResponseRequest() # V2RuleCustomResponseRequest | 

    try:
        # Create a custom response rule
        api_response = api_instance.rules_custom_response_create(organization, project, v2_rule_custom_response_request)
        print("The response of RulesApi->rules_custom_response_create:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RulesApi->rules_custom_response_create: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **organization** | **str**| Organization identifier | 
 **project** | **str**| Project identifier | 
 **v2_rule_custom_response_request** | [**V2RuleCustomResponseRequest**](V2RuleCustomResponseRequest.md)|  | 

### Return type

[**V2RuleCustomResponse**](V2RuleCustomResponse.md)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

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

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | The request has succeeded. |  -  |
**400** | The server could not understand the request due to invalid syntax. |  -  |
**403** | Access is forbidden. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **rules_custom_response_delete**
> rules_custom_response_delete(organization, project, rule)

Delete a custom response rule

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
import quantcdn
from quantcdn.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://dashboard.quantcdn.io
# See configuration.py for a list of all supported configuration parameters.
configuration = quantcdn.Configuration(
    host = "https://dashboard.quantcdn.io"
)

# 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 Bearer authorization (JWT): BearerAuth
configuration = quantcdn.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with quantcdn.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = quantcdn.RulesApi(api_client)
    organization = 'organization_example' # str | Organization identifier
    project = 'project_example' # str | Project identifier
    rule = 'rule_example' # str | Rule identifier

    try:
        # Delete a custom response rule
        api_instance.rules_custom_response_delete(organization, project, rule)
    except Exception as e:
        print("Exception when calling RulesApi->rules_custom_response_delete: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **organization** | **str**| Organization identifier | 
 **project** | **str**| Project identifier | 
 **rule** | **str**| Rule identifier | 

### Return type

void (empty response body)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

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

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**204** | The request has succeeded. |  -  |
**400** | The server could not understand the request due to invalid syntax. |  -  |
**403** | Access is forbidden. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **rules_custom_response_list**
> List[V2RuleCustomResponse] rules_custom_response_list(organization, project)

List custom response rules

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
import quantcdn
from quantcdn.models.v2_rule_custom_response import V2RuleCustomResponse
from quantcdn.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://dashboard.quantcdn.io
# See configuration.py for a list of all supported configuration parameters.
configuration = quantcdn.Configuration(
    host = "https://dashboard.quantcdn.io"
)

# 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 Bearer authorization (JWT): BearerAuth
configuration = quantcdn.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with quantcdn.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = quantcdn.RulesApi(api_client)
    organization = 'organization_example' # str | Organization identifier
    project = 'project_example' # str | Project identifier

    try:
        # List custom response rules
        api_response = api_instance.rules_custom_response_list(organization, project)
        print("The response of RulesApi->rules_custom_response_list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RulesApi->rules_custom_response_list: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **organization** | **str**| Organization identifier | 
 **project** | **str**| Project identifier | 

### Return type

[**List[V2RuleCustomResponse]**](V2RuleCustomResponse.md)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

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

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | The request has succeeded. |  -  |
**400** | The server could not understand the request due to invalid syntax. |  -  |
**403** | Access is forbidden. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **rules_custom_response_read**
> V2RuleCustomResponse rules_custom_response_read(organization, project, rule)

Get details of a custom response rule

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
import quantcdn
from quantcdn.models.v2_rule_custom_response import V2RuleCustomResponse
from quantcdn.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://dashboard.quantcdn.io
# See configuration.py for a list of all supported configuration parameters.
configuration = quantcdn.Configuration(
    host = "https://dashboard.quantcdn.io"
)

# 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 Bearer authorization (JWT): BearerAuth
configuration = quantcdn.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with quantcdn.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = quantcdn.RulesApi(api_client)
    organization = 'organization_example' # str | Organization identifier
    project = 'project_example' # str | Project identifier
    rule = 'rule_example' # str | Rule identifier

    try:
        # Get details of a custom response rule
        api_response = api_instance.rules_custom_response_read(organization, project, rule)
        print("The response of RulesApi->rules_custom_response_read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RulesApi->rules_custom_response_read: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **organization** | **str**| Organization identifier | 
 **project** | **str**| Project identifier | 
 **rule** | **str**| Rule identifier | 

### Return type

[**V2RuleCustomResponse**](V2RuleCustomResponse.md)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

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

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | The request has succeeded. |  -  |
**400** | The server could not understand the request due to invalid syntax. |  -  |
**403** | Access is forbidden. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **rules_custom_response_update**
> V2RuleCustomResponse rules_custom_response_update(organization, project, rule, v2_rule_custom_response_request)

Update a custom response rule

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
import quantcdn
from quantcdn.models.v2_rule_custom_response import V2RuleCustomResponse
from quantcdn.models.v2_rule_custom_response_request import V2RuleCustomResponseRequest
from quantcdn.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://dashboard.quantcdn.io
# See configuration.py for a list of all supported configuration parameters.
configuration = quantcdn.Configuration(
    host = "https://dashboard.quantcdn.io"
)

# 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 Bearer authorization (JWT): BearerAuth
configuration = quantcdn.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with quantcdn.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = quantcdn.RulesApi(api_client)
    organization = 'organization_example' # str | Organization identifier
    project = 'project_example' # str | Project identifier
    rule = 'rule_example' # str | Rule identifier
    v2_rule_custom_response_request = quantcdn.V2RuleCustomResponseRequest() # V2RuleCustomResponseRequest | 

    try:
        # Update a custom response rule
        api_response = api_instance.rules_custom_response_update(organization, project, rule, v2_rule_custom_response_request)
        print("The response of RulesApi->rules_custom_response_update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RulesApi->rules_custom_response_update: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **organization** | **str**| Organization identifier | 
 **project** | **str**| Project identifier | 
 **rule** | **str**| Rule identifier | 
 **v2_rule_custom_response_request** | [**V2RuleCustomResponseRequest**](V2RuleCustomResponseRequest.md)|  | 

### Return type

[**V2RuleCustomResponse**](V2RuleCustomResponse.md)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

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

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | The request has succeeded. |  -  |
**400** | The server could not understand the request due to invalid syntax. |  -  |
**403** | Access is forbidden. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **rules_function_create**
> V2RuleFunction rules_function_create(organization, project, v2_rule_function_request)

Create an edge function rule

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
import quantcdn
from quantcdn.models.v2_rule_function import V2RuleFunction
from quantcdn.models.v2_rule_function_request import V2RuleFunctionRequest
from quantcdn.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://dashboard.quantcdn.io
# See configuration.py for a list of all supported configuration parameters.
configuration = quantcdn.Configuration(
    host = "https://dashboard.quantcdn.io"
)

# 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 Bearer authorization (JWT): BearerAuth
configuration = quantcdn.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with quantcdn.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = quantcdn.RulesApi(api_client)
    organization = 'organization_example' # str | Organization identifier
    project = 'project_example' # str | Project identifier
    v2_rule_function_request = quantcdn.V2RuleFunctionRequest() # V2RuleFunctionRequest | 

    try:
        # Create an edge function rule
        api_response = api_instance.rules_function_create(organization, project, v2_rule_function_request)
        print("The response of RulesApi->rules_function_create:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RulesApi->rules_function_create: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **organization** | **str**| Organization identifier | 
 **project** | **str**| Project identifier | 
 **v2_rule_function_request** | [**V2RuleFunctionRequest**](V2RuleFunctionRequest.md)|  | 

### Return type

[**V2RuleFunction**](V2RuleFunction.md)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

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

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | The request has succeeded. |  -  |
**400** | The server could not understand the request due to invalid syntax. |  -  |
**403** | Access is forbidden. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **rules_function_delete**
> rules_function_delete(organization, project, rule)

Delete an edge function rule

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
import quantcdn
from quantcdn.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://dashboard.quantcdn.io
# See configuration.py for a list of all supported configuration parameters.
configuration = quantcdn.Configuration(
    host = "https://dashboard.quantcdn.io"
)

# 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 Bearer authorization (JWT): BearerAuth
configuration = quantcdn.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with quantcdn.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = quantcdn.RulesApi(api_client)
    organization = 'organization_example' # str | Organization identifier
    project = 'project_example' # str | Project identifier
    rule = 'rule_example' # str | Rule identifier

    try:
        # Delete an edge function rule
        api_instance.rules_function_delete(organization, project, rule)
    except Exception as e:
        print("Exception when calling RulesApi->rules_function_delete: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **organization** | **str**| Organization identifier | 
 **project** | **str**| Project identifier | 
 **rule** | **str**| Rule identifier | 

### Return type

void (empty response body)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

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

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**204** | The request has succeeded. |  -  |
**400** | The server could not understand the request due to invalid syntax. |  -  |
**403** | Access is forbidden. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **rules_function_list**
> List[V2RuleFunction] rules_function_list(organization, project)

List edge function rules

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
import quantcdn
from quantcdn.models.v2_rule_function import V2RuleFunction
from quantcdn.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://dashboard.quantcdn.io
# See configuration.py for a list of all supported configuration parameters.
configuration = quantcdn.Configuration(
    host = "https://dashboard.quantcdn.io"
)

# 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 Bearer authorization (JWT): BearerAuth
configuration = quantcdn.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with quantcdn.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = quantcdn.RulesApi(api_client)
    organization = 'organization_example' # str | Organization identifier
    project = 'project_example' # str | Project identifier

    try:
        # List edge function rules
        api_response = api_instance.rules_function_list(organization, project)
        print("The response of RulesApi->rules_function_list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RulesApi->rules_function_list: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **organization** | **str**| Organization identifier | 
 **project** | **str**| Project identifier | 

### Return type

[**List[V2RuleFunction]**](V2RuleFunction.md)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

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

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | The request has succeeded. |  -  |
**400** | The server could not understand the request due to invalid syntax. |  -  |
**403** | Access is forbidden. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **rules_function_read**
> V2RuleFunction rules_function_read(organization, project, rule)

Get details of an edge function rule

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
import quantcdn
from quantcdn.models.v2_rule_function import V2RuleFunction
from quantcdn.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://dashboard.quantcdn.io
# See configuration.py for a list of all supported configuration parameters.
configuration = quantcdn.Configuration(
    host = "https://dashboard.quantcdn.io"
)

# 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 Bearer authorization (JWT): BearerAuth
configuration = quantcdn.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with quantcdn.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = quantcdn.RulesApi(api_client)
    organization = 'organization_example' # str | Organization identifier
    project = 'project_example' # str | Project identifier
    rule = 'rule_example' # str | Rule identifier

    try:
        # Get details of an edge function rule
        api_response = api_instance.rules_function_read(organization, project, rule)
        print("The response of RulesApi->rules_function_read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RulesApi->rules_function_read: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **organization** | **str**| Organization identifier | 
 **project** | **str**| Project identifier | 
 **rule** | **str**| Rule identifier | 

### Return type

[**V2RuleFunction**](V2RuleFunction.md)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

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

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | The request has succeeded. |  -  |
**400** | The server could not understand the request due to invalid syntax. |  -  |
**403** | Access is forbidden. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **rules_function_update**
> V2RuleFunction rules_function_update(organization, project, rule, v2_rule_function_request)

Update an edge function rule

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
import quantcdn
from quantcdn.models.v2_rule_function import V2RuleFunction
from quantcdn.models.v2_rule_function_request import V2RuleFunctionRequest
from quantcdn.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://dashboard.quantcdn.io
# See configuration.py for a list of all supported configuration parameters.
configuration = quantcdn.Configuration(
    host = "https://dashboard.quantcdn.io"
)

# 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 Bearer authorization (JWT): BearerAuth
configuration = quantcdn.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with quantcdn.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = quantcdn.RulesApi(api_client)
    organization = 'organization_example' # str | Organization identifier
    project = 'project_example' # str | Project identifier
    rule = 'rule_example' # str | Rule identifier
    v2_rule_function_request = quantcdn.V2RuleFunctionRequest() # V2RuleFunctionRequest | 

    try:
        # Update an edge function rule
        api_response = api_instance.rules_function_update(organization, project, rule, v2_rule_function_request)
        print("The response of RulesApi->rules_function_update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RulesApi->rules_function_update: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **organization** | **str**| Organization identifier | 
 **project** | **str**| Project identifier | 
 **rule** | **str**| Rule identifier | 
 **v2_rule_function_request** | [**V2RuleFunctionRequest**](V2RuleFunctionRequest.md)|  | 

### Return type

[**V2RuleFunction**](V2RuleFunction.md)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

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

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | The request has succeeded. |  -  |
**400** | The server could not understand the request due to invalid syntax. |  -  |
**403** | Access is forbidden. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **rules_headers_create**
> V2RuleHeader rules_headers_create(organization, project, v2_rule_header_request)

Create a header rule

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
import quantcdn
from quantcdn.models.v2_rule_header import V2RuleHeader
from quantcdn.models.v2_rule_header_request import V2RuleHeaderRequest
from quantcdn.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://dashboard.quantcdn.io
# See configuration.py for a list of all supported configuration parameters.
configuration = quantcdn.Configuration(
    host = "https://dashboard.quantcdn.io"
)

# 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 Bearer authorization (JWT): BearerAuth
configuration = quantcdn.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with quantcdn.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = quantcdn.RulesApi(api_client)
    organization = 'organization_example' # str | Organization identifier
    project = 'project_example' # str | Project identifier
    v2_rule_header_request = quantcdn.V2RuleHeaderRequest() # V2RuleHeaderRequest | 

    try:
        # Create a header rule
        api_response = api_instance.rules_headers_create(organization, project, v2_rule_header_request)
        print("The response of RulesApi->rules_headers_create:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RulesApi->rules_headers_create: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **organization** | **str**| Organization identifier | 
 **project** | **str**| Project identifier | 
 **v2_rule_header_request** | [**V2RuleHeaderRequest**](V2RuleHeaderRequest.md)|  | 

### Return type

[**V2RuleHeader**](V2RuleHeader.md)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

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

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | The request has succeeded. |  -  |
**400** | The server could not understand the request due to invalid syntax. |  -  |
**403** | Access is forbidden. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **rules_headers_delete**
> rules_headers_delete(organization, project, rule)

Delete a header rule

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
import quantcdn
from quantcdn.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://dashboard.quantcdn.io
# See configuration.py for a list of all supported configuration parameters.
configuration = quantcdn.Configuration(
    host = "https://dashboard.quantcdn.io"
)

# 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 Bearer authorization (JWT): BearerAuth
configuration = quantcdn.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with quantcdn.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = quantcdn.RulesApi(api_client)
    organization = 'organization_example' # str | Organization identifier
    project = 'project_example' # str | Project identifier
    rule = 'rule_example' # str | Rule identifier

    try:
        # Delete a header rule
        api_instance.rules_headers_delete(organization, project, rule)
    except Exception as e:
        print("Exception when calling RulesApi->rules_headers_delete: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **organization** | **str**| Organization identifier | 
 **project** | **str**| Project identifier | 
 **rule** | **str**| Rule identifier | 

### Return type

void (empty response body)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

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

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**204** | The request has succeeded. |  -  |
**400** | The server could not understand the request due to invalid syntax. |  -  |
**403** | Access is forbidden. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **rules_headers_list**
> List[V2RuleHeader] rules_headers_list(organization, project)

List header rules

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
import quantcdn
from quantcdn.models.v2_rule_header import V2RuleHeader
from quantcdn.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://dashboard.quantcdn.io
# See configuration.py for a list of all supported configuration parameters.
configuration = quantcdn.Configuration(
    host = "https://dashboard.quantcdn.io"
)

# 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 Bearer authorization (JWT): BearerAuth
configuration = quantcdn.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with quantcdn.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = quantcdn.RulesApi(api_client)
    organization = 'organization_example' # str | Organization identifier
    project = 'project_example' # str | Project identifier

    try:
        # List header rules
        api_response = api_instance.rules_headers_list(organization, project)
        print("The response of RulesApi->rules_headers_list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RulesApi->rules_headers_list: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **organization** | **str**| Organization identifier | 
 **project** | **str**| Project identifier | 

### Return type

[**List[V2RuleHeader]**](V2RuleHeader.md)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

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

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | The request has succeeded. |  -  |
**400** | The server could not understand the request due to invalid syntax. |  -  |
**403** | Access is forbidden. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **rules_headers_read**
> V2RuleHeader rules_headers_read(organization, project, rule)

Get details of a header rule

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
import quantcdn
from quantcdn.models.v2_rule_header import V2RuleHeader
from quantcdn.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://dashboard.quantcdn.io
# See configuration.py for a list of all supported configuration parameters.
configuration = quantcdn.Configuration(
    host = "https://dashboard.quantcdn.io"
)

# 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 Bearer authorization (JWT): BearerAuth
configuration = quantcdn.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with quantcdn.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = quantcdn.RulesApi(api_client)
    organization = 'organization_example' # str | Organization identifier
    project = 'project_example' # str | Project identifier
    rule = 'rule_example' # str | Rule identifier

    try:
        # Get details of a header rule
        api_response = api_instance.rules_headers_read(organization, project, rule)
        print("The response of RulesApi->rules_headers_read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RulesApi->rules_headers_read: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **organization** | **str**| Organization identifier | 
 **project** | **str**| Project identifier | 
 **rule** | **str**| Rule identifier | 

### Return type

[**V2RuleHeader**](V2RuleHeader.md)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

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

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | The request has succeeded. |  -  |
**400** | The server could not understand the request due to invalid syntax. |  -  |
**403** | Access is forbidden. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **rules_headers_update**
> V2RuleHeader rules_headers_update(organization, project, rule, v2_rule_header_request)

Update a header rule

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
import quantcdn
from quantcdn.models.v2_rule_header import V2RuleHeader
from quantcdn.models.v2_rule_header_request import V2RuleHeaderRequest
from quantcdn.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://dashboard.quantcdn.io
# See configuration.py for a list of all supported configuration parameters.
configuration = quantcdn.Configuration(
    host = "https://dashboard.quantcdn.io"
)

# 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 Bearer authorization (JWT): BearerAuth
configuration = quantcdn.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with quantcdn.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = quantcdn.RulesApi(api_client)
    organization = 'organization_example' # str | Organization identifier
    project = 'project_example' # str | Project identifier
    rule = 'rule_example' # str | Rule identifier
    v2_rule_header_request = quantcdn.V2RuleHeaderRequest() # V2RuleHeaderRequest | 

    try:
        # Update a header rule
        api_response = api_instance.rules_headers_update(organization, project, rule, v2_rule_header_request)
        print("The response of RulesApi->rules_headers_update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RulesApi->rules_headers_update: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **organization** | **str**| Organization identifier | 
 **project** | **str**| Project identifier | 
 **rule** | **str**| Rule identifier | 
 **v2_rule_header_request** | [**V2RuleHeaderRequest**](V2RuleHeaderRequest.md)|  | 

### Return type

[**V2RuleHeader**](V2RuleHeader.md)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

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

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | The request has succeeded. |  -  |
**400** | The server could not understand the request due to invalid syntax. |  -  |
**403** | Access is forbidden. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **rules_proxy_create**
> V2RuleProxy rules_proxy_create(organization, project, v2_rule_proxy_request)

Create a proxy rule

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
import quantcdn
from quantcdn.models.v2_rule_proxy import V2RuleProxy
from quantcdn.models.v2_rule_proxy_request import V2RuleProxyRequest
from quantcdn.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://dashboard.quantcdn.io
# See configuration.py for a list of all supported configuration parameters.
configuration = quantcdn.Configuration(
    host = "https://dashboard.quantcdn.io"
)

# 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 Bearer authorization (JWT): BearerAuth
configuration = quantcdn.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with quantcdn.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = quantcdn.RulesApi(api_client)
    organization = 'organization_example' # str | 
    project = 'project_example' # str | 
    v2_rule_proxy_request = quantcdn.V2RuleProxyRequest() # V2RuleProxyRequest | 

    try:
        # Create a proxy rule
        api_response = api_instance.rules_proxy_create(organization, project, v2_rule_proxy_request)
        print("The response of RulesApi->rules_proxy_create:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RulesApi->rules_proxy_create: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **organization** | **str**|  | 
 **project** | **str**|  | 
 **v2_rule_proxy_request** | [**V2RuleProxyRequest**](V2RuleProxyRequest.md)|  | 

### Return type

[**V2RuleProxy**](V2RuleProxy.md)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

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

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**201** | The request has succeeded and a new resource has been created as a result. |  -  |
**400** | The server could not understand the request due to invalid syntax. |  -  |
**403** | Access is forbidden. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **rules_proxy_delete**
> rules_proxy_delete(organization, project, rule)

Delete a proxy rule

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
import quantcdn
from quantcdn.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://dashboard.quantcdn.io
# See configuration.py for a list of all supported configuration parameters.
configuration = quantcdn.Configuration(
    host = "https://dashboard.quantcdn.io"
)

# 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 Bearer authorization (JWT): BearerAuth
configuration = quantcdn.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with quantcdn.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = quantcdn.RulesApi(api_client)
    organization = 'organization_example' # str | 
    project = 'project_example' # str | 
    rule = 'rule_example' # str | 

    try:
        # Delete a proxy rule
        api_instance.rules_proxy_delete(organization, project, rule)
    except Exception as e:
        print("Exception when calling RulesApi->rules_proxy_delete: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **organization** | **str**|  | 
 **project** | **str**|  | 
 **rule** | **str**|  | 

### Return type

void (empty response body)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

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

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**204** | The request has succeeded. |  -  |
**400** | The server could not understand the request due to invalid syntax. |  -  |
**403** | Access is forbidden. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **rules_proxy_list**
> List[V2RuleProxy] rules_proxy_list(organization, project)

List proxy rules

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
import quantcdn
from quantcdn.models.v2_rule_proxy import V2RuleProxy
from quantcdn.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://dashboard.quantcdn.io
# See configuration.py for a list of all supported configuration parameters.
configuration = quantcdn.Configuration(
    host = "https://dashboard.quantcdn.io"
)

# 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 Bearer authorization (JWT): BearerAuth
configuration = quantcdn.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with quantcdn.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = quantcdn.RulesApi(api_client)
    organization = 'organization_example' # str | 
    project = 'project_example' # str | 

    try:
        # List proxy rules
        api_response = api_instance.rules_proxy_list(organization, project)
        print("The response of RulesApi->rules_proxy_list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RulesApi->rules_proxy_list: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **organization** | **str**|  | 
 **project** | **str**|  | 

### Return type

[**List[V2RuleProxy]**](V2RuleProxy.md)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

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

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | The request has succeeded. |  -  |
**400** | The server could not understand the request due to invalid syntax. |  -  |
**403** | Access is forbidden. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **rules_proxy_read**
> V2RuleProxy rules_proxy_read(organization, project, rule)

Get details of a proxy rule

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
import quantcdn
from quantcdn.models.v2_rule_proxy import V2RuleProxy
from quantcdn.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://dashboard.quantcdn.io
# See configuration.py for a list of all supported configuration parameters.
configuration = quantcdn.Configuration(
    host = "https://dashboard.quantcdn.io"
)

# 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 Bearer authorization (JWT): BearerAuth
configuration = quantcdn.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with quantcdn.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = quantcdn.RulesApi(api_client)
    organization = 'organization_example' # str | 
    project = 'project_example' # str | 
    rule = 'rule_example' # str | 

    try:
        # Get details of a proxy rule
        api_response = api_instance.rules_proxy_read(organization, project, rule)
        print("The response of RulesApi->rules_proxy_read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RulesApi->rules_proxy_read: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **organization** | **str**|  | 
 **project** | **str**|  | 
 **rule** | **str**|  | 

### Return type

[**V2RuleProxy**](V2RuleProxy.md)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

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

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | The request has succeeded. |  -  |
**400** | The server could not understand the request due to invalid syntax. |  -  |
**403** | Access is forbidden. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **rules_proxy_update**
> V2RuleProxy rules_proxy_update(organization, project, rule, v2_rule_proxy_request)

Update a proxy rule

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
import quantcdn
from quantcdn.models.v2_rule_proxy import V2RuleProxy
from quantcdn.models.v2_rule_proxy_request import V2RuleProxyRequest
from quantcdn.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://dashboard.quantcdn.io
# See configuration.py for a list of all supported configuration parameters.
configuration = quantcdn.Configuration(
    host = "https://dashboard.quantcdn.io"
)

# 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 Bearer authorization (JWT): BearerAuth
configuration = quantcdn.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with quantcdn.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = quantcdn.RulesApi(api_client)
    organization = 'organization_example' # str | 
    project = 'project_example' # str | 
    rule = 'rule_example' # str | 
    v2_rule_proxy_request = quantcdn.V2RuleProxyRequest() # V2RuleProxyRequest | 

    try:
        # Update a proxy rule
        api_response = api_instance.rules_proxy_update(organization, project, rule, v2_rule_proxy_request)
        print("The response of RulesApi->rules_proxy_update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RulesApi->rules_proxy_update: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **organization** | **str**|  | 
 **project** | **str**|  | 
 **rule** | **str**|  | 
 **v2_rule_proxy_request** | [**V2RuleProxyRequest**](V2RuleProxyRequest.md)|  | 

### Return type

[**V2RuleProxy**](V2RuleProxy.md)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

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

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | The request has succeeded. |  -  |
**400** | The server could not understand the request due to invalid syntax. |  -  |
**403** | Access is forbidden. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **rules_redirect_create**
> V2RuleRedirect rules_redirect_create(organization, project, v2_rule_redirect_request)

Create a redirect rule

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
import quantcdn
from quantcdn.models.v2_rule_redirect import V2RuleRedirect
from quantcdn.models.v2_rule_redirect_request import V2RuleRedirectRequest
from quantcdn.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://dashboard.quantcdn.io
# See configuration.py for a list of all supported configuration parameters.
configuration = quantcdn.Configuration(
    host = "https://dashboard.quantcdn.io"
)

# 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 Bearer authorization (JWT): BearerAuth
configuration = quantcdn.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with quantcdn.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = quantcdn.RulesApi(api_client)
    organization = 'organization_example' # str | 
    project = 'project_example' # str | 
    v2_rule_redirect_request = quantcdn.V2RuleRedirectRequest() # V2RuleRedirectRequest | 

    try:
        # Create a redirect rule
        api_response = api_instance.rules_redirect_create(organization, project, v2_rule_redirect_request)
        print("The response of RulesApi->rules_redirect_create:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RulesApi->rules_redirect_create: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **organization** | **str**|  | 
 **project** | **str**|  | 
 **v2_rule_redirect_request** | [**V2RuleRedirectRequest**](V2RuleRedirectRequest.md)|  | 

### Return type

[**V2RuleRedirect**](V2RuleRedirect.md)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

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

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | The request has succeeded. |  -  |
**400** | The server could not understand the request due to invalid syntax. |  -  |
**403** | Access is forbidden. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **rules_redirect_delete**
> rules_redirect_delete(organization, project, rule)

Delete a redirect rule

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
import quantcdn
from quantcdn.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://dashboard.quantcdn.io
# See configuration.py for a list of all supported configuration parameters.
configuration = quantcdn.Configuration(
    host = "https://dashboard.quantcdn.io"
)

# 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 Bearer authorization (JWT): BearerAuth
configuration = quantcdn.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with quantcdn.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = quantcdn.RulesApi(api_client)
    organization = 'organization_example' # str | 
    project = 'project_example' # str | 
    rule = 'rule_example' # str | 

    try:
        # Delete a redirect rule
        api_instance.rules_redirect_delete(organization, project, rule)
    except Exception as e:
        print("Exception when calling RulesApi->rules_redirect_delete: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **organization** | **str**|  | 
 **project** | **str**|  | 
 **rule** | **str**|  | 

### Return type

void (empty response body)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

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

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**204** | The request has succeeded. |  -  |
**400** | The server could not understand the request due to invalid syntax. |  -  |
**403** | Access is forbidden. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **rules_redirect_list**
> List[V2RuleRedirect] rules_redirect_list(organization, project)

List redirect rules

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
import quantcdn
from quantcdn.models.v2_rule_redirect import V2RuleRedirect
from quantcdn.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://dashboard.quantcdn.io
# See configuration.py for a list of all supported configuration parameters.
configuration = quantcdn.Configuration(
    host = "https://dashboard.quantcdn.io"
)

# 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 Bearer authorization (JWT): BearerAuth
configuration = quantcdn.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with quantcdn.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = quantcdn.RulesApi(api_client)
    organization = 'organization_example' # str | 
    project = 'project_example' # str | 

    try:
        # List redirect rules
        api_response = api_instance.rules_redirect_list(organization, project)
        print("The response of RulesApi->rules_redirect_list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RulesApi->rules_redirect_list: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **organization** | **str**|  | 
 **project** | **str**|  | 

### Return type

[**List[V2RuleRedirect]**](V2RuleRedirect.md)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

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

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | The request has succeeded. |  -  |
**400** | The server could not understand the request due to invalid syntax. |  -  |
**403** | Access is forbidden. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **rules_redirect_read**
> V2RuleRedirect rules_redirect_read(organization, project, rule)

Get details of a redirect rule

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
import quantcdn
from quantcdn.models.v2_rule_redirect import V2RuleRedirect
from quantcdn.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://dashboard.quantcdn.io
# See configuration.py for a list of all supported configuration parameters.
configuration = quantcdn.Configuration(
    host = "https://dashboard.quantcdn.io"
)

# 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 Bearer authorization (JWT): BearerAuth
configuration = quantcdn.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with quantcdn.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = quantcdn.RulesApi(api_client)
    organization = 'organization_example' # str | 
    project = 'project_example' # str | 
    rule = 'rule_example' # str | 

    try:
        # Get details of a redirect rule
        api_response = api_instance.rules_redirect_read(organization, project, rule)
        print("The response of RulesApi->rules_redirect_read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RulesApi->rules_redirect_read: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **organization** | **str**|  | 
 **project** | **str**|  | 
 **rule** | **str**|  | 

### Return type

[**V2RuleRedirect**](V2RuleRedirect.md)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

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

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | The request has succeeded. |  -  |
**400** | The server could not understand the request due to invalid syntax. |  -  |
**403** | Access is forbidden. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **rules_redirect_update**
> V2RuleRedirect rules_redirect_update(organization, project, rule, v2_rule_redirect_request)

Update a redirect rule

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
import quantcdn
from quantcdn.models.v2_rule_redirect import V2RuleRedirect
from quantcdn.models.v2_rule_redirect_request import V2RuleRedirectRequest
from quantcdn.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://dashboard.quantcdn.io
# See configuration.py for a list of all supported configuration parameters.
configuration = quantcdn.Configuration(
    host = "https://dashboard.quantcdn.io"
)

# 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 Bearer authorization (JWT): BearerAuth
configuration = quantcdn.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with quantcdn.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = quantcdn.RulesApi(api_client)
    organization = 'organization_example' # str | 
    project = 'project_example' # str | 
    rule = 'rule_example' # str | 
    v2_rule_redirect_request = quantcdn.V2RuleRedirectRequest() # V2RuleRedirectRequest | 

    try:
        # Update a redirect rule
        api_response = api_instance.rules_redirect_update(organization, project, rule, v2_rule_redirect_request)
        print("The response of RulesApi->rules_redirect_update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RulesApi->rules_redirect_update: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **organization** | **str**|  | 
 **project** | **str**|  | 
 **rule** | **str**|  | 
 **v2_rule_redirect_request** | [**V2RuleRedirectRequest**](V2RuleRedirectRequest.md)|  | 

### Return type

[**V2RuleRedirect**](V2RuleRedirect.md)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

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

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | The request has succeeded. |  -  |
**400** | The server could not understand the request due to invalid syntax. |  -  |
**403** | Access is forbidden. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **rules_serve_static_create**
> V2RuleServeStatic rules_serve_static_create(organization, project, v2_rule_serve_static_request)

Create a serve static rule

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
import quantcdn
from quantcdn.models.v2_rule_serve_static import V2RuleServeStatic
from quantcdn.models.v2_rule_serve_static_request import V2RuleServeStaticRequest
from quantcdn.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://dashboard.quantcdn.io
# See configuration.py for a list of all supported configuration parameters.
configuration = quantcdn.Configuration(
    host = "https://dashboard.quantcdn.io"
)

# 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 Bearer authorization (JWT): BearerAuth
configuration = quantcdn.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with quantcdn.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = quantcdn.RulesApi(api_client)
    organization = 'organization_example' # str | Organization identifier
    project = 'project_example' # str | Project identifier
    v2_rule_serve_static_request = quantcdn.V2RuleServeStaticRequest() # V2RuleServeStaticRequest | 

    try:
        # Create a serve static rule
        api_response = api_instance.rules_serve_static_create(organization, project, v2_rule_serve_static_request)
        print("The response of RulesApi->rules_serve_static_create:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RulesApi->rules_serve_static_create: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **organization** | **str**| Organization identifier | 
 **project** | **str**| Project identifier | 
 **v2_rule_serve_static_request** | [**V2RuleServeStaticRequest**](V2RuleServeStaticRequest.md)|  | 

### Return type

[**V2RuleServeStatic**](V2RuleServeStatic.md)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

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

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | The request has succeeded. |  -  |
**400** | The server could not understand the request due to invalid syntax. |  -  |
**403** | Access is forbidden. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **rules_serve_static_delete**
> rules_serve_static_delete(organization, project, rule)

Delete a serve static rule

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
import quantcdn
from quantcdn.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://dashboard.quantcdn.io
# See configuration.py for a list of all supported configuration parameters.
configuration = quantcdn.Configuration(
    host = "https://dashboard.quantcdn.io"
)

# 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 Bearer authorization (JWT): BearerAuth
configuration = quantcdn.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with quantcdn.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = quantcdn.RulesApi(api_client)
    organization = 'organization_example' # str | Organization identifier
    project = 'project_example' # str | Project identifier
    rule = 'rule_example' # str | Rule identifier

    try:
        # Delete a serve static rule
        api_instance.rules_serve_static_delete(organization, project, rule)
    except Exception as e:
        print("Exception when calling RulesApi->rules_serve_static_delete: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **organization** | **str**| Organization identifier | 
 **project** | **str**| Project identifier | 
 **rule** | **str**| Rule identifier | 

### Return type

void (empty response body)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

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

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**204** | The request has succeeded. |  -  |
**400** | The server could not understand the request due to invalid syntax. |  -  |
**403** | Access is forbidden. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **rules_serve_static_list**
> List[V2RuleServeStatic] rules_serve_static_list(organization, project)

List serve static rules

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
import quantcdn
from quantcdn.models.v2_rule_serve_static import V2RuleServeStatic
from quantcdn.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://dashboard.quantcdn.io
# See configuration.py for a list of all supported configuration parameters.
configuration = quantcdn.Configuration(
    host = "https://dashboard.quantcdn.io"
)

# 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 Bearer authorization (JWT): BearerAuth
configuration = quantcdn.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with quantcdn.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = quantcdn.RulesApi(api_client)
    organization = 'organization_example' # str | Organization identifier
    project = 'project_example' # str | Project identifier

    try:
        # List serve static rules
        api_response = api_instance.rules_serve_static_list(organization, project)
        print("The response of RulesApi->rules_serve_static_list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RulesApi->rules_serve_static_list: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **organization** | **str**| Organization identifier | 
 **project** | **str**| Project identifier | 

### Return type

[**List[V2RuleServeStatic]**](V2RuleServeStatic.md)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

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

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | The request has succeeded. |  -  |
**400** | The server could not understand the request due to invalid syntax. |  -  |
**403** | Access is forbidden. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **rules_serve_static_read**
> V2RuleServeStatic rules_serve_static_read(organization, project, rule)

Get details of a serve static rule

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
import quantcdn
from quantcdn.models.v2_rule_serve_static import V2RuleServeStatic
from quantcdn.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://dashboard.quantcdn.io
# See configuration.py for a list of all supported configuration parameters.
configuration = quantcdn.Configuration(
    host = "https://dashboard.quantcdn.io"
)

# 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 Bearer authorization (JWT): BearerAuth
configuration = quantcdn.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with quantcdn.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = quantcdn.RulesApi(api_client)
    organization = 'organization_example' # str | Organization identifier
    project = 'project_example' # str | Project identifier
    rule = 'rule_example' # str | Rule identifier

    try:
        # Get details of a serve static rule
        api_response = api_instance.rules_serve_static_read(organization, project, rule)
        print("The response of RulesApi->rules_serve_static_read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RulesApi->rules_serve_static_read: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **organization** | **str**| Organization identifier | 
 **project** | **str**| Project identifier | 
 **rule** | **str**| Rule identifier | 

### Return type

[**V2RuleServeStatic**](V2RuleServeStatic.md)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

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

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | The request has succeeded. |  -  |
**400** | The server could not understand the request due to invalid syntax. |  -  |
**403** | Access is forbidden. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **rules_serve_static_update**
> V2RuleServeStatic rules_serve_static_update(organization, project, rule, v2_rule_serve_static_request)

Update a serve static rule

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
import quantcdn
from quantcdn.models.v2_rule_serve_static import V2RuleServeStatic
from quantcdn.models.v2_rule_serve_static_request import V2RuleServeStaticRequest
from quantcdn.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://dashboard.quantcdn.io
# See configuration.py for a list of all supported configuration parameters.
configuration = quantcdn.Configuration(
    host = "https://dashboard.quantcdn.io"
)

# 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 Bearer authorization (JWT): BearerAuth
configuration = quantcdn.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with quantcdn.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = quantcdn.RulesApi(api_client)
    organization = 'organization_example' # str | Organization identifier
    project = 'project_example' # str | Project identifier
    rule = 'rule_example' # str | Rule identifier
    v2_rule_serve_static_request = quantcdn.V2RuleServeStaticRequest() # V2RuleServeStaticRequest | 

    try:
        # Update a serve static rule
        api_response = api_instance.rules_serve_static_update(organization, project, rule, v2_rule_serve_static_request)
        print("The response of RulesApi->rules_serve_static_update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RulesApi->rules_serve_static_update: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **organization** | **str**| Organization identifier | 
 **project** | **str**| Project identifier | 
 **rule** | **str**| Rule identifier | 
 **v2_rule_serve_static_request** | [**V2RuleServeStaticRequest**](V2RuleServeStaticRequest.md)|  | 

### Return type

[**V2RuleServeStatic**](V2RuleServeStatic.md)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

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

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | The request has succeeded. |  -  |
**400** | The server could not understand the request due to invalid syntax. |  -  |
**403** | Access is forbidden. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)