CloudInstances

Represents a paginated list of CloudInstance entities.

Properties

count

The number of CloudInstance objects in this collection.

nextHref

If the list of returned entities exceeds the request count value, TeamCity splits it into multiple batches. This property returns the endpoint that allows you to obtain the next batch.

prevHref

If the list of returned entities exceeds the request count value, TeamCity splits it into multiple batches. This property returns the endpoint that allows you to obtain the previous batch.

href

The relative link (without the TeamCity server URL) used to retrieve this object.

cloudInstance

The list of CloudInstance objects owned by this collection.

Schema

Below, you can find a full schema of this object, in XML and JSON formats. You can choose what fields to submit depending on your current needs. Different methods might expect different fields: the best approach is to request this entity via GET and use the response as a base for the following POST request.

A link to another object implies that you can substitute it with the schema of the linked object, if it is required for your call.

<cloudInstances count="54" href="/app/rest/cloud/instances" nextHref="/app/rest/cloud/instances?locator=count:200,start:250" prevHref="/app/rest/cloud/instances?locator=count:50,start:0">
  <cloudInstance>[[[cloudInstance...|cloudinstance.html]]]</cloudInstance>
</cloudInstances>

{
  "count" : 54,
  "cloudInstance" : [ {
    "image" : {
      "agentPoolId" : 1,
      "instances" : "[[[cloudInstances...|]]]",
      "agentTypeId" : 283,
      "webUrl" : "https://example.com/app/rest/cloudImage/3414",
      "profile" : "[[[cloudProfile...|cloudprofile.html]]]",
      "name" : "Win-Server-2022-xLarge (ami-08a0a7588100450ff)",
      "errorMessage" : "errorMessage",
      "id" : "id:(Ubuntu-22.04-Large(AMI)),profileId:amazon-4",
      "href" : "app/rest/cloud/images/id:(id:Win-Server-2022-xLarge,profileId:amazon-1)",
      "error" : "[[[cloudError...|clouderror.html]]]",
      "operatingSystemName" : "Linux, version 5.19.0-1025-aws",
      "locator" : "locator"
    },
    "agent" : {
      "disconnectionComment" : "Unregistered because of inactivity",
      "idleSinceTime" : "20240816T150655+0200",
      "enabledInfo" : "[[[enabledInfo...|enabledinfo.html]]]",
      "cpuRank" : 396,
      "enabled" : true,
      "compatibleBuildTypes" : "[[[buildTypes...|buildtypes.html]]]",
      "protocol" : "unidirectional",
      "outdated" : true,
      "authorized" : true,
      "host" : "ip-52-211-39-10.eu-west-1.compute.internal, localhost",
      "builds" : "[[[builds...|builds.html]]]",
      "links" : "[[[links...|links.html]]]",
      "id" : 771,
      "href" : "/app/rest/agents/id:771",
      "cloudImage" : "[[[cloudImage...|cloudimage.html]]]",
      "authorizedInfo" : "[[[authorizedInfo...|authorizedinfo.html]]]",
      "incompatibleBuildTypes" : "[[[compatibilities...|compatibilities.html]]]",
      "uptodate" : false,
      "ip" : "52.211.39.100",
      "pool" : "[[[agentPool...|agentpool.html]]]",
      "cloudInstance" : "[[[cloudInstance...|cloudinstance.html]]]",
      "version" : "156364",
      "connected" : true,
      "currentAgentVersion" : "160569",
      "compatibilityPolicy" : "[[[compatibilityPolicy...|compatibilitypolicy.html]]]",
      "registrationTimestamp" : "20240816T150655+0200",
      "environment" : "[[[environment...|environment.html]]]",
      "pluginsOutdated" : false,
      "removed" : false,
      "port" : 9090,
      "build" : "[[[build...|build.html]]]",
      "webUrl" : "https://example.com/agentDetails.html?id=771&agentTypeId=11389&realAgentName=db-win-2003",
      "name" : "Ubuntu-22.04-Large-i-045902939eae4af1a",
      "typeId" : 661,
      "lastActivityTime" : "20240816T151123+0200",
      "locator" : "locator",
      "properties" : "[[[properties...|properties.html]]]",
      "javaOutdated" : false
    },
    "name" : "i-0245b46070c443201",
    "errorMessage" : "errorMessage",
    "id" : "id:(Windows-Server2022(Instance)),imageId:(Windows-Server2022(Instance)),profileId:amazon-4",
    "state" : "running",
    "href" : "/app/rest/cloud/instances/id:(id:(Windows-Server2022(Instance)),imageId:(Windows-Server2022(Instance)),profileId:amazon-4)",
    "error" : {
      "detailedMessage" : "Unable to execute HTTP request: ec2.eu-west-1.amazonaws.com",
      "message" : "Failed to get image info for Ubuntu-22.04-Large"
    },
    "networkAddress" : "ec2-54-27-55-38.eu-west-1.compute.amazon.com",
    "startDate" : "20250515T114320+0200"
  } ],
  "prevHref" : "/app/rest/cloud/instances?locator=count:50,start:0",
  "href" : "/app/rest/cloud/instances",
  "nextHref" : "/app/rest/cloud/instances?locator=count:200,start:250"
}

Last modified: 02 December 2025