Domain Hosts Status
Get status of domains and hosts with task details.
- If request is given without filterType then it returns all domain configs without host configs.
- If request have filterType as DOMAIN, it returns config of domains passed in request body. Domain config will also include hosts configs.
- If request have filterType as HOST, it returns config of hosts given in request body with their respective domain configs.
Note:
- By default, we will return payload without task data.
- For task data, set includeTaskData flag as true.
- includeTaskData flag works for Cell-Site domains and Cell-Site hosts only.
- includeTaskData supported with filterType only.
Request
URI
POST
https://{api_host}/hybridity/api/ztp/status
COPY
Request Body
To get all domains, give request body as {}. For getting particular hosts or domains use filterType as HOST or DOMAIN respectively. Give host names in hosts list and domain names in domains list. For task data set includeTaskData flag as true.
domainHostsStatusRequest of type(s) application/json
Required
{
"domains": [
"string"
],
"hosts": [
"string"
],
"filterType": "string",
"includeTaskData": false
}array of string
domains
Optional
domains
array of string
hosts
Optional
hosts
string
filterType
Optional
filterType
Possible values are : DOMAIN, HOST,
boolean
includeTaskData
Optional
includeTaskData
Responses
200
Successfully returned status of domains and hosts
Returns domainHostsStatusResponse of type(s) application/json
{
"hostsNotFound": [
"hostsNotFound",
"hostsNotFound"
],
"domains": [
{
"lastUpdatedTimestamp": 2,
"hosts": [
{
"ipmiIp": "ipmiIp",
"parent": "parent",
"lastUpdatedTimestamp": 1,
"registrationUser": "registrationUser",
"preDeployed": true,
"ip": "ip",
"hostSettingStatus": "hostSettingStatus",
"type": "type",
"registrationTimestamp": 6,
"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": 5,
"progressInPercentage": 2,
"endTime": 5,
"type": "type",
"taskId": "taskId",
"statusMessage": "statusMessage",
"status": "status"
},
{
"subTasks": [
null,
null
],
"name": "name",
"startTime": 5,
"progressInPercentage": 2,
"endTime": 5,
"type": "type",
"taskId": "taskId",
"statusMessage": "statusMessage",
"status": "status"
}
],
"errors": [
{
"stack": "stack",
"code": "code",
"message": "message"
},
{
"stack": "stack",
"code": "code",
"message": "message"
}
],
"username": "username",
"status": "status"
},
{
"ipmiIp": "ipmiIp",
"parent": "parent",
"lastUpdatedTimestamp": 1,
"registrationUser": "registrationUser",
"preDeployed": true,
"ip": "ip",
"hostSettingStatus": "hostSettingStatus",
"type": "type",
"registrationTimestamp": 6,
"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": 5,
"progressInPercentage": 2,
"endTime": 5,
"type": "type",
"taskId": "taskId",
"statusMessage": "statusMessage",
"status": "status"
},
{
"subTasks": [
null,
null
],
"name": "name",
"startTime": 5,
"progressInPercentage": 2,
"endTime": 5,
"type": "type",
"taskId": "taskId",
"statusMessage": "statusMessage",
"status": "status"
}
],
"errors": [
{
"stack": "stack",
"code": "code",
"message": "message"
},
{
"stack": "stack",
"code": "code",
"message": "message"
}
],
"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": 3,
"hostSettingStatus": "hostSettingStatus",
"type": "type",
"name": "name",
"hostsCount": 0,
"messages": {
"warnings": [
{
"stack": "stack",
"code": "code",
"message": "message"
},
{
"stack": "stack",
"code": "code",
"message": "message"
}
],
"errors": [
{
"stack": "stack",
"code": "code",
"message": "message"
},
{
"stack": "stack",
"code": "code",
"message": "message"
}
]
},
"startTime": 7,
"endTime": 9,
"taskId": "taskId",
"status": "status"
},
{
"lastUpdatedTimestamp": 2,
"hosts": [
{
"ipmiIp": "ipmiIp",
"parent": "parent",
"lastUpdatedTimestamp": 1,
"registrationUser": "registrationUser",
"preDeployed": true,
"ip": "ip",
"hostSettingStatus": "hostSettingStatus",
"type": "type",
"registrationTimestamp": 6,
"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": 5,
"progressInPercentage": 2,
"endTime": 5,
"type": "type",
"taskId": "taskId",
"statusMessage": "statusMessage",
"status": "status"
},
{
"subTasks": [
null,
null
],
"name": "name",
"startTime": 5,
"progressInPercentage": 2,
"endTime": 5,
"type": "type",
"taskId": "taskId",
"statusMessage": "statusMessage",
"status": "status"
}
],
"errors": [
{
"stack": "stack",
"code": "code",
"message": "message"
},
{
"stack": "stack",
"code": "code",
"message": "message"
}
],
"username": "username",
"status": "status"
},
{
"ipmiIp": "ipmiIp",
"parent": "parent",
"lastUpdatedTimestamp": 1,
"registrationUser": "registrationUser",
"preDeployed": true,
"ip": "ip",
"hostSettingStatus": "hostSettingStatus",
"type": "type",
"registrationTimestamp": 6,
"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": 5,
"progressInPercentage": 2,
"endTime": 5,
"type": "type",
"taskId": "taskId",
"statusMessage": "statusMessage",
"status": "status"
},
{
"subTasks": [
null,
null
],
"name": "name",
"startTime": 5,
"progressInPercentage": 2,
"endTime": 5,
"type": "type",
"taskId": "taskId",
"statusMessage": "statusMessage",
"status": "status"
}
],
"errors": [
{
"stack": "stack",
"code": "code",
"message": "message"
},
{
"stack": "stack",
"code": "code",
"message": "message"
}
],
"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": 3,
"hostSettingStatus": "hostSettingStatus",
"type": "type",
"name": "name",
"hostsCount": 0,
"messages": {
"warnings": [
{
"stack": "stack",
"code": "code",
"message": "message"
},
{
"stack": "stack",
"code": "code",
"message": "message"
}
],
"errors": [
{
"stack": "stack",
"code": "code",
"message": "message"
},
{
"stack": "stack",
"code": "code",
"message": "message"
}
]
},
"startTime": 7,
"endTime": 9,
"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.
400
Bad Request
Returns response of type(s) application/json
{
"warnings": [
{
"stack": "stack",
"code": "code",
"message": "message"
},
{
"stack": "stack",
"code": "code",
"message": "message"
}
],
"errors": [
{
"stack": "stack",
"code": "code",
"message": "message"
},
{
"stack": "stack",
"code": "code",
"message": "message"
}
]
}
401
Unauthorized
Operation doesn't return any data structure
403
Forbidden
Operation doesn't return any data structure
500
Internal Server Error
Returns response of type(s) application/json
{
"warnings": [
{
"stack": "stack",
"code": "code",
"message": "message"
},
{
"stack": "stack",
"code": "code",
"message": "message"
}
],
"errors": [
{
"stack": "stack",
"code": "code",
"message": "message"
},
{
"stack": "stack",
"code": "code",
"message": "message"
}
]
}