Get Windows VM(s) Credentials

Details

API Details
NameGet Windows VM(s) credentials
DescriptionRetrieve the Windows VM(s) credentials. This is the initial system-generated VM password for the user during the job orchestration. If the user changes the password at a later stage, that password is not  reflected in this API's response.
MethodGET
URI
  • v1/jobs/jobId/credentials
  • v1/jobs/jobId/credentials?nodeId=nodeId
CloudCenter Release

CloudCenter 3.x and 4.x

Notes
  • For additional context on <PORT> usage in the following example(s), see Base URI Format.
  • You cannot retrieve passwords for terminated jobs.
  • Use the child Job ID of the Windows server node(s) for which you need to retrieve the password. See the Get Job Details API for additional details on retrieving the child Job ID.
ESB Header
  • action: get.jobs.jobId.credentials
  • action: get.jobs.jobId.credentials
    actionparam: nodeId=nodeId

Example 1 – /v1/jobs/jobId/credentials

curl -k -X GET -H "Accept: application/json" -u cloudcenteradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/jobs/5610/credentials"

Response

[
    {
        "nodeId": "i-0965cca2",
        "username": "cloudcenter",
        "password": "DE123C6F1059C75781F7162839F"
    },
    {
        "nodeId": "i-5d65ccf6",
        "username": "cloudcenter",
        "password": "647D7287EE98CB31C37B2CC50AF"
    }
]

Example 2 – /v1/jobs/jobId/credentials?nodeId=nodeId

curl -k -X GET -H "Accept: application/json" -u cloudcenteradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/jobs/5610/credentials?nodeId=nodeId"

Response

[
    {
        "nodeId": "i-0965cca2",
        "username": "cloudcenter",
        "password": "DE123C6F1059C75781F7162839F"
    }
]

Request Attributes

jobId
  • DescriptionUnique, system-generated identifier for the job
  • Type: String

nodeId
  • DescriptionUnique identifier for the node – generated by the cloud provider

  • Type: String

Response Attributes

The response for this API displays an array of the current set of attributes (nodeId):

nodeId
  • DescriptionUnique identifier for the node – generated by the cloud provider

  • Type: String
username
  • Description: Unique, CloudCenter-generated name reference for this user.
  • Type: String
password
  • Description: Password for the user's account. Effective Cloud Center 4.6.1, the CloudCenter platform enforces a minimum password length of 5 characters for all settings.
  • Type: String