Retrieve settings

GET /show
Retrieve settings for PortSIP PBX.
Path parameters
  • access_token

    string

    required

    token to be passed as a header

    minLength: 64

    maxLength: 64

Sample Request

                      curl -v -X GET http://127.0.0.1:8990/api/settings/show \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
                      
                    

Responses

200
Successful operation
application/json
  • paging_intercom

    object

    Show child attributes
  • blf

    object

    Show child attributes
  • general

    object

    Show child attributes

Sample Response

                      
{}
                      
                    

Update PBX mode and ip

POST /pbx_mode_ip/update
Update PBX mode and ip
Path parameters
  • access_token

    string

    required

    token to be passed as a header

    minLength: 64

    maxLength: 64

Request body
application/json
  • pbx_private_ip_v6

    string

    required

    private IPv6 address for PortSIP PBX
  • pbx_private_ip_v4

    string

    required

    private IPv4 address for PortSIP PBX
  • pbx_public_ip_v6

    string

    required

    public IPv6 address for PortSIP PBX
  • pbx_web_domain

    string

    required

    web domain for PortSIP PBX
  • pbx_public_ip_v4

    string

    required

    public IPv4 address for PortSIP PBX

Sample Request

                      curl -v -X POST http://127.0.0.1:8990/api/settings/pbx_mode_ip/update \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
                          -d '{}'
                      
                    

Responses

200
Successful operation

Sample Response

                      
                      
                    

Update setting entry

POST /update
Update settings for PortSIP PBX
Path parameters
  • access_token

    string

    required

    token to be passed as a header

    minLength: 64

    maxLength: 64

Request body
application/json
  • paging_intercom

    object

    required

    Show child attributes
  • blf

    object

    required

    Show child attributes
  • general

    object

    required

    Show child attributes

Sample Request

                      curl -v -X POST http://127.0.0.1:8990/api/settings/update \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
                          -d '{}'
                      
                    

Responses

200
Successful operation

Sample Response

                      
                      
                    

Retrieve PBX system ip and mode.

GET /pbx_mode_ip/show
Path parameters
  • access_token

    string

    required

    token to be passed as a header

    minLength: 64

    maxLength: 64

Sample Request

                      curl -v -X GET http://127.0.0.1:8990/api/settings/pbx_mode_ip/show \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
                      
                    

Responses

200
Successful operation
application/json
  • pbx_web_domain

    string

    web domain for PortSIP PBX

Sample Response

                      
{}