Get EpicServers
This endpoint is used to return the list of epic servers.
- 200
- 404
Success
- application/json
- Schema
- Example (from schema)
Schema
- fileServerCount int32
This returns the total number of file servers.
fileServers object[]
This returns the file server list.
id int32This gives the id of the file server.
name stringThis give the name of the file server.
displayName stringThis gives the name of the file server as it shown on the admin console or GUI.
GUID stringThis returns the Globally Unique Identifier of the file server.
configured booleanThis returns if the file server is configured or deconfigured.
type stringThis returns the type of the file server. Example: Windows, Qumulo
commcellName stringThis returns the CommCell the file server is connected to.
lastBackup object
jobId int32Returns the job id of the last backup job performed.
status stringPossible values: [
NEVER_BACKED_UP
,COMPLETED
,FAILED
,COMPLETED_WITH_ERRORS
,KILLED
,SUSPENDED
,INTERRUPTED
,ANY_STATUS
,SKIPPED
,FAILED_TO_START
,SYNCHRONIZED
,NOT_SYNCHRONIZED
,NOT_ATTEMPTED
,STARTED
,COMPLETED_WITH_WARNINGS
,SYSTEM_FAILED
,COMMITTED
]Status of the last backup job performed.
time int64Shows the time when the last back up job was carried out. The time is provided in unix time format.
failureReason stringGives the reason for the last backup job failing, if the last backup job fails.
applicationSize int32Provides the application size of the file server. It is provided in bytes.
plan object
id int32name stringSLA object
status stringPossible values: [
MET_SLA
,MISSED_SLA
,EXCLUDED_SLA
,YET_TO_BE_PROTECTED
,MIGHT_MISS_SLA
,UNKNOWN
]Provides the SLA status.
reasonList object[]
Provides a reason on why the SLA might not be met.
mightMissReason stringGives the reason as to why the SLA might not be met.
subclient object
id int32name stringstatus stringPossible values: [
OFFLINE
,ONLINE
,UNKNOWN
,NOT_APPLICABLE
]Gives the status of the file server.
company object
id int32name stringtags object[]
Tags associated to file server
id int32name stringvalue string
{
"fileServerCount": 0,
"fileServers": [
{
"id": 0,
"name": "string",
"displayName": "string",
"GUID": "string",
"configured": true,
"type": "string",
"commcellName": "string",
"lastBackup": {
"jobId": 0,
"status": "NEVER_BACKED_UP",
"time": 0,
"failureReason": "string"
},
"applicationSize": 0,
"plan": {
"id": 0,
"name": "string"
},
"SLA": {
"status": "MET_SLA",
"reasonList": [
{
"mightMissReason": "string",
"subclient": {
"id": 0,
"name": "string"
}
}
]
},
"status": "OFFLINE",
"company": {
"id": 0,
"name": "string"
},
"tags": [
{
"id": 0,
"name": "string",
"value": "string"
}
]
}
]
}
Requested Details not found