Guide for Rest API for ISPCONFIG 3.1

Discussion in 'ISPConfig 3 Priority Support' started by pawan, Oct 2, 2016.

  1. pawan

    pawan Member

    Hi Till,
    Is there any guide or documentation for using Rest API with ISPCONFIG 3.1 ?
    I am very keen to know more abut it and using it.
  2. till

    till Super Moderator Staff Member ISPConfig Developer

    There is no documentation available for that yet. The REST API is absically a REST wrapper for the existing SOAP api (or in other words, just a second communication protocol for the existing api) and for the SOAP api has a documentation, you can find it in the remote_client folder of the ISPConfig tar.gz file.
  3. maumar

    maumar Member

    Hello Till
    lately I am trying to upgrade to 3.1, I let this job for xmas vacation
    Regarding remote interface, only to be sure I am understanding well:
    the functions the were into /usr/local/ispconfig/interface/lib/classes/
    were splitted into files located at /usr/local/ispconfig/interface/lib/classes/remote.d/
    The 2 custom functions that I coded myself to handle dns (I create automatically dns slave zones)

    public function dns_slave_add($session_id, $client_id, $params)
    public function dns_slave_delete($session_id, $primary_id)

    now should be inserted into:
    isn't it?

    If I am not ready to use REST Api, can I use 3.0 soap interface?
  4. till

    till Super Moderator Staff Member ISPConfig Developer

    Yes. Or even better, create your own file in remote.d for them so they don't get overridden by an update.

    Yes, the soap interface still exists and will exist in future. the REST api is just a wrapper for those users that prefer REST over SOAP.
    maumar likes this.

Share This Page