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
    • Operations Manager search APIs
    • Search API
    • URL query parameters
    • Use query parameters in API requests
  • Reference
        • GETExport a prebuilt
        • GETGet prebuilt
        • POSTImport a prebuilt
        • GETList all the prebuilts
        • DELRemove a prebuilt
        • PUTUpdate a prebuilt
        • PUTValidate the data structure of a prebuilt
LogoLogo
Open sourceSupportFAQsDocs Home
ReferencePrebuilts

List all the prebuilts

GET
http://localhost:3000/prebuilts
GET
/prebuilts
$curl http://localhost:3000/prebuilts \
>     -u "<username>:<password>"
1{
2  "packages": [
3    {
4      "metadata": {
5        "name": "@itentialopensource/aggregate-functions-for-arrays",
6        "version": "0.0.1",
7        "description": "A basic description",
8        "author": "Itential Artifacts",
9        "license": "Apache-2.0",
10        "repository": {
11          "type": "local",
12          "hostname": "gitlab.com",
13          "path": "/itentialopensource/pre-built-automations"
14        },
15        "IAPDependencies": {},
16        "keywords": [
17          "Itential"
18        ],
19        "gitlabId": 17866482
20      },
21      "manifest": {
22        "bundleName": "aggregateFunctions",
23        "artifacts": [
24          {
25            "id": "5e5ea3bd16da51d52b4a8f9f",
26            "name": "aggregateFunctions",
27            "type": "automation",
28            "location": "/bundles/workflows/IAP Test Artifact Workflow.json"
29          }
30        ],
31        "fingerprint": "5e84f892c5eab11ec2eee16d",
32        "createdEpoch": "1585772690392"
33      },
34      "bundles": [
35        {
36          "type": "automation",
37          "data": {}
38        }
39      ],
40      "readme": "example of readme"
41    }
42  ],
43  "total": 1
44}
Returns all the prebuilts in Itential Platform.
Was this page helpful?
Previous

Remove a prebuilt

Next
Built with

Authentication

AuthorizationBasic

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

Query parameters

containsstringOptional
contains
containsFieldstringOptional
containsField
equalsstringOptional
equals
equalsFieldstringOptional
equalsField
startsWithstringOptional
startsWith
startsWithFieldstringOptional
startsWithField
skipintegerOptional>=0Defaults to 0
skip
limitintegerOptional>=0Defaults to 25
limit
sortenumOptionalDefaults to name
sort
Allowed values:
orderenumOptionalDefaults to 1
order
Allowed values:
configstringOptional
config

Response

Contains an array of prebuilts and the total in the response.
packageslist of objects
totalinteger>=0
The total number of documents

Errors

500
Internal Server Error