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

Update a prebuilt

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

Validate the data structure of 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.

Request

request body
prebuiltobjectOptional

Response

The output of the prebuilt update process.
statusenum
The status of the API request.
Allowed values:
messagestring
Message containing either confirmation of the operation or the reason for the failure of the operation.
dataobject

Errors

500
Internal Server Error