---
title: "Update (partial) catalogue item."
method: PATCH
path: "/api/v1/catalogue/{id}"
tags: ["catalogue"]
---

# Update (partial) catalogue item.

`PATCH /api/v1/catalogue/{id}`

Update catalogue item with PATCH.

## Path parameters

- `id` string, required

## Cookies

- `Session` string, nullable

## Request body

- CatalogueUpdate — Common base for catalogue update.
  - `revision` integer, required — Revision.
  - `name` string, nullable — User facing name.
  - `description` string, nullable — Short description.
  - `mediation` Mediation — Mediation.
    - `enabled` boolean — Enable mediation.
  - `appId` string, nullable — App id.
  - `basePath` string, nullable — Base path.
  - `serviceOfferingLink` string, uri, nullable — Link to service offering (ex. SNOW).
  - `apiPolicy` CustomAttribute — Generic value/name attribute schema.
    - `name` string, required — Name.
    - `value` string[], nullable, required — List of values
  - `healthCheckPath` string, nullable — Health check path.
  - `businessOwners` string[], nullable — Business owner(s) as reference id(s).
  - `technicalOwners` string[], nullable — Technical owner(s) as reference id(s).
  - `documents` CatalogueDocumentUpdate[], nullable — Documentation.
    - `id` string, required — Document id.
    - `customTitle` string, nullable — Custom document title.
    - `orderNumber` integer — Document order number.
  - `environments` string[], nullable — Environments supported by API.
  - `categories` string[], nullable — List of categories

## Response `200`

Successful Response

- CatalogueResponse — Catalogue update response.
  - `id` string, required — Unique id in db.
  - `history` HistoryResponse, required — History response model.
    - `id` string, required — Id of entry in db.
    - `creator` string, required — User or email of the creator.
    - `created` string, date-time, required — Datetime when the entry has been created.
    - `modifier` string, required — User or email of the modifier.
    - `modified` string, date-time, required — Datetime when the entry has been modified.
    - `revision` number — Revision of entry, incremented by 1 for each update
  - `name` string, required — User facing name.
  - `description` string, required — Short description.
  - `targetName` string, required — Target name (used as API role).
  - `mediation` Mediation, required — Mediation.
    - `enabled` boolean — Enable mediation.
  - `appId` string, nullable, required — App id.
  - `basePath` string, nullable, required — Base path.
  - `serviceOfferingLink` string, uri, nullable, required — Link to service offering (ex. SNOW).
  - `apiPolicy` CustomAttribute, required — Generic value/name attribute schema.
    - `name` string, required — Name.
    - `value` string[], nullable, required — List of values
  - `healthCheckPath` string, nullable, required — Health check path.
  - `revision` integer, required — Revision.
  - `action` 'INSERT' | 'UPDATE', required — Actions.
  - `documents` CatalogueDocumentResponse[], nullable, required — Documentation.
    - `document` DocumentResponseNoHistory, required — Document response without history.
      - `docId` string, nullable — Id of the document by language and description.
      - `description` string, required — Short description of document.
      - `document` string, required — Document itself.
      - `language` 'EN', required — Supported languages.
      - `id` string, required — Unique id in db.
    - `customTitle` string, nullable — Custom document title.
    - `orderNumber` integer — Document order number.
  - `environments` EnvironmentResponseNoHistory[], nullable, required — Environments supported by API.
    - `environment` 'dev' | 'prd' | 'stg' | 'tst', required — Supported environments.
    - `dnsName` string, required — DNS name of the environment service.
    - `port` integer, required — Port.
    - `openapiJson` string — OpenAPI JSON as url or str (may be empty).
    - `version` string, required — API version.
    - `catalogueId` string, required — Id of catalogue item to which throttling belongs.
    - `lifecycle` string — Lifecycle state.
    - `tryOutAllow` boolean — Allow try-out tool to make requests.
    - `targetIpPublic` boolean — Target ip is public.
    - `throttling` ThrottlingResponseNoHistory[], nullable — Throttling options.
      - `name` string, required — Name of the throttling set.
      - `tierNumber` integer, nullable — Tier number.
      - `requestsMaxAmount` integer, required — Max amount of requests.
      - `timeInterval` integer, required — Time interval for requests.
      - `catalogueId` string, required — Id of catalogue item to which throttling belongs.
      - `type` 'ENV' | 'CONSUMER', required — Throttling type.
      - `id` string, required — Unique id in db.
    - `id` string, required — Unique id in db.
  - `businessOwners` OwnerResponseNoHistory[], required — Business owner(s) as reference id(s).
    - `name` string, required — Owner's or unit's name.
    - `email` string[], required — Owner's email address.
    - `id` string, required — Unique id in db.
  - `technicalOwners` OwnerResponseNoHistory[], required — Technical owner(s) as reference id(s).
    - `name` string, required — Owner's or unit's name.
    - `email` string[], required — Owner's email address.
    - `id` string, required — Unique id in db.
  - `categories` CategoryResponseNoHistory[], required — List of categories
    - `name` string, required — Category name.
    - `description` string, required — Category description.
    - `sequence` integer, required — Category sequence id.
    - `id` string, required — Unique id in db.

## Other responses

- `403` — Forbidden
- `404` — Not Found
- `409` — Conflict
- `422` — Unprocessable entity
- `500` — Internal Server Error

---

[API](https://skmtc.dev/posti/apis/posti-developer-portal-backend-rest-api.md) · [All operations](https://skmtc.dev/posti/apis/posti-developer-portal-backend-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/posti/posti-developer-portal-backend-rest-api/revisions/4b67dce32742/schema)