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

Search projects

GET
http://localhost:3000/automation-studio/projects
GET
/automation-studio/projects
$curl http://localhost:3000/automation-studio/projects \
>     -u "<username>:<password>"
1{
2  "message": "Successfully retrieved projects",
3  "data": [
4    {
5      "_id": "62a1f3d2ebedfc54e6e0065c",
6      "iid": 1,
7      "name": "Firewall Service Provisioning",
8      "description": "This project is used at Acme Corp as the foundation of some major parts of our business process.",
9      "members": [
10        {
11          "type": "account",
12          "reference": "62a1f3d2ebedfc54e6e0065c",
13          "role": "owner",
14          "missing": true,
15          "username": "admin@pronghorn",
16          "name": "admin",
17          "provenance": "Pronghorn"
18        }
19      ],
20      "accessControl": {
21        "read": [
22          "account:67d3108eddcf3e66cc0efbac"
23        ],
24        "execute": [
25          "account:67d3108eddcf3e66cc0efbac"
26        ],
27        "write": [
28          "account:67d3108eddcf3e66cc0efbac"
29        ],
30        "manage": [
31          "account:67d3108eddcf3e66cc0efbac"
32        ]
33      },
34      "componentIidIndex": 1,
35      "components": [
36        {
37          "iid": 1,
38          "type": "workflow",
39          "reference": "1Ac4B2268489019745B5baa4",
40          "folder": "string"
41        }
42      ],
43      "folders": [
44        {
45          "nodeType": "folder",
46          "name": "folder-1",
47          "children": [
48            null
49          ]
50        }
51      ],
52      "created": "2019-11-25T22:51:39.201Z",
53      "lastUpdated": "2019-11-25T22:51:39.201Z",
54      "versionHistory": [
55        {
56          "versionNumber": 1,
57          "commitMessage": "string",
58          "author": "admin@pronghorn",
59          "branchName": "master"
60        }
61      ],
62      "gitConfiguration": {
63        "connectionType": "GitHub",
64        "repositoryPath": "Itential Open Source",
65        "branchName": "master",
66        "projectPath": "Projects"
67      }
68    }
69  ],
70  "metadata": {
71    "skip": 1.1,
72    "limit": 1.1,
73    "total": 1.1,
74    "previousPageSkip": null,
75    "nextPageSkip": null
76  }
77}
Searches projects.
Was this page helpful?
Previous

Set a project's thumbnail image

Next
Built with

Authentication

AuthorizationBasic

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

Response

Projects
messagestring
datalist of objects
metadataobject

Errors

500
Internal Server Error