Skip to content

Update platform

PATCH
/api/platforms/{id}
 
curl --request PATCH \
  --url http://localhost:3000/api/platforms/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Content-Type: application/json' \
  --cookie session=<session> \
  --data '{ "name": "example", "slug": "example", "manufacturerId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "description": "example", "nosFamily": "example", "typicalDevices": "example", "keyFeatures": "example", "commonUseCases": "example", "commercialStatus": "active", "automationApis": [ "NETCONF" ], "popular": false }'

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string format: uuid

Request Body required

Section titled “Request Body required ”
Media type application/json
object
name
string
slug

Auto-generated from name when omitted

string
manufacturerId
string format: uuid
description
string
nosFamily
string
typicalDevices
string
keyFeatures
string
commonUseCases
string
commercialStatus
string
Allowed values: active eos eol limited open-source
automationApis
Array<string>
Allowed values: NETCONF RESTCONF gNMI gRPC eAPI NX-API JSON-RPC REST YANG NDK SNMP Cloud-only
popular
boolean

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Platform updated

Media type application/json
object
data
object
id
required
string format: uuid
name
required
string
slug
string
nullable
manufacturerId
string format: uuid
nullable
description
string
nullable
nosFamily
string
nullable
typicalDevices
string
nullable
keyFeatures
string
nullable
commonUseCases
string
nullable
commercialStatus
string
nullable
automationApis
Array<string>
popular
boolean
source
string
Allowed values: vendor customer
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
Example 
{
  "data": {
    "source": "vendor"
  }
}

400

Section titled “400 ”

Validation error

Media type application/json
object
error
required
string
Example 
{
  "error": "Not found"
}

401

Section titled “401 ”

Not authenticated

Media type application/json
object
error
required
string
Example 
{
  "error": "Not found"
}

404

Section titled “404 ”

Platform not found

Media type application/json
object
error
required
string
Example 
{
  "error": "Not found"
}