scc_firewall_manager_sdk.TransactionsApi¶

All URIs are relative to the base URL, which depends on the region your organization is deployed to.

Region	Base URL
US	https://api.us.security.cisco.com/firewall
EU	https://api.eu.security.cisco.com/firewall
APJ	https://api.apj.security.cisco.com/firewall
AU	https://api.au.security.cisco.com/firewall
IN	https://api.in.security.cisco.com/firewall
UAE	https://api.uae.security.cisco.com/firewall

Method	HTTP request	Description
cancel_transaction	POST /v1/transactions/{transactionUid}/cancel	Cancel Transaction
get_transaction	GET /v1/transactions/{transactionUid}	Get Transaction

cancel_transaction¶

CdoTransaction cancel_transaction(transaction_uid)

Cancel Transaction

Cancel a running transaction. Note:: Only transactions of cancellable types can be cancelled; whether a transaction is cancellable is indicated by the

isCancellable

field in the

CdoTransaction

object.

Example¶

Bearer (JWT) Authentication (bearerAuth):

import scc_firewall_manager_sdk
from scc_firewall_manager_sdk.models.cdo_transaction import CdoTransaction
from scc_firewall_manager_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.us.security.cisco.com/firewall
# See configuration.py for a list of all supported configuration parameters.
configuration = scc_firewall_manager_sdk.Configuration(
    host = "https://api.us.security.cisco.com/firewall"
)

# 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 = scc_firewall_manager_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with scc_firewall_manager_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = scc_firewall_manager_sdk.TransactionsApi(api_client)
    transaction_uid = 'transaction_uid_example' # str | 

    try:
        # Cancel Transaction
        api_response = api_instance.cancel_transaction(transaction_uid)
        print("The response of TransactionsApi->cancel_transaction:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TransactionsApi->cancel_transaction: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
transaction_uid	str

Return type¶

CdoTransaction

Authorization¶

bearerAuth

HTTP request headers¶

Content-Type: Not defined
Accept: application/json

HTTP response details¶

Status code	Description	Response headers
200	The cancelled CDO transaction.	-
400	Invalid input provided. Check the response for details.	-
401	Request not authorized.	-
403	User does not have sufficient privileges to perform this operation.	-
422	The transaction cannot be cancelled, because the transaction type is not cancellable.	-
500	Internal server error.	-

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

get_transaction¶

CdoTransaction get_transaction(transaction_uid)

Get Transaction

Get information on a CDO transaction. An CDO transaction is an entity used to monitor progress of, and provide feedback on, long-running operations. All asynchronous operations in CDO's API create Security Cloud Control transactions. Note: CDO transactions are deleted two hours after the last update to it.