Update Platform Type

PUT 
/api/v1/platforms/:platformId

Updates the mutable fields of an existing platform type. Requires the MANAGE_DISCOVERY role.

Request

Path Parameters

platformId numberrequired

ID of the platform

application/json

Body

required

name string

Name of the platform

description string

Description of the platform

imageId string

Optional image ID

metadata object

Optional tags or metadata

Responses

200

application/json

Schema

Schema

name stringrequired

Name of the platform

description string

Description of the platform

imageId string

Optional image ID

metadata object

Optional tags or metadata

id numberrequired

ID of the platform

createdAt date-timerequired

Timestamp when the platform was created

updatedAt date-timerequired

Timestamp when the platform was last updated

Example (from schema)

{
  "name": "string",
  "description": "This is a sample platform.",
  "imageId": "string",
  "metadata": {},
  "id": 0,
  "createdAt": "2026-11-08T13:48:43.190Z",
  "updatedAt": "2026-11-08T13:48:43.190Z"
}

Loading...