TeamCity REST API Reference 2022.10 Help

CloudImage

Represents a cloud instance image saved with a profile.

Related Help article: Cloud Profile

Properties

Field

Data type

id

string

name

string

href

string

profile

CloudProfile

instances

CloudInstances

errorMessage

string

agentTypeId

integer

agentPoolId

integer

operatingSystemName

string

locator

string

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.

<cloudImage agentPoolId="123" agentTypeId="123" errorMessage="string" href="string" id="string" locator="string" name="string" operatingSystemName="string"> <profile cloudProviderId="string" href="string" id="string" name="string"> <project>[[[project...|project.html]]]</project> <images>[[[cloudImages...|cloudimages.html]]]</images> </profile> <instances count="123" href="string" nextHref="string" prevHref="string"> <cloudInstance>[[[cloudInstance...|cloudinstance.html]]]</cloudInstance> </instances> </cloudImage>
{ "agentPoolId" : 0, "instances" : "[[[cloudInstances...|cloudinstances.html]]]", "agentTypeId" : 4, "profile" : "[[[cloudProfile...|cloudprofile.html]]]", "name" : "name", "errorMessage" : "errorMessage", "id" : "id", "href" : "href", "operatingSystemName" : "operatingSystemName", "locator" : "locator" }
Last modified: 30 November 2022