Product Documentation

Retrieving CloudBridge Resource Details

Oct 21, 2015
Note: All examples in this documentation use the "user_account" resource type.

Retrieving Details of a Single Resource

The request and response formats to get the details of a single resource. The URL must specify the type and name of the resource to be retrieved. The request header must provide the base64 encoded username and password.

  • Request:

    HTTP Method
    GET
    URL
    https://<cb_ip>/cb/nitro/v1/config/user_account/test1
    Request Headers
    Authorization: Basic <base64 encoded(username:password)> 
    Content-Type: <Not Required. Ignored if given.> 
    Accept: <Must either be */* or application/vnd.com.citrix.cloudbridge.user_account+json.>
  • Response:

    HTTP Status Code on Success
    200 OK
    HTTP Status Code on Failure
    4xx <string> or 5xx <string>. The response provides details of the error. See Error Handling.
    Response Header
    Content-Type: application/vnd.com.citrix.cloudbridge.user_account+json
    Response Payload
    { 
        "user_account": 
        { 
            "username":"test1", 
            "privilege":"admin" 
        } 
    }

Retrieving Details of All Resources

The request and response formats to get the details of all resources of a specific resource type. The URL must specify the type of the resource to be retrieved. The request header must provide the base64 encoded username and password.

  • Request:

    HTTP Method
    GET
    URL
    https://<cb_ip>/cb/nitro/v1/config/user_account
    Request Headers
    Authorization: Basic <base64 encoded(username:password)> 
    Content-Type: <Not Required. Ignored if given.> 
    Accept: <Must either be */* or application/vnd.com.citrix.cloudbridge.user_account_list+json.>
  • Response:

    HTTP Status Code on Success
    200 OK
    HTTP Status Code on Failure
    4xx <string> or 5xx <string>. The response provides details of the error. See Error Handling.
    Response Header
    Content-Type: application/vnd.com.citrix.cloudbridge.user_account_list+json
    Response Payload
    { 
        "user_account": 
        [ 
            { 
                "username":"test1", 
                "privilege":"admin" 
            }, 
            { 
                "username":"test2", 
                "privilege":"admin" 
            } 
        ] 
    }