Register FPP Server
post
https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/fppServers
Registers FPP server with Enterprise Manager along with necessary details required for performing database maintenance
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : schema
Type:
object
Input to register the FPP server
Show Source
-
name(required): string
FPP server target name
-
properties(required): object
properties
FPP server properties to be registered
-
restUser(required):
CreateRestUserDetails
Details of REST user
-
schedule: object
Schedule
Schedule details
Nested Schema : properties
Type:
object
FPP server properties to be registered
Show Source
-
agentCredential(required): string
Named credential of the agent - CREDENTIAL:OWNER, where OWNER is optionalExample:
NC_DEV:ADMIN, NC_DEV
-
restUrl(required): string
REST url to be registered with the FPP serverExample:
https://xyz.com:4473/em/api/fppServers
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
Nested Schema : Schedule
Type:
object
Schedule details
Show Source
-
isTargetZone: boolean
To indicate if the time should be interpreted in the target timezone or not. If timezone is specified in time and isTargetZone is true, it will be reported as an ERROR condition
-
recurring: string
Frequency at which the operation must be executed repeatedlyExample:
frequency:weekly;days:2,
-
scheduleType: string
Currently we support ICAL specification default is ICAL, in the future it can be extended to other types e.g CRON.
-
startGracePeriodInMinutes: integer
Time in minutes after which the job will be marked as skipped if not started. Null or Negative value means no grace period.Example:
60
-
timeToEnd: string
(date-time)
End time
-
timeToStart: string
(date-time)
Start time
Examples
Back to Top
Response
201 Response
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