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": "pariatur officia deserunt"
  },
  {
    "username": "incididunt voluptate in",
    "created_at": {
      "iso_8601": "in esse dolore",
      "unix": -80632021
    }
  },
  {
    "username": "nulla sint",
    "receive_copies": false
  },
  {
    "username": "ipsum sit consequat cillum ",
    "name": "cillum laboris irure sint"
  },
  {
    "username": "qui"
  }
]
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 labore",
  "password": "sit non enim"
}
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": "dolore est tempor ex sint"
}
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": "mollit dolore nisi ea",
  "password": "sunt exercitation ex Lorem",
  "username": "non et anim Lorem ullamco"
}
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": "cillum eiusmod sint tempor aliquip",
  "receive_copies": true,
  "name": "laborum anim voluptate"
}
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": "Lorem adipisicing commodo aute",
  "name": "ad proident ut ipsum laborum",
  "receive_copies": true,
  "created_at": {
    "iso_8601": "veniam ipsum et",
    "unix": 846282
  }
}
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
{
  "users": {
    "clients": {
      "read": true
    }
  },
  "network": {
    "switches": {
      "write": false
    }
  }
}
Schema
{
  "properties": {
    "network": {
      "properties": {
        "entities": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "forward": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "groups": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "switches": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        }
      },
      "type": "object"
    },
    "pxe": {
      "properties": {
        "installs": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "settings": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        }
      },
      "type": "object"
    },
    "server": {
      "properties": {
        "in_inventory": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "in_use": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "settings": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        }
      },
      "type": "object"
    },
    "system": {
      "properties": {
        "emails": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "integrations": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "logs": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "settings": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "theme": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        }
      },
      "type": "object"
    },
    "users": {
      "properties": {
        "admins": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        },
        "clients": {
          "properties": {
            "read": {
              "type": "boolean"
            },
            "write": {
              "type": "boolean"
            }
          },
          "type": "object"
        }
      },
      "type": "object"
    }
  },
  "type": "object"
}

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

Edit a specific admin’s Permissions

Example URI

PATCH /admin/admin_id/permission
URI Parameters
HideShow
admin_id
string (required) 
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "pxe": {
    "settings": {
      "write": true
    },
    "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"
}
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": 84588873,
    "name": "exercitation dolore Ut fugiat in",
    "expires_at": {
      "iso_8601": "dolor et con",
      "unix": 37467471
    },
    "key": "Excepteur"
  },
  {
    "id": -54525548,
    "name": "officia cupidatat elit"
  },
  {
    "id": -47015524,
    "name": "in nostrud in"
  }
]
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": "sed occaecat",
  "owner": {
    "name": "ut ex magna qui",
    "url": "elit ad",
    "id": -45443720
  },
  "key": "elit qui pariatur aute ipsum",
  "expires_at": {
    "iso_8601": "exercitation minim in adipisicing",
    "unix": -753335
  }
}
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": -1789427,
  "name": "velit non cupidatat 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"
}
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "name": "dolor voluptate est sed sit",
  "id": 10564284,
  "owner": {
    "id": 79053917,
    "name": "labore officia reprehenderit non",
    "url": "nulla eiusmod aute veniam"
  }
}
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": -39590288,
  "name": "dol",
  "expires_at": {
    "iso_8601": "dolor ea eu",
    "unix": -30026766
  }
}
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": "ani",
  "id": -35083328,
  "owner": {
    "url": "amet",
    "id": -32705090
  },
  "expires_at": {
    "iso_8601": "voluptate proident amet nisi Duis",
    "unix": 49507366
  },
  "key": "nisi"
}
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": -19870909,
  "name": "aliquip e"
}
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": "velit sed cillum",
  "key": "in in irur",
  "owner": {
    "name": "ullamco quis cillum"
  }
}
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
[
  {
    "id": 28468660
  }
]
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
{
  "method": {
    "id": -67103461
  },
  "value": "veniam labore id proident do"
}
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
{}
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
{
  "value": "sed dolor commodo exercitation"
}
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
{
  "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
{
  "id": 80619644
}
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
{
  "value": "dolor"
}
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
{
  "value": "mollit tempor",
  "id": -10614853,
  "verified": true
}
Schema
{
  "properties": {
    "id": {
      "description": "SynergyCP-specific unique identifier used for URLs, etc.",
      "type": "integer"
    },
    "method": {
      "properties": {
        "id": {
          "description": "SynergyCP-specific unique identifier used for URLs, etc.",
          "type": "integer"
        },
        "name": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "value": {
      "type": "string"
    },
    "verified": {
      "type": "boolean"
    }
  },
  "type": "object"
}
Response  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
{}
Schema
{
  "properties": {
    "isWrapped": {
      "type": "boolean"
    }
  },
  "type": "object"
}
Response  200
HideShow

2FA Code Sent

Headers
Content-Type: application/json
Body
{
  "id": 54727917,
  "token": "nostrud sint ut"
}
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": false
}
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
{
  "id": -88432682,
  "token": "dolore irure dolor voluptate"
}
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": {
    "id": -65920946,
    "key": "Excepteur",
    "owner": {
      "url": "reprehenderit sint esse",
      "id": 60800146,
      "name": "dolor minim dolor "
    }
  }
}
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
[
  {
    "description": "sit incididunt labore aliqua laboris",
    "id": -79015077
  },
  {
    "id": -38011797
  }
]
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": "fugiat in elit cillum velit"
}
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
{
  "description": "fugiat aliquip ut cupidatat in",
  "id": 62059105
}
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
{}
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
{}
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
{}
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
{}
Schema
{
  "properties": {
    "email": {
      "type": "string"
    }
  },
  "type": "object"
}
Response  200
HideShow

SSL Settings

Headers
Content-Type: application/json
Body
{}
Schema
{
  "properties": {
    "enabled": {
      "type": "boolean"
    },
    "required": {
      "type": "boolean"
    }
  },
  "type": "object"
}
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{}
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": -56188430,
    "name": "est Lorem",
    "email": "eu consequat reprehenderit elit ut",
    "created_at": {
      "iso_8601": "sunt Duis occ",
      "unix": -73377756
    }
  },
  {
    "id": -94503636,
    "name": "enim Excepteur sunt commodo Ut",
    "email": "ad occaecat esse"
  }
]
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": "esse Duis",
  "first": "Lorem",
  "last": "in eiusmod Excepteur "
}
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": -13478350,
  "name": "laborum",
  "email": "est qui laboris dolore"
}
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": "cillum Duis officia dolore",
  "first": "proident incididunt Ut sint",
  "last": "sit Lorem 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": -57994943,
  "name": "do in Lorem enim",
  "email": "ullamco Duis pariatur",
  "serversCount": 86510026,
  "last": "aliquip ",
  "billing_id": 3007996
}
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
{
  "last": "Exc",
  "email": "ut aliqua ad in aliqui",
  "first": "esse"
}
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": 21440601,
  "name": "anim",
  "email": "mollit"
}
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
{
  "last": "laboris Excepteur"
}
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": "nulla ut aute magn"
}
Schema
{
  "properties": {
    "type": {
      "type": "string"
    }
  },
  "required": [
    "type"
  ],
  "type": "object"
}
Response  200
HideShow

Sent an email to one client.

Headers
Content-Type: application/json
Body
[
  {}
]
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": ""
}
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": -91800425,
    "child": {
      "created_at": {
        "iso_8601": "amet proident magna ut",
        "unix": -64363290
      }
    },
    "laboreef0": -54443949
  }
]
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": 31011398
}
Schema
{
  "properties": {
    "client_id": {
      "type": "integer"
    }
  },
  "required": [
    "client_id"
  ]
}
Response  200
HideShow

A Sub Client

Headers
Content-Type: application/json
Body
{
  "id": -50139421,
  "non5": -23771782
}
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": 51373871
}
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": 65189546,
  "minim2e": true,
  "enim2": 77590746
}
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": "aliqua dolore cupidatat eiusmod amet",
  "password": "irure",
  "first": "mollit esse eu"
}
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": -22918627,
  "adipisicing9": 6997370,
  "quibf3": -34342787
}
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
{
  "first": "irure ad",
  "last": "irure ad magna elit",
  "password": "ipsum nisi"
}
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": -48755542,
    "enim01": -60656965
  },
  {
    "id": -57077596,
    "pariatur05": 5247266
  },
  {
    "id": -65715415,
    "grantee": {
      "id": -6504289
    }
  }
]
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": -16279316
}
Schema
{
  "properties": {
    "client_id": {
      "type": "integer"
    }
  },
  "required": [
    "client_id"
  ]
}
Response  200
HideShow

A Super Client

Headers
Content-Type: application/json
Body
{
  "id": -84222352,
  "utd": -19162928
}
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": 62295806
}
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": 10737802,
  "occaecataa": "dolore"
}
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
{
  "first": "laborum a",
  "email": "irure",
  "last": "veniam est voluptate"
}
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": -24783829
}
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
{}
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
[
  {
    "name": "occaecat ad velit sint",
    "body": "pariatur qui"
  }
]
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": "laboris labore et quis tempor",
  "subject": "labore ut",
  "body": "culpa incididunt velit et mollit",
  "id": 41325755
}
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
{}
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": "dol",
  "subject": "minim voluptate",
  "body": "enim dolore irure"
}
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
{
  "body": "velit occaecat"
}
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": "Lorem anim labore",
  "subject": "non aliquip sint en",
  "body": "proident ipsum et",
  "id": 37559438
}
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
{}
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": "pariatur ullamco",
  "subject": "ut fugiat nisi sint elit",
  "body": "anim mollit aute"
}
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
[
  {
    "address": "et",
    "v4": {
      "full": "deserunt exercitation",
      "address": "id",
      "gateway": "ipsum quis in occaecat"
    }
  },
  {
    "vlan": -96544618
  },
  {
    "id": 20318509,
    "address": "sit mollit ad tempor"
  },
  {
    "v6_address": "Ut ullamco aliquip",
    "v6_gateway": "ut sed offic"
  },
  {}
]
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
{}
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_address": "in Duis enim consectetur magna",
  "v6_gateway": "exercitation ut ea do deserunt",
  "name": "culpa amet nisi elit"
}
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
{
  "group": {
    "name": "reprehenderit in commodo dolore",
    "id": -75530255
  }
}
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
{}
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
{
  "id": -99233057,
  "vlan": 4189352
}
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": "sunt nostrud dolore",
  "nickname": "id dolore",
  "id": -31143595,
  "address": "Excepteur in"
}
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
[
  {
    "type": "string"
  },
  {
    "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
{
  "type": "string"
}
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
{}
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
{
  "field_id": 63761670
}
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": "sunt ullamco in non eiusmod",
    "hostname": "sint fugiat occaecat",
    "api_key": "mollit sed culpa ex",
    "id": 90486926,
    "port_limit": "aliquip elit in do qui",
    "groups": [
      {
        "id": -74802856,
        "name": "sed id occaecat anim sunt"
      }
    ]
  },
  {
    "name": "officia amet voluptate",
    "hostname": "quis officia sunt",
    "consecteturd15": true,
    "dolor9f": -51475894
  }
]
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": "elit ea nisi culpa aliqua",
  "hostname": "ex in pariatur ut",
  "id": -24262332,
  "port_limit": "ut minim"
}
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": "exercitation sed laborum Lorem",
  "hostname": "elit minim",
  "aliquip5": false,
  "velit4c5": -6508473
}
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 sed",
  "hostname": "sed veniam",
  "sint334": -71535313,
  "labore953": -12315888
}
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": "ad velit cillum nisi",
  "hostname": "pariatur cupidatat",
  "port_limit": "Lorem aliquip",
  "id": -75399270
}
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": "consequat ",
  "hostname": "incididunt elit cupidatat dolore",
  "quis5": 89156874,
  "occaecat1c1": -54663985
}
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": "aute est tempor consectetur deserunt",
  "hostname": "ea amet et",
  "consequat4b9": 80447483,
  "dolored4": "commodo"
}
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": "nulla do sit incididunt v",
  "hostname": "aute mollit ex ea velit",
  "api_key": "ad ex irure",
  "temporc38": 41387405
}
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
[
  {},
  {}
]
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
{
  "id": -59940390
}
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": "dolor eiusmod",
    "servers": {
      "inventory": -99290884,
      "count": -18715366
    },
    "name": "null",
    "entitiesCount": -30703509
  }
]
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
{}
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
{
  "servers": {
    "count": 87775287,
    "inventory": 75595975
  }
}
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
{
  "pxe_dhcp_server": {
    "id": -40666906,
    "name": "cupidatat cillum pariatur aliqua"
  },
  "servers": {
    "count": 13078302,
    "inventory": 4639271
  }
}
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
{
  "reserved": true,
  "id": 72605051,
  "name": "nostrud"
}
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
[
  {
    "permissions": -57815172,
    "servers": 9293477,
    "id": -80587906
  },
  {},
  {
    "clients": 97577515,
    "keys": -9960199
  },
  {}
]
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": "id",
  "body": "elit Duis in Ut"
}
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
{}
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": "consectetur et in",
  "body": "consequat reprehenderit"
}
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
{
  "name": "sed deserunt sit",
  "permissions": 76428188,
  "clients": 67835380,
  "servers": 77173465
}
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
{
  "clients": 18665368
}
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
[
  {
    "pxe": {
      "settings": {
        "read": true
      }
    }
  },
  {
    "users": {
      "clients": {
        "write": true,
        "read": true
      }
    }
  }
]
Schema
{
  "items": {
    "properties": {
      "network": {
        "properties": {
          "entities": {
            "properties": {
              "read": {
                "type": "boolean"
              },
              "write": {
                "type": "boolean"
              }
            },
            "type": "object"
          },
          "forward": {
            "properties": {
              "read": {
                "type": "boolean"
              },
              "write": {
                "type": "boolean"
              }
            },
            "type": "object"
          },
          "groups": {
            "properties": {
              "read": {
                "type": "boolean"
              },
              "write": {
                "type": "boolean"
              }
            },
            "type": "object"
          },
          "switches": {
            "properties": {
              "read": {
                "type": "boolean"
              },
              "write": {
                "type": "boolean"
              }
            },
            "type": "object"
          }
        },
        "type": "object"
      },
      "pxe": {
        "properties": {
          "installs": {
            "properties": {
              "read": {
                "type": "boolean"
              },
              "write": {
                "type": "boolean"
              }
            },
            "type": "object"
          },
          "settings": {
            "properties": {
              "read": {
                "type": "boolean"
              },
              "write": {
                "type": "boolean"
              }
            },
            "type": "object"
          }
        },
        "type": "object"
      },
      "server": {
        "properties": {
          "in_inventory": {
            "properties": {
              "read": {
                "type": "boolean"
              },
              "write": {
                "type": "boolean"
              }
            },
            "type": "object"
          },
          "in_use": {
            "properties": {
              "read": {
                "type": "boolean"
              },
              "write": {
                "type": "boolean"
              }
            },
            "type": "object"
          },
          "settings": {
            "properties": {
              "read": {
                "type": "boolean"
              },
              "write": {
                "type": "boolean"
              }
            },
            "type": "object"
          }
        },
        "type": "object"
      },
      "system": {
        "properties": {
          "emails": {
            "properties": {
              "read": {
                "type": "boolean"
              },
              "write": {
                "type": "boolean"
              }
            },
            "type": "object"
          },
          "integrations": {
            "properties": {
              "read": {
                "type": "boolean"
              },
              "write": {
                "type": "boolean"
              }
            },
            "type": "object"
          },
          "logs": {
            "properties": {
              "read": {
                "type": "boolean"
              },
              "write": {
                "type": "boolean"
              }
            },
            "type": "object"
          },
          "settings": {
            "properties": {
              "read": {
                "type": "boolean"
              },
              "write": {
                "type": "boolean"
              }
            },
            "type": "object"
          },
          "theme": {
            "properties": {
              "read": {
                "type": "boolean"
              },
              "write": {
                "type": "boolean"
              }
            },
            "type": "object"
          }
        },
        "type": "object"
      },
      "users": {
        "properties": {
          "admins": {
            "properties": {
              "read": {
                "type": "boolean"
              },
              "write": {
                "type": "boolean"
              }
            },
            "type": "object"
          },
          "clients": {
            "properties": {
              "read": {
                "type": "boolean"
              },
              "write": {
                "type": "boolean"
              }
            },
            "type": "object"
          }
        },
        "type": "object"
      }
    },
    "type": "object"
  },
  "type": "array"
}

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

Edit Integration permissions

Example URI

PATCH /integration/integration_id/permission
URI Parameters
HideShow
integration_id
string (required) 
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "pxe": {
    "installs": {
      "write": false,
      "read": 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
{
  "pxe": {
    "settings": {
      "read": false,
      "write": false
    },
    "installs": {
      "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
{
  "pxe": {
    "installs": {
      "write": true,
      "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"
}
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": "pariatur minim Duis et velit"
}
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
{
  "isWrapped": true
}
Schema
{
  "properties": {
    "isWrapped": {
      "type": "boolean"
    }
  }
}
Response  200
HideShow

License Information

Headers
Content-Type: application/json
Body
{
  "key": "ut dolore ea velit"
}
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
{}
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
[
  {
    "targets": [
      {
        "url": "officia ut",
        "singular": "veniam amet",
        "name": "sint nisi"
      },
      {
        "name": "irure reprehenderit",
        "singular": "laboris esse"
      },
      {
        "url": "irure laborum ut",
        "singular": "veniam deserunt Duis minim eu"
      },
      {
        "singular": "proident adipisicing tempor",
        "id": -93592338,
        "name": "laborum"
      }
    ],
    "ip": "aliquip Excepteur consectetur",
    "user": {
      "name": "voluptate ad non"
    },
    "created_at": {
      "iso_8601": "esse",
      "unix": 25215461
    },
    "id": -52989271
  },
  {}
]
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
{}
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": [
      "nisi",
      "amet id",
      "eni",
      "Lorem laborum aliquip",
      "lab"
    ]
  },
  {
    "files": [
      "adipisicing aliquip",
      "anim",
      "id veniam occaecat Duis irure",
      "ea aliq"
    ]
  },
  {}
]
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
{
  "files": [
    "pariatur",
    "esse cillum",
    "ut et sit",
    "veniam cillum sunt dolor"
  ]
}
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": 45901334
  }
]
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
{
  "parent": -12035585,
  "id": 94798794,
  "name": "in cupidatat eu"
}
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
{
  "allowed": false
}
Schema
{
  "properties": {
    "allowed": {
      "type": "boolean"
    },
    "theme": {
      "properties": {
        "custom_admin_html": {
          "type": "string"
        },
        "custom_client_html": {
          "type": "string"
        },
        "custom_css": {
          "type": "string"
        },
        "link_color": {
          "type": "string"
        },
        "logo": {
          "type": "string"
        },
        "main_bg": {
          "type": "string"
        },
        "nav_bg": {
          "type": "string"
        },
        "panel_alt_bg": {
          "type": "string"
        },
        "panel_bg": {
          "type": "string"
        },
        "side_nav_bg": {
          "type": "string"
        },
        "text_color": {
          "type": "string"
        }
      },
      "type": "object"
    }
  },
  "type": "object"
}

Edit Theme Customization Options
POST/system/theme/customize

Update Theme Customization Options

Example URI

POST /system/theme/customize
Request
HideShow
Headers
Content-Type: application/json
Accept: 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"
}
Response  200
HideShow

Theme Customization Options

Headers
Content-Type: application/json
Body
{
  "allowed": false
}
Schema
{
  "properties": {
    "allowed": {
      "type": "boolean"
    },
    "theme": {
      "properties": {
        "custom_admin_html": {
          "type": "string"
        },
        "custom_client_html": {
          "type": "string"
        },
        "custom_css": {
          "type": "string"
        },
        "link_color": {
          "type": "string"
        },
        "logo": {
          "type": "string"
        },
        "main_bg": {
          "type": "string"
        },
        "nav_bg": {
          "type": "string"
        },
        "panel_alt_bg": {
          "type": "string"
        },
        "panel_bg": {
          "type": "string"
        },
        "side_nav_bg": {
          "type": "string"
        },
        "text_color": {
          "type": "string"
        }
      },
      "type": "object"
    }
  },
  "type": "object"
}
Request
HideShow
Headers
Content-Type: application/json
Accept: 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"
}
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
[
  {
    "completed_at": {
      "iso_8601": "et consectetur veniam ex Lorem",
      "unix": -26513421
    }
  },
  {}
]
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
{
  "completed_at": {
    "iso_8601": "dolor sunt n",
    "unix": 96801756
  },
  "id": -84563087,
  "slug": "elit aute Ut veniam"
}
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": "adipisicing aliqua consectetur",
    "part_type": {
      "id": 48387759,
      "name": "amet"
    },
    "billing_id": "elit cillum ad"
  },
  {
    "part_type": {
      "id": 24475200
    }
  }
]
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
{}
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
{}
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
{
  "part_type": "nulla ea",
  "name": "dolore culpa",
  "billing_id": "sit esse do"
}
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
{
  "name": "enim",
  "part_type": {
    "id": 55846459
  },
  "id": -498796,
  "billing_id": "dolor ut"
}
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": "ut non minim aliqua",
  "name": "elit voluptate qui",
  "part_type": {},
  "id": 82427979
}
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
{
  "name": "nostrud proident"
}
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": "ea in dolore esse deserunt",
  "name": "minim nostrud laborum",
  "part_type": {},
  "id": 23319756
}
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
[
  {},
  {
    "id": 12680775
  },
  {}
]
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": "eiusmod tempor ut "
}
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
{
  "speed": -45488833,
  "switchPortCount": false,
  "id": 65485137,
  "name": "officia nulla"
}
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": "ea non sint sit",
  "speed": -4695604,
  "name": "Duis officia"
}
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": "minim",
  "name": "fugiat id qui pariatur velit",
  "speed": 53870556
}
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
{
  "billing_id": "magna ad consectetur pariatur do",
  "speed": -77489408
}
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": "labore id",
  "name": "commodo dolore ut exercitation",
  "speed": 25225788
}
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": -81992316
  },
  {}
]
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
{}
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
{}
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
{
  "id": -62185583,
  "name": "consequat aliquip ex occaecat ut"
}
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
{}
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
{}
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
[
  {}
]
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
{
  "id": -79196587
}
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
{
  "id": 66879896,
  "name": "ut"
}
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
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
[
  {
    "parent": {
      "id": 2412024,
      "name": "mollit Excepteur ea id"
    },
    "id": -35725689,
    "ssh": {
      "port": -49042332,
      "public_key": "quis laborum ipsum ad sed"
    }
  },
  {
    "name": "incididunt nostrud",
    "group": {
      "name": "nisi laborum in",
      "id": -40688795
    },
    "ssh": {
      "port": 27574609
    }
  },
  {
    "http": {
      "use_https": false,
      "port": -45607900,
      "host": "mollit quis"
    },
    "group": {
      "id": 11960115
    },
    "id": -19795659,
    "parent": {
      "name": "commodo"
    }
  },
  {}
]
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": "aliqua pariatur eiusmod",
  "install_max_concurrent": -65394385,
  "group_id": -85583920,
  "http": {
    "api_key": "veniam",
    "host": "fugiat consequat"
  },
  "enim4d5": 20854695,
  "laboref": -39410900,
  "elitd": true
}
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
{}
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": "occaecat aute fugiat consectetur in",
  "install_max_concurrent": 43911407,
  "group_id": -30406560,
  "Lorem6": 69232592,
  "voluptatee5": true,
  "quis42a": false,
  "aliqua2f7": -76446828
}
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
{}
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
{
  "ssh": {
    "port": "repr",
    "public_key": "pariatur fugiat"
  },
  "install_max_concurrent": -71306433,
  "name": "magna ipsum Excepteur Lorem in"
}
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": "ut minim",
  "folder": "sint ",
  "url": "Ut mollit ad"
}
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": -21701814
}
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": "in qui proident anim",
  "folder": "aliquip laboris",
  "url": "non aliquip sed est"
}
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
{
  "id": -72671646
}
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
{}
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
{
  "name": "ea aute exercitation velit",
  "id": 31673992,
  "created_at": {
    "iso_8601": "ipsum fugiat in",
    "unix": 85433261
  }
}
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": "nulla tempor minim dolore aliqua",
  "name": "deserunt labore Lorem",
  "folder": "eiusmod reprehenderit"
}
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": "ea dolore Excepteur ut nisi",
    "name": "occaecat reprehenderit ad"
  },
  {},
  {},
  {
    "id": -49843884,
    "is_enabled": true
  },
  {
    "id": -1075208
  }
]
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
{}
Schema
{
  "properties": {
    "is_enabled": {
      "type": "boolean"
    },
    "license_key": {
      "type": "string"
    }
  }
}
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"
}
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "is_enabled": false,
  "license_key": "commodo Excepteur"
}
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": "culpa labore dolore "
  },
  {},
  {
    "id": 89997672
  },
  {
    "description": "ipsum",
    "name": "in adipisicing"
  }
]
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": "sed"
}
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
{
  "is_installable": false
}
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": "in veniam",
  "description": "nulla ut"
}
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
{
  "name": "elit ut",
  "body": "aliqua dolor",
  "description": "qui ut a"
}
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
{}
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
{}
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": "adipisici"
}
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
[
  {
    "name": "ex labore nulla nostrud",
    "iso": {
      "id": -57695102
    },
    "id": -4148061
  }
]
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": "cupidatat sit quis Duis",
  "boot_script": {
    "id": 72994198
  },
  "preseed": {
    "id": 94946562,
    "name": "elit quis do"
  }
}
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
{}
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": "deserunt eiusmod",
  "boot_script": {},
  "drivers": [
    {
      "name": "nostrud"
    },
    {
      "id": -38777794,
      "name": "aute cillum esse consequat cupidatat"
    }
  ],
  "billing_id": "dolor incididunt Duis",
  "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
{}
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
{
  "drivers": [
    {
      "id": -95251577,
      "name": "esse Ut"
    },
    {
      "id": 13029700,
      "name": "dolor reprehenderit quis eu"
    },
    {
      "name": "in",
      "id": 17718991
    },
    {
      "name": "occa",
      "id": -80592860
    }
  ]
}
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
{
  "access_client": false
}
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": -86646608,
    "description": "in",
    "name": "ipsum adipisicing cillum Excepteur"
  },
  {
    "description": "adipisicing veniam Ut",
    "name": "sunt ut"
  },
  {
    "name": "voluptate ut cillum fugiat",
    "description": "esse dolore nulla consectetur",
    "id": -62004238
  }
]
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": "esse commodo ut irure aute"
}
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
{
  "id": 30673122,
  "name": "Ut sed dolor",
  "body": "non nisi "
}
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": "ipsum min"
}
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_s