Overview
This article documents the fields included in endpoint objects returned by JetPatch API responses.
The reference covers field names, data types, and descriptions for endpoint properties, including URLs, status values, operating system information, and metadata.
When an API response includes one or more endpoint objects, each such object includes the following fields, in JSON format:
| Field | Type | Description |
| url | URL | The resource URL for the endpoint. The provided URL is referred to in this guide as <endpoint-url> |
| links | object list | List of objects, each of which includes an href field containing a URL and a rel field containing a descriptive name for that URL. |
| status | string | One of: |
| connectorUrl | URL | The resource URL for this endpoint's Intigua connector, provided even if there is no installed connector (to be used to deploy a connector). The provided URL is referred to in this guide as <connector-url> |
| vagentsUrl | URL | The resource URL for the collection of this endpoint's installed management service instances. The provided URL is referred to in this guide as <services-url> |
| name | string | The endpoint's Name |
| dnsname | string | The endpoint's hostname |
| osFullName | string | Description of endpoint's operating system. For example: "Microsoft Windows Server 2008 R2 (64-bit)" |
| os | string | Identifying string for endpoint's operating system. For example: windows7Server64Guest |
| vmxPath | string | If endpoint is a vSphere VM, path to .vmx file |
| verificationScriptUrl | URL | Enables posting a script for execution on server. Beta support; to use, please contact Intigua support. |
| uuid | string | If endpoint is a vSphere VM, the vSphere's Instance UUID for the endpoint |
| ip | string | The endpoint's IP address |
| tags | object list | List of Intigua tags for this endpoint. For example:["id":47,"url":"/vmanage-server/rest/rest-api/tags/47","name":"tag-name-1","tagColor":"GRAY"},{"id":48,"url":"/vmanage-server/rest/rest-api/tags/48","name":"tag-name-2","tagColor":"BLUE"}] |
For example:
Content-Type: vnd.intigua.vmanager.Server+json { "url": "/vmanage-server/rest/rest-api/servers/111", "links":[ { "href": "/vmanage-server/rest/rest-api/servers/111/connector", "rel": "connector" }, { "href": "/vmanage-server/rest/rest-api/servers/111/deployments", "rel": "vagents" }, { "href": "/vmanage-server/rest/rest-api/servers/111/connector/command", "rel": "example1" } ], "connectorUrl": "/vmanage-server/rest/rest-api/servers/111/connector", "vagentsUrl": "/vmanage-server/rest/rest-api/servers/111/deployments", "verificationScriptUrl": "/vmanage-server/rest/rest-api/servers/111/connector/command", "uuid": null, "ip": "1.1.1.1", "ips":[ "1.1.1.1" ], "os": null, "coreid": "6c74a365-2fb0-4061-98a0-617f44ab26db-CS", "name": "example-name", "hostname": "example.local", "dnsname": “example”, "osFullName": "Windows Server 2012 R2 Standard (64-bit)", "esxHostname": null, "vmxPath": null, "tags":["id":47,"url":"/vmanage-server/rest/rest-api/tags/47","name":"tag-name-1","tagColor":"GRAY"},{"id":48,"url":"/vmanage-server/rest/rest-api/tags/48","name":"tag-name-2","tagColor":"BLUE"}], "status": "OK", "vcenter": null, "machineType": "PHYSICAL", "lastStatusCollected": 1503919058456, "clusterName": null, "dataCenterName": null, "properties":[] } |
Comments
0 comments
Please sign in to leave a comment.