Jump to

• Request
• Response

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

Request Body - 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
  Defining time schedule

{
    "description":"Input to register the FPP server",
    "type":"object",
    "required":[
        "name",
        "properties",
        "restUser"
    ],
    "properties":{
        "name":{
            "description":"FPP server target name",
            "type":"string"
        },
        "properties":{
            "description":"FPP server properties to be registered",
            "type":"object",
            "required":[
                "restUrl",
                "agentCredential"
            ],
            "properties":{
                "restUrl":{
                    "description":"REST url to be registered with the FPP server",
                    "type":"string",
                    "example":"https://xyz.com:portnumber/em/api/fppServers"
                },
                "agentCredential":{
                    "description":"Named credential of the agent - CREDENTIAL:OWNER, where OWNER is optional",
                    "type":"string",
                    "example":"NC_DEV:ADMIN, NC_DEV"
                }
            }
        },
        "restUser":{
            "$ref":"#/components/schemas/CreateRestUserDetails"
        },
        "schedule":{
            "$ref":"#/components/schemas/Schedule"
        }
    }
}

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 optional

  Example: NC_DEV:ADMIN, NC_DEV
• restUrl(required): string
  REST url to be registered with the FPP server

  Example: https://xyz.com:portnumber/em/api/fppServers

{
    "description":"FPP server properties to be registered",
    "type":"object",
    "required":[
        "restUrl",
        "agentCredential"
    ],
    "properties":{
        "restUrl":{
            "description":"REST url to be registered with the FPP server",
            "type":"string",
            "example":"https://xyz.com:portnumber/em/api/fppServers"
        },
        "agentCredential":{
            "description":"Named credential of the agent - CREDENTIAL:OWNER, where OWNER is optional",
            "type":"string",
            "example":"NC_DEV:ADMIN, NC_DEV"
        }
    }
}

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"
        }
    }
}

Nested Schema : Schedule

Type: object

Defining time schedule

Show Source

• isTargetZoneUsed: boolean
  To indicate the time should be interpreted in target's timezone or not. If Timezone is specified in time and useTargetZone is true, it will be reported as an ERROR condition

  Example: true
• recurring: string
  Frequency at which the operation must be executed repeatedly

  Example: Weekly
• scheduleType: string
  Currently we support ical specification default is ICAL, in future it can be extended to other types e.g CRON.
• startGracePeriodInMinutes: number
  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
  end time for the job in the format YYYY-MM-DDTHH24:Mi:SSZTimezone Timezone specification is optional and will be defaulted to UTC.

  Example: 2021-03-02 22:00:13
• timeToStart: string
  start time for the job in the format YYYY-MM-DDTHH24:Mi:SSZTimezone Timezone specification is optional and will be defaulted to UTC.

  Example: 2021-03-01 21:23:03

{
    "description":"Defining time schedule",
    "type":"object",
    "properties":{
        "timeToStart":{
            "type":"string",
            "description":"start time for the job in the format YYYY-MM-DDTHH24:Mi:SSZTimezone Timezone specification is optional and will be defaulted to UTC.",
            "example":"2021-03-01 21:23:03"
        },
        "timeToEnd":{
            "type":"string",
            "description":"end time for the job in the format YYYY-MM-DDTHH24:Mi:SSZTimezone Timezone specification is optional and will be defaulted to UTC.",
            "example":"2021-03-02 22:00:13"
        },
        "isTargetZoneUsed":{
            "type":"boolean",
            "description":"To indicate the time should be interpreted in target's timezone or not. If Timezone is specified in time and useTargetZone is true, it will be reported as an ERROR condition",
            "example":true
        },
        "scheduleType":{
            "type":"string",
            "description":"Currently we support ical specification default is ICAL, in future it can be extended to other types e.g CRON."
        },
        "recurring":{
            "type":"string",
            "description":"Frequency at which the operation must be executed repeatedly",
            "example":"Weekly"
        },
        "startGracePeriodInMinutes":{
            "type":"number",
            "description":"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
        }
    }
}

Examples

Select an example Payload

Back to Top

Response

201 Response

FPP server registered.

Headers

• Location:
  Examples

  Select an example location

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