SynergyCP API

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

For Integrations: API Keys are used for connecting Integrations like WHMCS to Synergy. To create a new one go to System < Integrations. Create a new Integration and then select it, click on API Keys and then Generate one. This API Key will be used anytime the Integration needs to communicate with Synergy.

Admins

Admins

List Admins

List Admins
GET/admin

List all Admins

Example URI

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

A list of Admins

Headers
Content-Type: application/json
Body
[
  {
    "username": "labore enim sunt Duis",
    "id": -70502595
  },
  {
    "username": "deserunt et fugiat"
  },
  {
    "username": "adipisicing cupidatat",
    "email": "sunt cillum",
    "receive_copies": true
  },
  {
    "username": "quis ut tempor in nostrud",
    "created_at": {
      "iso_8601": "officia quis dolor",
      "unix": -91375448
    }
  },
  {
    "username": "nulla ullamco",
    "name": "in",
    "receive_copies": false,
    "created_at": {
      "iso_8601": "labore",
      "unix": -86364730
    }
  }
]
Schema
{
  "items": {
    "properties": {
      "created_at": {
        "properties": {
          "iso_8601": {
            "description": "IS0 8601-formatted Date",
            "type": "string"
          },
          "unix": {
            "description": "Seconds since Unix epoch (Unix Timestamp)",
            "type": "integer"
          }
        },
        "required": [
          "iso_8601",
          "unix"
        ],
        "type": "object"
      },
      "email": {
        "example": "[email protected]",
        "type": "string"
      },
      "id": {
        "description": "SynergyCP-specific unique identifier used for URLs, etc.",
        "type": "integer"
      },
      "name": {
        "type": "string"
      },
      "receive_copies": {
        "type": "boolean"
      },
      "username": {
        "type": "string"
      }
    },
    "required": [
      "username"
    ],
    "type": "object"
  },
  "type": "array"
}

Create Admin
POST/admin

Create a new Admin

Example URI

POST /admin
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "email": "sit laboris",
  "password": "dolor",
  "receive_copies": false,
  "username": "exercitation sint"
}
Schema
{
  "required": [
    "email",
    "password"
  ],
  "properties": {
    "email": {
      "example": "[email protected]",
      "type": "string"
    },
    "password": {
      "type": "string"
    },
    "receive_copies": {
      "type": "boolean"
    },
    "username": {
      "type": "string"
    }
  },
  "type": "object"
}
Response  200
HideShow

An Admin

Headers
Content-Type: application/json
Body
{
  "username": "in"
}
Schema
{
  "properties": {
    "created_at": {
      "properties": {
        "iso_8601": {
          "description": "IS0 8601-formatted Date",
          "type": "string"
        },
        "unix": {
          "description": "Seconds since Unix epoch (Unix Timestamp)",
          "type": "integer"
        }
      },
      "required": [
        "iso_8601",
        "unix"
      ],
      "type": "object"
    },
    "email": {
      "example": "[email protected]",
      "type": "string"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "name": {
      "type": "string"
    },
    "receive_copies": {
      "type": "boolean"
    },
    "username": {
      "type": "string"
    }
  },
  "required": [
    "username"
  ],
  "type": "object"
}
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "email": "fugiat aute nulla adipisicing irure",
  "password": "minim dolore irure"
}
Schema
{
  "required": [
    "email",
    "password"
  ],
  "properties": {
    "email": {
      "example": "[email protected]",
      "type": "string"
    },
    "password": {
      "type": "string"
    },
    "receive_copies": {
      "type": "boolean"
    },
    "username": {
      "type": "string"
    }
  },
  "type": "object"
}
Response  422
HideShow

Unprocessable Entity

Headers
Content-Type: application/json

Delete Admin

Delete Admin
DELETE/admin/{admin_id}

Delete an admin

Example URI

DELETE /admin/admin_id
URI Parameters
HideShow
admin_id
string (required) 
Response  200
HideShow

Admin deleted successfully

Response  404
HideShow

Item not Found

View Admin
GET/admin/{admin_id}

View a specific admin

Example URI

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

An Admin

Headers
Content-Type: application/json
Body
{
  "username": "do proident id minim aliquip",
  "email": "voluptate exercitation ea"
}
Schema
{
  "properties": {
    "created_at": {
      "properties": {
        "iso_8601": {
          "description": "IS0 8601-formatted Date",
          "type": "string"
        },
        "unix": {
          "description": "Seconds since Unix epoch (Unix Timestamp)",
          "type": "integer"
        }
      },
      "required": [
        "iso_8601",
        "unix"
      ],
      "type": "object"
    },
    "email": {
      "example": "[email protected]",
      "type": "string"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "name": {
      "type": "string"
    },
    "receive_copies": {
      "type": "boolean"
    },
    "username": {
      "type": "string"
    }
  },
  "required": [
    "username"
  ],
  "type": "object"
}

Edit Admin
PATCH/admin/{admin_id}

Edit a specific admin with new information

Example URI

PATCH /admin/admin_id
URI Parameters
HideShow
admin_id
string (required) 
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{}
Schema
{
  "properties": {
    "email": {
      "example": "[email protected]",
      "type": "string"
    },
    "password": {
      "type": "string"
    },
    "receive_copies": {
      "type": "boolean"
    },
    "username": {
      "type": "string"
    }
  },
  "type": "object"
}
Response  200
HideShow

An Admin

Headers
Content-Type: application/json
Body
{
  "username": "cupidatat"
}
Schema
{
  "properties": {
    "created_at": {
      "properties": {
        "iso_8601": {
          "description": "IS0 8601-formatted Date",
          "type": "string"
        },
        "unix": {
          "description": "Seconds since Unix epoch (Unix Timestamp)",
          "type": "integer"
        }
      },
      "required": [
        "iso_8601",
        "unix"
      ],
      "type": "object"
    },
    "email": {
      "example": "[email protected]",
      "type": "string"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "name": {
      "type": "string"
    },
    "receive_copies": {
      "type": "boolean"
    },
    "username": {
      "type": "string"
    }
  },
  "required": [
    "username"
  ],
  "type": "object"
}
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{}
Schema
{
  "properties": {
    "email": {
      "example": "[email protected]",
      "type": "string"
    },
    "password": {
      "type": "string"
    },
    "receive_copies": {
      "type": "boolean"
    },
    "username": {
      "type": "string"
    }
  },
  "type": "object"
}
Response  422
HideShow

Unprocessable Entity

Headers
Content-Type: application/json

View Admin Permissions

View Admin Permissions
GET/admin/{admin_id}/permission

View a specific admin’s permissions

Example URI

GET /admin/admin_id/permission
URI Parameters
HideShow
admin_id
string (required) 
Request
HideShow
Headers
Accept: application/json
Response  200
HideShow

An Admin’s Permissions

Headers
Content-Type: application/json
Body
{
  "pxe": {
    "settings": {
      "read": false
    }
  }
}
Schema
{
  "properties": {
    "network": {
      "properties": {
        "entities": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "forward": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "groups": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "switches": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        }
      },
      "type": "object"
    },
    "pxe": {
      "properties": {
        "installs": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "settings": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        }
      },
      "type": "object"
    },
    "server": {
      "properties": {
        "in_inventory": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "in_use": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "settings": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        }
      },
      "type": "object"
    },
    "system": {
      "properties": {
        "emails": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "integrations": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "logs": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "settings": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "theme": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        }
      },
      "type": "object"
    },
    "users": {
      "properties": {
        "admins": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "clients": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        }
      },
      "type": "object"
    }
  },
  "type": "object"
}

Edit Admin Permissions
PATCH/admin/{admin_id}/permission

Edit a specific admin’s Permissions

Example URI

PATCH /admin/admin_id/permission
URI Parameters
HideShow
admin_id
string (required) 
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{}
Schema
{
  "properties": {
    "network": {
      "properties": {
        "entities": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "forward": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "groups": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "switches": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        }
      },
      "type": "object"
    },
    "pxe": {
      "properties": {
        "installs": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "settings": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        }
      },
      "type": "object"
    },
    "server": {
      "properties": {
        "in_inventory": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "in_use": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "settings": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        }
      },
      "type": "object"
    },
    "system": {
      "properties": {
        "emails": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "integrations": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "logs": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "settings": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "theme": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        }
      },
      "type": "object"
    },
    "users": {
      "properties": {
        "admins": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "clients": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        }
      },
      "type": "object"
    }
  },
  "type": "object"
}
Response  200
HideShow

An Admin’s Permissions

Headers
Content-Type: application/json
Body
{}
Schema
{
  "properties": {
    "network": {
      "properties": {
        "entities": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "forward": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "groups": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "switches": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        }
      },
      "type": "object"
    },
    "pxe": {
      "properties": {
        "installs": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "settings": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        }
      },
      "type": "object"
    },
    "server": {
      "properties": {
        "in_inventory": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "in_use": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "settings": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        }
      },
      "type": "object"
    },
    "system": {
      "properties": {
        "emails": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "integrations": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "logs": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "settings": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "theme": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        }
      },
      "type": "object"
    },
    "users": {
      "properties": {
        "admins": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "clients": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        }
      },
      "type": "object"
    }
  },
  "type": "object"
}
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{}
Schema
{
  "properties": {
    "network": {
      "properties": {
        "entities": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "forward": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "groups": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "switches": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        }
      },
      "type": "object"
    },
    "pxe": {
      "properties": {
        "installs": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "settings": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        }
      },
      "type": "object"
    },
    "server": {
      "properties": {
        "in_inventory": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "in_use": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "settings": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        }
      },
      "type": "object"
    },
    "system": {
      "properties": {
        "emails": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "integrations": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "logs": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "settings": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "theme": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        }
      },
      "type": "object"
    },
    "users": {
      "properties": {
        "admins": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "clients": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        }
      },
      "type": "object"
    }
  },
  "type": "object"
}
Response  422
HideShow

Unprocessable Entity

Headers
Content-Type: application/json

API Keys

API Keys

List API Keys

List API Keys
GET/auth/key

List of API keys currently active in Synergy

Example URI

GET /auth/key
Request
HideShow
Headers
Accept: application/json
Response  200
HideShow

A list of API Keys

Headers
Content-Type: application/json
Body
[
  {
    "id": -25252146,
    "name": "qui",
    "key": "commodo"
  },
  {
    "id": 94006911,
    "name": "ex consectetur dolor ut proident"
  }
]
Schema
{
  "items": {
    "properties": {
      "expires_at": {
        "properties": {
          "iso_8601": {
            "description": "IS0 8601-formatted Date",
            "type": "string"
          },
          "unix": {
            "description": "Seconds since Unix epoch (Unix Timestamp)",
            "type": "integer"
          }
        },
        "required": [
          "iso_8601",
          "unix"
        ],
        "type": "object"
      },
      "id": {
        "description": "SynergyCP-specific unique identifier used for URLs, etc.",
        "type": "integer"
      },
      "key": {
        "type": "string"
      },
      "name": {
        "type": "string"
      },
      "owner": {
        "properties": {
          "id": {
            "description": "SynergyCP-specific unique identifier used for URLs, etc.",
            "type": "integer"
          },
          "name": {
            "type": "string"
          },
          "url": {
            "type": "string"
          }
        },
        "type": "object"
      }
    },
    "required": [
      "id",
      "name"
    ],
    "type": "object"
  },
  "type": "array"
}

Create API Key
POST/auth/key

Create a new API Key

Example URI

POST /auth/key
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "name": "amet veniam Lorem"
}
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  200
HideShow

An API Key

Headers
Content-Type: application/json
Body
{
  "id": -4002771,
  "name": "consectetur ea do minim aliquip",
  "key": "enim irure nostrud veniam ullamco"
}
Schema
{
  "properties": {
    "expires_at": {
      "properties": {
        "iso_8601": {
          "description": "IS0 8601-formatted Date",
          "type": "string"
        },
        "unix": {
          "description": "Seconds since Unix epoch (Unix Timestamp)",
          "type": "integer"
        }
      },
      "required": [
        "iso_8601",
        "unix"
      ],
      "type": "object"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "key": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "owner": {
      "properties": {
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "name": {
          "type": "string"
        },
        "url": {
          "type": "string"
        }
      },
      "type": "object"
    }
  },
  "required": [
    "id",
    "name"
  ],
  "type": "object"
}
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "name": "fugiat",
  "id": 73856564,
  "key": "minim id proident cupidatat Lorem",
  "owner": {
    "url": "laborum"
  }
}
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  422
HideShow

Unprocessable Entity

Headers
Content-Type: application/json

Delete API Key

Delete API Key
DELETE/auth/key/{key_id}

Delete an API Key

Example URI

DELETE /auth/key/key_id
URI Parameters
HideShow
key_id
string (required) 
Response  200
HideShow

API Key deleted successfully

Response  404
HideShow

Item not Found

View API Key
GET/auth/key/{key_id}

An API key

Example URI

GET /auth/key/key_id
URI Parameters
HideShow
key_id
string (required) 
Request
HideShow
Headers
Accept: application/json
Response  200
HideShow

An API Key

Headers
Content-Type: application/json
Body
{
  "id": -5644176,
  "name": "Lorem voluptate consectetur adipisicing"
}
Schema
{
  "properties": {
    "expires_at": {
      "properties": {
        "iso_8601": {
          "description": "IS0 8601-formatted Date",
          "type": "string"
        },
        "unix": {
          "description": "Seconds since Unix epoch (Unix Timestamp)",
          "type": "integer"
        }
      },
      "required": [
        "iso_8601",
        "unix"
      ],
      "type": "object"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "key": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "owner": {
      "properties": {
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "name": {
          "type": "string"
        },
        "url": {
          "type": "string"
        }
      },
      "type": "object"
    }
  },
  "required": [
    "id",
    "name"
  ],
  "type": "object"
}

Edit API Key
PATCH/auth/key/{key_id}

Edit API Key

Example URI

PATCH /auth/key/key_id
URI Parameters
HideShow
key_id
string (required) 
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "name": "adipisicing dolor aute consequat"
}
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  200
HideShow

An API Key

Headers
Content-Type: application/json
Body
{
  "id": -53926433,
  "name": "do",
  "owner": {
    "id": 99119366,
    "name": "tempor ad",
    "url": "exer"
  }
}
Schema
{
  "properties": {
    "expires_at": {
      "properties": {
        "iso_8601": {
          "description": "IS0 8601-formatted Date",
          "type": "string"
        },
        "unix": {
          "description": "Seconds since Unix epoch (Unix Timestamp)",
          "type": "integer"
        }
      },
      "required": [
        "iso_8601",
        "unix"
      ],
      "type": "object"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "key": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "owner": {
      "properties": {
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "name": {
          "type": "string"
        },
        "url": {
          "type": "string"
        }
      },
      "type": "object"
    }
  },
  "required": [
    "id",
    "name"
  ],
  "type": "object"
}
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "name": "magna qui"
}
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  422
HideShow

Unprocessable Entity

Headers
Content-Type: application/json

Auth

Auth

Reset Password

Reset Password
POST/auth/password-reset

Reset Password

Example URI

POST /auth/password-reset
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{}
Schema
{
  "properties": {
    "email": {
      "type": "string"
    },
    "type": {
      "type": "string"
    }
  },
  "type": "object"
}
Response  200
HideShow

Password Reset Successfully

Headers
Content-Type: application/json
Body
{}
Schema
{
  "properties": {
    "user": {
      "properties": {
        "email": {
          "type": "string"
        },
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "name": {
          "type": "string"
        },
        "username": {
          "type": "string"
        }
      },
      "type": "object"
    }
  },
  "type": "object"
}
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{}
Schema
{
  "properties": {
    "email": {
      "type": "string"
    },
    "type": {
      "type": "string"
    }
  },
  "type": "object"
}
Response  422
HideShow

Unprocessable Entity

Headers
Content-Type: application/json

Single Sign On Link

Single Sign On Link
GET/auth/sso

A Single Sign On Link

Example URI

GET /auth/sso
Response  200
HideShow

Single Sign On Link

2 Factor Authentication

2 Factor Authentication

List 2FAs

List 2FAs
GET/auth/verify/auth

List of 2FAs

Example URI

GET /auth/verify/auth
Request
HideShow
Headers
Accept: application/json
Response  200
HideShow

A list of 2FAs

Headers
Content-Type: application/json
Body
[
  {
    "method": {
      "name": "sed"
    }
  }
]
Schema
{
  "items": {
    "properties": {
      "id": {
        "description": "SynergyCP-specific unique identifier used for URLs, etc.",
        "type": "integer"
      },
      "method": {
        "properties": {
          "id": {
            "description": "SynergyCP-specific unique identifier used for URLs, etc.",
            "type": "integer"
          },
          "name": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "value": {
        "type": "string"
      },
      "verified": {
        "type": "boolean"
      }
    },
    "type": "object"
  },
  "type": "array"
}

Create 2FA
POST/auth/verify/auth

Create 2FA

Example URI

POST /auth/verify/auth
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "value": "ad qui laborum"
}
Schema
{
  "properties": {
    "method": {
      "properties": {
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        }
      },
      "type": "object"
    },
    "value": {
      "type": "string"
    }
  },
  "type": "object"
}
Response  200
HideShow

Two Factor Authenticator created.

Headers
Content-Type: application/json
Body
{
  "method": {
    "name": "laboris"
  },
  "verified": false
}
Schema
{
  "properties": {
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "method": {
      "properties": {
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "name": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "value": {
      "type": "string"
    },
    "verified": {
      "type": "boolean"
    }
  },
  "type": "object"
}
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{}
Schema
{
  "properties": {
    "method": {
      "properties": {
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        }
      },
      "type": "object"
    },
    "value": {
      "type": "string"
    }
  },
  "type": "object"
}
Response  422
HideShow

Unprocessable Entity

Headers
Content-Type: application/json

Delete 2FA

Delete 2FA
DELETE/auth/verify/auth/{auth_id}

Delete 2FA

Example URI

DELETE /auth/verify/auth/auth_id
URI Parameters
HideShow
auth_id
string (required) 
Response  200
HideShow

2 Factor Authentication deleted successfully

Response  404
HideShow

Item not Found

View 2FA
GET/auth/verify/auth/{auth_id}

Get A 2FA

Example URI

GET /auth/verify/auth/auth_id
URI Parameters
HideShow
auth_id
string (required) 
Request
HideShow
Headers
Accept: application/json
Response  200
HideShow

A 2 Factor Authentication

Headers
Content-Type: application/json
Body
{
  "method": {
    "name": "consectetur consequat quis"
  },
  "id": 6991261,
  "verified": false
}
Schema
{
  "properties": {
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "method": {
      "properties": {
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "name": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "value": {
      "type": "string"
    },
    "verified": {
      "type": "boolean"
    }
  },
  "type": "object"
}

Validate 2FA
PATCH/auth/verify/auth/{auth_id}

Edit 2FA

Example URI

PATCH /auth/verify/auth/auth_id
URI Parameters
HideShow
auth_id
string (required) 
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "value": "eiusmod dolore Lorem ex exercitati"
}
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  200
HideShow

A 2 Factor Authentication

Headers
Content-Type: application/json
Body
{
  "verified": true,
  "value": "mollit ad veniam ea"
}
Schema
{
  "properties": {
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "method": {
      "properties": {
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "name": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "value": {
      "type": "string"
    },
    "verified": {
      "type": "boolean"
    }
  },
  "type": "object"
}
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{}
Schema
{
  "properties": {
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "method": {
      "properties": {
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "name": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "value": {
      "type": "string"
    },
    "verified": {
      "type": "boolean"
    }
  },
  "type": "object"
}
Response  422
HideShow

Unprocessable Entity

Headers
Content-Type: application/json

Create 2FA Code

Create 2FA Code
POST/auth/verify/auth/{auth_id}/code

2FA Code

Example URI

POST /auth/verify/auth/auth_id/code
URI Parameters
HideShow
auth_id
string (required) 
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "isWrapped": false
}
Schema
{
  "properties": {
    "isWrapped": {
      "type": "boolean"
    }
  },
  "type": "object"
}
Response  200
HideShow

2FA Code Sent

Headers
Content-Type: application/json
Body
{}
Schema
{
  "properties": {
    "auth": {
      "properties": {
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "method": {
          "properties": {
            "id": {
              "description": "SynergyCP-specific unique identifier used for URLs, etc.",
              "type": "integer"
            },
            "name": {
              "type": "string"
            }
          },
          "type": "object"
        },
        "value": {
          "type": "string"
        },
        "verified": {
          "type": "boolean"
        }
      },
      "type": "object"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "token": {
      "type": "string"
    }
  },
  "type": "object"
}
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "isWrapped": true
}
Schema
{
  "properties": {
    "isWrapped": {
      "type": "boolean"
    }
  },
  "type": "object"
}
Response  422
HideShow

Unprocessable Entity

Headers
Content-Type: application/json

Delete 2FA Code

Delete 2FA Code
DELETE/auth/verify/auth/{auth_id}/code/{code_id}

Delete 2FA Code

Example URI

DELETE /auth/verify/auth/auth_id/code/code_id
URI Parameters
HideShow
auth_id
string (required) 
code_id
string (required) 
Response  200
HideShow

2 Factor Authentication Code deleted successfully

Response  404
HideShow

Item not Found

View 2FA Code
GET/auth/verify/auth/{auth_id}/code/{code_id}

Get 2FA Code

Example URI

GET /auth/verify/auth/auth_id/code/code_id
URI Parameters
HideShow
auth_id
string (required) 
code_id
string (required) 
Request
HideShow
Headers
Accept: application/json
Response  200
HideShow

A 2FA Code

Headers
Content-Type: application/json
Body
{}
Schema
{
  "properties": {
    "auth": {
      "properties": {
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "method": {
          "properties": {
            "id": {
              "description": "SynergyCP-specific unique identifier used for URLs, etc.",
              "type": "integer"
            },
            "name": {
              "type": "string"
            }
          },
          "type": "object"
        },
        "value": {
          "type": "string"
        },
        "verified": {
          "type": "boolean"
        }
      },
      "type": "object"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "token": {
      "type": "string"
    }
  },
  "type": "object"
}

Edit 2FA Code
PATCH/auth/verify/auth/{auth_id}/code/{code_id}

Edit 2FA Code

Example URI

PATCH /auth/verify/auth/auth_id/code/code_id
URI Parameters
HideShow
auth_id
string (required) 
code_id
string (required) 
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{}
Schema
{
  "properties": {
    "auth": {
      "properties": {
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "method": {
          "properties": {
            "id": {
              "description": "SynergyCP-specific unique identifier used for URLs, etc.",
              "type": "integer"
            },
            "name": {
              "type": "string"
            }
          },
          "type": "object"
        },
        "value": {
          "type": "string"
        },
        "verified": {
          "type": "boolean"
        }
      },
      "type": "object"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "token": {
      "type": "string"
    }
  },
  "type": "object"
}
Response  200
HideShow

A 2 Factor Authentication Code

Headers
Content-Type: application/json
Body
{
  "key": {
    "expires_at": {
      "iso_8601": "aliquip amet minim occaecat",
      "unix": -14824386
    },
    "key": "enim",
    "id": 77358693
  }
}
Schema
{
  "properties": {
    "key": {
      "properties": {
        "expires_at": {
          "properties": {
            "iso_8601": {
              "description": "IS0 8601-formatted Date",
              "type": "string"
            },
            "unix": {
              "description": "Seconds since Unix epoch (Unix Timestamp)",
              "type": "integer"
            }
          },
          "required": [
            "iso_8601",
            "unix"
          ],
          "type": "object"
        },
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "key": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "owner": {
          "properties": {
            "id": {
              "description": "SynergyCP-specific unique identifier used for URLs, etc.",
              "type": "integer"
            },
            "name": {
              "type": "string"
            },
            "url": {
              "type": "string"
            }
          },
          "type": "object"
        }
      },
      "type": "object"
    }
  },
  "type": "object"
}
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{}
Schema
{
  "properties": {
    "auth": {
      "properties": {
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "method": {
          "properties": {
            "id": {
              "description": "SynergyCP-specific unique identifier used for URLs, etc.",
              "type": "integer"
            },
            "name": {
              "type": "string"
            }
          },
          "type": "object"
        },
        "value": {
          "type": "string"
        },
        "verified": {
          "type": "boolean"
        }
      },
      "type": "object"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "token": {
      "type": "string"
    }
  },
  "type": "object"
}
Response  422
HideShow

Unprocessable Entity

Headers
Content-Type: application/json

List 2FA Methods

List 2FA Methods
GET/auth/verify/method

2FA Methods

Example URI

GET /auth/verify/method
Request
HideShow
Headers
Accept: application/json
Response  200
HideShow

2 Factor Auth Methods

Headers
Content-Type: application/json
Body
[
  {
    "id": -31186684
  },
  {},
  {}
]
Schema
{
  "items": {
    "properties": {
      "description": {
        "type": "string"
      },
      "id": {
        "description": "SynergyCP-specific unique identifier used for URLs, etc.",
        "type": "integer"
      },
      "name": {
        "type": "string"
      }
    },
    "type": "object"
  },
  "type": "array"
}

View 2FA Method

View 2FA Method
GET/auth/verify/method/{method_id}

A 2FA Method

Example URI

GET /auth/verify/method/method_id
URI Parameters
HideShow
method_id
string (required) 
Request
HideShow
Headers
Accept: application/json
Response  200
HideShow

A 2 Factor Authentication Method

Headers
Content-Type: application/json
Body
{
  "description": "nisi enim"
}
Schema
{
  "properties": {
    "description": {
      "type": "string"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "name": {
      "type": "string"
    }
  },
  "type": "object"
}

Edit 2FA Method
PATCH/auth/verify/method/{method_id}

Edit 2FA Method

Example URI

PATCH /auth/verify/method/method_id
URI Parameters
HideShow
method_id
string (required) 
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{}
Schema
{
  "properties": {
    "description": {
      "type": "string"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "name": {
      "type": "string"
    }
  },
  "type": "object"
}
Response  200
HideShow

A 2FA Method

Headers
Content-Type: application/json
Body
{
  "name": "nulla no"
}
Schema
{
  "properties": {
    "description": {
      "type": "string"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "name": {
      "type": "string"
    }
  },
  "type": "object"
}
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{}
Schema
{
  "properties": {
    "description": {
      "type": "string"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "name": {
      "type": "string"
    }
  },
  "type": "object"
}
Response  422
HideShow

Unprocessable Entity

Headers
Content-Type: application/json

Other

Other

View Browser Details

View Browser Details
GET/browser-details

View the details about your browser

Example URI

GET /browser-details
Request
HideShow
Headers
Accept: application/json
Response  200
HideShow

Browser Details

Headers
Content-Type: application/json
Body
{
  "ip": "consectetur in"
}
Schema
{
  "properties": {
    "ip": {
      "type": "string"
    }
  },
  "type": "object"
}

Delete SSL Settings

Delete SSL Settings
DELETE/http/ssl

Delete SSL Settings

Example URI

DELETE /http/ssl
Response  200
HideShow

SSL Settings deleted successfully

Response  404
HideShow

Item not Found

View SSL Settings
GET/http/ssl

SSL Information

Example URI

GET /http/ssl
Request
HideShow
Headers
Accept: application/json
Response  200
HideShow

SSL Information

Headers
Content-Type: application/json
Body
{
  "required": true,
  "enabled": true
}
Schema
{
  "properties": {
    "enabled": {
      "type": "boolean"
    },
    "required": {
      "type": "boolean"
    }
  },
  "type": "object"
}

Create SSL Settings
POST/http/ssl

Set new SSL Settings

Example URI

POST /http/ssl
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "email": "com"
}
Schema
{
  "properties": {
    "email": {
      "type": "string"
    }
  },
  "type": "object"
}
Response  200
HideShow

SSL Settings

Headers
Content-Type: application/json
Body
{
  "required": true,
  "enabled": true
}
Schema
{
  "properties": {
    "enabled": {
      "type": "boolean"
    },
    "required": {
      "type": "boolean"
    }
  },
  "type": "object"
}
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "email": "ut"
}
Schema
{
  "properties": {
    "email": {
      "type": "string"
    }
  },
  "type": "object"
}
Response  422
HideShow

Unprocessable Entity

Headers
Content-Type: application/json

Clients

Clients

List Clients

List Clients
GET/client

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

Example URI

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

A list of Clients

Headers
Content-Type: application/json
Body
[
  {
    "id": 1818117,
    "name": "ut",
    "email": "Ut",
    "last": "Ut id quis aliquip",
    "billing": {
      "id": 20768514,
      "ignoreAutoSuspend": true
    }
  },
  {
    "id": -24742866,
    "name": "consequat Lorem ut",
    "email": "ea",
    "billing": {
      "id": -39307190
    },
    "billing_id": 33824546
  },
  {
    "id": -66357078,
    "name": "deserunt in aliqua ullamco magna",
    "email": "ut",
    "created_at": {
      "iso_8601": "nulla ut nisi consec",
      "unix": -39684482
    },
    "billing_id": -87083643
  },
  {
    "id": -70581661,
    "name": "et sed voluptate dolor Duis",
    "email": "tempor a"
  }
]
Schema
{
  "items": {
    "properties": {
      "billing": {
        "properties": {
          "id": {
            "description": "The Billing ID of the API Integration that this client belongs to.",
            "type": "integer"
          },
          "ignoreAutoSuspend": {
            "description": "Tells Synergy that this is a client with VIP status and their servers will never be automatically suspended.",
            "type": "boolean"
          }
        },
        "type": "object"
      },
      "billing_id": {
        "type": "integer"
      },
      "created_at": {
        "properties": {
          "iso_8601": {
            "description": "IS0 8601-formatted Date",
            "type": "string"
          },
          "unix": {
            "description": "Seconds since Unix epoch (Unix Timestamp)",
            "type": "integer"
          }
        },
        "required": [
          "iso_8601",
          "unix"
        ],
        "type": "object"
      },
      "email": {
        "example": "[email protected]",
        "type": "string"
      },
      "first": {
        "type": "string"
      },
      "id": {
        "description": "SynergyCP-specific unique identifier used for URLs, etc.",
        "type": "integer"
      },
      "integration": {
        "properties": {
          "id": {
            "description": "SynergyCP-specific unique identifier used for URLs, etc.",
            "type": "integer"
          },
          "name": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "name"
        ],
        "type": "object"
      },
      "last": {
        "type": "string"
      },
      "name": {
        "type": "string"
      },
      "serversCount": {
        "type": "integer"
      }
    },
    "required": [
      "id",
      "name",
      "email"
    ],
    "type": "object"
  },
  "type": "array"
}

Create Client
POST/client

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

Example URI

POST /client
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "email": "velit veniam",
  "first": "aliqua nisi cillum reprehenderit officia",
  "last": "officia qui dolor",
  "password": "et 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  200
HideShow

A Client

Headers
Content-Type: application/json
Body
{
  "id": -93164074,
  "name": "Excepteur",
  "email": "esse nulla"
}
Schema
{
  "properties": {
    "billing": {
      "properties": {
        "id": {
          "description": "The Billing ID of the API Integration that this client belongs to.",
          "type": "integer"
        },
        "ignoreAutoSuspend": {
          "description": "Tells Synergy that this is a client with VIP status and their servers will never be automatically suspended.",
          "type": "boolean"
        }
      },
      "type": "object"
    },
    "billing_id": {
      "type": "integer"
    },
    "created_at": {
      "properties": {
        "iso_8601": {
          "description": "IS0 8601-formatted Date",
          "type": "string"
        },
        "unix": {
          "description": "Seconds since Unix epoch (Unix Timestamp)",
          "type": "integer"
        }
      },
      "required": [
        "iso_8601",
        "unix"
      ],
      "type": "object"
    },
    "email": {
      "example": "[email protected]",
      "type": "string"
    },
    "first": {
      "type": "string"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "integration": {
      "properties": {
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ],
      "type": "object"
    },
    "last": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "serversCount": {
      "type": "integer"
    }
  },
  "required": [
    "id",
    "name",
    "email"
  ],
  "type": "object"
}
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "email": "est proident adipisicing",
  "first": "consectetur",
  "last": "officia quis"
}
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  422
HideShow

Unprocessable Entity

Headers
Content-Type: application/json

Delete Client

Delete Client
DELETE/client/{client_id}

Delete a client

Example URI

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

Client deleted successfully

Response  404
HideShow

Item not Found

View Client
GET/client/{client_id}

View a specific client

Example URI

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

A Client

Headers
Content-Type: application/json
Body
{
  "id": -80980759,
  "name": "Lorem ipsum sunt dolore aute",
  "email": "tempor ut velit dolor eu",
  "created_at": {
    "iso_8601": "ut est sint cillum",
    "unix": 83786819
  }
}
Schema
{
  "properties": {
    "billing": {
      "properties": {
        "id": {
          "description": "The Billing ID of the API Integration that this client belongs to.",
          "type": "integer"
        },
        "ignoreAutoSuspend": {
          "description": "Tells Synergy that this is a client with VIP status and their servers will never be automatically suspended.",
          "type": "boolean"
        }
      },
      "type": "object"
    },
    "billing_id": {
      "type": "integer"
    },
    "created_at": {
      "properties": {
        "iso_8601": {
          "description": "IS0 8601-formatted Date",
          "type": "string"
        },
        "unix": {
          "description": "Seconds since Unix epoch (Unix Timestamp)",
          "type": "integer"
        }
      },
      "required": [
        "iso_8601",
        "unix"
      ],
      "type": "object"
    },
    "email": {
      "example": "[email protected]",
      "type": "string"
    },
    "first": {
      "type": "string"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "integration": {
      "properties": {
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ],
      "type": "object"
    },
    "last": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "serversCount": {
      "type": "integer"
    },
    "verify": {
      "properties": {
        "require": {
          "type": "boolean"
        }
      },
      "type": "array"
    }
  },
  "required": [
    "id",
    "name",
    "email"
  ],
  "type": "object"
}

Edit Client
PATCH/client/{client_id}

Edit a specific client with new information

Example URI

PATCH /client/client_id
URI Parameters
HideShow
client_id
string (required) 
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "password": "consectetur nulla sed est quis"
}
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  200
HideShow

A Client

Headers
Content-Type: application/json
Body
{
  "id": 78442458,
  "name": "ea ut veniam",
  "email": "minim",
  "serversCount": 46784096,
  "last": "eiusmod ipsum commodo anim culpa",
  "integration": {
    "id": 21864224,
    "name": "nisi aute minim ipsum"
  },
  "billing_id": -93839552
}
Schema
{
  "properties": {
    "billing": {
      "properties": {
        "id": {
          "description": "The Billing ID of the API Integration that this client belongs to.",
          "type": "integer"
        },
        "ignoreAutoSuspend": {
          "description": "Tells Synergy that this is a client with VIP status and their servers will never be automatically suspended.",
          "type": "boolean"
        }
      },
      "type": "object"
    },
    "billing_id": {
      "type": "integer"
    },
    "created_at": {
      "properties": {
        "iso_8601": {
          "description": "IS0 8601-formatted Date",
          "type": "string"
        },
        "unix": {
          "description": "Seconds since Unix epoch (Unix Timestamp)",
          "type": "integer"
        }
      },
      "required": [
        "iso_8601",
        "unix"
      ],
      "type": "object"
    },
    "email": {
      "example": "[email protected]",
      "type": "string"
    },
    "first": {
      "type": "string"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "integration": {
      "properties": {
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ],
      "type": "object"
    },
    "last": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "serversCount": {
      "type": "integer"
    },
    "verify": {
      "properties": {
        "require": {
          "type": "boolean"
        }
      },
      "type": "array"
    }
  },
  "required": [
    "id",
    "name",
    "email"
  ],
  "type": "object"
}
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "billing": {
    "ignoreAutoSuspend": false
  }
}
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  422
HideShow

Unprocessable Entity

Headers
Content-Type: application/json

Send Email to Client

Send Email to Client
POST/client/{client_id}/email

Send Email to a Client

Example URI

POST /client/client_id/email
URI Parameters
HideShow
client_id
string (required) 
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "type": "culpa deserunt"
}
Schema
{
  "properties": {
    "type": {
      "type": "string"
    }
  },
  "required": [
    "type"
  ],
  "type": "object"
}
Response  200
HideShow

Sent an email to one client.

Headers
Content-Type: application/json
Body
[
  {},
  {},
  {
    "text": "magna",
    "type": "anim eu elit veniam"
  }
]
Schema
{
  "items": {
    "properties": {
      "text": {
        "type": "string"
      },
      "type": {
        "type": "string"
      }
    },
    "type": "object"
  },
  "type": "array"
}
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "type": "in minim enim"
}
Schema
{
  "properties": {
    "type": {
      "type": "string"
    }
  },
  "required": [
    "type"
  ],
  "type": "object"
}
Response  422
HideShow

Unprocessable Entity

Headers
Content-Type: application/json

Sub Clients

Sub Clients

List Sub Clients

List Sub Clients
GET/client/{client_id}/sub

List all Sub Clients of {client_id}

Example URI

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

A list of Sub Clients

Headers
Content-Type: application/json
Body
[
  {
    "id": 50722685,
    "eu6": 79902570,
    "enima": 99289055
  },
  {
    "id": 4801743,
    "Duis0": true
  },
  {
    "id": -93140099,
    "sintc": "commodo sint"
  },
  {
    "id": -27462329,
    "velit5f9": -14053823
  },
  {
    "id": -82567288,
    "child": {
      "name": "amet aliqua"
    },
    "laboris35d": 2020742
  }
]
Schema
{
  "items": {
    "properties": {
      "child": {
        "properties": {
          "created_at": {
            "properties": {
              "iso_8601": {
                "description": "IS0 8601-formatted Date",
                "type": "string"
              },
              "unix": {
                "description": "Seconds since Unix epoch (Unix Timestamp)",
                "type": "integer"
              }
            },
            "required": [
              "iso_8601",
              "unix"
            ],
            "type": "object"
          },
          "email": {
            "example": "[email protected]",
            "type": "string"
          },
          "first": {
            "type": "string"
          },
          "id": {
            "description": "SynergyCP-specific unique identifier used for URLs, etc.",
            "type": "integer"
          },
          "integration": {
            "properties": {
              "id": {
                "description": "SynergyCP-specific unique identifier used for URLs, etc.",
                "type": "integer"
              },
              "name": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "name"
            ],
            "type": "object"
          },
          "last": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "serversCount": {
            "type": "integer"
          }
        },
        "type": "object"
      },
      "id": {
        "description": "The Unique ID that represents the relationship between the Client and Sub Client.",
        "type": "integer"
      }
    },
    "required": [
      "id",
      "name",
      "email"
    ],
    "type": "object"
  },
  "type": "array"
}

Create Sub Client
POST/client/{client_id}/sub

Create a new Sub Client of {client_id}

Example URI

POST /client/client_id/sub
URI Parameters
HideShow
client_id
string (required) 
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "client_id": 84850633
}
Schema
{
  "properties": {
    "client_id": {
      "type": "integer"
    }
  },
  "required": [
    "client_id"
  ]
}
Response  200
HideShow

A Sub Client

Headers
Content-Type: application/json
Body
{
  "id": 3285623,
  "child": {
    "id": -37532856,
    "serversCount": 81778184,
    "first": "est aliqua"
  },
  "aliqua83": "dolor"
}
Schema
{
  "properties": {
    "child": {
      "properties": {
        "created_at": {
          "properties": {
            "iso_8601": {
              "description": "IS0 8601-formatted Date",
              "type": "string"
            },
            "unix": {
              "description": "Seconds since Unix epoch (Unix Timestamp)",
              "type": "integer"
            }
          },
          "required": [
            "iso_8601",
            "unix"
          ],
          "type": "object"
        },
        "email": {
          "example": "[email protected]",
          "type": "string"
        },
        "first": {
          "type": "string"
        },
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "integration": {
          "properties": {
            "id": {
              "description": "SynergyCP-specific unique identifier used for URLs, etc.",
              "type": "integer"
            },
            "name": {
              "type": "string"
            }
          },
          "required": [
            "id",
            "name"
          ],
          "type": "object"
        },
        "last": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "serversCount": {
          "type": "integer"
        }
      },
      "type": "object"
    },
    "id": {
      "description": "The Unique ID that represents the relationship between the Client and Sub Client.",
      "type": "integer"
    }
  },
  "required": [
    "id",
    "name",
    "email"
  ],
  "type": "object"
}
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "client_id": 43909808
}
Schema
{
  "properties": {
    "client_id": {
      "type": "integer"
    }
  },
  "required": [
    "client_id"
  ]
}
Response  422
HideShow

Unprocessable Entity

Headers
Content-Type: application/json

Delete Sub Client

Delete Sub Client
DELETE/client/{client_id}/sub/{sub_id}

Delete a sub client

Example URI

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

One Sub Client deleted

Response  404
HideShow

Item not Found

View Sub Client
GET/client/{client_id}/sub/{sub_id}

View a specific sub client

Example URI

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

A Sub Client

Headers
Content-Type: application/json
Body
{
  "id": -71221544,
  "dolore5": -2411885,
  "commodo3": "culpa voluptate anim"
}
Schema
{
  "properties": {
    "child": {
      "properties": {
        "created_at": {
          "properties": {
            "iso_8601": {
              "description": "IS0 8601-formatted Date",
              "type": "string"
            },
            "unix": {
              "description": "Seconds since Unix epoch (Unix Timestamp)",
              "type": "integer"
            }
          },
          "required": [
            "iso_8601",
            "unix"
          ],
          "type": "object"
        },
        "email": {
          "example": "[email protected]",
          "type": "string"
        },
        "first": {
          "type": "string"
        },
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "integration": {
          "properties": {
            "id": {
              "description": "SynergyCP-specific unique identifier used for URLs, etc.",
              "type": "integer"
            },
            "name": {
              "type": "string"
            }
          },
          "required": [
            "id",
            "name"
          ],
          "type": "object"
        },
        "last": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "serversCount": {
          "type": "integer"
        }
      },
      "type": "object"
    },
    "id": {
      "description": "The Unique ID that represents the relationship between the Client and Sub Client.",
      "type": "integer"
    }
  },
  "required": [
    "id",
    "name",
    "email"
  ],
  "type": "object"
}

Edit Sub Client
PATCH/client/{client_id}/sub/{sub_id}

Edit a specific sub client

Example URI

PATCH /client/client_id/sub/sub_id
URI Parameters
HideShow
client_id
string (required) 
sub_id
string (required) 
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "email": "laboris dolor occaecat",
  "password": "exercitation occaecat adipisicing"
}
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  200
HideShow

New Sub Client Information

Headers
Content-Type: application/json
Body
{
  "id": -25473978,
  "child": {
    "first": "fugiat amet officia",
    "last": "culpa proident est dolor"
  },
  "pariatura24": "cupidatat nisi quis magna fugiat"
}
Schema
{
  "properties": {
    "child": {
      "properties": {
        "created_at": {
          "properties": {
            "iso_8601": {
              "description": "IS0 8601-formatted Date",
              "type": "string"
            },
            "unix": {
              "description": "Seconds since Unix epoch (Unix Timestamp)",
              "type": "integer"
            }
          },
          "required": [
            "iso_8601",
            "unix"
          ],
          "type": "object"
        },
        "email": {
          "example": "[email protected]",
          "type": "string"
        },
        "first": {
          "type": "string"
        },
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "integration": {
          "properties": {
            "id": {
              "description": "SynergyCP-specific unique identifier used for URLs, etc.",
              "type": "integer"
            },
            "name": {
              "type": "string"
            }
          },
          "required": [
            "id",
            "name"
          ],
          "type": "object"
        },
        "last": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "serversCount": {
          "type": "integer"
        }
      },
      "type": "object"
    },
    "id": {
      "description": "The Unique ID that represents the relationship between the Client and Sub Client.",
      "type": "integer"
    }
  },
  "required": [
    "id",
    "name",
    "email"
  ],
  "type": "object"
}
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{}
Schema
{
  "properties": {
    "billing": {
      "properties": {
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "ignoreAutoSuspend": {
          "type": "boolean"
        },
        "integration": {
          "properties": {
            "id": {
              "description": "SynergyCP-specific unique identifier used for URLs, etc.",
              "type": "integer"
            }
          },
          "type": "object"
        }
      },
      "type": "object"
    },
    "email": {
      "example": "[email protected]",
      "type": "string"
    },
    "first": {
      "type": "string"
    },
    "last": {
      "type": "string"
    },
    "password": {
      "type": "string"
    }
  }
}
Response  422
HideShow

Unprocessable Entity

Headers
Content-Type: application/json

Super Clients

Super Clients

List Super Clients

List Super Clients
GET/client/{client_id}/super

List all Super Clients of {client_id}

Example URI

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

A list of Super Clients

Headers
Content-Type: application/json
Body
[
  {
    "id": 97235149
  },
  {
    "id": 67623668,
    "grantee": {
      "name": "nisi",
      "id": -88001803
    }
  },
  {
    "id": -20697324,
    "grantee": {
      "name": "dolore officia dolor non proident",
      "id": 41718592
    }
  },
  {
    "id": 10408308,
    "culpac": "nisi anim exercitation aliquip mollit"
  }
]
Schema
{
  "items": {
    "properties": {
      "grantee": {
        "properties": {
          "id": {
            "description": "SynergyCP-specific unique identifier used for URLs, etc.",
            "type": "integer"
          },
          "name": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "id": {
        "description": "The Unique ID that represents the relationship between the Client and Sub Client.",
        "type": "integer"
      }
    },
    "required": [
      "id",
      "name"
    ],
    "type": "object"
  },
  "type": "array"
}

Create Super Client
POST/client/{client_id}/super

Create a new Super Client of {client_id}

Example URI

POST /client/client_id/super
URI Parameters
HideShow
client_id
string (required) 
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "client_id": 38678336
}
Schema
{
  "properties": {
    "client_id": {
      "type": "integer"
    }
  },
  "required": [
    "client_id"
  ]
}
Response  200
HideShow

A Super Client

Headers
Content-Type: application/json
Body
{
  "id": -53800603
}
Schema
{
  "properties": {
    "grantee": {
      "properties": {
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "name": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "id": {
      "description": "The Unique ID that represents the relationship between the Client and Sub Client.",
      "type": "integer"
    }
  },
  "required": [
    "id",
    "name"
  ],
  "type": "object"
}
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "client_id": -81036701
}
Schema
{
  "properties": {
    "client_id": {
      "type": "integer"
    }
  },
  "required": [
    "client_id"
  ]
}
Response  422
HideShow

Unprocessable Entity

Headers
Content-Type: application/json

Delete Super Client

Delete Super Client
DELETE/client/{client_id}/super/{super_id}

Delete a super client

Example URI

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

One Super Client deleted

Response  404
HideShow

Item not Found

View Super Client
GET/client/{client_id}/super/{super_id}

View a specific super client

Example URI

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

A Super Client

Headers
Content-Type: application/json
Body
{
  "id": -22222357,
  "incididuntc": 89489097
}
Schema
{
  "properties": {
    "grantee": {
      "properties": {
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "name": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "id": {
      "description": "The Unique ID that represents the relationship between the Client and Sub Client.",
      "type": "integer"
    }
  },
  "required": [
    "id",
    "name"
  ],
  "type": "object"
}

Edit Super Client
PATCH/client/{client_id}/super/{super_id}

Edit a specific super client

Example URI

PATCH /client/client_id/super/super_id
URI Parameters
HideShow
client_id
string (required) 
super_id
string (required) 
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "password": "cillum anim sunt dolore dolore",
  "email": "in adipisicing irure ut minim",
  "first": "cupidatat dolor mollit ad",
  "last": "oc"
}
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  200
HideShow

A Super Client

Headers
Content-Type: application/json
Body
{
  "id": 63083505,
  "magna44": false
}
Schema
{
  "properties": {
    "grantee": {
      "properties": {
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "name": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "id": {
      "description": "The Unique ID that represents the relationship between the Client and Sub Client.",
      "type": "integer"
    }
  },
  "required": [
    "id",
    "name"
  ],
  "type": "object"
}
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "first": "sint est occaecat Lorem",
  "password": "labore laborum incididunt"
}
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  422
HideShow

Unprocessable Entity

Headers
Content-Type: application/json

Email Templates

Email Templates

List Email Templates

List Email Templates
GET/email/template

List of Email Templates

Example URI

GET /email/template
Request
HideShow
Headers
Accept: application/json
Response  200
HideShow

A List of Email Templates

Headers
Content-Type: application/json
Body
[
  {
    "id": 2073360,
    "body": "irure Excepteur est ad sed"
  },
  {},
  {}
]
Schema
{
  "items": {
    "properties": {
      "body": {
        "type": "string"
      },
      "id": {
        "description": "SynergyCP-specific unique identifier used for URLs, etc.",
        "type": "integer"
      },
      "name": {
        "type": "string"
      },
      "subject": {
        "type": "string"
      }
    }
  },
  "type": "array"
}

Create Email Template
POST/email/template

Create a new Email Template

Example URI

POST /email/template
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "name": "qui dolore aliquip ",
  "subject": "voluptate non tempor sint ali",
  "body": "tempor aute cillum",
  "id": -58776907
}
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  200
HideShow

An Email Template

Headers
Content-Type: application/json
Body
{
  "name": "cillum non ad ut",
  "body": "Lorem dolore ex cillum laboris"
}
Schema
{
  "properties": {
    "body": {
      "type": "string"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "name": {
      "type": "string"
    },
    "subject": {
      "type": "string"
    }
  }
}
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "name": "exercitation est",
  "subject": "dolor qui velit Duis",
  "body": "dolor aliquip ut et"
}
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  422
HideShow

Unprocessable Entity

Headers
Content-Type: application/json

Delete Email Template

Delete Email Template
DELETE/email/template/{template_id}

Delete an Email Template

Example URI

DELETE /email/template/template_id
URI Parameters
HideShow
template_id
string (required) 
Response  200
HideShow

Email Template deleted successfully

Response  404
HideShow

Item not Found

View Email Template
GET/email/template/{template_id}

An Email Template

Example URI

GET /email/template/template_id
URI Parameters
HideShow
template_id
string (required) 
Request
HideShow
Headers
Accept: application/json
Response  200
HideShow

An Email Template

Headers
Content-Type: application/json
Body
{}
Schema
{
  "properties": {
    "body": {
      "type": "string"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "name": {
      "type": "string"
    },
    "subject": {
      "type": "string"
    }
  }
}

Edit Email Template
PATCH/email/template/{template_id}

Edit Email Template

Example URI

PATCH /email/template/template_id
URI Parameters
HideShow
template_id
string (required) 
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "name": "consequat et id labore",
  "subject": "laborum anim fugiat",
  "body": "et ad reprehenderit",
  "id": -89275196
}
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  200
HideShow

An Email Template

Headers
Content-Type: application/json
Body
{
  "name": "eiusmod proident mini"
}
Schema
{
  "properties": {
    "body": {
      "type": "string"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "name": {
      "type": "string"
    },
    "subject": {
      "type": "string"
    }
  }
}
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "name": "aliqua sunt do in",
  "subject": "anim in in",
  "body": "non magna deserunt",
  "id": 62940581
}
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  422
HideShow

Unprocessable Entity

Headers
Content-Type: application/json

IP Entities

IP Entities

List IP Entities

List IP Entities
GET/entity

List of IP Entities

Example URI

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

A List of IP Entities

Headers
Content-Type: application/json
Body
[
  {
    "billing_id": "voluptate aliquip dolore do elit",
    "v6_gateway": "elit culpa dolore",
    "vlan": -46214993,
    "owner": {
      "name": "sed aute deserunt",
      "id": -63518543
    }
  },
  {},
  {
    "name": "ea in minim pariatur",
    "address": "pariatur dolor aute qui"
  }
]
Schema
{
  "items": {
    "properties": {
      "address": {
        "type": "string"
      },
      "billing_id": {
        "type": "string"
      },
      "full_ip": {
        "type": "string"
      },
      "gateway": {
        "type": "string"
      },
      "group": {
        "properties": {
          "id": {
            "description": "SynergyCP-specific unique identifier used for URLs, etc.",
            "type": "integer"
          },
          "name": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "id": {
        "description": "SynergyCP-specific unique identifier used for URLs, etc.",
        "type": "integer"
      },
      "name": {
        "type": "string"
      },
      "nickname": {
        "type": "string"
      },
      "owner": {
        "properties": {
          "id": {
            "description": "SynergyCP-specific unique identifier used for URLs, etc.",
            "type": "integer"
          },
          "name": {
            "type": "string"
          },
          "server": {
            "properties": {
              "id": {
                "description": "SynergyCP-specific unique identifier used for URLs, etc.",
                "type": "integer"
              },
              "name": {
                "type": "string"
              }
            },
            "type": "object"
          }
        },
        "type": "object"
      },
      "siblings_count": {
        "type": "integer"
      },
      "subnet_mask": {
        "type": "string"
      },
      "v4": {
        "properties": {
          "address": {
            "type": "string"
          },
          "full": {
            "type": "string"
          },
          "gateway": {
            "type": "string"
          },
          "range_end": {
            "type": "string"
          },
          "subnet_mask": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "v6": {
        "properties": {
          "address": {
            "type": "string"
          },
          "gateway": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "v6_address": {
        "type": "string"
      },
      "v6_gateway": {
        "type": "string"
      },
      "vlan": {
        "type": "integer"
      }
    },
    "type": "object"
  },
  "type": "array"
}

Create IP Entity
POST/entity

Create a new IP Entity

Example URI

POST /entity
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "owner": {
    "id": -82242077
  }
}
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  200
HideShow

An IP Entity

Headers
Content-Type: application/json
Body
{}
Schema
{
  "properties": {
    "address": {
      "type": "string"
    },
    "billing_id": {
      "type": "string"
    },
    "full_ip": {
      "type": "string"
    },
    "gateway": {
      "type": "string"
    },
    "group": {
      "properties": {
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "name": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "name": {
      "type": "string"
    },
    "nickname": {
      "type": "string"
    },
    "owner": {
      "properties": {
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "name": {
          "type": "string"
        },
        "server": {
          "properties": {
            "id": {
              "description": "SynergyCP-specific unique identifier used for URLs, etc.",
              "type": "integer"
            },
            "name": {
              "type": "string"
            }
          },
          "type": "object"
        }
      },
      "type": "object"
    },
    "siblings_count": {
      "type": "integer"
    },
    "subnet_mask": {
      "type": "string"
    },
    "v4": {
      "properties": {
        "address": {
          "type": "string"
        },
        "full": {
          "type": "string"
        },
        "gateway": {
          "type": "string"
        },
        "range_end": {
          "type": "string"
        },
        "subnet_mask": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "v6": {
      "properties": {
        "address": {
          "type": "string"
        },
        "gateway": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "v6_address": {
      "type": "string"
    },
    "v6_gateway": {
      "type": "string"
    },
    "vlan": {
      "type": "integer"
    }
  },
  "type": "object"
}
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "billing_id": "elit occaecat qui irure",
  "v6_gateway": "anim Duis ullamco dolore",
  "name": "consectetur amet ex consequat"
}
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  422
HideShow

Unprocessable Entity

Headers
Content-Type: application/json

Delete IP Entity

Delete IP Entity
DELETE/entity/{entity_id}

Delete an IP Entity

Example URI

DELETE /entity/entity_id
URI Parameters
HideShow
entity_id
string (required) 
Response  200
HideShow

IP Entity deleted successfully

Response  404
HideShow

Item not Found

View IP Entity
GET/entity/{entity_id}

An IP Entity

Example URI

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

An IP Entity

Headers
Content-Type: application/json
Body
{
  "subnet_mask": "Excepteur"
}
Schema
{
  "properties": {
    "address": {
      "type": "string"
    },
    "billing_id": {
      "type": "string"
    },
    "full_ip": {
      "type": "string"
    },
    "gateway": {
      "type": "string"
    },
    "group": {
      "properties": {
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "name": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "name": {
      "type": "string"
    },
    "nickname": {
      "type": "string"
    },
    "owner": {
      "properties": {
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "name": {
          "type": "string"
        },
        "server": {
          "properties": {
            "id": {
              "description": "SynergyCP-specific unique identifier used for URLs, etc.",
              "type": "integer"
            },
            "name": {
              "type": "string"
            }
          },
          "type": "object"
        }
      },
      "type": "object"
    },
    "siblings_count": {
      "type": "integer"
    },
    "subnet_mask": {
      "type": "string"
    },
    "v4": {
      "properties": {
        "address": {
          "type": "string"
        },
        "full": {
          "type": "string"
        },
        "gateway": {
          "type": "string"
        },
        "range_end": {
          "type": "string"
        },
        "subnet_mask": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "v6": {
      "properties": {
        "address": {
          "type": "string"
        },
        "gateway": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "v6_address": {
      "type": "string"
    },
    "v6_gateway": {
      "type": "string"
    },
    "vlan": {
      "type": "integer"
    }
  },
  "type": "object"
}

Edit IP Entity
PATCH/entity/{entity_id}

Edit IP Entity

Example URI

PATCH /entity/entity_id
URI Parameters
HideShow
entity_id
string (required) 
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "siblings_count": -52015044,
  "full_ip": "velit aliquip",
  "nickname": "ea non aute laborum",
  "subnet_mask": "dolor Lor"
}
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  200
HideShow

An IP Entity

Headers
Content-Type: application/json
Body
{
  "v6": {
    "gateway": "ea dolor eiusmod qui",
    "address": "cupidatat qui consequat incididunt labore"
  }
}
Schema
{
  "properties": {
    "address": {
      "type": "string"
    },
    "billing_id": {
      "type": "string"
    },
    "full_ip": {
      "type": "string"
    },
    "gateway": {
      "type": "string"
    },
    "group": {
      "properties": {
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "name": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "name": {
      "type": "string"
    },
    "nickname": {
      "type": "string"
    },
    "owner": {
      "properties": {
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "name": {
          "type": "string"
        },
        "server": {
          "properties": {
            "id": {
              "description": "SynergyCP-specific unique identifier used for URLs, etc.",
              "type": "integer"
            },
            "name": {
              "type": "string"
            }
          },
          "type": "object"
        }
      },
      "type": "object"
    },
    "siblings_count": {
      "type": "integer"
    },
    "subnet_mask": {
      "type": "string"
    },
    "v4": {
      "properties": {
        "address": {
          "type": "string"
        },
        "full": {
          "type": "string"
        },
        "gateway": {
          "type": "string"
        },
        "range_end": {
          "type": "string"
        },
        "subnet_mask": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "v6": {
      "properties": {
        "address": {
          "type": "string"
        },
        "gateway": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "v6_address": {
      "type": "string"
    },
    "v6_gateway": {
      "type": "string"
    },
    "vlan": {
      "type": "integer"
    }
  },
  "type": "object"
}
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{}
Schema
{
  "properties": {
    "address": {
      "type": "string"
    },
    "billing_id": {
      "type": "string"
    },
    "full_ip": {
      "type": "string"
    },
    "gateway": {
      "type": "string"
    },
    "group": {
      "properties": {
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "name": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "name": {
      "type": "string"
    },
    "nickname": {
      "type": "string"
    },
    "owner": {
      "properties": {
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "name": {
          "type": "string"
        },
        "server": {
          "properties": {
            "id": {
              "description": "SynergyCP-specific unique identifier used for URLs, etc.",
              "type": "integer"
            },
            "name": {
              "type": "string"
            }
          },
          "type": "object"
        }
      },
      "type": "object"
    },
    "siblings_count": {
      "type": "integer"
    },
    "subnet_mask": {
      "type": "string"
    },
    "v4": {
      "properties": {
        "address": {
          "type": "string"
        },
        "full": {
          "type": "string"
        },
        "gateway": {
          "type": "string"
        },
        "range_end": {
          "type": "string"
        },
        "subnet_mask": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "v6": {
      "properties": {
        "address": {
          "type": "string"
        },
        "gateway": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "v6_address": {
      "type": "string"
    },
    "v6_gateway": {
      "type": "string"
    },
    "vlan": {
      "type": "integer"
    }
  },
  "type": "object"
}
Response  422
HideShow

Unprocessable Entity

Headers
Content-Type: application/json

Fields

Fields

List Fields

List Fields
GET/field

List of Fields

Example URI

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

A List of Fields

Headers
Content-Type: application/json
Body
[
  {},
  {
    "slug": "esse"
  },
  {
    "type": "string"
  },
  {}
]
Schema
{
  "items": {
    "properties": {
      "default": {
        "type": "string"
      },
      "desc": {
        "type": "string"
      },
      "id": {
        "description": "SynergyCP-specific unique identifier used for URLs, etc.",
        "type": "integer"
      },
      "name": {
        "type": "string"
      },
      "placeholder": {
        "type": "string"
      },
      "slug": {
        "type": "string"
      },
      "target_type": {
        "type": "string"
      }
    },
    "type": "object"
  },
  "type": "array"
}

View Field

View Field
GET/field/{field_id}

Field Information

Example URI

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

Field Information

Headers
Content-Type: application/json
Body
{}
Schema
{
  "properties": {
    "default": {
      "type": "string"
    },
    "desc": {
      "type": "string"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "name": {
      "type": "string"
    },
    "placeholder": {
      "type": "string"
    },
    "slug": {
      "type": "string"
    },
    "target_type": {
      "type": "string"
    }
  },
  "type": "object"
}

List Field Values

List Field Values
GET/field/{field_id}/value

Field Values

Example URI

GET /field/field_id/value
URI Parameters
HideShow
field_id
string (required) 
Request
HideShow
Headers
Accept: application/json
Response  200
HideShow

Field Values

Headers
Content-Type: application/json
Body
{
  "id": -65763632
}
Schema
{
  "properties": {
    "field_id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "target_id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "value": {
      "type": "string"
    }
  },
  "type": "object"
}

View Field Value

View Field Value
GET/field/{field_id}/value/{value_id}

Field Value

Example URI

GET /field/field_id/value/value_id
URI Parameters
HideShow
field_id
string (required) 
value_id
string (required) 
Request
HideShow
Headers
Accept: application/json
Response  200
HideShow

A Field Value

Headers
Content-Type: application/json
Body
{
  "id": 94419312,
  "target_id": 21577247
}
Schema
{
  "properties": {
    "field_id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "target_id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "value": {
      "type": "string"
    }
  },
  "type": "object"
}

Forwarding Gateways

Forwarding Gateways

List Forwarding Gateways

List Forwarding Gateways
GET/forward/gateway

List of Forwarding Gateways

Example URI

GET /forward/gateway
Request
HideShow
Headers
Accept: application/json
Response  200
HideShow

A List of Forwarding Gateways

Headers
Content-Type: application/json
Body
[
  {
    "name": "dolor quis veniam in qui",
    "hostname": "offic",
    "api_key": "aute",
    "culpa3": 80251371
  },
  {
    "name": "Duis irure quis",
    "hostname": "aute magna in in culpa",
    "Duise": "ex ut adipisicing",
    "dolorc09": -83328749
  }
]
Schema
{
  "items": {
    "properties": {
      "api_key": {
        "type": "string"
      },
      "groups": {
        "items": {
          "properties": {
            "id": {
              "description": "SynergyCP-specific unique identifier used for URLs, etc.",
              "type": "integer"
            },
            "name": {
              "type": "string"
            }
          },
          "type": "object"
        },
        "type": "array"
      },
      "hostname": {
        "type": "string"
      },
      "id": {
        "description": "SynergyCP-specific unique identifier used for URLs, etc.",
        "type": "integer"
      },
      "name": {
        "type": "string"
      },
      "port_limit": {
        "type": "string"
      }
    },
    "required": [
      "name",
      "apikey",
      "hostname",
      "port limit"
    ]
  },
  "type": "array"
}

Create Forwarding Gateway
POST/forward/gateway

Create a new Forwarding Gateway

Example URI

POST /forward/gateway
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "name": "laborum qui sint cillum",
  "hostname": "anim",
  "nonde3": 4970680,
  "commodo5a9": -14364936
}
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  200
HideShow

A Forwarding Gateway

Headers
Content-Type: application/json
Body
{
  "name": "est mollit esse",
  "hostname": "ea mollit dolore",
  "id": 65209348,
  "aliqua0": "nulla non laboris cupidatat"
}
Schema
{
  "properties": {
    "api_key": {
      "type": "string"
    },
    "groups": {
      "items": {
        "properties": {
          "id": {
            "description": "SynergyCP-specific unique identifier used for URLs, etc.",
            "type": "integer"
          },
          "name": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "type": "array"
    },
    "hostname": {
      "type": "string"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "name": {
      "type": "string"
    },
    "port_limit": {
      "type": "string"
    }
  },
  "required": [
    "name",
    "apikey",
    "hostname",
    "port limit"
  ]
}
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "name": "consequat exercitation cillum ad consectetur",
  "hostname": "laboris cillum laborum",
  "occaecatb0c": true,
  "officia19": false
}
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  422
HideShow

Unprocessable Entity

Headers
Content-Type: application/json

Delete Forwarding Gateway

Delete Forwarding Gateway
DELETE/forward/gateway/{gateway_id}

Delete a Forwarding Gateway

Example URI

DELETE /forward/gateway/gateway_id
URI Parameters
HideShow
gateway_id
string (required) 
Response  200
HideShow

Forwarding Gateway deleted successfully

Response  404
HideShow

Item not Found

View Forwarding Gateway
GET/forward/gateway/{gateway_id}

A Forwarding Gateway

Example URI

GET /forward/gateway/gateway_id
URI Parameters
HideShow
gateway_id
string (required) 
Request
HideShow
Headers
Accept: application/json
Response  200
HideShow

A Forwarding Gateway

Headers
Content-Type: application/json
Body
{
  "name": "sint consectetur",
  "hostname": "consequat adipisicing ",
  "groups": [
    {
      "id": -88114587,
      "name": "nostrud Ut anim"
    },
    {
      "name": "sint tempor cillum pariatur in"
    }
  ],
  "port_limit": "irure fugiat eu"
}
Schema
{
  "properties": {
    "api_key": {
      "type": "string"
    },
    "groups": {
      "items": {
        "properties": {
          "id": {
            "description": "SynergyCP-specific unique identifier used for URLs, etc.",
            "type": "integer"
          },
          "name": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "type": "array"
    },
    "hostname": {
      "type": "string"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "name": {
      "type": "string"
    },
    "port_limit": {
      "type": "string"
    }
  },
  "required": [
    "name",
    "apikey",
    "hostname",
    "port limit"
  ]
}

Edit Forwarding Gateway
PATCH/forward/gateway/{gateway_id}

Edit Forwarding Gateway

Example URI

PATCH /forward/gateway/gateway_id
URI Parameters
HideShow
gateway_id
string (required) 
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "name": "ullamco",
  "hostname": "fugiat ",
  "groups": [
    {
      "id": 73822662
    },
    {
      "id": -54495618,
      "name": "occaecat sed"
    }
  ],
  "id": 85240404,
  "api_key": "est do Lorem ex"
}
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  200
HideShow

A Forwarding Gateway

Headers
Content-Type: application/json
Body
{
  "name": "laborum magna esse",
  "hostname": "ad",
  "port_limit": "occaecat ipsum exercitation adipisicing",
  "sed5": 16001044
}
Schema
{
  "properties": {
    "api_key": {
      "type": "string"
    },
    "groups": {
      "items": {
        "properties": {
          "id": {
            "description": "SynergyCP-specific unique identifier used for URLs, etc.",
            "type": "integer"
          },
          "name": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "type": "array"
    },
    "hostname": {
      "type": "string"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "name": {
      "type": "string"
    },
    "port_limit": {
      "type": "string"
    }
  },
  "required": [
    "name",
    "apikey",
    "hostname",
    "port limit"
  ]
}
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "name": "cillum tempor occaecat fugiat",
  "hostname": "est",
  "port_limit": "in",
  "api_key": "adipisicing"
}
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  422
HideShow

Unprocessable Entity

Headers
Content-Type: application/json

List Forwarding Types

List Forwarding Types
GET/forward/type

List of Forwarding Types

Example URI

GET /forward/type
Request
HideShow
Headers
Accept: application/json
Response  200
HideShow

A List of Forwarding Types

Headers
Content-Type: application/json
Body
[
  {
    "id": 76229217
  }
]
Schema
{
  "items": {
    "properties": {
      "id": {
        "description": "SynergyCP-specific unique identifier used for URLs, etc.",
        "type": "integer"
      },
      "name": {
        "type": "string"
      },
      "slug": {
        "type": "string"
      }
    }
  },
  "type": "array"
}

View Forwarding Type

View Forwarding Type
GET/forward/type/{type_id}

Forwarding Type Information

Example URI

GET /forward/type/type_id
URI Parameters
HideShow
type_id
string (required) 
Request
HideShow
Headers
Accept: application/json
Response  200
HideShow

Forwarding Type Information

Headers
Content-Type: application/json
Body
{}
Schema
{
  "properties": {
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "name": {
      "type": "string"
    },
    "slug": {
      "type": "string"
    }
  }
}

IP Groups

IP Groups

List IP Groups

List IP Groups
GET/group

List of IP Groups

Example URI

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

A List of IP Groups

Headers
Content-Type: application/json
Body
[
  {
    "billing_id": "deserunt id commodo consequat magn",
    "name": "proident id eu Ut reprehenderit",
    "entitiesCount": -38122705
  },
  {},
  {
    "entitiesCount": -61572689,
    "servers": {
      "count": 97827262,
      "inventory": 59252799
    }
  },
  {
    "id": 47728828
  }
]
Schema
{
  "items": {
    "properties": {
      "billing_id": {
        "type": "string"
      },
      "entities": {
        "properties": {
          "count": {
            "type": "integer"
          }
        },
        "type": "object"
      },
      "entitiesCount": {
        "type": "integer"
      },
      "id": {
        "description": "SynergyCP-specific unique identifier used for URLs, etc.",
        "type": "integer"
      },
      "name": {
        "type": "string"
      },
      "pxe_dhcp_server": {
        "properties": {
          "id": {
            "description": "SynergyCP-specific unique identifier used for URLs, etc.",
            "type": "integer"
          },
          "name": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "reserved": {
        "type": "boolean"
      },
      "servers": {
        "properties": {
          "count": {
            "type": "integer"
          },
          "inventory": {
            "type": "integer"
          }
        },
        "type": "object"
      }
    }
  },
  "type": "array"
}

Create IP Group
POST/group

Create a new IP Group

Example URI

POST /group
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{}
Schema
{
  "properties": {
    "billing_id": {
      "type": "string"
    },
    "entities": {
      "properties": {
        "count": {
          "type": "integer"
        }
      },
      "type": "object"
    },
    "entitiesCount": {
      "type": "integer"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "name": {
      "type": "string"
    },
    "pxe_dhcp_server": {
      "properties": {
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "name": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "reserved": {
      "type": "boolean"
    },
    "servers": {
      "properties": {
        "count": {
          "type": "integer"
        },
        "inventory": {
          "type": "integer"
        }
      },
      "type": "object"
    }
  }
}
Response  200
HideShow

An IP Group

Headers
Content-Type: application/json
Body
{
  "reserved": true
}
Schema
{
  "properties": {
    "billing_id": {
      "type": "string"
    },
    "entities": {
      "properties": {
        "count": {
          "type": "integer"
        }
      },
      "type": "object"
    },
    "entitiesCount": {
      "type": "integer"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "name": {
      "type": "string"
    },
    "pxe_dhcp_server": {
      "properties": {
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "name": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "reserved": {
      "type": "boolean"
    },
    "servers": {
      "properties": {
        "count": {
          "type": "integer"
        },
        "inventory": {
          "type": "integer"
        }
      },
      "type": "object"
    }
  }
}
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "entitiesCount": 62256765
}
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  422
HideShow

Unprocessable Entity

Headers
Content-Type: application/json

Delete IP Group

Delete IP Group
DELETE/group/{group_id}

Delete an IP Group

Example URI

DELETE /group/group_id
URI Parameters
HideShow
group_id
string (required) 
Response  200
HideShow

IP Group deleted successfully

Response  404
HideShow

Item not Found

View IP Group
GET/group/{group_id}

An IP Group

Example URI

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

An IP Group

Headers
Content-Type: application/json
Body
{}
Schema
{
  "properties": {
    "billing_id": {
      "type": "string"
    },
    "entities": {
      "properties": {
        "count": {
          "type": "integer"
        }
      },
      "type": "object"
    },
    "entitiesCount": {
      "type": "integer"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "name": {
      "type": "string"
    },
    "pxe_dhcp_server": {
      "properties": {
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "name": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "reserved": {
      "type": "boolean"
    },
    "servers": {
      "properties": {
        "count": {
          "type": "integer"
        },
        "inventory": {
          "type": "integer"
        }
      },
      "type": "object"
    }
  }
}

Edit IP Group
PATCH/group/{group_id}

Edit IP Group

Example URI

PATCH /group/group_id
URI Parameters
HideShow
group_id
string (required) 
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{}
Schema
{
  "properties": {
    "billing_id": {
      "type": "string"
    },
    "entities": {
      "properties": {
        "count": {
          "type": "integer"
        }
      },
      "type": "object"
    },
    "entitiesCount": {
      "type": "integer"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "name": {
      "type": "string"
    },
    "pxe_dhcp_server": {
      "properties": {
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "name": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "reserved": {
      "type": "boolean"
    },
    "servers": {
      "properties": {
        "count": {
          "type": "integer"
        },
        "inventory": {
          "type": "integer"
        }
      },
      "type": "object"
    }
  }
}
Response  200
HideShow

An IP Group

Headers
Content-Type: application/json
Body
{
  "servers": {
    "count": -69879866
  },
  "billing_id": "cillum",
  "name": "e"
}
Schema
{
  "properties": {
    "billing_id": {
      "type": "string"
    },
    "entities": {
      "properties": {
        "count": {
          "type": "integer"
        }
      },
      "type": "object"
    },
    "entitiesCount": {
      "type": "integer"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "name": {
      "type": "string"
    },
    "pxe_dhcp_server": {
      "properties": {
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "name": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "reserved": {
      "type": "boolean"
    },
    "servers": {
      "properties": {
        "count": {
          "type": "integer"
        },
        "inventory": {
          "type": "integer"
        }
      },
      "type": "object"
    }
  }
}
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{}
Schema
{
  "properties": {
    "billing_id": {
      "type": "string"
    },
    "entities": {
      "properties": {
        "count": {
          "type": "integer"
        }
      },
      "type": "object"
    },
    "entitiesCount": {
      "type": "integer"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "name": {
      "type": "string"
    },
    "pxe_dhcp_server": {
      "properties": {
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "name": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "reserved": {
      "type": "boolean"
    },
    "servers": {
      "properties": {
        "count": {
          "type": "integer"
        },
        "inventory": {
          "type": "integer"
        }
      },
      "type": "object"
    }
  }
}
Response  422
HideShow

Unprocessable Entity

Headers
Content-Type: application/json

Integration

Integration

List Integrations

List Integrations
GET/integration

List of Integrations

Example URI

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

List of Integrations

Headers
Content-Type: application/json
Body
[
  {
    "clients": 62731572,
    "keys": 67760239
  },
  {}
]
Schema
{
  "items": {
    "properties": {
      "clients": {
        "type": "integer"
      },
      "id": {
        "description": "SynergyCP-specific unique identifier used for URLs, etc.",
        "type": "integer"
      },
      "keys": {
        "type": "integer"
      },
      "name": {
        "type": "string"
      },
      "permissions": {
        "type": "integer"
      },
      "servers": {
        "type": "integer"
      }
    },
    "type": "object"
  },
  "type": "array"
}

Create Integration
POST/integration

Add new Integration

Example URI

POST /integration
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "name": "veniam",
  "subject": "fugiat non commodo consectetur",
  "body": "exercitation anim"
}
Schema
{
  "required": [
    "name"
  ],
  "properties": {
    "body": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "subject": {
      "type": "string"
    }
  },
  "type": "object"
}
Response  200
HideShow

An Integration

Headers
Content-Type: application/json
Body
{
  "id": 79881330,
  "permissions": -59554617
}
Schema
{
  "properties": {
    "clients": {
      "type": "integer"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "keys": {
      "type": "integer"
    },
    "name": {
      "type": "string"
    },
    "permissions": {
      "type": "integer"
    },
    "servers": {
      "type": "integer"
    }
  },
  "type": "object"
}
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "name": "nostrud sit occaecat sint",
  "body": "culpa mollit"
}
Schema
{
  "required": [
    "name"
  ],
  "properties": {
    "body": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "subject": {
      "type": "string"
    }
  },
  "type": "object"
}
Response  422
HideShow

Unprocessable Entity

Headers
Content-Type: application/json

Delete Integration

Delete Integration
DELETE/integration/{integration_id}

Delete an Integration

Example URI

DELETE /integration/integration_id
URI Parameters
HideShow
integration_id
string (required) 
Response  200
HideShow

Integration deleted successfully

Response  404
HideShow

Item not Found

View Integration
GET/integration/{integration_id}

An Integration

Example URI

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

An Integration

Headers
Content-Type: application/json
Body
{}
Schema
{
  "properties": {
    "clients": {
      "type": "integer"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "keys": {
      "type": "integer"
    },
    "name": {
      "type": "string"
    },
    "permissions": {
      "type": "integer"
    },
    "servers": {
      "type": "integer"
    }
  },
  "type": "object"
}

Edit Integration
PATCH/integration/{integration_id}

Edit Integration

Example URI

PATCH /integration/integration_id
URI Parameters
HideShow
integration_id
string (required) 
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{}
Schema
{
  "properties": {
    "body": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "subject": {
      "type": "string"
    }
  },
  "type": "object"
}
Response  200
HideShow

An Integration

Headers
Content-Type: application/json
Body
{
  "permissions": 34787812,
  "clients": -56827958
}
Schema
{
  "properties": {
    "clients": {
      "type": "integer"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "keys": {
      "type": "integer"
    },
    "name": {
      "type": "string"
    },
    "permissions": {
      "type": "integer"
    },
    "servers": {
      "type": "integer"
    }
  },
  "type": "object"
}
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{}
Schema
{
  "properties": {
    "body": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "subject": {
      "type": "string"
    }
  },
  "type": "object"
}
Response  422
HideShow

Unprocessable Entity

Headers
Content-Type: application/json

List Integration Permissions

List Integration Permissions
GET/integration/{integration_id}/permission

List of Permissions for an Integration

Example URI

GET /integration/integration_id/permission
URI Parameters
HideShow
integration_id
string (required) 
Request
HideShow
Headers
Accept: application/json
Response  200
HideShow

List of Permissions for an Integration

Headers
Content-Type: application/json
Body
[
  {
    "network": {
      "entities": {
        "read": true,
        "write": false
      }
    }
  }
]
Schema
{
  "items": {
    "properties": {
      "network": {
        "properties": {
          "entities": {
            "properties": {
              "read": {
                "type": "boolean"
              },
              "write": {
                "type": "boolean"
              }
            },
            "type": "object"
          },
          "forward": {
            "properties": {
              "read": {
                "type": "boolean"
              },
              "write": {
                "type": "boolean"
              }
            },
            "type": "object"
          },
          "groups": {
            "properties": {
              "read": {
                "type": "boolean"
              },
              "write": {
                "type": "boolean"
              }
            },
            "type": "object"
          },
          "switches": {
            "properties": {
              "read": {
                "type": "boolean"
              },
              "write": {
                "type": "boolean"
              }
            },
            "type": "object"
          }
        },
        "type": "object"
      },
      "pxe": {
        "properties": {
          "installs": {
            "properties": {
              "read": {
                "type": "boolean"
              },
              "write": {
                "type": "boolean"
              }
            },
            "type": "object"
          },
          "settings": {
            "properties": {
              "read": {
                "type": "boolean"
              },
              "write": {
                "type": "boolean"
              }
            },
            "type": "object"
          }
        },
        "type": "object"
      },
      "server": {
        "properties": {
          "in_inventory": {
            "properties": {
              "read": {
                "type": "boolean"
              },
              "write": {
                "type": "boolean"
              }
            },
            "type": "object"
          },
          "in_use": {
            "properties": {
              "read": {
                "type": "boolean"
              },
              "write": {
                "type": "boolean"
              }
            },
            "type": "object"
          },
          "settings": {
            "properties": {
              "read": {
                "type": "boolean"
              },
              "write": {
                "type": "boolean"
              }
            },
            "type": "object"
          }
        },
        "type": "object"
      },
      "system": {
        "properties": {
          "emails": {
            "properties": {
              "read": {
                "type": "boolean"
              },
              "write": {
                "type": "boolean"
              }
            },
            "type": "object"
          },
          "integrations": {
            "properties": {
              "read": {
                "type": "boolean"
              },
              "write": {
                "type": "boolean"
              }
            },
            "type": "object"
          },
          "logs": {
            "properties": {
              "read": {
                "type": "boolean"
              },
              "write": {
                "type": "boolean"
              }
            },
            "type": "object"
          },
          "settings": {
            "properties": {
              "read": {
                "type": "boolean"
              },
              "write": {
                "type": "boolean"
              }
            },
            "type": "object"
          },
          "theme": {
            "properties": {
              "read": {
                "type": "boolean"
              },
              "write": {
                "type": "boolean"
              }
            },
            "type": "object"
          }
        },
        "type": "object"
      },
      "users": {
        "properties": {
          "admins": {
            "properties": {
              "read": {
                "type": "boolean"
              },
              "write": {
                "type": "boolean"
              }
            },
            "type": "object"
          },
          "clients": {
            "properties": {
              "read": {
                "type": "boolean"
              },
              "write": {
                "type": "boolean"
              }
            },
            "type": "object"
          }
        },
        "type": "object"
      }
    },
    "type": "object"
  },
  "type": "array"
}

Edit Integration Permissions
PATCH/integration/{integration_id}/permission

Edit Integration permissions

Example URI

PATCH /integration/integration_id/permission
URI Parameters
HideShow
integration_id
string (required) 
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "network": {
    "switches": {
      "write": true
    }
  }
}
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  200
HideShow

An Integration’s Permissions

Headers
Content-Type: application/json
Body
{
  "system": {
    "integrations": {
      "read": false,
      "write": false
    }
  },
  "users": {
    "admins": {
      "write": true,
      "read": true
    }
  },
  "pxe": {
    "installs": {
      "read": false,
      "write": false
    }
  }
}
Schema
{
  "properties": {
    "network": {
      "properties": {
        "entities": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "forward": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "groups": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "switches": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        }
      },
      "type": "object"
    },
    "pxe": {
      "properties": {
        "installs": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "settings": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        }
      },
      "type": "object"
    },
    "server": {
      "properties": {
        "in_inventory": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "in_use": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "settings": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        }
      },
      "type": "object"
    },
    "system": {
      "properties": {
        "emails": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "integrations": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "logs": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "settings": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "theme": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        }
      },
      "type": "object"
    },
    "users": {
      "properties": {
        "admins": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "clients": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        }
      },
      "type": "object"
    }
  },
  "type": "object"
}
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{}
Schema
{
  "properties": {
    "network": {
      "properties": {
        "entities": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "forward": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "groups": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "switches": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        }
      },
      "type": "object"
    },
    "pxe": {
      "properties": {
        "installs": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "settings": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        }
      },
      "type": "object"
    },
    "server": {
      "properties": {
        "in_inventory": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "in_use": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "settings": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        }
      },
      "type": "object"
    },
    "system": {
      "properties": {
        "emails": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "integrations": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "logs": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "settings": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "theme": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        }
      },
      "type": "object"
    },
    "users": {
      "properties": {
        "admins": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "clients": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        }
      },
      "type": "object"
    }
  },
  "type": "object"
}
Response  422
HideShow

Unprocessable Entity

Headers
Content-Type: application/json

System

System

View License Information

View License Information
GET/license

License Information for Synergy

Example URI

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

License Information for Synergy

Headers
Content-Type: application/json
Body
{
  "key": "eiusmod"
}
Schema
{
  "properties": {
    "has_enterprise": {
      "type": "boolean"
    },
    "is_active": {
      "type": "boolean"
    },
    "key": {
      "type": "string"
    }
  },
  "required": [
    "key"
  ]
}

Create License Information

Create License Information
POST/license/refresh

Refresh Synergy License Information

Example URI

POST /license/refresh
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{}
Schema
{
  "properties": {
    "isWrapped": {
      "type": "boolean"
    }
  }
}
Response  200
HideShow

License Information

Headers
Content-Type: application/json
Body
{
  "key": "Lorem mi",
  "is_active": true
}
Schema
{
  "properties": {
    "has_enterprise": {
      "type": "boolean"
    },
    "is_active": {
      "type": "boolean"
    },
    "key": {
      "type": "string"
    }
  },
  "required": [
    "key"
  ]
}
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "isWrapped": false
}
Schema
{
  "properties": {
    "isWrapped": {
      "type": "boolean"
    }
  }
}
Response  422
HideShow

Unprocessable Entity

Headers
Content-Type: application/json

List Log Items

List Log Items
GET/log

Log Information for Synergy

Example URI

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

Log Information for Synergy

Headers
Content-Type: application/json
Body
[
  {}
]
Schema
{
  "items": {
    "properties": {
      "created_at": {
        "properties": {
          "iso_8601": {
            "description": "IS0 8601-formatted Date",
            "type": "string"
          },
          "unix": {
            "description": "Seconds since Unix epoch (Unix Timestamp)",
            "type": "integer"
          }
        },
        "required": [
          "iso_8601",
          "unix"
        ],
        "type": "object"
      },
      "desc": {
        "type": "string"
      },
      "id": {
        "description": "SynergyCP-specific unique identifier used for URLs, etc.",
        "type": "integer"
      },
      "ip": {
        "type": "string"
      },
      "targets": {
        "items": {
          "properties": {
            "id": {
              "description": "SynergyCP-specific unique identifier used for URLs, etc.",
              "type": "integer"
            },
            "name": {
              "type": "string"
            },
            "singular": {
              "type": "string"
            },
            "url": {
              "type": "string"
            }
          },
          "type": "object"
        },
        "type": "array"
      },
      "user": {
        "properties": {
          "id": {
            "description": "SynergyCP-specific unique identifier used for URLs, etc.",
            "type": "integer"
          },
          "name": {
            "type": "string"
          },
          "url": {
            "type": "string"
          }
        },
        "type": "object"
      }
    },
    "type": "object"
  },
  "type": "array"
}

View Log Item

View Log Item
GET/log/{log_id}

A Synergy Log Item

Example URI

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

A Synergy Log Item

Headers
Content-Type: application/json
Body
{
  "created_at": {
    "iso_8601": "amet",
    "unix": -36788441
  },
  "targets": [
    {
      "url": "in anim dolor",
      "name": "sed consequat"
    }
  ],
  "desc": "minim irure sed incididunt al"
}
Schema
{
  "properties": {
    "created_at": {
      "properties": {
        "iso_8601": {
          "description": "IS0 8601-formatted Date",
          "type": "string"
        },
        "unix": {
          "description": "Seconds since Unix epoch (Unix Timestamp)",
          "type": "integer"
        }
      },
      "required": [
        "iso_8601",
        "unix"
      ],
      "type": "object"
    },
    "data": {
      "properties": {
        "description": {
          "type": "string"
        },
        "message": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "desc": {
      "type": "string"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "ip": {
      "type": "string"
    },
    "targets": {
      "items": {
        "properties": {
          "id": {
            "description": "SynergyCP-specific unique identifier used for URLs, etc.",
            "type": "integer"
          },
          "name": {
            "type": "string"
          },
          "singular": {
            "type": "string"
          },
          "url": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "type": "array"
    },
    "user": {
      "properties": {
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "name": {
          "type": "string"
        },
        "url": {
          "type": "string"
        }
      },
      "type": "object"
    }
  },
  "type": "object"
}

List Packages

List Packages
GET/package

Get Packages

Example URI

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

Packages

Headers
Content-Type: application/json
Body
[
  {
    "files": [
      "non eu ut et",
      "in officia i",
      "ad",
      "nisi sed aliqua"
    ]
  },
  {},
  {}
]
Schema
{
  "items": {
    "properties": {
      "files": {
        "items": {
          "type": "string"
        },
        "type": "array"
      }
    },
    "type": "object"
  },
  "type": "array"
}

View Package

View Package
GET/package/{package_id}

Get Package

Example URI

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

Package

Headers
Content-Type: application/json
Body
{}
Schema
{
  "properties": {
    "files": {
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "type": "object"
}

List Setting Groups

List Setting Groups
GET/setting-group

List of Setting Groups

Example URI

GET /setting-group
Request
HideShow
Headers
Accept: application/json
Response  200
HideShow

List of Setting Groups

Headers
Content-Type: application/json
Body
[
  {},
  {
    "id": 35112465,
    "name": "nostrud"
  }
]
Schema
{
  "items": {
    "properties": {
      "id": {
        "description": "SynergyCP-specific unique identifier used for URLs, etc.",
        "type": "integer"
      },
      "name": {
        "type": "string"
      },
      "parent": {
        "description": "SynergyCP-specific unique identifier used for URLs, etc.",
        "type": "integer"
      },
      "settings": {
        "items": {
          "properties": {
            "id": {
              "description": "SynergyCP-specific unique identifier used for URLs, etc.",
              "type": "integer"
            },
            "name": {
              "type": "string"
            },
            "options": {
              "type": "string"
            },
            "slug": {
              "type": "string"
            },
            "type": {
              "type": "string"
            },
            "validator": {
              "type": "string"
            },
            "value": {
              "type": "integer"
            }
          },
          "type": "object"
        },
        "type": "array"
      }
    },
    "type": "object"
  },
  "type": "array"
}

View Setting Group

View Setting Group
GET/setting-group/{setting_group_id}

Information about a Setting Group

Example URI

GET /setting-group/setting_group_id
URI Parameters
HideShow
setting_group_id
string (required) 
Request
HideShow
Headers
Accept: application/json
Response  200
HideShow

Information about a Setting Group

Headers
Content-Type: application/json
Body
{}
Schema
{
  "properties": {
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "name": {
      "type": "string"
    },
    "parent": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "settings": {
      "items": {
        "properties": {
          "id": {
            "description": "SynergyCP-specific unique identifier used for URLs, etc.",
            "type": "integer"
          },
          "name": {
            "type": "string"
          },
          "options": {
            "type": "string"
          },
          "slug": {
            "type": "string"
          },
          "type": {
            "type": "string"
          },
          "validator": {
            "type": "string"
          },
          "value": {
            "type": "integer"
          }
        },
        "type": "object"
      },
      "type": "array"
    }
  },
  "type": "object"
}

List Theme Customization Options

List Theme Customization Options
GET/system/theme/customize

Theme Customization Options

Example URI

GET /system/theme/customize
Request
HideShow
Headers
Accept: application/json
Response  200
HideShow

Theme Customization Options

Headers
Content-Type: application/json
Body
{}
Schema
{
  "properties": {
    "allowed": {
      "type": "boolean"
    },
    "theme": {
      "properties": {
        "custom_admin_html": {
          "type": "string"
        },
        "custom_client_html": {
          "type": "string"
        },
        "custom_css": {
          "type": "string"
        },
        "link_color": {
          "type": "string"
        },
        "logo": {
          "type": "string"
        },
        "main_bg": {
          "type": "string"
        },
        "nav_bg": {
          "type": "string"
        },
        "panel_alt_bg": {
          "type": "string"
        },
        "panel_bg": {
          "type": "string"
        },
        "side_nav_bg": {
          "type": "string"
        },
        "text_color": {
          "type": "string"
        }
      },
      "type": "object"
    }
  },
  "type": "object"
}

Edit Theme Customization Options
POST/system/theme/customize

Update Theme Customization Options

Example URI

POST /system/theme/customize
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "allowed": true,
  "theme": {
    "main_bg": "Duis ea",
    "custom_css": "ut exercitation",
    "link_color": "aliquip",
    "text_color": "e"
  }
}
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  200
HideShow

Theme Customization Options

Headers
Content-Type: application/json
Body
{}
Schema
{
  "properties": {
    "allowed": {
      "type": "boolean"
    },
    "theme": {
      "properties": {
        "custom_admin_html": {
          "type": "string"
        },
        "custom_client_html": {
          "type": "string"
        },
        "custom_css": {
          "type": "string"
        },
        "link_color": {
          "type": "string"
        },
        "logo": {
          "type": "string"
        },
        "main_bg": {
          "type": "string"
        },
        "nav_bg": {
          "type": "string"
        },
        "panel_alt_bg": {
          "type": "string"
        },
        "panel_bg": {
          "type": "string"
        },
        "side_nav_bg": {
          "type": "string"
        },
        "text_color": {
          "type": "string"
        }
      },
      "type": "object"
    }
  },
  "type": "object"
}
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "theme": {
    "custom_css": "eu laboris ea"
  },
  "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"
}
Response  422
HideShow

Unprocessable Entity

Headers
Content-Type: application/json

List Todo Items

List Todo Items
GET/todo

Todo Items

Example URI

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

Todo Items

Headers
Content-Type: application/json
Body
[
  {},
  {
    "slug": "aliqua",
    "id": -70437069,
    "completed_at": {
      "iso_8601": "non esse",
      "unix": -84836324
    }
  },
  {
    "completed_at": {
      "iso_8601": "sint sit",
      "unix": -81834346
    },
    "slug": "aliqua officia ut consequat veniam"
  }
]
Schema
{
  "items": {
    "properties": {
      "completed_at": {
        "properties": {
          "iso_8601": {
            "description": "IS0 8601-formatted Date",
            "type": "string"
          },
          "unix": {
            "description": "Seconds since Unix epoch (Unix Timestamp)",
            "type": "integer"
          }
        },
        "required": [
          "iso_8601",
          "unix"
        ],
        "type": "object"
      },
      "id": {
        "description": "SynergyCP-specific unique identifier used for URLs, etc.",
        "type": "integer"
      },
      "slug": {
        "type": "string"
      }
    },
    "type": "object"
  },
  "type": "array"
}

View Todo Item

View Todo Item
GET/todo/{todo_id}

Todo Item

Example URI

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

Todo Item

Headers
Content-Type: application/json
Body
{}
Schema
{
  "properties": {
    "completed_at": {
      "properties": {
        "iso_8601": {
          "description": "IS0 8601-formatted Date",
          "type": "string"
        },
        "unix": {
          "description": "Seconds since Unix epoch (Unix Timestamp)",
          "type": "integer"
        }
      },
      "required": [
        "iso_8601",
        "unix"
      ],
      "type": "object"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "slug": {
      "type": "string"
    }
  },
  "type": "object"
}

Hardware

Hardware

List Computer Parts

List Computer Parts
GET/part{?part_type,q}

List of Computer Parts

Example URI

GET /part?part_type=&q=
URI Parameters
HideShow
part_type
string (required) 
q
string (required) 
Request
HideShow
Headers
Accept: application/json
Response  200
HideShow

List of Computer Parts

Headers
Content-Type: application/json
Body
[
  {},
  {
    "name": "in in laborum dolor id",
    "id": -2172904,
    "part_type": {
      "id": -14300409
    }
  },
  {
    "name": "deserunt et",
    "billing_id": "c"
  },
  {}
]
Schema
{
  "items": {
    "properties": {
      "billing_id": {
        "type": "string"
      },
      "id": {
        "description": "SynergyCP-specific unique identifier used for URLs, etc.",
        "type": "integer"
      },
      "name": {
        "type": "string"
      },
      "part_type": {
        "properties": {
          "id": {
            "description": "SynergyCP-specific unique identifier used for URLs, etc.",
            "type": "integer"
          },
          "name": {
            "type": "string"
          }
        },
        "type": "object"
      }
    },
    "type": "object"
  },
  "type": "array"
}

Create Computer Part
POST/part

Add new Computer Part

Example URI

POST /part
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "name": "ipsum anim aute",
  "part_type": "veniam"
}
Schema
{
  "properties": {
    "billing_id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "part_type": {
      "type": "string"
    }
  },
  "type": "object"
}
Response  200
HideShow

Part Information

Headers
Content-Type: application/json
Body
{
  "id": 51971006
}
Schema
{
  "properties": {
    "billing_id": {
      "type": "string"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "name": {
      "type": "string"
    },
    "part_type": {
      "properties": {
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "name": {
          "type": "string"
        }
      },
      "type": "object"
    }
  },
  "type": "object"
}
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{}
Schema
{
  "properties": {
    "billing_id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "part_type": {
      "type": "string"
    }
  },
  "type": "object"
}
Response  422
HideShow

Unprocessable Entity

Headers
Content-Type: application/json

Delete Computer Part

Delete Computer Part
DELETE/part/{part_id}

Delete a Synergy Computer Part

Example URI

DELETE /part/part_id
URI Parameters
HideShow
part_id
string (required) 
Response  200
HideShow

Part deleted successfully

Response  404
HideShow

Item not Found

View Computer Part
GET/part/{part_id}

A Synergy Computer Part

Example URI

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

A Synergy Computer Part

Headers
Content-Type: application/json
Body
{
  "billing_id": "ut qui"
}
Schema
{
  "properties": {
    "billing_id": {
      "type": "string"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "name": {
      "type": "string"
    },
    "part_type": {
      "properties": {
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "name": {
          "type": "string"
        }
      },
      "type": "object"
    }
  },
  "type": "object"
}

Edit Computer Part
PATCH/part/{part_id}

Edit Computer Part

Example URI

PATCH /part/part_id
URI Parameters
HideShow
part_id
string (required) 
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "billing_id": "nostrud",
  "name": "eu",
  "part_type": {
    "id": 61106363
  }
}
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  200
HideShow

A Synergy Computer Part

Headers
Content-Type: application/json
Body
{}
Schema
{
  "properties": {
    "billing_id": {
      "type": "string"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "name": {
      "type": "string"
    },
    "part_type": {
      "properties": {
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "name": {
          "type": "string"
        }
      },
      "type": "object"
    }
  },
  "type": "object"
}
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "billing_id": "Duis enim",
  "name": "id in reprehenderit elit",
  "part_type": {
    "name": "culpa",
    "id": 99784852
  }
}
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  422
HideShow

Unprocessable Entity

Headers
Content-Type: application/json

Network

Network

List Port Speeds

List Port Speeds
GET/port-speed

List of Port Speeds

Example URI

GET /port-speed
Request
HideShow
Headers
Accept: application/json
Response  200
HideShow

List of Port Speeds

Headers
Content-Type: application/json
Body
[
  {}
]
Schema
{
  "items": {
    "properties": {
      "billing_id": {
        "type": "string"
      },
      "id": {
        "description": "SynergyCP-specific unique identifier used for URLs, etc.",
        "type": "integer"
      },
      "name": {
        "type": "string"
      },
      "switchPortCount": {
        "type": "boolean"
      }
    },
    "type": "object"
  },
  "type": "array"
}

Create Port Speed
POST/port-speed

Add new Port Speed

Example URI

POST /port-speed
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "billing_id": "incididunt",
  "name": "et Excepteur veniam",
  "speed": 1710587
}
Schema
{
  "properties": {
    "billing_id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "speed": {
      "type": "integer"
    }
  },
  "type": "object"
}
Response  200
HideShow

Port Speed Information

Headers
Content-Type: application/json
Body
{
  "name": "pariatur elit qui Ut laborum",
  "billing_id": "magna id Excepteur",
  "speed": -197455
}
Schema
{
  "properties": {
    "billing_id": {
      "type": "string"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "name": {
      "type": "string"
    },
    "speed": {
      "type": "integer"
    },
    "switchPortCount": {
      "type": "boolean"
    }
  },
  "type": "object"
}
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "name": "irure consectetur nisi ut ex",
  "speed": -50228066,
  "billing_id": "elit velit incididunt"
}
Schema
{
  "properties": {
    "billing_id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "speed": {
      "type": "integer"
    }
  },
  "type": "object"
}
Response  422
HideShow

Unprocessable Entity

Headers
Content-Type: application/json

Delete Port Speed

Delete Port Speed
DELETE/port-speed/{port_speed_id}

Delete a Synergy Port Speed

Example URI

DELETE /port-speed/port_speed_id
URI Parameters
HideShow
port_speed_id
string (required) 
Response  200
HideShow

Port Speed deleted successfully

Response  404
HideShow

Item not Found

View Port Speed
GET/port-speed/{port_speed_id}

A Synergy Port Speed

Example URI

GET /port-speed/port_speed_id
URI Parameters
HideShow
port_speed_id
string (required) 
Request
HideShow
Headers
Accept: application/json
Response  200
HideShow

A Synergy Port Speed

Headers
Content-Type: application/json
Body
{}
Schema
{
  "properties": {
    "billing_id": {
      "type": "string"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "name": {
      "type": "string"
    },
    "speed": {
      "type": "integer"
    },
    "switchPortCount": {
      "type": "boolean"
    }
  },
  "type": "object"
}

Edit Port Speed
PATCH/port-speed/{port_speed_id}

Edit Port Speed

Example URI

PATCH /port-speed/port_speed_id
URI Parameters
HideShow
port_speed_id
string (required) 
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "billing_id": "veniam dolor irure sed cupidatat",
  "name": "voluptate veniam",
  "speed": -17883606
}
Schema
{
  "required": [
    "billing_id",
    "name",
    "speed"
  ],
  "properties": {
    "billing_id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "speed": {
      "type": "integer"
    }
  },
  "type": "object"
}
Response  200
HideShow

A Synergy Port Speed

Headers
Content-Type: application/json
Body
{
  "switchPortCount": true,
  "speed": -32568620
}
Schema
{
  "properties": {
    "billing_id": {
      "type": "string"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "name": {
      "type": "string"
    },
    "speed": {
      "type": "integer"
    },
    "switchPortCount": {
      "type": "boolean"
    }
  },
  "type": "object"
}
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "billing_id": "nisi deserunt proident et irure",
  "name": "Excepteur dolor exercitation voluptate dolore",
  "speed": 93265761
}
Schema
{
  "required": [
    "billing_id",
    "name",
    "speed"
  ],
  "properties": {
    "billing_id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "speed": {
      "type": "integer"
    }
  },
  "type": "object"
}
Response  422
HideShow

Unprocessable Entity

Headers
Content-Type: application/json

DHCP Servers

DHCP Servers

List DHCP Servers

List DHCP Servers
GET/pxe/dhcp

List of DHCP Servers

Example URI

GET /pxe/dhcp
Request
HideShow
Headers
Accept: application/json
Response  200
HideShow

List of DHCP Servers

Headers
Content-Type: application/json
Body
[
  {
    "id": 29552300,
    "http": {
      "api_key": "cillum consequat"
    }
  },
  {
    "name": "Duis Excepteur"
  },
  {
    "http": {
      "host": "esse sit commodo"
    },
    "id": -17835961
  }
]
Schema
{
  "items": {
    "properties": {
      "http": {
        "properties": {
          "host": {
            "type": "string"
          },
          "api_key": {
            "type": "string"
          },
          "port": {
            "type": "integer"
          },
          "use_https": {
            "type": "boolean"
          }
        },
        "type": "object"
      },
      "id": {
        "description": "SynergyCP-specific unique identifier used for URLs, etc.",
        "type": "integer"
      },
      "name": {
        "type": "string"
      }
    },
    "type": "object"
  },
  "type": "array"
}

Create DHCP Server
POST/pxe/dhcp

Add new DHCP Server

Example URI

POST /pxe/dhcp
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{}
Schema
{
  "properties": {
    "http": {
      "properties": {
        "host": {
          "type": "string"
        },
        "api_key": {
          "type": "string"
        },
        "port": {
          "type": "integer"
        },
        "use_https": {
          "type": "boolean"
        }
      },
      "type": "object"
    },
    "name": {
      "type": "string"
    }
  },
  "type": "object"
}
Response  200
HideShow

DHCP Server Information

Headers
Content-Type: application/json
Body
{
  "id": 71059497
}
Schema
{
  "properties": {
    "http": {
      "properties": {
        "host": {
          "type": "string"
        },
        "api_key": {
          "type": "string"
        },
        "port": {
          "type": "integer"
        },
        "use_https": {
          "type": "boolean"
        }
      },
      "type": "object"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "name": {
      "type": "string"
    }
  },
  "type": "object"
}
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "name": "do par"
}
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  422
HideShow

Unprocessable Entity

Headers
Content-Type: application/json

Delete DHCP Server

Delete DHCP Server
DELETE/pxe/dhcp/{dhcp_id}

Delete a Synergy DHCP Server

Example URI

DELETE /pxe/dhcp/dhcp_id
URI Parameters
HideShow
dhcp_id
string (required) 
Response  200
HideShow

DHCP Server deleted successfully

Response  404
HideShow

Item not Found

View DHCP Server
GET/pxe/dhcp/{dhcp_id}

A DHCP Server

Example URI

GET /pxe/dhcp/dhcp_id
URI Parameters
HideShow
dhcp_id
string (required) 
Request
HideShow
Headers
Accept: application/json
Response  200
HideShow

A DHCP Server

Headers
Content-Type: application/json
Body
{}
Schema
{
  "properties": {
    "http": {
      "properties": {
        "host": {
          "type": "string"
        },
        "api_key": {
          "type": "string"
        },
        "port": {
          "type": "integer"
        },
        "use_https": {
          "type": "boolean"
        }
      },
      "type": "object"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "name": {
      "type": "string"
    }
  },
  "type": "object"
}

Edit DHCP Server
PATCH/pxe/dhcp/{dhcp_id}

Edit DHCP Server

Example URI

PATCH /pxe/dhcp/dhcp_id
URI Parameters
HideShow
dhcp_id
string (required) 
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "http": {
    "host": "minim Excepteur reprehenderit"
  }
}
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  200
HideShow

A Synergy DHCP Server

Headers
Content-Type: application/json
Body
{}
Schema
{
  "properties": {
    "http": {
      "properties": {
        "host": {
          "type": "string"
        },
        "api_key": {
          "type": "string"
        },
        "port": {
          "type": "integer"
        },
        "use_https": {
          "type": "boolean"
        }
      },
      "type": "object"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "name": {
      "type": "string"
    }
  },
  "type": "object"
}
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "name": "veniam"
}
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  422
HideShow

Unprocessable Entity

Headers
Content-Type: application/json

PXE Drivers

PXE Drivers

List PXE Drivers

List PXE Drivers
GET/pxe/driver

List of PXE Drivers

Example URI

GET /pxe/driver
Request
HideShow
Headers
Accept: application/json
Response  200
HideShow

List of PXE Drivers

Headers
Content-Type: application/json
Body
[
  {
    "id": 64203585,
    "name": "in"
  }
]
Schema
{
  "items": {
    "properties": {
      "id": {
        "description": "SynergyCP-specific unique identifier used for URLs, etc.",
        "type": "integer"
      },
      "name": {
        "type": "string"
      }
    },
    "type": "object"
  },
  "type": "array"
}

Create PXE Driver
POST/pxe/driver

Add new PXE Driver

Example URI

POST /pxe/driver
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Schema
{
  "required": [
    "name",
    "driver"
  ],
  "properties": {
    "driver": {
      "format": "binary",
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  },
  "type": "object"
}
Response  200
HideShow

A PXE Driver

Headers
Content-Type: application/json
Body
{}
Schema
{
  "properties": {
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "name": {
      "type": "string"
    }
  },
  "type": "object"
}
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Schema
{
  "required": [
    "name",
    "driver"
  ],
  "properties": {
    "driver": {
      "format": "binary",
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  },
  "type": "object"
}
Response  422
HideShow

Unprocessable Entity

Headers
Content-Type: application/json

Delete PXE Driver

Delete PXE Driver
DELETE/pxe/driver/{driver_id}

Delete a Synergy PXE Driver

Example URI

DELETE /pxe/driver/driver_id
URI Parameters
HideShow
driver_id
string (required) 
Response  200
HideShow

PXE Driver deleted successfully

Response  404
HideShow

Item not Found

View PXE Driver
GET/pxe/driver/{driver_id}

A PXE Driver

Example URI

GET /pxe/driver/driver_id
URI Parameters
HideShow
driver_id
string (required) 
Request
HideShow
Headers
Accept: application/json
Response  200
HideShow

A PXE Driver

Headers
Content-Type: application/json
Body
{}
Schema
{
  "properties": {
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "name": {
      "type": "string"
    }
  },
  "type": "object"
}

Edit PXE Driver
PATCH/pxe/driver/{driver_id}

Edit PXE Driver

Example URI

PATCH /pxe/driver/driver_id
URI Parameters
HideShow
driver_id
string (required) 
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{}
Schema
{
  "properties": {
    "driver": {
      "format": "binary",
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  },
  "type": "object"
}
Response  200
HideShow

A Synergy PXE Driver

Headers
Content-Type: application/json
Body
{}
Schema
{
  "properties": {
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "name": {
      "type": "string"
    }
  },
  "type": "object"
}
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{}
Schema
{
  "properties": {
    "driver": {
      "format": "binary",
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  },
  "type": "object"
}
Response  422
HideShow

Unprocessable Entity

Headers
Content-Type: application/json

File Servers

File Servers

List File Servers

List File Servers
GET/pxe/file

List of File Servers

Example URI

GET /pxe/file
Request
HideShow
Headers
Accept: application/json
Response  200
HideShow

List of File Servers

Headers
Content-Type: application/json
Body
[
  {
    "install_max_concurrent": -4844984,
    "group": {
      "name": "mollit nostrud aute"
    }
  },
  {}
]
Schema
{
  "items": {
    "properties": {
      "group": {
        "properties": {
          "id": {
            "description": "SynergyCP-specific unique identifier used for URLs, etc.",
            "type": "integer"
          },
          "name": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "http": {
        "properties": {
          "host": {
            "type": "string"
          },
          "port": {
            "type": "integer"
          },
          "use_https": {
            "type": "boolean"
          }
        },
        "type": "object"
      },
      "id": {
        "description": "SynergyCP-specific unique identifier used for URLs, etc.",
        "type": "integer"
      },
      "install_max_concurrent": {
        "type": "integer"
      },
      "name": {
        "type": "string"
      },
      "parent": {
        "properties": {
          "id": {
            "description": "SynergyCP-specific unique identifier used for URLs, etc.",
            "type": "integer"
          },
          "name": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "ssh": {
        "properties": {
          "port": {
            "type": "integer"
          },
          "public_key": {
            "type": "string"
          }
        },
        "type": "object"
      }
    },
    "type": "object"
  },
  "type": "array"
}

Create File Server
POST/pxe/file

Add new File Server

Example URI

POST /pxe/file
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "name": "officia voluptate quis ipsum",
  "install_max_concurrent": 40102760,
  "group_id": -16495554,
  "parent_id": -89992266,
  "elitc8": -25706895
}
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  200
HideShow

A File Server

Headers
Content-Type: application/json
Body
{
  "install_max_concurrent": -55564679
}
Schema
{
  "properties": {
    "group": {
      "properties": {
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "name": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "http": {
      "properties": {
        "host": {
          "type": "string"
        },
        "port": {
          "type": "integer"
        },
        "use_https": {
          "type": "boolean"
        }
      },
      "type": "object"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "install_max_concurrent": {
      "type": "integer"
    },
    "name": {
      "type": "string"
    },
    "parent": {
      "properties": {
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "name": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "ssh": {
      "properties": {
        "port": {
          "type": "integer"
        },
        "public_key": {
          "type": "string"
        }
      },
      "type": "object"
    }
  },
  "type": "object"
}
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "name": "nulla sed in minim",
  "install_max_concurrent": 97482676,
  "group_id": -26892370,
  "http": {
    "host": "pariatur anim"
  },
  "ssh": {
    "port": "deserunt ea aliqua laboris",
    "public_key": "ipsum amet exercitation cupidata"
  },
  "esse0e": "ullamco amet",
  "nostrudd": "dolor cupidatat reprehenderit Duis"
}
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  422
HideShow

Unprocessable Entity

Headers
Content-Type: application/json

Delete File Server

Delete File Server
DELETE/pxe/file/{file_server_id}

Delete a File Server

Example URI

DELETE /pxe/file/file_server_id
URI Parameters
HideShow
file_server_id
string (required) 
Response  200
HideShow

File Server deleted successfully

Response  404
HideShow

Item not Found

View File Server
GET/pxe/file/{file_server_id}

A File Server

Example URI

GET /pxe/file/file_server_id
URI Parameters
HideShow
file_server_id
string (required) 
Request
HideShow
Headers
Accept: application/json
Response  200
HideShow

A File Server

Headers
Content-Type: application/json
Body
{
  "name": "officia anim et cillum",
  "install_max_concurrent": 24840857,
  "http": {
    "host": "ut occaeca",
    "port": -49004292
  }
}
Schema
{
  "properties": {
    "group": {
      "properties": {
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "name": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "http": {
      "properties": {
        "host": {
          "type": "string"
        },
        "port": {
          "type": "integer"
        },
        "use_https": {
          "type": "boolean"
        }
      },
      "type": "object"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "install_max_concurrent": {
      "type": "integer"
    },
    "name": {
      "type": "string"
    },
    "parent": {
      "properties": {
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "name": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "ssh": {
      "properties": {
        "port": {
          "type": "integer"
        },
        "public_key": {
          "type": "string"
        }
      },
      "type": "object"
    }
  },
  "type": "object"
}

Edit File Server
PATCH/pxe/file/{file_server_id}

Edit File Server

Example URI

PATCH /pxe/file/file_server_id
URI Parameters
HideShow
file_server_id
string (required) 
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{}
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  200
HideShow

A File Server

Headers
Content-Type: application/json
Body
{}
Schema
{
  "properties": {
    "group": {
      "properties": {
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "name": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "http": {
      "properties": {
        "host": {
          "type": "string"
        },
        "port": {
          "type": "integer"
        },
        "use_https": {
          "type": "boolean"
        }
      },
      "type": "object"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "install_max_concurrent": {
      "type": "integer"
    },
    "name": {
      "type": "string"
    },
    "parent": {
      "properties": {
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "name": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "ssh": {
      "properties": {
        "port": {
          "type": "integer"
        },
        "public_key": {
          "type": "string"
        }
      },
      "type": "object"
    }
  },
  "type": "object"
}
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{}
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  422
HideShow

Unprocessable Entity

Headers
Content-Type: application/json

Sync Child Server Files

Sync Child Server Files
POST/pxe/file/{file_server_id}/child/sync

Sync Files to Child Server

Example URI

POST /pxe/file/file_server_id/child/sync
URI Parameters
HideShow
file_server_id
string (required) 
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "isWrapped": false
}
Schema
{
  "properties": {
    "isWrapped": {
      "type": "boolean"
    }
  },
  "required": [
    "isWrapped"
  ]
}
Response  200
HideShow

File server sync initiated with all children.

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "isWrapped": false
}
Schema
{
  "properties": {
    "isWrapped": {
      "type": "boolean"
    }
  },
  "required": [
    "isWrapped"
  ]
}
Response  422
HideShow

Unprocessable Entity

ISOs

ISOs

List ISO Managers

List ISO Managers
GET/pxe/iso

List of ISO Managers

Example URI

GET /pxe/iso
Request
HideShow
Headers
Accept: application/json
Response  200
HideShow

List of ISO Managers

Headers
Content-Type: application/json
Body
[
  {}
]
Schema
{
  "items": {
    "properties": {
      "created_at": {
        "properties": {
          "iso_8601": {
            "description": "IS0 8601-formatted Date",
            "type": "string"
          },
          "unix": {
            "description": "Seconds since Unix epoch (Unix Timestamp)",
            "type": "integer"
          }
        },
        "required": [
          "iso_8601",
          "unix"
        ],
        "type": "object"
      },
      "folder": {
        "type": "string"
      },
      "id": {
        "description": "SynergyCP-specific unique identifier used for URLs, etc.",
        "type": "integer"
      },
      "name": {
        "type": "string"
      },
      "status": {
        "type": "string"
      }
    },
    "type": "object"
  },
  "type": "array"
}

Create ISO Manager
POST/pxe/iso

Add new ISO Manager

Example URI

POST /pxe/iso
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "name": "cillum aliqua",
  "folder": "commodo cupidatat nulla tempor",
  "url": "elit dolore"
}
Schema
{
  "required": [
    "name",
    "folder",
    "url"
  ],
  "properties": {
    "folder": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "url": {
      "type": "string"
    }
  },
  "type": "object"
}
Response  200
HideShow

An ISO Manager

Headers
Content-Type: application/json
Body
{
  "id": -72929880,
  "folder": "cil"
}
Schema
{
  "properties": {
    "created_at": {
      "properties": {
        "iso_8601": {
          "description": "IS0 8601-formatted Date",
          "type": "string"
        },
        "unix": {
          "description": "Seconds since Unix epoch (Unix Timestamp)",
          "type": "integer"
        }
      },
      "required": [
        "iso_8601",
        "unix"
      ],
      "type": "object"
    },
    "folder": {
      "type": "string"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "name": {
      "type": "string"
    },
    "status": {
      "type": "string"
    }
  },
  "type": "object"
}
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "name": "eiusmod non aute ut",
  "folder": "consequat laborum",
  "url": "ad ea labore irure aliqua"
}
Schema
{
  "required": [
    "name",
    "folder",
    "url"
  ],
  "properties": {
    "folder": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "url": {
      "type": "string"
    }
  },
  "type": "object"
}
Response  422
HideShow

Unprocessable Entity

Headers
Content-Type: application/json

Delete ISO Manager

Delete ISO Manager
DELETE/pxe/iso/{iso_manager_id}

Delete an ISO Manager

Example URI

DELETE /pxe/iso/iso_manager_id
URI Parameters
HideShow
iso_manager_id
string (required) 
Response  200
HideShow

ISO Manager deleted successfully

Response  404
HideShow

Item not Found

View ISO Manager
GET/pxe/iso/{iso_manager_id}

An ISO Manager

Example URI

GET /pxe/iso/iso_manager_id
URI Parameters
HideShow
iso_manager_id
string (required) 
Request
HideShow
Headers
Accept: application/json
Response  200
HideShow

An ISO Manager

Headers
Content-Type: application/json
Body
{}
Schema
{
  "properties": {
    "created_at": {
      "properties": {
        "iso_8601": {
          "description": "IS0 8601-formatted Date",
          "type": "string"
        },
        "unix": {
          "description": "Seconds since Unix epoch (Unix Timestamp)",
          "type": "integer"
        }
      },
      "required": [
        "iso_8601",
        "unix"
      ],
      "type": "object"
    },
    "folder": {
      "type": "string"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "name": {
      "type": "string"
    },
    "status": {
      "type": "string"
    }
  },
  "type": "object"
}

Edit ISO Manager
PATCH/pxe/iso/{iso_manager_id}

Edit ISO Manager

Example URI

PATCH /pxe/iso/iso_manager_id
URI Parameters
HideShow
iso_manager_id
string (required) 
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "folder": "anim proident adipi"
}
Schema
{
  "properties": {
    "folder": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "url": {
      "type": "string"
    }
  },
  "type": "object"
}
Response  200
HideShow

An ISO Manager

Headers
Content-Type: application/json
Body
{
  "folder": "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"
    },
    "folder": {
      "type": "string"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "name": {
      "type": "string"
    },
    "status": {
      "type": "string"
    }
  },
  "type": "object"
}
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "url": "incididunt laborum occaecat",
  "folder": "cupidatat",
  "name": "velit consectetur est cupidatat magna"
}
Schema
{
  "properties": {
    "folder": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "url": {
      "type": "string"
    }
  },
  "type": "object"
}
Response  422
HideShow

Unprocessable Entity

Headers
Content-Type: application/json

List ISO Editions

List ISO Editions
GET/pxe/iso/{iso_manager_id}/edition

List of ISO Editions

Example URI

GET /pxe/iso/iso_manager_id/edition
URI Parameters
HideShow
iso_manager_id
string (required) 
Request
HideShow
Headers
Accept: application/json
Response  200
HideShow

List of ISO Editions

Headers
Content-Type: application/json
Body
[
  {
    "key": "proident Lorem",
    "is_enabled": true
  }
]
Schema
{
  "items": {
    "properties": {
      "id": {
        "description": "SynergyCP-specific unique identifier used for URLs, etc.",
        "type": "integer"
      },
      "is_enabled": {
        "type": "boolean"
      },
      "key": {
        "type": "string"
      },
      "name": {
        "type": "string"
      }
    },
    "type": "object"
  },
  "type": "array"
}

View ISO Edition

View ISO Edition
GET/pxe/iso/{iso_manager_id}/edition/{edition_id}

An ISO Edition

Example URI

GET /pxe/iso/iso_manager_id/edition/edition_id
URI Parameters
HideShow
iso_manager_id
string (required) 
edition_id
string (required) 
Request
HideShow
Headers
Accept: application/json
Response  200
HideShow

An ISO Edition

Headers
Content-Type: application/json
Body
{}
Schema
{
  "properties": {
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "is_enabled": {
      "type": "boolean"
    },
    "key": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  },
  "type": "object"
}

Edit ISO Edition
PATCH/pxe/iso/{iso_manager_id}/edition/{edition_id}

Edit ISO Edition

Example URI

PATCH /pxe/iso/iso_manager_id/edition/edition_id
URI Parameters
HideShow
iso_manager_id
string (required) 
edition_id
string (required) 
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "is_enabled": true,
  "license_key": "Lorem"
}
Schema
{
  "properties": {
    "is_enabled": {
      "type": "boolean"
    },
    "license_key": {
      "type": "string"
    }
  }
}
Response  200
HideShow

An ISO Edition

Headers
Content-Type: application/json
Body
{
  "id": -88946937
}
Schema
{
  "properties": {
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "is_enabled": {
      "type": "boolean"
    },
    "key": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  },
  "type": "object"
}
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "license_key": "irure sint",
  "is_enabled": false
}
Schema
{
  "properties": {
    "is_enabled": {
      "type": "boolean"
    },
    "license_key": {
      "type": "string"
    }
  }
}
Response  422
HideShow

Unprocessable Entity

Headers
Content-Type: application/json

PXE Preseeds

PXE Preseeds

List OS Preseeds

List OS Preseeds
GET/pxe/preseed

List of OS Preseeds

Example URI

GET /pxe/preseed
Request
HideShow
Headers
Accept: application/json
Response  200
HideShow

List of OS Preseeds

Headers
Content-Type: application/json
Body
[
  {
    "name": "adipisicing enim"
  },
  {}
]
Schema
{
  "items": {
    "properties": {
      "description": {
        "type": "string"
      },
      "id": {
        "description": "SynergyCP-specific unique identifier used for URLs, etc.",
        "type": "integer"
      },
      "is_installable": {
        "type": "boolean"
      },
      "name": {
        "type": "string"
      }
    },
    "type": "object"
  },
  "type": "array"
}

Create OS Preseed
POST/pxe/preseed

Add new OS Preseed

Example URI

POST /pxe/preseed
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "name": "quis proident elit nisi"
}
Schema
{
  "required": [
    "name"
  ],
  "properties": {
    "body": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "is_installable": {
      "type": "boolean"
    },
    "name": {
      "type": "string"
    }
  },
  "type": "object"
}
Response  200
HideShow

An OS Preseed

Headers
Content-Type: application/json
Body
{
  "id": 40854322,
  "description": "eu magna sunt ut id",
  "is_installable": true
}
Schema
{
  "properties": {
    "body": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "is_installable": {
      "type": "boolean"
    },
    "name": {
      "type": "string"
    }
  },
  "type": "object"
}
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "name": "adipisicing ea ex aliqua",
  "body": "qui"
}
Schema
{
  "required": [
    "name"
  ],
  "properties": {
    "body": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "is_installable": {
      "type": "boolean"
    },
    "name": {
      "type": "string"
    }
  },
  "type": "object"
}
Response  422
HideShow

Unprocessable Entity

Headers
Content-Type: application/json

Delete OS Preseed

Delete OS Preseed
DELETE/pxe/preseed/{preseed_id}

Delete an OS Preseed

Example URI

DELETE /pxe/preseed/preseed_id
URI Parameters
HideShow
preseed_id
string (required) 
Response  200
HideShow

OS Preseed deleted successfully

Response  404
HideShow

Item not Found

View OS Preseed
GET/pxe/preseed/{preseed_id}

An OS Preseed

Example URI

GET /pxe/preseed/preseed_id
URI Parameters
HideShow
preseed_id
string (required) 
Request
HideShow
Headers
Accept: application/json
Response  200
HideShow

An OS Preseed

Headers
Content-Type: application/json
Body
{
  "is_installable": true,
  "id": -50628534
}
Schema
{
  "properties": {
    "body": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "is_installable": {
      "type": "boolean"
    },
    "name": {
      "type": "string"
    }
  },
  "type": "object"
}

Edit OS Preseed
PATCH/pxe/preseed/{preseed_id}

Edit OS Preseed

Example URI

PATCH /pxe/preseed/preseed_id
URI Parameters
HideShow
preseed_id
string (required) 
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "is_installable": true
}
Schema
{
  "properties": {
    "body": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "is_installable": {
      "type": "boolean"
    },
    "name": {
      "type": "string"
    }
  },
  "type": "object"
}
Response  200
HideShow

An OS Preseed

Headers
Content-Type: application/json
Body
{
  "body": "velit reprehenderit officia",
  "description": "minim adipisicing anim qui",
  "is_installable": false,
  "id": 43553235
}
Schema
{
  "properties": {
    "body": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "is_installable": {
      "type": "boolean"
    },
    "name": {
      "type": "string"
    }
  },
  "type": "object"
}
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{}
Schema
{
  "properties": {
    "body": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "is_installable": {
      "type": "boolean"
    },
    "name": {
      "type": "string"
    }
  },
  "type": "object"
}
Response  422
HideShow

Unprocessable Entity

Headers
Content-Type: application/json

OS Reload Profiles

OS Reload Profiles

List Reload Profiles

List Reload Profiles
GET/pxe/profile

List of OS Reload Profiles

Example URI

GET /pxe/profile
Request
HideShow
Headers
Accept: application/json
Response  200
HideShow

List of OS Reload Profiles

Headers
Content-Type: application/json
Body
[
  {
    "iso": {
      "id": 94473894
    },
    "access_client": false,
    "id": 14519800,
    "name": "anim"
  }
]
Schema
{
  "items": {
    "properties": {
      "access_client": {
        "type": "boolean"
      },
      "billing_id": {
        "type": "string"
      },
      "id": {
        "description": "SynergyCP-specific unique identifier used for URLs, etc.",
        "type": "integer"
      },
      "iso": {
        "properties": {
          "id": {
            "description": "SynergyCP-specific unique identifier used for URLs, etc.",
            "type": "integer"
          }
        },
        "type": "object"
      },
      "name": {
        "type": "string"
      }
    },
    "type": "object"
  },
  "type": "array"
}

Create Reload Profile
POST/pxe/profile

Add new Reload Profiles

Example URI

POST /pxe/profile
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "name": "proident deserunt voluptate et labore",
  "boot_script": {},
  "drivers": [
    {
      "id": 90811293,
      "name": "Ut occ"
    }
  ]
}
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  200
HideShow

A Reload Profiles

Headers
Content-Type: application/json
Body
{
  "id": 99527211
}
Schema
{
  "properties": {
    "access_client": {
      "type": "boolean"
    },
    "billing_id": {
      "type": "string"
    },
    "boot_script": {
      "properties": {
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "name": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "drivers": {
      "items": {
        "properties": {
          "id": {
            "description": "SynergyCP-specific unique identifier used for URLs, etc.",
            "type": "integer"
          },
          "name": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "type": "array"
    },
    "email": {
      "properties": {
        "template": {
          "properties": {
            "id": {
              "description": "SynergyCP-specific unique identifier used for URLs, etc.",
              "type": "integer"
            },
            "name": {
              "type": "string"
            }
          },
          "type": "object"
        }
      },
      "type": "object"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "iso": {
      "properties": {
        "edition": {
          "type": "string"
        },
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "name": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "name": {
      "type": "string"
    },
    "preseed": {
      "properties": {
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "name": {
          "type": "string"
        }
      },
      "type": "object"
    }
  },
  "type": "object"
}
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "name": "velit Lorem non",
  "boot_script": {
    "id": 83102689,
    "name": "esse elit dolore velit in"
  },
  "access_client": true
}
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  422
HideShow

Unprocessable Entity

Headers
Content-Type: application/json

Delete Reload Profile

Delete Reload Profile
DELETE/pxe/profile/{profile_id}

Delete an OS Reload Profile

Example URI

DELETE /pxe/profile/profile_id
URI Parameters
HideShow
profile_id
string (required) 
Response  200
HideShow

OS Reload Profile deleted successfully

Response  404
HideShow

Item not Found

View Reload Profile
GET/pxe/profile/{profile_id}

An OS Preseed

Example URI

GET /pxe/profile/profile_id
URI Parameters
HideShow
profile_id
string (required) 
Request
HideShow
Headers
Accept: application/json
Response  200
HideShow

An OS Preseed

Headers
Content-Type: application/json
Body
{
  "billing_id": "dolore ullamco elit do quis"
}
Schema
{
  "properties": {
    "access_client": {
      "type": "boolean"
    },
    "billing_id": {
      "type": "string"
    },
    "boot_script": {
      "properties": {
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "name": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "drivers": {
      "items": {
        "properties": {
          "id": {
            "description": "SynergyCP-specific unique identifier used for URLs, etc.",
            "type": "integer"
          },
          "name": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "type": "array"
    },
    "email": {
      "properties": {
        "template": {
          "properties": {
            "id": {
              "description": "SynergyCP-specific unique identifier used for URLs, etc.",
              "type": "integer"
            },
            "name": {
              "type": "string"
            }
          },
          "type": "object"
        }
      },
      "type": "object"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "iso": {
      "properties": {
        "edition": {
          "type": "string"
        },
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "name": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "name": {
      "type": "string"
    },
    "preseed": {
      "properties": {
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "name": {
          "type": "string"
        }
      },
      "type": "object"
    }
  },
  "type": "object"
}

Edit Reload Profile
PATCH/pxe/profile/{profile_id}

Edit OS Reload Profile

Example URI

PATCH /pxe/profile/profile_id
URI Parameters
HideShow
profile_id
string (required) 
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "id": -33301749,
  "name": "ad enim dolor",
  "iso": {
    "id": 6402210,
    "name": "in Exce",
    "edition": "ullamco"
  },
  "billing_id": "do proident magna"
}
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  200
HideShow

An OS Reload Profile

Headers
Content-Type: application/json
Body
{
  "name": "tempor aliquip ullamco sit Exce",
  "preseed": {
    "name": "ut u",
    "id": -45816784
  }
}
Schema
{
  "properties": {
    "access_client": {
      "type": "boolean"
    },
    "billing_id": {
      "type": "string"
    },
    "boot_script": {
      "properties": {
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "name": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "drivers": {
      "items": {
        "properties": {
          "id": {
            "description": "SynergyCP-specific unique identifier used for URLs, etc.",
            "type": "integer"
          },
          "name": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "type": "array"
    },
    "email": {
      "properties": {
        "template": {
          "properties": {
            "id": {
              "description": "SynergyCP-specific unique identifier used for URLs, etc.",
              "type": "integer"
            },
            "name": {
              "type": "string"
            }
          },
          "type": "object"
        }
      },
      "type": "object"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "iso": {
      "properties": {
        "edition": {
          "type": "string"
        },
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "name": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "name": {
      "type": "string"
    },
    "preseed": {
      "properties": {
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "name": {
          "type": "string"
        }
      },
      "type": "object"
    }
  },
  "type": "object"
}
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{}
Schema
{
  "properties": {
    "access_client": {
      "type": "boolean"
    },
    "billing_id": {
      "type": "string"
    },
    "boot_script": {
      "properties": {
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "name": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "drivers": {
      "items": {
        "properties": {
          "id": {
            "description": "SynergyCP-specific unique identifier used for URLs, etc.",
            "type": "integer"
          },
          "name": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "type": "array"
    },
    "email": {
      "properties": {
        "template": {
          "properties": {
            "id": {
              "description": "SynergyCP-specific unique identifier used for URLs, etc.",
              "type": "integer"
            },
            "name": {
              "type": "string"
            }
          },
          "type": "object"
        }
      },
      "type": "object"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "iso": {
      "properties": {
        "edition": {
          "type": "string"
        },
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "name": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "name": {
      "type": "string"
    },
    "preseed": {
      "properties": {
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "name": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "shell": {
      "properties": {
        "after": {
          "items": {
            "type": "integer"
          },
          "type": "array"
        }
      },
      "type": "object"
    }
  },
  "type": "object"
}
Response  422
HideShow

Unprocessable Entity

Headers
Content-Type: application/json

OS Shell Scripts

OS Shell Scripts

List Shell Scripts

List Shell Scripts
GET/pxe/shell

List of OS Reload Shell Scripts

Example URI

GET /pxe/shell
Request
HideShow
Headers
Accept: application/json
Response  200
HideShow

List of OS Reload Shell Scripts

Headers
Content-Type: application/json
Body
[
  {},
  {
    "id": -63237964,
    "description": "aliquip reprehenderit elit"
  }
]
Schema
{
  "items": {
    "properties": {
      "description": {
        "type": "string"
      },
      "id": {
        "description": "SynergyCP-specific unique identifier used for URLs, etc.",
        "type": "integer"
      },
      "name": {
        "type": "string"
      }
    },
    "type": "object"
  },
  "type": "array"
}

Create Shell Script
POST/pxe/shell

Add new Reload Shell Scripts

Example URI

POST /pxe/shell
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "name": "aute Lorem laboris",
  "body": "veniam in reprehenderit elit ut"
}
Schema
{
  "required": [
    "name"
  ],
  "properties": {
    "body": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  },
  "type": "object"
}
Response  200
HideShow

A Reload Shell Script

Headers
Content-Type: application/json
Body
{
  "body": "Lorem",
  "id": 98026782,
  "name": "reprehenderit sunt elit"
}
Schema
{
  "properties": {
    "body": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "name": {
      "type": "string"
    }
  },
  "type": "object"
}
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "name": "adipisicing veniam officia Lorem"
}
Schema
{
  "required": [
    "name"
  ],
  "properties": {
    "body": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  },
  "type": "object"
}
Response  422
HideShow

Unprocessable Entity

Headers
Content-Type: application/json

Delete Shell Script

Delete Shell Script
DELETE/pxe/shell/{shell_script_id}

Delete an OS Reload Shell Script

Example URI

DELETE /pxe/shell/shell_script_id
URI Parameters
HideShow
shell_script_id
string (required) 
Response  200
HideShow

OS Reload Shell Script deleted successfully

Response  404
HideShow

Item not Found

View Shell Script
GET/pxe/shell/{shell_script_id}

An OS Reload Shell Script

Example URI

GET /pxe/shell/shell_script_id</