Get cloud account

Available in versions: 2020 SP2 and later

Retrieves a cloud account by its ID.

URL

Copy code
/Admin/rest/v1/cloud/accounts/{accountID}

Remarks

This API should be authorized for the Application, Tenant, and Site Admin permission levels.

HTTP method

GET: Returns the cloud account description.

Request

Headers:

Accept: application/xml

Cookies:

ADM_LWSSO={AdmLwssoCookie};

Request body:

GET: No request body.

Request example:

Copy code
GET http://<LRE_Server>/Admin/rest/v1/cloud/accounts/3 HTTP/1.1
Host: PCServer
Accept: application/xml
Cookie: ADM_LWSSO={AdmLwssoCookie};

Response

Headers:

One of:

  • Content-Type: application/xml

  • Content-Type: application/json

Cookies:

None

HTML return code:

One of the HTTP return codes

Upon successful deletion, returns HTTP status 201 (Created).

HTML body:

GET: Returns the cloud account data.

This table lists the fields in the response:

ElementDescription

ActiveHost

Number of currently provisioned hosts.

ActiveHostsLimit

Maximum number of allowed active hosts.

Response example:

Copy code
{
   "ID": 3,
   "ActiveHosts": 0,
   "LastSyncTime": "2020-07-03T18:24:30.421365",  
   "Credits": 817.0,
   "Name": "CB", 
   "Description": "",
   "Provider": "Amazon EC2", 
   "ActiveHostsLimit": 14,
   "AccountNumber": "9f27941b-ad0b-4301-97d9-9218c70974e9",
   "ProjectUID": "a027a5be-9dff-4e59-aa11-2e5a1a827jki",
   "AssignedProjects": [
   "DEFAULT\\my_proj"
   ],
   "CreatedBy": "sa",
   "UserName": "John.Smith@acme.com",
   "CompanyName": "AM"
}

See also: