Workflow Automation API reference

The Workflow Automation API enables you to programmatically create, manage, and execute workflows in New Relic. Use these APIs to automate repetitive tasks, orchestrate complex operations, and integrate workflows into your development and operations processes.

Before you begin

To use the Workflow Automation APIs, you'll need:

• A New Relic account with appropriate permissions
• Access to the NerdGraph API explorer to create and test your API calls
• Understanding of NerdGraph (New Relic's GraphQL API)

For additional help:

• Learn how to use the GraphiQL IDE in the NerdGraph API explorer tutorial
• See Introduction to APIs for an overview of all New Relic APIs

Authentication and secrets

Workflow Automation uses Customer Secret Storage for managing sensitive information like API keys and credentials. Secrets are managed through our GraphQL API. For authentication details related to secret management, refer to the NerdGraph documentation.

API operations by category

Create and manage workflows

Use these APIs to create, update, validate, and delete workflow definitions:

• CreateWorkflowDefinition - Create a new workflow definition
• UpdateWorkflowDefinition - Update an existing workflow definition
• ValidateWorkflowDefinition - Validate workflow definition YAML before creating or updating
• DeleteWorkflowDefinition - Delete all versions of a workflow definition with the specified name

Query workflows and actions

Use these APIs to retrieve information about workflows and available actions:

• GetWorkflowDefinition - Get and return a specific workflow definition
• GetWorkflowDefinitions - Get and return a list of workflow definitions under your account scope
• GetActionDefinitions - Return all available action definitions

Run workflows

Use these APIs to control workflow execution:

• StartWorkflowRun - Start a workflow run for a specified workflow definition
• SignalWorkflowRun - Trigger a signal to an existing running workflow
• StopWorkflowRun - Stop a running workflow instance

Schedule workflows

Use these APIs to create and manage workflow schedules:

• CreateSchedule - Create a schedule for a workflow definition
• GetSchedule - Get and return schedule details
• GetSchedules - Return information about all schedules
• DeleteSchedule - Delete the schedule of a workflow definition

Reference documentation

• Definition Schema - Workflow definition structure and syntax reference