Portal Core (0.30.6)

Download OpenAPI specification:Download

Core software stack that manages all aspects of a Portal

/internal

App Error

path Parameters

status

required

integer (Status)

Responses

Response samples

200
422

Content type

application/json

null

Authenticate Terminal

cookie Parameters

authorization

string (Authorization)

Responses

Response samples

200
422

Content type

application/json

null

Authenticate Management

header Parameters

authorization

string (Authorization)

Responses

Response samples

200
422

Content type

application/json

null

Authenticate And Authorize

cookie Parameters

authorization

string (Authorization)

header Parameters

x-forwarded-host	string (X-Forwarded-Host)
x-forwarded-uri	string (X-Forwarded-Uri)

Responses

Response samples

200
422

Content type

application/json

null

Call Backend

path Parameters

rest

required

string (Rest)

Responses

Response samples

200
422

Content type

application/json

null

Call Backend

path Parameters

rest

required

string (Rest)

Responses

Response samples

200
422

Content type

application/json

null

Call Backend

path Parameters

rest

required

string (Rest)

Responses

Response samples

200
422

Content type

application/json

null

Call Backend

path Parameters

rest

required

string (Rest)

Responses

Response samples

200
422

Content type

application/json

null

Call Backend

path Parameters

rest

required

string (Rest)

Responses

Response samples

200
422

Content type

application/json

null

Call Backend

path Parameters

rest

required

string (Rest)

Responses

Response samples

200
422

Content type

application/json

null

Call Backend

path Parameters

rest

required

string (Rest)

Responses

Response samples

200
422

Content type

application/json

null

Call Peer

path Parameters

portal_id required	string (Portal Id)
rest required	string (Rest)

Responses

Response samples

200
422

Content type

application/json

null

Call Peer

path Parameters

portal_id required	string (Portal Id)
rest required	string (Rest)

Responses

Response samples

200
422

Content type

application/json

null

Call Peer

path Parameters

portal_id required	string (Portal Id)
rest required	string (Rest)

Responses

Response samples

200
422

Content type

application/json

null

Call Peer

path Parameters

portal_id required	string (Portal Id)
rest required	string (Rest)

Responses

Response samples

200
422

Content type

application/json

null

Call Peer

path Parameters

portal_id required	string (Portal Id)
rest required	string (Rest)

Responses

Response samples

200
422

Content type

application/json

null

Call Peer

path Parameters

portal_id required	string (Portal Id)
rest required	string (Rest)

Responses

Response samples

200
422

Content type

application/json

null

Call Peer

path Parameters

portal_id required	string (Portal Id)
rest required	string (Rest)

Responses

Response samples

200
422

Content type

application/json

null

/public

Health

Responses

Response samples

200

Content type

application/json

{"status": "string"
}

Who Are You

Responses

Response samples

200

Content type

application/json

{"id": "string",
"name": "string",
"email": "string",
"description": "string",
"is_default": true,
"public_key_pem": "string",
"domain": "string"
}

Get Default Avatar

Responses

Response samples

200

Content type

application/json

null

Who Am I

cookie Parameters

authorization

string (Authorization)

Responses

Response samples

200
422

Content type

application/json

{"type": "terminal",
"id": "string",
"name": "string"
}

Add Terminal

query Parameters

code

required

string (Code)

Request Body schema: application/json

name required	string (Name)
icon	string (Icon) Default: "unknown" Enum: "unknown" "smartphone" "tablet" "notebook" "desktop" An enumeration.

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"icon": "unknown"
}

Response samples

201
422

Content type

application/json

null

/protected

List All Apps

Responses

Response samples

200

Content type

application/json

[{"name": "string",
"installation_reason": "unknown",
"status": "unknown",
"last_access": "2019-08-24T14:15:22Z",
"meta": {"v": "string",
"app_version": "string",
"upstream_repo": "string",
"homepage": "string",
"name": "string",
"pretty_name": "string",
"icon": "string",
"entrypoints": [{"container_name": "string",
"container_port": 0,
"entrypoint_port": "http"
}
],
"paths": {"property1": {"access": "public",
"headers": {"property1": "string",
"property2": "string"
}
},
"property2": {"access": "public",
"headers": {"property1": "string",
"property2": "string"
}
}
},
"lifecycle": {"always_on": false,
"idle_time_for_shutdown": 60
},
"minimum_portal_size": "xs",
"store_info": {"description_short": "string",
"description_long": "string",
"hint": "string",
"is_featured": true
}
}
}
]

Install Custom App

Request Body schema: multipart/form-data

file

required

string <binary> (File)

Responses

Response samples

201
422

Content type

application/json

null

Get App

path Parameters

name

required

string (Name)

Responses

Response samples

200
422

Content type

application/json

{"name": "string",
"installation_reason": "unknown",
"status": "unknown",
"last_access": "2019-08-24T14:15:22Z",
"meta": {"v": "string",
"app_version": "string",
"upstream_repo": "string",
"homepage": "string",
"name": "string",
"pretty_name": "string",
"icon": "string",
"entrypoints": [{"container_name": "string",
"container_port": 0,
"entrypoint_port": "http"
}
],
"paths": {"property1": {"access": "public",
"headers": {"property1": "string",
"property2": "string"
}
},
"property2": {"access": "public",
"headers": {"property1": "string",
"property2": "string"
}
}
},
"lifecycle": {"always_on": false,
"idle_time_for_shutdown": 60
},
"minimum_portal_size": "xs",
"store_info": {"description_short": "string",
"description_long": "string",
"hint": "string",
"is_featured": true
}
}
}

Install App

path Parameters

name

required

string (Name)

Responses

Response samples

201
422

Content type

application/json

null

Uninstall App

path Parameters

name

required

string (Name)

Responses

Response samples

422

Content type

application/json

{"detail": [{"loc": ["string"
],
"msg": "string",
"type": "string"
}
]
}

Get App Icon

path Parameters

name

required

string (Name)

Responses

Response samples

200
422

Content type

application/json

null

Reinstall App

path Parameters

name

required

string (Name)

Responses

Response samples

201
422

Content type

application/json

null

Get Backup Info

Responses

Response samples

200

Content type

application/json

{"last_report": {"directories": [{"directory": "string",
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"bytes": 0,
"checks": 0,
"deletedDirs": 0,
"deletes": 0,
"elapsedTime": 0,
"errors": 0,
"fatalError": true,
"renames": 0,
"retryError": true,
"serverSideCopies": 0,
"serverSideCopyBytes": 0,
"serverSideMoveBytes": 0,
"serverSideMoves": 0,
"speed": 0,
"totalBytes": 0,
"totalChecks": 0,
"totalTransfers": 0,
"transferTime": 0,
"transfers": 0
}
],
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z"
},
"last_passphrase_access_info": {"time": "2019-08-24T14:15:22Z",
"terminal_id": "string",
"terminal_name": "string"
}
}

Get Backup Passphrase

header Parameters

x-ptl-client-id

string (X-Ptl-Client-Id)

Responses

Response samples

200
422

Content type

application/json

{"passphrase": "string"
}

Start Backup

Responses

Export Backup

Responses

Response samples

200

Content type

application/json

null

Post Quick Feedback

Request Body schema: application/json

text

required

string (Text)

Responses

Request samples

Payload

Content type

application/json

{"text": "string"
}

Response samples

201
422

Content type

application/json

null

List All Identities

query Parameters

name	string (Name)

Responses

Response samples

200
422

Content type

application/json

[{"id": "string",
"name": "string",
"email": "string",
"description": "string",
"is_default": true,
"public_key_pem": "string",
"domain": "string"
}
]

Put Identity

Request Body schema: application/json

id	string (Id)
name	string (Name) Default: ""
email	string (Email) Default: ""
description	string (Description) Default: ""

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"name": "",
"email": "",
"description": ""
}

Response samples

201
422

Content type

application/json

{"id": "string",
"name": "string",
"email": "string",
"description": "string",
"is_default": true,
"public_key_pem": "string",
"domain": "string"
}

Get Default Identity

Responses

Response samples

200

Content type

application/json

{"id": "string",
"name": "string",
"email": "string",
"description": "string",
"is_default": true,
"public_key_pem": "string",
"domain": "string"
}

Get Identity By Id

path Parameters

id

required

any (Id)

Responses

Response samples

200
422

Content type

application/json

{"id": "string",
"name": "string",
"email": "string",
"description": "string",
"is_default": true,
"public_key_pem": "string",
"domain": "string"
}

Get Default Avatar

Responses

Response samples

200

Content type

application/json

null

Put Default Avatar

Request Body schema: multipart/form-data

file

required

string <binary> (File)

Responses

Response samples

200
422

Content type

application/json

null

Delete Default Avatar

Responses

Response samples

200

Content type

application/json

null

Get Avatar By Identity

path Parameters

id

required

any (Id)

Responses

Response samples

200
422

Content type

application/json

null

Put Avatar

path Parameters

id

required

string (Id)

Request Body schema: multipart/form-data

file

required

string <binary> (File)

Responses

Response samples

201
422

Content type

application/json

null

Delete Avatar

path Parameters

id

required

string (Id)

Responses

Response samples

200
422

Content type

application/json

null

Make Identity Default

path Parameters

id

required

any (Id)

Responses

Response samples

422

Content type

application/json

{"detail": [{"loc": ["string"
],
"msg": "string",
"type": "string"
}
]
}

List All Peers

query Parameters

name	string (Name)

Responses

Response samples

200
422

Content type

application/json

[{"id": "string",
"name": "string",
"public_bytes_b64": "string",
"is_reachable": true
}
]

Put Peer

Request Body schema: application/json

id required	string (Id)
name	string (Name)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"name": "string"
}

Response samples

200
422

Content type

application/json

{"id": "string",
"name": "string",
"public_bytes_b64": "string",
"is_reachable": true
}

Get Peer By Id

path Parameters

id

required

any (Id)

Responses

Response samples

200
422

Content type

application/json

{"id": "string",
"name": "string",
"public_bytes_b64": "string",
"is_reachable": true
}

Delete Peer

path Parameters

id

required

any (Id)

Responses

Response samples

422

Content type

application/json

{"detail": [{"loc": ["string"
],
"msg": "string",
"type": "string"
}
]
}

List All Terminals

Responses

Response samples

200

Content type

application/json

[{"id": "string",
"name": "string",
"icon": "unknown",
"last_connection": "2019-08-24T14:15:22Z"
}
]

Get Terminal By Id

path Parameters

id_

required

string (Id )

Responses

Response samples

200
422

Content type

application/json

null

Edit Terminal

path Parameters

id_

required

string (Id )

Request Body schema: application/json

name required	string (Name)
icon	string (Icon) Default: "unknown" Enum: "unknown" "smartphone" "tablet" "notebook" "desktop" An enumeration.

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"icon": "unknown"
}

Response samples

200
422

Content type

application/json

null

Delete Terminal By Id

path Parameters

id_

required

string (Id )

Responses

Response samples

422

Content type

application/json

{"detail": [{"loc": ["string"
],
"msg": "string",
"type": "string"
}
]
}

Get Terminal By Name

path Parameters

name

required

string (Name)

Responses

Response samples

200
422

Content type

application/json

{"id": "string",
"name": "string",
"icon": "unknown",
"last_connection": "2019-08-24T14:15:22Z"
}

New Pairing Code

query Parameters

deadline

integer (Deadline)

Responses

Response samples

201
422

Content type

application/json

{"code": "string",
"created": "2019-08-24T14:15:22Z",
"valid_until": "2019-08-24T14:15:22Z"
}

List Tours

Responses

Response samples

200

Content type

application/json

[{"name": "string",
"status": "seen"
}
]

Put Tour

Request Body schema: application/json

name required	string (Name)
status required	string (TourStatus) Enum: "seen" "unseen" An enumeration.

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"status": "seen"
}

Response samples

422

Content type

application/json

{"detail": [{"loc": ["string"
],
"msg": "string",
"type": "string"
}
]
}

Reset Tours

Responses

Get Tour

path Parameters

name

required

string (Name)

Responses

Response samples

200
422

Content type

application/json

{"name": "string",
"status": "seen"
}

Get Profile

query Parameters

refresh

boolean (Refresh)

Default: false

Responses

Response samples

200
422

Content type

application/json

{"vm_id": "string",
"owner": "string",
"owner_email": "string",
"time_created": "2019-08-24T14:15:22Z",
"time_assigned": "2019-08-24T14:15:22Z",
"delete_after": "2019-08-24T14:15:22Z",
"portal_size": "xs",
"max_portal_size": "xs"
}

Call Management

path Parameters

rest

required

string (Rest)

Responses

Response samples

200
422

Content type

application/json

null

Call Management

path Parameters

rest

required

string (Rest)

Responses

Response samples

200
422

Content type

application/json

null

Call Management

path Parameters

rest

required

string (Rest)

Responses

Response samples

200
422

Content type

application/json

null

Call Management

path Parameters

rest

required

string (Rest)

Responses

Response samples

200
422

Content type

application/json

null

Call Management

path Parameters

rest

required

string (Rest)

Responses

Response samples

200
422

Content type

application/json

null

Call Management

path Parameters

rest

required

string (Rest)

Responses

Response samples

200
422

Content type

application/json

null

Call Management

path Parameters

rest

required

string (Rest)

Responses

Response samples

200
422

Content type

application/json

null

Prune Images

Prune all unused docker images.

Responses

Response samples

200

Content type

application/json

null

Disk Usage

Responses

Response samples

200

Content type

application/json

{"total_gb": 0,
"free_gb": 0,
"disk_space_low": true
}

Tasks

Responses

Response samples

200

Content type

application/json

null

/management

Install App

path Parameters

name

required

string (Name)

Responses

Response samples

201
422

Content type

application/json

null