Domain Hosts Status
Get status of domains and hosts with task details. Domains or Hosts provided should belong to cell sites.
Request
URI
POST
https://{api_host}/hybridity/api//ztp/status
COPY
Request Body
For filterType as HOST give list of host's FQDNs and for DOMAIN give List of domains.
domainHostsStatusRequest of type(s) application/json
Required
{
"domains": [
"string"
],
"hosts": [
"string"
],
"filterType": "string"
}array of string
domains
Optional
domains
array of string
hosts
Optional
hosts
string
filterType
Required
filterType
Possible values are : DOMAIN, HOST,
Responses
200
Successfully returned status of domains and hosts
Returns domainHostsStatusResponse of type(s) application/json
{
"hostsNotFound": [
"hostsNotFound",
"hostsNotFound"
],
"domains": [
{
"lastUpdatedTimestamp": 3,
"hosts": [
{
"ipmiIp": "ipmiIp",
"parent": "parent",
"lastUpdatedTimestamp": 6,
"registrationUser": "registrationUser",
"preDeployed": true,
"ip": "ip",
"hostSettingStatus": "hostSettingStatus",
"type": "type",
"registrationTimestamp": 0,
"bootstrap_host": true,
"name": "name",
"location": {
"country": "country",
"address": "address",
"city": "city",
"latitude": -63.615366350946985,
"longitude": 36.988422590534526
},
"lastUpdatedByUser": "lastUpdatedByUser",
"ipmiUsername": "ipmiUsername",
"tasks": [
{
"subTasks": [
null,
null
],
"name": "name",
"startTime": 1,
"progressInPercentage": 5,
"endTime": 5,
"type": "type",
"taskId": "taskId",
"statusMessage": "statusMessage",
"status": "status"
},
{
"subTasks": [
null,
null
],
"name": "name",
"startTime": 1,
"progressInPercentage": 5,
"endTime": 5,
"type": "type",
"taskId": "taskId",
"statusMessage": "statusMessage",
"status": "status"
}
],
"username": "username",
"status": "status"
},
{
"ipmiIp": "ipmiIp",
"parent": "parent",
"lastUpdatedTimestamp": 6,
"registrationUser": "registrationUser",
"preDeployed": true,
"ip": "ip",
"hostSettingStatus": "hostSettingStatus",
"type": "type",
"registrationTimestamp": 0,
"bootstrap_host": true,
"name": "name",
"location": {
"country": "country",
"address": "address",
"city": "city",
"latitude": -63.615366350946985,
"longitude": 36.988422590534526
},
"lastUpdatedByUser": "lastUpdatedByUser",
"ipmiUsername": "ipmiUsername",
"tasks": [
{
"subTasks": [
null,
null
],
"name": "name",
"startTime": 1,
"progressInPercentage": 5,
"endTime": 5,
"type": "type",
"taskId": "taskId",
"statusMessage": "statusMessage",
"status": "status"
},
{
"subTasks": [
null,
null
],
"name": "name",
"startTime": 1,
"progressInPercentage": 5,
"endTime": 5,
"type": "type",
"taskId": "taskId",
"statusMessage": "statusMessage",
"status": "status"
}
],
"username": "username",
"status": "status"
}
],
"appliances": [
{
"ip": "ip",
"name": "name",
"serviceUrl": "serviceUrl",
"type": "type",
"status": "status"
},
{
"ip": "ip",
"name": "name",
"serviceUrl": "serviceUrl",
"type": "type",
"status": "status"
}
],
"createdTimestamp": 9,
"name": "name",
"hostSettingStatus": "hostSettingStatus",
"messages": {
"warnings": [
{
"message": "message"
},
{
"message": "message"
}
],
"errors": [
{
"code": "code",
"message": "message"
},
{
"code": "code",
"message": "message"
}
]
},
"startTime": 2,
"endTime": 7,
"type": "type",
"taskId": "taskId",
"status": "status"
},
{
"lastUpdatedTimestamp": 3,
"hosts": [
{
"ipmiIp": "ipmiIp",
"parent": "parent",
"lastUpdatedTimestamp": 6,
"registrationUser": "registrationUser",
"preDeployed": true,
"ip": "ip",
"hostSettingStatus": "hostSettingStatus",
"type": "type",
"registrationTimestamp": 0,
"bootstrap_host": true,
"name": "name",
"location": {
"country": "country",
"address": "address",
"city": "city",
"latitude": -63.615366350946985,
"longitude": 36.988422590534526
},
"lastUpdatedByUser": "lastUpdatedByUser",
"ipmiUsername": "ipmiUsername",
"tasks": [
{
"subTasks": [
null,
null
],
"name": "name",
"startTime": 1,
"progressInPercentage": 5,
"endTime": 5,
"type": "type",
"taskId": "taskId",
"statusMessage": "statusMessage",
"status": "status"
},
{
"subTasks": [
null,
null
],
"name": "name",
"startTime": 1,
"progressInPercentage": 5,
"endTime": 5,
"type": "type",
"taskId": "taskId",
"statusMessage": "statusMessage",
"status": "status"
}
],
"username": "username",
"status": "status"
},
{
"ipmiIp": "ipmiIp",
"parent": "parent",
"lastUpdatedTimestamp": 6,
"registrationUser": "registrationUser",
"preDeployed": true,
"ip": "ip",
"hostSettingStatus": "hostSettingStatus",
"type": "type",
"registrationTimestamp": 0,
"bootstrap_host": true,
"name": "name",
"location": {
"country": "country",
"address": "address",
"city": "city",
"latitude": -63.615366350946985,
"longitude": 36.988422590534526
},
"lastUpdatedByUser": "lastUpdatedByUser",
"ipmiUsername": "ipmiUsername",
"tasks": [
{
"subTasks": [
null,
null
],
"name": "name",
"startTime": 1,
"progressInPercentage": 5,
"endTime": 5,
"type": "type",
"taskId": "taskId",
"statusMessage": "statusMessage",
"status": "status"
},
{
"subTasks": [
null,
null
],
"name": "name",
"startTime": 1,
"progressInPercentage": 5,
"endTime": 5,
"type": "type",
"taskId": "taskId",
"statusMessage": "statusMessage",
"status": "status"
}
],
"username": "username",
"status": "status"
}
],
"appliances": [
{
"ip": "ip",
"name": "name",
"serviceUrl": "serviceUrl",
"type": "type",
"status": "status"
},
{
"ip": "ip",
"name": "name",
"serviceUrl": "serviceUrl",
"type": "type",
"status": "status"
}
],
"createdTimestamp": 9,
"name": "name",
"hostSettingStatus": "hostSettingStatus",
"messages": {
"warnings": [
{
"message": "message"
},
{
"message": "message"
}
],
"errors": [
{
"code": "code",
"message": "message"
},
{
"code": "code",
"message": "message"
}
]
},
"startTime": 2,
"endTime": 7,
"type": "type",
"taskId": "taskId",
"status": "status"
}
],
"messages": [
"messages",
"messages"
],
"domainsNotFound": [
"domainsNotFound",
"domainsNotFound"
]
}array of string
hostsNotFound
Optional
hostsNotFound
array of string
domainsNotFound
Optional
domainsNotFound
array of string
messages
Optional
messages
301
API endpoint has permanently moved.
Returns redirectResponse of type(s) application/json
{
"redirectURL": "string"
}string
redirectURL
Optional
redirectURL
Response Headers
string
Location
URI where the client will find the new endpoint.
401
Unauthorized
Operation doesn't return any data structure
403
Forbidden
Operation doesn't return any data structure