API Documentation
**
Admins
**
API Keys
**
Auth
**Reset Password **Single Sign On Link
**
2 Factor Authentication
**
Other
**
Clients
**
Sub Clients
**
Super Clients
**
Email Templates
**
IP Entities
**
Fields
**List Fields **View Field **List Field Values **View Field Value
**
Forwarding Gateways
**List Forwarding Types **View Forwarding Type
**
IP Groups
**
Integration
**
System
**View License Information **Create License Information **List Log Items **View Log Item **List Packages **View Package **List Setting Groups **View Setting Group
**List Todo Items **View Todo Item
**
Hardware
**
Network
**
DHCP Servers
**
PXE Drivers
**
File Servers
**
ISOs
**
PXE Preseeds
**
OS Reload Profiles
**
OS Shell Scripts
**
OS Templates
**
Servers
**List Server Control Types **View Server Control **Provision Server
**
Server Access
**
Server Power Controls
**Run Control Command **Open Server KVM **View Server Control Status
**
Server OS Reloads
**
Server Ports
**
Switches
**
Switch Commands
**
Switch Ports
**
Switch Scans
**
SSH Keys
SynergyCP API
For users: 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.
For Integrations: API Keys are used for connecting Integrations like WHMCS to Synergy. To create a new one go to System < Integrations. Create a new Integration and then select it, click on API Keys and then Generate one. This API Key will be used anytime the Integration needs to communicate with Synergy.
Admins ¶
Admins
List Admins ¶
List Admins
GET/admin
List all Admins
Example URI
GET /admin
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
A list of Admins
Headers
```
Content-Type: application/json
```
Body
```
[
{
"username": "in"
},
{
"username": "in Ut s"
}
]
```
Schema
```
{
"items": {
"properties": {
"created_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"
},
"email": {
"example": "[email protected]",
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"receive_copies": {
"type": "boolean"
},
"username": {
"type": "string"
}
},
"required": [
"username"
],
"type": "object"
},
"type": "array"
}
```
Create Admin
POST/admin
Create a new Admin
Example URI
POST /admin
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"email": "veniam sunt Duis ipsum cupidatat",
"password": "ipsum velit reprehenderit Duis amet",
"receive_copies": false
}
```
Schema
```
{
"required": [
"email",
"password"
],
"properties": {
"email": {
"example": "[email protected]",
"type": "string"
},
"password": {
"type": "string"
},
"receive_copies": {
"type": "boolean"
},
"username": {
"type": "string"
}
},
"type": "object"
}
```
Response200
HideShow
An Admin
Headers
```
Content-Type: application/json
```
Body
```
{
"username": "commodo esse in consectetur ut"
}
```
Schema
```
{
"properties": {
"created_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"
},
"email": {
"example": "[email protected]",
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"receive_copies": {
"type": "boolean"
},
"username": {
"type": "string"
}
},
"required": [
"username"
],
"type": "object"
}
```
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"email": "non in",
"password": "enim culpa ad aliquip",
"receive_copies": true,
"username": "magna mollit"
}
```
Schema
```
{
"required": [
"email",
"password"
],
"properties": {
"email": {
"example": "[email protected]",
"type": "string"
},
"password": {
"type": "string"
},
"receive_copies": {
"type": "boolean"
},
"username": {
"type": "string"
}
},
"type": "object"
}
```
Response422
HideShow
Unprocessable Entity
Headers
```
Content-Type: application/json
```
Delete Admin ¶
Delete Admin
DELETE/admin/{admin_id}
Delete an admin
Example URI
DELETE /admin/admin_id
URI Parameters
HideShow
admin_id
string (required)
Response200
HideShow
Admin deleted successfully
Response404
HideShow
Item not Found
View Admin
GET/admin/{admin_id}
View a specific admin
Example URI
GET /admin/admin_id
URI Parameters
HideShow
admin_id
string (required)
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
An Admin
Headers
```
Content-Type: application/json
```
Body
```
{
"username": "Excepteur pariatur proident est velit",
"email": "fugiat minim cillum"
}
```
Schema
```
{
"properties": {
"created_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"
},
"email": {
"example": "[email protected]",
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"receive_copies": {
"type": "boolean"
},
"username": {
"type": "string"
}
},
"required": [
"username"
],
"type": "object"
}
```
Edit Admin
PATCH/admin/{admin_id}
Edit a specific admin with new information
Example URI
PATCH /admin/admin_id
URI Parameters
HideShow
admin_id
string (required)
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"receive_copies": true
}
```
Schema
```
{
"properties": {
"email": {
"example": "[email protected]",
"type": "string"
},
"password": {
"type": "string"
},
"receive_copies": {
"type": "boolean"
},
"username": {
"type": "string"
}
},
"type": "object"
}
```
Response200
HideShow
An Admin
Headers
```
Content-Type: application/json
```
Body
```
{
"username": "consectetur reprehenderit consequat et"
}
```
Schema
```
{
"properties": {
"created_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"
},
"email": {
"example": "[email protected]",
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"receive_copies": {
"type": "boolean"
},
"username": {
"type": "string"
}
},
"required": [
"username"
],
"type": "object"
}
```
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{}
```
Schema
```
{
"properties": {
"email": {
"example": "[email protected]",
"type": "string"
},
"password": {
"type": "string"
},
"receive_copies": {
"type": "boolean"
},
"username": {
"type": "string"
}
},
"type": "object"
}
```
Response422
HideShow
Unprocessable Entity
Headers
```
Content-Type: application/json
```
View Admin Permissions ¶
View Admin Permissions
GET/admin/{admin_id}/permission
View a specific admin’s permissions
Example URI
GET /admin/admin_id/permission
URI Parameters
HideShow
admin_id
string (required)
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
An Admin’s Permissions
Headers
```
Content-Type: application/json
```
Body
```
{
"server": {
"in_use": {
"write": false
}
}
}
```
Schema
```
{
"properties": {
"network": {
"properties": {
"entities": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"forward": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"groups": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"switches": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"pxe": {
"properties": {
"installs": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"settings": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"server": {
"properties": {
"in_inventory": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"in_use": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"settings": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"system": {
"properties": {
"emails": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"integrations": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"logs": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"settings": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"theme": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"users": {
"properties": {
"admins": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"clients": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
```
Edit Admin Permissions
PATCH/admin/{admin_id}/permission
Edit a specific admin’s Permissions
Example URI
PATCH /admin/admin_id/permission
URI Parameters
HideShow
admin_id
string (required)
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{}
```
Schema
```
{
"properties": {
"network": {
"properties": {
"entities": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"forward": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"groups": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"switches": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"pxe": {
"properties": {
"installs": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"settings": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"server": {
"properties": {
"in_inventory": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"in_use": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"settings": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"system": {
"properties": {
"emails": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"integrations": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"logs": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"settings": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"theme": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"users": {
"properties": {
"admins": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"clients": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
```
Response200
HideShow
An Admin’s Permissions
Headers
```
Content-Type: application/json
```
Body
```
{}
```
Schema
```
{
"properties": {
"network": {
"properties": {
"entities": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"forward": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"groups": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"switches": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"pxe": {
"properties": {
"installs": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"settings": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"server": {
"properties": {
"in_inventory": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"in_use": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"settings": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"system": {
"properties": {
"emails": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"integrations": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"logs": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"settings": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"theme": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"users": {
"properties": {
"admins": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"clients": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
```
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{}
```
Schema
```
{
"properties": {
"network": {
"properties": {
"entities": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"forward": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"groups": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"switches": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"pxe": {
"properties": {
"installs": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"settings": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"server": {
"properties": {
"in_inventory": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"in_use": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"settings": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"system": {
"properties": {
"emails": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"integrations": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"logs": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"settings": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"theme": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"users": {
"properties": {
"admins": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"clients": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
```
Response422
HideShow
Unprocessable Entity
Headers
```
Content-Type: application/json
```
API Keys ¶
API Keys
List API Keys ¶
List API Keys
GET/auth/key
List of API keys currently active in Synergy
Example URI
GET /auth/key
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
A list of API Keys
Headers
```
Content-Type: application/json
```
Body
```
[
{
"id": -8609493,
"name": "ex",
"owner": {
"id": -86087048,
"name": "qui nisi elit ut Excepteur",
"url": "ut dolor eiusmod"
},
"key": "commodo",
"expires_at": {
"iso_8601": "nulla in ea",
"unix": 39321858
}
}
]
```
Schema
```
{
"items": {
"properties": {
"expires_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"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"key": {
"type": "string"
},
"name": {
"type": "string"
},
"owner": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"url": {
"type": "string"
}
},
"type": "object"
}
},
"required": [
"id",
"name"
],
"type": "object"
},
"type": "array"
}
```
Create API Key
POST/auth/key
Create a new API Key
Example URI
POST /auth/key
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"name": "dolore cillum in proident",
"id": 11671981,
"key": "ut sit amet",
"expires_at": {
"iso_8601": "fugiat magna labore minim",
"unix": 33106102
}
}
```
Schema
```
{
"required": [
"name"
],
"properties": {
"expires_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"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"key": {
"type": "string"
},
"name": {
"type": "string"
},
"owner": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"url": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
```
Response200
HideShow
An API Key
Headers
```
Content-Type: application/json
```
Body
```
{
"id": -76434312,
"name": "amet nostrud",
"key": "magna pariatur"
}
```
Schema
```
{
"properties": {
"expires_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"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"key": {
"type": "string"
},
"name": {
"type": "string"
},
"owner": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"url": {
"type": "string"
}
},
"type": "object"
}
},
"required": [
"id",
"name"
],
"type": "object"
}
```
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"name": "in eiusmod est"
}
```
Schema
```
{
"required": [
"name"
],
"properties": {
"expires_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"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"key": {
"type": "string"
},
"name": {
"type": "string"
},
"owner": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"url": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
```
Response422
HideShow
Unprocessable Entity
Headers
```
Content-Type: application/json
```
Delete API Key ¶
Delete API Key
DELETE/auth/key/{key_id}
Delete an API Key
Example URI
DELETE /auth/key/key_id
URI Parameters
HideShow
key_id
string (required)
Response200
HideShow
API Key deleted successfully
Response404
HideShow
Item not Found
View API Key
GET/auth/key/{key_id}
An API key
Example URI
GET /auth/key/key_id
URI Parameters
HideShow
key_id
string (required)
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
An API Key
Headers
```
Content-Type: application/json
```
Body
```
{
"id": 83071829,
"name": "amet",
"key": "exercitation occaecat ex",
"expires_at": {
"iso_8601": "sit est aliqua officia",
"unix": 39633074
}
}
```
Schema
```
{
"properties": {
"expires_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"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"key": {
"type": "string"
},
"name": {
"type": "string"
},
"owner": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"url": {
"type": "string"
}
},
"type": "object"
}
},
"required": [
"id",
"name"
],
"type": "object"
}
```
Edit API Key
PATCH/auth/key/{key_id}
Edit API Key
Example URI
PATCH /auth/key/key_id
URI Parameters
HideShow
key_id
string (required)
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"name": "sit esse sed ut",
"id": 53416834
}
```
Schema
```
{
"required": [
"name"
],
"properties": {
"expires_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"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"key": {
"type": "string"
},
"name": {
"type": "string"
},
"owner": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"url": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
```
Response200
HideShow
An API Key
Headers
```
Content-Type: application/json
```
Body
```
{
"id": -73287314,
"name": "laboris Lorem",
"owner": {
"id": 7932732,
"name": "et do commodo laboris occaecat"
},
"key": "dolore"
}
```
Schema
```
{
"properties": {
"expires_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"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"key": {
"type": "string"
},
"name": {
"type": "string"
},
"owner": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"url": {
"type": "string"
}
},
"type": "object"
}
},
"required": [
"id",
"name"
],
"type": "object"
}
```
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"name": "cupidatat"
}
```
Schema
```
{
"required": [
"name"
],
"properties": {
"expires_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"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"key": {
"type": "string"
},
"name": {
"type": "string"
},
"owner": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"url": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
```
Response422
HideShow
Unprocessable Entity
Headers
```
Content-Type: application/json
```
Auth ¶
Auth
Reset Password ¶
Reset Password
POST/auth/password-reset
Reset Password
Example URI
POST /auth/password-reset
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"email": "sed officia ",
"type": "esse qui in"
}
```
Schema
```
{
"properties": {
"email": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
}
```
Response200
HideShow
Password Reset Successfully
Headers
```
Content-Type: application/json
```
Body
```
{}
```
Schema
```
{
"properties": {
"user": {
"properties": {
"email": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"username": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
```
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"type": "quis ipsum",
"email": "la"
}
```
Schema
```
{
"properties": {
"email": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
}
```
Response422
HideShow
Unprocessable Entity
Headers
```
Content-Type: application/json
```
Single Sign On Link ¶
Single Sign On Link
GET/auth/sso
A Single Sign On Link
Example URI
GET /auth/sso
Response200
HideShow
Single Sign On Link
2 Factor Authentication ¶
2 Factor Authentication
List 2FAs ¶
List 2FAs
GET/auth/verify/auth
List of 2FAs
Example URI
GET /auth/verify/auth
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
A list of 2FAs
Headers
```
Content-Type: application/json
```
Body
```
[
{
"id": -28958353
},
{
"id": 55196759,
"value": "enim ullamco",
"verified": false
},
{
"id": -52856338
}
]
```
Schema
```
{
"items": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"method": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"value": {
"type": "string"
},
"verified": {
"type": "boolean"
}
},
"type": "object"
},
"type": "array"
}
```
Create 2FA
POST/auth/verify/auth
Create 2FA
Example URI
POST /auth/verify/auth
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"value": "pariatur in est ad"
}
```
Schema
```
{
"properties": {
"method": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
}
},
"type": "object"
},
"value": {
"type": "string"
}
},
"type": "object"
}
```
Response200
HideShow
Two Factor Authenticator created.
Headers
```
Content-Type: application/json
```
Body
```
{
"method": {
"name": "officia"
},
"value": "do",
"verified": true,
"id": -57638067
}
```
Schema
```
{
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"method": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"value": {
"type": "string"
},
"verified": {
"type": "boolean"
}
},
"type": "object"
}
```
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"method": {
"id": -91886387
},
"value": "in sit Duis fugiat"
}
```
Schema
```
{
"properties": {
"method": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
}
},
"type": "object"
},
"value": {
"type": "string"
}
},
"type": "object"
}
```
Response422
HideShow
Unprocessable Entity
Headers
```
Content-Type: application/json
```
Delete 2FA ¶
Delete 2FA
DELETE/auth/verify/auth/{auth_id}
Delete 2FA
Example URI
DELETE /auth/verify/auth/auth_id
URI Parameters
HideShow
auth_id
string (required)
Response200
HideShow
2 Factor Authentication deleted successfully
Response404
HideShow
Item not Found
View 2FA
GET/auth/verify/auth/{auth_id}
Get A 2FA
Example URI
GET /auth/verify/auth/auth_id
URI Parameters
HideShow
auth_id
string (required)
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
A 2 Factor Authentication
Headers
```
Content-Type: application/json
```
Body
```
{
"method": {
"name": "eu consequat occaecat id dolore",
"id": -45592637
}
}
```
Schema
```
{
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"method": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"value": {
"type": "string"
},
"verified": {
"type": "boolean"
}
},
"type": "object"
}
```
Validate 2FA
PATCH/auth/verify/auth/{auth_id}
Edit 2FA
Example URI
PATCH /auth/verify/auth/auth_id
URI Parameters
HideShow
auth_id
string (required)
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{}
```
Schema
```
{
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"method": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"value": {
"type": "string"
},
"verified": {
"type": "boolean"
}
},
"type": "object"
}
```
Response200
HideShow
A 2 Factor Authentication
Headers
```
Content-Type: application/json
```
Body
```
{
"value": "sunt dolor ut velit",
"id": 37116015
}
```
Schema
```
{
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"method": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"value": {
"type": "string"
},
"verified": {
"type": "boolean"
}
},
"type": "object"
}
```
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"method": {
"name": "esse",
"id": -17522865
},
"verified": true
}
```
Schema
```
{
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"method": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"value": {
"type": "string"
},
"verified": {
"type": "boolean"
}
},
"type": "object"
}
```
Response422
HideShow
Unprocessable Entity
Headers
```
Content-Type: application/json
```
Create 2FA Code ¶
Create 2FA Code
POST/auth/verify/auth/{auth_id}/code
2FA Code
Example URI
POST /auth/verify/auth/auth_id/code
URI Parameters
HideShow
auth_id
string (required)
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{}
```
Schema
```
{
"properties": {
"isWrapped": {
"type": "boolean"
}
},
"type": "object"
}
```
Response200
HideShow
2FA Code Sent
Headers
```
Content-Type: application/json
```
Body
```
{}
```
Schema
```
{
"properties": {
"auth": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"method": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"value": {
"type": "string"
},
"verified": {
"type": "boolean"
}
},
"type": "object"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"token": {
"type": "string"
}
},
"type": "object"
}
```
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"isWrapped": false
}
```
Schema
```
{
"properties": {
"isWrapped": {
"type": "boolean"
}
},
"type": "object"
}
```
Response422
HideShow
Unprocessable Entity
Headers
```
Content-Type: application/json
```
Delete 2FA Code ¶
Delete 2FA Code
DELETE/auth/verify/auth/{auth_id}/code/{code_id}
Delete 2FA Code
Example URI
DELETE /auth/verify/auth/auth_id/code/code_id
URI Parameters
HideShow
auth_id
string (required)
code_id
string (required)
Response200
HideShow
2 Factor Authentication Code deleted successfully
Response404
HideShow
Item not Found
View 2FA Code
GET/auth/verify/auth/{auth_id}/code/{code_id}
Get 2FA Code
Example URI
GET /auth/verify/auth/auth_id/code/code_id
URI Parameters
HideShow
auth_id
string (required)
code_id
string (required)
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
A 2FA Code
Headers
```
Content-Type: application/json
```
Body
```
{
"auth": {
"method": {
"id": 70453693,
"name": "Duis"
},
"verified": false
}
}
```
Schema
```
{
"properties": {
"auth": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"method": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"value": {
"type": "string"
},
"verified": {
"type": "boolean"
}
},
"type": "object"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"token": {
"type": "string"
}
},
"type": "object"
}
```
Edit 2FA Code
PATCH/auth/verify/auth/{auth_id}/code/{code_id}
Edit 2FA Code
Example URI
PATCH /auth/verify/auth/auth_id/code/code_id
URI Parameters
HideShow
auth_id
string (required)
code_id
string (required)
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{}
```
Schema
```
{
"properties": {
"auth": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"method": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"value": {
"type": "string"
},
"verified": {
"type": "boolean"
}
},
"type": "object"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"token": {
"type": "string"
}
},
"type": "object"
}
```
Response200
HideShow
A 2 Factor Authentication Code
Headers
```
Content-Type: application/json
```
Body
```
{}
```
Schema
```
{
"properties": {
"key": {
"properties": {
"expires_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"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"key": {
"type": "string"
},
"name": {
"type": "string"
},
"owner": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"url": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
```
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"token": "adipisicing non",
"id": 46123834,
"auth": {
"value": "nulla cillum minim",
"id": 67596549,
"method": {
"id": 60480629,
"name": "sint exercitation ad"
}
}
}
```
Schema
```
{
"properties": {
"auth": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"method": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"value": {
"type": "string"
},
"verified": {
"type": "boolean"
}
},
"type": "object"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"token": {
"type": "string"
}
},
"type": "object"
}
```
Response422
HideShow
Unprocessable Entity
Headers
```
Content-Type: application/json
```
List 2FA Methods ¶
List 2FA Methods
GET/auth/verify/method
2FA Methods
Example URI
GET /auth/verify/method
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
2 Factor Auth Methods
Headers
```
Content-Type: application/json
```
Body
```
[
{
"description": "anim laborum comm"
},
{
"description": "esse enim elit",
"id": -44691674,
"name": "exercitation cupidatat commodo reprehenderit"
},
{
"id": -85720066,
"description": "est qui"
},
{
"id": -83717255,
"name": "dolor laboris",
"description": "amet sit pariatur"
}
]
```
Schema
```
{
"items": {
"properties": {
"description": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
```
View 2FA Method ¶
View 2FA Method
GET/auth/verify/method/{method_id}
A 2FA Method
Example URI
GET /auth/verify/method/method_id
URI Parameters
HideShow
method_id
string (required)
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
A 2 Factor Authentication Method
Headers
```
Content-Type: application/json
```
Body
```
{
"id": 72244060
}
```
Schema
```
{
"properties": {
"description": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
}
```
Edit 2FA Method
PATCH/auth/verify/method/{method_id}
Edit 2FA Method
Example URI
PATCH /auth/verify/method/method_id
URI Parameters
HideShow
method_id
string (required)
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"name": "sunt laboris comm",
"description": "qui id",
"id": 32648803
}
```
Schema
```
{
"properties": {
"description": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
}
```
Response200
HideShow
A 2FA Method
Headers
```
Content-Type: application/json
```
Body
```
{
"name": "proident sint cupidatat fugiat enim"
}
```
Schema
```
{
"properties": {
"description": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
}
```
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"name": "anim"
}
```
Schema
```
{
"properties": {
"description": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
}
```
Response422
HideShow
Unprocessable Entity
Headers
```
Content-Type: application/json
```
Other ¶
Other
View Browser Details ¶
View Browser Details
GET/browser-details
View the details about your browser
Example URI
GET /browser-details
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
Browser Details
Headers
```
Content-Type: application/json
```
Body
```
{}
```
Schema
```
{
"properties": {
"ip": {
"type": "string"
}
},
"type": "object"
}
```
Delete SSL Settings ¶
Delete SSL Settings
DELETE/http/ssl
Delete SSL Settings
Example URI
DELETE /http/ssl
Response200
HideShow
SSL Settings deleted successfully
Response404
HideShow
Item not Found
View SSL Settings
GET/http/ssl
SSL Information
Example URI
GET /http/ssl
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
SSL Information
Headers
```
Content-Type: application/json
```
Body
```
{}
```
Schema
```
{
"properties": {
"enabled": {
"type": "boolean"
},
"required": {
"type": "boolean"
}
},
"type": "object"
}
```
Create SSL Settings
POST/http/ssl
Set new SSL Settings
Example URI
POST /http/ssl
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"email": "non anim sit minim"
}
```
Schema
```
{
"properties": {
"email": {
"type": "string"
}
},
"type": "object"
}
```
Response200
HideShow
SSL Settings
Headers
```
Content-Type: application/json
```
Body
```
{
"required": false,
"enabled": false
}
```
Schema
```
{
"properties": {
"enabled": {
"type": "boolean"
},
"required": {
"type": "boolean"
}
},
"type": "object"
}
```
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"email": "dolor"
}
```
Schema
```
{
"properties": {
"email": {
"type": "string"
}
},
"type": "object"
}
```
Response422
HideShow
Unprocessable Entity
Headers
```
Content-Type: application/json
```
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
```
Response200
HideShow
A list of Clients
Headers
```
Content-Type: application/json
```
Body
```
[
{
"id": 34717752,
"name": "consequat culpa ut",
"email": "amet irure"
},
{
"id": -95584932,
"name": "deserunt voluptate irure commodo incididunt",
"email": "exercitation officia Lorem in",
"first": "et fugiat nulla min",
"serversCount": 35410397
}
]
```
Schema
```
{
"items": {
"properties": {
"billing": {
"properties": {
"id": {
"description": "The Billing ID of the API Integration that this client belongs to.",
"type": "integer"
},
"ignoreAutoSuspend": {
"description": "Tells Synergy that this is a client with VIP status and their servers will never be automatically suspended.",
"type": "boolean"
}
},
"type": "object"
},
"billing_id": {
"type": "integer"
},
"created_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"
},
"email": {
"example": "[email protected]",
"type": "string"
},
"first": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"integration": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
},
"last": {
"type": "string"
},
"name": {
"type": "string"
},
"serversCount": {
"type": "integer"
}
},
"required": [
"id",
"name",
"email"
],
"type": "object"
},
"type": "array"
}
```
Create Client
POST/client
Create a new Client (or sub-client on client-side)
Example URI
POST /client
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"email": "sed adipisicing elit aute aliqua",
"first": "pariatur id nulla",
"last": "Lorem consequat Duis ea",
"password": "ut Ut commodo"
}
```
Schema
```
{
"required": [
"email",
"first",
"last"
],
"properties": {
"billing": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"ignoreAutoSuspend": {
"type": "boolean"
},
"integration": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"email": {
"example": "[email protected]",
"type": "string"
},
"first": {
"type": "string"
},
"last": {
"type": "string"
},
"password": {
"type": "string"
}
}
}
```
Response200
HideShow
A Client
Headers
```
Content-Type: application/json
```
Body
```
{
"id": 36346840,
"name": "Ut eiusmod fugiat laboris",
"email": "ea pariatur laboris",
"integration": {
"id": -34631438,
"name": "consequat aliqua cupidatat sunt eu"
}
}
```
Schema
```
{
"properties": {
"billing": {
"properties": {
"id": {
"description": "The Billing ID of the API Integration that this client belongs to.",
"type": "integer"
},
"ignoreAutoSuspend": {
"description": "Tells Synergy that this is a client with VIP status and their servers will never be automatically suspended.",
"type": "boolean"
}
},
"type": "object"
},
"billing_id": {
"type": "integer"
},
"created_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"
},
"email": {
"example": "[email protected]",
"type": "string"
},
"first": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"integration": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
},
"last": {
"type": "string"
},
"name": {
"type": "string"
},
"serversCount": {
"type": "integer"
}
},
"required": [
"id",
"name",
"email"
],
"type": "object"
}
```
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"email": "cillum mol",
"first": "cillum magna quis sed",
"last": "magna ullamco",
"password": "laborum id labore"
}
```
Schema
```
{
"required": [
"email",
"first",
"last"
],
"properties": {
"billing": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"ignoreAutoSuspend": {
"type": "boolean"
},
"integration": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"email": {
"example": "[email protected]",
"type": "string"
},
"first": {
"type": "string"
},
"last": {
"type": "string"
},
"password": {
"type": "string"
}
}
}
```
Response422
HideShow
Unprocessable Entity
Headers
```
Content-Type: application/json
```
Delete Client ¶
Delete Client
DELETE/client/{client_id}
Delete a client
Example URI
DELETE /client/client_id
URI Parameters
HideShow
client_id
string (required)
Response200
HideShow
Client deleted successfully
Response404
HideShow
Item not Found
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
```
Response200
HideShow
A Client
Headers
```
Content-Type: application/json
```
Body
```
{
"id": 79540964,
"name": "id irure",
"email": "anim adipisicing ad",
"serversCount": 14725672
}
```
Schema
```
{
"properties": {
"billing": {
"properties": {
"id": {
"description": "The Billing ID of the API Integration that this client belongs to.",
"type": "integer"
},
"ignoreAutoSuspend": {
"description": "Tells Synergy that this is a client with VIP status and their servers will never be automatically suspended.",
"type": "boolean"
}
},
"type": "object"
},
"billing_id": {
"type": "integer"
},
"created_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"
},
"email": {
"example": "[email protected]",
"type": "string"
},
"first": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"integration": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
},
"last": {
"type": "string"
},
"name": {
"type": "string"
},
"serversCount": {
"type": "integer"
},
"verify": {
"properties": {
"require": {
"type": "boolean"
}
},
"type": "array"
}
},
"required": [
"id",
"name",
"email"
],
"type": "object"
}
```
Edit Client
PATCH/client/{client_id}
Edit a specific client with new information
Example URI
PATCH /client/client_id
URI Parameters
HideShow
client_id
string (required)
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{}
```
Schema
```
{
"properties": {
"billing": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"ignoreAutoSuspend": {
"type": "boolean"
},
"integration": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"email": {
"example": "[email protected]",
"type": "string"
},
"first": {
"type": "string"
},
"last": {
"type": "string"
},
"password": {
"type": "string"
}
}
}
```
Response200
HideShow
A Client
Headers
```
Content-Type: application/json
```
Body
```
{
"id": -98582019,
"name": "magna",
"email": "Ut magna",
"last": "Lorem Duis proident do esse",
"integration": {
"id": -58597491,
"name": "quis occaecat"
},
"created_at": {
"iso_8601": "tempor ex cupidatat enim",
"unix": -76605618
}
}
```
Schema
```
{
"properties": {
"billing": {
"properties": {
"id": {
"description": "The Billing ID of the API Integration that this client belongs to.",
"type": "integer"
},
"ignoreAutoSuspend": {
"description": "Tells Synergy that this is a client with VIP status and their servers will never be automatically suspended.",
"type": "boolean"
}
},
"type": "object"
},
"billing_id": {
"type": "integer"
},
"created_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"
},
"email": {
"example": "[email protected]",
"type": "string"
},
"first": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"integration": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
},
"last": {
"type": "string"
},
"name": {
"type": "string"
},
"serversCount": {
"type": "integer"
},
"verify": {
"properties": {
"require": {
"type": "boolean"
}
},
"type": "array"
}
},
"required": [
"id",
"name",
"email"
],
"type": "object"
}
```
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{}
```
Schema
```
{
"properties": {
"billing": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"ignoreAutoSuspend": {
"type": "boolean"
},
"integration": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"email": {
"example": "[email protected]",
"type": "string"
},
"first": {
"type": "string"
},
"last": {
"type": "string"
},
"password": {
"type": "string"
}
}
}
```
Response422
HideShow
Unprocessable Entity
Headers
```
Content-Type: application/json
```
Send Email to Client ¶
Send Email to Client
POST/client/{client_id}/email
Send Email to a Client
Example URI
POST /client/client_id/email
URI Parameters
HideShow
client_id
string (required)
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"type": "magna"
}
```
Schema
```
{
"properties": {
"type": {
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
```
Response200
HideShow
Sent an email to one client.
Headers
```
Content-Type: application/json
```
Body
```
[
{},
{},
{
"type": "enim",
"text": "velit minim ullamco nisi"
}
]
```
Schema
```
{
"items": {
"properties": {
"text": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
```
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"type": "elit nisi nostrud adipisicing cupidatat"
}
```
Schema
```
{
"properties": {
"type": {
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
```
Response422
HideShow
Unprocessable Entity
Headers
```
Content-Type: application/json
```
Sub Clients ¶
Sub Clients
List Sub Clients ¶
List Sub Clients
GET/client/{client_id}/sub
List all Sub Clients of {client_id}
Example URI
GET /client/client_id/sub
URI Parameters
HideShow
client_id
string (required)
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
A list of Sub Clients
Headers
```
Content-Type: application/json
```
Body
```
[
{
"id": 57431454,
"quif": -45600274
},
{
"id": -36607461,
"occaecatb5": 18258308,
"in5ed": 70656510
},
{
"id": -66977108,
"child": {
"first": "labore sed Excepteur",
"last": "qui esse minim magna sunt"
},
"eiusmodce": false
},
{
"id": 63317940,
"Lorem6": false,
"in0": -61454364
}
]
```
Schema
```
{
"items": {
"properties": {
"child": {
"properties": {
"created_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"
},
"email": {
"example": "[email protected]",
"type": "string"
},
"first": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"integration": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
},
"last": {
"type": "string"
},
"name": {
"type": "string"
},
"serversCount": {
"type": "integer"
}
},
"type": "object"
},
"id": {
"description": "The Unique ID that represents the relationship between the Client and Sub Client.",
"type": "integer"
}
},
"required": [
"id",
"name",
"email"
],
"type": "object"
},
"type": "array"
}
```
Create Sub Client
POST/client/{client_id}/sub
Create a new Sub Client of {client_id}
Example URI
POST /client/client_id/sub
URI Parameters
HideShow
client_id
string (required)
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"client_id": 45678935
}
```
Schema
```
{
"properties": {
"client_id": {
"type": "integer"
}
},
"required": [
"client_id"
]
}
```
Response200
HideShow
A Sub Client
Headers
```
Content-Type: application/json
```
Body
```
{
"id": -15291393,
"elit31a": false,
"reprehenderit82c": "pariatur irure ex do"
}
```
Schema
```
{
"properties": {
"child": {
"properties": {
"created_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"
},
"email": {
"example": "[email protected]",
"type": "string"
},
"first": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"integration": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
},
"last": {
"type": "string"
},
"name": {
"type": "string"
},
"serversCount": {
"type": "integer"
}
},
"type": "object"
},
"id": {
"description": "The Unique ID that represents the relationship between the Client and Sub Client.",
"type": "integer"
}
},
"required": [
"id",
"name",
"email"
],
"type": "object"
}
```
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"client_id": 27672246
}
```
Schema
```
{
"properties": {
"client_id": {
"type": "integer"
}
},
"required": [
"client_id"
]
}
```
Response422
HideShow
Unprocessable Entity
Headers
```
Content-Type: application/json
```
Delete Sub Client ¶
Delete Sub Client
DELETE/client/{client_id}/sub/{sub_id}
Delete a sub client
Example URI
DELETE /client/client_id/sub/sub_id
URI Parameters
HideShow
client_id
string (required)
sub_id
string (required)
Response200
HideShow
One Sub Client deleted
Response404
HideShow
Item not Found
View Sub Client
GET/client/{client_id}/sub/{sub_id}
View a specific sub client
Example URI
GET /client/client_id/sub/sub_id
URI Parameters
HideShow
client_id
string (required)
sub_id
string (required)
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
A Sub Client
Headers
```
Content-Type: application/json
```
Body
```
{
"id": -29669626,
"child": {
"serversCount": 30491472
},
"laborisc4e": "laboris dolore sed"
}
```
Schema
```
{
"properties": {
"child": {
"properties": {
"created_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"
},
"email": {
"example": "[email protected]",
"type": "string"
},
"first": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"integration": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
},
"last": {
"type": "string"
},
"name": {
"type": "string"
},
"serversCount": {
"type": "integer"
}
},
"type": "object"
},
"id": {
"description": "The Unique ID that represents the relationship between the Client and Sub Client.",
"type": "integer"
}
},
"required": [
"id",
"name",
"email"
],
"type": "object"
}
```
Edit Sub Client
PATCH/client/{client_id}/sub/{sub_id}
Edit a specific sub client
Example URI
PATCH /client/client_id/sub/sub_id
URI Parameters
HideShow
client_id
string (required)
sub_id
string (required)
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{}
```
Schema
```
{
"properties": {
"billing": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"ignoreAutoSuspend": {
"type": "boolean"
},
"integration": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"email": {
"example": "[email protected]",
"type": "string"
},
"first": {
"type": "string"
},
"last": {
"type": "string"
},
"password": {
"type": "string"
}
}
}
```
Response200
HideShow
New Sub Client Information
Headers
```
Content-Type: application/json
```
Body
```
{
"id": 91763157,
"sunte81": "ut",
"reprehenderite2": -10761175
}
```
Schema
```
{
"properties": {
"child": {
"properties": {
"created_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"
},
"email": {
"example": "[email protected]",
"type": "string"
},
"first": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"integration": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
},
"last": {
"type": "string"
},
"name": {
"type": "string"
},
"serversCount": {
"type": "integer"
}
},
"type": "object"
},
"id": {
"description": "The Unique ID that represents the relationship between the Client and Sub Client.",
"type": "integer"
}
},
"required": [
"id",
"name",
"email"
],
"type": "object"
}
```
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{}
```
Schema
```
{
"properties": {
"billing": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"ignoreAutoSuspend": {
"type": "boolean"
},
"integration": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"email": {
"example": "[email protected]",
"type": "string"
},
"first": {
"type": "string"
},
"last": {
"type": "string"
},
"password": {
"type": "string"
}
}
}
```
Response422
HideShow
Unprocessable Entity
Headers
```
Content-Type: application/json
```
Super Clients ¶
Super Clients
List Super Clients ¶
List Super Clients
GET/client/{client_id}/super
List all Super Clients of {client_id}
Example URI
GET /client/client_id/super
URI Parameters
HideShow
client_id
string (required)
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
A list of Super Clients
Headers
```
Content-Type: application/json
```
Body
```
[
{
"id": -63134804,
"ad92": -57239114
},
{
"id": -83325598,
"ipsume3": 81193268
},
{
"id": -46176132,
"esse3": "ad"
},
{
"id": 61905852,
"grantee": {
"id": 35392684
}
}
]
```
Schema
```
{
"items": {
"properties": {
"grantee": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"id": {
"description": "The Unique ID that represents the relationship between the Client and Sub Client.",
"type": "integer"
}
},
"required": [
"id",
"name"
],
"type": "object"
},
"type": "array"
}
```
Create Super Client
POST/client/{client_id}/super
Create a new Super Client of {client_id}
Example URI
POST /client/client_id/super
URI Parameters
HideShow
client_id
string (required)
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"client_id": 46710126
}
```
Schema
```
{
"properties": {
"client_id": {
"type": "integer"
}
},
"required": [
"client_id"
]
}
```
Response200
HideShow
A Super Client
Headers
```
Content-Type: application/json
```
Body
```
{
"id": 12176780,
"grantee": {
"id": 79531142,
"name": "no"
}
}
```
Schema
```
{
"properties": {
"grantee": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"id": {
"description": "The Unique ID that represents the relationship between the Client and Sub Client.",
"type": "integer"
}
},
"required": [
"id",
"name"
],
"type": "object"
}
```
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"client_id": -47595645
}
```
Schema
```
{
"properties": {
"client_id": {
"type": "integer"
}
},
"required": [
"client_id"
]
}
```
Response422
HideShow
Unprocessable Entity
Headers
```
Content-Type: application/json
```
Delete Super Client ¶
Delete Super Client
DELETE/client/{client_id}/super/{super_id}
Delete a super client
Example URI
DELETE /client/client_id/super/super_id
URI Parameters
HideShow
client_id
string (required)
super_id
string (required)
Response200
HideShow
One Super Client deleted
Response404
HideShow
Item not Found
View Super Client
GET/client/{client_id}/super/{super_id}
View a specific super client
Example URI
GET /client/client_id/super/super_id
URI Parameters
HideShow
client_id
string (required)
super_id
string (required)
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
A Super Client
Headers
```
Content-Type: application/json
```
Body
```
{
"id": 92507204,
"officia4": true
}
```
Schema
```
{
"properties": {
"grantee": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"id": {
"description": "The Unique ID that represents the relationship between the Client and Sub Client.",
"type": "integer"
}
},
"required": [
"id",
"name"
],
"type": "object"
}
```
Edit Super Client
PATCH/client/{client_id}/super/{super_id}
Edit a specific super client
Example URI
PATCH /client/client_id/super/super_id
URI Parameters
HideShow
client_id
string (required)
super_id
string (required)
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{}
```
Schema
```
{
"properties": {
"billing": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"ignoreAutoSuspend": {
"type": "boolean"
},
"integration": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"email": {
"example": "[email protected]",
"type": "string"
},
"first": {
"type": "string"
},
"last": {
"type": "string"
},
"password": {
"type": "string"
}
}
}
```
Response200
HideShow
A Super Client
Headers
```
Content-Type: application/json
```
Body
```
{
"id": 67864369,
"consecteturf6": 20378179
}
```
Schema
```
{
"properties": {
"grantee": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"id": {
"description": "The Unique ID that represents the relationship between the Client and Sub Client.",
"type": "integer"
}
},
"required": [
"id",
"name"
],
"type": "object"
}
```
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"billing": {
"integration": {
"id": -43942162
},
"id": -86366437,
"ignoreAutoSuspend": true
},
"password": "laboris do"
}
```
Schema
```
{
"properties": {
"billing": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"ignoreAutoSuspend": {
"type": "boolean"
},
"integration": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"email": {
"example": "[email protected]",
"type": "string"
},
"first": {
"type": "string"
},
"last": {
"type": "string"
},
"password": {
"type": "string"
}
}
}
```
Response422
HideShow
Unprocessable Entity
Headers
```
Content-Type: application/json
```
Email Templates ¶
Email Templates
List Email Templates ¶
List Email Templates
GET/email/template
List of Email Templates
Example URI
GET /email/template
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
A List of Email Templates
Headers
```
Content-Type: application/json
```
Body
```
[
{},
{},
{
"name": "non magna eiusmod cupidatat adipisicing",
"subject": "commodo exercitation cillum et"
},
{
"body": "fugiat",
"name": "laborum fugi",
"id": 34186267
},
{
"id": -37077327
}
]
```
Schema
```
{
"items": {
"properties": {
"body": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"subject": {
"type": "string"
}
}
},
"type": "array"
}
```
Create Email Template
POST/email/template
Create a new Email Template
Example URI
POST /email/template
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"name": "pariatur",
"subject": "mollit nulla reprehenderit fugiat Duis",
"body": "ut in ut",
"id": -44066936
}
```
Schema
```
{
"required": [
"name",
"subject",
"body"
],
"properties": {
"body": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"subject": {
"type": "string"
}
}
}
```
Response200
HideShow
An Email Template
Headers
```
Content-Type: application/json
```
Body
```
{
"subject": "non Duis qui amet",
"name": "culpa ad ullamco proident ipsum"
}
```
Schema
```
{
"properties": {
"body": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"subject": {
"type": "string"
}
}
}
```
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"name": "fugiat labore exercitation eiusmod",
"subject": "ut ex sint",
"body": "veniam sed proident"
}
```
Schema
```
{
"required": [
"name",
"subject",
"body"
],
"properties": {
"body": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"subject": {
"type": "string"
}
}
}
```
Response422
HideShow
Unprocessable Entity
Headers
```
Content-Type: application/json
```
Delete Email Template ¶
Delete Email Template
DELETE/email/template/{template_id}
Delete an Email Template
Example URI
DELETE /email/template/template_id
URI Parameters
HideShow
template_id
string (required)
Response200
HideShow
Email Template deleted successfully
Response404
HideShow
Item not Found
View Email Template
GET/email/template/{template_id}
An Email Template
Example URI
GET /email/template/template_id
URI Parameters
HideShow
template_id
string (required)
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
An Email Template
Headers
```
Content-Type: application/json
```
Body
```
{
"subject": "ut dolore",
"body": "in incididunt in eiusmod",
"id": 12935022,
"name": "dolore ullamco enim Ut"
}
```
Schema
```
{
"properties": {
"body": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"subject": {
"type": "string"
}
}
}
```
Edit Email Template
PATCH/email/template/{template_id}
Edit Email Template
Example URI
PATCH /email/template/template_id
URI Parameters
HideShow
template_id
string (required)
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"name": "consectetur in deserunt tempor cillum",
"subject": "irure mollit ullamco",
"body": "adipisicing pariatur non"
}
```
Schema
```
{
"required": [
"name",
"subject",
"body"
],
"properties": {
"body": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"subject": {
"type": "string"
}
}
}
```
Response200
HideShow
An Email Template
Headers
```
Content-Type: application/json
```
Body
```
{}
```
Schema
```
{
"properties": {
"body": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"subject": {
"type": "string"
}
}
}
```
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"name": "culpa est anim",
"subject": "dolore",
"body": "adipisicing eu",
"id": 7053984
}
```
Schema
```
{
"required": [
"name",
"subject",
"body"
],
"properties": {
"body": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"subject": {
"type": "string"
}
}
}
```
Response422
HideShow
Unprocessable Entity
Headers
```
Content-Type: application/json
```
IP Entities ¶
IP Entities
List IP Entities ¶
List IP Entities
GET/entity
List of IP Entities
Example URI
GET /entity
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
A List of IP Entities
Headers
```
Content-Type: application/json
```
Body
```
[
{
"gateway": "id et commodo laboris",
"full_ip": "commodo elit incididunt officia",
"v6": {
"address": "eiusmod et ad do"
},
"v6_address": "labore",
"billing_id": "aliqua eu nisi mollit"
},
{},
{},
{}
]
```
Schema
```
{
"items": {
"properties": {
"address": {
"type": "string"
},
"billing_id": {
"type": "string"
},
"full_ip": {
"type": "string"
},
"gateway": {
"type": "string"
},
"group": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"nickname": {
"type": "string"
},
"owner": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"server": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"siblings_count": {
"type": "integer"
},
"subnet_mask": {
"type": "string"
},
"v4": {
"properties": {
"address": {
"type": "string"
},
"full": {
"type": "string"
},
"gateway": {
"type": "string"
},
"range_end": {
"type": "string"
},
"subnet_mask": {
"type": "string"
}
},
"type": "object"
},
"v6": {
"properties": {
"address": {
"type": "string"
},
"gateway": {
"type": "string"
}
},
"type": "object"
},
"v6_address": {
"type": "string"
},
"v6_gateway": {
"type": "string"
},
"vlan": {
"type": "integer"
}
},
"type": "object"
},
"type": "array"
}
```
Create IP Entity
POST/entity
Create a new IP Entity
Example URI
POST /entity
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"vlan": 63291639,
"siblings_count": 35820387
}
```
Schema
```
{
"properties": {
"address": {
"type": "string"
},
"billing_id": {
"type": "string"
},
"full_ip": {
"type": "string"
},
"gateway": {
"type": "string"
},
"group": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"nickname": {
"type": "string"
},
"owner": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"server": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"siblings_count": {
"type": "integer"
},
"subnet_mask": {
"type": "string"
},
"v4": {
"properties": {
"address": {
"type": "string"
},
"full": {
"type": "string"
},
"gateway": {
"type": "string"
},
"range_end": {
"type": "string"
},
"subnet_mask": {
"type": "string"
}
},
"type": "object"
},
"v6": {
"properties": {
"address": {
"type": "string"
},
"gateway": {
"type": "string"
}
},
"type": "object"
},
"v6_address": {
"type": "string"
},
"v6_gateway": {
"type": "string"
},
"vlan": {
"type": "integer"
}
},
"type": "object"
}
```
Response200
HideShow
An IP Entity
Headers
```
Content-Type: application/json
```
Body
```
{
"siblings_count": 79025078
}
```
Schema
```
{
"properties": {
"address": {
"type": "string"
},
"billing_id": {
"type": "string"
},
"full_ip": {
"type": "string"
},
"gateway": {
"type": "string"
},
"group": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"nickname": {
"type": "string"
},
"owner": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"server": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"siblings_count": {
"type": "integer"
},
"subnet_mask": {
"type": "string"
},
"v4": {
"properties": {
"address": {
"type": "string"
},
"full": {
"type": "string"
},
"gateway": {
"type": "string"
},
"range_end": {
"type": "string"
},
"subnet_mask": {
"type": "string"
}
},
"type": "object"
},
"v6": {
"properties": {
"address": {
"type": "string"
},
"gateway": {
"type": "string"
}
},
"type": "object"
},
"v6_address": {
"type": "string"
},
"v6_gateway": {
"type": "string"
},
"vlan": {
"type": "integer"
}
},
"type": "object"
}
```
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"address": "mollit anim velit"
}
```
Schema
```
{
"properties": {
"address": {
"type": "string"
},
"billing_id": {
"type": "string"
},
"full_ip": {
"type": "string"
},
"gateway": {
"type": "string"
},
"group": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"nickname": {
"type": "string"
},
"owner": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"server": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"siblings_count": {
"type": "integer"
},
"subnet_mask": {
"type": "string"
},
"v4": {
"properties": {
"address": {
"type": "string"
},
"full": {
"type": "string"
},
"gateway": {
"type": "string"
},
"range_end": {
"type": "string"
},
"subnet_mask": {
"type": "string"
}
},
"type": "object"
},
"v6": {
"properties": {
"address": {
"type": "string"
},
"gateway": {
"type": "string"
}
},
"type": "object"
},
"v6_address": {
"type": "string"
},
"v6_gateway": {
"type": "string"
},
"vlan": {
"type": "integer"
}
},
"type": "object"
}
```
Response422
HideShow
Unprocessable Entity
Headers
```
Content-Type: application/json
```
Delete IP Entity ¶
Delete IP Entity
DELETE/entity/{entity_id}
Delete an IP Entity
Example URI
DELETE /entity/entity_id
URI Parameters
HideShow
entity_id
string (required)
Response200
HideShow
IP Entity deleted successfully
Response404
HideShow
Item not Found
View IP Entity
GET/entity/{entity_id}
An IP Entity
Example URI
GET /entity/entity_id
URI Parameters
HideShow
entity_id
string (required)
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
An IP Entity
Headers
```
Content-Type: application/json
```
Body
```
{
"address": "est",
"nickname": "sunt"
}
```
Schema
```
{
"properties": {
"address": {
"type": "string"
},
"billing_id": {
"type": "string"
},
"full_ip": {
"type": "string"
},
"gateway": {
"type": "string"
},
"group": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"nickname": {
"type": "string"
},
"owner": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"server": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"siblings_count": {
"type": "integer"
},
"subnet_mask": {
"type": "string"
},
"v4": {
"properties": {
"address": {
"type": "string"
},
"full": {
"type": "string"
},
"gateway": {
"type": "string"
},
"range_end": {
"type": "string"
},
"subnet_mask": {
"type": "string"
}
},
"type": "object"
},
"v6": {
"properties": {
"address": {
"type": "string"
},
"gateway": {
"type": "string"
}
},
"type": "object"
},
"v6_address": {
"type": "string"
},
"v6_gateway": {
"type": "string"
},
"vlan": {
"type": "integer"
}
},
"type": "object"
}
```
Edit IP Entity
PATCH/entity/{entity_id}
Edit IP Entity
Example URI
PATCH /entity/entity_id
URI Parameters
HideShow
entity_id
string (required)
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"name": "consectetur deserunt nostrud",
"billing_id": "irure ullamco tempor dolor dolore",
"id": -60051345
}
```
Schema
```
{
"properties": {
"address": {
"type": "string"
},
"billing_id": {
"type": "string"
},
"full_ip": {
"type": "string"
},
"gateway": {
"type": "string"
},
"group": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"nickname": {
"type": "string"
},
"owner": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"server": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"siblings_count": {
"type": "integer"
},
"subnet_mask": {
"type": "string"
},
"v4": {
"properties": {
"address": {
"type": "string"
},
"full": {
"type": "string"
},
"gateway": {
"type": "string"
},
"range_end": {
"type": "string"
},
"subnet_mask": {
"type": "string"
}
},
"type": "object"
},
"v6": {
"properties": {
"address": {
"type": "string"
},
"gateway": {
"type": "string"
}
},
"type": "object"
},
"v6_address": {
"type": "string"
},
"v6_gateway": {
"type": "string"
},
"vlan": {
"type": "integer"
}
},
"type": "object"
}
```
Response200
HideShow
An IP Entity
Headers
```
Content-Type: application/json
```
Body
```
{
"v4": {
"range_end": "cupidatat"
}
}
```
Schema
```
{
"properties": {
"address": {
"type": "string"
},
"billing_id": {
"type": "string"
},
"full_ip": {
"type": "string"
},
"gateway": {
"type": "string"
},
"group": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"nickname": {
"type": "string"
},
"owner": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"server": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"siblings_count": {
"type": "integer"
},
"subnet_mask": {
"type": "string"
},
"v4": {
"properties": {
"address": {
"type": "string"
},
"full": {
"type": "string"
},
"gateway": {
"type": "string"
},
"range_end": {
"type": "string"
},
"subnet_mask": {
"type": "string"
}
},
"type": "object"
},
"v6": {
"properties": {
"address": {
"type": "string"
},
"gateway": {
"type": "string"
}
},
"type": "object"
},
"v6_address": {
"type": "string"
},
"v6_gateway": {
"type": "string"
},
"vlan": {
"type": "integer"
}
},
"type": "object"
}
```
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{}
```
Schema
```
{
"properties": {
"address": {
"type": "string"
},
"billing_id": {
"type": "string"
},
"full_ip": {
"type": "string"
},
"gateway": {
"type": "string"
},
"group": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"nickname": {
"type": "string"
},
"owner": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"server": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"siblings_count": {
"type": "integer"
},
"subnet_mask": {
"type": "string"
},
"v4": {
"properties": {
"address": {
"type": "string"
},
"full": {
"type": "string"
},
"gateway": {
"type": "string"
},
"range_end": {
"type": "string"
},
"subnet_mask": {
"type": "string"
}
},
"type": "object"
},
"v6": {
"properties": {
"address": {
"type": "string"
},
"gateway": {
"type": "string"
}
},
"type": "object"
},
"v6_address": {
"type": "string"
},
"v6_gateway": {
"type": "string"
},
"vlan": {
"type": "integer"
}
},
"type": "object"
}
```
Response422
HideShow
Unprocessable Entity
Headers
```
Content-Type: application/json
```
Fields ¶
Fields
List Fields ¶
List Fields
GET/field
List of Fields
Example URI
GET /field
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
A List of Fields
Headers
```
Content-Type: application/json
```
Body
```
[
{},
{},
{},
{},
{}
]
```
Schema
```
{
"items": {
"properties": {
"default": {
"type": "string"
},
"desc": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"placeholder": {
"type": "string"
},
"slug": {
"type": "string"
},
"target_type": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
```
View Field ¶
View Field
GET/field/{field_id}
Field Information
Example URI
GET /field/field_id
URI Parameters
HideShow
field_id
string (required)
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
Field Information
Headers
```
Content-Type: application/json
```
Body
```
{
"target_type": "incididunt sit Excepteur Lorem sint"
}
```
Schema
```
{
"properties": {
"default": {
"type": "string"
},
"desc": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"placeholder": {
"type": "string"
},
"slug": {
"type": "string"
},
"target_type": {
"type": "string"
}
},
"type": "object"
}
```
List Field Values ¶
List Field Values
GET/field/{field_id}/value
Field Values
Example URI
GET /field/field_id/value
URI Parameters
HideShow
field_id
string (required)
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
Field Values
Headers
```
Content-Type: application/json
```
Body
```
{
"field_id": 86311880,
"value": "et"
}
```
Schema
```
{
"properties": {
"field_id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"target_id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"value": {
"type": "string"
}
},
"type": "object"
}
```
View Field Value ¶
View Field Value
GET/field/{field_id}/value/{value_id}
Field Value
Example URI
GET /field/field_id/value/value_id
URI Parameters
HideShow
field_id
string (required)
value_id
string (required)
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
A Field Value
Headers
```
Content-Type: application/json
```
Body
```
{
"target_id": 77645734,
"id": -51065444
}
```
Schema
```
{
"properties": {
"field_id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"target_id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"value": {
"type": "string"
}
},
"type": "object"
}
```
Forwarding Gateways ¶
Forwarding Gateways
List Forwarding Gateways ¶
List Forwarding Gateways
GET/forward/gateway
List of Forwarding Gateways
Example URI
GET /forward/gateway
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
A List of Forwarding Gateways
Headers
```
Content-Type: application/json
```
Body
```
[
{
"name": "non aliqua Dui",
"hostname": "in dolor ex non",
"port_limit": "veniam do ipsum non nostrud"
}
]
```
Schema
```
{
"items": {
"properties": {
"api_key": {
"type": "string"
},
"groups": {
"items": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"hostname": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"port_limit": {
"type": "string"
}
},
"required": [
"name",
"apikey",
"hostname",
"port limit"
]
},
"type": "array"
}
```
Create Forwarding Gateway
POST/forward/gateway
Create a new Forwarding Gateway
Example URI
POST /forward/gateway
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"name": "sit in ex",
"hostname": "velit deserunt",
"id": 38566610,
"api_key": "Duis esse Excepteur ad qui"
}
```
Schema
```
{
"properties": {
"api_key": {
"type": "string"
},
"groups": {
"items": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"hostname": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"port_limit": {
"type": "string"
}
},
"required": [
"name",
"apikey",
"hostname",
"port limit"
]
}
```
Response200
HideShow
A Forwarding Gateway
Headers
```
Content-Type: application/json
```
Body
```
{
"name": "dolor nostrud",
"hostname": "commodo non laboris",
"port_limit": "ipsum",
"api_key": "sed aliquip ipsum aliqua",
"id": -22916368
}
```
Schema
```
{
"properties": {
"api_key": {
"type": "string"
},
"groups": {
"items": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"hostname": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"port_limit": {
"type": "string"
}
},
"required": [
"name",
"apikey",
"hostname",
"port limit"
]
}
```
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"name": "ea incididunt exercitation",
"hostname": "amet id consequat fugiat",
"api_key": "non ut Lorem",
"id": 21333040,
"port_limit": "in anim Duis culpa ut",
"groups": [
{
"name": "adipisicing laboris non minim",
"id": 34472037
},
{
"name": "aliqua non veniam ea",
"id": -36023055
},
{
"id": -75271029,
"name": "cupidatat non do ad nostrud"
},
{
"name": "id consequat veniam ut"
}
]
}
```
Schema
```
{
"properties": {
"api_key": {
"type": "string"
},
"groups": {
"items": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"hostname": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"port_limit": {
"type": "string"
}
},
"required": [
"name",
"apikey",
"hostname",
"port limit"
]
}
```
Response422
HideShow
Unprocessable Entity
Headers
```
Content-Type: application/json
```
Delete Forwarding Gateway ¶
Delete Forwarding Gateway
DELETE/forward/gateway/{gateway_id}
Delete a Forwarding Gateway
Example URI
DELETE /forward/gateway/gateway_id
URI Parameters
HideShow
gateway_id
string (required)
Response200
HideShow
Forwarding Gateway deleted successfully
Response404
HideShow
Item not Found
View Forwarding Gateway
GET/forward/gateway/{gateway_id}
A Forwarding Gateway
Example URI
GET /forward/gateway/gateway_id
URI Parameters
HideShow
gateway_id
string (required)
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
A Forwarding Gateway
Headers
```
Content-Type: application/json
```
Body
```
{
"name": "veniam minim qui",
"hostname": "ipsum",
"labore8": 17393370,
"dolor4e5": 21779123
}
```
Schema
```
{
"properties": {
"api_key": {
"type": "string"
},
"groups": {
"items": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"hostname": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"port_limit": {
"type": "string"
}
},
"required": [
"name",
"apikey",
"hostname",
"port limit"
]
}
```
Edit Forwarding Gateway
PATCH/forward/gateway/{gateway_id}
Edit Forwarding Gateway
Example URI
PATCH /forward/gateway/gateway_id
URI Parameters
HideShow
gateway_id
string (required)
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"name": "minim",
"hostname": "eu id labore Ut",
"id": 66208716,
"proident7": -97235318
}
```
Schema
```
{
"properties": {
"api_key": {
"type": "string"
},
"groups": {
"items": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"hostname": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"port_limit": {
"type": "string"
}
},
"required": [
"name",
"apikey",
"hostname",
"port limit"
]
}
```
Response200
HideShow
A Forwarding Gateway
Headers
```
Content-Type: application/json
```
Body
```
{
"name": "ea exercitation Ut consequat in",
"hostname": "tempor in cupidatat amet",
"ullamco9": true,
"dolorc39": "cons"
}
```
Schema
```
{
"properties": {
"api_key": {
"type": "string"
},
"groups": {
"items": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"hostname": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"port_limit": {
"type": "string"
}
},
"required": [
"name",
"apikey",
"hostname",
"port limit"
]
}
```
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"name": "elit id cillum nostrud magna",
"hostname": "non sint laboris reprehenderit anim",
"culpa43": "tempor Lorem ",
"consequatf3": "nulla ut anim in eiusmod"
}
```
Schema
```
{
"properties": {
"api_key": {
"type": "string"
},
"groups": {
"items": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"hostname": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"port_limit": {
"type": "string"
}
},
"required": [
"name",
"apikey",
"hostname",
"port limit"
]
}
```
Response422
HideShow
Unprocessable Entity
Headers
```
Content-Type: application/json
```
List Forwarding Types ¶
List Forwarding Types
GET/forward/type
List of Forwarding Types
Example URI
GET /forward/type
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
A List of Forwarding Types
Headers
```
Content-Type: application/json
```
Body
```
[
{
"name": "laboris dolor magna",
"slug": "labore mollit of",
"id": 73593783
}
]
```
Schema
```
{
"items": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"slug": {
"type": "string"
}
}
},
"type": "array"
}
```
View Forwarding Type ¶
View Forwarding Type
GET/forward/type/{type_id}
Forwarding Type Information
Example URI
GET /forward/type/type_id
URI Parameters
HideShow
type_id
string (required)
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
Forwarding Type Information
Headers
```
Content-Type: application/json
```
Body
```
{
"id": -2562874
}
```
Schema
```
{
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"slug": {
"type": "string"
}
}
}
```
IP Groups ¶
IP Groups
List IP Groups ¶
List IP Groups
GET/group
List of IP Groups
Example URI
GET /group
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
A List of IP Groups
Headers
```
Content-Type: application/json
```
Body
```
[
{},
{},
{},
{
"id": -71881567,
"name": "ad adipisicing tempor"
},
{}
]
```
Schema
```
{
"items": {
"properties": {
"billing_id": {
"type": "string"
},
"entities": {
"properties": {
"count": {
"type": "integer"
}
},
"type": "object"
},
"entitiesCount": {
"type": "integer"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"pxe_dhcp_server": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"reserved": {
"type": "boolean"
},
"servers": {
"properties": {
"count": {
"type": "integer"
},
"inventory": {
"type": "integer"
}
},
"type": "object"
}
}
},
"type": "array"
}
```
Create IP Group
POST/group
Create a new IP Group
Example URI
POST /group
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{}
```
Schema
```
{
"properties": {
"billing_id": {
"type": "string"
},
"entities": {
"properties": {
"count": {
"type": "integer"
}
},
"type": "object"
},
"entitiesCount": {
"type": "integer"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"pxe_dhcp_server": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"reserved": {
"type": "boolean"
},
"servers": {
"properties": {
"count": {
"type": "integer"
},
"inventory": {
"type": "integer"
}
},
"type": "object"
}
}
}
```
Response200
HideShow
An IP Group
Headers
```
Content-Type: application/json
```
Body
```
{}
```
Schema
```
{
"properties": {
"billing_id": {
"type": "string"
},
"entities": {
"properties": {
"count": {
"type": "integer"
}
},
"type": "object"
},
"entitiesCount": {
"type": "integer"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"pxe_dhcp_server": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"reserved": {
"type": "boolean"
},
"servers": {
"properties": {
"count": {
"type": "integer"
},
"inventory": {
"type": "integer"
}
},
"type": "object"
}
}
}
```
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{}
```
Schema
```
{
"properties": {
"billing_id": {
"type": "string"
},
"entities": {
"properties": {
"count": {
"type": "integer"
}
},
"type": "object"
},
"entitiesCount": {
"type": "integer"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"pxe_dhcp_server": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"reserved": {
"type": "boolean"
},
"servers": {
"properties": {
"count": {
"type": "integer"
},
"inventory": {
"type": "integer"
}
},
"type": "object"
}
}
}
```
Response422
HideShow
Unprocessable Entity
Headers
```
Content-Type: application/json
```
Delete IP Group ¶
Delete IP Group
DELETE/group/{group_id}
Delete an IP Group
Example URI
DELETE /group/group_id
URI Parameters
HideShow
group_id
string (required)
Response200
HideShow
IP Group deleted successfully
Response404
HideShow
Item not Found
View IP Group
GET/group/{group_id}
An IP Group
Example URI
GET /group/group_id
URI Parameters
HideShow
group_id
string (required)
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
An IP Group
Headers
```
Content-Type: application/json
```
Body
```
{
"pxe_dhcp_server": {
"name": "consequat ut ex laborum",
"id": 96414696
}
}
```
Schema
```
{
"properties": {
"billing_id": {
"type": "string"
},
"entities": {
"properties": {
"count": {
"type": "integer"
}
},
"type": "object"
},
"entitiesCount": {
"type": "integer"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"pxe_dhcp_server": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"reserved": {
"type": "boolean"
},
"servers": {
"properties": {
"count": {
"type": "integer"
},
"inventory": {
"type": "integer"
}
},
"type": "object"
}
}
}
```
Edit IP Group
PATCH/group/{group_id}
Edit IP Group
Example URI
PATCH /group/group_id
URI Parameters
HideShow
group_id
string (required)
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{}
```
Schema
```
{
"properties": {
"billing_id": {
"type": "string"
},
"entities": {
"properties": {
"count": {
"type": "integer"
}
},
"type": "object"
},
"entitiesCount": {
"type": "integer"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"pxe_dhcp_server": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"reserved": {
"type": "boolean"
},
"servers": {
"properties": {
"count": {
"type": "integer"
},
"inventory": {
"type": "integer"
}
},
"type": "object"
}
}
}
```
Response200
HideShow
An IP Group
Headers
```
Content-Type: application/json
```
Body
```
{}
```
Schema
```
{
"properties": {
"billing_id": {
"type": "string"
},
"entities": {
"properties": {
"count": {
"type": "integer"
}
},
"type": "object"
},
"entitiesCount": {
"type": "integer"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"pxe_dhcp_server": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"reserved": {
"type": "boolean"
},
"servers": {
"properties": {
"count": {
"type": "integer"
},
"inventory": {
"type": "integer"
}
},
"type": "object"
}
}
}
```
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"billing_id": "fugiat ipsum amet enim ullamco",
"reserved": true,
"pxe_dhcp_server": {
"id": -24631614,
"name": "non in amet dolor ullamco"
}
}
```
Schema
```
{
"properties": {
"billing_id": {
"type": "string"
},
"entities": {
"properties": {
"count": {
"type": "integer"
}
},
"type": "object"
},
"entitiesCount": {
"type": "integer"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"pxe_dhcp_server": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"reserved": {
"type": "boolean"
},
"servers": {
"properties": {
"count": {
"type": "integer"
},
"inventory": {
"type": "integer"
}
},
"type": "object"
}
}
}
```
Response422
HideShow
Unprocessable Entity
Headers
```
Content-Type: application/json
```
Integration ¶
Integration
List Integrations ¶
List Integrations
GET/integration
List of Integrations
Example URI
GET /integration
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
List of Integrations
Headers
```
Content-Type: application/json
```
Body
```
[
{},
{},
{},
{}
]
```
Schema
```
{
"items": {
"properties": {
"clients": {
"type": "integer"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"keys": {
"type": "integer"
},
"name": {
"type": "string"
},
"permissions": {
"type": "integer"
},
"servers": {
"type": "integer"
}
},
"type": "object"
},
"type": "array"
}
```
Create Integration
POST/integration
Add new Integration
Example URI
POST /integration
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"name": "qui mollit Ut nulla in"
}
```
Schema
```
{
"required": [
"name"
],
"properties": {
"body": {
"type": "string"
},
"name": {
"type": "string"
},
"subject": {
"type": "string"
}
},
"type": "object"
}
```
Response200
HideShow
An Integration
Headers
```
Content-Type: application/json
```
Body
```
{
"keys": -34736124
}
```
Schema
```
{
"properties": {
"clients": {
"type": "integer"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"keys": {
"type": "integer"
},
"name": {
"type": "string"
},
"permissions": {
"type": "integer"
},
"servers": {
"type": "integer"
}
},
"type": "object"
}
```
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"name": "cupidatat elit dolor"
}
```
Schema
```
{
"required": [
"name"
],
"properties": {
"body": {
"type": "string"
},
"name": {
"type": "string"
},
"subject": {
"type": "string"
}
},
"type": "object"
}
```
Response422
HideShow
Unprocessable Entity
Headers
```
Content-Type: application/json
```
Delete Integration ¶
Delete Integration
DELETE/integration/{integration_id}
Delete an Integration
Example URI
DELETE /integration/integration_id
URI Parameters
HideShow
integration_id
string (required)
Response200
HideShow
Integration deleted successfully
Response404
HideShow
Item not Found
View Integration
GET/integration/{integration_id}
An Integration
Example URI
GET /integration/integration_id
URI Parameters
HideShow
integration_id
string (required)
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
An Integration
Headers
```
Content-Type: application/json
```
Body
```
{
"permissions": 2086104,
"keys": -23779442
}
```
Schema
```
{
"properties": {
"clients": {
"type": "integer"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"keys": {
"type": "integer"
},
"name": {
"type": "string"
},
"permissions": {
"type": "integer"
},
"servers": {
"type": "integer"
}
},
"type": "object"
}
```
Edit Integration
PATCH/integration/{integration_id}
Edit Integration
Example URI
PATCH /integration/integration_id
URI Parameters
HideShow
integration_id
string (required)
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"subject": "dolore",
"body": "adipisicing aute fugiat voluptate",
"name": "non incididunt id in"
}
```
Schema
```
{
"properties": {
"body": {
"type": "string"
},
"name": {
"type": "string"
},
"subject": {
"type": "string"
}
},
"type": "object"
}
```
Response200
HideShow
An Integration
Headers
```
Content-Type: application/json
```
Body
```
{
"keys": 43305158
}
```
Schema
```
{
"properties": {
"clients": {
"type": "integer"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"keys": {
"type": "integer"
},
"name": {
"type": "string"
},
"permissions": {
"type": "integer"
},
"servers": {
"type": "integer"
}
},
"type": "object"
}
```
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"name": "in laborum velit anim"
}
```
Schema
```
{
"properties": {
"body": {
"type": "string"
},
"name": {
"type": "string"
},
"subject": {
"type": "string"
}
},
"type": "object"
}
```
Response422
HideShow
Unprocessable Entity
Headers
```
Content-Type: application/json
```
List Integration Permissions ¶
List Integration Permissions
GET/integration/{integration_id}/permission
List of Permissions for an Integration
Example URI
GET /integration/integration_id/permission
URI Parameters
HideShow
integration_id
string (required)
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
List of Permissions for an Integration
Headers
```
Content-Type: application/json
```
Body
```
[
{
"network": {
"forward": {
"read": true,
"write": false
}
},
"system": {
"integrations": {
"read": false
}
}
},
{
"network": {
"switches": {
"write": false,
"read": true
}
}
},
{},
{},
{
"system": {
"theme": {
"read": true
}
}
}
]
```
Schema
```
{
"items": {
"properties": {
"network": {
"properties": {
"entities": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"forward": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"groups": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"switches": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"pxe": {
"properties": {
"installs": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"settings": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"server": {
"properties": {
"in_inventory": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"in_use": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"settings": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"system": {
"properties": {
"emails": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"integrations": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"logs": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"settings": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"theme": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"users": {
"properties": {
"admins": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"clients": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
}
```
Edit Integration Permissions
PATCH/integration/{integration_id}/permission
Edit Integration permissions
Example URI
PATCH /integration/integration_id/permission
URI Parameters
HideShow
integration_id
string (required)
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{}
```
Schema
```
{
"properties": {
"network": {
"properties": {
"entities": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"forward": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"groups": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"switches": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"pxe": {
"properties": {
"installs": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"settings": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"server": {
"properties": {
"in_inventory": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"in_use": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"settings": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"system": {
"properties": {
"emails": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"integrations": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"logs": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"settings": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"theme": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"users": {
"properties": {
"admins": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"clients": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
```
Response200
HideShow
An Integration’s Permissions
Headers
```
Content-Type: application/json
```
Body
```
{
"network": {
"forward": {
"read": false
},
"groups": {
"read": false,
"write": false
}
}
}
```
Schema
```
{
"properties": {
"network": {
"properties": {
"entities": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"forward": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"groups": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"switches": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"pxe": {
"properties": {
"installs": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"settings": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"server": {
"properties": {
"in_inventory": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"in_use": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"settings": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"system": {
"properties": {
"emails": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"integrations": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"logs": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"settings": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"theme": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"users": {
"properties": {
"admins": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"clients": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
```
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{}
```
Schema
```
{
"properties": {
"network": {
"properties": {
"entities": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"forward": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"groups": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"switches": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"pxe": {
"properties": {
"installs": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"settings": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"server": {
"properties": {
"in_inventory": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"in_use": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"settings": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"system": {
"properties": {
"emails": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"integrations": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"logs": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"settings": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"theme": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"users": {
"properties": {
"admins": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
},
"clients": {
"properties": {
"read": {
"type": "boolean"
},
"write": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
```
Response422
HideShow
Unprocessable Entity
Headers
```
Content-Type: application/json
```
System ¶
System
View License Information ¶
View License Information
GET/license
License Information for Synergy
Example URI
GET /license
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
License Information for Synergy
Headers
```
Content-Type: application/json
```
Body
```
{
"key": "est ut aute",
"has_enterprise": true,
"is_active": true
}
```
Schema
```
{
"properties": {
"has_enterprise": {
"type": "boolean"
},
"is_active": {
"type": "boolean"
},
"key": {
"type": "string"
}
},
"required": [
"key"
]
}
```
Create License Information ¶
Create License Information
POST/license/refresh
Refresh Synergy License Information
Example URI
POST /license/refresh
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{}
```
Schema
```
{
"properties": {
"isWrapped": {
"type": "boolean"
}
}
}
```
Response200
HideShow
License Information
Headers
```
Content-Type: application/json
```
Body
```
{
"key": "irure consectetur do Duis"
}
```
Schema
```
{
"properties": {
"has_enterprise": {
"type": "boolean"
},
"is_active": {
"type": "boolean"
},
"key": {
"type": "string"
}
},
"required": [
"key"
]
}
```
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{}
```
Schema
```
{
"properties": {
"isWrapped": {
"type": "boolean"
}
}
}
```
Response422
HideShow
Unprocessable Entity
Headers
```
Content-Type: application/json
```
List Log Items ¶
List Log Items
GET/log
Log Information for Synergy
Example URI
GET /log
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
Log Information for Synergy
Headers
```
Content-Type: application/json
```
Body
```
[
{
"id": 63738730,
"created_at": {
"iso_8601": "mollit Ut",
"unix": 94374484
},
"ip": "amet incididunt esse et",
"desc": "dolor"
},
{
"ip": "exercitation dolor in",
"created_at": {
"iso_8601": "ipsum est",
"unix": -44291819
},
"desc": "in ad enim"
}
]
```
Schema
```
{
"items": {
"properties": {
"created_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"
},
"desc": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"ip": {
"type": "string"
},
"targets": {
"items": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"singular": {
"type": "string"
},
"url": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"user": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"url": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
}
```
View Log Item ¶
View Log Item
GET/log/{log_id}
A Synergy Log Item
Example URI
GET /log/log_id
URI Parameters
HideShow
log_id
string (required)
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
A Synergy Log Item
Headers
```
Content-Type: application/json
```
Body
```
{}
```
Schema
```
{
"properties": {
"created_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"
},
"data": {
"properties": {
"description": {
"type": "string"
},
"message": {
"type": "string"
}
},
"type": "object"
},
"desc": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"ip": {
"type": "string"
},
"targets": {
"items": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"singular": {
"type": "string"
},
"url": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"user": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"url": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
```
List Packages ¶
List Packages
GET/package
Get Packages
Example URI
GET /package
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
Packages
Headers
```
Content-Type: application/json
```
Body
```
[
{
"files": [
"dolore irure in",
"fugiat est"
]
},
{
"files": [
"velit ullamco enim ea aliqua",
"",
"consectetu",
"Duis ipsum"
]
},
{
"files": [
"commodo fugiat elit",
"ullamco elit"
]
},
{}
]
```
Schema
```
{
"items": {
"properties": {
"files": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"type": "array"
}
```
View Package ¶
View Package
GET/package/{package_id}
Get Package
Example URI
GET /package/package_id
URI Parameters
HideShow
package_id
string (required)
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
Package
Headers
```
Content-Type: application/json
```
Body
```
{}
```
Schema
```
{
"properties": {
"files": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
```
List Setting Groups ¶
List Setting Groups
GET/setting-group
List of Setting Groups
Example URI
GET /setting-group
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
List of Setting Groups
Headers
```
Content-Type: application/json
```
Body
```
[
{},
{}
]
```
Schema
```
{
"items": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"parent": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"settings": {
"items": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"options": {
"type": "string"
},
"slug": {
"type": "string"
},
"type": {
"type": "string"
},
"validator": {
"type": "string"
},
"value": {
"type": "integer"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"type": "array"
}
```
View Setting Group ¶
View Setting Group
GET/setting-group/{setting_group_id}
Information about a Setting Group
Example URI
GET /setting-group/setting_group_id
URI Parameters
HideShow
setting_group_id
string (required)
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
Information about a Setting Group
Headers
```
Content-Type: application/json
```
Body
```
{
"id": -48929345
}
```
Schema
```
{
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"parent": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"settings": {
"items": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"options": {
"type": "string"
},
"slug": {
"type": "string"
},
"type": {
"type": "string"
},
"validator": {
"type": "string"
},
"value": {
"type": "integer"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
```
List Theme Customization Options ¶
List Theme Customization Options
GET/system/theme/customize
Theme Customization Options
Example URI
GET /system/theme/customize
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
Theme Customization Options
Headers
```
Content-Type: application/json
```
Body
```
{
"allowed": false
}
```
Schema
```
{
"properties": {
"allowed": {
"type": "boolean"
},
"theme": {
"properties": {
"custom_admin_html": {
"type": "string"
},
"custom_client_html": {
"type": "string"
},
"custom_css": {
"type": "string"
},
"link_color": {
"type": "string"
},
"logo": {
"type": "string"
},
"main_bg": {
"type": "string"
},
"nav_bg": {
"type": "string"
},
"panel_alt_bg": {
"type": "string"
},
"panel_bg": {
"type": "string"
},
"side_nav_bg": {
"type": "string"
},
"text_color": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
```
Edit Theme Customization Options
POST/system/theme/customize
Update Theme Customization Options
Example URI
POST /system/theme/customize
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{}
```
Schema
```
{
"properties": {
"allowed": {
"type": "boolean"
},
"theme": {
"properties": {
"custom_admin_html": {
"type": "string"
},
"custom_client_html": {
"type": "string"
},
"custom_css": {
"type": "string"
},
"link_color": {
"type": "string"
},
"logo": {
"type": "string"
},
"main_bg": {
"type": "string"
},
"nav_bg": {
"type": "string"
},
"panel_alt_bg": {
"type": "string"
},
"panel_bg": {
"type": "string"
},
"side_nav_bg": {
"type": "string"
},
"text_color": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
```
Response200
HideShow
Theme Customization Options
Headers
```
Content-Type: application/json
```
Body
```
{
"allowed": true
}
```
Schema
```
{
"properties": {
"allowed": {
"type": "boolean"
},
"theme": {
"properties": {
"custom_admin_html": {
"type": "string"
},
"custom_client_html": {
"type": "string"
},
"custom_css": {
"type": "string"
},
"link_color": {
"type": "string"
},
"logo": {
"type": "string"
},
"main_bg": {
"type": "string"
},
"nav_bg": {
"type": "string"
},
"panel_alt_bg": {
"type": "string"
},
"panel_bg": {
"type": "string"
},
"side_nav_bg": {
"type": "string"
},
"text_color": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
```
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"theme": {
"logo": "id velit dolor dolor ullamco",
"panel_alt_bg": "nulla veniam"
}
}
```
Schema
```
{
"properties": {
"allowed": {
"type": "boolean"
},
"theme": {
"properties": {
"custom_admin_html": {
"type": "string"
},
"custom_client_html": {
"type": "string"
},
"custom_css": {
"type": "string"
},
"link_color": {
"type": "string"
},
"logo": {
"type": "string"
},
"main_bg": {
"type": "string"
},
"nav_bg": {
"type": "string"
},
"panel_alt_bg": {
"type": "string"
},
"panel_bg": {
"type": "string"
},
"side_nav_bg": {
"type": "string"
},
"text_color": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
```
Response422
HideShow
Unprocessable Entity
Headers
```
Content-Type: application/json
```
List Todo Items ¶
List Todo Items
GET/todo
Todo Items
Example URI
GET /todo
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
Todo Items
Headers
```
Content-Type: application/json
```
Body
```
[
{}
]
```
Schema
```
{
"items": {
"properties": {
"completed_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"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"slug": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
```
View Todo Item ¶
View Todo Item
GET/todo/{todo_id}
Todo Item
Example URI
GET /todo/todo_id
URI Parameters
HideShow
todo_id
string (required)
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
Todo Item
Headers
```
Content-Type: application/json
```
Body
```
{
"completed_at": {
"iso_8601": "Ut ex cupidatat pariatur",
"unix": -26906287
},
"slug": "qui"
}
```
Schema
```
{
"properties": {
"completed_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"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"slug": {
"type": "string"
}
},
"type": "object"
}
```
Hardware ¶
Hardware
List Computer Parts ¶
List Computer Parts
GET/part{?part_type,q}
List of Computer Parts
Example URI
GET /part?part_type=&q=
URI Parameters
HideShow
part_type
string (required)
q
string (required)
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
List of Computer Parts
Headers
```
Content-Type: application/json
```
Body
```
[
{
"name": "cillum dolor"
},
{},
{
"name": "anim ut deserunt cillum aliqua",
"part_type": {
"name": "eu"
},
"billing_id": "qui elit",
"id": -94967887
}
]
```
Schema
```
{
"items": {
"properties": {
"billing_id": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"part_type": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
}
```
Create Computer Part
POST/part
Add new Computer Part
Example URI
POST /part
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"part_type": "proident irure",
"name": "labore ex Lorem",
"billing_id": "officia"
}
```
Schema
```
{
"properties": {
"billing_id": {
"type": "string"
},
"name": {
"type": "string"
},
"part_type": {
"type": "string"
}
},
"type": "object"
}
```
Response200
HideShow
Part Information
Headers
```
Content-Type: application/json
```
Body
```
{}
```
Schema
```
{
"properties": {
"billing_id": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"part_type": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
```
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"name": "laboris velit id qui Duis"
}
```
Schema
```
{
"properties": {
"billing_id": {
"type": "string"
},
"name": {
"type": "string"
},
"part_type": {
"type": "string"
}
},
"type": "object"
}
```
Response422
HideShow
Unprocessable Entity
Headers
```
Content-Type: application/json
```
Delete Computer Part ¶
Delete Computer Part
DELETE/part/{part_id}
Delete a Synergy Computer Part
Example URI
DELETE /part/part_id
URI Parameters
HideShow
part_id
string (required)
Response200
HideShow
Part deleted successfully
Response404
HideShow
Item not Found
View Computer Part
GET/part/{part_id}
A Synergy Computer Part
Example URI
GET /part/part_id
URI Parameters
HideShow
part_id
string (required)
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
A Synergy Computer Part
Headers
```
Content-Type: application/json
```
Body
```
{
"id": -37285037
}
```
Schema
```
{
"properties": {
"billing_id": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"part_type": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
```
Edit Computer Part
PATCH/part/{part_id}
Edit Computer Part
Example URI
PATCH /part/part_id
URI Parameters
HideShow
part_id
string (required)
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"billing_id": "consequat",
"name": "exercitation quis et reprehenderit ad",
"part_type": {
"name": "nisi Ut esse ex ut",
"id": -25277450
},
"id": 96079608
}
```
Schema
```
{
"required": [
"billing_id",
"name",
"part_type"
],
"properties": {
"billing_id": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"part_type": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
```
Response200
HideShow
A Synergy Computer Part
Headers
```
Content-Type: application/json
```
Body
```
{}
```
Schema
```
{
"properties": {
"billing_id": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"part_type": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
```
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"billing_id": "dolore veniam commodo pariatur ut",
"name": "in aliquip ut nulla",
"part_type": {
"name": "irure enim eiusmod id",
"id": -53578587
},
"id": -66738519
}
```
Schema
```
{
"required": [
"billing_id",
"name",
"part_type"
],
"properties": {
"billing_id": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"part_type": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
```
Response422
HideShow
Unprocessable Entity
Headers
```
Content-Type: application/json
```
Network ¶
Network
List Port Speeds ¶
List Port Speeds
GET/port-speed
List of Port Speeds
Example URI
GET /port-speed
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
List of Port Speeds
Headers
```
Content-Type: application/json
```
Body
```
[
{},
{
"billing_id": "elit",
"switchPortCount": true,
"name": "proident reprehenderit sit",
"id": 67168378
},
{},
{
"name": "eu consequat ut"
}
]
```
Schema
```
{
"items": {
"properties": {
"billing_id": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"switchPortCount": {
"type": "boolean"
}
},
"type": "object"
},
"type": "array"
}
```
Create Port Speed
POST/port-speed
Add new Port Speed
Example URI
POST /port-speed
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"speed": 16371038,
"billing_id": "quis",
"name": "dolore c"
}
```
Schema
```
{
"properties": {
"billing_id": {
"type": "string"
},
"name": {
"type": "string"
},
"speed": {
"type": "integer"
}
},
"type": "object"
}
```
Response200
HideShow
Port Speed Information
Headers
```
Content-Type: application/json
```
Body
```
{}
```
Schema
```
{
"properties": {
"billing_id": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"speed": {
"type": "integer"
},
"switchPortCount": {
"type": "boolean"
}
},
"type": "object"
}
```
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"name": "sint",
"billing_id": "nulla",
"speed": -31421880
}
```
Schema
```
{
"properties": {
"billing_id": {
"type": "string"
},
"name": {
"type": "string"
},
"speed": {
"type": "integer"
}
},
"type": "object"
}
```
Response422
HideShow
Unprocessable Entity
Headers
```
Content-Type: application/json
```
Delete Port Speed ¶
Delete Port Speed
DELETE/port-speed/{port_speed_id}
Delete a Synergy Port Speed
Example URI
DELETE /port-speed/port_speed_id
URI Parameters
HideShow
port_speed_id
string (required)
Response200
HideShow
Port Speed deleted successfully
Response404
HideShow
Item not Found
View Port Speed
GET/port-speed/{port_speed_id}
A Synergy Port Speed
Example URI
GET /port-speed/port_speed_id
URI Parameters
HideShow
port_speed_id
string (required)
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
A Synergy Port Speed
Headers
```
Content-Type: application/json
```
Body
```
{}
```
Schema
```
{
"properties": {
"billing_id": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"speed": {
"type": "integer"
},
"switchPortCount": {
"type": "boolean"
}
},
"type": "object"
}
```
Edit Port Speed
PATCH/port-speed/{port_speed_id}
Edit Port Speed
Example URI
PATCH /port-speed/port_speed_id
URI Parameters
HideShow
port_speed_id
string (required)
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"billing_id": "esse id sed in aliqua",
"name": "nostrud ullamco minim aliquip proident",
"speed": -47039790
}
```
Schema
```
{
"required": [
"billing_id",
"name",
"speed"
],
"properties": {
"billing_id": {
"type": "string"
},
"name": {
"type": "string"
},
"speed": {
"type": "integer"
}
},
"type": "object"
}
```
Response200
HideShow
A Synergy Port Speed
Headers
```
Content-Type: application/json
```
Body
```
{}
```
Schema
```
{
"properties": {
"billing_id": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"speed": {
"type": "integer"
},
"switchPortCount": {
"type": "boolean"
}
},
"type": "object"
}
```
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"billing_id": "elit veniam eiusmod non quis",
"name": "Ut est officia",
"speed": -31746144
}
```
Schema
```
{
"required": [
"billing_id",
"name",
"speed"
],
"properties": {
"billing_id": {
"type": "string"
},
"name": {
"type": "string"
},
"speed": {
"type": "integer"
}
},
"type": "object"
}
```
Response422
HideShow
Unprocessable Entity
Headers
```
Content-Type: application/json
```
DHCP Servers ¶
DHCP Servers
List DHCP Servers ¶
List DHCP Servers
GET/pxe/dhcp
List of DHCP Servers
Example URI
GET /pxe/dhcp
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
List of DHCP Servers
Headers
```
Content-Type: application/json
```
Body
```
[
{
"name": "dolore qui",
"id": 44650086
}
]
```
Schema
```
{
"items": {
"properties": {
"http": {
"properties": {
"host": {
"type": "string"
},
"api_key": {
"type": "string"
},
"port": {
"type": "integer"
},
"use_https": {
"type": "boolean"
}
},
"type": "object"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
```
Create DHCP Server
POST/pxe/dhcp
Add new DHCP Server
Example URI
POST /pxe/dhcp
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"http": {
"port": -64125538
}
}
```
Schema
```
{
"properties": {
"http": {
"properties": {
"host": {
"type": "string"
},
"api_key": {
"type": "string"
},
"port": {
"type": "integer"
},
"use_https": {
"type": "boolean"
}
},
"type": "object"
},
"name": {
"type": "string"
}
},
"type": "object"
}
```
Response200
HideShow
DHCP Server Information
Headers
```
Content-Type: application/json
```
Body
```
{
"name": "magna nulla dolor reprehenderit cillum",
"id": 64240773
}
```
Schema
```
{
"properties": {
"http": {
"properties": {
"host": {
"type": "string"
},
"api_key": {
"type": "string"
},
"port": {
"type": "integer"
},
"use_https": {
"type": "boolean"
}
},
"type": "object"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
}
```
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{}
```
Schema
```
{
"properties": {
"http": {
"properties": {
"host": {
"type": "string"
},
"api_key": {
"type": "string"
},
"port": {
"type": "integer"
},
"use_https": {
"type": "boolean"
}
},
"type": "object"
},
"name": {
"type": "string"
}
},
"type": "object"
}
```
Response422
HideShow
Unprocessable Entity
Headers
```
Content-Type: application/json
```
Delete DHCP Server ¶
Delete DHCP Server
DELETE/pxe/dhcp/{dhcp_id}
Delete a Synergy DHCP Server
Example URI
DELETE /pxe/dhcp/dhcp_id
URI Parameters
HideShow
dhcp_id
string (required)
Response200
HideShow
DHCP Server deleted successfully
Response404
HideShow
Item not Found
View DHCP Server
GET/pxe/dhcp/{dhcp_id}
A DHCP Server
Example URI
GET /pxe/dhcp/dhcp_id
URI Parameters
HideShow
dhcp_id
string (required)
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
A DHCP Server
Headers
```
Content-Type: application/json
```
Body
```
{
"name": "commodo sed sunt laboris officia"
}
```
Schema
```
{
"properties": {
"http": {
"properties": {
"host": {
"type": "string"
},
"api_key": {
"type": "string"
},
"port": {
"type": "integer"
},
"use_https": {
"type": "boolean"
}
},
"type": "object"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
}
```
Edit DHCP Server
PATCH/pxe/dhcp/{dhcp_id}
Edit DHCP Server
Example URI
PATCH /pxe/dhcp/dhcp_id
URI Parameters
HideShow
dhcp_id
string (required)
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"http": {
"port": 59424073,
"api_key": "pariatur"
}
}
```
Schema
```
{
"properties": {
"http": {
"properties": {
"host": {
"type": "string"
},
"api_key": {
"type": "string"
},
"port": {
"type": "integer"
},
"use_https": {
"type": "boolean"
}
},
"type": "object"
},
"name": {
"type": "string"
}
},
"type": "object"
}
```
Response200
HideShow
A Synergy DHCP Server
Headers
```
Content-Type: application/json
```
Body
```
{
"name": "commodo quis officia deserunt aute",
"http": {
"use_https": true
}
}
```
Schema
```
{
"properties": {
"http": {
"properties": {
"host": {
"type": "string"
},
"api_key": {
"type": "string"
},
"port": {
"type": "integer"
},
"use_https": {
"type": "boolean"
}
},
"type": "object"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
}
```
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"http": {
"api_key": "et",
"use_https": false,
"host": "eiusmod"
}
}
```
Schema
```
{
"properties": {
"http": {
"properties": {
"host": {
"type": "string"
},
"api_key": {
"type": "string"
},
"port": {
"type": "integer"
},
"use_https": {
"type": "boolean"
}
},
"type": "object"
},
"name": {
"type": "string"
}
},
"type": "object"
}
```
Response422
HideShow
Unprocessable Entity
Headers
```
Content-Type: application/json
```
PXE Drivers ¶
PXE Drivers
List PXE Drivers ¶
List PXE Drivers
GET/pxe/driver
List of PXE Drivers
Example URI
GET /pxe/driver
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
List of PXE Drivers
Headers
```
Content-Type: application/json
```
Body
```
[
{},
{},
{
"name": "occaecat velit esse",
"id": -20807038
}
]
```
Schema
```
{
"items": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
```
Create PXE Driver
POST/pxe/driver
Add new PXE Driver
Example URI
POST /pxe/driver
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Schema
```
{
"required": [
"name",
"driver"
],
"properties": {
"driver": {
"format": "binary",
"type": "string"
},
"name": {
"type": "string"
}
},
"type": "object"
}
```
Response200
HideShow
A PXE Driver
Headers
```
Content-Type: application/json
```
Body
```
{
"name": "ad sunt"
}
```
Schema
```
{
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
}
```
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Schema
```
{
"required": [
"name",
"driver"
],
"properties": {
"driver": {
"format": "binary",
"type": "string"
},
"name": {
"type": "string"
}
},
"type": "object"
}
```
Response422
HideShow
Unprocessable Entity
Headers
```
Content-Type: application/json
```
Delete PXE Driver ¶
Delete PXE Driver
DELETE/pxe/driver/{driver_id}
Delete a Synergy PXE Driver
Example URI
DELETE /pxe/driver/driver_id
URI Parameters
HideShow
driver_id
string (required)
Response200
HideShow
PXE Driver deleted successfully
Response404
HideShow
Item not Found
View PXE Driver
GET/pxe/driver/{driver_id}
A PXE Driver
Example URI
GET /pxe/driver/driver_id
URI Parameters
HideShow
driver_id
string (required)
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
A PXE Driver
Headers
```
Content-Type: application/json
```
Body
```
{}
```
Schema
```
{
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
}
```
Edit PXE Driver
PATCH/pxe/driver/{driver_id}
Edit PXE Driver
Example URI
PATCH /pxe/driver/driver_id
URI Parameters
HideShow
driver_id
string (required)
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Schema
```
{
"properties": {
"driver": {
"format": "binary",
"type": "string"
},
"name": {
"type": "string"
}
},
"type": "object"
}
```
Response200
HideShow
A Synergy PXE Driver
Headers
```
Content-Type: application/json
```
Body
```
{}
```
Schema
```
{
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
}
```
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{}
```
Schema
```
{
"properties": {
"driver": {
"format": "binary",
"type": "string"
},
"name": {
"type": "string"
}
},
"type": "object"
}
```
Response422
HideShow
Unprocessable Entity
Headers
```
Content-Type: application/json
```
File Servers ¶
File Servers
List File Servers ¶
List File Servers
GET/pxe/file
List of File Servers
Example URI
GET /pxe/file
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
List of File Servers
Headers
```
Content-Type: application/json
```
Body
```
[
{
"name": "irure et"
}
]
```
Schema
```
{
"items": {
"properties": {
"group": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"http": {
"properties": {
"host": {
"type": "string"
},
"port": {
"type": "integer"
},
"use_https": {
"type": "boolean"
}
},
"type": "object"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"install_max_concurrent": {
"type": "integer"
},
"name": {
"type": "string"
},
"parent": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"ssh": {
"properties": {
"port": {
"type": "integer"
},
"public_key": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
}
```
Create File Server
POST/pxe/file
Add new File Server
Example URI
POST /pxe/file
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"name": "qui",
"install_max_concurrent": -64867020,
"group_id": -69584613,
"inf9": false,
"proident5": true,
"ad415": 71267813,
"cupidatat9": -2256029
}
```
Schema
```
{
"required": [
"name",
"install_max_concurrent",
"group_id",
"host",
"port",
"api_key",
"public_key"
],
"properties": {
"group_id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"http": {
"properties": {
"host": {
"type": "string"
},
"api_key": {
"type": "string"
},
"port": {
"type": "integer"
},
"use_https": {
"type": "boolean"
}
},
"type": "object"
},
"install_max_concurrent": {
"type": "integer"
},
"name": {
"type": "string"
},
"parent_id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"ssh": {
"properties": {
"port": {
"type": "string"
},
"public_key": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
```
Response200
HideShow
A File Server
Headers
```
Content-Type: application/json
```
Body
```
{
"name": "dolore"
}
```
Schema
```
{
"properties": {
"group": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"http": {
"properties": {
"host": {
"type": "string"
},
"port": {
"type": "integer"
},
"use_https": {
"type": "boolean"
}
},
"type": "object"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"install_max_concurrent": {
"type": "integer"
},
"name": {
"type": "string"
},
"parent": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"ssh": {
"properties": {
"port": {
"type": "integer"
},
"public_key": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
```
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"name": "veniam",
"install_max_concurrent": 67202218,
"group_id": 63161577,
"parent_id": 69443475,
"eiusmodc85": "et commodo",
"laborum0": "Ut ad nulla sunt"
}
```
Schema
```
{
"required": [
"name",
"install_max_concurrent",
"group_id",
"host",
"port",
"api_key",
"public_key"
],
"properties": {
"group_id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"http": {
"properties": {
"host": {
"type": "string"
},
"api_key": {
"type": "string"
},
"port": {
"type": "integer"
},
"use_https": {
"type": "boolean"
}
},
"type": "object"
},
"install_max_concurrent": {
"type": "integer"
},
"name": {
"type": "string"
},
"parent_id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"ssh": {
"properties": {
"port": {
"type": "string"
},
"public_key": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
```
Response422
HideShow
Unprocessable Entity
Headers
```
Content-Type: application/json
```
Delete File Server ¶
Delete File Server
DELETE/pxe/file/{file_server_id}
Delete a File Server
Example URI
DELETE /pxe/file/file_server_id
URI Parameters
HideShow
file_server_id
string (required)
Response200
HideShow
File Server deleted successfully
Response404
HideShow
Item not Found
View File Server
GET/pxe/file/{file_server_id}
A File Server
Example URI
GET /pxe/file/file_server_id
URI Parameters
HideShow
file_server_id
string (required)
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
A File Server
Headers
```
Content-Type: application/json
```
Body
```
{
"http": {
"use_https": true,
"host": "eiusmod",
"port": -66116001
},
"parent": {
"id": 31608939
},
"install_max_concurrent": -85873035,
"group": {
"id": -95997332
}
}
```
Schema
```
{
"properties": {
"group": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"http": {
"properties": {
"host": {
"type": "string"
},
"port": {
"type": "integer"
},
"use_https": {
"type": "boolean"
}
},
"type": "object"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"install_max_concurrent": {
"type": "integer"
},
"name": {
"type": "string"
},
"parent": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"ssh": {
"properties": {
"port": {
"type": "integer"
},
"public_key": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
```
Edit File Server
PATCH/pxe/file/{file_server_id}
Edit File Server
Example URI
PATCH /pxe/file/file_server_id
URI Parameters
HideShow
file_server_id
string (required)
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"ssh": {
"public_key": "Excepteur",
"port": "elit"
},
"install_max_concurrent": 9764999,
"parent_id": -10542449
}
```
Schema
```
{
"properties": {
"group_id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"http": {
"properties": {
"host": {
"type": "string"
},
"api_key": {
"type": "string"
},
"port": {
"type": "integer"
},
"use_https": {
"type": "boolean"
}
},
"type": "object"
},
"install_max_concurrent": {
"type": "integer"
},
"name": {
"type": "string"
},
"parent_id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"ssh": {
"properties": {
"port": {
"type": "string"
},
"public_key": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
```
Response200
HideShow
A File Server
Headers
```
Content-Type: application/json
```
Body
```
{}
```
Schema
```
{
"properties": {
"group": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"http": {
"properties": {
"host": {
"type": "string"
},
"port": {
"type": "integer"
},
"use_https": {
"type": "boolean"
}
},
"type": "object"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"install_max_concurrent": {
"type": "integer"
},
"name": {
"type": "string"
},
"parent": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"ssh": {
"properties": {
"port": {
"type": "integer"
},
"public_key": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
```
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"parent_id": 57149112,
"name": "veniam esse minim reprehenderit sit"
}
```
Schema
```
{
"properties": {
"group_id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"http": {
"properties": {
"host": {
"type": "string"
},
"api_key": {
"type": "string"
},
"port": {
"type": "integer"
},
"use_https": {
"type": "boolean"
}
},
"type": "object"
},
"install_max_concurrent": {
"type": "integer"
},
"name": {
"type": "string"
},
"parent_id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"ssh": {
"properties": {
"port": {
"type": "string"
},
"public_key": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
```
Response422
HideShow
Unprocessable Entity
Headers
```
Content-Type: application/json
```
Sync Child Server Files ¶
Sync Child Server Files
POST/pxe/file/{file_server_id}/child/sync
Sync Files to Child Server
Example URI
POST /pxe/file/file_server_id/child/sync
URI Parameters
HideShow
file_server_id
string (required)
Request
HideShow
Headers
```
Content-Type: application/json
```
Body
```
{
"isWrapped": true
}
```
Schema
```
{
"properties": {
"isWrapped": {
"type": "boolean"
}
},
"required": [
"isWrapped"
]
}
```
Response200
HideShow
File server sync initiated with all children.
Request
HideShow
Headers
```
Content-Type: application/json
```
Body
```
{
"isWrapped": false
}
```
Schema
```
{
"properties": {
"isWrapped": {
"type": "boolean"
}
},
"required": [
"isWrapped"
]
}
```
Response422
HideShow
Unprocessable Entity
ISOs ¶
ISOs
List ISO Managers ¶
List ISO Managers
GET/pxe/iso
List of ISO Managers
Example URI
GET /pxe/iso
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
List of ISO Managers
Headers
```
Content-Type: application/json
```
Body
```
[
{},
{
"id": 62145863
},
{
"status": "i",
"name": "eu dolo"
}
]
```
Schema
```
{
"items": {
"properties": {
"created_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"
},
"folder": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"status": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
```
Create ISO Manager
POST/pxe/iso
Add new ISO Manager
Example URI
POST /pxe/iso
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"name": "eu veniam sunt",
"folder": "occaecat",
"url": "ullamco"
}
```
Schema
```
{
"required": [
"name",
"folder",
"url"
],
"properties": {
"folder": {
"type": "string"
},
"name": {
"type": "string"
},
"url": {
"type": "string"
}
},
"type": "object"
}
```
Response200
HideShow
An ISO Manager
Headers
```
Content-Type: application/json
```
Body
```
{
"name": "ea est deserunt veniam commodo",
"status": "officia aliquip amet proident"
}
```
Schema
```
{
"properties": {
"created_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"
},
"folder": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"status": {
"type": "string"
}
},
"type": "object"
}
```
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"name": "do",
"folder": "do",
"url": "sint"
}
```
Schema
```
{
"required": [
"name",
"folder",
"url"
],
"properties": {
"folder": {
"type": "string"
},
"name": {
"type": "string"
},
"url": {
"type": "string"
}
},
"type": "object"
}
```
Response422
HideShow
Unprocessable Entity
Headers
```
Content-Type: application/json
```
Delete ISO Manager ¶
Delete ISO Manager
DELETE/pxe/iso/{iso_manager_id}
Delete an ISO Manager
Example URI
DELETE /pxe/iso/iso_manager_id
URI Parameters
HideShow
iso_manager_id
string (required)
Response200
HideShow
ISO Manager deleted successfully
Response404
HideShow
Item not Found
View ISO Manager
GET/pxe/iso/{iso_manager_id}
An ISO Manager
Example URI
GET /pxe/iso/iso_manager_id
URI Parameters
HideShow
iso_manager_id
string (required)
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
An ISO Manager
Headers
```
Content-Type: application/json
```
Body
```
{
"name": "aliquip"
}
```
Schema
```
{
"properties": {
"created_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"
},
"folder": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"status": {
"type": "string"
}
},
"type": "object"
}
```
Edit ISO Manager
PATCH/pxe/iso/{iso_manager_id}
Edit ISO Manager
Example URI
PATCH /pxe/iso/iso_manager_id
URI Parameters
HideShow
iso_manager_id
string (required)
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"name": "ad mollit veniam ullamco com",
"url": "nulla id sunt nisi cupidatat",
"folder": "dolor ea ipsum"
}
```
Schema
```
{
"properties": {
"folder": {
"type": "string"
},
"name": {
"type": "string"
},
"url": {
"type": "string"
}
},
"type": "object"
}
```
Response200
HideShow
An ISO Manager
Headers
```
Content-Type: application/json
```
Body
```
{
"id": 93966642,
"name": "cupidatat",
"folder": "cillum",
"created_at": {
"iso_8601": "labore nisi irure tempor veniam",
"unix": 54118963
}
}
```
Schema
```
{
"properties": {
"created_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"
},
"folder": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"status": {
"type": "string"
}
},
"type": "object"
}
```
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{}
```
Schema
```
{
"properties": {
"folder": {
"type": "string"
},
"name": {
"type": "string"
},
"url": {
"type": "string"
}
},
"type": "object"
}
```
Response422
HideShow
Unprocessable Entity
Headers
```
Content-Type: application/json
```
List ISO Editions ¶
List ISO Editions
GET/pxe/iso/{iso_manager_id}/edition
List of ISO Editions
Example URI
GET /pxe/iso/iso_manager_id/edition
URI Parameters
HideShow
iso_manager_id
string (required)
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
List of ISO Editions
Headers
```
Content-Type: application/json
```
Body
```
[
{},
{
"name": "magna qui",
"key": "aliquip est",
"is_enabled": false,
"id": 32520592
},
{
"name": "aute nis",
"key": "sed consectetur"
}
]
```
Schema
```
{
"items": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"is_enabled": {
"type": "boolean"
},
"key": {
"type": "string"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
```
View ISO Edition ¶
View ISO Edition
GET/pxe/iso/{iso_manager_id}/edition/{edition_id}
An ISO Edition
Example URI
GET /pxe/iso/iso_manager_id/edition/edition_id
URI Parameters
HideShow
iso_manager_id
string (required)
edition_id
string (required)
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
An ISO Edition
Headers
```
Content-Type: application/json
```
Body
```
{}
```
Schema
```
{
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"is_enabled": {
"type": "boolean"
},
"key": {
"type": "string"
},
"name": {
"type": "string"
}
},
"type": "object"
}
```
Edit ISO Edition
PATCH/pxe/iso/{iso_manager_id}/edition/{edition_id}
Edit ISO Edition
Example URI
PATCH /pxe/iso/iso_manager_id/edition/edition_id
URI Parameters
HideShow
iso_manager_id
string (required)
edition_id
string (required)
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"license_key": "nulla velit esse fugiat sint",
"is_enabled": true
}
```
Schema
```
{
"properties": {
"is_enabled": {
"type": "boolean"
},
"license_key": {
"type": "string"
}
}
}
```
Response200
HideShow
An ISO Edition
Headers
```
Content-Type: application/json
```
Body
```
{}
```
Schema
```
{
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"is_enabled": {
"type": "boolean"
},
"key": {
"type": "string"
},
"name": {
"type": "string"
}
},
"type": "object"
}
```
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{}
```
Schema
```
{
"properties": {
"is_enabled": {
"type": "boolean"
},
"license_key": {
"type": "string"
}
}
}
```
Response422
HideShow
Unprocessable Entity
Headers
```
Content-Type: application/json
```
PXE Preseeds ¶
PXE Preseeds
List OS Preseeds ¶
List OS Preseeds
GET/pxe/preseed
List of OS Preseeds
Example URI
GET /pxe/preseed
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
List of OS Preseeds
Headers
```
Content-Type: application/json
```
Body
```
[
{
"name": "do minim",
"is_installable": true
},
{
"name": "ad et dolor velit",
"id": 59452761,
"is_installable": true,
"description": "veniam"
}
]
```
Schema
```
{
"items": {
"properties": {
"description": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"is_installable": {
"type": "boolean"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
```
Create OS Preseed
POST/pxe/preseed
Add new OS Preseed
Example URI
POST /pxe/preseed
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"name": "adipisicing"
}
```
Schema
```
{
"required": [
"name"
],
"properties": {
"body": {
"type": "string"
},
"description": {
"type": "string"
},
"is_installable": {
"type": "boolean"
},
"name": {
"type": "string"
}
},
"type": "object"
}
```
Response200
HideShow
An OS Preseed
Headers
```
Content-Type: application/json
```
Body
```
{}
```
Schema
```
{
"properties": {
"body": {
"type": "string"
},
"description": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"is_installable": {
"type": "boolean"
},
"name": {
"type": "string"
}
},
"type": "object"
}
```
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"name": "magna pariatur in ipsum",
"is_installable": false
}
```
Schema
```
{
"required": [
"name"
],
"properties": {
"body": {
"type": "string"
},
"description": {
"type": "string"
},
"is_installable": {
"type": "boolean"
},
"name": {
"type": "string"
}
},
"type": "object"
}
```
Response422
HideShow
Unprocessable Entity
Headers
```
Content-Type: application/json
```
Delete OS Preseed ¶
Delete OS Preseed
DELETE/pxe/preseed/{preseed_id}
Delete an OS Preseed
Example URI
DELETE /pxe/preseed/preseed_id
URI Parameters
HideShow
preseed_id
string (required)
Response200
HideShow
OS Preseed deleted successfully
Response404
HideShow
Item not Found
View OS Preseed
GET/pxe/preseed/{preseed_id}
An OS Preseed
Example URI
GET /pxe/preseed/preseed_id
URI Parameters
HideShow
preseed_id
string (required)
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
An OS Preseed
Headers
```
Content-Type: application/json
```
Body
```
{
"name": "pariatur mollit eu",
"body": "est elit voluptate ea",
"description": "pariatur cupidatat labore non ea"
}
```
Schema
```
{
"properties": {
"body": {
"type": "string"
},
"description": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"is_installable": {
"type": "boolean"
},
"name": {
"type": "string"
}
},
"type": "object"
}
```
Edit OS Preseed
PATCH/pxe/preseed/{preseed_id}
Edit OS Preseed
Example URI
PATCH /pxe/preseed/preseed_id
URI Parameters
HideShow
preseed_id
string (required)
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"name": "aliqua dolore ipsum fugiat"
}
```
Schema
```
{
"properties": {
"body": {
"type": "string"
},
"description": {
"type": "string"
},
"is_installable": {
"type": "boolean"
},
"name": {
"type": "string"
}
},
"type": "object"
}
```
Response200
HideShow
An OS Preseed
Headers
```
Content-Type: application/json
```
Body
```
{
"id": 18111025
}
```
Schema
```
{
"properties": {
"body": {
"type": "string"
},
"description": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"is_installable": {
"type": "boolean"
},
"name": {
"type": "string"
}
},
"type": "object"
}
```
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"body": "sunt Duis reprehenderit"
}
```
Schema
```
{
"properties": {
"body": {
"type": "string"
},
"description": {
"type": "string"
},
"is_installable": {
"type": "boolean"
},
"name": {
"type": "string"
}
},
"type": "object"
}
```
Response422
HideShow
Unprocessable Entity
Headers
```
Content-Type: application/json
```
OS Reload Profiles ¶
OS Reload Profiles
List Reload Profiles ¶
List Reload Profiles
GET/pxe/profile
List of OS Reload Profiles
Example URI
GET /pxe/profile
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
List of OS Reload Profiles
Headers
```
Content-Type: application/json
```
Body
```
[
{
"iso": {
"id": -78283021
}
},
{
"billing_id": "minim elit mollit"
}
]
```
Schema
```
{
"items": {
"properties": {
"access_client": {
"type": "boolean"
},
"billing_id": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"iso": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
}
},
"type": "object"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
```
Create Reload Profile
POST/pxe/profile
Add new Reload Profiles
Example URI
POST /pxe/profile
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"name": "ipsum qui deserunt",
"boot_script": {
"id": -72888011
},
"id": 85457712,
"shell": {
"after": [
37007636,
-93728428,
-83158272,
-3544072,
4272667
]
}
}
```
Schema
```
{
"required": [
"name",
"boot_script"
],
"properties": {
"access_client": {
"type": "boolean"
},
"billing_id": {
"type": "string"
},
"boot_script": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"drivers": {
"items": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"email": {
"properties": {
"template": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"iso": {
"properties": {
"edition": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"name": {
"type": "string"
},
"preseed": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"shell": {
"properties": {
"after": {
"items": {
"type": "integer"
},
"type": "array"
}
},
"type": "object"
}
},
"type": "object"
}
```
Response200
HideShow
A Reload Profiles
Headers
```
Content-Type: application/json
```
Body
```
{
"email": {
"template": {
"id": 74162014
}
},
"id": -48507101
}
```
Schema
```
{
"properties": {
"access_client": {
"type": "boolean"
},
"billing_id": {
"type": "string"
},
"boot_script": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"drivers": {
"items": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"email": {
"properties": {
"template": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"iso": {
"properties": {
"edition": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"name": {
"type": "string"
},
"preseed": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
```
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"name": "qui",
"boot_script": {
"name": "dolore"
}
}
```
Schema
```
{
"required": [
"name",
"boot_script"
],
"properties": {
"access_client": {
"type": "boolean"
},
"billing_id": {
"type": "string"
},
"boot_script": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"drivers": {
"items": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"email": {
"properties": {
"template": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"iso": {
"properties": {
"edition": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"name": {
"type": "string"
},
"preseed": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"shell": {
"properties": {
"after": {
"items": {
"type": "integer"
},
"type": "array"
}
},
"type": "object"
}
},
"type": "object"
}
```
Response422
HideShow
Unprocessable Entity
Headers
```
Content-Type: application/json
```
Delete Reload Profile ¶
Delete Reload Profile
DELETE/pxe/profile/{profile_id}
Delete an OS Reload Profile
Example URI
DELETE /pxe/profile/profile_id
URI Parameters
HideShow
profile_id
string (required)
Response200
HideShow
OS Reload Profile deleted successfully
Response404
HideShow
Item not Found
View Reload Profile
GET/pxe/profile/{profile_id}
An OS Preseed
Example URI
GET /pxe/profile/profile_id
URI Parameters
HideShow
profile_id
string (required)
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
An OS Preseed
Headers
```
Content-Type: application/json
```
Body
```
{
"billing_id": "Lorem Excepteur occaecat velit",
"name": "te"
}
```
Schema
```
{
"properties": {
"access_client": {
"type": "boolean"
},
"billing_id": {
"type": "string"
},
"boot_script": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"drivers": {
"items": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"email": {
"properties": {
"template": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"iso": {
"properties": {
"edition": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"name": {
"type": "string"
},
"preseed": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
```
Edit Reload Profile
PATCH/pxe/profile/{profile_id}
Edit OS Reload Profile
Example URI
PATCH /pxe/profile/profile_id
URI Parameters
HideShow
profile_id
string (required)
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"id": -52632267,
"name": "nostrud anim",
"boot_script": {
"id": -13222382,
"name": "ipsum reprehenderit Excepteur"
}
}
```
Schema
```
{
"properties": {
"access_client": {
"type": "boolean"
},
"billing_id": {
"type": "string"
},
"boot_script": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"drivers": {
"items": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"email": {
"properties": {
"template": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"iso": {
"properties": {
"edition": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"name": {
"type": "string"
},
"preseed": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"shell": {
"properties": {
"after": {
"items": {
"type": "integer"
},
"type": "array"
}
},
"type": "object"
}
},
"type": "object"
}
```
Response200
HideShow
An OS Reload Profile
Headers
```
Content-Type: application/json
```
Body
```
{}
```
Schema
```
{
"properties": {
"access_client": {
"type": "boolean"
},
"billing_id": {
"type": "string"
},
"boot_script": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"drivers": {
"items": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"email": {
"properties": {
"template": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"iso": {
"properties": {
"edition": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"name": {
"type": "string"
},
"preseed": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
```
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"boot_script": {
"id": -21831772,
"name": "in in amet"
}
}
```
Schema
```
{
"properties": {
"access_client": {
"type": "boolean"
},
"billing_id": {
"type": "string"
},
"boot_script": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"drivers": {
"items": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"email": {
"properties": {
"template": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"iso": {
"properties": {
"edition": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"name": {
"type": "string"
},
"preseed": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"shell": {
"properties": {
"after": {
"items": {
"type": "integer"
},
"type": "array"
}
},
"type": "object"
}
},
"type": "object"
}
```
Response422
HideShow
Unprocessable Entity
Headers
```
Content-Type: application/json
```
OS Shell Scripts ¶
OS Shell Scripts
List Shell Scripts ¶
List Shell Scripts
GET/pxe/shell
List of OS Reload Shell Scripts
Example URI
GET /pxe/shell
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
List of OS Reload Shell Scripts
Headers
```
Content-Type: application/json
```
Body
```
[
{
"description": "fugiat "
},
{}
]
```
Schema
```
{
"items": {
"properties": {
"description": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
```
Create Shell Script
POST/pxe/shell
Add new Reload Shell Scripts
Example URI
POST /pxe/shell
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"name": "irure ea consequat",
"description": "sint ullamco laborum dolore",
"body": "velit proident"
}
```
Schema
```
{
"required": [
"name"
],
"properties": {
"body": {
"type": "string"
},
"description": {
"type": "string"
},
"name": {
"type": "string"
}
},
"type": "object"
}
```
Response200
HideShow
A Reload Shell Script
Headers
```
Content-Type: application/json
```
Body
```
{
"id": 40803386
}
```
Schema
```
{
"properties": {
"body": {
"type": "string"
},
"description": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
}
```
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"name": "Excepteur eiusmod est ea"
}
```
Schema
```
{
"required": [
"name"
],
"properties": {
"body": {
"type": "string"
},
"description": {
"type": "string"
},
"name": {
"type": "string"
}
},
"type": "object"
}
```
Response422
HideShow
Unprocessable Entity
Headers
```
Content-Type: application/json
```
Delete Shell Script ¶
Delete Shell Script
DELETE/pxe/shell/{shell_script_id}
Delete an OS Reload Shell Script
Example URI
DELETE /pxe/shell/shell_script_id
URI Parameters
HideShow
shell_script_id
string (required)
Response200
HideShow
OS Reload Shell Script deleted successfully
Response404
HideShow
Item not Found
View Shell Script
GET/pxe/shell/{shell_script_id}
An OS Reload Shell Script
Example URI
GET /pxe/shell/shell_script_id
URI Parameters
HideShow
shell_script_id
string (required)
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
An OS Reload Shell Script
Headers
```
Content-Type: application/json
```
Body
```
{
"description": "enim in"
}
```
Schema
```
{
"properties": {
"body": {
"type": "string"
},
"description": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
}
```
Edit Shell Script
PATCH/pxe/shell/{shell_script_id}
Edit OS Reload Shell Script
Example URI
PATCH /pxe/shell/shell_script_id
URI Parameters
HideShow
shell_script_id
string (required)
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"body": "Duis",
"description": "amet",
"name": "eu proident elit"
}
```
Schema
```
{
"properties": {
"body": {
"type": "string"
},
"description": {
"type": "string"
},
"name": {
"type": "string"
}
},
"type": "object"
}
```
Response200
HideShow
An OS Reload Shell Script
Headers
```
Content-Type: application/json
```
Body
```
{}
```
Schema
```
{
"properties": {
"body": {
"type": "string"
},
"description": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
}
```
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"body": "exercitation",
"description": "nulla sint eiusmod aut",
"name": "ea in sunt"
}
```
Schema
```
{
"properties": {
"body": {
"type": "string"
},
"description": {
"type": "string"
},
"name": {
"type": "string"
}
},
"type": "object"
}
```
Response422
HideShow
Unprocessable Entity
Headers
```
Content-Type: application/json
```
OS Templates ¶
OS Templates
List Templates ¶
List Templates
GET/pxe/template
List of OS Templates
Example URI
GET /pxe/template
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
List of OS Templates
Headers
```
Content-Type: application/json
```
Body
```
[
{},
{
"name": "anim elit id"
},
{
"id": 68488049,
"iso_id": 22208841,
"body": "incididunt",
"name": "laboris"
},
{}
]
```
Schema
```
{
"items": {
"properties": {
"body": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"iso_id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
```
Create Template
POST/pxe/template
Add new Template
Example URI
POST /pxe/template
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"name": "esse",
"body": "anim"
}
```
Schema
```
{
"required": [
"name"
],
"properties": {
"body": {
"type": "string"
},
"name": {
"type": "string"
}
},
"type": "object"
}
```
Response200
HideShow
A Template
Headers
```
Content-Type: application/json
```
Body
```
{
"id": -85717949,
"iso_id": 96008405
}
```
Schema
```
{
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"iso_id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
}
```
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"name": "in",
"body": "cupidatat occaecat minim non"
}
```
Schema
```
{
"required": [
"name"
],
"properties": {
"body": {
"type": "string"
},
"name": {
"type": "string"
}
},
"type": "object"
}
```
Response422
HideShow
Unprocessable Entity
Headers
```
Content-Type: application/json
```
Delete Template ¶
Delete Template
DELETE/pxe/template/{template_id}
Delete an OS Reload Template
Example URI
DELETE /pxe/template/template_id
URI Parameters
HideShow
template_id
string (required)
Response200
HideShow
OS Reload Template deleted successfully
Response404
HideShow
Item not Found
View Template
GET/pxe/template/{template_id}
An OS Reload Template
Example URI
GET /pxe/template/template_id
URI Parameters
HideShow
template_id
string (required)
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
An OS Reload Template
Headers
```
Content-Type: application/json
```
Body
```
{}
```
Schema
```
{
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"iso_id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
}
```
Edit Template
PATCH/pxe/template/{template_id}
Edit OS Reload Template
Example URI
PATCH /pxe/template/template_id
URI Parameters
HideShow
template_id
string (required)
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{}
```
Schema
```
{
"properties": {
"body": {
"type": "string"
},
"name": {
"type": "string"
}
},
"type": "object"
}
```
Response200
HideShow
An OS Reload Template
Headers
```
Content-Type: application/json
```
Body
```
{
"iso_id": 92973406,
"name": "enim laboris dolor qui",
"id": -23774237
}
```
Schema
```
{
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"iso_id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
}
```
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{}
```
Schema
```
{
"properties": {
"body": {
"type": "string"
},
"name": {
"type": "string"
}
},
"type": "object"
}
```
Response422
HideShow
Unprocessable Entity
Headers
```
Content-Type: application/json
```
Servers ¶
Servers
List Servers ¶
List Servers
GET/server{?parts.exact,available,inventory,is_pxe_ready,q,cpu,mem,disks,addons,cpu_billing,mem_billing,disks_billing,addons_billing,client,group,switch,ip_group_billing,billing_id,billing_integration}
Example URI
GET /server?parts.exact=&available=&inventory=&is_pxe_ready=&q=&cpu=&mem=&disks=&addons=&cpu_billing=&mem_billing=&disks_billing=&addons_billing=&client=&group=&switch=&ip_group_billing=&billing_id=&billing_integration=
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
```
Response200
HideShow
A list of Servers
Headers
```
Content-Type: application/json
```
Body
```
[
{
"srv_id": "ut",
"access": {
"id": -32631705,
"client": {
"id": -12646728,
"name": "exercitation labore commodo do mollit",
"email": "sunt occaecat labore eu Excepteur"
},
"ipmi": true,
"is_active": true,
"pxe": false,
"switch": true
},
"addons": [
{
"id": 5347908,
"name": "sed aliqua id",
"billing_id": "offici"
},
{
"id": -79337601,
"name": "sit amet minim aliquip",
"billing_id": "sint"
}
],
"billing": {
"id": -24220612,
"date": "nisi commodo id",
"integration": {
"id": -70335837,
"name": "nisi non ipsum deserunt reprehenderit"
}
},
"canEdit": true,
"cpu": {
"id": 7912144,
"name": "nulla magna esse ut enim",
"billing_id": "nulla sint"
},
"disks": [
{
"id": 18931547,
"name": "ad velit",
"billing_id": "elit pariatur"
}
],
"entity": {
"id": -78550743,
"name": "in officia mollit Excepteur dolore",
"full_ip": "dolore irure ullamco mollit cupidatat"
},
"group": {
"id": 44799894,
"name": "anim tempor non"
},
"hdd_counts": [
{
"key": 14978706,
"value": "ad proident"
},
{
"key": 8093850,
"value": "nostrud consectetur irure quis"
}
],
"id": -78373499,
"ipmi": {
"id": 95783756,
"admin": {
"username": "ipsum labore cupidatat ",
"password": "ut quis ipsu"
},
"client": {
"username": "consectetur Duis nulla ea",
"password": "aliqua nulla"
},
"ip": "in sed cupidatat qui"
},
"is_ipmi_ready": true,
"is_pxe_ready": false,
"mem": {
"id": 74120206,
"name": "in mollit",
"billing_id": "irure"
},
"nickname": "voluptate sed",
"notes": {},
"raid_soft_ready": false,
"status_desc": "veniam amet sed",
"switch": {
"id": 28032102,
"name": "labo",
"port": {
"id": 68333132,
"name": "Excepteur dolor"
}
},
"usage": {
"id": 47025097,
"used": 87827884,
"max": 90491266
}
},
{
"srv_id": "cillum veniam",
"access": {
"id": 97091113,
"client": {
"id": 94155936,
"name": "sit commodo ex ea qui",
"email": "esse enim id Lorem in",
"first": "ea veniam"
},
"ipmi": true,
"is_active": true,
"pxe": true,
"switch": false
},
"addons": [
{
"id": -68491410,
"name": "exercitation nisi dolor",
"billing_id": "id eiusmod in"
},
{
"id": 95811401,
"name": "occaecat veniam",
"billing_id": "esse culpa irure"
},
{
"id": -86068878,
"name": "in cupidatat et",
"billing_id": "officia sunt"
},
{
"id": -40764123,
"name": "ullamco",
"billing_id": "ex"
},
{
"id": 26962202,
"name": "ut",
"billing_id": "Duis dolor velit exercitation fugiat"
}
],
"billing": {
"id": -69458086,
"date": "do",
"integration": {
"id": -19619355,
"name": "qui nisi nulla"
}
},
"canEdit": false,
"cpu": {
"id": -42138376,
"name": "enim non esse cupidatat sed",
"billing_id": "nisi ut cupidatat"
},
"disks": [
{
"id": -34508981,
"name": "magna do",
"billing_id": "non enim Duis de"
},
{
"id": 47870002,
"name": "sit",
"billing_id": "ut"
}
],
"entity": {
"id": -89085556,
"name": "laborum esse Duis",
"full_ip": "et dolor"
},
"group": {
"id": 64300885,
"name": "labore in exercitation quis"
},
"hdd_counts": [
{
"key": -90557078,
"value": "fugiat"
},
{
"key": -43343436,
"value": "occaecat et ea"
},
{
"key": -81088186,
"value": "aliqua"
},
{
"key": -18952403,
"value": "sunt eiusmod nisi"
},
{
"key": -48706644,
"value": "voluptate quis"
}
],
"id": 20273197,
"ipmi": {
"id": 83772653,
"admin": {
"username": "ipsum",
"password": "esse enim ut dolore commodo"
},
"client": {
"username": "velit",
"password": "exercitation"
},
"ip": "Ut est do sint ullamco"
},
"is_ipmi_ready": true,
"is_pxe_ready": true,
"mem": {
"id": 2961688,
"name": "ullamco Excepteur voluptate",
"billing_id": "qui labore fugiat nulla"
},
"nickname": "cillum enim Excepteur dolore",
"notes": {},
"raid_soft_ready": true,
"status_desc": "velit nostrud magna cillum qui",
"switch": {
"id": -91061804,
"name": "Excepteur ullamco",
"port": {
"id": -81103668,
"name": "ipsum"
}
},
"usage": {
"id": -7762157,
"used": 20815970,
"max": -20899490
}
},
{
"srv_id": "velit",
"access": {
"id": -88005861,
"client": {
"id": 76357834,
"name": "deserunt ut culpa consectetur",
"email": "ex"
},
"ipmi": false,
"is_active": true,
"pxe": false,
"switch": false
},
"addons": [
{
"id": 92654918,
"name": "enim",
"billing_id": "in"
},
{
"id": -64526779,
"name": "eu nostrud consequat sint",
"billing_id": "nisi elit dolore"
}
],
"billing": {
"id": 89713523,
"date": "occ",
"integration": {
"id": -64146824,
"name": "et"
}
},
"canEdit": false,
"cpu": {
"id": 19983196,
"name": "mollit ea proident",
"billing_id": "non sunt"
},
"disks": [
{
"id": 31827165,
"name": "tempor",
"billing_id": "occaecat velit sunt sed"
},
{
"id": -16215367,
"name": "mollit minim amet ut deserunt",
"billing_id": ""
}
],
"entity": {
"id": 19063406,
"name": "tempor sunt",
"full_ip": "sit laboris ut"
},
"group": {
"id": 82398178,
"name": "elit magna reprehenderit est ad"
},
"hdd_counts": [
{
"key": -3275394,
"value": "amet ipsum"
},
{
"key": 6001547,
"value": "ut Lorem"
},
{
"key": -96360224,
"value": "ad esse"
}
],
"id": -46718814,
"ipmi": {
"id": -58757527,
"admin": {
"username": "do dolor et nulla",
"password": "reprehenderit nostrud culpa"
},
"client": {
"username": "fugiat non ullamco",
"password": "consequat"
},
"ip": "laborum id sit amet"
},
"is_ipmi_ready": true,
"is_pxe_ready": false,
"mem": {
"id": -1211004,
"name": "commodo labore ullamco amet dolor",
"billing_id": "elit eu dolore"
},
"nickname": "magna Duis sin",
"notes": {
"client": "mollit",
"admin": "exercitation consectet"
},
"raid_soft_ready": false,
"status_desc": "id et",
"switch": {
"id": 71295232,
"name": "non incididunt do in",
"port": {
"id": 5774613,
"name": "eiusmod sed"
}
},
"usage": {
"id": 91401210,
"used": -48293497,
"max": -72729956
}
}
]
```
Schema
```
{
"items": {
"properties": {
"access": {
"properties": {
"client": {
"properties": {
"billing": {
"properties": {
"id": {
"description": "The Billing ID of the API Integration that this client belongs to.",
"type": "integer"
},
"ignoreAutoSuspend": {
"description": "Tells Synergy that this is a client with VIP status and their servers will never be automatically suspended.",
"type": "boolean"
}
},
"type": "object"
},
"billing_id": {
"type": "integer"
},
"created_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"
},
"email": {
"example": "[email protected]",
"type": "string"
},
"first": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"integration": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
},
"last": {
"type": "string"
},
"name": {
"type": "string"
},
"serversCount": {
"type": "integer"
}
},
"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
```
Response400
HideShow
Invalid input
Headers
```
Content-Type: application/json
```
Create Server
POST/server
Create a new Server
Example URI
POST /server
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"cpu": {
"id": 61712901,
"name": "laborum",
"billing_id": "aliqua eiusmod Duis sunt dolore"
},
"mem": {
"id": -96405222,
"name": "eu laboris",
"billing_id": "proident sit ut quis"
},
"disks": [
{
"id": -55449217,
"name": "ut do nisi nulla dolore",
"billing_id": "nisi sit in"
},
{
"id": -47030899,
"name": "ut non Excepteur",
"billing_id": "dolor nisi"
},
{
"id": -52248808,
"name": "qui adipisicing Du",
"billing_id": "qui amet esse Duis"
},
{
"id": 41997358,
"name": "aliquip exercitation eiusmod ut cupidatat",
"billing_id": "culpa"
}
],
"id": -10881559
}
```
Schema
```
{
"required": [
"cpu",
"mem",
"disks",
"id"
],
"properties": {
"access": {
"properties": {
"client": {
"properties": {
"billing": {
"properties": {
"id": {
"description": "The Billing ID of the API Integration that this client belongs to.",
"type": "integer"
},
"ignoreAutoSuspend": {
"description": "Tells Synergy that this is a client with VIP status and their servers will never be automatically suspended.",
"type": "boolean"
}
},
"type": "object"
},
"billing_id": {
"type": "integer"
},
"created_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"
},
"email": {
"example": "[email protected]",
"type": "string"
},
"first": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"integration": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
},
"last": {
"type": "string"
},
"name": {
"type": "string"
},
"serversCount": {
"type": "integer"
}
},
"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"
}
},
"type": "object"
}
```
Response200
HideShow
A Server
Headers
```
Content-Type: application/json
```
Body
```
{
"srv_id": "irure e",
"access": {
"id": -3856015,
"client": {
"id": 72293609,
"name": "commodo",
"email": "quis velit Duis nostrud",
"billing_id": 63809240
},
"ipmi": false,
"is_active": true,
"pxe": true,
"switch": true
},
"addons": [
{
"id": -69393935,
"name": "pariatur exercitation",
"billing_id": "fugiat Ut con"
},
{
"id": -66951799,
"name": "officia Ut magna",
"billing_id": "exercitation commodo enim dolor laborum"
},
{
"id": 6430737,
"name": "sit deserunt",
"billing_id": "adipis"
},
{
"id": 80745906,
"name": "ipsum ut consectetur occaecat",
"billing_id": "sit sed quis"
},
{
"id": 92032543,
"name": "exercitation Ut laborum enim pariatur",
"billing_id": "aute deserunt"
}
],
"billing": {
"id": 85413339,
"date": "deserunt labore elit adipisicing pariatur",
"integration": {
"id": -1391337,
"name": "culpa irure"
}
},
"canEdit": false,
"cpu": {
"id": -65673566,
"name": "consequat",
"billing_id": "ea Excepteur mollit occaecat"
},
"disks": [
{
"id": -30739100,
"name": "consectetur deserunt ut",
"billing_id": "voluptate dolor culpa"
},
{
"id": 96537594,
"name": "Duis est dolor aliquip",
"billing_id": "tempor ipsum enim sed veniam"
},
{
"id": -47759980,
"name": "est pariatur aliquip",
"billing_id": "sed reprehenderit cillum consectetur"
},
{
"id": -53108514,
"name": "eiusmod",
"billing_id": "velit"
},
{
"id": 19109735,
"name": "aliqua dolore Excepteur consequat in",
"billing_id": "eiusmod proident pariatur cupidatat "
}
],
"entity": {
"id": -64212950,
"name": "sed dolore",
"full_ip": "minim sed ut"
},
"group": {
"id": 76940502,
"name": "enim ad"
},
"hdd_counts": [
{
"key": 18514053,
"value": "commodo"
},
{
"key": -6245219,
"value": "voluptate"
},
{
"key": -29200337,
"value": "nostrud deserunt dolor proident"
},
{
"key": 46088146,
"value": "consequat aute do"
}
],
"id": 59925688,
"ipmi": {
"id": -7192299,
"admin": {
"username": "labore",
"password": "quis Excepteur cillum Lorem exercitation"
},
"client": {
"username": "velit Ut eu culpa",
"password": "dolore ex est"
},
"ip": "ut nisi dolore tempor culpa"
},
"is_ipmi_ready": false,
"is_pxe_ready": false,
"mem": {
"id": -33010862,
"name": "consectetur ex cupidatat in enim",
"billing_id": "Ut in nisi non irure"
},
"nickname": "qui sit aute sunt",
"notes": {},
"raid_soft_ready": false,
"status_desc": "deseru",
"switch": {
"id": -2105564,
"name": "quis nisi",
"port": {
"id": 89200658,
"name": "veniam amet sit"
}
},
"usage": {
"id": -22267091,
"used": -60224328,
"max": -75637997
}
}
```
Schema
```
{
"properties": {
"access": {
"properties": {
"client": {
"properties": {
"billing": {
"properties": {
"id": {
"description": "The Billing ID of the API Integration that this client belongs to.",
"type": "integer"
},
"ignoreAutoSuspend": {
"description": "Tells Synergy that this is a client with VIP status and their servers will never be automatically suspended.",
"type": "boolean"
}
},
"type": "object"
},
"billing_id": {
"type": "integer"
},
"created_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"
},
"email": {
"example": "[email protected]",
"type": "string"
},
"first": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"integration": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
},
"last": {
"type": "string"
},
"name": {
"type": "string"
},
"serversCount": {
"type": "integer"
}
},
"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"
}
```
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"cpu": {
"id": 89753729,
"name": "voluptate ut qui",
"billing_id": "dolor occaecat laborum eiusmod"
},
"mem": {
"id": 38642418,
"name": "aliquip anim elit",
"billing_id": "Excepteur velit voluptate dolore in"
},
"disks": [
{
"id": 5178175,
"name": "consequat dolore esse anim velit",
"billing_id": "id irure dolore"
},
{
"id": 80670949,
"name": "eu ullamco",
"billing_id": "et"
},
{
"id": -15398255,
"name": "ipsum minim dolor officia consequat",
"billing_id": "esse do"
},
{
"id": -3711027,
"name": "magna veniam mollit enim",
"billing_id": "est occaecat dolor"
},
{
"id": -48570756,
"name": "aute dolor esse",
"billing_id": "magna"
}
],
"id": -78827773,
"billing": {
"id": -16199317,
"date": "occaecat anim",
"integration": {
"id": 66764313,
"name": "in sint enim"
}
},
"nickname": "commodo"
}
```
Schema
```
{
"required": [
"cpu",
"mem",
"disks",
"id"
],
"properties": {
"access": {
"properties": {
"client": {
"properties": {
"billing": {
"properties": {
"id": {
"description": "The Billing ID of the API Integration that this client belongs to.",
"type": "integer"
},
"ignoreAutoSuspend": {
"description": "Tells Synergy that this is a client with VIP status and their servers will never be automatically suspended.",
"type": "boolean"
}
},
"type": "object"
},
"billing_id": {
"type": "integer"
},
"created_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"
},
"email": {
"example": "[email protected]",
"type": "string"
},
"first": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"integration": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
},
"last": {
"type": "string"
},
"name": {
"type": "string"
},
"serversCount": {
"type": "integer"
}
},
"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"
}
},
"type": "object"
}
```
Response422
HideShow
Unprocessable Entity
Headers
```
Content-Type: application/json
```
List Server Control Types ¶
List Server Control Types
GET/server/control/type
A list of the types of server controls
Example URI
GET /server/control/type
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
A list of the types of server controls
Headers
```
Content-Type: application/json
```
Body
```
[
{
"name": "laboris Duis",
"supports": {
"snmp": true
}
},
{},
{},
{
"name": "",
"id": -98669871
},
{
"id": -18281043
}
]
```
Schema
```
{
"items": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"supports": {
"properties": {
"admin_user": {
"type": "boolean"
},
"bmc_reset": {
"type": "boolean"
},
"boot_device": {
"type": "boolean"
},
"client_user": {
"type": "boolean"
},
"power_control": {
"type": "boolean"
},
"power_status": {
"type": "boolean"
},
"snmp": {
"type": "boolean"
},
"system_info": {
"type": "boolean"
},
"web_access": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
}
```
View Server Control ¶
View Server Control
GET/server/control/type/{type_id}
List the server controls for a type of server
Example URI
GET /server/control/type/type_id
URI Parameters
HideShow
type_id
string (required)
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
List the server controls for a type of server
Headers
```
Content-Type: application/json
```
Body
```
{}
```
Schema
```
{
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"supports": {
"properties": {
"admin_user": {
"type": "boolean"
},
"bmc_reset": {
"type": "boolean"
},
"boot_device": {
"type": "boolean"
},
"client_user": {
"type": "boolean"
},
"power_control": {
"type": "boolean"
},
"power_status": {
"type": "boolean"
},
"snmp": {
"type": "boolean"
},
"system_info": {
"type": "boolean"
},
"web_access": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
}
```
Provision Server ¶
Provision Server
POST/server/provision
Provison a Server
Example URI
POST /server/provision
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"server": {
"id": -6462633
},
"extra_ports_ip_group_id_to_billing_id": {
"proident33e": 26554089
},
"entities": [],
"ips_billing": "et commodo eu sint do"
}
```
Schema
```
{
"properties": {
"entities": {
"description": "An array of entity IDs",
"type": "array"
},
"extra_ports_ip_group_id_to_billing_id": {
"description": "A mapping from IP Group ID to Billing ID which applies only to secondary server ports",
"properties": {
"some_ip_group_ID": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
}
},
"required": [
"some_ip_group_id"
],
"type": "object"
},
"ips_billing": {
"description": "IP Entity/IP Pool Billing ID",
"type": "string"
},
"server": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
}
},
"required": [
"id"
],
"type": "object"
}
},
"required": [
"server",
"extra_ports_ip_group_id_to_billing_id",
"entities",
"ips_billing"
],
"type": "object"
}
```
Response200
HideShow
A Server
Headers
```
Content-Type: application/json
```
Body
```
{
"srv_id": "commodo",
"access": {
"id": -74038930,
"client": {
"id": -16039911,
"name": "mollit veniam quis esse",
"email": "sint dolor consectetur",
"first": "nulla ullamco consectetur aute Excepteur"
},
"ipmi": false,
"is_active": false,
"pxe": false,
"switch": false
},
"addons": [
{
"id": -94409723,
"name": "fugiat sed magna culpa elit",
"billing_id": "ad"
}
],
"billing": {
"id": 93513523,
"date": "officia tempor ullamco elit consequat",
"integration": {
"id": -81797566,
"name": "minim ad irure incididunt reprehenderit"
}
},
"canEdit": true,
"cpu": {
"id": 30030777,
"name": "sed",
"billing_id": "aliqua ex"
},
"disks": [
{
"id": -96709835,
"name": "nulla",
"billing_id": "elit"
},
{
"id": -27197515,
"name": "adipisicing ullamco veniam ut",
"billing_id": "pariatur culpa magna e"
},
{
"id": 9104726,
"name": "sit officia non",
"billing_id": "enim adipisicing Ut velit"
},
{
"id": 36811877,
"name": "ex dolor aliquip",
"billing_id": "incididunt do"
}
],
"entity": {
"id": -27334160,
"name": "incididunt",
"full_ip": "Ut nis"
},
"group": {
"id": 39856085,
"name": "do incididunt officia deserunt culpa"
},
"hdd_counts": [
{
"key": 78833121,
"value": "sint non Excepteur amet velit"
},
{
"key": 72604190,
"value": "enim"
},
{
"key": -53215923,
"value": "sit voluptate non labore"
}
],
"id": 14321934,
"ipmi": {
"id": -89639625,
"admin": {
"username": "quis Duis elit",
"password": "irure nostrud deserunt voluptate"
},
"client": {
"username": "voluptate fugiat elit",
"password": "enim culpa pariatur"
},
"ip": "in"
},
"is_ipmi_ready": true,
"is_pxe_ready": false,
"mem": {
"id": -6469472,
"name": "reprehenderit veniam velit dolor i",
"billing_id": "magna Ut dolor"
},
"nickname": "aliqua non sed",
"notes": {},
"raid_soft_ready": false,
"status_desc": "Duis quis ea",
"switch": {
"id": -50952730,
"name": "sunt dolore ut nulla consequat",
"port": {
"id": 50972688,
"name": "sint dolore ex dolor"
}
},
"usage": {
"id": -75370089,
"used": 29520512,
"max": -91891823
}
}
```
Schema
```
{
"properties": {
"access": {
"properties": {
"client": {
"properties": {
"billing": {
"properties": {
"id": {
"description": "The Billing ID of the API Integration that this client belongs to.",
"type": "integer"
},
"ignoreAutoSuspend": {
"description": "Tells Synergy that this is a client with VIP status and their servers will never be automatically suspended.",
"type": "boolean"
}
},
"type": "object"
},
"billing_id": {
"type": "integer"
},
"created_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"
},
"email": {
"example": "[email protected]",
"type": "string"
},
"first": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"integration": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
},
"last": {
"type": "string"
},
"name": {
"type": "string"
},
"serversCount": {
"type": "integer"
}
},
"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"
}
```
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"server": {
"id": -42368955
},
"extra_ports_ip_group_id_to_billing_id": {
"laboruma80": -10479010
},
"entities": [],
"ips_billing": "Excepteur et mollit irure"
}
```
Schema
```
{
"properties": {
"entities": {
"description": "An array of entity IDs",
"type": "array"
},
"extra_ports_ip_group_id_to_billing_id": {
"description": "A mapping from IP Group ID to Billing ID which applies only to secondary server ports",
"properties": {
"some_ip_group_ID": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
}
},
"required": [
"some_ip_group_id"
],
"type": "object"
},
"ips_billing": {
"description": "IP Entity/IP Pool Billing ID",
"type": "string"
},
"server": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
}
},
"required": [
"id"
],
"type": "object"
}
},
"required": [
"server",
"extra_ports_ip_group_id_to_billing_id",
"entities",
"ips_billing"
],
"type": "object"
}
```
Response422
HideShow
Unprocessable Entity
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
```
Response200
HideShow
A server
Headers
```
Content-Type: application/json
```
Body
```
{
"srv_id": "cillum commodo ea laboris sint",
"access": {
"id": -28924716,
"client": {
"id": 46858256,
"name": "minim sed commodo ad",
"email": "dolore sunt",
"integration": {
"id": 18606851,
"name": "labore"
}
},
"ipmi": false,
"is_active": false,
"pxe": true,
"switch": false
},
"addons": [
{
"id": 51520001,
"name": "nulla ipsum eiusmod",
"billing_id": "sit officia ut occaecat"
},
{
"id": 75814710,
"name": "nostrud ad sint labore",
"billing_id": "reprehenderit exercitation laborum ut deserunt"
},
{
"id": -2305691,
"name": "qui consectet",
"billing_id": "reprehenderit sint"
}
],
"billing": {
"id": 62585273,
"date": "enim",
"integration": {
"id": -19437155,
"name": ""
}
},
"canEdit": false,
"cpu": {
"id": 1587268,
"name": "ullam",
"billing_id": "mollit"
},
"disks": [
{
"id": 6240800,
"name": "voluptate fugiat culpa",
"billing_id": "eiusmod ipsum"
}
],
"entity": {
"id": 64002172,
"name": "labore",
"full_ip": "dolor"
},
"group": {
"id": 27854004,
"name": "enim sit"
},
"hdd_counts": [
{
"key": 34915179,
"value": "commodo ut aliquip"
},
{
"key": 36959202,
"value": "mollit"
},
{
"key": 70475447,
"value": "exercitation cillum voluptate ipsum ullamco"
}
],
"id": 90584764,
"ipmi": {
"id": 88403607,
"admin": {
"username": "culpa ad eu",
"password": "Excepteur laborum al"
},
"client": {
"username": "in",
"password": "sunt velit"
},
"ip": "ex anim"
},
"is_ipmi_ready": false,
"is_pxe_ready": false,
"mem": {
"id": 11431404,
"name": "laborum cillum nulla",
"billing_id": "commodo dolor aliquip esse"
},
"nickname": "exercitation ut nisi reprehenderit do",
"notes": {},
"raid_soft_ready": true,
"status_desc": "ullamco Duis Ut commodo dolore",
"switch": {
"id": -45126183,
"name": "et consequat culpa magna s",
"port": {
"id": 54392342,
"name": "velit"
}
},
"usage": {
"id": -12512278,
"used": -78600279,
"max": 9800093
}
}
```
Schema
```
{
"properties": {
"access": {
"properties": {
"client": {
"properties": {
"billing": {
"properties": {
"id": {
"description": "The Billing ID of the API Integration that this client belongs to.",
"type": "integer"
},
"ignoreAutoSuspend": {
"description": "Tells Synergy that this is a client with VIP status and their servers will never be automatically suspended.",
"type": "boolean"
}
},
"type": "object"
},
"billing_id": {
"type": "integer"
},
"created_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"
},
"email": {
"example": "[email protected]",
"type": "string"
},
"first": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"integration": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
},
"last": {
"type": "string"
},
"name": {
"type": "string"
},
"serversCount": {
"type": "integer"
}
},
"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"
}
```
Edit 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
```
Response200
HideShow
A server
Headers
```
Content-Type: application/json
```
Body
```
{
"srv_id": "adipisicing velit e",
"access": {
"id": -1974126,
"client": {
"id": -15426734,
"name": "aliquip",
"email": "sit sed",
"integration": {
"id": 41342493,
"name": "laborum labore sint esse sunt"
},
"created_at": {
"iso_8601": "id adipisicing velit",
"unix": -91613433
},
"billing_id": 71725121
},
"ipmi": true,
"is_active": true,
"pxe": false,
"switch": true
},
"addons": [
{
"id": 9073015,
"name": "non sed occaecat ut",
"billing_id": "ullamco amet in"
},
{
"id": 56714446,
"name": "nostrud",
"billing_id": "esse velit ut consequat"
},
{
"id": -54298541,
"name": "ipsum irure in nisi dolore",
"billing_id": "vol"
},
{
"id": 49754151,
"name": "in in labore",
"billing_id": "sed "
},
{
"id": 9586564,
"name": "cupidatat culpa dolor",
"billing_id": "commodo labore laborum non"
}
],
"billing": {
"id": -49617222,
"date": "sed eu ea enim incididunt",
"integration": {
"id": -42409152,
"name": "consequat"
}
},
"canEdit": true,
"cpu": {
"id": -99606546,
"name": "amet",
"billing_id": "nostrud consequat aliquip exercitation"
},
"disks": [
{
"id": -12312122,
"name": "velit",
"billing_id": "labore fugiat"
}
],
"entity": {
"id": 38548437,
"name": "est ullamco dolore aute adipisicing",
"full_ip": "aliquip consectetur"
},
"group": {
"id": -57404392,
"name": "eni"
},
"hdd_counts": [
{
"key": 24556437,
"value": "nisi commodo officia cupidatat ut"
}
],
"id": -39427627,
"ipmi": {
"id": 92670047,
"admin": {
"username": "occaecat do cillum",
"password": "id proident ut"
},
"client": {
"username": "sed eiusmod ipsum tempor",
"password": "ipsum"
},
"ip": "Lorem aliquip non id reprehenderit"
},
"is_ipmi_ready": true,
"is_pxe_ready": false,
"mem": {
"id": -28818024,
"name": "consectetur",
"billing_id": "culpa ut tempor"
},
"nickname": "ad dolor",
"notes": {},
"raid_soft_ready": true,
"status_desc": "dolore dolor est",
"switch": {
"id": -39768967,
"name": "ut in eiusmod veniam",
"port": {
"id": -28367322,
"name": "aliqua incididunt Excepteur Lorem"
}
},
"usage": {
"id": 67009793,
"used": -26034015,
"max": -12816981
}
}
```
Schema
```
{
"properties": {
"access": {
"properties": {
"client": {
"properties": {
"billing": {
"properties": {
"id": {
"description": "The Billing ID of the API Integration that this client belongs to.",
"type": "integer"
},
"ignoreAutoSuspend": {
"description": "Tells Synergy that this is a client with VIP status and their servers will never be automatically suspended.",
"type": "boolean"
}
},
"type": "object"
},
"billing_id": {
"type": "integer"
},
"created_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"
},
"email": {
"example": "[email protected]",
"type": "string"
},
"first": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"integration": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
},
"last": {
"type": "string"
},
"name": {
"type": "string"
},
"serversCount": {
"type": "integer"
}
},
"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 ¶
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
```
Response200
HideShow
A list of Server Accesses
Headers
```
Content-Type: application/json
```
Body
```
[
{
"id": -21584537,
"client": {
"id": 77772701,
"name": "proident in esse pariatur sit",
"email": "mollit do",
"last": "ut proident"
},
"ipmi": true,
"is_active": true,
"pxe": true,
"switch": true
}
]
```
Schema
```
{
"items": {
"properties": {
"client": {
"properties": {
"billing": {
"properties": {
"id": {
"description": "The Billing ID of the API Integration that this client belongs to.",
"type": "integer"
},
"ignoreAutoSuspend": {
"description": "Tells Synergy that this is a client with VIP status and their servers will never be automatically suspended.",
"type": "boolean"
}
},
"type": "object"
},
"billing_id": {
"type": "integer"
},
"created_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"
},
"email": {
"example": "[email protected]",
"type": "string"
},
"first": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"integration": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
},
"last": {
"type": "string"
},
"name": {
"type": "string"
},
"serversCount": {
"type": "integer"
}
},
"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"
}
```
Edit Server Access
PATCH/server/{server_id}/access
Edit Client Access on a Server.
Example URI
PATCH /server/server_id/access
URI Parameters
HideShow
server_id
string (required)
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"id": -7643063,
"client": {
"id": 97410757,
"name": "officia ut Lorem in",
"email": "Excepteur exercitation Duis dolor mollit",
"integration": {
"id": -9614372,
"name": "mollit minim laboris"
},
"first": "esse magna occaecat aute commodo"
},
"ipmi": false,
"is_active": true,
"pxe": true,
"switch": false
}
```
Schema
```
{
"properties": {
"client": {
"properties": {
"billing": {
"properties": {
"id": {
"description": "The Billing ID of the API Integration that this client belongs to.",
"type": "integer"
},
"ignoreAutoSuspend": {
"description": "Tells Synergy that this is a client with VIP status and their servers will never be automatically suspended.",
"type": "boolean"
}
},
"type": "object"
},
"billing_id": {
"type": "integer"
},
"created_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"
},
"email": {
"example": "[email protected]",
"type": "string"
},
"first": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"integration": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
},
"last": {
"type": "string"
},
"name": {
"type": "string"
},
"serversCount": {
"type": "integer"
}
},
"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"
}
```
Response200
HideShow
A Server Access
Headers
```
Content-Type: application/json
```
Body
```
{
"id": -86884100,
"client": {
"id": 11968206,
"name": "laboris",
"email": "id pariatur voluptate occaecat dolore",
"integration": {
"id": 1060699,
"name": "aliqua reprehenderit nulla dolor dolor"
}
},
"ipmi": false,
"is_active": true,
"pxe": true,
"switch": false
}
```
Schema
```
{
"properties": {
"client": {
"properties": {
"billing": {
"properties": {
"id": {
"description": "The Billing ID of the API Integration that this client belongs to.",
"type": "integer"
},
"ignoreAutoSuspend": {
"description": "Tells Synergy that this is a client with VIP status and their servers will never be automatically suspended.",
"type": "boolean"
}
},
"type": "object"
},
"billing_id": {
"type": "integer"
},
"created_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"
},
"email": {
"example": "[email protected]",
"type": "string"
},
"first": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"integration": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
},
"last": {
"type": "string"
},
"name": {
"type": "string"
},
"serversCount": {
"type": "integer"
}
},
"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)
Response200
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
```
Response200
HideShow
A Server Access
Headers
```
Content-Type: application/json
```
Body
```
{
"id": -52445197,
"client": {
"id": -50588226,
"name": "culpa officia exercitation quis Duis",
"email": "amet ut et",
"last": "nisi dolor exercita"
},
"ipmi": true,
"is_active": false,
"pxe": false,
"switch": false
}
```
Schema
```
{
"properties": {
"client": {
"properties": {
"billing": {
"properties": {
"id": {
"description": "The Billing ID of the API Integration that this client belongs to.",
"type": "integer"
},
"ignoreAutoSuspend": {
"description": "Tells Synergy that this is a client with VIP status and their servers will never be automatically suspended.",
"type": "boolean"
}
},
"type": "object"
},
"billing_id": {
"type": "integer"
},
"created_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"
},
"email": {
"example": "[email protected]",
"type": "string"
},
"first": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"integration": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
},
"last": {
"type": "string"
},
"name": {
"type": "string"
},
"serversCount": {
"type": "integer"
}
},
"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 ¶
Server Power Controls
List Server Controls ¶
List Server 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
```
Response200
HideShow
A list of Server Power Controls
Headers
```
Content-Type: application/json
```
Body
```
[
{
"id": -89330410,
"ip": "Excepteur voluptate laborum su",
"client_user": "ut in ",
"client_password": "ullamco culpa",
"admin_user": "",
"admin_password": "fugiat esse",
"server": {
"id": 46463613,
"srv_id": "dolore aute in"
},
"type": {
"id": 52784938,
"name": "commodo "
}
},
{
"id": 80916684,
"ip": "p",
"client_user": "aliquip te",
"client_password": "Duis incididunt",
"admin_user": "veniam esse reprehenderit est mollit",
"admin_password": "sit ut in aute Duis",
"server": {
"id": -83230724,
"srv_id": "officia"
}
},
{
"id": 82998857,
"ip": "in",
"client_user": "est in veniam",
"client_password": "ea incididunt cul",
"admin_user": "veniam",
"admin_password": "incididunt Lorem reprehenderit si",
"server": {
"id": -53938758,
"srv_id": "nulla"
},
"type": {
"id": 99799778,
"name": "Lor"
}
},
{
"id": 79002969,
"ip": "ut veniam officia magna enim",
"client_user": "Excepteur",
"client_password": "in",
"admin_user": "occaecat cillum aliqua",
"admin_password": "ut",
"server": {
"id": 53679039,
"srv_id": "voluptate offici"
},
"type": {
"id": -24115894,
"name": "in"
}
}
]
```
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"
}
```
Edit Server Control
PATCH/server/{server_id}/control
Example URI
PATCH /server/server_id/control
URI Parameters
HideShow
server_id
string (required)
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"id": -48931085,
"ip": "fugiat",
"client_user": "et magna veniam id",
"client_password": "officia occaecat eu dolor qui",
"admin_user": "laboris ea",
"admin_password": "labore",
"server": {
"id": 30291303,
"srv_id": "quis pariatur"
}
}
```
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"
}
```
Response200
HideShow
A Server Power Control
Headers
```
Content-Type: application/json
```
Body
```
{
"id": 70589293,
"ip": "dolore culpa adipisicing",
"client_user": "et",
"client_password": "laboris adipisic",
"admin_user": "ea ut in quis",
"admin_password": "in Du",
"server": {
"id": -2464043,
"srv_id": "par"
},
"type": {
"id": 26267802,
"name": "laborum culpa commodo velit"
}
}
```
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 Control ¶
Delete Server 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)
Response200
HideShow
Server Power Control deleted.
View Server 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
```
Response200
HideShow
A Server Power Control
Headers
```
Content-Type: application/json
```
Body
```
{
"id": -52817100,
"ip": "qui ut",
"client_user": "quis proident",
"client_password": "ea in cupidatat Excepteur ut",
"admin_user": "voluptate consectetur",
"admin_password": "pariatur velit Excepteur laborum non",
"server": {
"id": 17409274,
"srv_id": "eiusmod sint"
}
}
```
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 Control Command ¶
Run 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
```
{
"web_address": "occaecat anim dolore minim"
}
```
Schema
```
{
"properties": {
"admin_password": {
"type": "string"
},
"admin_user": {
"type": "string"
},
"cached_system_info": {
"type": "string"
},
"client_password": {
"type": "string"
},
"client_user": {
"type": "string"
},
"has_acl": {
"type": "boolean"
},
"hostname": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"ip": {
"type": "string"
},
"name": {
"type": "string"
},
"port_forwarding_type": {
"type": "string"
},
"server": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"srv_id": {
"type": "string"
}
},
"type": "object"
},
"status": {
"properties": {
"checked_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"
},
"desc": {
"type": "string"
}
},
"type": "object"
},
"type": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"supports": {
"properties": {
"admin_user": {
"type": "integer"
},
"bmc_reset": {
"type": "integer"
},
"boot_device": {
"type": "integer"
},
"client_user": {
"type": "integer"
},
"kvm": {
"type": "integer"
},
"power_control": {
"type": "integer"
},
"power_status": {
"type": "integer"
},
"snmp": {
"type": "integer"
},
"system_info": {
"type": "integer"
},
"web_access": {
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"web_address": {
"type": "string"
}
},
"type": "object"
}
```
Response209
HideShow
Command created
Open Server KVM ¶
Open Server KVM
GET/server/{server_id}/control/{server_control_id}/kvm
Example URI
GET /server/server_id/control/server_control_id/kvm
URI Parameters
HideShow
server_id
string (required)
server_control_id
string (required)
Response200
HideShow
KVM Launched
View Server Control Status ¶
View Server Control Status
GET/server/{server_id}/control/{server_control_id}/status
Example URI
GET /server/server_id/control/server_control_id/status
URI Parameters
HideShow
server_id
string (required)
server_control_id
string (required)
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
A Server Power Control Status
Headers
```
Content-Type: application/json
```
Body
```
{}
```
Schema
```
{
"properties": {
"admin_password": {
"type": "string"
},
"admin_user": {
"type": "string"
},
"cached_system_info": {
"type": "string"
},
"client_password": {
"type": "string"
},
"client_user": {
"type": "string"
},
"has_acl": {
"type": "boolean"
},
"hostname": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"ip": {
"type": "string"
},
"name": {
"type": "string"
},
"port_forwarding_type": {
"type": "string"
},
"server": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"srv_id": {
"type": "string"
}
},
"type": "object"
},
"status": {
"properties": {
"checked_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"
},
"desc": {
"type": "string"
}
},
"type": "object"
},
"type": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"supports": {
"properties": {
"admin_user": {
"type": "integer"
},
"bmc_reset": {
"type": "integer"
},
"boot_device": {
"type": "integer"
},
"client_user": {
"type": "integer"
},
"kvm": {
"type": "integer"
},
"power_control": {
"type": "integer"
},
"power_status": {
"type": "integer"
},
"snmp": {
"type": "integer"
},
"system_info": {
"type": "integer"
},
"web_access": {
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"web_address": {
"type": "string"
}
},
"type": "object"
}
```
Server OS Reloads ¶
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
```
Response200
HideShow
A list of OS Reloads
Headers
```
Content-Type: application/json
```
Body
```
[
{
"id": -23235729,
"percent": -91000269,
"profile": {
"id": 87629670,
"name": "qui v"
},
"server": {
"id": 39810724,
"name": "cul"
},
"started_at": {
"iso_8601": "irure molli",
"unix": -51140422
},
"step": 91853172,
"step_desc": "occaecat laboris",
"steps": -40860094,
"updated_at": {
"iso_8601": "commodo mollit culpa cillum dolore",
"unix": -82879989
}
}
]
```
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"
}
```
Create 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/jsonAccept: application/json
```
Body
```
{
"disk": {
"raid": 83542709,
"index": 62152395
},
"password": "et enim sunt ipsum voluptate",
"pxe_profile_id": -21122937,
"pxe_profile_billing": "eiusmod non",
"license_key": "adipisicing commodo",
"iso_install_id": -37307835,
"queue": true
}
```
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"
]
}
```
Response200
HideShow
An OS Reload
Headers
```
Content-Type: application/json
```
Body
```
{
"id": -53068973,
"percent": -88551333,
"profile": {
"id": -62944348,
"name": "mollit fugiat"
},
"server": {
"id": -7837381,
"name": "ex"
},
"started_at": {
"iso_8601": "nisi adipisicing enim elit",
"unix": 47994739
},
"step": -25170953,
"step_desc": "ut labor",
"steps": 30982138,
"updated_at": {
"iso_8601": "ipsum",
"unix": -32067384
}
}
```
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)
Response200
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
```
Response200
HideShow
An OS Reload
Headers
```
Content-Type: application/json
```
Body
```
{
"id": -77665875,
"percent": 47227894,
"profile": {
"id": 89452784,
"name": "qui eu dolor in non"
},
"server": {
"id": 10921824,
"name": "ipsum labore officia Ut"
},
"started_at": {
"iso_8601": "fugiat Duis qui cillum",
"unix": 70814682
},
"step": -69846996,
"step_desc": "irure",
"steps": 25536576,
"updated_at": {
"iso_8601": "anim",
"unix": 89988838
}
}
```
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"
}
```
View Preseed Template ¶
View Preseed Template
GET/server/{server_id}/install/{install_id}/preseed
OS Reload Preseed Template
Example URI
GET /server/server_id/install/install_id/preseed
URI Parameters
HideShow
server_id
string (required)
install_id
string (required)
Response200
HideShow
OS Reload Preseed Template
Server Ports ¶
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
```
Response200
HideShow
A list of Server Ports
Headers
```
Content-Type: application/json
```
Body
```
[
{
"id": 10752998,
"name": "enim magna ut incididunt esse",
"mac": "et nostrud exercitati",
"group": {
"id": 70206173,
"name": "aute ipsum deserunt cupidatat"
},
"is_billable": true,
"billing": {
"date": "dolore mollit"
},
"switch": {
"port": {
"name": "nostrud Ut adipisicing nisi qui",
"speed": {
"id": -5007364,
"name": "Lorem fugiat velit"
}
}
}
},
{
"id": -57148501,
"name": "sit elit",
"mac": "mollit eu",
"group": {
"id": 21055126,
"name": "esse"
},
"is_billable": true,
"billing": {
"date": "Excepteur adipisicing voluptate"
},
"switch": {
"port": {
"name": "in in",
"speed": {
"id": 92048011,
"name": "nostrud non"
}
}
}
}
]
```
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/jsonAccept: application/json
```
Body
```
{
"id": -52803554,
"name": "exercitation",
"mac": "ex ullamco",
"group": {
"id": 33941198,
"name": "dolore sed amet dolor aliqua"
},
"is_billable": false,
"billing": {
"date": "dolor sed"
},
"switch": {
"port": {
"name": "sunt culpa",
"speed": {
"id": -47163341,
"name": "la"
}
}
}
}
```
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"
}
```
Response200
HideShow
A Server Port
Headers
```
Content-Type: application/json
```
Body
```
{
"id": 67862612,
"name": "aliquip",
"mac": "et volupt",
"group": {
"id": 60729110,
"name": "occaecat sint quis consectetur"
},
"is_billable": true,
"billing": {
"date": "ea ullamco"
},
"switch": {
"port": {
"name": "voluptate aliquip ut",
"speed": {
"id": -26089853,
"name": "fugiat eiusmod officia mollit"
}
}
}
}
```
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"
}
```
View Port Bandwidth ¶
View Port Bandwidth
GET/server/{server_id}/port/{port_id}/bandwidth
A Server Port’s Bandwidth
Example URI
GET /server/server_id/port/port_id/bandwidth
URI Parameters
HideShow
server_id
string (required)
port_id
string (required)
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
A Server Port’s Bandwidth
Headers
```
Content-Type: application/json
```
Body
```
{
"from_time": 3738392,
"data": [
[
38176230,
55560541,
15933142,
11119227
],
[
-50396431
],
[
-66636501,
98108699,
10378879,
93808275,
-46377280
],
[
-98832040,
-67471005
],
[
46048563,
-42487470,
40361169,
14924534
]
],
"max_time": 67394827
}
```
Schema
```
{
"properties": {
"data": {
"items": {
"items": {
"type": "integer"
},
"type": "array"
},
"type": "array"
},
"from_time": {
"type": "integer"
},
"max_time": {
"type": "integer"
},
"min_time": {
"type": "integer"
},
"stats": {
"items": {
"properties": {
"avg": {
"type": "integer"
},
"max": {
"type": "integer"
},
"min": {
"type": "integer"
},
"nf": {
"type": "integer"
},
"sum": {
"type": "integer"
}
},
"type": "object"
},
"type": "array"
},
"status": {
"type": "integer"
},
"to_time": {
"type": "integer"
}
},
"type": "object"
}
```
List Server Port Bandwidth Usage ¶
List Server Port Bandwidth Usage
GET/server/{server_id}/port/{port_id}/bandwidth/usage
A list of Server Port Bandwidth Usages.
Example URI
GET /server/server_id/port/port_id/bandwidth/usage
URI Parameters
HideShow
server_id
string (required)
port_id
string (required)
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
A list of Server Port Bandwidth Usages
Headers
```
Content-Type: application/json
```
Body
```
[
{
"id": 5561461,
"used": -5137274,
"max": -76900742
},
{
"id": 50204502,
"used": -36589188,
"max": -27207427
}
]
```
Schema
```
{
"items": {
"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"
},
"type": "array"
}
```
Create Server Port Bandwidth Usage
POST/server/{server_id}/port/{port_id}/bandwidth/usage
Example URI
POST /server/server_id/port/port_id/bandwidth/usage
URI Parameters
HideShow
server_id
string (required)
port_id
string (required)
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"id": -69792370,
"used": 84129344,
"max": -59037101
}
```
Schema
```
{
"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"
}
```
Response200
HideShow
A Server Port
Headers
```
Content-Type: application/json
```
Body
```
{
"id": -21913219,
"used": -91652921,
"max": -88342248
}
```
Schema
```
{
"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"
}
```
Delete Server Port Bandwidth Usage ¶
Delete Server Port Bandwidth Usage
DELETE/server/{server_id}/port/{port_id}/bandwidth/usage/{usage_id}
Delete Server Port Bandwidth Usage
Example URI
DELETE /server/server_id/port/port_id/bandwidth/usage/usage_id
URI Parameters
HideShow
server_id
string (required)
port_id
string (required)
usage_id
string (required)
Response200
HideShow
Server Port Bandwidth Usage Deleted Successfully
Response404
HideShow
Item not Found
Get Server Port Bandwidth Usage
GET/server/{server_id}/port/{port_id}/bandwidth/usage/{usage_id}
A Server Port Bandwidth Usage
Example URI
GET /server/server_id/port/port_id/bandwidth/usage/usage_id
URI Parameters
HideShow
server_id
string (required)
port_id
string (required)
usage_id
string (required)
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
A Server Port Bandwidth Usage
Headers
```
Content-Type: application/json
```
Body
```
{
"id": -72092780,
"used": -81000030,
"max": 24172132
}
```
Schema
```
{
"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"
}
```
Edit Server Port Bandwidth Usage
PATCH/server/{server_id}/port/{port_id}/bandwidth/usage/{usage_id}
Edit Server Port Bandwidth Usage
Example URI
PATCH /server/server_id/port/port_id/bandwidth/usage/usage_id
URI Parameters
HideShow
server_id
string (required)
port_id
string (required)
usage_id
string (required)
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"id": 48980779,
"used": -66177320,
"max": 74854224
}
```
Schema
```
{
"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"
}
```
Response200
HideShow
A Server Port Bandwidth Usage
Headers
```
Content-Type: application/json
```
Body
```
{
"id": 3920222,
"used": 16361342,
"max": -98090044
}
```
Schema
```
{
"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"
}
```
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"id": 70228538,
"used": 48882031,
"max": 81589477
}
```
Schema
```
{
"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"
}
```
Response422
HideShow
Unprocessable Entity
Headers
```
Content-Type: application/json
```
Delete Server Port Command ¶
Delete Server Port Command
DELETE/server/{server_id}/port/{port_id}/command/{command_id}
Example URI
DELETE /server/server_id/port/port_id/command/command_id
URI Parameters
HideShow
server_id
string (required)
port_id
string (required)
command_id
string (required)
Response200
HideShow
Server Port Command deleted.
Edit Server Port Command
PATCH/server/{server_id}/port/{port_id}/command/{command_id}
Example URI
PATCH /server/server_id/port/port_id/command/command_id
URI Parameters
HideShow
server_id
string (required)
port_id
string (required)
command_id
string (required)
Request
HideShow
Headers
```
Content-Type: application/json
```
Body
```
{}
```
Schema
```
{
"properties": {
"command": {
"description": "The command to run. Options include: power-off, power-on, sync-speed, sync-vlan",
"type": "string"
}
},
"type": "object"
}
```
Response200
HideShow
A server Port Command
Request
HideShow
Headers
```
Content-Type: application/json
```
Body
```
{
"command": "in"
}
```
Schema
```
{
"properties": {
"command": {
"description": "The command to run. Options include: power-off, power-on, sync-speed, sync-vlan",
"type": "string"
}
},
"type": "object"
}
```
Response422
HideShow
Bad Request
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)
Response200
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
```
Response200
HideShow
A Server Port
Headers
```
Content-Type: application/json
```
Body
```
{
"id": 14750174,
"name": "ipsum nulla",
"mac": "dolor consectetur deserunt velit",
"group": {
"id": 35288479,
"name": "deserunt in irure"
},
"is_billable": true,
"billing": {
"date": "dolore"
},
"switch": {
"port": {
"name": "consectetur amet Ut reprehenderit ad",
"speed": {
"id": -50311883,
"name": "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"
}
```
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": "sit velit id Ut officia"
}
```
Schema
```
{
"properties": {
"command": {
"description": "The command to run. Options include: power-off, power-on, sync-speed, sync-vlan",
"type": "string"
}
},
"type": "object"
}
```
Response209
HideShow
Command created
Switches ¶
Switches
List Switches ¶
List Switches
GET/switch
List of Network Switches
Example URI
GET /switch
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
List of Network Switches
Headers
```
Content-Type: application/json
```
Body
```
[
{}
]
```
Schema
```
{
"items": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"ip": {
"type": "string"
},
"port": {
"type": "integer"
},
"portsInUseCount": {
"type": "integer"
},
"scan": {
"properties": {
"cancelled": {
"type": "boolean"
},
"created_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"
},
"done": {
"type": "boolean"
},
"failed": {
"type": "boolean"
},
"finished": {
"type": "boolean"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"status": {
"type": "string"
}
},
"type": "object"
},
"type": {
"type": "string"
},
"type_desc": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
```
Create Switch
POST/switch
Add new Network Switch
Example URI
POST /switch
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"ssh_user": "dolor in anim dolor",
"ssh_pass": "tempor ex ipsum sint ea",
"ssh_en_pass": "voluptate dolor in irure nostrud",
"snmp_pass": "ipsum et enim",
"name": "ut qu",
"ip": "culpa dolore",
"port": "nisi et do minim qui",
"snmp_version": "velit"
}
```
Schema
```
{
"required": [
"ssh_user",
"ssh_pass",
"ssh_en_pass",
"snmp_pass",
"name",
"ip",
"port"
],
"properties": {
"allow_vlan_tagging": {
"type": "boolean"
},
"groups": {
"items": {
"type": "integer"
},
"type": "array"
},
"ip": {
"type": "string"
},
"name": {
"type": "string"
},
"port": {
"type": "string"
},
"snmp_pass": {
"type": "string"
},
"snmp_version": {
"type": "string"
},
"ssh_en_pass": {
"type": "string"
},
"ssh_pass": {
"type": "string"
},
"ssh_user": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
}
```
Response200
HideShow
A Network Switch
Headers
```
Content-Type: application/json
```
Body
```
{
"ssh_en_pass": "dolor elit",
"type": "et consequat ",
"allow_vlan_tagging": false
}
```
Schema
```
{
"properties": {
"allow_vlan_tagging": {
"type": "boolean"
},
"groups": {
"items": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"ip": {
"type": "string"
},
"name": {
"type": "string"
},
"port": {
"type": "integer"
},
"portsInUseCount": {
"type": "integer"
},
"scan": {
"properties": {
"canceled": {
"type": "boolean"
},
"created_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"
},
"done": {
"type": "boolean"
},
"failed": {
"type": "boolean"
},
"finished": {
"type": "boolean"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"status": {
"type": "string"
}
},
"type": "object"
},
"snmp_pass": {
"type": "string"
},
"snmp_use_32_bit": {
"type": "boolean"
},
"snmp_version": {
"type": "integer"
},
"ssh_en_pass": {
"type": "string"
},
"ssh_pass": {
"type": "string"
},
"ssh_user": {
"type": "string"
},
"type": {
"type": "string"
},
"type_desc": {
"type": "string"
}
},
"type": "object"
}
```
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"ssh_user": "consequat esse nisi mollit",
"ssh_pass": "in consequat velit",
"ssh_en_pass": "adipisicing magna in",
"snmp_pass": "tempor labore in",
"name": "veniam fugiat",
"ip": "cillum culpa et proident",
"port": "s"
}
```
Schema
```
{
"required": [
"ssh_user",
"ssh_pass",
"ssh_en_pass",
"snmp_pass",
"name",
"ip",
"port"
],
"properties": {
"allow_vlan_tagging": {
"type": "boolean"
},
"groups": {
"items": {
"type": "integer"
},
"type": "array"
},
"ip": {
"type": "string"
},
"name": {
"type": "string"
},
"port": {
"type": "string"
},
"snmp_pass": {
"type": "string"
},
"snmp_version": {
"type": "string"
},
"ssh_en_pass": {
"type": "string"
},
"ssh_pass": {
"type": "string"
},
"ssh_user": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
}
```
Response422
HideShow
Unprocessable Entity
Headers
```
Content-Type: application/json
```
List Switch Types ¶
List Switch Types
GET/switch/type
A Network Switch Type
Example URI
GET /switch/type
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
A Network Switch Type
Headers
```
Content-Type: application/json
```
Body
```
[
{},
{
"slug": "ea incididunt",
"name": "laborum consectetur"
},
{}
]
```
Schema
```
{
"items": {
"properties": {
"name": {
"type": "string"
},
"slug": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
```
Delete Switch ¶
Delete Switch
DELETE/switch/{switch_id}
Delete a Network Switch
Example URI
DELETE /switch/switch_id
URI Parameters
HideShow
switch_id
string (required)
Response200
HideShow
Network Switch deleted successfully
Response404
HideShow
Item not Found
View Switch
GET/switch/{switch_id}
A Network Switch
Example URI
GET /switch/switch_id
URI Parameters
HideShow
switch_id
string (required)
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
A Network Switch
Headers
```
Content-Type: application/json
```
Body
```
{}
```
Schema
```
{
"properties": {
"allow_vlan_tagging": {
"type": "boolean"
},
"groups": {
"items": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"ip": {
"type": "string"
},
"name": {
"type": "string"
},
"port": {
"type": "integer"
},
"portsInUseCount": {
"type": "integer"
},
"scan": {
"properties": {
"canceled": {
"type": "boolean"
},
"created_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"
},
"done": {
"type": "boolean"
},
"failed": {
"type": "boolean"
},
"finished": {
"type": "boolean"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"status": {
"type": "string"
}
},
"type": "object"
},
"snmp_pass": {
"type": "string"
},
"snmp_use_32_bit": {
"type": "boolean"
},
"snmp_version": {
"type": "integer"
},
"ssh_en_pass": {
"type": "string"
},
"ssh_pass": {
"type": "string"
},
"ssh_user": {
"type": "string"
},
"type": {
"type": "string"
},
"type_desc": {
"type": "string"
}
},
"type": "object"
}
```
Edit Switch
PATCH/switch/{switch_id}
Edit Network Switch
Example URI
PATCH /switch/switch_id
URI Parameters
HideShow
switch_id
string (required)
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{}
```
Schema
```
{
"properties": {
"allow_vlan_tagging": {
"type": "boolean"
},
"groups": {
"items": {
"type": "integer"
},
"type": "array"
},
"ip": {
"type": "string"
},
"name": {
"type": "string"
},
"port": {
"type": "string"
},
"snmp_pass": {
"type": "string"
},
"snmp_version": {
"type": "string"
},
"ssh_en_pass": {
"type": "string"
},
"ssh_pass": {
"type": "string"
},
"ssh_user": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
}
```
Response200
HideShow
A Network Switch
Headers
```
Content-Type: application/json
```
Body
```
{
"name": "magna"
}
```
Schema
```
{
"properties": {
"allow_vlan_tagging": {
"type": "boolean"
},
"groups": {
"items": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"ip": {
"type": "string"
},
"name": {
"type": "string"
},
"port": {
"type": "integer"
},
"portsInUseCount": {
"type": "integer"
},
"scan": {
"properties": {
"canceled": {
"type": "boolean"
},
"created_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"
},
"done": {
"type": "boolean"
},
"failed": {
"type": "boolean"
},
"finished": {
"type": "boolean"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"status": {
"type": "string"
}
},
"type": "object"
},
"snmp_pass": {
"type": "string"
},
"snmp_use_32_bit": {
"type": "boolean"
},
"snmp_version": {
"type": "integer"
},
"ssh_en_pass": {
"type": "string"
},
"ssh_pass": {
"type": "string"
},
"ssh_user": {
"type": "string"
},
"type": {
"type": "string"
},
"type_desc": {
"type": "string"
}
},
"type": "object"
}
```
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"groups": [
-15551276,
-88657016
],
"ssh_user": "enim ex magna commodo",
"ssh_pass": "non sunt elit ex magna"
}
```
Schema
```
{
"properties": {
"allow_vlan_tagging": {
"type": "boolean"
},
"groups": {
"items": {
"type": "integer"
},
"type": "array"
},
"ip": {
"type": "string"
},
"name": {
"type": "string"
},
"port": {
"type": "string"
},
"snmp_pass": {
"type": "string"
},
"snmp_version": {
"type": "string"
},
"ssh_en_pass": {
"type": "string"
},
"ssh_pass": {
"type": "string"
},
"ssh_user": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
}
```
Response422
HideShow
Unprocessable Entity
Headers
```
Content-Type: application/json
```
Switch Commands ¶
Switch Commands
List Switch Commands ¶
List Switch Commands
GET/switch/{switch_id}/command
List of Network Switch Commands
Example URI
GET /switch/switch_id/command
URI Parameters
HideShow
switch_id
string (required)
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
List of Network Switch Commands
Headers
```
Content-Type: application/json
```
Body
```
[
{
"status": "commodo sint"
},
{},
{
"id": -72509197
},
{}
]
```
Schema
```
{
"items": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"status": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
```
Create Switch Command
POST/switch/{switch_id}/command
Add new Network Switch Command
Example URI
POST /switch/switch_id/command
URI Parameters
HideShow
switch_id
string (required)
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
A Network Switch Command
Headers
```
Content-Type: application/json
```
Body
```
{
"command": "ea et sunt Excepteur nostrud"
}
```
Schema
```
{
"properties": {
"command": {
"type": "string"
},
"errors": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"output": {
"type": "string"
},
"status": {
"type": "string"
}
},
"type": "object"
}
```
Request
HideShow
Headers
```
Accept: application/json
```
Response422
HideShow
Unprocessable Entity
Headers
```
Content-Type: application/json
```
View Switch Command ¶
View Switch Command
GET/switch/{switch_id}/command/{command_id}
A Network Switch Command
Example URI
GET /switch/switch_id/command/command_id
URI Parameters
HideShow
switch_id
string (required)
command_id
string (required)
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
A Network Switch Command
Headers
```
Content-Type: application/json
```
Body
```
{
"id": 97354985
}
```
Schema
```
{
"properties": {
"command": {
"type": "string"
},
"errors": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"output": {
"type": "string"
},
"status": {
"type": "string"
}
},
"type": "object"
}
```
Edit Switch Command
PATCH/switch/{switch_id}/command/{command_id}
Edit Network Switch Command
Example URI
PATCH /switch/switch_id/command/command_id
URI Parameters
HideShow
switch_id
string (required)
command_id
string (required)
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{}
```
Schema
```
{
"properties": {
"command": {
"type": "string"
},
"errors": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"output": {
"type": "string"
},
"status": {
"type": "string"
}
},
"type": "object"
}
```
Response200
HideShow
A Network Switch Command
Headers
```
Content-Type: application/json
```
Body
```
{}
```
Schema
```
{
"properties": {
"command": {
"type": "string"
},
"errors": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"output": {
"type": "string"
},
"status": {
"type": "string"
}
},
"type": "object"
}
```
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"id": 62607345,
"command": "elit adipisicing",
"output": "pariatur magna aliquip",
"status": "laborum Excepteur magna nostrud ea",
"errors": "nisi nostrud"
}
```
Schema
```
{
"properties": {
"command": {
"type": "string"
},
"errors": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"output": {
"type": "string"
},
"status": {
"type": "string"
}
},
"type": "object"
}
```
Response422
HideShow
Unprocessable Entity
Headers
```
Content-Type: application/json
```
Switch Ports ¶
Switch Ports
List Switch Ports ¶
List Switch Ports
GET/switch/{switch_id}/port
List of Network Switch Ports
Example URI
GET /switch/switch_id/port
URI Parameters
HideShow
switch_id
string (required)
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
List of Network Switch Ports
Headers
```
Content-Type: application/json
```
Body
```
[
{
"is_switch_primary": true
},
{
"usage": false,
"is_switch_primary": true
}
]
```
Schema
```
{
"items": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"is_switch_primary": {
"type": "boolean"
},
"name": {
"type": "string"
},
"owner": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"server": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"speed": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"usage": {
"type": "boolean"
}
},
"type": "object"
},
"type": "array"
}
```
Create Switch Port
POST/switch/{switch_id}/port
Add new Network Switch Port
Example URI
POST /switch/switch_id/port
URI Parameters
HideShow
switch_id
string (required)
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{}
```
Schema
```
{
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"is_switch_primary": {
"type": "boolean"
},
"name": {
"type": "string"
},
"owner": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"server": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"speed": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"usage": {
"type": "boolean"
}
},
"type": "object"
}
```
Response200
HideShow
A Network Switch Port
Headers
```
Content-Type: application/json
```
Body
```
{
"id": -68439604,
"usage": false,
"owner": {
"id": -59686675
}
}
```
Schema
```
{
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"is_switch_primary": {
"type": "boolean"
},
"name": {
"type": "string"
},
"owner": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"server": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"speed": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"usage": {
"type": "boolean"
}
},
"type": "object"
}
```
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"is_switch_primary": false
}
```
Schema
```
{
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"is_switch_primary": {
"type": "boolean"
},
"name": {
"type": "string"
},
"owner": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"server": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"speed": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"usage": {
"type": "boolean"
}
},
"type": "object"
}
```
Response422
HideShow
Unprocessable Entity
Headers
```
Content-Type: application/json
```
View Switch Port ¶
View Switch Port
GET/switch/{switch_id}/port/{port_id}
A Network Switch Port
Example URI
GET /switch/switch_id/port/port_id
URI Parameters
HideShow
switch_id
string (required)
port_id
string (required)
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
A Network Switch Port
Headers
```
Content-Type: application/json
```
Body
```
{}
```
Schema
```
{
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"is_switch_primary": {
"type": "boolean"
},
"name": {
"type": "string"
},
"owner": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"server": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"speed": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"usage": {
"type": "boolean"
}
},
"type": "object"
}
```
Edit Switch Port
PATCH/switch/{switch_id}/port/{port_id}
Edit Network Switch Port
Example URI
PATCH /switch/switch_id/port/port_id
URI Parameters
HideShow
switch_id
string (required)
port_id
string (required)
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"is_switch_primary": false
}
```
Schema
```
{
"properties": {
"is_switch_primary": {
"type": "boolean"
}
},
"type": "object"
}
```
Response200
HideShow
A Network Switch Port
Headers
```
Content-Type: application/json
```
Body
```
{
"name": "labore dolor voluptate",
"is_switch_primary": false
}
```
Schema
```
{
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"is_switch_primary": {
"type": "boolean"
},
"name": {
"type": "string"
},
"owner": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"server": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"speed": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"usage": {
"type": "boolean"
}
},
"type": "object"
}
```
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"is_switch_primary": true
}
```
Schema
```
{
"properties": {
"is_switch_primary": {
"type": "boolean"
}
},
"type": "object"
}
```
Response422
HideShow
Unprocessable Entity
Headers
```
Content-Type: application/json
```
View Switch Port Bandwidth ¶
View Switch Port Bandwidth
GET/switch/{switch_id}/port/{port_id}/bandwidth
A Network Switch Port’s Bandwidth
Example URI
GET /switch/switch_id/port/port_id/bandwidth
URI Parameters
HideShow
switch_id
string (required)
port_id
string (required)
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
A Network Switch Port’s Bandwidth
Headers
```
Content-Type: application/json
```
Body
```
{}
```
Schema
```
{
"properties": {
"data": {
"items": {
"items": {
"type": "integer"
},
"type": "array"
},
"type": "array"
},
"from_time": {
"type": "integer"
},
"max_time": {
"type": "integer"
},
"min_time": {
"type": "integer"
},
"stats": {
"items": {
"properties": {
"avg": {
"type": "integer"
},
"max": {
"type": "integer"
},
"min": {
"type": "integer"
},
"nf": {
"type": "integer"
},
"sum": {
"type": "integer"
}
},
"type": "object"
},
"type": "array"
},
"status": {
"type": "integer"
},
"to_time": {
"type": "integer"
}
},
"type": "object"
}
```
List Switch Port Bandwidth Usage ¶
List Switch Port Bandwidth Usage
GET/switch/{switch_id}/port/{port_id}/bandwidth/usage
A list of Switch Port Bandwidth Usages.
Example URI
GET /switch/switch_id/port/port_id/bandwidth/usage
URI Parameters
HideShow
switch_id
string (required)
port_id
string (required)
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
A list of Switch Port Bandwidth Usages
Headers
```
Content-Type: application/json
```
Body
```
[
{
"id": -91640538,
"used": 48139871,
"max": -91009520
},
{
"id": 80674673,
"used": 65056837,
"max": 54635340
},
{
"id": -41697530,
"used": 43762534,
"max": -46458029
}
]
```
Schema
```
{
"items": {
"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"
},
"type": "array"
}
```
Create Switch Port Bandwidth Usage
POST/switch/{switch_id}/port/{port_id}/bandwidth/usage
Example URI
POST /switch/switch_id/port/port_id/bandwidth/usage
URI Parameters
HideShow
switch_id
string (required)
port_id
string (required)
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"id": 43969602,
"used": -44265352,
"max": 74695084
}
```
Schema
```
{
"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"
}
```
Response200
HideShow
A Switch Port
Headers
```
Content-Type: application/json
```
Body
```
{
"id": 21966389,
"used": 6982439,
"max": 63249837
}
```
Schema
```
{
"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"
}
```
Delete Switch Port Bandwidth Usage ¶
Delete Switch Port Bandwidth Usage
DELETE/switch/{switch_id}/port/{port_id}/bandwidth/usage/{usage_id}
Delete Switch Port Bandwidth Usage
Example URI
DELETE /switch/switch_id/port/port_id/bandwidth/usage/usage_id
URI Parameters
HideShow
switch_id
string (required)
port_id
string (required)
usage_id
string (required)
Response200
HideShow
Switch Port Bandwidth Usage Deleted Successfully
Response404
HideShow
Item not Found
Get Switch Port Bandwidth Usage
GET/switch/{switch_id}/port/{port_id}/bandwidth/usage/{usage_id}
A Switch Port Bandwidth Usage
Example URI
GET /switch/switch_id/port/port_id/bandwidth/usage/usage_id
URI Parameters
HideShow
switch_id
string (required)
port_id
string (required)
usage_id
string (required)
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
A Switch Port Bandwidth Usage
Headers
```
Content-Type: application/json
```
Body
```
{
"id": 74537988,
"used": -70462832,
"max": -77274633
}
```
Schema
```
{
"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"
}
```
Edit Switch Port Bandwidth Usage
PATCH/switch/{switch_id}/port/{port_id}/bandwidth/usage/{usage_id}
Edit Switch Port Bandwidth Usage
Example URI
PATCH /switch/switch_id/port/port_id/bandwidth/usage/usage_id
URI Parameters
HideShow
switch_id
string (required)
port_id
string (required)
usage_id
string (required)
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"id": -27357980,
"used": -63166773,
"max": -39898165
}
```
Schema
```
{
"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"
}
```
Response200
HideShow
A Switch Port Bandwidth Usage
Headers
```
Content-Type: application/json
```
Body
```
{
"id": -40903607,
"used": -52614705,
"max": 17046809
}
```
Schema
```
{
"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"
}
```
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"id": 63479760,
"used": 22952800,
"max": 53932360
}
```
Schema
```
{
"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"
}
```
Response422
HideShow
Unprocessable Entity
Headers
```
Content-Type: application/json
```
Switch Scans ¶
Switch Scans
List Switch Scans ¶
List Switch Scans
GET/switch/{switch_id}/scan
List of Scans for a Network Switch
Example URI
GET /switch/switch_id/scan
URI Parameters
HideShow
switch_id
string (required)
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
List of Scans for a Network Switch
Headers
```
Content-Type: application/json
```
Body
```
[
{
"id": -52027370
},
{
"status": "ullamco elit ut",
"canceled": true,
"done": false
},
{},
{
"id": -68011658
}
]
```
Schema
```
{
"items": {
"properties": {
"canceled": {
"type": "boolean"
},
"created_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"
},
"done": {
"type": "boolean"
},
"failed": {
"type": "boolean"
},
"finished": {
"type": "boolean"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"status": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
```
Create Switch Scan
POST/switch/{switch_id}/scan
Add new Scan to a Network Switch
Example URI
POST /switch/switch_id/scan
URI Parameters
HideShow
switch_id
string (required)
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{}
```
Schema
```
{
"properties": {
"canceled": {
"type": "boolean"
},
"created_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"
},
"done": {
"type": "boolean"
},
"failed": {
"type": "boolean"
},
"finished": {
"type": "boolean"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"status": {
"type": "string"
}
},
"type": "object"
}
```
Response200
HideShow
A Scan for a Network Switch
Headers
```
Content-Type: application/json
```
Body
```
{
"snmp_version": 46270659
}
```
Schema
```
{
"properties": {
"allow_vlan_tagging": {
"type": "boolean"
},
"groups": {
"items": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"ip": {
"type": "string"
},
"name": {
"type": "string"
},
"port": {
"type": "integer"
},
"portsInUseCount": {
"type": "integer"
},
"scan": {
"properties": {
"canceled": {
"type": "boolean"
},
"created_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"
},
"done": {
"type": "boolean"
},
"failed": {
"type": "boolean"
},
"finished": {
"type": "boolean"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"status": {
"type": "string"
}
},
"type": "object"
},
"snmp_pass": {
"type": "string"
},
"snmp_use_32_bit": {
"type": "boolean"
},
"snmp_version": {
"type": "integer"
},
"ssh_en_pass": {
"type": "string"
},
"ssh_pass": {
"type": "string"
},
"ssh_user": {
"type": "string"
},
"type": {
"type": "string"
},
"type_desc": {
"type": "string"
}
},
"type": "object"
}
```
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{}
```
Schema
```
{
"properties": {
"canceled": {
"type": "boolean"
},
"created_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"
},
"done": {
"type": "boolean"
},
"failed": {
"type": "boolean"
},
"finished": {
"type": "boolean"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"status": {
"type": "string"
}
},
"type": "object"
}
```
Response422
HideShow
Unprocessable Entity
Headers
```
Content-Type: application/json
```
View Switch Scan ¶
View Switch Scan
GET/switch/{switch_id}/scan/{scan_id}
A Scan for a Network Switch
Example URI
GET /switch/switch_id/scan/scan_id
URI Parameters
HideShow
scan_id
string (required)
switch_id
string (required)
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
A Scan for a Network Switch
Headers
```
Content-Type: application/json
```
Body
```
{
"status": "in aliquip incididunt",
"done": true,
"failed": false
}
```
Schema
```
{
"properties": {
"canceled": {
"type": "boolean"
},
"created_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"
},
"done": {
"type": "boolean"
},
"failed": {
"type": "boolean"
},
"finished": {
"type": "boolean"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"status": {
"type": "string"
}
},
"type": "object"
}
```
Edit Switch Scan
PATCH/switch/{switch_id}/scan/{scan_id}
Edit Network Switch Scan
Example URI
PATCH /switch/switch_id/scan/scan_id
URI Parameters
HideShow
switch_id
string (required)
scan_id
string (required)
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{}
```
Schema
```
{
"properties": {
"canceled": {
"type": "boolean"
},
"created_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"
},
"done": {
"type": "boolean"
},
"failed": {
"type": "boolean"
},
"finished": {
"type": "boolean"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"status": {
"type": "string"
}
},
"type": "object"
}
```
Response200
HideShow
A Scan for a Network Switch
Headers
```
Content-Type: application/json
```
Body
```
{
"failed": false,
"status": "amet exercitation incididunt cupidatat in"
}
```
Schema
```
{
"properties": {
"canceled": {
"type": "boolean"
},
"created_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"
},
"done": {
"type": "boolean"
},
"failed": {
"type": "boolean"
},
"finished": {
"type": "boolean"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"status": {
"type": "string"
}
},
"type": "object"
}
```
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{}
```
Schema
```
{
"properties": {
"canceled": {
"type": "boolean"
},
"created_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"
},
"done": {
"type": "boolean"
},
"failed": {
"type": "boolean"
},
"finished": {
"type": "boolean"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"status": {
"type": "string"
}
},
"type": "object"
}
```
Response422
HideShow
Unprocessable Entity
Headers
```
Content-Type: application/json
```
SSH Keys ¶
SSH Keys
List SSH Keys ¶
List SSH Keys
GET/system/ssh/key
List of SSH Keys
Example URI
GET /system/ssh/key
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
List of SSH Keys
Headers
```
Content-Type: application/json
```
Body
```
[
{
"id": -23439712,
"public_key": "est elit"
}
]
```
Schema
```
{
"items": {
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"public_key": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
```
Create SSH Key
POST/system/ssh/key
Add new SSH Key
Example URI
POST /system/ssh/key
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"id": -29646691,
"public_key": "aliquip"
}
```
Schema
```
{
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"public_key": {
"type": "string"
}
},
"type": "object"
}
```
Response200
HideShow
An SSH Key
Headers
```
Content-Type: application/json
```
Body
```
{}
```
Schema
```
{
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"public_key": {
"type": "string"
}
},
"type": "object"
}
```
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{
"public_key": "pariatur minim dolore Dui"
}
```
Schema
```
{
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"public_key": {
"type": "string"
}
},
"type": "object"
}
```
Response422
HideShow
Unprocessable Entity
Headers
```
Content-Type: application/json
```
Delete SSH Key ¶
Delete SSH Key
DELETE/system/ssh/key/{ssh_key_id}
Delete an SSH Key
Example URI
DELETE /system/ssh/key/ssh_key_id
URI Parameters
HideShow
ssh_key_id
string (required)
Response200
HideShow
Deleted SSH Key
Response404
HideShow
Item not Found
View SSH Key
GET/system/ssh/key/{ssh_key_id}
Get an SSH Key
Example URI
GET /system/ssh/key/ssh_key_id
URI Parameters
HideShow
ssh_key_id
string (required)
Request
HideShow
Headers
```
Accept: application/json
```
Response200
HideShow
An SSH Key
Headers
```
Content-Type: application/json
```
Body
```
{
"public_key": "in sint laborum cupidat"
}
```
Schema
```
{
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"public_key": {
"type": "string"
}
},
"type": "object"
}
```
Edit SSH Key
PATCH/system/ssh/key/{ssh_key_id}
Edit SSH Key
Example URI
PATCH /system/ssh/key/ssh_key_id
URI Parameters
HideShow
ssh_key_id
string (required)
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{}
```
Schema
```
{
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"public_key": {
"type": "string"
}
},
"type": "object"
}
```
Response200
HideShow
The new SSH Key
Headers
```
Content-Type: application/json
```
Body
```
{}
```
Schema
```
{
"properties": {
"canceled": {
"type": "boolean"
},
"created_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"
},
"done": {
"type": "boolean"
},
"failed": {
"type": "boolean"
},
"finished": {
"type": "boolean"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"status": {
"type": "string"
}
},
"type": "object"
}
```
Request
HideShow
Headers
```
Content-Type: application/jsonAccept: application/json
```
Body
```
{}
```
Schema
```
{
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"public_key": {
"type": "string"
}
},
"type": "object"
}
```
Response422
HideShow
Unprocessable Entity
Headers
```
Content-Type: application/json
```
About
Support
Featured Add-Ons
Legal
Social
Copyright © 2018 SynergyCP, LLC. All Rights Reserved.