Create platform

POST

/api/platforms

curl --request POST \
  --url http://localhost:3000/api/platforms \
  --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 }'

• Local development
• Dedicated / self-hosted instance

Authorizations

• cookieAuth

Request Body ^required

Media type application/json

object

name

required

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

201

Platform created

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

Validation error

Media type application/json

object

error

required

string

Example

{
  "error": "Not found"
}

401

Not authenticated

Media type application/json

object

error

required

string

Example

{
  "error": "Not found"
}