(mt):Set root password
- This page was last modified on September 2, 2011, at 08:53.
From (mt) Community Wiki
Contents |
Overview
This method provides a way to set the root password for a specific (mt) Media Temple service associated with the authenticated account.
This article is for use with the (mt) API. For more information, please see: ProDev API.
Request Info
The following URL and HTTP method should be used:
| HTTP Method | URL |
|---|---|
| PUT | https://api.mediatemple.net/api/v1/services/{serviceId}/rootPassword |
The following parameters must be provided in the URL:
| Parameter | Type | Description |
|---|---|---|
| serviceId | int | The service id. |
The body content of the request should contain a rootPassword object with a single field password which contains the new root password.
Response Info
The response will return an HTTP status code to indicate the general category of success or failure to the client. More specific error codes and messages will be contained in the response data itself, if provided. For more information on response codes and parsing response data, see Parsing API responses.
Sample Request
To set the root password, do the following:
curl -D log.txt -s -X "PUT" -d '{"password": "MyN3WPass"}' -H "Content-type: application/json" "https://api.mediatemple.net/api/v1/services/556/rootPassword.json?apikey=a5h34sf62..."
Sample Response
Here is an example of the returned result:
{
"response" : {
"statusCode" : 202,
"timeStamp" : 1284609174311,
"date" : "2010-09-16T03:52:54.311+0000",
"errors" : [ ],
"custom" : [ ]
}
}
Sample Operation Pending
If another set root password operation is already pending (e.g. the above request is called a second time before the set root password job has completed), then you can expect a response like the following:
{
"response" : {
"statusCode" : 409,
"timeStamp" : 1284609198593,
"date" : "2010-09-16T03:53:18.593+0000",
"errors" : [ {
"errorCode" : "OperationPending",
"message" : "An existing operation that conflicts is currently pending. This operation cannot be scheduled until it completes."
} ],
"custom" : [ ]
}
}
Response Errors
All responses should be in the standard response format. For more information, see Parsing API responses.
| Status Code | Error Code | Error Description |
|---|---|---|
| 404 | InvalidService | The specified serviceId was invalid. |
| 400 | InvalidPassword | The specified password was invalid. |
| 409 | OperationPending | There is an existing operation that has not completed. |
| 500 | UnknownError | There was an unexpected error. |