Returns uptime information as well as information about the application and the server it runs on.
Since Product Version: 2.0
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
API version v1 is deprecated
This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.
Resource URL
/webacs/api/v1/op/info/uptime
Response Parameters
applicationUptime
String
|
Uptime of this application.
|
defaultGateway
String
|
The default gateway used by the server.
|
domainName
String
|
The domain name of this server.
|
highAvailabilityEnabled
boolean
|
Is high availability enabled on this server.
|
highAvailabilityPrimaryServerHostname
String
|
The high availability primary server's hostname.
|
highAvailabilityPrimaryServerIp
String
|
The high availability primary server's IP address.
|
highAvailabilityRole
HighAvailabilityRole
|
The role this server plays in the high availability group.
Allowed values:
- UNKNOWN
- PRIMARY
- SECONDARY
|
highAvailabilitySecondaryServerHostname
String
|
The high availability secondary server's hostname.
|
highAvailabilitySecondaryServerIp
String
|
The high availability secondary server's IP address.
|
highAvailabilityVirtualHostname
String
|
High availability partners' virtual hostname
|
highAvailabilityVirtualIp
String
|
The high availabiliti partners' virtual IP address.
|
hostName
String
|
The host name of this server.
|
serverTime
Date
|
Time as reported by the server.
|
serverUptime
String
|
Uptime of the host server.
|
totalMemory
long
|
The total amount of memory on the server in kilobytes.
|
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Response Payload
https://localhost/webacs/api/v1/op/info/uptime
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v1/op/info/uptime" rootUrl="https://localhost/webacs/api/v1/op">
<applicationInfoDTO>
<highAvailabilityEnabled>true</highAvailabilityEnabled>
<highAvailabilitySecondaryServerIp>String value</highAvailabilitySecondaryServerIp>
<hostName>String value</hostName>
<serverUptime>String value</serverUptime>
<applicationUptime>String value</applicationUptime>
<defaultGateway>String value</defaultGateway>
<domainName>String value</domainName>
<highAvailabilityPrimaryServerHostname>String value</highAvailabilityPrimaryServerHostname>
<highAvailabilityPrimaryServerIp>String value</highAvailabilityPrimaryServerIp>
<highAvailabilityRole>UNKNOWN</highAvailabilityRole>
<highAvailabilitySecondaryServerHostname>String value</highAvailabilitySecondaryServerHostname>
<highAvailabilityVirtualHostname>String value</highAvailabilityVirtualHostname>
<highAvailabilityVirtualIp>String value</highAvailabilityVirtualIp>
<serverTime>2019-08-20T09:01:14.815Z</serverTime>
<totalMemory>2</totalMemory>
</applicationInfoDTO>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v1/op/info/uptime.json
{
"mgmtResponse" : {
"@responseType" : "operation",
"@requestUrl" : "https : \/\/localhost\/webacs\/api\/v1\/op\/info\/uptime",
"@rootUrl" : "https : \/\/localhost\/webacs\/api\/v1\/op",
"applicationInfoDTO" : {
"highAvailabilityEnabled" : true,
"highAvailabilitySecondaryServerIp" : "String value",
"hostName" : "String value",
"serverUptime" : "String value",
"applicationUptime" : "String value",
"defaultGateway" : "String value",
"domainName" : "String value",
"highAvailabilityPrimaryServerHostname" : "String value",
"highAvailabilityPrimaryServerIp" : "String value",
"highAvailabilityRole" : "UNKNOWN",
"highAvailabilitySecondaryServerHostname" : "String value",
"highAvailabilityVirtualHostname" : "String value",
"highAvailabilityVirtualIp" : "String value",
"serverTime" : "2019-08-20T09 : 01 : 14.815Z",
"totalMemory" : 2
}
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v2/op/info/uptime
Unmodified
This resource has not been modified since the previous API version.
Response Parameters
applicationUptime
String
|
Uptime of this application.
|
defaultGateway
String
|
The default gateway used by the server.
|
domainName
String
|
The domain name of this server.
|
highAvailabilityEnabled
boolean
|
Is high availability enabled on this server.
|
highAvailabilityPrimaryServerHostname
String
|
The high availability primary server's hostname.
|
highAvailabilityPrimaryServerIp
String
|
The high availability primary server's IP address.
|
highAvailabilityRole
HighAvailabilityRole
|
The role this server plays in the high availability group.
Allowed values:
- UNKNOWN
- PRIMARY
- SECONDARY
|
highAvailabilitySecondaryServerHostname
String
|
The high availability secondary server's hostname.
|
highAvailabilitySecondaryServerIp
String
|
The high availability secondary server's IP address.
|
highAvailabilityVirtualHostname
String
|
High availability partners' virtual hostname
|
highAvailabilityVirtualIp
String
|
The high availabiliti partners' virtual IP address.
|
hostName
String
|
The host name of this server.
|
serverTime
Date
|
Time as reported by the server.
|
serverUptime
String
|
Uptime of the host server.
|
totalMemory
long
|
The total amount of memory on the server in kilobytes.
|
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Response Payload
https://localhost/webacs/api/v2/op/info/uptime
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v2/op/info/uptime" rootUrl="https://localhost/webacs/api/v2/op">
<applicationInfoDTO>
<highAvailabilityEnabled>true</highAvailabilityEnabled>
<highAvailabilitySecondaryServerIp>String value</highAvailabilitySecondaryServerIp>
<hostName>String value</hostName>
<serverUptime>String value</serverUptime>
<applicationUptime>String value</applicationUptime>
<defaultGateway>String value</defaultGateway>
<domainName>String value</domainName>
<highAvailabilityPrimaryServerHostname>String value</highAvailabilityPrimaryServerHostname>
<highAvailabilityPrimaryServerIp>String value</highAvailabilityPrimaryServerIp>
<highAvailabilityRole>UNKNOWN</highAvailabilityRole>
<highAvailabilitySecondaryServerHostname>String value</highAvailabilitySecondaryServerHostname>
<highAvailabilityVirtualHostname>String value</highAvailabilityVirtualHostname>
<highAvailabilityVirtualIp>String value</highAvailabilityVirtualIp>
<serverTime>2019-08-20T09:01:14.820Z</serverTime>
<totalMemory>2</totalMemory>
</applicationInfoDTO>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v2/op/info/uptime.json
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v2/op/info/uptime",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v2/op",
"applicationInfoDTO" : [ {
"applicationUptime" : "String value",
"defaultGateway" : "String value",
"domainName" : "String value",
"highAvailabilityEnabled" : true,
"highAvailabilityPrimaryServerHostname" : "String value",
"highAvailabilityPrimaryServerIp" : "String value",
"highAvailabilityRole" : "UNKNOWN",
"highAvailabilitySecondaryServerHostname" : "String value",
"highAvailabilitySecondaryServerIp" : "String value",
"highAvailabilityVirtualHostname" : "String value",
"highAvailabilityVirtualIp" : "String value",
"hostName" : "String value",
"serverTime" : 1566291674820,
"serverUptime" : "String value",
"totalMemory" : 2
} ]
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v3/op/info/uptime
Unmodified
This resource has not been modified since the previous API version.
Response Parameters
applicationUptime
String
|
Uptime of this application.
|
defaultGateway
String
|
The default gateway used by the server.
|
domainName
String
|
The domain name of this server.
|
highAvailabilityEnabled
boolean
|
Is high availability enabled on this server.
|
highAvailabilityPrimaryServerHostname
String
|
The high availability primary server's hostname.
|
highAvailabilityPrimaryServerIp
String
|
The high availability primary server's IP address.
|
highAvailabilityRole
HighAvailabilityRole
|
The role this server plays in the high availability group.
Allowed values:
- UNKNOWN
- PRIMARY
- SECONDARY
|
highAvailabilitySecondaryServerHostname
String
|
The high availability secondary server's hostname.
|
highAvailabilitySecondaryServerIp
String
|
The high availability secondary server's IP address.
|
highAvailabilityVirtualHostname
String
|
High availability partners' virtual hostname
|
highAvailabilityVirtualIp
String
|
The high availabiliti partners' virtual IP address.
|
hostName
String
|
The host name of this server.
|
serverTime
Date
|
Time as reported by the server.
|
serverUptime
String
|
Uptime of the host server.
|
totalMemory
long
|
The total amount of memory on the server in kilobytes.
|
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Response Payload
https://localhost/webacs/api/v3/op/info/uptime
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v3/op/info/uptime" rootUrl="https://localhost/webacs/api/v3/op">
<applicationInfoDTO>
<highAvailabilityEnabled>true</highAvailabilityEnabled>
<highAvailabilitySecondaryServerIp>String value</highAvailabilitySecondaryServerIp>
<hostName>String value</hostName>
<serverUptime>String value</serverUptime>
<applicationUptime>String value</applicationUptime>
<defaultGateway>String value</defaultGateway>
<domainName>String value</domainName>
<highAvailabilityPrimaryServerHostname>String value</highAvailabilityPrimaryServerHostname>
<highAvailabilityPrimaryServerIp>String value</highAvailabilityPrimaryServerIp>
<highAvailabilityRole>UNKNOWN</highAvailabilityRole>
<highAvailabilitySecondaryServerHostname>String value</highAvailabilitySecondaryServerHostname>
<highAvailabilityVirtualHostname>String value</highAvailabilityVirtualHostname>
<highAvailabilityVirtualIp>String value</highAvailabilityVirtualIp>
<serverTime>2019-08-20T09:01:14.823Z</serverTime>
<totalMemory>2</totalMemory>
</applicationInfoDTO>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v3/op/info/uptime.json
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v3/op/info/uptime",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v3/op",
"applicationInfoDTO" : [ {
"applicationUptime" : "String value",
"defaultGateway" : "String value",
"domainName" : "String value",
"highAvailabilityEnabled" : true,
"highAvailabilityPrimaryServerHostname" : "String value",
"highAvailabilityPrimaryServerIp" : "String value",
"highAvailabilityRole" : "UNKNOWN",
"highAvailabilitySecondaryServerHostname" : "String value",
"highAvailabilitySecondaryServerIp" : "String value",
"highAvailabilityVirtualHostname" : "String value",
"highAvailabilityVirtualIp" : "String value",
"hostName" : "String value",
"serverTime" : "2019-08-20T09:01:14.823Z",
"serverUptime" : "String value",
"totalMemory" : 2
} ]
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v4/op/info/uptime
Unmodified
This resource has not been modified since the previous API version.
Response Parameters
applicationUptime
String
|
Uptime of this application.
|
defaultGateway
String
|
The default gateway used by the server.
|
domainName
String
|
The domain name of this server.
|
highAvailabilityEnabled
boolean
|
Is high availability enabled on this server.
|
highAvailabilityPrimaryServerHostname
String
|
The high availability primary server's hostname.
|
highAvailabilityPrimaryServerIp
String
|
The high availability primary server's IP address.
|
highAvailabilityRole
HighAvailabilityRole
|
The role this server plays in the high availability group.
Allowed values:
- UNKNOWN
- PRIMARY
- SECONDARY
|
highAvailabilitySecondaryServerHostname
String
|
The high availability secondary server's hostname.
|
highAvailabilitySecondaryServerIp
String
|
The high availability secondary server's IP address.
|
highAvailabilityVirtualHostname
String
|
High availability partners' virtual hostname
|
highAvailabilityVirtualIp
String
|
The high availabiliti partners' virtual IP address.
|
hostName
String
|
The host name of this server.
|
serverTime
Date
|
Time as reported by the server.
|
serverUptime
String
|
Uptime of the host server.
|
totalMemory
long
|
The total amount of memory on the server in kilobytes.
|
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Response Payload
https://localhost/webacs/api/v4/op/info/uptime
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v4/op/info/uptime" rootUrl="https://localhost/webacs/api/v4/op">
<applicationInfoDTO>
<highAvailabilityEnabled>true</highAvailabilityEnabled>
<highAvailabilitySecondaryServerIp>String value</highAvailabilitySecondaryServerIp>
<hostName>String value</hostName>
<serverUptime>String value</serverUptime>
<applicationUptime>String value</applicationUptime>
<defaultGateway>String value</defaultGateway>
<domainName>String value</domainName>
<highAvailabilityPrimaryServerHostname>String value</highAvailabilityPrimaryServerHostname>
<highAvailabilityPrimaryServerIp>String value</highAvailabilityPrimaryServerIp>
<highAvailabilityRole>UNKNOWN</highAvailabilityRole>
<highAvailabilitySecondaryServerHostname>String value</highAvailabilitySecondaryServerHostname>
<highAvailabilityVirtualHostname>String value</highAvailabilityVirtualHostname>
<highAvailabilityVirtualIp>String value</highAvailabilityVirtualIp>
<serverTime>2019-08-20T09:01:14.826Z</serverTime>
<totalMemory>2</totalMemory>
</applicationInfoDTO>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v4/op/info/uptime.json
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v4/op/info/uptime",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v4/op",
"applicationInfoDTO" : [ {
"applicationUptime" : "String value",
"defaultGateway" : "String value",
"domainName" : "String value",
"highAvailabilityEnabled" : true,
"highAvailabilityPrimaryServerHostname" : "String value",
"highAvailabilityPrimaryServerIp" : "String value",
"highAvailabilityRole" : "UNKNOWN",
"highAvailabilitySecondaryServerHostname" : "String value",
"highAvailabilitySecondaryServerIp" : "String value",
"highAvailabilityVirtualHostname" : "String value",
"highAvailabilityVirtualIp" : "String value",
"hostName" : "String value",
"serverTime" : "2019-08-20T09:01:14.826Z",
"serverUptime" : "String value",
"totalMemory" : 2
} ]
}
}