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
        • 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

Get prebuilt

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

Import a prebuilt

Next
Built with

Authentication

AuthorizationBasic

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

Path parameters

idstringRequiredformat: "^[0-9a-f]{24}$"
The object id of the selected prebuilt.

Response

The data for a prebuilt.
metadataobject
manifestobject
bundleslist of objects
readmestringformat: "^([\S\s]*)$"

Errors

500
Internal Server Error