SynergyCP API

You will need an API Key from the API Keys page, which is available to clients and administrators under the user dropdown at the top right of the SynergyCP Application.

Clients

Clients

List Clients

List Clients
GET/client

List all Clients (sub-clients if on client-side)

Example URI

GET /client
Request
HideShow
Headers
Accept: application/json
Response  200
HideShow

A list of Clients

Headers
Content-Type: application/json
Body
[
  {
    "id": 54247739,
    "name": "occaec",
    "email": "et ullamco dolore"
  },
  {
    "id": -54495191,
    "name": "id incididunt",
    "email": "incididunt id anim dolor"
  }
]
Schema
{
  "items": {
    "properties": {
      "email": {
        "example": "[email protected]",
        "type": "string"
      },
      "id": {
        "description": "SynergyCP-specific unique identifier used for URLs, etc.",
        "type": "integer"
      },
      "name": {
        "type": "string"
      }
    },
    "required": [
      "id",
      "name",
      "email"
    ],
    "type": "object"
  },
  "type": "array"
}
Request
HideShow
Headers
Accept: application/json
Response  400
HideShow

Invalid input

Headers
Content-Type: application/json

Create Client
POST/client

Create a new Client (or sub-client on client-side)

Example URI

POST /client
Request
HideShow
Headers
Accept: application/json
Response  200
HideShow

A Client

Headers
Content-Type: application/json
Body
{
  "id": 24716748,
  "name": "occaecat",
  "email": "Excepteur mollit"
}
Schema
{
  "properties": {
    "email": {
      "example": "[email protected]",
      "type": "string"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "name": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "name",
    "email"
  ],
  "type": "object"
}

Delete Client

Delete Client
DELETE/client/{client_id}

Delete a client

Example URI

DELETE /client/client_id
URI Parameters
HideShow
client_id
string (required) 
Response  200
HideShow

Client deleted successfully

View Client
GET/client/{client_id}

View a specific client

Example URI

GET /client/client_id
URI Parameters
HideShow
client_id
string (required) 
Request
HideShow
Headers
Accept: application/json
Response  200
HideShow

A Client

Headers
Content-Type: application/json
Body
{
  "id": -70020118,
  "name": "fugiat",
  "email": "dolor ea dolore ex"
}
Schema
{
  "properties": {
    "email": {
      "example": "[email protected]",
      "type": "string"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "name": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "name",
    "email"
  ],
  "type": "object"
}

Servers

Servers

List Servers

List Servers
GET/server

Example URI

GET /server
URI Parameters
HideShow
parts.exact
string (required) 
available
string (required) 
inventory
string (required) 
is_pxe_ready
string (required) 
q
string (required) 
cpu
string (required) 
mem
string (required) 
disks
string (required) 
addons
string (required) 
cpu_billing
string (required) 
mem_billing
string (required) 
disks_billing
string (required) 
addons_billing
string (required) 
client
string (required) 
group
string (required) 
switch
string (required) 
ip_group_billing
string (required) 
billing_id
string (required) 
billing_integration
string (required) 
Request
HideShow
Headers
Accept: application/json
Response  200
HideShow

A list of Servers

Headers
Content-Type: application/json
Body
[
  {
    "srv_id": "dol",
    "access": {
      "id": 46725961,
      "client": {
        "id": -48627906,
        "name": "sunt sint eu id",
        "email": "consequat sit est sint dolore"
      },
      "ipmi": false,
      "is_active": true,
      "pxe": true,
      "switch": false
    },
    "addons": [
      {
        "id": 42377544,
        "name": "nisi sit",
        "billing_id": "enim deserunt ut anim velit"
      },
      {
        "id": 71785526,
        "name": "ea minim ullamco",
        "billing_id": "labore officia"
      }
    ],
    "billing": {
      "id": -4278313,
      "date": "reprehenderit in",
      "integration": {
        "id": -24083707,
        "name": "pariatur"
      }
    },
    "canEdit": true,
    "cpu": {
      "id": 38169711,
      "name": "consequat Lorem sunt elit id",
      "billing_id": "sed irure et in non"
    },
    "disks": [
      {
        "id": 68640964,
        "name": "deserunt sit cupidatat irure",
        "billing_id": "est"
      }
    ],
    "entity": {
      "id": 74611592,
      "name": "volup",
      "full_ip": "ex proident dolore et exercitation"
    },
    "group": {
      "id": -56180687,
      "name": "quis"
    },
    "hdd_counts": [
      {
        "key": 9922216,
        "value": "consequat aliquip"
      },
      {
        "key": -91180202,
        "value": "ad exercitation in"
      },
      {
        "key": 44478482,
        "value": "ullamc"
      }
    ],
    "id": -73331156,
    "ipmi": {
      "id": -51708723,
      "admin": {
        "username": "ex",
        "password": "do labore"
      },
      "client": {
        "username": "dolor anim veniam dolore",
        "password": "mollit"
      },
      "ip": "Ut non labore sunt laboris"
    },
    "is_ipmi_ready": true,
    "is_pxe_ready": false,
    "mem": {
      "id": 4266447,
      "name": "voluptate in eiusmod",
      "billing_id": "occaecat ipsum do dolore"
    },
    "nickname": "in",
    "notes": {
      "admin": "esse est commodo ut Duis"
    },
    "raid_soft_ready": true,
    "status_desc": "pariatur exercitation",
    "switch": {
      "id": -61962828,
      "name": "proident exercitation",
      "port": {
        "id": 10753805,
        "name": "labore ut dolore"
      }
    },
    "usage": {
      "id": -44992219,
      "used": 68724027,
      "max": -30546029
    }
  },
  {
    "srv_id": "in",
    "access": {
      "id": 23470321,
      "client": {
        "id": -66639661,
        "name": "veniam commodo",
        "email": "sed"
      },
      "ipmi": true,
      "is_active": true,
      "pxe": false,
      "switch": false
    },
    "addons": [
      {
        "id": -93889725,
        "name": "anim",
        "billing_id": "occaecat adipisicing et est do"
      },
      {
        "id": -93622400,
        "name": "dolor aliqua adipisicing incidid",
        "billing_id": "Duis sit exercitation ea culpa"
      },
      {
        "id": 81852801,
        "name": "do",
        "billing_id": "do velit deserunt tempor incididunt"
      }
    ],
    "billing": {
      "id": -38050947,
      "date": "voluptate",
      "integration": {
        "id": 44806451,
        "name": "laborum enim esse eu"
      }
    },
    "canEdit": true,
    "cpu": {
      "id": -91143703,
      "name": "et magna sit veniam in",
      "billing_id": "culpa voluptate amet elit"
    },
    "disks": [
      {
        "id": -88059455,
        "name": "quis",
        "billing_id": "qui"
      },
      {
        "id": -47550541,
        "name": "sed",
        "billing_id": "nulla"
      },
      {
        "id": -57267124,
        "name": "aute",
        "billing_id": "sunt laborum"
      },
      {
        "id": -35292015,
        "name": "in irure consectetur",
        "billing_id": "laborum incidi"
      },
      {
        "id": 80980093,
        "name": "Excepteur Duis deserunt",
        "billing_id": "nulla reprehenderit consectetur"
      }
    ],
    "entity": {
      "id": -44758749,
      "name": "sint",
      "full_ip": "dolore sunt"
    },
    "group": {
      "id": 83599755,
      "name": "qui aute pariatur"
    },
    "hdd_counts": [
      {
        "key": -16804312,
        "value": "cupidatat officia eiusmod elit"
      },
      {
        "key": -41151633,
        "value": "sed in ea id proident"
      },
      {
        "key": 37319203,
        "value": "labore et ut cupidata"
      }
    ],
    "id": 98693757,
    "ipmi": {
      "id": 55588537,
      "admin": {
        "username": "magna aute",
        "password": "est veniam mollit proident"
      },
      "client": {
        "username": "minim voluptate",
        "password": "pariatur proident qui esse anim"
      },
      "ip": "adipisicing culpa velit"
    },
    "is_ipmi_ready": false,
    "is_pxe_ready": true,
    "mem": {
      "id": 94517091,
      "name": "sit ",
      "billing_id": "laborum sed"
    },
    "nickname": "esse ut eu ad cillum",
    "notes": {},
    "raid_soft_ready": false,
    "status_desc": "nisi dolore",
    "switch": {
      "id": 29325509,
      "name": "venia",
      "port": {
        "id": -24442437,
        "name": "irure et"
      }
    },
    "usage": {
      "id": -69718969,
      "used": 48460247,
      "max": -28927551
    }
  }
]
Schema
{
  "items": {
    "properties": {
      "access": {
        "properties": {
          "client": {
            "properties": {
              "email": {
                "example": "[email protected]",
                "type": "string"
              },
              "id": {
                "description": "SynergyCP-specific unique identifier used for URLs, etc.",
                "type": "integer"
              },
              "name": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "name",
              "email"
            ],
            "type": "object"
          },
          "id": {
            "description": "SynergyCP-specific unique identifier used for URLs, etc.",
            "type": "integer"
          },
          "ipmi": {
            "description": "Whether or not the Client has been granted IPMI access to the server",
            "type": "boolean"
          },
          "is_active": {
            "description": "Whether or not the Client's access to the server has been suspended",
            "type": "boolean"
          },
          "pxe": {
            "description": "Whether or not the Client has been granted OS Reload access to the server",
            "type": "boolean"
          },
          "switch": {
            "description": "Whether or not the Client has been granted access to turn on/off the server's switch port",
            "type": "boolean"
          }
        },
        "required": [
          "id",
          "client",
          "ipmi",
          "is_active",
          "pxe",
          "switch"
        ],
        "type": "object"
      },
      "addons": {
        "items": {
          "properties": {
            "billing_id": {
              "description": "The billing ID of the part, which is what is used by billing programs like WHMCS.",
              "type": "string"
            },
            "id": {
              "description": "SynergyCP-specific unique identifier used for URLs, etc.",
              "type": "integer"
            },
            "name": {
              "description": "The name of the part, e.g. E3-1270",
              "type": "string"
            }
          },
          "required": [
            "id",
            "name",
            "billing_id"
          ],
          "type": "object"
        },
        "type": "array"
      },
      "billing": {
        "properties": {
          "date": {
            "type": "string"
          },
          "id": {
            "description": "The ID of the server given to us by the billing program. Only unique to that API Integration.",
            "type": "integer"
          },
          "integration": {
            "properties": {
              "id": {
                "description": "SynergyCP-specific unique identifier used for URLs, etc.",
                "type": "integer"
              },
              "name": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "name"
            ],
            "type": "object"
          }
        },
        "required": [
          "id",
          "date",
          "integration"
        ],
        "type": "object"
      },
      "canEdit": {
        "type": "boolean"
      },
      "cpu": {
        "properties": {
          "billing_id": {
            "description": "The billing ID of the part, which is what is used by billing programs like WHMCS.",
            "type": "string"
          },
          "id": {
            "description": "SynergyCP-specific unique identifier used for URLs, etc.",
            "type": "integer"
          },
          "name": {
            "description": "The name of the part, e.g. E3-1270",
            "type": "string"
          }
        },
        "required": [
          "id",
          "name",
          "billing_id"
        ],
        "type": "object"
      },
      "disks": {
        "items": {
          "properties": {
            "billing_id": {
              "description": "The billing ID of the part, which is what is used by billing programs like WHMCS.",
              "type": "string"
            },
            "id": {
              "description": "SynergyCP-specific unique identifier used for URLs, etc.",
              "type": "integer"
            },
            "name": {
              "description": "The name of the part, e.g. E3-1270",
              "type": "string"
            }
          },
          "required": [
            "id",
            "name",
            "billing_id"
          ],
          "type": "object"
        },
        "type": "array"
      },
      "entity": {
        "properties": {
          "full_ip": {
            "type": "string"
          },
          "id": {
            "description": "SynergyCP-specific unique identifier used for URLs, etc.",
            "type": "integer"
          },
          "name": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "name",
          "full_ip"
        ],
        "type": "object"
      },
      "group": {
        "properties": {
          "id": {
            "description": "SynergyCP-specific unique identifier used for URLs, etc.",
            "type": "integer"
          },
          "name": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "name"
        ],
        "type": "object"
      },
      "hdd_counts": {
        "items": {
          "properties": {
            "key": {
              "description": "The number of the Disk type that are in the server",
              "type": "integer"
            },
            "value": {
              "description": "The name of the Disk type",
              "type": "string"
            }
          },
          "required": [
            "key",
            "value"
          ],
          "type": "object"
        },
        "type": "array"
      },
      "id": {
        "description": "SynergyCP-specific unique identifier used for URLs, etc.",
        "type": "integer"
      },
      "ipmi": {
        "properties": {
          "admin": {
            "properties": {
              "password": {
                "type": "string"
              },
              "username": {
                "type": "string"
              }
            },
            "required": [
              "username",
              "password"
            ],
            "type": "object"
          },
          "client": {
            "properties": {
              "password": {
                "type": "string"
              },
              "username": {
                "type": "string"
              }
            },
            "required": [
              "username",
              "password"
            ],
            "type": "object"
          },
          "id": {
            "description": "SynergyCP-specific unique identifier used for URLs, etc.",
            "type": "integer"
          },
          "ip": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "admin",
          "client",
          "ip"
        ],
        "type": "object"
      },
      "is_ipmi_ready": {
        "type": "boolean"
      },
      "is_pxe_ready": {
        "type": "boolean"
      },
      "mem": {
        "properties": {
          "billing_id": {
            "description": "The billing ID of the part, which is what is used by billing programs like WHMCS.",
            "type": "string"
          },
          "id": {
            "description": "SynergyCP-specific unique identifier used for URLs, etc.",
            "type": "integer"
          },
          "name": {
            "description": "The name of the part, e.g. E3-1270",
            "type": "string"
          }
        },
        "required": [
          "id",
          "name",
          "billing_id"
        ],
        "type": "object"
      },
      "nickname": {
        "description": "The hostname of the server.",
        "type": "string"
      },
      "notes": {
        "properties": {
          "admin": {
            "type": "string"
          },
          "client": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "raid_soft_ready": {
        "type": "boolean"
      },
      "srv_id": {
        "description": "Unique identifier typically labeled on the physical server.",
        "type": "string"
      },
      "status_desc": {
        "type": "string"
      },
      "switch": {
        "properties": {
          "id": {
            "description": "SynergyCP-specific unique identifier used for URLs, etc.",
            "type": "integer"
          },
          "name": {
            "type": "string"
          },
          "port": {
            "properties": {
              "id": {
                "description": "SynergyCP-specific unique identifier used for URLs, etc.",
                "type": "integer"
              },
              "name": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "name"
            ],
            "type": "object"
          }
        },
        "required": [
          "id",
          "name",
          "port"
        ],
        "type": "object"
      },
      "usage": {
        "properties": {
          "id": {
            "description": "SynergyCP-specific unique identifier used for URLs, etc.",
            "type": "integer"
          },
          "max": {
            "description": "Max Bandwidth in bits",
            "type": "integer"
          },
          "used": {
            "description": "Bandwidth used in bits",
            "type": "integer"
          }
        },
        "required": [
          "id",
          "used",
          "max"
        ],
        "type": "object"
      }
    },
    "required": [
      "srv_id",
      "access",
      "addons",
      "billing",
      "canEdit",
      "cpu",
      "disks",
      "entity",
      "group",
      "hdd_counts",
      "id",
      "ipmi",
      "is_ipmi_ready",
      "is_pxe_ready",
      "mem",
      "nickname",
      "notes",
      "raid_soft_ready",
      "status_desc",
      "switch",
      "usage"
    ],
    "type": "object"
  },
  "type": "array"
}
Request
HideShow
Headers
Accept: application/json
Response  400
HideShow

Invalid input

Headers
Content-Type: application/json

View Server

View Server
GET/server/{server_id}

Example URI

GET /server/server_id
URI Parameters
HideShow
server_id
string (required) 
Request
HideShow
Headers
Accept: application/json
Response  200
HideShow

A server

Headers
Content-Type: application/json
Body
{
  "srv_id": "proident nulla minim",
  "access": {
    "id": 59813655,
    "client": {
      "id": 91779235,
      "name": "cupidatat id",
      "email": "labore ci"
    },
    "ipmi": true,
    "is_active": true,
    "pxe": false,
    "switch": true
  },
  "addons": [
    {
      "id": 7039485,
      "name": "cillum cupidatat",
      "billing_id": "tempor velit veniam ad"
    },
    {
      "id": 71789995,
      "name": "occaecat officia deserunt mollit",
      "billing_id": "nulla do nostrud co"
    }
  ],
  "billing": {
    "id": -57981444,
    "date": "eu dolore in",
    "integration": {
      "id": 40042082,
      "name": "pariat"
    }
  },
  "canEdit": false,
  "cpu": {
    "id": 32101639,
    "name": "adipisicing ex mollit",
    "billing_id": "exercita"
  },
  "disks": [
    {
      "id": -77138390,
      "name": "magna dolor eu",
      "billing_id": "reprehenderit eiusmod id aliqua irure"
    },
    {
      "id": 97189100,
      "name": "in",
      "billing_id": "eu"
    },
    {
      "id": 48319212,
      "name": "esse laboris pariatur aute labore",
      "billing_id": "ad tempor commodo"
    },
    {
      "id": -50999087,
      "name": "fugiat commodo enim quis consequat",
      "billing_id": "commodo eiusmod ipsum"
    }
  ],
  "entity": {
    "id": -97662340,
    "name": "ea in laborum in exercitation",
    "full_ip": "sint quis id"
  },
  "group": {
    "id": -2006398,
    "name": "fugiat"
  },
  "hdd_counts": [
    {
      "key": 59823977,
      "value": "eiusmod esse nisi"
    },
    {
      "key": 57748509,
      "value": "tempor"
    }
  ],
  "id": 51259440,
  "ipmi": {
    "id": -7408442,
    "admin": {
      "username": "tempor aute cupidatat",
      "password": "dolore est in"
    },
    "client": {
      "username": "Lorem elit",
      "password": "qui id nulla deserunt"
    },
    "ip": "consectetur proident laboris consequat exercitation"
  },
  "is_ipmi_ready": true,
  "is_pxe_ready": true,
  "mem": {
    "id": 70894179,
    "name": "ut",
    "billing_id": "in exercitation et"
  },
  "nickname": "eu nostrud",
  "notes": {
    "client": "labore ipsum nulla",
    "admin": "e"
  },
  "raid_soft_ready": true,
  "status_desc": "proident sint consectetur o",
  "switch": {
    "id": 43149843,
    "name": "dolore ad enim in mollit",
    "port": {
      "id": 66571218,
      "name": "occaecat voluptate nisi inc"
    }
  },
  "usage": {
    "id": -81356232,
    "used": -8410407,
    "max": 63765854
  }
}
Schema
{
  "properties": {
    "access": {
      "properties": {
        "client": {
          "properties": {
            "email": {
              "example": "[email protected]",
              "type": "string"
            },
            "id": {
              "description": "SynergyCP-specific unique identifier used for URLs, etc.",
              "type": "integer"
            },
            "name": {
              "type": "string"
            }
          },
          "required": [
            "id",
            "name",
            "email"
          ],
          "type": "object"
        },
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "ipmi": {
          "description": "Whether or not the Client has been granted IPMI access to the server",
          "type": "boolean"
        },
        "is_active": {
          "description": "Whether or not the Client's access to the server has been suspended",
          "type": "boolean"
        },
        "pxe": {
          "description": "Whether or not the Client has been granted OS Reload access to the server",
          "type": "boolean"
        },
        "switch": {
          "description": "Whether or not the Client has been granted access to turn on/off the server's switch port",
          "type": "boolean"
        }
      },
      "required": [
        "id",
        "client",
        "ipmi",
        "is_active",
        "pxe",
        "switch"
      ],
      "type": "object"
    },
    "addons": {
      "items": {
        "properties": {
          "billing_id": {
            "description": "The billing ID of the part, which is what is used by billing programs like WHMCS.",
            "type": "string"
          },
          "id": {
            "description": "SynergyCP-specific unique identifier used for URLs, etc.",
            "type": "integer"
          },
          "name": {
            "description": "The name of the part, e.g. E3-1270",
            "type": "string"
          }
        },
        "required": [
          "id",
          "name",
          "billing_id"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "billing": {
      "properties": {
        "date": {
          "type": "string"
        },
        "id": {
          "description": "The ID of the server given to us by the billing program. Only unique to that API Integration.",
          "type": "integer"
        },
        "integration": {
          "properties": {
            "id": {
              "description": "SynergyCP-specific unique identifier used for URLs, etc.",
              "type": "integer"
            },
            "name": {
              "type": "string"
            }
          },
          "required": [
            "id",
            "name"
          ],
          "type": "object"
        }
      },
      "required": [
        "id",
        "date",
        "integration"
      ],
      "type": "object"
    },
    "canEdit": {
      "type": "boolean"
    },
    "cpu": {
      "properties": {
        "billing_id": {
          "description": "The billing ID of the part, which is what is used by billing programs like WHMCS.",
          "type": "string"
        },
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "name": {
          "description": "The name of the part, e.g. E3-1270",
          "type": "string"
        }
      },
      "required": [
        "id",
        "name",
        "billing_id"
      ],
      "type": "object"
    },
    "disks": {
      "items": {
        "properties": {
          "billing_id": {
            "description": "The billing ID of the part, which is what is used by billing programs like WHMCS.",
            "type": "string"
          },
          "id": {
            "description": "SynergyCP-specific unique identifier used for URLs, etc.",
            "type": "integer"
          },
          "name": {
            "description": "The name of the part, e.g. E3-1270",
            "type": "string"
          }
        },
        "required": [
          "id",
          "name",
          "billing_id"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "entity": {
      "properties": {
        "full_ip": {
          "type": "string"
        },
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name",
        "full_ip"
      ],
      "type": "object"
    },
    "group": {
      "properties": {
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ],
      "type": "object"
    },
    "hdd_counts": {
      "items": {
        "properties": {
          "key": {
            "description": "The number of the Disk type that are in the server",
            "type": "integer"
          },
          "value": {
            "description": "The name of the Disk type",
            "type": "string"
          }
        },
        "required": [
          "key",
          "value"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "ipmi": {
      "properties": {
        "admin": {
          "properties": {
            "password": {
              "type": "string"
            },
            "username": {
              "type": "string"
            }
          },
          "required": [
            "username",
            "password"
          ],
          "type": "object"
        },
        "client": {
          "properties": {
            "password": {
              "type": "string"
            },
            "username": {
              "type": "string"
            }
          },
          "required": [
            "username",
            "password"
          ],
          "type": "object"
        },
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "ip": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "admin",
        "client",
        "ip"
      ],
      "type": "object"
    },
    "is_ipmi_ready": {
      "type": "boolean"
    },
    "is_pxe_ready": {
      "type": "boolean"
    },
    "mem": {
      "properties": {
        "billing_id": {
          "description": "The billing ID of the part, which is what is used by billing programs like WHMCS.",
          "type": "string"
        },
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "name": {
          "description": "The name of the part, e.g. E3-1270",
          "type": "string"
        }
      },
      "required": [
        "id",
        "name",
        "billing_id"
      ],
      "type": "object"
    },
    "nickname": {
      "description": "The hostname of the server.",
      "type": "string"
    },
    "notes": {
      "properties": {
        "admin": {
          "type": "string"
        },
        "client": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "raid_soft_ready": {
      "type": "boolean"
    },
    "srv_id": {
      "description": "Unique identifier typically labeled on the physical server.",
      "type": "string"
    },
    "status_desc": {
      "type": "string"
    },
    "switch": {
      "properties": {
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "name": {
          "type": "string"
        },
        "port": {
          "properties": {
            "id": {
              "description": "SynergyCP-specific unique identifier used for URLs, etc.",
              "type": "integer"
            },
            "name": {
              "type": "string"
            }
          },
          "required": [
            "id",
            "name"
          ],
          "type": "object"
        }
      },
      "required": [
        "id",
        "name",
        "port"
      ],
      "type": "object"
    },
    "usage": {
      "properties": {
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "max": {
          "description": "Max Bandwidth in bits",
          "type": "integer"
        },
        "used": {
          "description": "Bandwidth used in bits",
          "type": "integer"
        }
      },
      "required": [
        "id",
        "used",
        "max"
      ],
      "type": "object"
    }
  },
  "required": [
    "srv_id",
    "access",
    "addons",
    "billing",
    "canEdit",
    "cpu",
    "disks",
    "entity",
    "group",
    "hdd_counts",
    "id",
    "ipmi",
    "is_ipmi_ready",
    "is_pxe_ready",
    "mem",
    "nickname",
    "notes",
    "raid_soft_ready",
    "status_desc",
    "switch",
    "usage"
  ],
  "type": "object"
}

Update Server
PATCH/server/{server_id}

Use the same field names as the Model fields. Clients can only change the server nickname and client notes.

Example URI

PATCH /server/server_id
URI Parameters
HideShow
server_id
string (required) 
Request
HideShow
Headers
Accept: application/json
Response  200
HideShow

A server

Headers
Content-Type: application/json
Body
{
  "srv_id": "exercitation mollit et",
  "access": {
    "id": 66310480,
    "client": {
      "id": -35013228,
      "name": "magna anim",
      "email": "sed cillum quis"
    },
    "ipmi": true,
    "is_active": true,
    "pxe": true,
    "switch": false
  },
  "addons": [
    {
      "id": 33164487,
      "name": "reprehenderit mollit",
      "billing_id": "laboris"
    },
    {
      "id": -48034579,
      "name": "Lorem consectetur qui aliquip",
      "billing_id": "nulla in proident"
    },
    {
      "id": 21035451,
      "name": "deserunt adipisicing irure occaecat",
      "billing_id": "fugiat ex"
    },
    {
      "id": 35454026,
      "name": "incididunt",
      "billing_id": "dolore incididunt ea voluptate enim"
    }
  ],
  "billing": {
    "id": 16930738,
    "date": "id sunt ullamco",
    "integration": {
      "id": 65406823,
      "name": "Excepteur ex"
    }
  },
  "canEdit": false,
  "cpu": {
    "id": -36378447,
    "name": "ipsum nulla nisi ",
    "billing_id": "anim non sunt"
  },
  "disks": [
    {
      "id": -34247449,
      "name": "",
      "billing_id": "dolor nulla Excepteur ut"
    },
    {
      "id": -97564184,
      "name": "sed in fugiat cillum proident",
      "billing_id": "est sunt"
    }
  ],
  "entity": {
    "id": -72980673,
    "name": "eiusmod dolore nostrud amet",
    "full_ip": "sed laboris Lorem ut"
  },
  "group": {
    "id": -73379768,
    "name": "non exercitation qui officia"
  },
  "hdd_counts": [
    {
      "key": 68760255,
      "value": "voluptate deserunt nisi"
    },
    {
      "key": -14478173,
      "value": "labo"
    },
    {
      "key": -80523132,
      "value": "sit do ut"
    },
    {
      "key": -88700230,
      "value": "cupidatat veniam est proident"
    },
    {
      "key": 18203738,
      "value": "cupidatat labo"
    }
  ],
  "id": -87811336,
  "ipmi": {
    "id": -16518736,
    "admin": {
      "username": "conse",
      "password": "in sit"
    },
    "client": {
      "username": "dolor qui officia adipisicing exercitation",
      "password": "aliqua id dolor deserunt"
    },
    "ip": "elit"
  },
  "is_ipmi_ready": true,
  "is_pxe_ready": true,
  "mem": {
    "id": 3491579,
    "name": "magna laborum eiusmod",
    "billing_id": "aliquip elit officia pariatur ipsum"
  },
  "nickname": "cupidatat non adipisicing est voluptate",
  "notes": {
    "admin": "magna laborum velit ut",
    "client": "sint quis veniam"
  },
  "raid_soft_ready": false,
  "status_desc": "dolore magna ea",
  "switch": {
    "id": 58880544,
    "name": "eu commodo",
    "port": {
      "id": 69468045,
      "name": "pariatur elit consectetur"
    }
  },
  "usage": {
    "id": -59451027,
    "used": -89294187,
    "max": 97005506
  }
}
Schema
{
  "properties": {
    "access": {
      "properties": {
        "client": {
          "properties": {
            "email": {
              "example": "[email protected]",
              "type": "string"
            },
            "id": {
              "description": "SynergyCP-specific unique identifier used for URLs, etc.",
              "type": "integer"
            },
            "name": {
              "type": "string"
            }
          },
          "required": [
            "id",
            "name",
            "email"
          ],
          "type": "object"
        },
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "ipmi": {
          "description": "Whether or not the Client has been granted IPMI access to the server",
          "type": "boolean"
        },
        "is_active": {
          "description": "Whether or not the Client's access to the server has been suspended",
          "type": "boolean"
        },
        "pxe": {
          "description": "Whether or not the Client has been granted OS Reload access to the server",
          "type": "boolean"
        },
        "switch": {
          "description": "Whether or not the Client has been granted access to turn on/off the server's switch port",
          "type": "boolean"
        }
      },
      "required": [
        "id",
        "client",
        "ipmi",
        "is_active",
        "pxe",
        "switch"
      ],
      "type": "object"
    },
    "addons": {
      "items": {
        "properties": {
          "billing_id": {
            "description": "The billing ID of the part, which is what is used by billing programs like WHMCS.",
            "type": "string"
          },
          "id": {
            "description": "SynergyCP-specific unique identifier used for URLs, etc.",
            "type": "integer"
          },
          "name": {
            "description": "The name of the part, e.g. E3-1270",
            "type": "string"
          }
        },
        "required": [
          "id",
          "name",
          "billing_id"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "billing": {
      "properties": {
        "date": {
          "type": "string"
        },
        "id": {
          "description": "The ID of the server given to us by the billing program. Only unique to that API Integration.",
          "type": "integer"
        },
        "integration": {
          "properties": {
            "id": {
              "description": "SynergyCP-specific unique identifier used for URLs, etc.",
              "type": "integer"
            },
            "name": {
              "type": "string"
            }
          },
          "required": [
            "id",
            "name"
          ],
          "type": "object"
        }
      },
      "required": [
        "id",
        "date",
        "integration"
      ],
      "type": "object"
    },
    "canEdit": {
      "type": "boolean"
    },
    "cpu": {
      "properties": {
        "billing_id": {
          "description": "The billing ID of the part, which is what is used by billing programs like WHMCS.",
          "type": "string"
        },
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "name": {
          "description": "The name of the part, e.g. E3-1270",
          "type": "string"
        }
      },
      "required": [
        "id",
        "name",
        "billing_id"
      ],
      "type": "object"
    },
    "disks": {
      "items": {
        "properties": {
          "billing_id": {
            "description": "The billing ID of the part, which is what is used by billing programs like WHMCS.",
            "type": "string"
          },
          "id": {
            "description": "SynergyCP-specific unique identifier used for URLs, etc.",
            "type": "integer"
          },
          "name": {
            "description": "The name of the part, e.g. E3-1270",
            "type": "string"
          }
        },
        "required": [
          "id",
          "name",
          "billing_id"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "entity": {
      "properties": {
        "full_ip": {
          "type": "string"
        },
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name",
        "full_ip"
      ],
      "type": "object"
    },
    "group": {
      "properties": {
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ],
      "type": "object"
    },
    "hdd_counts": {
      "items": {
        "properties": {
          "key": {
            "description": "The number of the Disk type that are in the server",
            "type": "integer"
          },
          "value": {
            "description": "The name of the Disk type",
            "type": "string"
          }
        },
        "required": [
          "key",
          "value"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "ipmi": {
      "properties": {
        "admin": {
          "properties": {
            "password": {
              "type": "string"
            },
            "username": {
              "type": "string"
            }
          },
          "required": [
            "username",
            "password"
          ],
          "type": "object"
        },
        "client": {
          "properties": {
            "password": {
              "type": "string"
            },
            "username": {
              "type": "string"
            }
          },
          "required": [
            "username",
            "password"
          ],
          "type": "object"
        },
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "ip": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "admin",
        "client",
        "ip"
      ],
      "type": "object"
    },
    "is_ipmi_ready": {
      "type": "boolean"
    },
    "is_pxe_ready": {
      "type": "boolean"
    },
    "mem": {
      "properties": {
        "billing_id": {
          "description": "The billing ID of the part, which is what is used by billing programs like WHMCS.",
          "type": "string"
        },
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "name": {
          "description": "The name of the part, e.g. E3-1270",
          "type": "string"
        }
      },
      "required": [
        "id",
        "name",
        "billing_id"
      ],
      "type": "object"
    },
    "nickname": {
      "description": "The hostname of the server.",
      "type": "string"
    },
    "notes": {
      "properties": {
        "admin": {
          "type": "string"
        },
        "client": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "raid_soft_ready": {
      "type": "boolean"
    },
    "srv_id": {
      "description": "Unique identifier typically labeled on the physical server.",
      "type": "string"
    },
    "status_desc": {
      "type": "string"
    },
    "switch": {
      "properties": {
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "name": {
          "type": "string"
        },
        "port": {
          "properties": {
            "id": {
              "description": "SynergyCP-specific unique identifier used for URLs, etc.",
              "type": "integer"
            },
            "name": {
              "type": "string"
            }
          },
          "required": [
            "id",
            "name"
          ],
          "type": "object"
        }
      },
      "required": [
        "id",
        "name",
        "port"
      ],
      "type": "object"
    },
    "usage": {
      "properties": {
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "max": {
          "description": "Max Bandwidth in bits",
          "type": "integer"
        },
        "used": {
          "description": "Bandwidth used in bits",
          "type": "integer"
        }
      },
      "required": [
        "id",
        "used",
        "max"
      ],
      "type": "object"
    }
  },
  "required": [
    "srv_id",
    "access",
    "addons",
    "billing",
    "canEdit",
    "cpu",
    "disks",
    "entity",
    "group",
    "hdd_counts",
    "id",
    "ipmi",
    "is_ipmi_ready",
    "is_pxe_ready",
    "mem",
    "nickname",
    "notes",
    "raid_soft_ready",
    "status_desc",
    "switch",
    "usage"
  ],
  "type": "object"
}

Server Access

List Server Access

List Server Access
GET/server/{server_id}/access

A list of Server Accesses that are currently on the server.

Example URI

GET /server/server_id/access
URI Parameters
HideShow
server_id
string (required) 
Request
HideShow
Headers
Accept: application/json
Response  200
HideShow

A list of Server Accesses

Headers
Content-Type: application/json
Body
[
  {
    "id": 77805858,
    "client": {
      "id": -52953052,
      "name": "irure enim",
      "email": "consectetur"
    },
    "ipmi": true,
    "is_active": true,
    "pxe": true,
    "switch": true
  },
  {
    "id": -22471707,
    "client": {
      "id": 27512001,
      "name": "esse",
      "email": "Duis ex occaecat"
    },
    "ipmi": true,
    "is_active": false,
    "pxe": true,
    "switch": false
  },
  {
    "id": -67385529,
    "client": {
      "id": -66271538,
      "name": "dolore veniam dolor adipisicing est",
      "email": "dolor eiusmod ea voluptate"
    },
    "ipmi": false,
    "is_active": false,
    "pxe": false,
    "switch": true
  }
]
Schema
{
  "items": {
    "properties": {
      "client": {
        "properties": {
          "email": {
            "example": "[email protected]",
            "type": "string"
          },
          "id": {
            "description": "SynergyCP-specific unique identifier used for URLs, etc.",
            "type": "integer"
          },
          "name": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "name",
          "email"
        ],
        "type": "object"
      },
      "id": {
        "description": "SynergyCP-specific unique identifier used for URLs, etc.",
        "type": "integer"
      },
      "ipmi": {
        "description": "Whether or not the Client has been granted IPMI access to the server",
        "type": "boolean"
      },
      "is_active": {
        "description": "Whether or not the Client's access to the server has been suspended",
        "type": "boolean"
      },
      "pxe": {
        "description": "Whether or not the Client has been granted OS Reload access to the server",
        "type": "boolean"
      },
      "switch": {
        "description": "Whether or not the Client has been granted access to turn on/off the server's switch port",
        "type": "boolean"
      }
    },
    "required": [
      "id",
      "client",
      "ipmi",
      "is_active",
      "pxe",
      "switch"
    ],
    "type": "object"
  },
  "type": "array"
}

Create Server Access
POST/server/{server_id}/access

Grant a Client Access on a Server.

Example URI

POST /server/server_id/access
URI Parameters
HideShow
server_id
string (required) 
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "id": -63732861,
  "client": {
    "id": -21184569,
    "name": "consectetur laboris enim",
    "email": "adipisicing cupidatat ut Excepteur"
  },
  "ipmi": true,
  "is_active": false,
  "pxe": true,
  "switch": true
}
Schema
{
  "properties": {
    "client": {
      "properties": {
        "email": {
          "example": "[email protected]",
          "type": "string"
        },
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name",
        "email"
      ],
      "type": "object"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "ipmi": {
      "description": "Whether or not the Client has been granted IPMI access to the server",
      "type": "boolean"
    },
    "is_active": {
      "description": "Whether or not the Client's access to the server has been suspended",
      "type": "boolean"
    },
    "pxe": {
      "description": "Whether or not the Client has been granted OS Reload access to the server",
      "type": "boolean"
    },
    "switch": {
      "description": "Whether or not the Client has been granted access to turn on/off the server's switch port",
      "type": "boolean"
    }
  },
  "required": [
    "id",
    "client",
    "ipmi",
    "is_active",
    "pxe",
    "switch"
  ],
  "type": "object"
}
Response  200
HideShow

A Server Access

Headers
Content-Type: application/json
Body
{
  "id": -37202514,
  "client": {
    "id": -48869162,
    "name": "officia",
    "email": "eu sint nulla pariatur"
  },
  "ipmi": false,
  "is_active": true,
  "pxe": true,
  "switch": false
}
Schema
{
  "properties": {
    "client": {
      "properties": {
        "email": {
          "example": "[email protected]",
          "type": "string"
        },
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name",
        "email"
      ],
      "type": "object"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "ipmi": {
      "description": "Whether or not the Client has been granted IPMI access to the server",
      "type": "boolean"
    },
    "is_active": {
      "description": "Whether or not the Client's access to the server has been suspended",
      "type": "boolean"
    },
    "pxe": {
      "description": "Whether or not the Client has been granted OS Reload access to the server",
      "type": "boolean"
    },
    "switch": {
      "description": "Whether or not the Client has been granted access to turn on/off the server's switch port",
      "type": "boolean"
    }
  },
  "required": [
    "id",
    "client",
    "ipmi",
    "is_active",
    "pxe",
    "switch"
  ],
  "type": "object"
}

Delete Server Access

Delete Server Access
DELETE/server/{server_id}/access/{server_access_id}

Example URI

DELETE /server/server_id/access/server_access_id
URI Parameters
HideShow
server_id
string (required) 
server_access_id
string (required) 
Response  200
HideShow

Server Access deleted.

View Server Access
GET/server/{server_id}/access/{server_access_id}

Example URI

GET /server/server_id/access/server_access_id
URI Parameters
HideShow
server_id
string (required) 
server_access_id
string (required) 
Request
HideShow
Headers
Accept: application/json
Response  200
HideShow

A Server Access

Headers
Content-Type: application/json
Body
{
  "id": 83088502,
  "client": {
    "id": 84373139,
    "name": "dolore reprehenderit ad",
    "email": "veniam"
  },
  "ipmi": true,
  "is_active": true,
  "pxe": false,
  "switch": false
}
Schema
{
  "properties": {
    "client": {
      "properties": {
        "email": {
          "example": "[email protected]",
          "type": "string"
        },
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name",
        "email"
      ],
      "type": "object"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "ipmi": {
      "description": "Whether or not the Client has been granted IPMI access to the server",
      "type": "boolean"
    },
    "is_active": {
      "description": "Whether or not the Client's access to the server has been suspended",
      "type": "boolean"
    },
    "pxe": {
      "description": "Whether or not the Client has been granted OS Reload access to the server",
      "type": "boolean"
    },
    "switch": {
      "description": "Whether or not the Client has been granted access to turn on/off the server's switch port",
      "type": "boolean"
    }
  },
  "required": [
    "id",
    "client",
    "ipmi",
    "is_active",
    "pxe",
    "switch"
  ],
  "type": "object"
}

Server Power Controls

List Server Power Controls

List Server Power Controls
GET/server/{server_id}/control

Example URI

GET /server/server_id/control
URI Parameters
HideShow
server_id
string (required) 
Request
HideShow
Headers
Accept: application/json
Response  200
HideShow

A list of Server Power Controls

Headers
Content-Type: application/json
Body
[
  {
    "id": 3902870,
    "ip": "voluptate anim quis L",
    "client_user": "tempor qui pariatur Excepteur labore",
    "client_password": "non",
    "admin_user": "velit",
    "admin_password": "in in consectetur cillum",
    "server": {
      "id": -28413467,
      "srv_id": "id Lorem Duis laboris ipsum"
    },
    "type": {
      "id": 71004253,
      "name": "ut"
    }
  },
  {
    "id": -63254205,
    "ip": "in dolor Ut",
    "client_user": "aliqua laboris reprehenderit fug",
    "client_password": "enim dolor",
    "admin_user": "Ut",
    "admin_password": "ea ut",
    "server": {
      "id": 76617734,
      "srv_id": "ut Duis sed"
    }
  },
  {
    "id": -74171750,
    "ip": "nisi nostrud ut reprehenderit",
    "client_user": "minim consequat",
    "client_password": "tempor",
    "admin_user": "qui Lorem non consectetur",
    "admin_password": "enim",
    "server": {
      "id": -32135327,
      "srv_id": "ullamco reprehenderit qui eu"
    },
    "type": {
      "id": -37362683,
      "name": "irure enim"
    }
  },
  {
    "id": 30843750,
    "ip": "non incididunt esse dolore nulla",
    "client_user": "sed reprehenderit",
    "client_password": "tempor",
    "admin_user": "anim",
    "admin_password": "et dolor",
    "server": {
      "id": -20323329,
      "srv_id": "quis aute nisi non"
    },
    "type": {
      "id": -74704224,
      "name": "ut aliqua ullamco ad"
    }
  },
  {
    "id": 58525200,
    "ip": "id",
    "client_user": "aliquip mollit sit fugiat veniam",
    "client_password": "sunt cillum",
    "admin_user": "in nostrud dolor tempor",
    "admin_password": "Ut dolore non nulla nos",
    "server": {
      "id": 1829098,
      "srv_id": "enim"
    },
    "type": {
      "id": 83031155,
      "name": "amet esse mollit exercitation"
    }
  }
]
Schema
{
  "items": {
    "properties": {
      "admin_password": {
        "type": "string"
      },
      "admin_user": {
        "type": "string"
      },
      "client_password": {
        "type": "string"
      },
      "client_user": {
        "type": "string"
      },
      "id": {
        "description": "SynergyCP-specific unique identifier used for URLs, etc.",
        "type": "integer"
      },
      "ip": {
        "type": "string"
      },
      "server": {
        "properties": {
          "id": {
            "type": "integer"
          },
          "srv_id": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "srv_id"
        ],
        "type": "object"
      },
      "type": {
        "properties": {
          "id": {
            "type": "integer"
          },
          "name": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "name"
        ],
        "type": "object"
      }
    },
    "required": [
      "id",
      "ip",
      "client_user",
      "client_password",
      "admin_user",
      "admin_password",
      "server"
    ],
    "type": "object"
  },
  "type": "array"
}

Create Server Power Control
POST/server/{server_id}/control

Example URI

POST /server/server_id/control
URI Parameters
HideShow
server_id
string (required) 
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "id": -65272416,
  "ip": "culpa",
  "client_user": "se",
  "client_password": "nisi esse rep",
  "admin_user": "consectetur nostrud anim",
  "admin_password": "aliqua consequ",
  "server": {
    "id": 59642523,
    "srv_id": "ut nostrud eu dolor"
  },
  "type": {
    "id": 3015675,
    "name": "nostrud ex id Ut"
  }
}
Schema
{
  "properties": {
    "admin_password": {
      "type": "string"
    },
    "admin_user": {
      "type": "string"
    },
    "client_password": {
      "type": "string"
    },
    "client_user": {
      "type": "string"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "ip": {
      "type": "string"
    },
    "server": {
      "properties": {
        "id": {
          "type": "integer"
        },
        "srv_id": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "srv_id"
      ],
      "type": "object"
    },
    "type": {
      "properties": {
        "id": {
          "type": "integer"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ],
      "type": "object"
    }
  },
  "required": [
    "id",
    "ip",
    "client_user",
    "client_password",
    "admin_user",
    "admin_password",
    "server"
  ],
  "type": "object"
}
Response  200
HideShow

A Server Power Control

Headers
Content-Type: application/json
Body
{
  "id": -56279605,
  "ip": "ad eiusmod",
  "client_user": "sunt dolor occaecat",
  "client_password": "",
  "admin_user": "ut dolore laboris in est",
  "admin_password": "dolore con",
  "server": {
    "id": 27606754,
    "srv_id": "nulla eu ipsum dolor incididunt"
  },
  "type": {
    "id": -85010301,
    "name": "ut nisi"
  }
}
Schema
{
  "properties": {
    "admin_password": {
      "type": "string"
    },
    "admin_user": {
      "type": "string"
    },
    "client_password": {
      "type": "string"
    },
    "client_user": {
      "type": "string"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "ip": {
      "type": "string"
    },
    "server": {
      "properties": {
        "id": {
          "type": "integer"
        },
        "srv_id": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "srv_id"
      ],
      "type": "object"
    },
    "type": {
      "properties": {
        "id": {
          "type": "integer"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ],
      "type": "object"
    }
  },
  "required": [
    "id",
    "ip",
    "client_user",
    "client_password",
    "admin_user",
    "admin_password",
    "server"
  ],
  "type": "object"
}

Delete Server Power Control

Delete Server Power Control
DELETE/server/{server_id}/control/{server_control_id}

Example URI

DELETE /server/server_id/control/server_control_id
URI Parameters
HideShow
server_id
string (required) 
server_control_id
string (required) 
Response  200
HideShow

Server Power Control deleted.

View Server Power Control
GET/server/{server_id}/control/{server_control_id}

Example URI

GET /server/server_id/control/server_control_id
URI Parameters
HideShow
server_id
string (required) 
server_control_id
string (required) 
Request
HideShow
Headers
Accept: application/json
Response  200
HideShow

A Server Power Control

Headers
Content-Type: application/json
Body
{
  "id": -71559469,
  "ip": "nostrud velit",
  "client_user": "in pariatur",
  "client_password": "aute ipsum sint est cillum",
  "admin_user": "ut Excepteur in nisi tempor",
  "admin_password": "Ut pariatur",
  "server": {
    "id": 70594676,
    "srv_id": "consequat"
  }
}
Schema
{
  "properties": {
    "admin_password": {
      "type": "string"
    },
    "admin_user": {
      "type": "string"
    },
    "client_password": {
      "type": "string"
    },
    "client_user": {
      "type": "string"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "ip": {
      "type": "string"
    },
    "server": {
      "properties": {
        "id": {
          "type": "integer"
        },
        "srv_id": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "srv_id"
      ],
      "type": "object"
    },
    "type": {
      "properties": {
        "id": {
          "type": "integer"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ],
      "type": "object"
    }
  },
  "required": [
    "id",
    "ip",
    "client_user",
    "client_password",
    "admin_user",
    "admin_password",
    "server"
  ],
  "type": "object"
}

Run Power Control Command

Run Power Control Command
POST/server/{server_id}/control/{server_control_id}/command

Example URI

POST /server/server_id/control/server_control_id/command
URI Parameters
HideShow
server_id
string (required) 
server_control_id
string (required) 
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "add_user": true,
  "delete_user": true
}
Schema
{
  "properties": {
    "add_user": {
      "type": "boolean"
    },
    "boot": {
      "properties": {
        "device": {
          "description": "bios, disk, pxe",
          "type": "string"
        },
        "persist": {
          "description": "Whether this setting should persist across future reboots or only applied to the next one.",
          "type": "boolean"
        }
      },
      "type": "object"
    },
    "delete_user": {
      "type": "boolean"
    },
    "power": {
      "description": "on, off (hard shutdown), soft (soft shutdown), cycle (restart)",
      "type": "string"
    },
    "reset_bmc": {
      "type": "boolean"
    }
  },
  "type": "object"
}
Response  209
HideShow

Command created

Server OS Reloads

List OS Reloads

List OS Reloads
GET/server/{server_id}/install

A list of OS Reloads that are currently running or queued on the server.

Example URI

GET /server/server_id/install
URI Parameters
HideShow
server_id
string (required) 
Request
HideShow
Headers
Accept: application/json
Response  200
HideShow

A list of OS Reloads

Headers
Content-Type: application/json
Body
[
  {
    "id": 54680281,
    "percent": 30953207,
    "profile": {
      "id": -55816692,
      "name": "elit quis"
    },
    "server": {
      "id": 6496389,
      "name": "adipisicing voluptate in dese"
    },
    "started_at": {
      "iso_8601": "exercitation amet Duis",
      "unix": -33429970
    },
    "step": 5656706,
    "step_desc": "in aliqua incididunt",
    "steps": -51766881,
    "updated_at": {
      "iso_8601": "enim qui",
      "unix": -76455404
    }
  },
  {
    "id": -89036252,
    "percent": 24360274,
    "profile": {
      "id": -978814,
      "name": "amet nostrud minim culpa exercitation"
    },
    "server": {
      "id": -56184229,
      "name": "qui in Ut tempor enim"
    },
    "started_at": {
      "iso_8601": "cupidatat voluptate proident velit dolore",
      "unix": 42603029
    },
    "step": -49374367,
    "step_desc": "esse laborum commodo elit",
    "steps": 21278363,
    "updated_at": {
      "iso_8601": "adipisicing dolor non et ex",
      "unix": -89948478
    }
  }
]
Schema
{
  "items": {
    "properties": {
      "id": {
        "description": "SynergyCP-specific unique identifier used for URLs, etc.",
        "type": "integer"
      },
      "percent": {
        "description": "The percentage of the install that is completed.",
        "type": "integer"
      },
      "profile": {
        "properties": {
          "id": {
            "type": "integer"
          },
          "name": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "name"
        ],
        "type": "object"
      },
      "server": {
        "properties": {
          "id": {
            "type": "integer"
          },
          "name": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "name"
        ],
        "type": "object"
      },
      "started_at": {
        "properties": {
          "iso_8601": {
            "description": "IS0 8601-formatted Date",
            "type": "string"
          },
          "unix": {
            "description": "Seconds since Unix epoch (Unix Timestamp)",
            "type": "integer"
          }
        },
        "required": [
          "iso_8601",
          "unix"
        ],
        "type": "object"
      },
      "step": {
        "description": "Index of the step that the install is on.",
        "type": "integer"
      },
      "step_desc": {
        "description": "Name for the step that the install is on.",
        "type": "string"
      },
      "steps": {
        "description": "The total number of steps that will be involved in the install.",
        "type": "integer"
      },
      "updated_at": {
        "properties": {
          "iso_8601": {
            "description": "IS0 8601-formatted Date",
            "type": "string"
          },
          "unix": {
            "description": "Seconds since Unix epoch (Unix Timestamp)",
            "type": "integer"
          }
        },
        "required": [
          "iso_8601",
          "unix"
        ],
        "type": "object"
      }
    },
    "required": [
      "id",
      "percent",
      "profile",
      "server",
      "started_at",
      "step",
      "step_desc",
      "steps",
      "updated_at"
    ],
    "type": "object"
  },
  "type": "array"
}

Start OS Reload
POST/server/{server_id}/install

Start a new OS Reload on the server.

Example URI

POST /server/server_id/install
URI Parameters
HideShow
server_id
string (required) 
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "disk": {
    "index": 36923763,
    "raid": 14323653
  },
  "password": "tempor incididunt veniam Ut aute",
  "pxe_profile_id": -41476966,
  "pxe_profile_billing": "culpa mollit dolore ad",
  "license_key": "fugiat aliqua deserunt",
  "iso_install_id": -81667724,
  "queue": false
}
Schema
{
  "properties": {
    "disk": {
      "properties": {
        "index": {
          "description": "The zero-based index of the disk that the install should occur on.",
          "type": "integer"
        },
        "raid": {
          "description": "1 or 0 or null",
          "type": "integer"
        }
      },
      "type": "object"
    },
    "iso_install_id": {
      "description": "(Optional) ID of the Windows Edition to install.",
      "type": "integer"
    },
    "license_key": {
      "description": "Only useful on Windows installs. Leave blank for trial.",
      "type": "string"
    },
    "password": {
      "type": "string"
    },
    "pxe_profile_billing": {
      "type": "string"
    },
    "pxe_profile_id": {
      "description": "At least one of pxe_profile_id, pxe_profile_billing must be specified.",
      "type": "integer"
    },
    "queue": {
      "description": "(Optional) If there is another install already running, queue the install given. Defaults to false, in which case starting an install while anothe is running yields an error.",
      "type": "boolean"
    }
  },
  "required": [
    "disk",
    "password",
    "pxe_profile_id",
    "pxe_profile_billing",
    "license_key",
    "iso_install_id",
    "queue"
  ]
}
Response  200
HideShow

An OS Reload

Headers
Content-Type: application/json
Body
{
  "id": 30937311,
  "percent": 20481538,
  "profile": {
    "id": 68622485,
    "name": "dolor veniam ea ut occaecat"
  },
  "server": {
    "id": 14851289,
    "name": "incididunt proident tempor esse"
  },
  "started_at": {
    "iso_8601": "minim",
    "unix": 69805831
  },
  "step": 98665680,
  "step_desc": "ex in",
  "steps": -36191464,
  "updated_at": {
    "iso_8601": "reprehenderit",
    "unix": 79919072
  }
}
Schema
{
  "properties": {
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "percent": {
      "description": "The percentage of the install that is completed.",
      "type": "integer"
    },
    "profile": {
      "properties": {
        "id": {
          "type": "integer"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ],
      "type": "object"
    },
    "server": {
      "properties": {
        "id": {
          "type": "integer"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ],
      "type": "object"
    },
    "started_at": {
      "properties": {
        "iso_8601": {
          "description": "IS0 8601-formatted Date",
          "type": "string"
        },
        "unix": {
          "description": "Seconds since Unix epoch (Unix Timestamp)",
          "type": "integer"
        }
      },
      "required": [
        "iso_8601",
        "unix"
      ],
      "type": "object"
    },
    "step": {
      "description": "Index of the step that the install is on.",
      "type": "integer"
    },
    "step_desc": {
      "description": "Name for the step that the install is on.",
      "type": "string"
    },
    "steps": {
      "description": "The total number of steps that will be involved in the install.",
      "type": "integer"
    },
    "updated_at": {
      "properties": {
        "iso_8601": {
          "description": "IS0 8601-formatted Date",
          "type": "string"
        },
        "unix": {
          "description": "Seconds since Unix epoch (Unix Timestamp)",
          "type": "integer"
        }
      },
      "required": [
        "iso_8601",
        "unix"
      ],
      "type": "object"
    }
  },
  "required": [
    "id",
    "percent",
    "profile",
    "server",
    "started_at",
    "step",
    "step_desc",
    "steps",
    "updated_at"
  ],
  "type": "object"
}

Delete OS Reload.

Delete OS Reload.
DELETE/server/{server_id}/install/{install_id}

Example URI

DELETE /server/server_id/install/install_id
URI Parameters
HideShow
server_id
string (required) 
install_id
string (required) 
Response  200
HideShow

OS Reload deleted.

View OS Reload
GET/server/{server_id}/install/{install_id}

View OS Reload.

Example URI

GET /server/server_id/install/install_id
URI Parameters
HideShow
server_id
string (required) 
install_id
string (required) 
Request
HideShow
Headers
Accept: application/json
Response  200
HideShow

An OS Reload

Headers
Content-Type: application/json
Body
{
  "id": 42764840,
  "percent": -45415248,
  "profile": {
    "id": 48047185,
    "name": "nisi in anim ad sed"
  },
  "server": {
    "id": -88929527,
    "name": "ullamco sunt"
  },
  "started_at": {
    "iso_8601": "officia",
    "unix": -16813006
  },
  "step": -92403078,
  "step_desc": "eiusmod deserunt velit",
  "steps": -73738756,
  "updated_at": {
    "iso_8601": "labore ex tempor id",
    "unix": 17293876
  }
}
Schema
{
  "properties": {
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "percent": {
      "description": "The percentage of the install that is completed.",
      "type": "integer"
    },
    "profile": {
      "properties": {
        "id": {
          "type": "integer"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ],
      "type": "object"
    },
    "server": {
      "properties": {
        "id": {
          "type": "integer"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ],
      "type": "object"
    },
    "started_at": {
      "properties": {
        "iso_8601": {
          "description": "IS0 8601-formatted Date",
          "type": "string"
        },
        "unix": {
          "description": "Seconds since Unix epoch (Unix Timestamp)",
          "type": "integer"
        }
      },
      "required": [
        "iso_8601",
        "unix"
      ],
      "type": "object"
    },
    "step": {
      "description": "Index of the step that the install is on.",
      "type": "integer"
    },
    "step_desc": {
      "description": "Name for the step that the install is on.",
      "type": "string"
    },
    "steps": {
      "description": "The total number of steps that will be involved in the install.",
      "type": "integer"
    },
    "updated_at": {
      "properties": {
        "iso_8601": {
          "description": "IS0 8601-formatted Date",
          "type": "string"
        },
        "unix": {
          "description": "Seconds since Unix epoch (Unix Timestamp)",
          "type": "integer"
        }
      },
      "required": [
        "iso_8601",
        "unix"
      ],
      "type": "object"
    }
  },
  "required": [
    "id",
    "percent",
    "profile",
    "server",
    "started_at",
    "step",
    "step_desc",
    "steps",
    "updated_at"
  ],
  "type": "object"
}

Server Ports

List Server Ports

List Server Ports
GET/server/{server_id}/port

A list of Server Ports that are on the server.

Example URI

GET /server/server_id/port
URI Parameters
HideShow
server_id
string (required) 
Request
HideShow
Headers
Accept: application/json
Response  200
HideShow

A list of Server Ports

Headers
Content-Type: application/json
Body
[
  {
    "id": -4080730,
    "name": "veniam deserunt dolore",
    "mac": "mollit",
    "group": {
      "id": -35609885,
      "name": "laborum Excepteur"
    },
    "is_billable": true,
    "billing": {
      "date": "id"
    },
    "switch": {
      "port": {
        "name": "ut mag",
        "speed": {
          "id": 17556746,
          "name": "dolor"
        }
      }
    }
  },
  {
    "id": 65412236,
    "name": "quis ",
    "mac": "nostrud",
    "group": {
      "id": 77929324,
      "name": "tempor eiusmod culpa ad"
    },
    "is_billable": true,
    "billing": {
      "date": "laboris enim Duis do"
    },
    "switch": {
      "port": {
        "name": "reprehenderit",
        "speed": {
          "id": 36933952,
          "name": "tempor aliquip non"
        }
      }
    }
  },
  {
    "id": 99349964,
    "name": "sit",
    "mac": "cillum aute",
    "group": {
      "id": 84196833,
      "name": "ipsum culpa non"
    },
    "is_billable": false,
    "billing": {
      "date": "aliquip Ut"
    },
    "switch": {
      "port": {
        "name": "officia dolore adipisicing",
        "speed": {
          "id": -9799303,
          "name": "labore ut aliqua"
        }
      }
    }
  },
  {
    "id": 36183777,
    "name": "occaecat dolor do ex",
    "mac": "velit dolore consequat Excepteur",
    "group": {
      "id": -65328542,
      "name": "ut"
    },
    "is_billable": false,
    "billing": {
      "date": "ut"
    },
    "switch": {
      "port": {
        "name": "officia ut elit sint consectet",
        "speed": {
          "id": -3138508,
          "name": "officia laborum veniam deserunt"
        }
      }
    }
  }
]
Schema
{
  "items": {
    "properties": {
      "billing": {
        "properties": {
          "date": {
            "type": "string"
          }
        },
        "required": [
          "date"
        ],
        "type": "object"
      },
      "group": {
        "properties": {
          "id": {
            "description": "SynergyCP-specific unique identifier used for URLs, etc.",
            "type": "integer"
          },
          "name": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "name"
        ],
        "type": "object"
      },
      "id": {
        "description": "SynergyCP-specific unique identifier used for URLs, etc.",
        "type": "integer"
      },
      "is_billable": {
        "type": "boolean"
      },
      "mac": {
        "type": "string"
      },
      "name": {
        "type": "string"
      },
      "switch": {
        "properties": {
          "port": {
            "properties": {
              "name": {
                "type": "string"
              },
              "speed": {
                "properties": {
                  "id": {
                    "description": "SynergyCP-specific unique identifier used for URLs, etc.",
                    "type": "integer"
                  },
                  "name": {
                    "type": "string"
                  }
                },
                "required": [
                  "id",
                  "name"
                ],
                "type": "object"
              }
            },
            "required": [
              "name",
              "speed"
            ],
            "type": "object"
          }
        },
        "required": [
          "port"
        ],
        "type": "object"
      }
    },
    "required": [
      "id",
      "name",
      "mac",
      "group",
      "is_billable",
      "billing",
      "switch"
    ],
    "type": "object"
  },
  "type": "array"
}

Create Server Port
POST/server/{server_id}/port

Example URI

POST /server/server_id/port
URI Parameters
HideShow
server_id
string (required) 
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "id": 56311006,
  "name": "nisi",
  "mac": "in anim esse reprehenderit",
  "group": {
    "id": 51889841,
    "name": "pariatur"
  },
  "is_billable": true,
  "billing": {
    "date": "irure"
  },
  "switch": {
    "port": {
      "name": "cillum aliqua esse",
      "speed": {
        "id": 34992564,
        "name": "qui deserunt quis aliquip fugiat"
      }
    }
  }
}
Schema
{
  "properties": {
    "billing": {
      "properties": {
        "date": {
          "type": "string"
        }
      },
      "required": [
        "date"
      ],
      "type": "object"
    },
    "group": {
      "properties": {
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ],
      "type": "object"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "is_billable": {
      "type": "boolean"
    },
    "mac": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "switch": {
      "properties": {
        "port": {
          "properties": {
            "name": {
              "type": "string"
            },
            "speed": {
              "properties": {
                "id": {
                  "description": "SynergyCP-specific unique identifier used for URLs, etc.",
                  "type": "integer"
                },
                "name": {
                  "type": "string"
                }
              },
              "required": [
                "id",
                "name"
              ],
              "type": "object"
            }
          },
          "required": [
            "name",
            "speed"
          ],
          "type": "object"
        }
      },
      "required": [
        "port"
      ],
      "type": "object"
    }
  },
  "required": [
    "id",
    "name",
    "mac",
    "group",
    "is_billable",
    "billing",
    "switch"
  ],
  "type": "object"
}
Response  200
HideShow

A Server Port

Headers
Content-Type: application/json
Body
{
  "id": 68017666,
  "name": "commodo",
  "mac": "consequat",
  "group": {
    "id": 64623228,
    "name": "laboris reprehenderit aute ad"
  },
  "is_billable": true,
  "billing": {
    "date": "amet irure magna culpa ullamco"
  },
  "switch": {
    "port": {
      "name": "dolor et anim Duis laborum",
      "speed": {
        "id": -86954553,
        "name": "esse elit"
      }
    }
  }
}
Schema
{
  "properties": {
    "billing": {
      "properties": {
        "date": {
          "type": "string"
        }
      },
      "required": [
        "date"
      ],
      "type": "object"
    },
    "group": {
      "properties": {
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ],
      "type": "object"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "is_billable": {
      "type": "boolean"
    },
    "mac": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "switch": {
      "properties": {
        "port": {
          "properties": {
            "name": {
              "type": "string"
            },
            "speed": {
              "properties": {
                "id": {
                  "description": "SynergyCP-specific unique identifier used for URLs, etc.",
                  "type": "integer"
                },
                "name": {
                  "type": "string"
                }
              },
              "required": [
                "id",
                "name"
              ],
              "type": "object"
            }
          },
          "required": [
            "name",
            "speed"
          ],
          "type": "object"
        }
      },
      "required": [
        "port"
      ],
      "type": "object"
    }
  },
  "required": [
    "id",
    "name",
    "mac",
    "group",
    "is_billable",
    "billing",
    "switch"
  ],
  "type": "object"
}

Delete Server Port

Delete Server Port
DELETE/server/{server_id}/port/{server_port_id}

Example URI

DELETE /server/server_id/port/server_port_id
URI Parameters
HideShow
server_id
string (required) 
server_port_id
string (required) 
Response  200
HideShow

Server Port deleted.

View Server Port
GET/server/{server_id}/port/{server_port_id}

Example URI

GET /server/server_id/port/server_port_id
URI Parameters
HideShow
server_id
string (required) 
server_port_id
string (required) 
Request
HideShow
Headers
Accept: application/json
Response  200
HideShow

A Server Port

Headers
Content-Type: application/json
Body
{
  "id": 21172907,
  "name": "dolore dolore Duis velit",
  "mac": "voluptate qui proident",
  "group": {
    "id": -89885504,
    "name": "in "
  },
  "is_billable": true,
  "billing": {
    "date": "veniam esse"
  },
  "switch": {
    "port": {
      "name": "dolor elit in",
      "speed": {
        "id": -46632814,
        "name": "magna amet"
      }
    }
  }
}
Schema
{
  "properties": {
    "billing": {
      "properties": {
        "date": {
          "type": "string"
        }
      },
      "required": [
        "date"
      ],
      "type": "object"
    },
    "group": {
      "properties": {
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ],
      "type": "object"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "is_billable": {
      "type": "boolean"
    },
    "mac": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "switch": {
      "properties": {
        "port": {
          "properties": {
            "name": {
              "type": "string"
            },
            "speed": {
              "properties": {
                "id": {
                  "description": "SynergyCP-specific unique identifier used for URLs, etc.",
                  "type": "integer"
                },
                "name": {
                  "type": "string"
                }
              },
              "required": [
                "id",
                "name"
              ],
              "type": "object"
            }
          },
          "required": [
            "name",
            "speed"
          ],
          "type": "object"
        }
      },
      "required": [
        "port"
      ],
      "type": "object"
    }
  },
  "required": [
    "id",
    "name",
    "mac",
    "group",
    "is_billable",
    "billing",
    "switch"
  ],
  "type": "object"
}

Run Switch Command

Run Switch Command
POST/server/{server_id}/port/{server_port_id}/command

Example URI

POST /server/server_id/port/server_port_id/command
URI Parameters
HideShow
server_id
string (required) 
server_port_id
string (required) 
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "command": "ex"
}
Schema
{
  "properties": {
    "command": {
      "description": "The command to run. Options include: power-off, power-on, sync-speed, sync-vlan",
      "type": "string"
    }
  },
  "type": "object"
}
Response  209
HideShow

Command created