POST /platforms/:platform/known-hosts

[davidraker]

Create a new known-host record for another platform known to the specified platform.

The Location header will return a route to the new resource, with :known-host having the format :address-:port.

Note: Attempting to create a known host entry when one already exists for the same address/port combination will return 409 Conflict with a Content-Location header pointing to the route of the conflicting record.

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

Request:

• Authorization: BEARER <jwt_token>
  • Content Type: application/json
  • Body:

    {
        "address": "<address>",
        "port": "<port>",
        "key": "<server_key>"
    },
    

Response:

• With valid BEARER token on success: 201 Created
  • Location: /platforms/:platform/known-hosts/:known-host
• With valid BEARER token if group name already exists: 409 Conflict
  • Content Type: application/json
  • Content-Location: /vui/platforms/:platform/known-hosts/:address-:port
  • Body:

    {
        "error": "Unable to create known-host entry: :address-:port, as a known host entry with this address and port already exists ."
    }
    

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

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

• With invalid BEARER token: 401 Unauthorized