GET /platforms/:platform/known-hosts

[davidraker]

Retrieve routes to the known-host records of platforms known to the specified platform.

To retrieve the records for all known-hosts on the platform, set the records query parameter to true.

⚠️ The colon is a reserved character in a URI. The path variable for routes to known hosts is delimited by a dash: e.g.: <address>-<port>.

Request:

• Authorization: BEARER <jwt_token>

Response:

• With valid BEARER token on success: 200 OK
  • Content Type: application/json
  • Body:

    {
       "route_options": {
        "<host_address>-<host_port>": "/platforms/:platform/known-hosts/:host_address-:host_port",
        "<host_address>-<host_port>": "/platforms/:platform/known-hosts/:host_address-:host_port"
    }
    

  • Body (with records=true):

    {
         <host_address>-<host_port>": {
                "route": "/platforms/:platform/known-hosts/:host_address-:host_port",
                "record": {
                    "addresss": "<address>".
                    "port": "<port>",
                    "key": "<server_key>"
                },  
        <host_address>-<host_port>": {
                "route": "/platforms/:platform/known-hosts/:host_address-:host_port",
                "record": {
                    "addresss": "<address>".
                    "port": "<port>",
                    "key": "<server_key>"
                }
    }
    

• With valid BEARER token on failure: 400 Bad Request
  • Content Type: application/json
  • Body:

    {
        "error": "<Error Message>"
    }
    

• With invalid BEARER token: 401 Unauthorized