Update a catalog item

Scope: catalog:write

Authorization

bearerAuth

AuthorizationBearer <token>

Personal Access Token (PAT) or Service Access Token (SAT). Pass the token in the Authorization header: Bearer admp_...

In: header

Path Parameters

catalog_item.id*id

Unique identifier for the catalog item (UUID).

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

catalog_item*

The catalog item with updated fields. Its id identifies the item; only fields named in update_mask are applied.

update_mask?update_mask

The set of fields to update. Optional; if omitted, all populated fields are updated. Pass * for full replacement. Supported fields: name, description, source_id, ref, root, path, labels. type is immutable and cannot be updated.

Response Body

`application/json`

curl -X PATCH "https://api.admiral.io/api/v1/catalog-items/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{    "catalog_item": {}  }'

{  "catalog_item": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "name": "string",    "description": "string",    "type": "CATALOG_ITEM_TYPE_UNSPECIFIED",    "source_id": "ae50a35c-df42-4eff-ba26-f8bc28d2af81",    "ref": "string",    "root": "string",    "path": "string",    "labels": {      "property1": "string",      "property2": "string"    },    "source_name": "string",    "created_by": {      "id": "string",      "display_name": "string",      "email": "string"    },    "created_at": "2023-01-15T01:30:15.01Z",    "updated_at": "2023-01-15T01:30:15.01Z"  }}