Class WorkflowAutomationApi

Hierarchy

WorkflowAutomationApi

Index

Constructors

Properties

configuration requestFactory responseProcessor

Methods

cancelWorkflowInstance createWorkflow createWorkflowInstance deleteWorkflow getWorkflow getWorkflowInstance listWorkflowInstances updateWorkflow

Constructors

constructor

new WorkflowAutomationApi(configuration: Configuration, requestFactory?: WorkflowAutomationApiRequestFactory, responseProcessor?: WorkflowAutomationApiResponseProcessor): WorkflowAutomationApi
Parameters
- configuration: Configuration
- Optional requestFactory: WorkflowAutomationApiRequestFactory
- Optional responseProcessor: WorkflowAutomationApiResponseProcessor
Returns WorkflowAutomationApi
- Defined in packages/datadog-api-client-v2/apis/WorkflowAutomationApi.ts:979

Properties

`Private` configuration

configuration: Configuration

`Private` requestFactory

requestFactory: WorkflowAutomationApiRequestFactory

`Private` responseProcessor

responseProcessor: WorkflowAutomationApiResponseProcessor

Methods

cancelWorkflowInstance

cancelWorkflowInstance(param: WorkflowAutomationApiCancelWorkflowInstanceRequest, options?: Configuration): Promise<WorklflowCancelInstanceResponse>
Cancels a specific execution of a given workflow. This API requires an application key scoped with the workflows_run permission.
Parameters
- param: WorkflowAutomationApiCancelWorkflowInstanceRequest
  
  The request object
- Optional options: Configuration
Returns Promise<WorklflowCancelInstanceResponse>
- Defined in packages/datadog-api-client-v2/apis/WorkflowAutomationApi.ts:995

createWorkflow

createWorkflow(param: WorkflowAutomationApiCreateWorkflowRequest, options?: Configuration): Promise<CreateWorkflowResponse>
Create a new workflow, returning the workflow ID. This API requires an application key scoped with the workflows_write permission.
Parameters
- param: WorkflowAutomationApiCreateWorkflowRequest
  
  The request object
- Optional options: Configuration
Returns Promise<CreateWorkflowResponse>
- Defined in packages/datadog-api-client-v2/apis/WorkflowAutomationApi.ts:1017

createWorkflowInstance

createWorkflowInstance(param: WorkflowAutomationApiCreateWorkflowInstanceRequest, options?: Configuration): Promise<WorkflowInstanceCreateResponse>
Execute the given workflow. This API requires an application key scoped with the workflows_run permission.
Parameters
- param: WorkflowAutomationApiCreateWorkflowInstanceRequest
  
  The request object
- Optional options: Configuration
Returns Promise<WorkflowInstanceCreateResponse>
- Defined in packages/datadog-api-client-v2/apis/WorkflowAutomationApi.ts:1038

deleteWorkflow

deleteWorkflow(param: WorkflowAutomationApiDeleteWorkflowRequest, options?: Configuration): Promise<void>
Delete a workflow by ID. This API requires an application key scoped with the workflows_write permission.
Parameters
- param: WorkflowAutomationApiDeleteWorkflowRequest
  
  The request object
- Optional options: Configuration
Returns Promise<void>
- Defined in packages/datadog-api-client-v2/apis/WorkflowAutomationApi.ts:1060

getWorkflow

getWorkflow(param: WorkflowAutomationApiGetWorkflowRequest, options?: Configuration): Promise<GetWorkflowResponse>
Get a workflow by ID. This API requires an application key scoped with the workflows_read permission.
Parameters
- param: WorkflowAutomationApiGetWorkflowRequest
  
  The request object
- Optional options: Configuration
Returns Promise<GetWorkflowResponse>
- Defined in packages/datadog-api-client-v2/apis/WorkflowAutomationApi.ts:1081

getWorkflowInstance

getWorkflowInstance(param: WorkflowAutomationApiGetWorkflowInstanceRequest, options?: Configuration): Promise<WorklflowGetInstanceResponse>
Get a specific execution of a given workflow. This API requires an application key scoped with the workflows_read permission.
Parameters
- param: WorkflowAutomationApiGetWorkflowInstanceRequest
  
  The request object
- Optional options: Configuration
Returns Promise<WorklflowGetInstanceResponse>
- Defined in packages/datadog-api-client-v2/apis/WorkflowAutomationApi.ts:1102

listWorkflowInstances

listWorkflowInstances(param: WorkflowAutomationApiListWorkflowInstancesRequest, options?: Configuration): Promise<WorkflowListInstancesResponse>
List all instances of a given workflow. This API requires an application key scoped with the workflows_read permission.
Parameters
- param: WorkflowAutomationApiListWorkflowInstancesRequest
  
  The request object
- Optional options: Configuration
Returns Promise<WorkflowListInstancesResponse>
- Defined in packages/datadog-api-client-v2/apis/WorkflowAutomationApi.ts:1124

updateWorkflow

updateWorkflow(param: WorkflowAutomationApiUpdateWorkflowRequest, options?: Configuration): Promise<UpdateWorkflowResponse>
Update a workflow by ID. This API requires an application key scoped with the workflows_write permission.
Parameters
- param: WorkflowAutomationApiUpdateWorkflowRequest
  
  The request object
- Optional options: Configuration
Returns Promise<UpdateWorkflowResponse>
- Defined in packages/datadog-api-client-v2/apis/WorkflowAutomationApi.ts:1147

Class WorkflowAutomationApi

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

configuration: Configuration

Optional requestFactory: WorkflowAutomationApiRequestFactory

Optional responseProcessor: WorkflowAutomationApiResponseProcessor

Returns WorkflowAutomationApi

Properties

Private configuration

Private requestFactory

Private responseProcessor

Methods

cancelWorkflowInstance

Parameters

param: WorkflowAutomationApiCancelWorkflowInstanceRequest

Optional options: Configuration

Returns Promise<WorklflowCancelInstanceResponse>

createWorkflow

Parameters

param: WorkflowAutomationApiCreateWorkflowRequest

Optional options: Configuration

Returns Promise<CreateWorkflowResponse>

createWorkflowInstance

Parameters

param: WorkflowAutomationApiCreateWorkflowInstanceRequest

Optional options: Configuration

Returns Promise<WorkflowInstanceCreateResponse>

deleteWorkflow

Parameters

param: WorkflowAutomationApiDeleteWorkflowRequest

Optional options: Configuration

Returns Promise<void>

getWorkflow

Parameters

param: WorkflowAutomationApiGetWorkflowRequest

Optional options: Configuration

Returns Promise<GetWorkflowResponse>

getWorkflowInstance

Parameters

param: WorkflowAutomationApiGetWorkflowInstanceRequest

Optional options: Configuration

Returns Promise<WorklflowGetInstanceResponse>

listWorkflowInstances

Parameters

param: WorkflowAutomationApiListWorkflowInstancesRequest

Optional options: Configuration

Returns Promise<WorkflowListInstancesResponse>

updateWorkflow

Parameters

param: WorkflowAutomationApiUpdateWorkflowRequest

Optional options: Configuration

Returns Promise<UpdateWorkflowResponse>

Settings

Member Visibility

Theme

`Optional` requestFactory: WorkflowAutomationApiRequestFactory

`Optional` responseProcessor: WorkflowAutomationApiResponseProcessor

`Private` configuration

`Private` requestFactory

`Private` responseProcessor

`Optional` options: Configuration

`Optional` options: Configuration

`Optional` options: Configuration

`Optional` options: Configuration

`Optional` options: Configuration

`Optional` options: Configuration

`Optional` options: Configuration

`Optional` options: Configuration