RunBooks

List RunBooks

{% swagger src="../../../.gitbook/assets/openapi2 (1).json" path="/v1alpha1/workflows" method="get" %} openapi2 (1).json

Curl Example (to get personal runBooks: isCloudOps=false)

curl  'https://<domain>/v1alpha1/workflows?pageSize=100&isCloudOps=false' \
      -H "X-CloudOps-API-Key:<apikey>" 

Curl Example (isCloudOps=true):

https://tenant-staging.alpha.cloudops.io/v1alpha1/workflows?pageSize=100&isCloudOps=true' \
-H "X-CloudOps-API-Key:<apikey>"

Get RunBook Details

{% swagger src="../../../.gitbook/assets/openapi2 (1).json" path="/v1alpha1/workflows/{workflowId}" method="get" %} openapi2 (1).json

Curl Example:

This example gets the details of an CloudOps XRunBook. To get a custom/personal xRUnBook, use the workflowId, and remove the isCloudOps parameter.

'https://<domain>/v1alpha1/workflows/79c167af0209e60fc45455bf4943b733904d4ab8654028d8434d193d1bf8c16c?isCloudOps=true' \
      -H "X-CloudOps-API-Key:<apy key>" 

Run a RunBook

{% swagger src="../../../.gitbook/assets/openapi2 (1).json" path="/v1alpha1/workflows/{workflowId}/run" method="post" %} openapi2 (1).json

Curl Example:

This xRunBook requires no parameters.

curl  -X POST 'https://<domain>/v1alpha1/workflows/14fac589-5849-403b-afcf-ed8079099500/run' \
    -H "X-CloudOps-API-Key:<apitoken>" \
-d '{"proxyId":"<proxyid>"}'

This xRunBook has input Parameters:

curl -X POST '<domain>/v1alpha1/workflows/c5030e77-7b0a-6c4ca/run'
-H "<apitoken>"
-d '{"proxyId":"<proxyid)", "inputs":"{"tag_key":"Service","tag_value":"MongoDB", "user_name":"test123"}"}'