Update a prebuilt

curl -X PUT http://localhost:3000/prebuilts/id \
     -H "Content-Type: application/json" \
     -u "<username>:<password>" \
     -d '{}'

{
  "status": "OK",
  "message": "A sample success message",
  "data": {
    "metadata": {
      "name": "@itentialopensource/aggregate-functions-for-arrays",
      "version": "0.0.1",
      "description": "A basic description",
      "author": "Itential Artifacts",
      "license": "Apache-2.0",
      "repository": {
        "type": "local",
        "hostname": "gitlab.com",
        "path": "/itentialopensource/pre-built-automations"
      },
      "IAPDependencies": {},
      "keywords": [
        "Itential"
      ],
      "gitlabId": 17866482
    },
    "manifest": {
      "bundleName": "aggregateFunctions",
      "artifacts": [
        {
          "id": "5e5ea3bd16da51d52b4a8f9f",
          "name": "aggregateFunctions",
          "type": "automation",
          "location": "/bundles/workflows/IAP Test Artifact Workflow.json"
        }
      ],
      "fingerprint": "5e84f892c5eab11ec2eee16d",
      "createdEpoch": "1585772690392"
    },
    "bundles": [
      {
        "type": "automation",
        "data": {}
      }
    ],
    "readme": "example of readme"
  }
}

Updates a prebuilt in Itential Platform.

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