Skip to main content
POST
/
api
/
models
/
{modelId}
/
ports
Create a new port
curl --request POST \
  --url http://localhost:3000/api/models/{modelId}/ports \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "label": "<string>",
  "partId": "<string>",
  "constraints": [
    "<string>"
  ]
}'
{
  "label": "<string>",
  "constraints": [
    "<string>"
  ],
  "notes": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
modelId
string<uuid>
required

ID of the model

Body

application/json
​
label
string
required

Label of the port

​
partId
string
required

ID of the part this port belongs to

​
constraints
string[]

Constraints on the port

Response

Port created successfully

A port belonging to a part in the model

​
label
string
required

The label of the part

​
constraints
string[]
required

The constraints on the port

​
notes
string

Additional notes about the port