swagger_client.LogForwardApi

All URIs are relative to http://0.0.0.0/v2

Method	HTTP request	Description
create_log_forward	POST /services/haproxy/configuration/log_forwards	Add a log forward
delete_log_forward	DELETE /services/haproxy/configuration/log_forwards/{name}	Delete a log forward
get_log_forward	GET /services/haproxy/configuration/log_forwards/{name}	Return a log forward
get_log_forwards	GET /services/haproxy/configuration/log_forwards	Return an array of log forwards
replace_log_forward	PUT /services/haproxy/configuration/log_forwards/{name}	Replace a log forward

create_log_forward

LogForward create_log_forward(body, transaction_id=transaction_id, version=version, force_reload=force_reload)

Add a log forward

Adds a new log_forward to the configuration file.

Example

from __future__ import print_function
import time
import dataplaneapi
from dataplaneapi.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic_auth
configuration = dataplaneapi.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = dataplaneapi.LogForwardApi(dataplaneapi.ApiClient(configuration))
body = dataplaneapi.LogForward() # LogForward | 
transaction_id = 'transaction_id_example' # str | ID of the transaction where we want to add the operation. Cannot be used when version is specified. (optional)
version = 56 # int | Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. (optional)
force_reload = false # bool | If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. (optional) (default to false)

try:
    # Add a log forward
    api_response = api_instance.create_log_forward(body, transaction_id=transaction_id, version=version, force_reload=force_reload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LogForwardApi->create_log_forward: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	LogForward
transaction_id	str	ID of the transaction where we want to add the operation. Cannot be used when version is specified.	[optional]
version	int	Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version.	[optional]
force_reload	bool	If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration.	[optional] [default to false]

Return type

LogForward

Authorization

basic_auth

HTTP request headers

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

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

delete_log_forward

delete_log_forward(name, transaction_id=transaction_id, version=version, force_reload=force_reload)

Delete a log forward

Deletes a log forward from the configuration by it's name.

Example

from __future__ import print_function
import time
import dataplaneapi
from dataplaneapi.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic_auth
configuration = dataplaneapi.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = dataplaneapi.LogForwardApi(dataplaneapi.ApiClient(configuration))
name = 'name_example' # str | Log Forward name
transaction_id = 'transaction_id_example' # str | ID of the transaction where we want to add the operation. Cannot be used when version is specified. (optional)
version = 56 # int | Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. (optional)
force_reload = false # bool | If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. (optional) (default to false)

try:
    # Delete a log forward
    api_instance.delete_log_forward(name, transaction_id=transaction_id, version=version, force_reload=force_reload)
except ApiException as e:
    print("Exception when calling LogForwardApi->delete_log_forward: %s\n" % e)

Parameters

Name	Type	Description	Notes
name	str	Log Forward name
transaction_id	str	ID of the transaction where we want to add the operation. Cannot be used when version is specified.	[optional]
version	int	Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version.	[optional]
force_reload	bool	If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration.	[optional] [default to false]

Return type

void (empty response body)

Authorization

basic_auth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

get_log_forward

InlineResponse20041 get_log_forward(name, transaction_id=transaction_id)

Return a log forward

Returns one log forward configuration by it's name.

Example

from __future__ import print_function
import time
import dataplaneapi
from dataplaneapi.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic_auth
configuration = dataplaneapi.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = dataplaneapi.LogForwardApi(dataplaneapi.ApiClient(configuration))
name = 'name_example' # str | Log Forward name
transaction_id = 'transaction_id_example' # str | ID of the transaction where we want to add the operation. Cannot be used when version is specified. (optional)

try:
    # Return a log forward
    api_response = api_instance.get_log_forward(name, transaction_id=transaction_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LogForwardApi->get_log_forward: %s\n" % e)

Parameters

Name	Type	Description	Notes
name	str	Log Forward name
transaction_id	str	ID of the transaction where we want to add the operation. Cannot be used when version is specified.	[optional]

Return type

InlineResponse20041

Authorization

basic_auth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

get_log_forwards

InlineResponse20040 get_log_forwards(transaction_id=transaction_id)

Return an array of log forwards

Returns an array of all configured log forwards.

Example

from __future__ import print_function
import time
import dataplaneapi
from dataplaneapi.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic_auth
configuration = dataplaneapi.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = dataplaneapi.LogForwardApi(dataplaneapi.ApiClient(configuration))
transaction_id = 'transaction_id_example' # str | ID of the transaction where we want to add the operation. Cannot be used when version is specified. (optional)

try:
    # Return an array of log forwards
    api_response = api_instance.get_log_forwards(transaction_id=transaction_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LogForwardApi->get_log_forwards: %s\n" % e)

Parameters

Name	Type	Description	Notes
transaction_id	str	ID of the transaction where we want to add the operation. Cannot be used when version is specified.	[optional]

Return type

InlineResponse20040

Authorization

basic_auth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

replace_log_forward

LogForward replace_log_forward(body, name, transaction_id=transaction_id, version=version, force_reload=force_reload)

Replace a log forward

Replaces a log forward configuration by it's name.

Example

from __future__ import print_function
import time
import dataplaneapi
from dataplaneapi.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic_auth
configuration = dataplaneapi.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = dataplaneapi.LogForwardApi(dataplaneapi.ApiClient(configuration))
body = dataplaneapi.LogForward() # LogForward | 
name = 'name_example' # str | Log Forward name
transaction_id = 'transaction_id_example' # str | ID of the transaction where we want to add the operation. Cannot be used when version is specified. (optional)
version = 56 # int | Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. (optional)
force_reload = false # bool | If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. (optional) (default to false)

try:
    # Replace a log forward
    api_response = api_instance.replace_log_forward(body, name, transaction_id=transaction_id, version=version, force_reload=force_reload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LogForwardApi->replace_log_forward: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	LogForward
name	str	Log Forward name
transaction_id	str	ID of the transaction where we want to add the operation. Cannot be used when version is specified.	[optional]
version	int	Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version.	[optional]
force_reload	bool	If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration.	[optional] [default to false]

Return type

LogForward

Authorization

basic_auth

HTTP request headers

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

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

LogForwardApi.md

LogForwardApi.md

swagger_client.LogForwardApi

create_log_forward

Example

Parameters

Return type

Authorization

HTTP request headers

delete_log_forward

Example

Parameters

Return type

Authorization

HTTP request headers

get_log_forward

Example

Parameters

Return type

Authorization

HTTP request headers

get_log_forwards

Example

Parameters

Return type

Authorization

HTTP request headers

replace_log_forward

Example

Parameters

Return type

Authorization

HTTP request headers

Files

LogForwardApi.md

Latest commit

History

LogForwardApi.md

File metadata and controls

swagger_client.LogForwardApi

create_log_forward

Example

Parameters

Return type

Authorization

HTTP request headers

delete_log_forward

Example

Parameters

Return type

Authorization

HTTP request headers

get_log_forward

Example

Parameters

Return type

Authorization

HTTP request headers

get_log_forwards

Example

Parameters

Return type

Authorization

HTTP request headers

replace_log_forward

Example

Parameters

Return type

Authorization

HTTP request headers