This method allows to delete a redis instance.

This method is asynchronous (status code 202) and you'll have to wait for async action to be completed by checking its status.

DELETE /redis/123

This method allows to delete a Maria DB instance.

This method is asynchronous (status code 202) and you'll have to wait for async action to be completed by checking its status.

DELETE /mariadb/123

This method allows to delete a postgre SQL instance.

This method is asynchronous (status code 202) and you'll have to wait for async action to be completed by checking its status.

DELETE /postgresql/123

This method allows to delete an OpenSearch instance.

This method is asynchronous (status code 202) and you'll have to wait for async action to be completed by checking its status.

DELETE /opensearch/123

This method allows to delete a SQL Server instance.

This method is asynchronous (status code 202) and you'll have to wait for async action to be completed by checking its status.

• by id

DELETE /compute/databases/sqlserver/1234

• by id and changeReference (RFC)

DELETE /compute/databases/sqlserver/1234
{
	"changeReference": "56789"
}

This method allows to update an OpenSearch instance.

Structure of payload is generic and describes :

• operation you want to be performed
• options data relative to the operation performed - see details - optional.

Below are different operations currently implemented.

Start OpenSearch instance

Use the start operation to start an OpenSearch instance.

Starts OpenSearch instance.

This method is synchronous (status code 202).

Example :

PATCH /opensearch/1234
{
    "operation": "start"
}

Stop OpenSearch instance

Use the stop operation to stop the nodes of the OpenSearch instance and the instance itself.

This operation cannot be undone afterwards.

This method is synchronous (status code 202).

PATCH /opensearch/1234
{
	"operation":"stop"
}

Add nodes the OpenSearch instance

Use the add_nodes operation to add nodes to the OpenSearch instance. nodesCount must be even

This method is synchronous (status code 202).

PATCH /opensearch/1234
{
	"operation":"add_nodes",
	"options" : {
	  "diskSize" : 10,
	  "nodeSize" : "2cpu4gb",
	  "nodesCount": 2
	}
}

Resize OpenSearch instance

Use the resize_nodes operation to resize the sizing of the OpenSearch nodes.

This operation cannot be undone afterwards.

This method is synchronous (status code 202).

PATCH /opensearch/1234
{
	"operation":"resize_nodes",
	"options" : {
	  "nodeSize" : "2cpu4gb",
	  "nodes" : ["node1"]
	}
}

Update Monitoring

Use the update_monitoring operation to update the monitoring state of the cluster.

Use the state option to turn on/off monitoring. Use the on_call option to turn on/off 24/7 monitoring.

This method is synchronous (status code 202).

PATCH /opensearch/1234
{
  "operation": "update_monitoring",
  "options": {
       "state": true,
       "on_call": true
 }
}

Update Patch Party

Use the update_patch_party operation to update the patch party scheduled plan of the OpenSearch instance.

• Use the excluded option to turn on/off patch party.
• Use the patchGroup option to select the patching group, the patchGroup is optional, and is only allowed when the farm has one member.
• Use the exclusionReason option to explain the reason of excluding the resource from patch part.

This method is synchronous (status code 202).

• Include from patch party body:

PATCH /opensearch/1234
{
  "operation": "update_patch_party",
  "options": {
    "patchParty": {
        "excluded": false,
        "patchGroup": "3"
    }
 }
}

• Exclude from patch party body:

PATCH /opensearch/1234
{
  "operation": "update_patch_party",
  "options": {
    "patchParty": {
        "excluded": true,
        "exclusionReason": "I want to handle this by myself"
    }
 }
}

This method allows to update a PostgreSQL instance.

Structure of payload is generic and describes :

• operation you want to be performed
• options data relative to the operation performed - see details - optional.

Below are different operations currently implemented.

Start PostgreSQL instance

Use the start operation to start a PostgreSQL instance.

Starts PostgreSQL instance.

This method is asynchronous (status code 202).

Example :

PATCH /postgresql/1234
{
    "operation": "start"
}

Stop PostgreSQL instance

Use the stop operation to stop the nodes of the PostgreSQL instance and the instance itself.

This operation cannot be undone afterwards.

This method is asynchronous (status code 202).

PATCH /postgresql/1234
{
	"operation":"stop"
}

Resize PostgreSQL instance

Use the resize operation to resize the nodes of the PostgreSQL instance and the instance itself.

This operation cannot be undone afterwards.

This method is asynchronous (status code 202).

PATCH /postgresql/1234
{
	"operation":"resize",
	"options": {
        "sizing": "2cpu4gb"
    }
}

Restore PostgreSQL instance

Use the restore operation to restore a PostgreSQL instance to another PostgreSQL instance with the same farm version.

• the source instance must be backed up.
• the source instance and destination farm must be ACTIVE
• the timestamp must be between now and now - 14 days for production service and now - 7 days for non production service→ raise exception
• timestamp should respect the format described in Json Schema (date-time) The following is correct : 2022-11-02T09:32:02.000+00:00

The available stop options are BEFORE and AFTER.

This method is asynchronous (status code 202).

PATCH /postgresql/5678
{
	"operation": "restore",
	"options": {
	    "sourceId": 1234,
	    "stop": "BEFORE",
	    "timestamp": "2022-11-02T09:32:02.000+00:00"
	}
}

Convert from Standalone to HA PostgreSQL instance

Use the enable_ha operation to convert a PostgreSQL instance from Standalone to HA mode.

• the replicationLag must be between 1 and 500.
• The standalone instance must have a version greater or egal to 12.
• changeReference is optional

This method is asynchronous (status code 202).

PATCH /postgresql/5678
{
	"operation": "enable_ha",
	"options": {
	    "replicationLag": 50,
	    "changeReference": "000"
	}
}

Update Monitoring

Use the update_monitoring operation to update the monitoring state of the cluster.

Use the state option to turn on/off monitoring. Use the on_call option to turn on/off 24/7 monitoring.

This method is asynchronous (status code 202).

PATCH /postgresql/1234
{
  "operation": "update_monitoring",
  "options": {
       "state": true,
       "on_call": true
 }
}

Update Patch Party

Use the update_patch_party operation to update the patch party scheduled plan of the cluster.

• Use the excluded option to turn on/off patch party.
• Use the patchGroup option to select the patching group, the patchGroup is optional, and is only allowed when the farm has one member.
• Use the exclusionReason option to explain the reason of excluding the resource from patch part.

This method is synchronous (status code 202).

• Include from patch party body:

PATCH /postgresql/1234
{
  "operation": "update_patch_party",
  "options": {
    "patchParty": {
        "excluded": false,
        "patchGroup": "3"
    }
 }
}

• Exclude from patch party body:

PATCH /postgresql/1234
{
  "operation": "update_patch_party",
  "options": {
    "patchParty": {
        "excluded": true,
        "exclusionReason": "I want to handle this by myself"
    }
 }
}

Install PostgreSQL extension

Use the install_extension operation to install an extension in the PostgreSQL.

This method is asynchronous (status code 202).

PATCH /postgresql/1234
{
	"operation":"install_extension",
	"options": {
        "dbname": "mydb",
        "extensions_list": [
        		{"name": "ext1"},
        		{"name": "ext2"}
        ]
    }
}

This method allows to update a Redis instance.

Structure of payload is generic and describes :

• operation you want to be performed
• options data relative to the operation performed - see details - optional.

Below are different operations currently implemented.

Start Redis instance

Use the start operation to start a Redis instance.

Starts kafka instance.

This method is synchronous (status code 202).

Example :

PATCH /redis/1234
{
    "operation": "start"
}

Stop Redis instance

Use the stop operation to stop the nodes of the Redis instance and the instance itself.

This operation cannot be undone afterwards.

This method is synchronous (status code 202).

PATCH /redis/1234
{
	"operation":"stop"
}

Resize Redis instance

Use the resize operation to resize the nodes of the Redis instance and the instance itself.

This operation cannot be undone afterwards.

This method is asynchronous (status code 202).

PATCH /redis/1234
{
	"operation":"resize",
	"options": {
        "sizing": "2cpu4gb"
    }
}

Update Monitoring

Use the update_monitoring operation to update the monitoring state of the cluster.

Use the state option to turn on/off monitoring. Use the on_call option to turn on/off 24/7 monitoring.

This method is synchronous (status code 202).

PATCH /redis/1234
{
  "operation": "update_monitoring",
  "options": {
       "state": true,
       "on_call": true
 }
}

Update Patch Party

Use the update_patch_party operation to update the patch party scheduled plan of the cluster.

• Use the excluded option to turn on/off patch party.
• Use the patchGroup option to select the patching group, the patchGroup is optional, and is only allowed when the farm has one member.
• Use the exclusionReason option to explain the reason of excluding the resource from patch part.

This method is synchronous (status code 202).

• Include from patch party body:

PATCH /redis/1234
{
  "operation": "update_patch_party",
  "options": {
    "patchParty": {
        "excluded": false,
        "patchGroup": "3"
    }
 }
}

• Exclude from patch party body:

PATCH /redis/1234
{
  "operation": "update_patch_party",
  "options": {
    "patchParty": {
        "excluded": true,
        "exclusionReason": "I want to handle this by myself"
    }
 }
}

This method allows to update a MariaDB instance.

Structure of payload is generic and describes :

• operation you want to be performed
• options data relative to the operation performed - see details - optional.

Below are different operations currently implemented.

Start MariaDB instance

Use the start operation to start a MariaDB instance.

Starts kafka instance.

This method is synchronous (status code 202).

Example :

PATCH /mariadb/1234
{
    "operation": "start"
}

Stop MariaDB instance

Use the stop operation to stop the nodes of the MariaDB instance and the instance itself.

This operation cannot be undone afterwards.

This method is synchronous (status code 202).

PATCH /compute/databases/mariadb/1234
{
	"operation":"stop"
}

Resize MariaDB instance

Use the resize operation to resize the sizing of the MariaDB instance.

This operation cannot be undone afterwards.

This method is synchronous (status code 202).

PATCH /compute/databases/mariadb/1234
{
	"operation":"resize",
	"options" : {
	  "sizing" : "2cpu4gb"
	}
}

Update Monitoring

Use the update_monitoring operation to update the monitoring state of the MariaDB instance.

Use the state option to turn on/off monitoring. Use the on_call option to turn on/off 24/7 monitoring.

This method is synchronous (status code 202).

PATCH /mariadb/1234
{
  "operation": "update_monitoring",
  "options": {
       "state": true,
       "on_call": true
 }
}

Update Patch Party

Use the update_patch_party operation to update the patch party scheduled plan for the MariaDB instance.

• Use the excluded option to turn on/off patch party.
• Use the patchGroup option to select the patching group, the patchGroup is optional, and is only allowed when the farm has one member.
• Use the exclusionReason option to explain the reason of excluding the resource from patch part.

This method is synchronous (status code 202).

• Include from patch party body:

PATCH /mariadb/1234
{
  "operation": "update_patch_party",
  "options": {
    "patchParty": {
        "excluded": false,
        "patchGroup": "3"
    }
 }
}

• Exclude from patch party body:

PATCH /mariadb/1234
{
  "operation": "update_patch_party",
  "options": {
    "patchParty": {
        "excluded": true,
        "exclusionReason": "I want to handle this by myself"
    }
 }
}

This method allows to update a SQL Server Farm.

Structure of payload is generic and describes :

• operation you want to be performed
• options data relative to the operation performed - see details - optional.

Below are different operations currently implemented.

Start SQL Server Farm

Use the start operation to start the SQL Server Farm.

This method is synchronous (status code 202).

Example :

PATCH /compute/databases/sqlserver/1234
{
    "operation": "start"
}

Stop SQL Server Farm

Use the stop operation to stop the SQL Server Farm.

This operation cannot be undone afterwards.

This method is synchronous (status code 202).

• by SQL Server id

PATCH /compute/databases/sqlserver/1234
{
	"operation": "stop"
}

• by sql server id and changeReference number (RFC)

PATCH /compute/databases/sqlserver/1234
{
	"operation": "stop",
	"options": {
	    "changeReference": "56789"
	}
}

Reset SQLServer Farm

Use the reset operation to reset the SQL Server Farm.

This method is synchronous (status code 202).

Example :

PATCH /compute/databases/sqlserver/1234
{
    "operation": "reset"
}

Resize SQLServer instance

Use the resize operation to resize the nodes of the SQLServer instance and the instance itself.

This operation cannot be undone afterwards.

This method is asynchronous (status code 202).

PATCH /compute/databases/sqlserver/1234
{
	"operation":"resize",
	"options": {
        "sizing": "2cpu4gb"
    }
}

Update Monitoring

Use the update_monitoring operation to update the monitoring state of the SQL Server.

Use the state option to turn on/off monitoring. Use the on_call option to turn on/off 24/7 monitoring.

This method is synchronous (status code 202).

PATCH /compute/databases/sqlserver/1234
{
  "operation": "update_monitoring",
  "options": {
       "state": true,
       "on_call": true
 }
}

Update Patch Party

Use the update_patch_party operation to update the patch party scheduled plan of the SQLServer.

• Use the excluded option to turn on/off patch party.
• Use the patchGroup option to select the patching group, the patchGroup is optional, and is only allowed when the farm has one member.
• Use the exclusionReason option to explain the reason of excluding the resource from patch part.

This method is synchronous (status code 202).

• Include from patch party body:

PATCH /compute/databases/sqlserver/1234
{
  "operation": "update_patch_party",
  "options": {
    "patchParty": {
        "excluded": false,
        "patchGroup": "3"
    }
 }
}

• Exclude from patch party body:

PATCH /compute/databases/sqlserver/1234
{
  "operation": "update_patch_party",
  "options": {
    "patchParty": {
        "excluded": true,
        "exclusionReason": "I want to handle this by myself"
    }
 }
}

This method allows to create an OpenSearch instance.

You will have to know at the minimum :

• the area of the region where you want to host your cluster (area attribute). Areas can be available in List Regions method.
• name of OpenSearch cluster (name attribute). The name can contain any lowercase characters or numbers (5-60). It must not be the keyword 'cluster'.
• Size of nodes in the OpenSearch cluster (nodeSizing attribute). Ex: 2cpu4gb
• storage needed on each data node of the OpenSearch cluster (diskSize attribute). The possible values are at least 40 and maximum 1024 (representing GB).
• how to connect to the instance (admPassword attribute). The password must be At least one lowercase, one uppercase, one digit, one special character, minimum length must be 12.
• version of the OpenSearch cluster (clusterVersion attribute). Example: 1.2.3
• On which service the OpenSearch instance belongs to (serviceId attribute).
• network ID of the cluster (networkId attribute).
• Number of instances in the OpenSearch cluster (instanceCount attribute). Must be odd and at least be 3, recommended is 5, Maximum is 51
• Node prefix of the OpenSearch cluster (nodePrefix attribute). 4 to 60 uppercase characters

This method is asynchronous (status code 202) and you'll have to wait for async action to be completed by checking its status.

POST /opensearch
{
  "clusterVersion": "1.2.3",
  "region" : "EB",
  "area": "EB-QA",
  "az": "az",
  "name": "Test123",
  "nodeSizing": "2cpu4gb",
  "diskSize": 40,
  "networkId": 1234511,
  "serviceId": 46922,
  "admPassword": "Test123@2022",
  "instanceCount": "3",
  "nodePrefix" : "OPESTC"
}

This method allows to create a redis instance.

You will have to know at the minimum :

• the area of the region where you want to host your cluster (area attribute). Areas can be available in List Regions method.
• name of redis cluster (name attribute). The name can contain any lowercase characters or numbers (5-60). It must not be the keyword 'cluster'.
• Size of nodes in the redis cluster (nodeSizing attribute). Ex: 2cpu2gb
• storage needed on each data node of the redis cluster (diskSize attribute). The possible values are at least 40 and maximum 1024 (representing GB).
• how to connect to the instance (admPassword attribute). The password must be At least one lowercase, one uppercase, one digit, one special character, minimum length must be 12.
• version of the redis cluster (redisVersion attribute). Example: 6.2.5
• On which service the redis instance belongs to (serviceId attribute).
• network ID of the cluster (networkId attribute).
• Number of instances in the redis cluster (instanceCount attribute). Minimum 1 and maximum 3
• Persistence mode of the redis cluster (persistenceMode attribute).

optional fields:

• Availability zone of the redis cluster (az attribute).

This method is asynchronous (status code 202) and you'll have to wait for async action to be completed by checking its status.

POST /redis
{
  "redisVersion": "6.2.5",
  "region" : "EB",
  "area": "EB-QA",
  "az": "az",
  "name": "Test123",
  "nodeSizing": "2cpu2gb",
  "diskSize": 40,
  "networkId": 1234511,
  "serviceId": 46922,
  "admPassword": "Test123@2022",
  "instanceCount": 1,
  "persistenceMode" : "PERSISTENT"
}

This method allows to create a Maria DB instance.

You will have to know at the minimum :

• the area of the region where you want to host your cluster (area attribute). Areas can be available in List Regions method.
• name of Maria DB cluster (name attribute). The name can contain any lowercase characters or numbers (5-60). It must not be the keyword 'cluster'.
• Size of nodes in the maria DB cluster (nodeSizing attribute). Ex: 2cpu2gb
• storage needed on each data node of the Maria DB cluster (diskSize attribute). The possible values are at least 40 and maximum 1024 (representing GB).
• how to connect to the instance (admPassword attribute). The password must be At least one lowercase, one uppercase, one digit, one special character, minimum length must be 12.
• version of the Maria DB cluster (Maria DBVersion attribute). Example: 13
• On which service the Maria DB instance belongs to (serviceId attribute).
• network ID of the cluster (networkId attribute).
• Number of instances in the Maria DB cluster (instanceCount attribute). Minimum 1 and maximum 3
• topology of the Maria DB cluster (topology attribute). Either single or cluster

optional fields:

• Availability zone of the Maria DB cluster (az attribute).
• TLS enabled boolean for the redis cluster (tlsEnabled attribute).

This method is asynchronous (status code 202) and you'll have to wait for async action to be completed by checking its status.

POST /mariadb
{
  "version": "10.6",
  "region" : "EB",
  "area": "EB-QA",
  "az": "az",
  "name": "Test123",
  "nodeSizing": "2cpu2gb",
  "diskSize": 40,
  "networkId": 1234511,
  "serviceId": 46922,
  "admPassword": "Test123@2022",
  "instanceCount": 1,
  "topology" : "SINGLE"
}

This method allows to create a postgre SQL instance.

You will have to know at the minimum :

• the area of the region where you want to host your cluster (area attribute). Areas can be available in List Regions method.
• name of postgre SQL cluster (name attribute). The name can contain any lowercase characters or numbers (5-60). It must not be the keyword 'cluster'.
• Size of nodes in the postgre SQL cluster (nodeSizing attribute). Ex: 2cpu2gb
• storage needed on each data node of the postgre SQL cluster (diskSize attribute). The possible values are at least 40 and maximum 1024 (representing GB).
• how to connect to the instance (admPassword attribute). The password must be At least one lowercase, one uppercase, one digit, one special character, minimum length must be 12.
• version of the postgre SQL cluster (postgreVersion attribute). Example: 13
• On which service the postgre SQL instance belongs to (serviceId attribute).
• network ID of the cluster (networkId attribute).
• Topology of the postgre SQL cluster (topology attribute). Either standalone / HA
• trigram of the postgre SQL cluster (trigram attribute).
• Allowed replication Lag of the postgre SQL (allowedReplicationLag attribute). The minimum size is 1 MB and maximum is 10240 MB

HA topology extra fields: These fields are required for HA clusters:

• prefix of the node names for postgre cluster (nodePrefix attribute). The prefix should be from 5 to 12 characters and can contain any uppercase character.
• Availability zone of the postgre cluster (az attribute).
• Trigram of the postgre cluster (trigram attribute).
• TLS enabled boolean for the postgre cluster (tls attribute).

This method is asynchronous (status code 202) and you'll have to wait for async action to be completed by checking its status.

POST /postgresql
{
  "serviceId" : 123,
  "nodeSizing" : "2cpu4gb",
  "networkId" : 132,
  "area" : "EB-QA",
  "diskSize" : 40,
  "admPassword" : "Test123@2022",
  "postgreVersion" : "13",
  "allowedReplicationLag" : 10,
  "az" : "az",
  "topology" : "STANDALONE",
  "trigram" : "tri",
  "tls" : true,
  "name" : "NEWPOSTGRE01"
}