Jump to

• Request
• Response

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 values

  Allowed Values: [ "restUsers", "clients", "properties" ]

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Ok. FPP server registration details retrieved.

Body ()

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

{
    "description":"FPP server registration summary",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/Target"
        }
    ],
    "properties":{
        "targetId":{
            "description":"ID of the cluster target, where the FPP server is running",
            "type":"string"
        },
        "totalRestUsers":{
            "description":"Total count of REST users registered with the FPP server",
            "type":"integer"
        },
        "totalClients":{
            "description":"Total count of clients registered with the FPP server",
            "type":"integer"
        },
        "totalProperties":{
            "description":"Total count of properties registered with the FPP server",
            "type":"integer"
        },
        "links":{
            "$ref":"#/components/schemas/FppServerLinks"
        },
        "restUsers":{
            "description":"REST user details registered with the FPP server",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CreateRestUserDetails"
            }
        },
        "clients":{
            "description":"Client details registered with the FPP server",
            "type":"array",
            "items":{
                "type":"object",
                "allOf":[
                    {
                        "$ref":"#/components/schemas/Target"
                    }
                ],
                "properties":{
                    "targetId":{
                        "description":"ID of the FPP client target",
                        "type":"string"
                    }
                }
            }
        },
        "properties":{
            "description":"Property details registered with the FPP server",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PropertySummary"
            }
        }
    }
}

Match All

FPP server registration summary

Show Source

• object schema
  Target details

{
    "description":"FPP server registration summary",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/Target"
        }
    ],
    "properties":{
        "targetId":{
            "description":"ID of the cluster target, where the FPP server is running",
            "type":"string"
        },
        "totalRestUsers":{
            "description":"Total count of REST users registered with the FPP server",
            "type":"integer"
        },
        "totalClients":{
            "description":"Total count of clients registered with the FPP server",
            "type":"integer"
        },
        "totalProperties":{
            "description":"Total count of properties registered with the FPP server",
            "type":"integer"
        },
        "links":{
            "$ref":"#/components/schemas/FppServerLinks"
        },
        "restUsers":{
            "description":"REST user details registered with the FPP server",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CreateRestUserDetails"
            }
        },
        "clients":{
            "description":"Client details registered with the FPP server",
            "type":"array",
            "items":{
                "type":"object",
                "allOf":[
                    {
                        "$ref":"#/components/schemas/Target"
                    }
                ],
                "properties":{
                    "targetId":{
                        "description":"ID of the FPP client target",
                        "type":"string"
                    }
                }
            }
        },
        "properties":{
            "description":"Property details registered with the FPP server",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PropertySummary"
            }
        }
    }
}

Nested Schema : clients

Type: array

Client details registered with the FPP server

Show Source

• Array of: object items

{
    "description":"Client details registered with the FPP server",
    "type":"array",
    "items":{
        "type":"object",
        "allOf":[
            {
                "$ref":"#/components/schemas/Target"
            }
        ],
        "properties":{
            "targetId":{
                "description":"ID of the FPP client target",
                "type":"string"
            }
        }
    }
}

Nested Schema : FppServerLinks

Type: object

Subresource links for the FPP server details

Show Source

• clients(required): object Link
  It represents a Link
• properties(required): object Link
  It represents a Link
• restUsers(required): object Link
  It represents a Link
• self(required): object Link
  It represents a Link

{
    "description":"Subresource links for the FPP server details",
    "type":"object",
    "required":[
        "self",
        "restUsers",
        "clients",
        "properties"
    ],
    "properties":{
        "self":{
            "$ref":"#/components/schemas/Link"
        },
        "restUsers":{
            "$ref":"#/components/schemas/Link"
        },
        "clients":{
            "$ref":"#/components/schemas/Link"
        },
        "properties":{
            "$ref":"#/components/schemas/Link"
        }
    }
}

Nested Schema : properties

Type: array

Property details registered with the FPP server

Show Source

• Array of: object PropertySummary
  Details of the property

{
    "description":"Property details registered with the FPP server",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/PropertySummary"
    }
}

Nested Schema : restUsers

Type: array

REST user details registered with the FPP server

Show Source

• Array of: object CreateRestUserDetails
  Details of REST user

{
    "description":"REST user details registered with the FPP server",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CreateRestUserDetails"
    }
}

Nested Schema : schema

Type: object

Target details

Show Source

• targetName: string
  Name of the target

  Example: sales_db1
• targetType: string
  Type of the target

  Example: oracle_database

{
    "description":"Target details",
    "type":"object",
    "properties":{
        "targetName":{
            "description":"Name of the target",
            "type":"string",
            "example":"sales_db1"
        },
        "targetType":{
            "description":"Type of the target",
            "type":"string",
            "example":"oracle_database"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• targetId: string
  ID of the FPP client target

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/Target"
        }
    ],
    "properties":{
        "targetId":{
            "description":"ID of the FPP client target",
            "type":"string"
        }
    }
}

Match All

Show Source

• object schema
  Target details

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/Target"
        }
    ],
    "properties":{
        "targetId":{
            "description":"ID of the FPP client target",
            "type":"string"
        }
    }
}

Nested Schema : Link

Type: object

It represents a Link

Show Source

• href: string
  URL for the link

{
    "type":"object",
    "properties":{
        "href":{
            "type":"string",
            "description":"URL for the link"
        }
    },
    "description":"It represents a Link"
}

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

{
    "description":"Details of the property",
    "type":"object",
    "required":[
        "name",
        "value"
    ],
    "properties":{
        "name":{
            "description":"Name of the property",
            "type":"string"
        },
        "value":{
            "description":"Value of the property",
            "type":"string"
        }
    }
}

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 URL

  Example: welcome1
• username(required): string
  REST username to be registered with the FPP server

{
    "description":"Details of REST user",
    "required":[
        "username",
        "password"
    ],
    "properties":{
        "username":{
            "description":"REST username to be registered with the FPP server",
            "type":"string"
        },
        "password":{
            "description":"Password to create the REST credential in EM, which is required to make a call to the FPP REST URL",
            "type":"string",
            "format":"password",
            "example":"welcome1"
        }
    }
}

Examples

Select an example Payload

400 Response

Bad Request

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

401 Response

Unauthorized

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

403 Response

Forbidden

Body ()

Root Schema : MissingPrivErrorResponse

Type: object

Response sent back as an Error in case required privileges are missing

Show Source

• missingPrivileges: array missingPrivileges
  Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object

{
    "type":"object",
    "properties":{
        "missingPrivileges":{
            "type":"array",
            "description":"Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object",
            "items":{
                "$ref":"#/components/schemas/MissingPrivilegeSummary"
            }
        }
    },
    "description":"Response sent back as an Error in case required privileges are missing",
    "allOf":[
        {
            "$ref":"#/components/schemas/ErrorResponse"
        }
    ]
}

Match All

Response sent back as an Error in case required privileges are missing

Show Source

• object ErrorResponse
  Response sent back in the case of an Error

{
    "type":"object",
    "properties":{
        "missingPrivileges":{
            "type":"array",
            "description":"Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object",
            "items":{
                "$ref":"#/components/schemas/MissingPrivilegeSummary"
            }
        }
    },
    "description":"Response sent back as an Error in case required privileges are missing",
    "allOf":[
        {
            "$ref":"#/components/schemas/ErrorResponse"
        }
    ]
}

Nested Schema : missingPrivileges

Type: array

Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object

Show Source

• Array of: object MissingPrivilegeSummary
  It represents a Privilege which is missing on a Resource to view or manage it.

{
    "type":"array",
    "description":"Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object",
    "items":{
        "$ref":"#/components/schemas/MissingPrivilegeSummary"
    }
}

Nested Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

Nested Schema : MissingPrivilegeSummary

Type: object

It represents a Privilege which is missing on a Resource to view or manage it.

Show Source

• displayName: string
  Display Name of Privilege

  Example: Manage
• name: string
  Name of Privilege

  Example: MANAGE_JOB

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of Privilege",
            "example":"MANAGE_JOB"
        },
        "displayName":{
            "type":"string",
            "description":"Display Name of Privilege",
            "example":"Manage"
        }
    },
    "description":"It represents a Privilege which is missing on a Resource to view or manage it."
}

404 Response

Not Found

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

500 Response

Internal Server Error

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

503 Response

Service Unavailable

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

Back to Top