Cloud Servers API: Difference between revisions
WikiSysopdi (talk | contribs) No edit summary |
WikiSysopdi (talk | contribs) No edit summary |
||
| (4 intermediate revisions by the same user not shown) | |||
| Line 19: | Line 19: | ||
<nowiki>#</nowiki>GET_CLOUD_SERVERS | <nowiki>#</nowiki>GET_CLOUD_SERVERS | ||
MethodType: GET | MethodType: GET | ||
| Line 30: | Line 31: | ||
Url: https://apidev.crmtogether.com/mastercloudserver | Url: https://apidev.crmtogether.com/mastercloudserver | ||
Payload: | Payload: [ | ||
{ | |||
"name":"test-server2", | |||
"geo_region":"de", | |||
"con_key":"CONNECTION_STRING;Connection Pruning Interval = 2;Include Error Detail=true;", | |||
"user_id":"9684407f-4a6d-497b-a1b9-2094977c9378", | |||
"default": true | |||
} | |||
] | |||
<nowiki>#</nowiki>UPDATE_CLOUD_SERVER | <nowiki>#</nowiki>UPDATE_CLOUD_SERVER | ||
| Line 41: | Line 48: | ||
Payload: { | Payload: { | ||
"columns": "\"name\"='test-server2'", | |||
"dataTable": [ | |||
{ | |||
"con_string": "CONNECTION_STRING" | |||
} | |||
] | |||
} | } | ||
<nowiki>#</nowiki>DELETE_CLOUD_SERVER | |||
MethodType: DELETE | MethodType: DELETE | ||
Url: https://apidev.crmtogether.com/mastercloudserver/<CLOUD_SEVER_NAME> | Url: https://apidev.crmtogether.com/mastercloudserver/<CLOUD_SEVER_NAME> | ||
Latest revision as of 12:17, 14 November 2024
Syntax : registercloudserver <NAME> <API_GEO_LOCATION> <CONNECTION_STRING> <ENTER>
eg.registercloudserver "NAME" "API GEO LOCATION" "CONNECTION STRING"
Description : Register a cloud server. User can also see list of cloud server by entering just "registercloudserver" without any parameter.
<NAME> - Name of the registered server
<API_GEO_LOCATION> - This defines which API is to be used. Options are "US", "UK", "DE" and "CA"
<CONNECTION_STRING> - the postgreSQL connection string
EG "host=yourserver.ondigitalocean.com;username=someadminuser;password=somepassword;database=defaultdb;port=25060;sslmode=Require;trust server certificate=true;Pooling=true;Connection Idle Lifetime = 2;Connection Pruning Interval = 2;Include Error Detail=true"
REST API
#GET_CLOUD_SERVERS
MethodType: GET
Url: https://apidev.crmtogether.com/mastercloudserver
#Add_CLOUD_SERVER
MethodType: POST
Url: https://apidev.crmtogether.com/mastercloudserver
Payload: [
{
"name":"test-server2",
"geo_region":"de",
"con_key":"CONNECTION_STRING;Connection Pruning Interval = 2;Include Error Detail=true;",
"user_id":"9684407f-4a6d-497b-a1b9-2094977c9378",
"default": true
}
]
#UPDATE_CLOUD_SERVER
MethodType: PUT
Url: https://apidev.crmtogether.com/mastercloudserver
Payload: {
"columns": "\"name\"='test-server2'",
"dataTable": [
{
"con_string": "CONNECTION_STRING"
}
]
}
#DELETE_CLOUD_SERVER
MethodType: DELETE
Url: https://apidev.crmtogether.com/mastercloudserver/<CLOUD_SEVER_NAME>
