List remote portals - Fluid Topics - Latest

Fluid Topics API Reference Guide
Category
Reference Guides
Audience
public
Version
Latest

This web service returns all remote portals configured on the portal, along with their connectivity status.

  • This web service is available to users or API keys with the ADMIN role.
  • It is necessary to provide an Ft-Calling-App value when using Fluid Topics web services. See Fluid Topics calling app.
Method Endpoint
GET 
/api/remote-portals

Response body

The following example shows a JSON response body for this web service:

[
  {
    "id": "remote-abc",
    "baseUrl": "https://other-portal.fluidtopics.com",
    "status": {
      "status": "OK",
      "remoteServerVersion": "4.5.0"
    }
  }
]
Field Type Description
id String Unique identifier of the remote portal.
baseUrl String Base URL of the remote Fluid Topics portal.
status Object Connectivity status of the remote portal.
status String Connection status. Possible values are:
  • FAILED
  • FORBIDDEN
  • INCOMPATIBLE
  • OK
  • UNAUTHORIZED
  • UNREACHABLE
remoteServerVersion String Version of the remote Fluid Topics server. Only present when the connection status is OK or version is INCOMPATIBLE.
Return code Description
200 OK Returns the list of remote portals.
401 UNAUTHORIZED The authorization header is absent or invalid.
403 FORBIDDEN The user or API key must be an ADMIN.

For a comprehensive list of all possible return codes, see Return codes.