Get FPP Server Details
get
https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/fppServers/{fppServerId}
Gets the details of the FPP server including clients and REST users
Request
Path Parameters
-
fppServerId(required): string
ID of the FPP server
Query Parameters
-
expand: string
restUsers | clients | properties are possible valuesAllowed Values:
[ "restUsers", "clients", "properties" ]
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Ok. FPP server registration details retrieved.
Root Schema : FppServer
Type:
object
FPP server registration summary
Show Source
-
clients: array
clients
Client details registered with the FPP server
-
links: object
FppServerLinks
Subresource links for the FPP server details
-
properties: array
properties
Property details registered with the FPP server
-
restUsers: array
restUsers
REST user details registered with the FPP server
-
targetId: string
ID of the cluster target, where the FPP server is running
-
totalClients: integer
Total count of clients registered with the FPP server
-
totalProperties: integer
Total count of properties registered with the FPP server
-
totalRestUsers: integer
Total count of REST users registered with the FPP server
Match All
Show Source
Nested Schema : FppServerLinks
Type:
object
Subresource links for the FPP server details
Show Source
-
clients(required): object
Link
Represents a link(could be self, previous or next)
-
properties(required): object
Link
Represents a link(could be self, previous or next)
-
restUsers(required): object
Link
Represents a link(could be self, previous or next)
-
self(required): object
Link
Represents a link(could be self, previous or next)
Nested Schema : properties
Type:
array
Property details registered with the FPP server
Show Source
-
Array of:
object PropertySummary
Details of the property
Nested Schema : restUsers
Type:
array
REST user details registered with the FPP server
Show Source
-
Array of:
object CreateRestUserDetails
Details of REST user
Nested Schema : schema
Type:
object
Target details
Show Source
-
targetName: string
Name of the targetExample:
sales_db1
-
targetType: string
Type of the targetExample:
oracle_database
Nested Schema : items
Type:
Show Source
object
-
targetId: string
ID of the FPP client target
Match All
Show Source
Nested Schema : Link
Type:
object
Represents a link(could be self, previous or next)
Show Source
-
href: string
URL for LinkExample:
/em/api/<resources>?page=b2Zmc2V0OjA&limit=0
Nested Schema : PropertySummary
Type:
object
Details of the property
Show Source
-
name(required): string
Name of the property
-
value(required): string
Value of the property
Nested Schema : CreateRestUserDetails
Type:
object
Details of REST user
Show Source
-
password(required): string
(password)
Password to create the REST credential in EM, which is required to make a call to the FPP REST URLExample:
welcome1
-
username(required): string
REST username to be registered with the FPP server
Examples
400 Response
Bad Request. The payload is null or missing some parameters
Root Schema : ErrorResponse
Type:
object
Error response
Show Source
-
code(required): string
A short error code that defines the error, meant for programmatic parsing
-
message(required): string
A human-readable error string
401 Response
Unauthorized. The user does not have permissions to perform the requested operation
Root Schema : ErrorResponse
Type:
object
Error response
Show Source
-
code(required): string
A short error code that defines the error, meant for programmatic parsing
-
message(required): string
A human-readable error string
403 Response
Forbidden. The user is forbidden to perform the requested operation
Root Schema : ErrorResponse
Type:
object
Error response
Show Source
-
code(required): string
A short error code that defines the error, meant for programmatic parsing
-
message(required): string
A human-readable error string
404 Response
Not Found. The requested REST API URL is not found.
Root Schema : ErrorResponse
Type:
object
Error response
Show Source
-
code(required): string
A short error code that defines the error, meant for programmatic parsing
-
message(required): string
A human-readable error string
500 Response
Internal Server Error. Exception in execution of REST API.
Root Schema : ErrorResponse
Type:
object
Error response
Show Source
-
code(required): string
A short error code that defines the error, meant for programmatic parsing
-
message(required): string
A human-readable error string
503 Response
Service Unavailable. The server is unable to process the request.
Root Schema : ErrorResponse
Type:
object
Error response
Show Source
-
code(required): string
A short error code that defines the error, meant for programmatic parsing
-
message(required): string
A human-readable error string