• /
  • EnglishEspañolFrançais日本語한국어Português
  • Log inStart now

GetWorkflowDefinition

|View as Markdown

Use the workflowAutomation.workflow query to get and return a workflow definition.

Input parameters

Parameter

Data type

Description

account.id

Number

(Required) Your account ID.

workflow.name

String

(Required) The name of the workflow definition to retrieve.

workflow.version

Number

(Required) The version of the workflow definition to retrieve.

Sample request

Use the Query Builder to create and edit a workflow. See NerdGraph API explorer.

{
actor {
account(id: 12345678) {
workflowAutomation {
workflow(name: "my-workflow", version: 1) {
definition {
name
version
yaml
}
}
}
}
}
}

Sample response

The query returns:

  • definition.name: The name of the workflow definition
  • definition.version: The version number of the workflow definition
  • definition.yaml: The base64-encoded workflow definition YAML

Get workflow definitions

List all workflow definitions to find name and version

Update workflow definition

Modify the retrieved workflow definition

Start workflow run

Execute this workflow definition

Definition schema

Understand the workflow YAML structure

Copyright © 2026 New Relic Inc.

This site is protected by reCAPTCHA and the Google Privacy Policy and Terms of Service apply.