Skip to content
Omniglass Omniglass Omniglass

Update a product

PATCH
/products/{id}
 
curl --request PATCH \
  --url https://example.com/api/v1/products/example \
  --header 'Content-Type: application/json' \
  --data '{ "capabilities": [ "example" ], "display_name": "example", "driver_id": "example", "kind": "device", "parent_product_id": "example", "vendor_id": "example" }'

Patches a custom product’s display_name, vendor, driver, kind, or parent, and replaces its capabilities when provided. Official products are read-only (422). Gated by product:update.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string

Request Body required

Section titled “Request Body required ”
Media type application/json
object
$schema

A URL to the JSON Schema for this object.

string format: uri
capabilities
Array<string>
display_name
string
driver_id
string
kind
string
Allowed values: device app service vm
parent_product_id
string
vendor_id
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json
object
$schema

A URL to the JSON Schema for this object.

string format: uri
capabilities
required
Array<string> | null
display_name
required
string
driver

The driver’s handle

string
driver_id

The driver’s uuid; the stable form of driver

string
id
required

The product’s uuid, the stable handle that survives a rename

string
kind
required
string
Allowed values: device app service vm
name
required

The kebab handle an operator reads and types; renameable

string
official
required
boolean
parent_product

The parent product’s handle

string
parent_product_id

The parent product’s uuid; the stable form of parent_product

string
vendor

The vendor’s handle

string
vendor_id

The vendor’s uuid; the stable form of vendor

string
Example 
{
  "$schema": "/api/v1/schemas/ProductBody.json",
  "kind": "device"
}

default

Section titled “default ”

Error

Media type application/problem+json
object
$schema

A URL to the JSON Schema for this object.

string format: uri
detail

A human-readable explanation specific to this occurrence of the problem.

string
errors

Optional list of individual error details

Array<object> | null
object
location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string
message

Error message text

string
value

The value at the given location

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri
status

HTTP status code

integer format: int64
title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string
type

A URI reference to human-readable documentation for the error.

string format: uri
default: about:blank
Example 
{
  "$schema": "/api/v1/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}