Synchronize Image Series
post
https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/fppServers/{fppServerId}/actions/sync
Submits a job to Synchronize the image series in the FPP server(s) with the data stored in Enterprise Manager
Request
Path Parameters
-
fppServerId(required): string
ID of the FPP server
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
type: string
Default Value:
BOTH
Allowed Values:[ "DATA", "CERTIFICATE", "BOTH" ]
It describes the sync type
Examples
Back to Top
Response
202 Response
It is a long running/async API. It submits a deployment procedure.
Headers
-
Location:
URL link to track the status of the API for the deployment procedureExample:
/deploymentProcedureInstances/{deploymentProcedureInstanceId}
Root Schema : schema
Type:
Show Source
object
-
links: object
links
links
-
message: string
messageExample:
It is a long running/async API. It submits a deployment procedure.
Nested Schema : links
Type:
object
links
Show Source
-
tracking: object
tracking
Represents a link to the REST API to track the status of the submitted deployment procedure
Nested Schema : tracking
Type:
object
Represents a link to the REST API to track the status of the submitted deployment procedure
Show Source
-
href: string
URL for the linkExample:
/deploymentProcedureInstances/{deploymentProcedureInstanceId}
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
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