Update machine details

PUT 
/api/v1/machines/:machineIdOrAlias/update

This API endpoint update the name, alias, tags, and icon of the machine identified by the provided machineId or machine alias.

Request

Path Parameters

machineIdOrAlias stringrequired

The machineId - unique id of the machine, alias - machine alias

application/json

Body

required

The request body containing the required details to update machine details

name string
alias string

tags

object[]

Array [

key string

value string

]

fileName string
pictureBase64 string

Responses

200

Success response

application/json

Schema

Schema

success boolean
message string
status string
statusCode int32
errorCode string
subErrors object[]
payload boolean

Example (from schema)

{
  "success": true,
  "message": "string",
  "status": "string",
  "statusCode": 0,
  "errorCode": "string",
  "subErrors": [
    {}
  ],
  "payload": true
}

Update machine details example

Update machine details response example

{
  "success": true,
  "message": "Machine updated successfully",
  "status": "OK",
  "statusCode": 200,
  "errorCode": "",
  "subErrors": [
    {}
  ],
  "payload": true
}

Loading...