cloudreactor-python-api-client

Python client for the CloudReactor API

Overview

This python package allows python applications to programmatically create, monitor, and manage Tasks and Workflows in CloudReactor. Most notably, you can start and stop Tasks and Workflows by creating Task Executions and Workflow Executions.

See the CloudReactor landing page to see the benefits of monitoring and managing your tasks with CloudReactor.

Installation

Get this package from PyPI:

pip install cloudreactor_api_client

Usage

First, create a client:

from cloudreactor_api_client import AuthenticatedClient

client = AuthenticatedClient(base_url="https://api.cloudreactor.io/api/v1",
    token="YOUR_API_KEY")

To start a Task, create a Task Execution:

from cloudreactor_api_client.api.task_executions import (
    task_executions_create
)
from cloudreactor_api_client.models import (
    TaskExecution,
    TaskExecutionStatus
)

# Identify the Task by name. Alternatively, you can specifiy the "uuid".
task_dict = {"name": "HappyTask"}

task_execution = TaskExecution.from_dict({
    "task": task_dict,
    "status": TaskExecutionStatus.MANUALLY_STARTED
})

response = task_executions_create.sync_detailed(client=client,
    json_body=task_execution)

parsed_task_execution = response.parsed

print(f"Task Execution {parsed_task_execution.uuid} started!")

More details on how to use API clients in general (async mode, disabling SSL) can be found in the generated README.

License

This software is licensed under the BSD 2-Clause License. See LICENSE for details.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Jeff Tsay 💻 📖 🚇 🚧

This project follows the all-contributors specification. Contributions of any kind welcome!

Credits

Code generated by openapi-python-client