diff --git a/en_US/iredadmin/2-iredadmin-pro.restful.api.md b/en_US/iredadmin/2-iredadmin-pro.restful.api.md index 3674f025..33140e4b 100644 --- a/en_US/iredadmin/2-iredadmin-pro.restful.api.md +++ b/en_US/iredadmin/2-iredadmin-pro.restful.api.md @@ -68,6 +68,19 @@ Notes: +### Login {: .toggle } + +!!! api "`POST`{: .post } `/api/login`{: .url } `Login with an admin username (full email address) and password`{: .comment } `Parameters`{: .has_params }" + +
+ + Parameter | Summary | Sample Usage + --- |--- |--- + `username` | Admin username. Must be a full email address. | `username=admin@mydomain.com` + `password` | (Plain) admin password. | `password=AsTr0ng@` + +
+ ### Domain {: .toggle } !!! api "`GET`{: .get } `/api/domain/`{: .url } `Get profile of an existing domain`{: .comment }" diff --git a/html/iredadmin-pro.restful.api.html b/html/iredadmin-pro.restful.api.html index f45e31a0..5958fcab 100644 --- a/html/iredadmin-pro.restful.api.html +++ b/html/iredadmin-pro.restful.api.html @@ -25,6 +25,7 @@
  • Enable RESTful API
  • Sample code to interact with iRedAdmin-Pro RESTful API
  • APIs

    +

    Login

    +
    +

    POST /api/login Login with an admin username (full email address) and password Parameters

    +
    + + + + + + + + + + + + + + + + + + + + + +
    ParameterSummarySample Usage
    usernameAdmin username. Must be a full email address.username=admin@mydomain.com
    password(Plain) admin password.password=AsTr0ng@
    +
    + +

    Domain

    GET /api/domain/<domain> Get profile of an existing domain