Appearance
fnb-home-proxy
5 endpoints.
GET /api/v1/fnb-home-proxy/status
Status
200 — Successful Response
json
{
"additionalProperties": true,
"type": "object",
"title": "Response Status Api V1 Fnb Home Proxy Status Get"
}POST /api/v1/fnb-home-proxy/install-command
Install Command
The one line to paste into PowerShell on the home PC.
200 — Successful Response
json
{
"additionalProperties": true,
"type": "object",
"title": "Response Install Command Api V1 Fnb Home Proxy Install Command Post"
}GET /api/v1/fnb-home-proxy/script
Script
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
token | query | no | string |
200 — Successful Response
422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}POST /api/v1/fnb-home-proxy/enroll
Enroll
Add the PC's public key to the tunnel account (one line per computer name; running the set-up again on the same PC replaces its line and keeps its port). Answers the port the PC's tunnel listens on.
Request body
json
{
"properties": {
"token": {
"type": "string",
"title": "Token"
},
"public_key": {
"type": "string",
"title": "Public Key"
},
"computer": {
"type": "string",
"title": "Computer",
"default": ""
}
},
"type": "object",
"required": [
"token",
"public_key"
],
"title": "EnrollBody"
}200 — Successful Response
json
{
"additionalProperties": true,
"type": "object",
"title": "Response Enroll Api V1 Fnb Home Proxy Enroll Post"
}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}GET /api/v1/fnb-home-proxy/check
Check
The set-up script's own test: does this PC's tunnel pass traffic now? Asked from the PC with its set-up token, so it holds no Force login.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
token | query | no | string | |
computer | query | no | string |
200 — Successful Response
json
{
"type": "object",
"additionalProperties": true,
"title": "Response Check Api V1 Fnb Home Proxy Check Get"
}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}