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

Import a new workflow document

POST
http://localhost:3000/automation-studio/automations/import
POST
/automation-studio/automations/import
$curl -X POST http://localhost:3000/automation-studio/automations/import \
>     -H "Content-Type: application/json" \
>     -u "<username>:<password>" \
>     -d '{}'
1{
2  "imported": [
3    {
4      "message": "string",
5      "original": {
6        "name": "Port Turn Up IOS",
7        "type": "automation",
8        "tasks": {
9          "workflow_start": {
10            "name": "string",
11            "summary": "string",
12            "groups": [
13              {
14                "name": "Admin",
15                "provenance": "Pronghorn"
16              }
17            ],
18            "x": 0,
19            "y": 100
20          },
21          "workflow_end": {
22            "name": "string",
23            "summary": "string",
24            "groups": [
25              {
26                "name": "Admin",
27                "provenance": "Pronghorn"
28              }
29            ],
30            "x": 0,
31            "y": 100
32          },
33          "error_handler": {
34            "name": null
35          }
36        },
37        "transitions": {
38          "workflow_start": {},
39          "workflow_end": {},
40          "error_handler": {}
41        },
42        "groups": [
43          {
44            "name": "Admin",
45            "provenance": "Pronghorn"
46          }
47        ],
48        "_id": "string",
49        "uuid": "string",
50        "namespace": null,
51        "description": "Port Turn Up IOS",
52        "preAutomationTime": 5000,
53        "sla": 10,
54        "errorHandler": null,
55        "font_size": 12,
56        "created": "2024-03-13T18:21:15.352Z",
57        "created_by": {
58          "username": "admin@pronghorn",
59          "provenance": "Pronghorn"
60        },
61        "createdBy": "string",
62        "createdVersion": "5.40.5-2021.1.72.0",
63        "last_updated": "2024-03-13T18:21:15.352Z",
64        "last_updated_by": {
65          "username": "admin@pronghorn",
66          "provenance": "Pronghorn"
67        },
68        "lastUpdatedVersion": "4.69.69",
69        "tags": [
70          {
71            "_id": "string",
72            "name": "string",
73            "description": "string"
74          }
75        ],
76        "canvasVersion": 1,
77        "encodingVersion": 1,
78        "inputSchema": {},
79        "outputSchema": {},
80        "outputData": {},
81        "decorators": [
82          {
83            "type": "encryption",
84            "pointer": "string"
85          }
86        ],
87        "migrationVersion": 1,
88        "scenarios": [
89          {
90            "name": "string",
91            "input": {},
92            "description": "string",
93            "taskMocks": {},
94            "last_updated": "2024-01-15T09:30:00Z",
95            "last_updated_by": {
96              "username": "admin@pronghorn",
97              "provenance": "Pronghorn"
98            }
99          }
100        ]
101      },
102      "created": {
103        "name": "Port Turn Up IOS",
104        "type": "automation",
105        "tasks": {
106          "workflow_start": {
107            "name": "string",
108            "summary": "string",
109            "groups": [
110              "62a1f3d2ebedfc54e6e0065c"
111            ],
112            "nodeLocation": {
113              "x": 1.1,
114              "y": 1.1
115            }
116          },
117          "workflow_end": {
118            "name": "string",
119            "summary": "string",
120            "groups": [
121              "62a1f3d2ebedfc54e6e0065c"
122            ],
123            "nodeLocation": {
124              "x": 1.1,
125              "y": 1.1
126            }
127          },
128          "error_handler": {
129            "name": null
130          }
131        },
132        "transitions": {
133          "workflow_start": {},
134          "workflow_end": {},
135          "error_handler": {}
136        },
137        "groups": [
138          "62a1f3d2ebedfc54e6e0065c"
139        ],
140        "canvasVersion": 1.1,
141        "_id": "string",
142        "uuid": "string",
143        "namespace": {
144          "type": null,
145          "_id": {},
146          "name": "Juniper JUNOS"
147        },
148        "description": "Port Turn Up IOS",
149        "preAutomationTime": 5000,
150        "sla": 1,
151        "errorHandler": null,
152        "font_size": 12,
153        "created": "2024-03-13T18:21:15.352Z",
154        "created_by": {
155          "username": "admin@pronghorn",
156          "provenance": "Pronghorn"
157        },
158        "createdVersion": "5.40.5-2021.1.72.0",
159        "last_updated": "2024-03-13T18:21:15.352Z",
160        "last_updated_by": {
161          "username": "admin@pronghorn",
162          "provenance": "Pronghorn"
163        },
164        "lastUpdatedVersion": "4.69.69",
165        "tags": [
166          "string"
167        ],
168        "encodingVersion": 1,
169        "inputSchema": {},
170        "outputSchema": {},
171        "outputData": {},
172        "decorators": [
173          {
174            "type": "encryption",
175            "pointer": "string"
176          }
177        ],
178        "migrationVersion": 1,
179        "scenarios": [
180          {
181            "name": "string",
182            "input": {},
183            "description": "string",
184            "taskMocks": {},
185            "last_updated": "2024-01-15T09:30:00Z",
186            "last_updated_by": {
187              "username": "admin@pronghorn",
188              "provenance": "Pronghorn"
189            }
190          }
191        ]
192      },
193      "edit": "string",
194      "success": true
195    }
196  ]
197}
Imports a new workflow document.
Was this page helpful?
Previous

Import a project document from a JSON document

Next
Built with

Authentication

AuthorizationBasic

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

Request

request body
automationslist of objectsOptional

Array of workflow documents to import. If ‘_id’ is provided, it will be replaced with an autogenerated ‘_id’.

Response

Results from each individual import operation.
importedlist of objects

Errors

500
Internal Server Error