---
title: "Update a prebuilt"
method: PUT
path: "/prebuilts/{id}"
tags: ["Prebuilts"]
---

# Update a prebuilt

`PUT /prebuilts/{id}`

## Request

- Base URL: `https://example.itential.io`
- URL: `https://example.itential.io/prebuilts/{id}`
- Auth: none declared

Updates a prebuilt in Itential Platform.

## Path parameters

- `id` string, required: String representation of a MongoDB ObjectId

## Request body

- object
  - `prebuilt` IapPrebuiltsSchema
    - `metadata` IapPrebuiltsSchemaMetadata, required
      - `name` string, required
      - `version` string, required
      - `description` string, required
      - `author` string, required
      - `license` string, required
      - `repository` IapPrebuiltsSchemaMetadataRepository, required
        - `type` 'local' | 'gitlab' | 'git', required
        - `hostname` string
        - `path` string
      - `keywords` string[]
      - `IAPDependencies` IapPrebuiltsSchemaMetadataIapDependencies, required
      - `gitlabId` integer
    - `manifest` IapPrebuiltsSchemaManifest, required
      - `bundleName` string, required
      - `fingerprint` string
      - `createdEpoch` string
      - `artifacts` IapPrebuiltsSchemaManifestArtifactsItems[], required
        - `id` string
        - `name` string
        - `type` 'automation' | 'forms' | 'golden-config' | 'integration' | 'integration-model' | 'json-forms' | 'mop-template' | 'mop-analytic-template' | 'template' | 'transformation' | 'workflow'
        - `location` string
    - `bundles` IapPrebuiltsSchemaBundlesItems[], required
      - `type` 'automation' | 'forms' | 'golden-config' | 'integration' | 'integration-model' | 'json-forms' | 'mop-template' | 'mop-analytic-template' | 'template' | 'transformation' | 'workflow', required
      - `data` IapPrebuiltsSchemaBundlesItemsData, required
    - `readme` string, required

## Response `200`

The output of the prebuilt update process.

- PrebuiltsUpdatePrebuiltResponse200
  - `status` 'OK' | 'Created': The status of the API request.
  - `message` string: Message containing either confirmation of the operation or the reason for the failure of the operation.
  - `data` IapPrebuiltsSchema
    - `metadata` IapPrebuiltsSchemaMetadata, required
      - `name` string, required
      - `version` string, required
      - `description` string, required
      - `author` string, required
      - `license` string, required
      - `repository` IapPrebuiltsSchemaMetadataRepository, required
        - `type` 'local' | 'gitlab' | 'git', required
        - `hostname` string
        - `path` string
      - `keywords` string[]
      - `IAPDependencies` IapPrebuiltsSchemaMetadataIapDependencies, required
      - `gitlabId` integer
    - `manifest` IapPrebuiltsSchemaManifest, required
      - `bundleName` string, required
      - `fingerprint` string
      - `createdEpoch` string
      - `artifacts` IapPrebuiltsSchemaManifestArtifactsItems[], required
        - `id` string
        - `name` string
        - `type` 'automation' | 'forms' | 'golden-config' | 'integration' | 'integration-model' | 'json-forms' | 'mop-template' | 'mop-analytic-template' | 'template' | 'transformation' | 'workflow'
        - `location` string
    - `bundles` IapPrebuiltsSchemaBundlesItems[], required
      - `type` 'automation' | 'forms' | 'golden-config' | 'integration' | 'integration-model' | 'json-forms' | 'mop-template' | 'mop-analytic-template' | 'template' | 'transformation' | 'workflow', required
      - `data` IapPrebuiltsSchemaBundlesItemsData, required
    - `readme` string, required

## Other responses

- `500`: Error response from API

---

[API](https://skmtc.dev/itential/apis/itential-2.md) - [All operations](https://skmtc.dev/itential/apis/itential-2/llms.txt) - [OpenAPI document](https://skmtc.dev/itential/apis/itential-2/revisions/2095cc90e583?raw)