Edit linked instance
Request
HTTP Method: POST
Content Type: application/json
Parameters
Property | Type | Description | Required |
|---|---|---|---|
| string | host of instance to edit | required |
| boolean | apply edits even if connection to instance fails |
|
| string | name of instance to edit |
|
| integer | port of instance to edit (non-negative) |
|
| string | new value for authentication type (possible values: 'SQL' and 'WIN') |
|
| string(password) | new value for password |
|
| integer | new value for port (non-negative) |
|
| string | new value for username |
|
{
"params": {
"host": "string",
"ignore_errors": false,
"instance": "string",
"port": 123,
"set_auth_type": "SQL",
"set_password": "string",
"set_port": 123,
"set_username": "string"
}
}
Response
HTTP Status: 200
Content Type: application/json
Response
Property | Type | Description |
|---|---|---|
| object of type | error response |
| object of type | SQL Server instance information |
| boolean | response with error or not |
error_response
Property | Type | Description |
|---|---|---|
| string | error message |
instance_info
Property | Type | Description |
|---|---|---|
| string | authentication type (possible values: 'SQL' and 'WIN') |
| string | host running instance |
| string | name of instance |
| integer | port number of instance |
| string | user name for authentication to instance |
{
"error": {
"message": "string"
},
"result": {
"authentication_type": "SQL",
"host": "string",
"instance_name": "string",
"port": 123,
"username": "string"
},
"successful": true
}
HTTP Status: 400
Content Type: application/json
Response
Property | Type | Description |
|---|---|---|
| object of type | error response |
| boolean | always false |
error_response
Property | Type | Description |
|---|---|---|
| string | error message |
{
"error": {
"message": "string"
},
"successful": false
}
Comments