Skip to content

Latest commit

 

History

History
executable file
·
108 lines (81 loc) · 2.11 KB

tinc_web_ui.md

File metadata and controls

executable file
·
108 lines (81 loc) · 2.11 KB

TincWebUI

Operations with tinc-web-boot related to UI

TincWebUI.IssueAccessToken

Issue and sign token

  • Method: TincWebUI.IssueAccessToken

  • Returns: string

  • Arguments:

Position Name Type
0 validDays uint
curl -H 'Content-Type: application/json' --data-binary @- "http://127.0.0.1:8686/api/" <<EOF
{
    "jsonrpc" : "2.0",
    "id" : 1,
    "method" : "TincWebUI.IssueAccessToken",
    "params" : []
}
EOF

TincWebUI.Notify

Make desktop notification if system supports it

  • Method: TincWebUI.Notify

  • Returns: bool

  • Arguments:

Position Name Type
0 title string
1 message string
curl -H 'Content-Type: application/json' --data-binary @- "http://127.0.0.1:8686/api/" <<EOF
{
    "jsonrpc" : "2.0",
    "id" : 1,
    "method" : "TincWebUI.Notify",
    "params" : []
}
EOF

TincWebUI.Endpoints

Endpoints list to access web UI

  • Method: TincWebUI.Endpoints
  • Returns: []Endpoint
curl -H 'Content-Type: application/json' --data-binary @- "http://127.0.0.1:8686/api/" <<EOF
{
    "jsonrpc" : "2.0",
    "id" : 1,
    "method" : "TincWebUI.Endpoints",
    "params" : []
}
EOF

Endpoint

Json Type Comment
host string
port uint16
kind EndpointKind

TincWebUI.Configuration

Configuration defined for the instance

  • Method: TincWebUI.Configuration
  • Returns: *Config
curl -H 'Content-Type: application/json' --data-binary @- "http://127.0.0.1:8686/api/" <<EOF
{
    "jsonrpc" : "2.0",
    "id" : 1,
    "method" : "TincWebUI.Configuration",
    "params" : []
}
EOF

Config

Json Type Comment
binding string