Import a prebuilt

POST

http://localhost:3000/prebuilts/import

POST

/prebuilts/import

$ curl -X POST http://localhost:3000/prebuilts/import \
>      -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 }

Imports a prebuilt into Itential Platform.

Authentication

AuthorizationBasic

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

Request

request body

prebuiltobjectOptional

optionsobjectOptional

Response

The output of the prebuilt import process.

statusenum

The status of the API request.

messagestring

Message containing either confirmation of the operation or the reason for the failure of the operation.

dataobject

Errors

500

Internal Server Error