Skip to content

Create an order from a sales/webhook payload

Request

Creates a new order from a flat webhook-style payload. The flat network fields are translated into nodes and NATs.

Requires orders::modify permission.

Security
JWTAuthorizer
Bodyapplication/json
contactNamestring
contactEmailstring
companyNamestring
technicalContactNamestring
technicalContactEmailstring
technicalContactPhonestring
locationNamestring
siteTypestring
deploymentTypestring

Deployment type

Enum:"High Availability Pair (HA)""Single Node"
interfacesCountstring

Number of Ethernet interfaces

Enum:"One Ethernet""Two Ethernet"
applianceTypestring
hypervisorstring

Hypervisor or appliance type override

rackMountsstring

Whether rack mounts are requested

firstNodeWANIPstring
firstNodeWANSubnetstring
firstNodeWANGwstring
firstNodeLANIPstring
firstNodeLANSubnetstring
firstNodeLANGwstring
secondNodeWANIPstring
secondNodeWANSubnetstring
secondNodeWANGwstring
secondNodeLANIPstring
secondNodeLANSubnetstring
secondNodeLANGwstring
dns1string
dns2string
clusterIpstring
shippingCompanyNamestring
shippingContactEmailstring
attnstring
address1string
address2string
citystring
statestring
zipstring
notesstring
NAT1Localstring

NAT 1 local CIDR

NAT1Descstring

NAT 1 description

NAT2Localstring

NAT 2 local CIDR

NAT2Descstring

NAT 2 description

NAT3Localstring

NAT 3 local CIDR

NAT3Descstring

NAT 3 description

curl -i -X POST \
  https://apidocs.trustgrid.io/_mock/provisioning/api/v1/orders/webhook \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "contactName": "string",
    "contactEmail": "string",
    "companyName": "string",
    "technicalContactName": "string",
    "technicalContactEmail": "string",
    "technicalContactPhone": "string",
    "locationName": "string",
    "siteType": "string",
    "deploymentType": "High Availability Pair (HA)",
    "interfacesCount": "One Ethernet",
    "applianceType": "string",
    "hypervisor": "string",
    "rackMounts": "string",
    "firstNodeWANIP": "string",
    "firstNodeWANSubnet": "string",
    "firstNodeWANGw": "string",
    "firstNodeLANIP": "string",
    "firstNodeLANSubnet": "string",
    "firstNodeLANGw": "string",
    "secondNodeWANIP": "string",
    "secondNodeWANSubnet": "string",
    "secondNodeWANGw": "string",
    "secondNodeLANIP": "string",
    "secondNodeLANSubnet": "string",
    "secondNodeLANGw": "string",
    "dns1": "string",
    "dns2": "string",
    "clusterIp": "string",
    "shippingCompanyName": "string",
    "shippingContactEmail": "string",
    "attn": "string",
    "address1": "string",
    "address2": "string",
    "city": "string",
    "state": "string",
    "zip": "string",
    "notes": "string",
    "NAT1Local": "string",
    "NAT1Desc": "string",
    "NAT2Local": "string",
    "NAT2Desc": "string",
    "NAT3Local": "string",
    "NAT3Desc": "string"
  }'

Responses

OK

Bodyapplication/json
uidstring
Response
{
  "uid": "string"
}