For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Open sourceSupportFAQsDocs Home
DocumentationAPI ReferenceRelease notes
DocumentationAPI ReferenceRelease notes
  • Introduction
    • Overview
    • Authentication
  • Guides
    • Integration API routes
    • Operations Manager search APIs
    • Search API
    • URL query parameters
    • Use query parameters in API requests
  • Reference
        • POSTAdd one or more components to project
        • POSTCreate a new component group document
        • POSTCreate a new project
        • POSTCreate a new template document
        • POSTCreate a new workflow document
        • DELDelete a component group document
        • DELDelete a project and any components it contains
        • DELDelete a template document
        • POSTDiscover referenced resources
        • GETExport a template document
        • GETExport project as JSON document
        • GETGet a list of all the apps and adapters
        • GETGet a page of component group documents
        • GETGet a page of template documents
        • GETGet a page of workflow documents
        • GETGet a project's thumbnail
        • GETGet component group document
        • GETGet details of a workflow
        • GETGet project
        • GETGet references to a particular document
        • GETGet task details
        • POSTGet task details
        • GETGet template document
        • POSTImport a new component group document
        • POSTImport a new template document
        • POSTImport a new workflow document
        • POSTImport a project document from a JSON document
        • GETList all available rest calls
        • DELRemove a component from a project
        • PUTReplace a component group document
        • PUTReplace a template document
        • PUTReplace a workflow document
        • GETSearch projects
        • PUTSet a project's thumbnail image
        • PATCHUpdate an existing project
        • POSTValidate a workflow
LogoLogo
Open sourceSupportFAQsDocs Home
ReferenceAutomation Studio

Create a new workflow document

POST
http://localhost:3000/automation-studio/automations
POST
/automation-studio/automations
$curl -X POST http://localhost:3000/automation-studio/automations \
>     -H "Content-Type: application/json" \
>     -u "<username>:<password>" \
>     -d '{}'
1{
2  "created": {
3    "name": "Port Turn Up IOS",
4    "type": "automation",
5    "tasks": {
6      "workflow_start": {
7        "name": "string",
8        "summary": "string",
9        "groups": [
10          "62a1f3d2ebedfc54e6e0065c"
11        ],
12        "nodeLocation": {
13          "x": 1.1,
14          "y": 1.1
15        }
16      },
17      "workflow_end": {
18        "name": "string",
19        "summary": "string",
20        "groups": [
21          "62a1f3d2ebedfc54e6e0065c"
22        ],
23        "nodeLocation": {
24          "x": 1.1,
25          "y": 1.1
26        }
27      },
28      "error_handler": {
29        "name": null
30      }
31    },
32    "transitions": {
33      "workflow_start": {},
34      "workflow_end": {},
35      "error_handler": {}
36    },
37    "groups": [
38      "62a1f3d2ebedfc54e6e0065c"
39    ],
40    "canvasVersion": 1.1,
41    "_id": "string",
42    "uuid": "string",
43    "namespace": {
44      "type": null,
45      "_id": {},
46      "name": "Juniper JUNOS"
47    },
48    "description": "Port Turn Up IOS",
49    "preAutomationTime": 5000,
50    "sla": 1,
51    "errorHandler": null,
52    "font_size": 12,
53    "created": "2024-03-13T18:21:15.352Z",
54    "created_by": {
55      "username": "admin@pronghorn",
56      "provenance": "Pronghorn"
57    },
58    "createdVersion": "5.40.5-2021.1.72.0",
59    "last_updated": "2024-03-13T18:21:15.352Z",
60    "last_updated_by": {
61      "username": "admin@pronghorn",
62      "provenance": "Pronghorn"
63    },
64    "lastUpdatedVersion": "4.69.69",
65    "tags": [
66      "string"
67    ],
68    "encodingVersion": 1,
69    "inputSchema": {},
70    "outputSchema": {},
71    "outputData": {},
72    "decorators": [
73      {
74        "type": "encryption",
75        "pointer": "string"
76      }
77    ],
78    "migrationVersion": 1,
79    "scenarios": [
80      {
81        "name": "string",
82        "input": {},
83        "description": "string",
84        "taskMocks": {},
85        "last_updated": "2024-01-15T09:30:00Z",
86        "last_updated_by": {
87          "username": "admin@pronghorn",
88          "provenance": "Pronghorn"
89        }
90      }
91    ]
92  },
93  "edit": "string"
94}
Creates a new workflow document.
Was this page helpful?
Previous

Delete a component group document

Next
Built with

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Request

request body
automationobjectOptional
Third generation workflow document as it exists in the database

Response

Created workflow and associated edit URI.
createdobject
Third generation workflow document as it exists in the database
editstring
URI to the edit page for the newly created workflow.

Errors

500
Internal Server Error