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": 78936610,
    "name": "do",
    "email": "eiusmod occaecat"
  },
  {
    "id": -25924725,
    "name": "laborum dolor",
    "email": "consecte"
  },
  {
    "id": -15365732,
    "name": "laborum consectetur est",
    "email": "laboris et aliqua"
  },
  {
    "id": -66838919,
    "name": "pariatur non",
    "email": "elit"
  },
  {
    "id": 8215434,
    "name": "exercitation",
    "email": "voluptate"
  }
]
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": 41608358,
  "name": "aliqua",
  "email": "sed non ea aliquip"
}
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": -75244238,
  "name": "amet anim proident cillum",
  "email": "Excepteur exercitation dolore sunt ullamco"
}
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": "ipsum",
    "access": {
      "id": 19814395,
      "client": {
        "id": 68700761,
        "name": "id iru",
        "email": ""
      },
      "ipmi": true,
      "is_active": true,
      "pxe": true,
      "switch": false
    },
    "addons": [
      {
        "id": 40186665,
        "name": "non dolor exercitation",
        "billing_id": "enim officia"
      },
      {
        "id": 71211856,
        "name": "veniam mollit occaecat nostrud",
        "billing_id": "ut irure"
      }
    ],
    "billing": {
      "id": -52896051,
      "date": "ut consectetur voluptate nisi eiusmod",
      "integration": {
        "id": -57088714,
        "name": "Lorem sed Ut"
      }
    },
    "canEdit": true,
    "cpu": {
      "id": 46183896,
      "name": "dolor",
      "billing_id": "culpa nulla deseru"
    },
    "disks": [
      {
        "id": -43032667,
        "name": "labore do",
        "billing_id": "voluptate nulla qui ullamco"
      },
      {
        "id": -56902096,
        "name": "id laborum do fugiat adipisicing",
        "billing_id": "adipisicing Lorem occaecat exercitation"
      },
      {
        "id": 87953595,
        "name": "est exercitation cillum aliqua culpa",
        "billing_id": "minim enim"
      },
      {
        "id": 76472480,
        "name": "ut esse e",
        "billing_id": "cillum Lorem"
      },
      {
        "id": -13224050,
        "name": "laboris occaecat fugiat",
        "billing_id": "anim nisi adipisicing velit est"
      }
    ],
    "entity": {
      "id": 14275056,
      "name": "in te",
      "full_ip": "nulla"
    },
    "group": {
      "id": -63651601,
      "name": "commodo et magna"
    },
    "hdd_counts": [
      {
        "key": -96177716,
        "value": "voluptate"
      },
      {
        "key": -96007391,
        "value": "anim"
      }
    ],
    "id": -18944266,
    "ipmi": {
      "id": 76092059,
      "admin": {
        "username": "laborum velit veniam esse",
        "password": "fugiat sunt irure qui laboris"
      },
      "client": {
        "username": "officia Duis labore in ea",
        "password": "labore magna deserunt irure"
      },
      "ip": "Excepteur"
    },
    "is_ipmi_ready": false,
    "is_pxe_ready": true,
    "mem": {
      "id": -10193644,
      "name": "fugiat pariatur voluptate adipisicing ut",
      "billing_id": "dolor aliqua est enim"
    },
    "nickname": "aute adipisicing esse in ex",
    "notes": {},
    "raid_soft_ready": true,
    "status_desc": "dolore",
    "switch": {
      "id": 41115250,
      "name": "Excepteur ex sint",
      "port": {
        "id": -64356063,
        "name": "nostrud"
      }
    },
    "usage": {
      "id": -2014630,
      "used": 38862098,
      "max": -63616281
    }
  }
]
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": "laborum dolor Ut aute Duis",
  "access": {
    "id": 40224513,
    "client": {
      "id": 27691718,
      "name": "ullamco ut",
      "email": "enim nostrud esse"
    },
    "ipmi": false,
    "is_active": false,
    "pxe": false,
    "switch": true
  },
  "addons": [
    {
      "id": -24125941,
      "name": "eu sint sed ea culpa",
      "billing_id": "et elit in Lorem"
    },
    {
      "id": -53352907,
      "name": "quis sed",
      "billing_id": "dolore occaecat dolor tempor ex"
    },
    {
      "id": -97232548,
      "name": "dolore laborum veniam dolore",
      "billing_id": "elit est et deserunt sit"
    },
    {
      "id": 7667148,
      "name": "sed ut Lorem ullamco",
      "billing_id": "culpa"
    }
  ],
  "billing": {
    "id": 17118700,
    "date": "voluptate id ea qui eu",
    "integration": {
      "id": 93608679,
      "name": "culpa"
    }
  },
  "canEdit": true,
  "cpu": {
    "id": -34513441,
    "name": "est",
    "billing_id": "est fugiat laborum ad Duis"
  },
  "disks": [
    {
      "id": -57999902,
      "name": "in",
      "billing_id": "proide"
    },
    {
      "id": -50609464,
      "name": "veniam proiden",
      "billing_id": "sit consectetur fugiat velit"
    },
    {
      "id": 21826043,
      "name": "consequat in dolor",
      "billing_id": "magna veniam voluptate"
    },
    {
      "id": 99915827,
      "name": "est deserunt anim",
      "billing_id": "id consequat incididu"
    },
    {
      "id": -41581524,
      "name": "elit cillum Ut",
      "billing_id": "nisi in adipisicing"
    }
  ],
  "entity": {
    "id": 13440099,
    "name": "enim cillum",
    "full_ip": "sit"
  },
  "group": {
    "id": -1019148,
    "name": "commodo proident"
  },
  "hdd_counts": [
    {
      "key": -71490597,
      "value": "Duis consectetur"
    },
    {
      "key": -2809309,
      "value": "dolore laborum velit amet do"
    }
  ],
  "id": 86086188,
  "ipmi": {
    "id": 60300012,
    "admin": {
      "username": "magna exercitation sed nisi Ut",
      "password": "qui voluptate"
    },
    "client": {
      "username": "et mollit",
      "password": "Ut"
    },
    "ip": "Excepteur cupidatat sint consequat"
  },
  "is_ipmi_ready": false,
  "is_pxe_ready": false,
  "mem": {
    "id": 93690918,
    "name": "minim eiusmod consequat laboris",
    "billing_id": "id elit ut"
  },
  "nickname": "non dolore amet deserunt aliqua",
  "notes": {},
  "raid_soft_ready": false,
  "status_desc": "id nulla dolor tempor Ut",
  "switch": {
    "id": -70129273,
    "name": "nostrud ut laboris deserunt",
    "port": {
      "id": -1693788,
      "name": "reprehenderit laborum in id"
    }
  },
  "usage": {
    "id": -94289689,
    "used": 61620103,
    "max": -8244194
  }
}
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": "mollit",
  "access": {
    "id": -12835679,
    "client": {
      "id": 44678989,
      "name": "culpa labore ",
      "email": "exercitation in dolor ut"
    },
    "ipmi": true,
    "is_active": true,
    "pxe": false,
    "switch": true
  },
  "addons": [
    {
      "id": -27470015,
      "name": "voluptate eu quis",
      "billing_id": "sunt sint est"
    },
    {
      "id": 34236001,
      "name": "in cillum",
      "billing_id": "consequat occaecat"
    }
  ],
  "billing": {
    "id": 535392,
    "date": "esse",
    "integration": {
      "id": 81149733,
      "name": "reprehenderit consequat qui nulla dolore"
    }
  },
  "canEdit": false,
  "cpu": {
    "id": 82062655,
    "name": "aliqua aliquip",
    "billing_id": "aute tempor proident nisi aliquip"
  },
  "disks": [
    {
      "id": -69436766,
      "name": "tempor exercitation ea ut",
      "billing_id": "tempor occaecat Excepteur eiusmod"
    },
    {
      "id": 62233832,
      "name": "ut tempor ullamco magna",
      "billing_id": "Lorem ea velit"
    },
    {
      "id": 74368321,
      "name": "ex",
      "billing_id": "officia consequat velit ad dolor"
    },
    {
      "id": -19666336,
      "name": "voluptate",
      "billing_id": "nostrud minim sed irure pariatur"
    }
  ],
  "entity": {
    "id": -87920779,
    "name": "irure amet",
    "full_ip": "Lorem"
  },
  "group": {
    "id": -64931270,
    "name": "et"
  },
  "hdd_counts": [
    {
      "key": -54593759,
      "value": "dolore aliquip dolor"
    },
    {
      "key": -95903712,
      "value": "aliqua cillum aliquip eu"
    }
  ],
  "id": 70668516,
  "ipmi": {
    "id": 62296866,
    "admin": {
      "username": "aute aliqua eu",
      "password": "ex"
    },
    "client": {
      "username": "laborum aliquip amet",
      "password": "do sit dolo"
    },
    "ip": "Duis ipsum irure"
  },
  "is_ipmi_ready": false,
  "is_pxe_ready": false,
  "mem": {
    "id": -97491841,
    "name": "in nostrud",
    "billing_id": "laboris anim cupidatat"
  },
  "nickname": "voluptate ea ullamco officia",
  "notes": {},
  "raid_soft_ready": false,
  "status_desc": "aliquip",
  "switch": {
    "id": 52027059,
    "name": "mollit pariatur elit dolor in",
    "port": {
      "id": -8390814,
      "name": "eiusmod fugiat"
    }
  },
  "usage": {
    "id": -74485545,
    "used": -39419810,
    "max": -34206378
  }
}
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": 99122261,
    "client": {
      "id": 433928,
      "name": "occaecat dolor",
      "email": "Ut"
    },
    "ipmi": false,
    "is_active": true,
    "pxe": true,
    "switch": false
  },
  {
    "id": 76171161,
    "client": {
      "id": -74862086,
      "name": "dolore Excepteur",
      "email": "deserunt commodo"
    },
    "ipmi": true,
    "is_active": false,
    "pxe": true,
    "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": 50070719,
  "client": {
    "id": 42529705,
    "name": "do ut Ut dolore dolore",
    "email": "nostrud"
  },
  "ipmi": true,
  "is_active": false,
  "pxe": false,
  "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": -52910979,
  "client": {
    "id": -68354627,
    "name": "qui",
    "email": "occaecat do"
  },
  "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"
}

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": -38925564,
  "client": {
    "id": 34506018,
    "name": "eu elit Duis sed",
    "email": "irure enim in deserunt"
  },
  "ipmi": true,
  "is_active": false,
  "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"
}

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": -3953451,
    "ip": "dolor labore dolore dolore",
    "client_user": "officia s",
    "client_password": "ex esse",
    "admin_user": "sed amet",
    "admin_password": "velit nostrud Duis proident",
    "server": {
      "id": 34059519,
      "srv_id": "veniam"
    },
    "type": {
      "id": -55292310,
      "name": "anim cupidatat"
    }
  },
  {
    "id": -21045702,
    "ip": "eiusmod",
    "client_user": "ipsum officia",
    "client_password": "amet in id",
    "admin_user": "esse aliquip",
    "admin_password": "est proident",
    "server": {
      "id": 67341355,
      "srv_id": "occaecat"
    },
    "type": {
      "id": -57636962,
      "name": "ut tempor dolore quis nisi"
    }
  },
  {
    "id": 73086385,
    "ip": "dolor",
    "client_user": "ut sunt magna",
    "client_password": "Lorem Excepteur in magna voluptate",
    "admin_user": "ea sunt proident et velit",
    "admin_password": "deserunt voluptate",
    "server": {
      "id": 86259807,
      "srv_id": "incididunt et Excepteur consectetur id"
    }
  },
  {
    "id": -64083472,
    "ip": "qui",
    "client_user": "elit ipsum id",
    "client_password": "nulla non dolore aliqua",
    "admin_user": "dolore aute quis Duis occaecat",
    "admin_password": "fugiat",
    "server": {
      "id": 83850409,
      "srv_id": "in mollit"
    }
  }
]
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": -35025584,
  "ip": "eu aliqua",
  "client_user": "dolor qui cillum nisi",
  "client_password": "commodo dolor proident",
  "admin_user": "est eu id Duis",
  "admin_password": "pariatur ipsum fugiat",
  "server": {
    "id": 13858718,
    "srv_id": "consectetur cu"
  },
  "type": {
    "id": -18171098,
    "name": "elit eu laborum exercitation officia"
  }
}
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": -51997334,
  "ip": "commodo esse",
  "client_user": "Lorem sint",
  "client_password": "minim",
  "admin_user": "dolore irure dolor",
  "admin_password": "eiusmod enim",
  "server": {
    "id": -6553241,
    "srv_id": "non"
  },
  "type": {
    "id": 32863629,
    "name": "enim consectetur"
  }
}
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": -89222793,
  "ip": "irure do",
  "client_user": "incididunt non mollit amet velit",
  "client_password": "voluptate in exercitation",
  "admin_user": "proident sed",
  "admin_password": "est",
  "server": {
    "id": 93410737,
    "srv_id": "officia eiusmod id non"
  },
  "type": {
    "id": -63786949,
    "name": "anim"
  }
}
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
{}
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": 57798449,
    "percent": 38492042,
    "profile": {
      "id": -88110214,
      "name": "qui Excepteur ad tempor"
    },
    "server": {
      "id": -18053906,
      "name": "officia dolor sunt"
    },
    "started_at": {
      "iso_8601": "consectetur pariatur cillum adipisicing",
      "unix": 24557910
    },
    "step": -14970869,
    "step_desc": "aliqua",
    "steps": -19186240,
    "updated_at": {
      "iso_8601": "Excepteur",
      "unix": 79760129
    }
  },
  {
    "id": 41328408,
    "percent": -52510389,
    "profile": {
      "id": -88313227,
      "name": "ut aliquip velit"
    },
    "server": {
      "id": -64940075,
      "name": "magna aute est"
    },
    "started_at": {
      "iso_8601": "aliqua non Ut dolore",
      "unix": -34085707
    },
    "step": 81477582,
    "step_desc": "veniam",
    "steps": -68870132,
    "updated_at": {
      "iso_8601": "id aliquip in",
      "unix": 77565255
    }
  },
  {
    "id": -52758114,
    "percent": -7358809,
    "profile": {
      "id": 92193062,
      "name": "incididunt nisi reprehenderit dolore est"
    },
    "server": {
      "id": 46447446,
      "name": "labore magna deserunt voluptate"
    },
    "started_at": {
      "iso_8601": "incididunt Duis amet adipisicing",
      "unix": -14471859
    },
    "step": 67415584,
    "step_desc": "est sunt deserunt",
    "steps": 50289406,
    "updated_at": {
      "iso_8601": "veniam",
      "unix": 39315807
    }
  },
  {
    "id": -98325816,
    "percent": 3956558,
    "profile": {
      "id": 80383444,
      "name": "repr"
    },
    "server": {
      "id": 43635041,
      "name": "Lorem"
    },
    "started_at": {
      "iso_8601": "ani",
      "unix": 22481309
    },
    "step": -6341070,
    "step_desc": "nulla eiusmod voluptate",
    "steps": 72935319,
    "updated_at": {
      "iso_8601": "dolore",
      "unix": -54864013
    }
  },
  {
    "id": 24234892,
    "percent": -79353861,
    "profile": {
      "id": 78977608,
      "name": "Lorem non ut est"
    },
    "server": {
      "id": 51358493,
      "name": "consequat"
    },
    "started_at": {
      "iso_8601": "do dolor irure officia anim",
      "unix": -66270991
    },
    "step": 20519969,
    "step_desc": "aliqua fugiat eu",
    "steps": 36903539,
    "updated_at": {
      "iso_8601": "in sed nostrud quis consequat",
      "unix": 37701636
    }
  }
]
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": -315277,
    "raid": -15507119
  },
  "password": "enim ea culpa",
  "pxe_profile_id": 9817020,
  "pxe_profile_billing": "incididunt proident adipisicin",
  "license_key": "Ut occaecat dolore",
  "iso_install_id": -33555955,
  "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": -42294018,
  "percent": 47480697,
  "profile": {
    "id": -19788792,
    "name": "culpa"
  },
  "server": {
    "id": 46214475,
    "name": "Ut sed"
  },
  "started_at": {
    "iso_8601": "sit laboris id",
    "unix": -58874965
  },
  "step": 69554541,
  "step_desc": "aute ad officia dolor",
  "steps": -59976458,
  "updated_at": {
    "iso_8601": "et ex",
    "unix": -47853390
  }
}
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": 42739471,
  "percent": -34948019,
  "profile": {
    "id": 74452800,
    "name": "non irure"
  },
  "server": {
    "id": 27667435,
    "name": "non sit esse"
  },
  "started_at": {
    "iso_8601": "cillum do sunt",
    "unix": 34087904
  },
  "step": 8081434,
  "step_desc": "consectetur Excepteur in",
  "steps": 99325261,
  "updated_at": {
    "iso_8601": "pariatur",
    "unix": -34507564
  }
}
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": 81634317,
    "name": "amet dolor Lorem consectetur irure",
    "mac": "est consequat",
    "group": {
      "id": -76256857,
      "name": "eu"
    },
    "is_billable": false,
    "billing": {
      "date": "culpa sed ipsum"
    },
    "switch": {
      "port": {
        "name": "fugiat t",
        "speed": {
          "id": 37850490,
          "name": "commodo sit consequat occaecat"
        }
      }
    }
  }
]
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": -94133238,
  "name": "non dolor laboris ea laborum",
  "mac": "ipsum mollit dolor Ut",
  "group": {
    "id": 44595536,
    "name": "eiusmod voluptate Lorem veniam"
  },
  "is_billable": true,
  "billing": {
    "date": "fugiat dolor labore sed"
  },
  "switch": {
    "port": {
      "name": "sunt",
      "speed": {
        "id": -86673274,
        "name": "officia in sunt Ut"
      }
    }
  }
}
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": -67865696,
  "name": "ut Duis qui ad",
  "mac": "culpa sint enim",
  "group": {
    "id": 47098287,
    "name": "officia"
  },
  "is_billable": false,
  "billing": {
    "date": "ad in Lorem nulla"
  },
  "switch": {
    "port": {
      "name": "dolore nisi anim ex exercitation",
      "speed": {
        "id": -3495560,
        "name": "sed 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"
}

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": -18326535,
  "name": "minim aliquip cillum",
  "mac": "",
  "group": {
    "id": -459495,
    "name": "magna deserunt sunt aliqua"
  },
  "is_billable": true,
  "billing": {
    "date": "laboris Excepteur sint"
  },
  "switch": {
    "port": {
      "name": "u",
      "speed": {
        "id": 67103436,
        "name": "cillum"
      }
    }
  }
}
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": "dolor nulla incididunt minim"
}
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