Get all cloud instances.
GET {{baseUrl}}/app/rest/cloud/instances?locator=<string>&fields=<string>
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
locator | string | ||
fields | string |
RESPONSES
status: OK
{"count":"\u003cinteger\u003e","nextHref":"\u003cstring\u003e","prevHref":"\u003cstring\u003e","href":"\u003cstring\u003e","cloudInstance":[{"id":"\u003cstring\u003e","name":"\u003cstring\u003e","state":"\u003cstring\u003e","startDate":"\u003cstring\u003e","networkAddress":"\u003cstring\u003e","href":"\u003cstring\u003e","image":{"id":"\u003cstring\u003e","name":"\u003cstring\u003e","href":"\u003cstring\u003e","profile":{"id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"name":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"cloudProviderId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"href":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"project":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"images":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"instances":{"count":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"nextHref":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"prevHref":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"href":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"cloudInstance":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"errorMessage":"\u003cstring\u003e","agentTypeId":"\u003cinteger\u003e","agentPoolId":"\u003cinteger\u003e","operatingSystemName":"\u003cstring\u003e","locator":"\u003cstring\u003e"},"agent":{"id":"\u003cinteger\u003e","name":"\u003cstring\u003e","typeId":"\u003cinteger\u003e","connected":"\u003cboolean\u003e","enabled":"\u003cboolean\u003e","authorized":"\u003cboolean\u003e","uptodate":"\u003cboolean\u003e","outdated":"\u003cboolean\u003e","pluginsOutdated":"\u003cboolean\u003e","javaOutdated":"\u003cboolean\u003e","ip":"\u003cstring\u003e","protocol":"\u003cstring\u003e","version":"\u003cstring\u003e","currentAgentVersion":"\u003cstring\u003e","lastActivityTime":"\u003cstring\u003e","idleSinceTime":"\u003cstring\u003e","disconnectionComment":"\u003cstring\u003e","registrationTimestamp":"\u003cstring\u003e","host":"\u003cstring\u003e","cpuRank":"\u003cinteger\u003e","port":"\u003cinteger\u003e","href":"\u003cstring\u003e","webUrl":"\u003cstring\u003e","build":{"value":"\u003cCircular reference to #/components/schemas/build detected\u003e"},"links":{"count":"\u003cinteger\u003e","link":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}]},"enabledInfo":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"authorizedInfo":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"properties":{"count":"\u003cinteger\u003e","href":"\u003cstring\u003e","property":[{"name":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"value":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"inherited":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},{"name":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"value":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"inherited":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}]},"cloudInstance":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"cloudImage":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"environment":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"pool":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"compatibilityPolicy":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"compatibleBuildTypes":{"count":"\u003cinteger\u003e","href":"\u003cstring\u003e","nextHref":"\u003cstring\u003e","prevHref":"\u003cstring\u003e","buildType":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}]},"incompatibleBuildTypes":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"builds":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"locator":"\u003cstring\u003e"},"errorMessage":"\u003cstring\u003e"},{"id":"\u003cstring\u003e","name":"\u003cstring\u003e","state":"\u003cstring\u003e","startDate":"\u003cstring\u003e","networkAddress":"\u003cstring\u003e","href":"\u003cstring\u003e","image":{"id":"\u003cstring\u003e","name":"\u003cstring\u003e","href":"\u003cstring\u003e","profile":{"id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"name":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"cloudProviderId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"href":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"project":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"images":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"instances":{"count":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"nextHref":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"prevHref":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"href":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"cloudInstance":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"errorMessage":"\u003cstring\u003e","agentTypeId":"\u003cinteger\u003e","agentPoolId":"\u003cinteger\u003e","operatingSystemName":"\u003cstring\u003e","locator":"\u003cstring\u003e"},"agent":{"id":"\u003cinteger\u003e","name":"\u003cstring\u003e","typeId":"\u003cinteger\u003e","connected":"\u003cboolean\u003e","enabled":"\u003cboolean\u003e","authorized":"\u003cboolean\u003e","uptodate":"\u003cboolean\u003e","outdated":"\u003cboolean\u003e","pluginsOutdated":"\u003cboolean\u003e","javaOutdated":"\u003cboolean\u003e","ip":"\u003cstring\u003e","protocol":"\u003cstring\u003e","version":"\u003cstring\u003e","currentAgentVersion":"\u003cstring\u003e","lastActivityTime":"\u003cstring\u003e","idleSinceTime":"\u003cstring\u003e","disconnectionComment":"\u003cstring\u003e","registrationTimestamp":"\u003cstring\u003e","host":"\u003cstring\u003e","cpuRank":"\u003cinteger\u003e","port":"\u003cinteger\u003e","href":"\u003cstring\u003e","webUrl":"\u003cstring\u003e","build":{"value":"\u003cCircular reference to #/components/schemas/build detected\u003e"},"links":{"count":"\u003cinteger\u003e","link":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}]},"enabledInfo":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"authorizedInfo":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"properties":{"count":"\u003cinteger\u003e","href":"\u003cstring\u003e","property":[{"name":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"value":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"inherited":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},{"name":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"value":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"inherited":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}]},"cloudInstance":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"cloudImage":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"environment":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"pool":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"compatibilityPolicy":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"compatibleBuildTypes":{"count":"\u003cinteger\u003e","href":"\u003cstring\u003e","nextHref":"\u003cstring\u003e","prevHref":"\u003cstring\u003e","buildType":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}]},"incompatibleBuildTypes":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"builds":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"locator":"\u003cstring\u003e"},"errorMessage":"\u003cstring\u003e"}]}