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 AdminsGET/admin
List all Admins
Example URI
GET /admin
Request
Headers
Accept: application/jsonResponse
200A list of Admins
Headers
Content-Type: application/jsonBody
[
{
"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 AdminPOST/admin
Create a new Admin
Example URI
POST /admin
Request
Headers
Content-Type: application/json
Accept: application/jsonBody
{
"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"
}Response
200An Admin
Headers
Content-Type: application/jsonBody
{
"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
Headers
Content-Type: application/json
Accept: application/jsonBody
{
"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"
}Response
422Unprocessable Entity
Headers
Content-Type: application/jsonDelete Admin ¶
Delete AdminDELETE/admin/{admin_id}
Delete an admin
Example URI
DELETE /admin/admin_id
URI Parameters
- admin_id
string(required)
Response
200Admin deleted successfully
Response
404Item not Found
View AdminGET/admin/{admin_id}
View a specific admin
Example URI
GET /admin/admin_id
URI Parameters
- admin_id
string(required)
Request
Headers
Accept: application/jsonResponse
200An Admin
Headers
Content-Type: application/jsonBody
{
"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 AdminPATCH/admin/{admin_id}
Edit a specific admin with new information
Example URI
PATCH /admin/admin_id
URI Parameters
- admin_id
string(required)
Request
Headers
Content-Type: application/json
Accept: application/jsonBody
{
"receive_copies": true
}Schema
{
"properties": {
"email": {
"example": "[email protected]",
"type": "string"
},
"password": {
"type": "string"
},
"receive_copies": {
"type": "boolean"
},
"username": {
"type": "string"
}
},
"type": "object"
}Response
200An Admin
Headers
Content-Type: application/jsonBody
{
"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
Headers
Content-Type: application/json
Accept: application/jsonBody
{}Schema
{
"properties": {
"email": {
"example": "[email protected]",
"type": "string"
},
"password": {
"type": "string"
},
"receive_copies": {
"type": "boolean"
},
"username": {
"type": "string"
}
},
"type": "object"
}Response
422Unprocessable Entity
Headers
Content-Type: application/jsonView Admin Permissions ¶
View Admin PermissionsGET/admin/{admin_id}/permission
View a specific admin’s permissions
Example URI
GET /admin/admin_id/permission
URI Parameters
- admin_id
string(required)
Request
Headers
Accept: application/jsonResponse
200An Admin’s Permissions
Headers
Content-Type: application/jsonBody
{
"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 PermissionsPATCH/admin/{admin_id}/permission
Edit a specific admin’s Permissions
Example URI
PATCH /admin/admin_id/permission
URI Parameters
- admin_id
string(required)
Request
Headers
Content-Type: application/json
Accept: application/jsonBody
{}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"
}Response
200An Admin’s Permissions
Headers
Content-Type: application/jsonBody
{}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
Headers
Content-Type: application/json
Accept: application/jsonBody
{}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"
}Response
422Unprocessable Entity
Headers
Content-Type: application/jsonAPI Keys ¶
API Keys
List API Keys ¶
List API KeysGET/auth/key
List of API keys currently active in Synergy
Example URI
GET /auth/key
Request
Headers
Accept: application/jsonResponse
200A list of API Keys
Headers
Content-Type: application/jsonBody
[
{
"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 KeyPOST/auth/key
Create a new API Key
Example URI
POST /auth/key
Request
Headers
Content-Type: application/json
Accept: application/jsonBody
{
"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"
}Response
200An API Key
Headers
Content-Type: application/jsonBody
{
"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
Headers
Content-Type: application/json
Accept: application/jsonBody
{
"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"
}Response
422Unprocessable Entity
Headers
Content-Type: application/jsonDelete API Key ¶
Delete API KeyDELETE/auth/key/{key_id}
Delete an API Key
Example URI
DELETE /auth/key/key_id
URI Parameters
- key_id
string(required)
Response
200API Key deleted successfully
Response
404Item not Found
View API KeyGET/auth/key/{key_id}
An API key
Example URI
GET /auth/key/key_id
URI Parameters
- key_id
string(required)
Request
Headers
Accept: application/jsonResponse
200An API Key
Headers
Content-Type: application/jsonBody
{
"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 KeyPATCH/auth/key/{key_id}
Edit API Key
Example URI
PATCH /auth/key/key_id
URI Parameters
- key_id
string(required)
Request
Headers
Content-Type: application/json
Accept: application/jsonBody
{
"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"
}Response
200An API Key
Headers
Content-Type: application/jsonBody
{
"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
Headers
Content-Type: application/json
Accept: application/jsonBody
{
"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"
}Response
422Unprocessable Entity
Headers
Content-Type: application/jsonAuth ¶
Auth
Reset Password ¶
Reset PasswordPOST/auth/password-reset
Reset Password
Example URI
POST /auth/password-reset
Request
Headers
Content-Type: application/json
Accept: application/jsonBody
{
"email": "sed officia ",
"type": "esse qui in"
}Schema
{
"properties": {
"email": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
}Response
200Password Reset Successfully
Headers
Content-Type: application/jsonBody
{}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
Headers
Content-Type: application/json
Accept: application/jsonBody
{
"type": "quis ipsum",
"email": "la"
}Schema
{
"properties": {
"email": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
}Response
422Unprocessable Entity
Headers
Content-Type: application/json2 Factor Authentication ¶
2 Factor Authentication
List 2FAs ¶
List 2FAsGET/auth/verify/auth
List of 2FAs
Example URI
GET /auth/verify/auth
Request
Headers
Accept: application/jsonResponse
200A list of 2FAs
Headers
Content-Type: application/jsonBody
[
{
"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 2FAPOST/auth/verify/auth
Create 2FA
Example URI
POST /auth/verify/auth
Request
Headers
Content-Type: application/json
Accept: application/jsonBody
{
"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"
}Response
200Two Factor Authenticator created.
Headers
Content-Type: application/jsonBody
{
"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
Headers
Content-Type: application/json
Accept: application/jsonBody
{
"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"
}Response
422Unprocessable Entity
Headers
Content-Type: application/jsonDelete 2FA ¶
Delete 2FADELETE/auth/verify/auth/{auth_id}
Delete 2FA
Example URI
DELETE /auth/verify/auth/auth_id
URI Parameters
- auth_id
string(required)
Response
2002 Factor Authentication deleted successfully
Response
404Item not Found
View 2FAGET/auth/verify/auth/{auth_id}
Get A 2FA
Example URI
GET /auth/verify/auth/auth_id
URI Parameters
- auth_id
string(required)
Request
Headers
Accept: application/jsonResponse
200A 2 Factor Authentication
Headers
Content-Type: application/jsonBody
{
"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 2FAPATCH/auth/verify/auth/{auth_id}
Edit 2FA
Example URI
PATCH /auth/verify/auth/auth_id
URI Parameters
- auth_id
string(required)
Request
Headers
Content-Type: application/json
Accept: application/jsonBody
{}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"
}Response
200A 2 Factor Authentication
Headers
Content-Type: application/jsonBody
{
"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
Headers
Content-Type: application/json
Accept: application/jsonBody
{
"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"
}Response
422Unprocessable Entity
Headers
Content-Type: application/jsonCreate 2FA Code ¶
Create 2FA CodePOST/auth/verify/auth/{auth_id}/code
2FA Code
Example URI
POST /auth/verify/auth/auth_id/code
URI Parameters
- auth_id
string(required)
Request
Headers
Content-Type: application/json
Accept: application/jsonBody
{}Schema
{
"properties": {
"isWrapped": {
"type": "boolean"
}
},
"type": "object"
}Response
2002FA Code Sent
Headers
Content-Type: application/jsonBody
{}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
Headers
Content-Type: application/json
Accept: application/jsonBody
{
"isWrapped": false
}Schema
{
"properties": {
"isWrapped": {
"type": "boolean"
}
},
"type": "object"
}Response
422Unprocessable Entity
Headers
Content-Type: application/jsonDelete 2FA Code ¶
Delete 2FA CodeDELETE/auth/verify/auth/{auth_id}/code/{code_id}
Delete 2FA Code
Example URI
DELETE /auth/verify/auth/auth_id/code/code_id
URI Parameters
- auth_id
string(required)- code_id
string(required)
Response
2002 Factor Authentication Code deleted successfully
Response
404Item not Found
View 2FA CodeGET/auth/verify/auth/{auth_id}/code/{code_id}
Get 2FA Code
Example URI
GET /auth/verify/auth/auth_id/code/code_id
URI Parameters
- auth_id
string(required)- code_id
string(required)
Request
Headers
Accept: application/jsonResponse
200A 2FA Code
Headers
Content-Type: application/jsonBody
{
"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 CodePATCH/auth/verify/auth/{auth_id}/code/{code_id}
Edit 2FA Code
Example URI
PATCH /auth/verify/auth/auth_id/code/code_id
URI Parameters
- auth_id
string(required)- code_id
string(required)
Request
Headers
Content-Type: application/json
Accept: application/jsonBody
{}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"
}Response
200A 2 Factor Authentication Code
Headers
Content-Type: application/jsonBody
{}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
Headers
Content-Type: application/json
Accept: application/jsonBody
{
"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"
}Response
422Unprocessable Entity
Headers
Content-Type: application/jsonList 2FA Methods ¶
List 2FA MethodsGET/auth/verify/method
2FA Methods
Example URI
GET /auth/verify/method
Request
Headers
Accept: application/jsonResponse
2002 Factor Auth Methods
Headers
Content-Type: application/jsonBody
[
{
"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 MethodGET/auth/verify/method/{method_id}
A 2FA Method
Example URI
GET /auth/verify/method/method_id
URI Parameters
- method_id
string(required)
Request
Headers
Accept: application/jsonResponse
200A 2 Factor Authentication Method
Headers
Content-Type: application/jsonBody
{
"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 MethodPATCH/auth/verify/method/{method_id}
Edit 2FA Method
Example URI
PATCH /auth/verify/method/method_id
URI Parameters
- method_id
string(required)
Request
Headers
Content-Type: application/json
Accept: application/jsonBody
{
"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"
}Response
200A 2FA Method
Headers
Content-Type: application/jsonBody
{
"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
Headers
Content-Type: application/json
Accept: application/jsonBody
{
"name": "anim"
}Schema
{
"properties": {
"description": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
}Response
422Unprocessable Entity
Headers
Content-Type: application/jsonOther ¶
Other
View Browser Details ¶
View Browser DetailsGET/browser-details
View the details about your browser
Example URI
GET /browser-details
Request
Headers
Accept: application/jsonResponse
200Browser Details
Headers
Content-Type: application/jsonBody
{}Schema
{
"properties": {
"ip": {
"type": "string"
}
},
"type": "object"
}Delete SSL Settings ¶
Delete SSL SettingsDELETE/http/ssl
Delete SSL Settings
Example URI
DELETE /http/ssl
Response
200SSL Settings deleted successfully
Response
404Item not Found
View SSL SettingsGET/http/ssl
SSL Information
Example URI
GET /http/ssl
Request
Headers
Accept: application/jsonResponse
200SSL Information
Headers
Content-Type: application/jsonBody
{}Schema
{
"properties": {
"enabled": {
"type": "boolean"
},
"required": {
"type": "boolean"
}
},
"type": "object"
}Create SSL SettingsPOST/http/ssl
Set new SSL Settings
Example URI
POST /http/ssl
Request
Headers
Content-Type: application/json
Accept: application/jsonBody
{
"email": "non anim sit minim"
}Schema
{
"properties": {
"email": {
"type": "string"
}
},
"type": "object"
}Response
200SSL Settings
Headers
Content-Type: application/jsonBody
{
"required": false,
"enabled": false
}Schema
{
"properties": {
"enabled": {
"type": "boolean"
},
"required": {
"type": "boolean"
}
},
"type": "object"
}Request
Headers
Content-Type: application/json
Accept: application/jsonBody
{
"email": "dolor"
}Schema
{
"properties": {
"email": {
"type": "string"
}
},
"type": "object"
}Response
422Unprocessable Entity
Headers
Content-Type: application/jsonClients ¶
Clients
List Clients ¶
List ClientsGET/client
List all Clients (sub-clients if on client-side)
Example URI
GET /client
Request
Headers
Accept: application/jsonResponse
200A list of Clients
Headers
Content-Type: application/jsonBody
[
{
"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 ClientPOST/client
Create a new Client (or sub-client on client-side)
Example URI
POST /client
Request
Headers
Content-Type: application/json
Accept: application/jsonBody
{
"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"
}
}
}Response
200A Client
Headers
Content-Type: application/jsonBody
{
"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
Headers
Content-Type: application/json
Accept: application/jsonBody
{
"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"
}
}
}Response
422Unprocessable Entity
Headers
Content-Type: application/jsonDelete Client ¶
Delete ClientDELETE/client/{client_id}
Delete a client
Example URI
DELETE /client/client_id
URI Parameters
- client_id
string(required)
Response
200Client deleted successfully
Response
404Item not Found
View ClientGET/client/{client_id}
View a specific client
Example URI
GET /client/client_id
URI Parameters
- client_id
string(required)
Request
Headers
Accept: application/jsonResponse
200A Client
Headers
Content-Type: application/jsonBody
{
"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 ClientPATCH/client/{client_id}
Edit a specific client with new information
Example URI
PATCH /client/client_id
URI Parameters
- client_id
string(required)
Request
Headers
Content-Type: application/json
Accept: application/jsonBody
{}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"
}
}
}Response
200A Client
Headers
Content-Type: application/jsonBody
{
"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
Headers
Content-Type: application/json
Accept: application/jsonBody
{}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"
}
}
}Response
422Unprocessable Entity
Headers
Content-Type: application/jsonSend Email to Client ¶
Send Email to ClientPOST/client/{client_id}/email
Send Email to a Client
Example URI
POST /client/client_id/email
URI Parameters
- client_id
string(required)
Request
Headers
Content-Type: application/json
Accept: application/jsonBody
{
"type": "magna"
}Schema
{
"properties": {
"type": {
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}Response
200Sent an email to one client.
Headers
Content-Type: application/jsonBody
[
{},
{},
{
"type": "enim",
"text": "velit minim ullamco nisi"
}
]Schema
{
"items": {
"properties": {
"text": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}Request
Headers
Content-Type: application/json
Accept: application/jsonBody
{
"type": "elit nisi nostrud adipisicing cupidatat"
}Schema
{
"properties": {
"type": {
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}Response
422Unprocessable Entity
Headers
Content-Type: application/jsonSub Clients ¶
Sub Clients
List Sub Clients ¶
List Sub ClientsGET/client/{client_id}/sub
List all Sub Clients of {client_id}
Example URI
GET /client/client_id/sub
URI Parameters
- client_id
string(required)
Request
Headers
Accept: application/jsonResponse
200A list of Sub Clients
Headers
Content-Type: application/jsonBody
[
{
"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 ClientPOST/client/{client_id}/sub
Create a new Sub Client of {client_id}
Example URI
POST /client/client_id/sub
URI Parameters
- client_id
string(required)
Request
Headers
Content-Type: application/json
Accept: application/jsonBody
{
"client_id": 45678935
}Schema
{
"properties": {
"client_id": {
"type": "integer"
}
},
"required": [
"client_id"
]
}Response
200A Sub Client
Headers
Content-Type: application/jsonBody
{
"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
Headers
Content-Type: application/json
Accept: application/jsonBody
{
"client_id": 27672246
}Schema
{
"properties": {
"client_id": {
"type": "integer"
}
},
"required": [
"client_id"
]
}Response
422Unprocessable Entity
Headers
Content-Type: application/jsonDelete Sub Client ¶
Delete Sub ClientDELETE/client/{client_id}/sub/{sub_id}
Delete a sub client
Example URI
DELETE /client/client_id/sub/sub_id
URI Parameters
- client_id
string(required)- sub_id
string(required)
Response
200One Sub Client deleted
Response
404Item not Found
View Sub ClientGET/client/{client_id}/sub/{sub_id}
View a specific sub client
Example URI
GET /client/client_id/sub/sub_id
URI Parameters
- client_id
string(required)- sub_id
string(required)
Request
Headers
Accept: application/jsonResponse
200A Sub Client
Headers
Content-Type: application/jsonBody
{
"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 ClientPATCH/client/{client_id}/sub/{sub_id}
Edit a specific sub client
Example URI
PATCH /client/client_id/sub/sub_id
URI Parameters
- client_id
string(required)- sub_id
string(required)
Request
Headers
Content-Type: application/json
Accept: application/jsonBody
{}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"
}
}
}Response
200New Sub Client Information
Headers
Content-Type: application/jsonBody
{
"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
Headers
Content-Type: application/json
Accept: application/jsonBody
{}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"
}
}
}Response
422Unprocessable Entity
Headers
Content-Type: application/jsonSuper Clients ¶
Super Clients
List Super Clients ¶
List Super ClientsGET/client/{client_id}/super
List all Super Clients of {client_id}
Example URI
GET /client/client_id/super
URI Parameters
- client_id
string(required)
Request
Headers
Accept: application/jsonResponse
200A list of Super Clients
Headers
Content-Type: application/jsonBody
[
{
"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 ClientPOST/client/{client_id}/super
Create a new Super Client of {client_id}
Example URI
POST /client/client_id/super
URI Parameters
- client_id
string(required)
Request
Headers
Content-Type: application/json
Accept: application/jsonBody
{
"client_id": 46710126
}Schema
{
"properties": {
"client_id": {
"type": "integer"
}
},
"required": [
"client_id"
]
}Response
200A Super Client
Headers
Content-Type: application/jsonBody
{
"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
Headers
Content-Type: application/json
Accept: application/jsonBody
{
"client_id": -47595645
}Schema
{
"properties": {
"client_id": {
"type": "integer"
}
},
"required": [
"client_id"
]
}Response
422Unprocessable Entity
Headers
Content-Type: application/jsonDelete Super Client ¶
Delete Super ClientDELETE/client/{client_id}/super/{super_id}
Delete a super client
Example URI
DELETE /client/client_id/super/super_id
URI Parameters
- client_id
string(required)- super_id
string(required)
Response
200One Super Client deleted
Response
404Item not Found
View Super ClientGET/client/{client_id}/super/{super_id}
View a specific super client
Example URI
GET /client/client_id/super/super_id
URI Parameters
- client_id
string(required)- super_id
string(required)
Request
Headers
Accept: application/jsonResponse
200A Super Client
Headers
Content-Type: application/jsonBody
{
"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 ClientPATCH/client/{client_id}/super/{super_id}
Edit a specific super client
Example URI
PATCH /client/client_id/super/super_id
URI Parameters
- client_id
string(required)- super_id
string(required)
Request
Headers
Content-Type: application/json
Accept: application/jsonBody
{}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"
}
}
}Response
200A Super Client
Headers
Content-Type: application/jsonBody
{
"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
Headers
Content-Type: application/json
Accept: application/jsonBody
{
"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"
}
}
}Response
422Unprocessable Entity
Headers
Content-Type: application/jsonEmail Templates ¶
Email Templates
List Email Templates ¶
List Email TemplatesGET/email/template
List of Email Templates
Example URI
GET /email/template
Request
Headers
Accept: application/jsonResponse
200A List of Email Templates
Headers
Content-Type: application/jsonBody
[
{},
{},
{
"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 TemplatePOST/email/template
Create a new Email Template
Example URI
POST /email/template
Request
Headers
Content-Type: application/json
Accept: application/jsonBody
{
"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"
}
}
}Response
200An Email Template
Headers
Content-Type: application/jsonBody
{
"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
Headers
Content-Type: application/json
Accept: application/jsonBody
{
"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"
}
}
}Response
422Unprocessable Entity
Headers
Content-Type: application/jsonDelete Email Template ¶
Delete Email TemplateDELETE/email/template/{template_id}
Delete an Email Template
Example URI
DELETE /email/template/template_id
URI Parameters
- template_id
string(required)
Response
200Email Template deleted successfully
Response
404Item not Found
View Email TemplateGET/email/template/{template_id}
An Email Template
Example URI
GET /email/template/template_id
URI Parameters
- template_id
string(required)
Request
Headers
Accept: application/jsonResponse
200An Email Template
Headers
Content-Type: application/jsonBody
{
"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 TemplatePATCH/email/template/{template_id}
Edit Email Template
Example URI
PATCH /email/template/template_id
URI Parameters
- template_id
string(required)
Request
Headers
Content-Type: application/json
Accept: application/jsonBody
{
"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"
}
}
}Response
200An Email Template
Headers
Content-Type: application/jsonBody
{}Schema
{
"properties": {
"body": {
"type": "string"
},
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
},
"subject": {
"type": "string"
}
}
}Request
Headers
Content-Type: application/json
Accept: application/jsonBody
{
"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"
}
}
}Response
422Unprocessable Entity
Headers
Content-Type: application/jsonIP Entities ¶
IP Entities
List IP Entities ¶
List IP EntitiesGET/entity
List of IP Entities
Example URI
GET /entity
Request
Headers
Accept: application/jsonResponse
200A List of IP Entities
Headers
Content-Type: application/jsonBody
[
{
"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 EntityPOST/entity
Create a new IP Entity
Example URI
POST /entity
Request
Headers
Content-Type: application/json
Accept: application/jsonBody
{
"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"
}Response
200An IP Entity
Headers
Content-Type: application/jsonBody
{
"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
Headers
Content-Type: application/json
Accept: application/jsonBody
{
"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"
}Response
422Unprocessable Entity
Headers
Content-Type: application/jsonDelete IP Entity ¶
Delete IP EntityDELETE/entity/{entity_id}
Delete an IP Entity
Example URI
DELETE /entity/entity_id
URI Parameters
- entity_id
string(required)
Response
200IP Entity deleted successfully
Response
404Item not Found
View IP EntityGET/entity/{entity_id}
An IP Entity
Example URI
GET /entity/entity_id
URI Parameters
- entity_id
string(required)
Request
Headers
Accept: application/jsonResponse
200An IP Entity
Headers
Content-Type: application/jsonBody
{
"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 EntityPATCH/entity/{entity_id}
Edit IP Entity
Example URI
PATCH /entity/entity_id
URI Parameters
- entity_id
string(required)
Request
Headers
Content-Type: application/json
Accept: application/jsonBody
{
"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"
}Response
200An IP Entity
Headers
Content-Type: application/jsonBody
{
"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
Headers
Content-Type: application/json
Accept: application/jsonBody
{}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"
}Response
422Unprocessable Entity
Headers
Content-Type: application/jsonFields ¶
Fields
List Fields ¶
List FieldsGET/field
List of Fields
Example URI
GET /field
Request
Headers
Accept: application/jsonResponse
200A List of Fields
Headers
Content-Type: application/jsonBody
[
{},
{},
{},
{},
{}
]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 FieldGET/field/{field_id}
Field Information
Example URI
GET /field/field_id
URI Parameters
- field_id
string(required)
Request
Headers
Accept: application/jsonResponse
200Field Information
Headers
Content-Type: application/jsonBody
{
"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 ValuesGET/field/{field_id}/value
Field Values
Example URI
GET /field/field_id/value
URI Parameters
- field_id
string(required)
Request
Headers
Accept: application/jsonResponse
200Field Values
Headers
Content-Type: application/jsonBody
{
"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 ValueGET/field/{field_id}/value/{value_id}
Field Value
Example URI
GET /field/field_id/value/value_id
URI Parameters
- field_id
string(required)- value_id
string(required)
Request
Headers
Accept: application/jsonResponse
200A Field Value
Headers
Content-Type: application/jsonBody
{
"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 GatewaysGET/forward/gateway
List of Forwarding Gateways
Example URI
GET /forward/gateway
Request
Headers
Accept: application/jsonResponse
200A List of Forwarding Gateways
Headers
Content-Type: application/jsonBody
[
{
"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 GatewayPOST/forward/gateway
Create a new Forwarding Gateway
Example URI
POST /forward/gateway
Request
Headers
Content-Type: application/json
Accept: application/jsonBody
{
"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"
]
}Response
200A Forwarding Gateway
Headers
Content-Type: application/jsonBody
{
"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
Headers
Content-Type: application/json
Accept: application/jsonBody
{
"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"
]
}Response
422Unprocessable Entity
Headers
Content-Type: application/jsonDelete Forwarding Gateway ¶
Delete Forwarding GatewayDELETE/forward/gateway/{gateway_id}
Delete a Forwarding Gateway
Example URI
DELETE /forward/gateway/gateway_id
URI Parameters
- gateway_id
string(required)
Response
200Forwarding Gateway deleted successfully
Response
404Item not Found
View Forwarding GatewayGET/forward/gateway/{gateway_id}
A Forwarding Gateway
Example URI
GET /forward/gateway/gateway_id
URI Parameters
- gateway_id
string(required)
Request
Headers
Accept: application/jsonResponse
200A Forwarding Gateway
Headers
Content-Type: application/jsonBody
{
"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 GatewayPATCH/forward/gateway/{gateway_id}
Edit Forwarding Gateway
Example URI
PATCH /forward/gateway/gateway_id
URI Parameters
- gateway_id
string(required)
Request
Headers
Content-Type: application/json
Accept: application/jsonBody
{
"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"
]
}Response
200A Forwarding Gateway
Headers
Content-Type: application/jsonBody
{
"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
Headers
Content-Type: application/json
Accept: application/jsonBody
{
"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"
]
}Response
422Unprocessable Entity
Headers
Content-Type: application/jsonList Forwarding Types ¶
List Forwarding TypesGET/forward/type
List of Forwarding Types
Example URI
GET /forward/type
Request
Headers
Accept: application/jsonResponse
200A List of Forwarding Types
Headers
Content-Type: application/jsonBody
[
{
"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 TypeGET/forward/type/{type_id}
Forwarding Type Information
Example URI
GET /forward/type/type_id
URI Parameters
- type_id
string(required)
Request
Headers
Accept: application/jsonResponse
200Forwarding Type Information
Headers
Content-Type: application/jsonBody
{
"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 GroupsGET/group
List of IP Groups
Example URI
GET /group
Request
Headers
Accept: application/jsonResponse
200A List of IP Groups
Headers
Content-Type: application/jsonBody
[
{},
{},
{},
{
"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 GroupPOST/group
Create a new IP Group
Example URI
POST /group
Request
Headers
Content-Type: application/json
Accept: application/jsonBody
{}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"
}
}
}Response
200An IP Group
Headers
Content-Type: application/jsonBody
{}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
Headers
Content-Type: application/json
Accept: application/jsonBody
{}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"
}
}
}Response
422Unprocessable Entity
Headers
Content-Type: application/jsonDelete IP Group ¶
Delete IP GroupDELETE/group/{group_id}
Delete an IP Group
Example URI
DELETE /group/group_id
URI Parameters
- group_id
string(required)
Response
200IP Group deleted successfully
Response
404Item not Found
View IP GroupGET/group/{group_id}
An IP Group
Example URI
GET /group/group_id
URI Parameters
- group_id
string(required)
Request
Headers
Accept: application/jsonResponse
200An IP Group
Headers
Content-Type: application/jsonBody
{
"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 GroupPATCH/group/{group_id}
Edit IP Group
Example URI
PATCH /group/group_id
URI Parameters
- group_id
string(required)
Request
Headers
Content-Type: application/json
Accept: application/jsonBody
{}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"
}
}
}Response
200An IP Group
Headers
Content-Type: application/jsonBody
{}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
Headers
Content-Type: application/json
Accept: application/jsonBody
{
"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"
}
}
}Response
422Unprocessable Entity
Headers
Content-Type: application/jsonIntegration ¶
Integration
List Integrations ¶
List IntegrationsGET/integration
List of Integrations
Example URI
GET /integration
Request
Headers
Accept: application/jsonResponse
200List of Integrations
Headers
Content-Type: application/jsonBody
[
{},
{},
{},
{}
]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 IntegrationPOST/integration
Add new Integration
Example URI
POST /integration
Request
Headers
Content-Type: application/json
Accept: application/jsonBody
{
"name": "qui mollit Ut nulla in"
}Schema
{
"required": [
"name"
],
"properties": {
"body": {
"type": "string"
},
"name": {
"type": "string"
},
"subject": {
"type": "string"
}
},
"type": "object"
}Response
200An Integration
Headers
Content-Type: application/jsonBody
{
"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
Headers
Content-Type: application/json
Accept: application/jsonBody
{
"name": "cupidatat elit dolor"
}Schema
{
"required": [
"name"
],
"properties": {
"body": {
"type": "string"
},
"name": {
"type": "string"
},
"subject": {
"type": "string"
}
},
"type": "object"
}Response
422Unprocessable Entity
Headers
Content-Type: application/jsonDelete Integration ¶
Delete IntegrationDELETE/integration/{integration_id}
Delete an Integration
Example URI
DELETE /integration/integration_id
URI Parameters
- integration_id
string(required)
Response
200Integration deleted successfully
Response
404Item not Found
View IntegrationGET/integration/{integration_id}
An Integration
Example URI
GET /integration/integration_id
URI Parameters
- integration_id
string(required)
Request
Headers
Accept: application/jsonResponse
200An Integration
Headers
Content-Type: application/jsonBody
{
"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 IntegrationPATCH/integration/{integration_id}
Edit Integration
Example URI
PATCH /integration/integration_id
URI Parameters
- integration_id
string(required)
Request
Headers
Content-Type: application/json
Accept: application/jsonBody
{
"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"
}Response
200An Integration
Headers
Content-Type: application/jsonBody
{
"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
Headers
Content-Type: application/json
Accept: application/jsonBody
{
"name": "in laborum velit anim"
}Schema
{
"properties": {
"body": {
"type": "string"
},
"name": {
"type": "string"
},
"subject": {
"type": "string"
}
},
"type": "object"
}Response
422Unprocessable Entity
Headers
Content-Type: application/jsonList Integration Permissions ¶
List Integration PermissionsGET/integration/{integration_id}/permission
List of Permissions for an Integration
Example URI
GET /integration/integration_id/permission
URI Parameters
- integration_id
string(required)
Request
Headers
Accept: application/jsonResponse
200List of Permissions for an Integration
Headers
Content-Type: application/jsonBody
[
{
"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 PermissionsPATCH/integration/{integration_id}/permission
Edit Integration permissions
Example URI
PATCH /integration/integration_id/permission
URI Parameters
- integration_id
string(required)
Request
Headers
Content-Type: application/json
Accept: application/jsonBody
{}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"
}Response
200An Integration’s Permissions
Headers
Content-Type: application/jsonBody
{
"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
Headers
Content-Type: application/json
Accept: application/jsonBody
{}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"
}Response
422Unprocessable Entity
Headers
Content-Type: application/jsonSystem ¶
System
View License Information ¶
View License InformationGET/license
License Information for Synergy
Example URI
GET /license
Request
Headers
Accept: application/jsonResponse
200License Information for Synergy
Headers
Content-Type: application/jsonBody
{
"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 InformationPOST/license/refresh
Refresh Synergy License Information
Example URI
POST /license/refresh
Request
Headers
Content-Type: application/json
Accept: application/jsonBody
{}Schema
{
"properties": {
"isWrapped": {
"type": "boolean"
}
}
}Response
200License Information
Headers
Content-Type: application/jsonBody
{
"key": "irure consectetur do Duis"
}Schema
{
"properties": {
"has_enterprise": {
"type": "boolean"
},
"is_active": {
"type": "boolean"
},
"key": {
"type": "string"
}
},
"required": [
"key"
]
}Request
Headers
Content-Type: application/json
Accept: application/jsonBody
{}Schema
{
"properties": {
"isWrapped": {
"type": "boolean"
}
}
}Response
422Unprocessable Entity
Headers
Content-Type: application/jsonList Log Items ¶
List Log ItemsGET/log
Log Information for Synergy
Example URI
GET /log
Request
Headers
Accept: application/jsonResponse
200Log Information for Synergy
Headers
Content-Type: application/jsonBody
[
{
"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 ItemGET/log/{log_id}
A Synergy Log Item
Example URI
GET /log/log_id
URI Parameters
- log_id
string(required)
Request
Headers
Accept: application/jsonResponse
200A Synergy Log Item
Headers
Content-Type: application/jsonBody
{}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 PackagesGET/package
Get Packages
Example URI
GET /package
Request
Headers
Accept: application/jsonResponse
200Packages
Headers
Content-Type: application/jsonBody
[
{
"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 PackageGET/package/{package_id}
Get Package
Example URI
GET /package/package_id
URI Parameters
- package_id
string(required)
Request
Headers
Accept: application/jsonResponse
200Package
Headers
Content-Type: application/jsonBody
{}Schema
{
"properties": {
"files": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
}List Setting Groups ¶
List Setting GroupsGET/setting-group
List of Setting Groups
Example URI
GET /setting-group
Request
Headers
Accept: application/jsonResponse
200List of Setting Groups
Headers
Content-Type: application/jsonBody
[
{},
{}
]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 GroupGET/setting-group/{setting_group_id}
Information about a Setting Group
Example URI
GET /setting-group/setting_group_id
URI Parameters
- setting_group_id
string(required)
Request
Headers
Accept: application/jsonResponse
200Information about a Setting Group
Headers
Content-Type: application/jsonBody
{
"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 OptionsGET/system/theme/customize
Theme Customization Options
Example URI
GET /system/theme/customize
Request
Headers
Accept: application/jsonResponse
200Theme Customization Options
Headers
Content-Type: application/jsonBody
{
"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 OptionsPOST/system/theme/customize
Update Theme Customization Options
Example URI
POST /system/theme/customize
Request
Headers
Content-Type: application/json
Accept: application/jsonBody
{}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"
}Response
200Theme Customization Options
Headers
Content-Type: application/jsonBody
{
"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
Headers
Content-Type: application/json
Accept: application/jsonBody
{
"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"
}Response
422Unprocessable Entity
Headers
Content-Type: application/jsonList Todo Items ¶
List Todo ItemsGET/todo
Todo Items
Example URI
GET /todo
Request
Headers
Accept: application/jsonResponse
200Todo Items
Headers
Content-Type: application/jsonBody
[
{}
]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 ItemGET/todo/{todo_id}
Todo Item
Example URI
GET /todo/todo_id
URI Parameters
- todo_id
string(required)
Request
Headers
Accept: application/jsonResponse
200Todo Item
Headers
Content-Type: application/jsonBody
{
"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 PartsGET/part{?part_type,q}
List of Computer Parts
Example URI
GET /part?part_type=&q=
URI Parameters
- part_type
string(required)- q
string(required)
Request
Headers
Accept: application/jsonResponse
200List of Computer Parts
Headers
Content-Type: application/jsonBody
[
{
"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 PartPOST/part
Add new Computer Part
Example URI
POST /part
Request
Headers
Content-Type: application/json
Accept: application/jsonBody
{
"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"
}Response
200Part Information
Headers
Content-Type: application/jsonBody
{}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
Headers
Content-Type: application/json
Accept: application/jsonBody
{
"name": "laboris velit id qui Duis"
}Schema
{
"properties": {
"billing_id": {
"type": "string"
},
"name": {
"type": "string"
},
"part_type": {
"type": "string"
}
},
"type": "object"
}Response
422Unprocessable Entity
Headers
Content-Type: application/jsonDelete Computer Part ¶
Delete Computer PartDELETE/part/{part_id}
Delete a Synergy Computer Part
Example URI
DELETE /part/part_id
URI Parameters
- part_id
string(required)
Response
200Part deleted successfully
Response
404Item not Found
View Computer PartGET/part/{part_id}
A Synergy Computer Part
Example URI
GET /part/part_id
URI Parameters
- part_id
string(required)
Request
Headers
Accept: application/jsonResponse
200A Synergy Computer Part
Headers
Content-Type: application/jsonBody
{
"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 PartPATCH/part/{part_id}
Edit Computer Part
Example URI
PATCH /part/part_id
URI Parameters
- part_id
string(required)
Request
Headers
Content-Type: application/json
Accept: application/jsonBody
{
"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"
}Response
200A Synergy Computer Part
Headers
Content-Type: application/jsonBody
{}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
Headers
Content-Type: application/json
Accept: application/jsonBody
{
"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"
}Response
422Unprocessable Entity
Headers
Content-Type: application/jsonNetwork ¶
Network
List Port Speeds ¶
List Port SpeedsGET/port-speed
List of Port Speeds
Example URI
GET /port-speed
Request
Headers
Accept: application/jsonResponse
200List of Port Speeds
Headers
Content-Type: application/jsonBody
[
{},
{
"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 SpeedPOST/port-speed
Add new Port Speed
Example URI
POST /port-speed
Request
Headers
Content-Type: application/json
Accept: application/jsonBody
{
"speed": 16371038,
"billing_id": "quis",
"name": "dolore c"
}Schema
{
"properties": {
"billing_id": {
"type": "string"
},
"name": {
"type": "string"
},
"speed": {
"type": "integer"
}
},
"type": "object"
}Response
200Port Speed Information
Headers
Content-Type: application/jsonBody
{}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
Headers
Content-Type: application/json
Accept: application/jsonBody
{
"name": "sint",
"billing_id": "nulla",
"speed": -31421880
}Schema
{
"properties": {
"billing_id": {
"type": "string"
},
"name": {
"type": "string"
},
"speed": {
"type": "integer"
}
},
"type": "object"
}Response
422Unprocessable Entity
Headers
Content-Type: application/jsonDelete Port Speed ¶
Delete Port SpeedDELETE/port-speed/{port_speed_id}
Delete a Synergy Port Speed
Example URI
DELETE /port-speed/port_speed_id
URI Parameters
- port_speed_id
string(required)
Response
200Port Speed deleted successfully
Response
404Item not Found
View Port SpeedGET/port-speed/{port_speed_id}
A Synergy Port Speed
Example URI
GET /port-speed/port_speed_id
URI Parameters
- port_speed_id
string(required)
Request
Headers
Accept: application/jsonResponse
200A Synergy Port Speed
Headers
Content-Type: application/jsonBody
{}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 SpeedPATCH/port-speed/{port_speed_id}
Edit Port Speed
Example URI
PATCH /port-speed/port_speed_id
URI Parameters
- port_speed_id
string(required)
Request
Headers
Content-Type: application/json
Accept: application/jsonBody
{
"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"
}Response
200A Synergy Port Speed
Headers
Content-Type: application/jsonBody
{}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
Headers
Content-Type: application/json
Accept: application/jsonBody
{
"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"
}Response
422Unprocessable Entity
Headers
Content-Type: application/jsonDHCP Servers ¶
DHCP Servers
List DHCP Servers ¶
List DHCP ServersGET/pxe/dhcp
List of DHCP Servers
Example URI
GET /pxe/dhcp
Request
Headers
Accept: application/jsonResponse
200List of DHCP Servers
Headers
Content-Type: application/jsonBody
[
{
"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 ServerPOST/pxe/dhcp
Add new DHCP Server
Example URI
POST /pxe/dhcp
Request
Headers
Content-Type: application/json
Accept: application/jsonBody
{
"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"
}Response
200DHCP Server Information
Headers
Content-Type: application/jsonBody
{
"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
Headers
Content-Type: application/json
Accept: application/jsonBody
{}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"
}Response
422Unprocessable Entity
Headers
Content-Type: application/jsonDelete DHCP Server ¶
Delete DHCP ServerDELETE/pxe/dhcp/{dhcp_id}
Delete a Synergy DHCP Server
Example URI
DELETE /pxe/dhcp/dhcp_id
URI Parameters
- dhcp_id
string(required)
Response
200DHCP Server deleted successfully
Response
404Item not Found
View DHCP ServerGET/pxe/dhcp/{dhcp_id}
A DHCP Server
Example URI
GET /pxe/dhcp/dhcp_id
URI Parameters
- dhcp_id
string(required)
Request
Headers
Accept: application/jsonResponse
200A DHCP Server
Headers
Content-Type: application/jsonBody
{
"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 ServerPATCH/pxe/dhcp/{dhcp_id}
Edit DHCP Server
Example URI
PATCH /pxe/dhcp/dhcp_id
URI Parameters
- dhcp_id
string(required)
Request
Headers
Content-Type: application/json
Accept: application/jsonBody
{
"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"
}Response
200A Synergy DHCP Server
Headers
Content-Type: application/jsonBody
{
"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
Headers
Content-Type: application/json
Accept: application/jsonBody
{
"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"
}Response
422Unprocessable Entity
Headers
Content-Type: application/jsonPXE Drivers ¶
PXE Drivers
List PXE Drivers ¶
List PXE DriversGET/pxe/driver
List of PXE Drivers
Example URI
GET /pxe/driver
Request
Headers
Accept: application/jsonResponse
200List of PXE Drivers
Headers
Content-Type: application/jsonBody
[
{},
{},
{
"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 DriverPOST/pxe/driver
Add new PXE Driver
Example URI
POST /pxe/driver
Request
Headers
Content-Type: application/json
Accept: application/jsonSchema
{
"required": [
"name",
"driver"
],
"properties": {
"driver": {
"format": "binary",
"type": "string"
},
"name": {
"type": "string"
}
},
"type": "object"
}Response
200A PXE Driver
Headers
Content-Type: application/jsonBody
{
"name": "ad sunt"
}Schema
{
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
}Request
Headers
Content-Type: application/json
Accept: application/jsonSchema
{
"required": [
"name",
"driver"
],
"properties": {
"driver": {
"format": "binary",
"type": "string"
},
"name": {
"type": "string"
}
},
"type": "object"
}Response
422Unprocessable Entity
Headers
Content-Type: application/jsonDelete PXE Driver ¶
Delete PXE DriverDELETE/pxe/driver/{driver_id}
Delete a Synergy PXE Driver
Example URI
DELETE /pxe/driver/driver_id
URI Parameters
- driver_id
string(required)
Response
200PXE Driver deleted successfully
Response
404Item not Found
View PXE DriverGET/pxe/driver/{driver_id}
A PXE Driver
Example URI
GET /pxe/driver/driver_id
URI Parameters
- driver_id
string(required)
Request
Headers
Accept: application/jsonResponse
200A PXE Driver
Headers
Content-Type: application/jsonBody
{}Schema
{
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
}Edit PXE DriverPATCH/pxe/driver/{driver_id}
Edit PXE Driver
Example URI
PATCH /pxe/driver/driver_id
URI Parameters
- driver_id
string(required)
Request
Headers
Content-Type: application/json
Accept: application/jsonSchema
{
"properties": {
"driver": {
"format": "binary",
"type": "string"
},
"name": {
"type": "string"
}
},
"type": "object"
}Response
200A Synergy PXE Driver
Headers
Content-Type: application/jsonBody
{}Schema
{
"properties": {
"id": {
"description": "SynergyCP-specific unique identifier used for URLs, etc.",
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
}Request
Headers
Content-Type: application/json
Accept: application/jsonBody
{}Schema
{
"properties": {
"driver": {
"format": "binary",
"type": "string"
},
"name": {
"type": "string"
}
},
"type": "object"
}Response
422Unprocessable Entity
Headers
Content-Type: application/jsonFile Servers ¶
File Servers
List File Servers ¶
List File ServersGET/pxe/file
List of File Servers
Example URI
GET /pxe/file
Request
Headers
Accept: application/jsonResponse
200List of File Servers
Headers
Content-Type: application/jsonBody
[
{
"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 ServerPOST/pxe/file
Add new File Server
Example URI
POST /pxe/file
Request
Headers
Content-Type: application/json
Accept: application/jsonBody
{
"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"
}Response
200A File Server
Headers
Content-Type: application/jsonBody
{
"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
Headers
Content-Type: application/json
Accept: application/jsonBody
{
"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"
}Response
422Unprocessable Entity
Headers
Content-Type: application/jsonDelete File Server ¶
Delete File ServerDELETE/pxe/file/{file_server_id}
Delete a File Server
Example URI
DELETE /pxe/file/file_server_id
URI Parameters
- file_server_id
string(required)
Response
200File Server deleted successfully
Response
404Item not Found
View File ServerGET/pxe/file/{file_server_id}
A File Server
Example URI
GET /pxe/file/file_server_id
URI Parameters
- file_server_id
string(required)
Request
Headers
Accept: application/jsonResponse
200A File Server
Headers
Content-Type: application/jsonBody
{
"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 ServerPATCH/pxe/file/{file_server_id}
Edit File Server
Example URI
PATCH /pxe/file/file_server_id
URI Parameters
- file_server_id
string(required)
Request
Headers
Content-Type: application/json
Accept: application/jsonBody
{
"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"
}Response
200A File Server
Headers
Content-Type: application/jsonBody
{}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
Headers
Content-Type: application/json
Accept: application/jsonBody
{
"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"
}Response
422Unprocessable Entity
Headers
Content-Type: application/jsonSync Child Server Files ¶
Sync Child Server FilesPOST/pxe/file/{file_server_id}/child/sync
Sync Files to Child Server
Example URI
POST /pxe/file/file_server_id/child/sync
URI Parameters
- file_server_id
string(required)
Request
Headers
Content-Type: application/jsonBody
{
"isWrapped": true
}Schema
{
"properties": {
"isWrapped": {
"type": "boolean"
}
},
"required": [
"isWrapped"
]
}Response
200File server sync initiated with all children.
Request
Headers
Content-Type: application/jsonBody
{
"isWrapped": false
}Schema
{
"properties": {
"isWrapped": {
"type": "boolean"
}
},
"required": [
"isWrapped"
]
}Response
422Unprocessable Entity
ISOs ¶
ISOs
List ISO Managers ¶
List ISO ManagersGET/pxe/iso
List of ISO Managers
Example URI
GET /pxe/iso
Request
Headers
Accept: application/jsonResponse
200List of ISO Managers
Headers
Content-Type: application/jsonBody
[
{},
{
"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 ManagerPOST/pxe/iso
Add new ISO Manager
Example URI
POST /pxe/iso
Request
Headers
Content-Type: application/json
Accept: application/jsonBody
{
"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"
}Response
200An ISO Manager
Headers
Content-Type: application/jsonBody
{
"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
Headers
Content-Type: application/json
Accept: application/jsonBody
{
"name": "do",
"folder": "do",
"url": "sint"
}Schema
{
"required": [
"name",
"folder",
"url"
],
"properties": {
"folder": {
"type": "string"
},
"name": {
"type": "string"
},
"url": {
"type": "string"
}
},
"type": "object"
}Response
422Unprocessable Entity
Headers
Content-Type: application/jsonDelete ISO Manager ¶
Delete ISO ManagerDELETE/pxe/iso/{iso_manager_id}
Delete an ISO Manager
Example URI
DELETE /pxe/iso/iso_manager_id
URI Parameters
- iso_manager_id
string(required)
Response
200ISO Manager deleted successfully
Response
404Item not Found
View ISO ManagerGET/pxe/iso/{iso_manager_id}
An ISO Manager
Example URI
GET /pxe/iso/iso_manager_id
URI Parameters
- iso_manager_id
string(required)
Request
Headers
Accept: application/jsonResponse
200An ISO Manager
Headers
Content-Type: application/jsonBody
{
"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 ManagerPATCH/pxe/iso/{iso_manager_id}
Edit ISO Manager
Example URI
PATCH /pxe/iso/iso_manager_id
URI Parameters
- iso_manager_id
string(required)
Request
Headers
Content-Type: application/json
Accept: application/jsonBody
{
"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"
}Response
200An ISO Manager
Headers
Content-Type: application/jsonBody
{
"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
Headers
Content-Type: application/json
Accept: application/jsonBody
{}Schema
{
"properties": {
"folder": {
"type": "string"
},
"name": {
"type": "string"
},
"url": {
"type": "string"
}
},
"type": "object"
}Response
422Unprocessable Entity
Headers
Content-Type: application/jsonList ISO Editions ¶
List ISO EditionsGET/pxe/iso/{iso_manager_id}/edition
List of ISO Editions
Example URI
GET /pxe/iso/iso_manager_id/edition
URI Parameters
- iso_manager_id
string(required)
Request
Headers
Accept: application/jsonResponse
200List of ISO Editions
Headers
Content-Type: application/jsonBody
[
{},
{
"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 EditionGET/pxe/iso/{iso_manager_id}/edition/{edition_id}
An ISO Edition
Example URI
GET /pxe/iso/iso_manager_id/edition/edition_id
URI Parameters
- iso_manager_id
string(required)- edition_id
string(required)
Request
Headers
Accept: application/jsonResponse
200An ISO Edition
Headers
Content-Type: application/jsonBody
{}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 EditionPATCH/pxe/iso/{iso_manager_id}/edition/{edition_id}
Edit ISO Edition
Example URI
PATCH /pxe/iso/iso_manager_id/edition/edition_id
URI Parameters
- iso_manager_id
string(required)- edition_id
string(required)
Request
Headers
Content-Type: application/json
Accept: application/jsonBody
{
"license_key": "nulla velit esse fugiat sint",
"is_enabled": true
}Schema
{
"properties": {
"is_enabled": {
"type": "boolean"
},
"license_key": {
"type": "string"
}
}
}Response
200An ISO Edition
Headers
Content-Type: application/jsonBody
{}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
Headers
Content-Type: application/json
Accept: application/jsonBody
{}Schema
{
"properties": {
"is_enabled": {
"type": "boolean"
},
"license_key": {
"type": "string"
}
}
}Response
422Unprocessable Entity
Headers
Content-Type: application/jsonPXE Preseeds ¶
PXE Preseeds
List OS Preseeds ¶
List OS PreseedsGET/pxe/preseed
List of OS Preseeds
Example URI
GET /pxe/preseed
Request
Headers
Accept: application/jsonResponse
200List of OS Preseeds
Headers
Content-Type: application/jsonBody
[
{
"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 PreseedPOST/pxe/preseed
Add new OS Preseed
Example URI
POST /pxe/preseed
Request
Headers
Content-Type: application/json
Accept: application/jsonBody
{
"name": "adipisicing"
}Schema
{
"required": [
"name"
],
"properties": {
"body": {
"type": "string"
},
"description": {
"type": "string"
},
"is_installable": {
"type": "boolean"
},
"name": {
"type": "string"
}
},
"type": "object"
}Response
200An OS Preseed
Headers
Content-Type: application/jsonBody
{}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
Headers
Content-Type: application/json
Accept: application/jsonBody
{
"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"
}Response
422Unprocessable Entity
Headers
Content-Type: application/jsonDelete OS Preseed ¶
Delete OS PreseedDELETE/pxe/preseed/{preseed_id}
Delete an OS Preseed
Example URI
DELETE /pxe/preseed/preseed_id
URI Parameters
- preseed_id
string(required)
Response
200OS Preseed deleted successfully
Response
404Item not Found
View OS PreseedGET/pxe/preseed/{preseed_id}
An OS Preseed
Example URI
GET /pxe/preseed/preseed_id
URI Parameters
- preseed_id
string(required)
Request
Headers
Accept: application/jsonResponse
200An OS Preseed
Headers
Content-Type: application/jsonBody
{
"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 PreseedPATCH/pxe/preseed/{preseed_id}
Edit OS Preseed
Example URI
PATCH /pxe/preseed/preseed_id
URI Parameters
- preseed_id
string(required)
Request
Headers
Content-Type: application/json
Accept: application/jsonBody
{
"name": "aliqua dolore ipsum fugiat"
}Schema
{
"properties": {
"body": {
"type": "string"
},
"description": {
"type": "string"
},
"is_installable": {
"type": "boolean"
},
"name": {
"type": "string"
}
},
"type": "object"
}Response
200An OS Preseed
Headers
Content-Type: application/jsonBody
{
"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
Headers
Content-Type: application/json
Accept: application/jsonBody
{
"body": "sunt Duis reprehenderit"
}Schema
{
"properties": {
"body": {
"type": "string"
},
"description": {
"type": "string"
},
"is_installable": {
"type": "boolean"
},
"name": {
"type": "string"
}
},
"type": "object"
}Response
422Unprocessable Entity
Headers
Content-Type: application/jsonOS Reload Profiles ¶
OS Reload Profiles
List Reload Profiles ¶
List Reload ProfilesGET/pxe/profile
List of OS Reload Profiles
Example URI
GET /pxe/profile
Request
Headers
Accept: application/jsonResponse
200List of OS Reload Profiles
Headers
Content-Type: application/jsonBody
[
{
"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 ProfilePOST/pxe/profile
Add new Reload Profiles
Example URI
POST /pxe/profile
Request
Headers
Content-Type: application/json
Accept: application/jsonBody
{
"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"
}Response
200A Reload Profiles
Headers
Content-Type: application/jsonBody
{
"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
Headers
Content-Type: application/json
Accept: application/jsonBody
{
"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"
}Response
422Unprocessable Entity
Headers
Content-Type: application/jsonDelete Reload Profile ¶
Delete Reload ProfileDELETE/pxe/profile/{profile_id}
Delete an OS Reload Profile
Example URI
DELETE /pxe/profile/profile_id
URI Parameters
- profile_id
string(required)
Response
200OS Reload Profile deleted successfully
Response
404Item not Found
View Reload ProfileGET/pxe/profile/{profile_id}
An OS Preseed
Example URI
GET /pxe/profile/profile_id
URI Parameters
- profile_id
string(required)
Request
Headers
Accept: application/jsonResponse
200An OS Preseed
Headers
Content-Type: application/jsonBody
{
"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 ProfilePATCH/pxe/profile/{profile_id}
Edit OS Reload Profile
Example URI
PATCH /pxe/profile/profile_id
URI Parameters
- profile_id
string(required)
Request
Headers
Content-Type: application/json
Accept: application/jsonBody
{
"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"
}Response
200An OS Reload Profile
Headers
Content-Type: application/jsonBody
{}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
Headers
Content-Type: application/json
Accept: application/jsonBody
{
"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"
}Response
422Unprocessable Entity
Headers
Content-Type: application/jsonOS Shell Scripts ¶
OS Shell Scripts
List Shell Scripts ¶
List Shell ScriptsGET/pxe/shell
List of OS Reload Shell Scripts
Example URI
GET /pxe/shell
Request
Headers
Accept: application/jsonResponse
200List of OS Reload Shell Scripts
Headers
Content-Type: application/jsonBody
[
{
"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 ScriptPOST/pxe/shell
Add new Reload Shell Scripts
Example URI
POST /pxe/shell
Request
Headers
Content-Type: application/json
Accept: application/jsonBody
{
"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"
}Response
200A Reload Shell Script
Headers
Content-Type: application/jsonBody
{
"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
Headers
Content-Type: application/json
Accept: application/jsonBody
{
"name": "Excepteur eiusmod est ea"
}Schema
{
"required": [
"name"
],
"properties": {