Cloud Servers API: Difference between revisions

From Data Islands
(Created page with "'''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 postgr...")
 
No edit summary
Line 13: Line 13:
EG
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"
"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>

Revision as of 12:12, 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


  1. GET_CLOUD_SERVERS

MethodType: GET Url: https://apidev.crmtogether.com/mastercloudserver

  1. 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}]

  1. UPDATE_CLOUD_SERVER

MethodType: PUT Url: https://apidev.crmtogether.com/mastercloudserver Payload: {

 "columns": "\"name\"='test-server2'",
 "dataTable": [
   {
     "con_string": "CONNECTION_STRING"
   }
 ]

}

  1. DELETE_CLOUD_SERVER

MethodType: DELETE Url: https://apidev.crmtogether.com/mastercloudserver/<CLOUD_SEVER_NAME>