API

support.password.get

From GoGrid



Contents

This call will retrieve a single password from your list of passwords. This method follows a common get pattern without a name lookup.

Request

URL


Role Based Access Control Permissions

  • Super User
  • System User

Input Request Query Parameters

Required Name Version Type Description
Required api_key 1.0 string An API Key generated by GoGrid.
  sig 1.0 string An MD5 Signature that signs each and every API request. Instructions on how to generate this signature can be found here.
v 1.0 string The version of the API. For more information, see API Versions.
  • For version 1.3, set parameter to 1.3
  id * {{{version}}} string The id of the password to retrieve.
  password * {{{version}}} string The id of the password to retrieve.
Optional {{{version}}}

* Only one of these parameters, id or password, is required per get method call. These parameters are exclusive and cannot be mixed in a call.

Sample Request

To get by id:

https://api.gogrid.com/api/grid/password/get
  ?id=19283
  ... auth parameters...

Response


A common get response for Passwords.


JSON Response

{
   "list":[
        {
            "applicationtype": "os",
            "id": 3312,
            "object": "password",
            "password": "nur29nec",
            "server": {
                "datacenter": {
                    "description": "US East 1 Datacenter",
                    "id": 2,
                    "name": "US-East-1",
                    "object": "option"
                },
                "id": 3150,
                "image": {
                    "billingtokens": [
                        {
                            "id": 23,
                            "name": "Windows 2008 64bit",
                            "object": "billingtoken",
                            "price": 0
                        },
                        {
                            "id": 43,
                            "name": "SQL Server 2008 Workgroup Edition",
                            "object": "billingtoken",
                            "price": 99.99
                        }
                    ],
                    "createdTime": 1233129600000,
                    "description": "Windows 2008 (64-bit) w/ MSSQL 2008 Workgroup",
                    "friendlyName": "Windows 2008 (64-bit) w/ MSSQL 2008 Workgroup",
                    "id": 68,
                    "isActive": true,
                    "isPublic": true,
                    "location": "gogrid/GSI-99d5f3db-47ea-470f-9aa8-723ceb75d6f5.img",
                    "name": "w2k8_64_mssql2k8wg",
                    "object": "serverimage",
                    "os": {
                        "description": "Windows 2008 Server (64-bit)",
                        "id": 12,
                        "name": "Windows 2008 Server (64-bit)",
                        "object": "option"
                    },
                    "owner": {
                        "id": -1,
                        "name": "GoGrid",
                        "object": "customer"
                    },
                    "price": 99.99,
                    "state": {
                        "description": "Image is available for adds",
                        "id": 2,
                        "name": "Available",
                        "object": "option"
                    },
                    "type": {
                        "description": "Database Server",
                        "id": 2,
                        "name": "Database Server",
                        "object": "option"
                    },
                    "updatedTime": 1246000000000
                },
                "ip": {
                    "datacenter": {
                        "description": "US East 1 Datacenter",
                        "id": 2,
                        "name": "US-East-1",
                        "object": "option"
                    },
                    "id": 232314,
                    "ip": "204.51.198.73",
                    "object": "ip",
                    "public": true,
                    "state": {
                        "description": "IP is reserved or in use",
                        "id": 2,
                        "name": "Assigned",
                        "object": "option"
                    },
                    "subnet": "204.51.198.64/255.255.255.240"
                },
                "isSandbox": false,
                "name": "ws01",
                "object": "server",
                "os": {
                    "description": "Windows 2008 Server (64-bit)",
                    "id": 12,
                    "name": "Windows 2008 Server (64-bit)",
                    "object": "option"
                },
                "ram": {
                    "description": "Server with 2GB RAM",
                    "id": 3,
                    "name": "2GB",
                    "object": "option"
                },
                "state": {
                    "description": "Server is in active state.",
                    "id": 1,
                    "name": "On",
                    "object": "option"
                },
                "type": {
                    "description": "Database Server",
                    "id": 2,
                    "name": "Database Server",
                    "object": "option"
                }
            },
            "username": "Administrator"
        }
   ],
    "method": "/grid/password/get",
    "status": "success",
    "summary": {
        "numpages": 1,
        "returned": 1,
        "start": 0,
        "total": 1
}

XML Response

<gogrid>
  <response method="/support/password/get" status="success">
    <summary total="1" start="0" numpages="0" returned="1"/>
    <list>
      <object name="password">
        <attribute name="id">3312</attribute>
        <attribute name="server">
          <object name="server">
            <attribute name="id">3150</attribute>
            <attribute name="name">ws01</attribute>
            <attribute name="description"></attribute>
            <attribute name="ip">
              <object name="ip">
                <attribute name="id">232314</attribute>
                <attribute name="ip">204.51.198.73</attribute>
                <attribute name="state">
                  <object name="option">
                    <attribute name="id">2</attribute>
                    <attribute name="name">Assigned</attribute>
                    <attribute name="description">IP is reserved or in use</attribute>
                  </object>
                </attribute>
                <attribute name="subnet">204.51.198.64/255.255.255.240</attribute>
                <attribute name="public">true</attribute>
                <attribute name="datacenter">
                  <object name="option">
                    <attribute name="id">2</attribute>
                    <attribute name="name">US-East-1</attribute>
                    <attribute name="description">US East 1 Datacenter</attribute>
                  </object>
                </attribute>
              </object>
            </attribute>
            <attribute name="ram">
              <object name="option">
                <attribute name="id">3</attribute>
                <attribute name="name">2GB</attribute>
                <attribute name="description">Server with 2GB RAM</attribute>
              </object>
            </attribute>
            <attribute name="image">
              <object name="serverimage">
                <attribute name="id">68</attribute>
                <attribute name="friendlyName">Windows 2008 (64-bit) w/ MSSQL 2008 Workgroup</attribute>
                <attribute name="name">w2k8_64_mssql2k8wg</attribute>
                <attribute name="os">
                  <object name="option">
                    <attribute name="id">12</attribute>
                    <attribute name="name">Windows 2008 Server (64-bit)</attribute>
                    <attribute name="description">Windows 2008 Server (64-bit)</attribute>
                  </object>
                </attribute>
                <attribute name="owner">
                  <object name="customer">
                    <attribute name="id">-1</attribute>
                    <attribute name="name">GoGrid</attribute>
                  </object>
                </attribute>
                <attribute name="type">
                  <object name="option">
                    <attribute name="id">2</attribute>
                    <attribute name="name">Database Server</attribute>
                    <attribute name="description">Database Server</attribute>
                  </object>
                </attribute>
                <attribute name="state">
                  <object name="option">
                    <attribute name="id">2</attribute>
                    <attribute name="name">Available</attribute>
                    <attribute name="description">Image is available for adds</attribute>
                  </object>
                </attribute>
                <attribute name="description">Windows 2008 (64-bit) w/ MSSQL 2008 Workgroup</attribute>
                <attribute name="location">gogrid/GSI-99d5f3db-47ea-470f-9aa8-723ceb75d6f5.img</attribute>
                <attribute name="price">99.99</attribute>
                <attribute name="isActive">true</attribute>
                <attribute name="isPublic">true</attribute>
                <attribute name="createdTime">1233129600000</attribute>
                <attribute name="updatedTime">1246000000000</attribute>
                <attribute name="billingtokens">
                  <list>
                    <object name="billingtoken">
                      <attribute name="id">23</attribute>
                      <attribute name="name">Windows 2008 64bit</attribute>
                      <attribute name="price">0.0</attribute>
                    </object>
                    <object name="billingtoken">
                      <attribute name="id">43</attribute>
                      <attribute name="name">SQL Server 2008 Workgroup Edition</attribute>
                      <attribute name="price">99.99</attribute>
                    </object>
                  </list>
                </attribute>
              </object>
            </attribute>
            <attribute name="state">
              <object name="option">
                <attribute name="id">1</attribute>
                <attribute name="name">On</attribute>
                <attribute name="description">Server is in active state.</attribute>
              </object>
            </attribute>
            <attribute name="type">
              <object name="option">
                <attribute name="id">2</attribute>
                <attribute name="name">Database Server</attribute>
                <attribute name="description">Database Server</attribute>
              </object>
            </attribute>
            <attribute name="os">
              <object name="option">
                <attribute name="id">12</attribute>
                <attribute name="name">Windows 2008 Server (64-bit)</attribute>
                <attribute name="description">Windows 2008 Server (64-bit)</attribute>
              </object>
            </attribute>
            <attribute name="isSandbox">false</attribute>
            <attribute name="datacenter">
              <object name="option">
                <attribute name="id">2</attribute>
                <attribute name="name">US-East-1</attribute>
                <attribute name="description">US East 1 Datacenter</attribute>
              </object>
            </attribute>
          </object>
        </attribute>
        <attribute name="applicationtype">os</attribute>
        <attribute name="username">Administrator</attribute>
        <attribute name="password">nur29nec</attribute>
      </object>
    </list>
  </response>
</gogrid>

CSV Response

# SUCCESS, /support/password/get, TOTAL, 1, START, 0, RETURNED, 1
# id,server.id,server.name,server.description,server.ip.id,server.ip.ip,server.ip.subnet,server.ip.public,server.ram.id,server.ram.name,server.ram.description,server.image.id,server.image.name,server.image.friendlyName,server.image.description,server.image.location,server.image.isActive,server.image.isPublic,server.image.createdTime,server.image.updatedTime,server.state.id,server.state.name,server.state.description,server.type.id,server.type.name,server.type.description,server.os.id,server.os.name,server.os.description,applicationtype,username,password
2546,2401,Test Web Server,Test Web Server,138813,216.121.62.44,216.121.62.32/255.255.255.240,true,1,512MB,Server with 512MB RAM,1,centos44_32_apache22php5,,CentOS 4.4 (32-bit) w/ Apache 2.2 + PHP5,,,,,,1,Started,Server is in active state.,1,Web Server,This server has a public connection to the Internet.,5,CentOS 4.4 (32-bit),CentOS Linux 4.4 (32-bit),os,root,6d5db078

Error Codes

Status Code Description
400 IllegalArgumentException Any problems with input parameters will generate an IllegalArgumentException.
401 Unauthorized This error code will occur when the role tied to the API Key in your request has the wrong Access Controls.
403 Authentication Failed This error code will occur when your request is not properly signed. Make sure your have a valid API key and secret and that you are properly generating a request signature. Ensure that the clock on the computer from which you are making the request is synchronized woth the GoGrid API Server.
404 Not Found This error will occur if you have specified a method that does not exist or any other URL does not exists on the API Server.
500 UnexpectedError These types of errors indicate an internal system problem. Depending on the severity of the error and whether not it is blocking your development, report the error to GoGrid support by emailing the response to apisupport@gogrid.com.
Personal tools