Database

• engines
  • getList available engines.
  • getEngine detail.
• instance_types
  • getList available instance types.
  • getInstance Type detail.
• instances
  • getList all database instances.
  • postCreates a new database instance.
  • getDatabase instance details.
  • patchDatabase instance update.
  • delDeletes a database instance.
  • postResizes a database instance.
  • postStarts a database instance.
  • postStops a database instance.
  • getBackups List.
  • postBackup Create.
  • getBackup Detail.
  • delDelete Backup.
  • postBackup restore.
  • getSnapshots List.
  • postSnapshot Create.
  • getSnapshot Detail.
  • patchSnapshot Update.
  • delDelete Snapshot.
• backups
  • getBackups List.
  • getBackup Detail.
  • delDelete Backup.
• replicas
  • getReplicas List.
  • postReplica Create.
  • getReplica Detail.
  • delDeletes a replica instance.
  • postReplica Resize.
  • postReplica Start.
  • postReplica Stop.
• snapshots
  • postCreate a new instance from snapshot asynchronously.

API docs by Redocly

DBaaS API Product (1.34.1)

DBaaS API Product.

engines

Engines available for database instances.

List available engines.

Returns a list of available engines.

Authorizations:

bearerAuthOAuth2

query Parameters

_offset	integer >= 0 Default: 0 The number of items to skip before starting to collect the result set.
_limit	integer [ 1 .. 50 ] Default: 10 The maximum number of items per page.
status	string (EngineStatus) Enum: "ACTIVE" "DEPRECATED" Value referring to engine status.

Responses

https://api.magalu.cloud/br-ne-1/database/v1/engines

https://api.magalu.cloud/br-se1/database/v1/engines

Response samples

• 200
• 400
• 401
• 403
• 422
• 500

Content type

application/json

{

• "meta": {

  • "filters": [

    • {

      • "field": "string",
      • "value": "string"

      }

    ],
  • "page": {

    • "offset": 0,
    • "limit": 0,
    • "count": 0,
    • "total": 0,
    • "max_limit": 0

    }

  },
• "results": [

  • {

    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "engine": "mysql",
    • "name": "mysql",
    • "version": "5.7",
    • "status": "ACTIVE"

    }

  ]

}

Engine detail.

Returns a engine detail.

Authorizations:

bearerAuthOAuth2

path Parameters

engine_id required

string <uuid> (Datastore Id (Deprecated)) Example: 7a11cfc5-f9f8-4fa2-a418-94a423f6a51f Value referring to datastore Id.

Responses

https://api.magalu.cloud/br-ne-1/database/v1/engines/{engine_id}

https://api.magalu.cloud/br-se1/database/v1/engines/{engine_id}

Response samples

• 200
• 400
• 401
• 403
• 404
• 422
• 500

Content type

application/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "engine": "mysql",
• "name": "mysql",
• "version": "5.7",
• "status": "ACTIVE"

}

instance_types

Instance Types available for database instances.

List available instance types.

Returns a list of available instance types. An instance type is a hardware template that defines the size of RAM and vCPU.

Authorizations:

bearerAuthOAuth2

query Parameters

_offset	integer >= 0 Default: 0 The number of items to skip before starting to collect the result set.
_limit	integer [ 1 .. 50 ] Default: 10 The maximum number of items per page.
status	string (Instance Type Status) Default: "ACTIVE" Enum: "ACTIVE" "DEPRECATED" An enumeration.
engine_id	string <uuid> (Engine Id) Engine Id unique identifier

Responses

https://api.magalu.cloud/br-ne-1/database/v1/instance-types

https://api.magalu.cloud/br-se1/database/v1/instance-types

Response samples

• 200
• 400
• 401
• 403
• 422
• 500

Content type

application/json

{

• "meta": {

  • "filters": [

    • {

      • "field": "string",
      • "value": "string"

      }

    ],
  • "page": {

    • "offset": 0,
    • "limit": 0,
    • "count": 0,
    • "total": 0,
    • "max_limit": 0

    }

  },
• "results": [

  • {

    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "name": "i0-c1-r4-d10",
    • "label": "cloud-dbaas-bs1.small",
    • "vcpu": "1",
    • "ram": "4 GB",
    • "family_description": "Basic",
    • "family_slug": "bs1",
    • "size": "Small",
    • "sku_source": "BRNE10600101sm",
    • "sku_replica": "BRNE10610101sm"

    }

  ]

}

Instance Type detail.

Returns an instance type detail.

Authorizations:

bearerAuthOAuth2

path Parameters

instance_type_id required

string <uuid> (Instance Type Id) Instance Type Unique Id.

Responses

https://api.magalu.cloud/br-ne-1/database/v1/instance-types/{instance_type_id}

https://api.magalu.cloud/br-se1/database/v1/instance-types/{instance_type_id}

Response samples

• 200
• 400
• 401
• 403
• 404
• 422
• 500

Content type

application/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "name": "i0-c1-r4-d10",
• "label": "cloud-dbaas-bs1.small",
• "vcpu": "1",
• "ram": "4 GB",
• "family_description": "Basic",
• "family_slug": "bs1",
• "size": "Small",
• "sku_source": "BRNE10600101sm",
• "sku_replica": "BRNE10610101sm"

}

instances

Database instances management.

List all database instances.

Returns a list of database instances for a x-tenant-id.

Authorizations:

bearerAuthOAuth2

query Parameters

_offset	integer >= 0 Default: 0 The number of items to skip before starting to collect the result set.
_limit	integer [ 1 .. 25 ] Default: 10 The maximum number of items per page.
status	string (Instance Status) Enum: "CREATING" "ERROR" "STOPPED" "REBOOT" "PENDING" "RESIZING" "DELETED" "ACTIVE" "STARTING" "STOPPING" "BACKING_UP" "DELETING" "RESTORING" "ERROR_DELETING" "MAINTENANCE" "MAINTENANCE_ERROR" Example: status=ACTIVE Value referring to instance status.
_expand	string (Instance Expand) Value: "replicas" Instance extra attributes or relations to show with the main query. When available, more than one value can be informed using commas. e.g: _expand=value1,value2
engine_id	string <uuid> (Engine Id) Value referring to engine Id.
volume.size	integer (Volume.Size) Value referring to volume size.
volume.size__gt	integer (Volume.Size Gt) Value referring to volume size greater than.
volume.size__gte	integer (Volume.Size Gte) Value referring to volume size greater than or equal to.
volume.size__lt	integer (Volume.Size Lt) Value referring to volume size less than.
volume.size__lte	integer (Volume.Size Lte) Value referring to volume size less than or equal to.

Responses

https://api.magalu.cloud/br-ne-1/database/v1/instances

https://api.magalu.cloud/br-se1/database/v1/instances

Response samples

• 200
• 400
• 401
• 403
• 422
• 500

Content type

application/json

{

• "meta": {

  • "filters": [

    • {

      • "field": "string",
      • "value": "string"

      }

    ],
  • "page": {

    • "offset": 0,
    • "limit": 0,
    • "count": 0,
    • "total": 0,
    • "max_limit": 0

    }

  },
• "results": [

  • {

    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "name": "mydbinstance",
    • "engine_id": "b1d2d00a-6e57-4e4b-9c8e-447d4c2457d0",
    • "datastore_id": "1c9da258-8b16-420b-b1ca-dda81ec7ed87",
    • "flavor_id": "fa3e89aa-6829-47f5-8bf4-76d57211a9f1",
    • "instance_type_id": "b67afca2-5b6f-43dd-b5de-7627dae240c8",
    • "volume": {

      • "size": 30,
      • "type": "CLOUD_NVME"

      },
    • "addresses": [

      • {

        • "access": "PRIVATE",
        • "type": "IPv4",
        • "address": "172.53.10.82"

        }

      ],
    • "status": "ACTIVE",
    • "generation": "G1B",
    • "parameters": [

      • {

        • "name": "LOWER_CASE_TABLE_NAMES",
        • "value": 0

        }

      ],
    • "backup_retention_days": 7,
    • "backup_start_at": "04:00:00",
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z",
    • "started_at": "2019-08-24T14:15:22Z",
    • "finished_at": "2019-08-24T14:15:22Z",
    • "maintenance_scheduled_at": "2019-08-24T14:15:22Z",
    • "replicas": [

      • {

        • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        • "source_id": "ae50a35c-df42-4eff-ba26-f8bc28d2af81",
        • "name": "string",
        • "engine_id": "b1d2d00a-6e57-4e4b-9c8e-447d4c2457d0",
        • "datastore_id": "1c9da258-8b16-420b-b1ca-dda81ec7ed87",
        • "instance_type_id": "b67afca2-5b6f-43dd-b5de-7627dae240c8",
        • "flavor_id": "fa3e89aa-6829-47f5-8bf4-76d57211a9f1",
        • "volume": {

          • "size": 30,
          • "type": "CLOUD_NVME"

          },
        • "addresses": [

          • {

            • "access": "PRIVATE",
            • "type": "IPv4",
            • "address": "string"

            }

          ],
        • "status": "ACTIVE",
        • "generation": "G1B",
        • "parameters": [

          • {

            • "name": "LOWER_CASE_TABLE_NAMES",
            • "value": 0

            }

          ],
        • "created_at": "2019-08-24T14:15:22Z",
        • "updated_at": "2019-08-24T14:15:22Z",
        • "started_at": "2019-08-24T14:15:22Z",
        • "finished_at": "2019-08-24T14:15:22Z",
        • "maintenance_scheduled_at": "2019-08-24T14:15:22Z"

        }

      ]

    }

  ]

}

Creates a new database instance.

Creates a new database instance asynchronously for a tenant.

Authorizations:

bearerAuthOAuth2

Request Body schema: application/json

required

name required	string (Name) <= 100 characters
engine_id	string <uuid> (Engine Id)
datastore_id	string <uuid> (Datastore Id (Deprecated)) Deprecated Deprecated: This property is being deprecated in favor of engine_id. Please update your requests to use engine_id for improved functionality and future compatibility.
flavor_id	string <uuid> (Flavor Id (Deprecated)) Deprecated Deprecated: This property is being deprecated in favor of instance_type_id. Please update your requests to use instance_type_id for improved functionality and future compatibility.
instance_type_id	string <uuid> (Instance Type Id)
user required	string (User) <= 25 characters
password required	string (Password) <= 50 characters
required	object (Instance Volume Request)
	Array of objects (InstanceParametersRequest) Default: []
backup_retention_days	integer (Backup Retention Days) Default: 7 The number of days that a particular backup is kept until its deletion.
backup_start_at	string <time> (Backup Start At) Default: "04:00:00" Start time (UTC timezone) which is allowed to start the automated backup process.

Responses

https://api.magalu.cloud/br-ne-1/database/v1/instances

https://api.magalu.cloud/br-se1/database/v1/instances

Request samples

• Payload

Content type

application/json

{

• "name": "string",
• "engine_id": "b1d2d00a-6e57-4e4b-9c8e-447d4c2457d0",
• "datastore_id": "1c9da258-8b16-420b-b1ca-dda81ec7ed87",
• "flavor_id": "fa3e89aa-6829-47f5-8bf4-76d57211a9f1",
• "instance_type_id": "b67afca2-5b6f-43dd-b5de-7627dae240c8",
• "user": "string",
• "password": "string",
• "volume": {

  • "size": 30,
  • "type": "CLOUD_NVME_15K"

  },
• "parameters": [ ],
• "backup_retention_days": 7,
• "backup_start_at": "04:00:00"

}

Response samples

• 202
• 400
• 401
• 403
• 422
• 500

Content type

application/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"

}

Database instance details.

Returns a database instance detail.

Authorizations:

bearerAuthOAuth2

path Parameters

instance_id required

string <uuid> (Instance Id) Example: f21999cb-302f-48f7-b584-6a84748e112c Value referring to instance Id.

query Parameters

_expand

string (Instance Expand) Value: "replicas" Instance extra attributes or relations to show with the main query. When available, more than one value can be informed using commas. e.g: _expand=value1,value2

Responses

https://api.magalu.cloud/br-ne-1/database/v1/instances/{instance_id}

https://api.magalu.cloud/br-se1/database/v1/instances/{instance_id}

Response samples

• 200
• 400
• 401
• 403
• 404
• 422
• 500

Content type

application/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "name": "mydbinstance",
• "engine_id": "b1d2d00a-6e57-4e4b-9c8e-447d4c2457d0",
• "datastore_id": "1c9da258-8b16-420b-b1ca-dda81ec7ed87",
• "flavor_id": "fa3e89aa-6829-47f5-8bf4-76d57211a9f1",
• "instance_type_id": "b67afca2-5b6f-43dd-b5de-7627dae240c8",
• "volume": {

  • "size": 30,
  • "type": "CLOUD_NVME"

  },
• "addresses": [

  • {

    • "access": "PRIVATE",
    • "type": "IPv4",
    • "address": "172.53.10.82"

    }

  ],
• "status": "ACTIVE",
• "generation": "G1B",
• "parameters": [

  • {

    • "name": "LOWER_CASE_TABLE_NAMES",
    • "value": 0

    }

  ],
• "backup_retention_days": 7,
• "backup_start_at": "04:00:00",
• "created_at": "2019-08-24T14:15:22Z",
• "updated_at": "2019-08-24T14:15:22Z",
• "started_at": "2019-08-24T14:15:22Z",
• "finished_at": "2019-08-24T14:15:22Z",
• "maintenance_scheduled_at": "2019-08-24T14:15:22Z",
• "replicas": [

  • {

    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "source_id": "ae50a35c-df42-4eff-ba26-f8bc28d2af81",
    • "name": "string",
    • "engine_id": "b1d2d00a-6e57-4e4b-9c8e-447d4c2457d0",
    • "datastore_id": "1c9da258-8b16-420b-b1ca-dda81ec7ed87",
    • "instance_type_id": "b67afca2-5b6f-43dd-b5de-7627dae240c8",
    • "flavor_id": "fa3e89aa-6829-47f5-8bf4-76d57211a9f1",
    • "volume": {

      • "size": 30,
      • "type": "CLOUD_NVME"

      },
    • "addresses": [

      • {

        • "access": "PRIVATE",
        • "type": "IPv4",
        • "address": "string"

        }

      ],
    • "status": "ACTIVE",
    • "generation": "G1B",
    • "parameters": [

      • {

        • "name": "LOWER_CASE_TABLE_NAMES",
        • "value": 0

        }

      ],
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z",
    • "started_at": "2019-08-24T14:15:22Z",
    • "finished_at": "2019-08-24T14:15:22Z",
    • "maintenance_scheduled_at": "2019-08-24T14:15:22Z"

    }

  ]

}

Database instance update.

Updates a database instance.

Authorizations:

bearerAuthOAuth2

path Parameters

instance_id required

string <uuid> (Instance Id) Example: f21999cb-302f-48f7-b584-6a84748e112c Value referring to instance Id.

Request Body schema: application/json

required

status	string (Instance Status Update) Enum: "ACTIVE" "STOPPED"
backup_retention_days	integer (Backup Retention Days) The number of days that a particular backup is kept until its deletion.
backup_start_at	string <time> (Backup Start At) Start time (UTC timezone) which is allowed to start the automated backup process.

Responses

https://api.magalu.cloud/br-ne-1/database/v1/instances/{instance_id}

https://api.magalu.cloud/br-se1/database/v1/instances/{instance_id}

Request samples

• Payload

Content type

application/json

{

• "status": "ACTIVE",
• "backup_retention_days": 7,
• "backup_start_at": "04:00:00"

}

Response samples

• 200
• 400
• 401
• 403
• 404
• 422
• 500

Content type

application/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "name": "mydbinstance",
• "engine_id": "b1d2d00a-6e57-4e4b-9c8e-447d4c2457d0",
• "datastore_id": "1c9da258-8b16-420b-b1ca-dda81ec7ed87",
• "flavor_id": "fa3e89aa-6829-47f5-8bf4-76d57211a9f1",
• "instance_type_id": "b67afca2-5b6f-43dd-b5de-7627dae240c8",
• "volume": {

  • "size": 30,
  • "type": "CLOUD_NVME"

  },
• "addresses": [

  • {

    • "access": "PRIVATE",
    • "type": "IPv4",
    • "address": "172.53.10.82"

    }

  ],
• "status": "ACTIVE",
• "generation": "G1B",
• "parameters": [

  • {

    • "name": "LOWER_CASE_TABLE_NAMES",
    • "value": 0

    }

  ],
• "backup_retention_days": 7,
• "backup_start_at": "04:00:00",
• "created_at": "2019-08-24T14:15:22Z",
• "updated_at": "2019-08-24T14:15:22Z",
• "started_at": "2019-08-24T14:15:22Z",
• "finished_at": "2019-08-24T14:15:22Z",
• "maintenance_scheduled_at": "2019-08-24T14:15:22Z",
• "replicas": [

  • {

    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "source_id": "ae50a35c-df42-4eff-ba26-f8bc28d2af81",
    • "name": "string",
    • "engine_id": "b1d2d00a-6e57-4e4b-9c8e-447d4c2457d0",
    • "datastore_id": "1c9da258-8b16-420b-b1ca-dda81ec7ed87",
    • "instance_type_id": "b67afca2-5b6f-43dd-b5de-7627dae240c8",
    • "flavor_id": "fa3e89aa-6829-47f5-8bf4-76d57211a9f1",
    • "volume": {

      • "size": 30,
      • "type": "CLOUD_NVME"

      },
    • "addresses": [

      • {

        • "access": "PRIVATE",
        • "type": "IPv4",
        • "address": "string"

        }

      ],
    • "status": "ACTIVE",
    • "generation": "G1B",
    • "parameters": [

      • {

        • "name": "LOWER_CASE_TABLE_NAMES",
        • "value": 0

        }

      ],
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z",
    • "started_at": "2019-08-24T14:15:22Z",
    • "finished_at": "2019-08-24T14:15:22Z",
    • "maintenance_scheduled_at": "2019-08-24T14:15:22Z"

    }

  ]

}

Deletes a database instance.

Deletes a database instance.

Authorizations:

bearerAuthOAuth2

path Parameters

instance_id required

string <uuid> (Instance Id) Example: f21999cb-302f-48f7-b584-6a84748e112c Value referring to instance Id.

Responses

https://api.magalu.cloud/br-ne-1/database/v1/instances/{instance_id}

https://api.magalu.cloud/br-se1/database/v1/instances/{instance_id}

Response samples

• 202
• 400
• 401
• 403
• 404
• 422
• 500

Content type

application/json

null

Resizes a database instance.

Resizes a database instance.

Authorizations:

bearerAuthOAuth2

path Parameters

instance_id required

string <uuid> (Instance Id) Example: f21999cb-302f-48f7-b584-6a84748e112c Value referring to instance Id.

Request Body schema: application/json

required

instance_type_id	string <uuid> (Instance Type Id)
flavor_id	string <uuid> (Flavor Id (Deprecated)) Deprecated Deprecated: This property is being deprecated in favor of instance_type_id. Please update your requests to use instance_type_id for improved functionality and future compatibility.
	object (Instance Volume Request)

Responses

https://api.magalu.cloud/br-ne-1/database/v1/instances/{instance_id}/resize

https://api.magalu.cloud/br-se1/database/v1/instances/{instance_id}/resize

Request samples

• Payload

Content type

application/json

{

• "instance_type_id": "b67afca2-5b6f-43dd-b5de-7627dae240c8",
• "flavor_id": "fa3e89aa-6829-47f5-8bf4-76d57211a9f1",
• "volume": {

  • "size": 30,
  • "type": "CLOUD_NVME_15K"

  }

}

Response samples

• 200
• 400
• 401
• 403
• 404
• 422
• 500

Content type

application/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "name": "mydbinstance",
• "engine_id": "b1d2d00a-6e57-4e4b-9c8e-447d4c2457d0",
• "datastore_id": "1c9da258-8b16-420b-b1ca-dda81ec7ed87",
• "flavor_id": "fa3e89aa-6829-47f5-8bf4-76d57211a9f1",
• "instance_type_id": "b67afca2-5b6f-43dd-b5de-7627dae240c8",
• "volume": {

  • "size": 30,
  • "type": "CLOUD_NVME"

  },
• "addresses": [

  • {

    • "access": "PRIVATE",
    • "type": "IPv4",
    • "address": "172.53.10.82"

    }

  ],
• "status": "ACTIVE",
• "generation": "G1B",
• "parameters": [

  • {

    • "name": "LOWER_CASE_TABLE_NAMES",
    • "value": 0

    }

  ],
• "backup_retention_days": 7,
• "backup_start_at": "04:00:00",
• "created_at": "2019-08-24T14:15:22Z",
• "updated_at": "2019-08-24T14:15:22Z",
• "started_at": "2019-08-24T14:15:22Z",
• "finished_at": "2019-08-24T14:15:22Z",
• "maintenance_scheduled_at": "2019-08-24T14:15:22Z",
• "replicas": [

  • {

    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "source_id": "ae50a35c-df42-4eff-ba26-f8bc28d2af81",
    • "name": "string",
    • "engine_id": "b1d2d00a-6e57-4e4b-9c8e-447d4c2457d0",
    • "datastore_id": "1c9da258-8b16-420b-b1ca-dda81ec7ed87",
    • "instance_type_id": "b67afca2-5b6f-43dd-b5de-7627dae240c8",
    • "flavor_id": "fa3e89aa-6829-47f5-8bf4-76d57211a9f1",
    • "volume": {

      • "size": 30,
      • "type": "CLOUD_NVME"

      },
    • "addresses": [

      • {

        • "access": "PRIVATE",
        • "type": "IPv4",
        • "address": "string"

        }

      ],
    • "status": "ACTIVE",
    • "generation": "G1B",
    • "parameters": [

      • {

        • "name": "LOWER_CASE_TABLE_NAMES",
        • "value": 0

        }

      ],
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z",
    • "started_at": "2019-08-24T14:15:22Z",
    • "finished_at": "2019-08-24T14:15:22Z",
    • "maintenance_scheduled_at": "2019-08-24T14:15:22Z"

    }

  ]

}

Starts a database instance.

Starts a database instance.

Authorizations:

bearerAuthOAuth2

path Parameters

instance_id required

string <uuid> (Instance Id) Example: f21999cb-302f-48f7-b584-6a84748e112c Value referring to instance Id.

Responses

https://api.magalu.cloud/br-ne-1/database/v1/instances/{instance_id}/start

https://api.magalu.cloud/br-se1/database/v1/instances/{instance_id}/start

Response samples

• 200
• 400
• 401
• 403
• 404
• 422
• 500

Content type

application/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "name": "mydbinstance",
• "engine_id": "b1d2d00a-6e57-4e4b-9c8e-447d4c2457d0",
• "datastore_id": "1c9da258-8b16-420b-b1ca-dda81ec7ed87",
• "flavor_id": "fa3e89aa-6829-47f5-8bf4-76d57211a9f1",
• "instance_type_id": "b67afca2-5b6f-43dd-b5de-7627dae240c8",
• "volume": {

  • "size": 30,
  • "type": "CLOUD_NVME"

  },
• "addresses": [

  • {

    • "access": "PRIVATE",
    • "type": "IPv4",
    • "address": "172.53.10.82"

    }

  ],
• "status": "ACTIVE",
• "generation": "G1B",
• "parameters": [

  • {

    • "name": "LOWER_CASE_TABLE_NAMES",
    • "value": 0

    }

  ],
• "backup_retention_days": 7,
• "backup_start_at": "04:00:00",
• "created_at": "2019-08-24T14:15:22Z",
• "updated_at": "2019-08-24T14:15:22Z",
• "started_at": "2019-08-24T14:15:22Z",
• "finished_at": "2019-08-24T14:15:22Z",
• "maintenance_scheduled_at": "2019-08-24T14:15:22Z",
• "replicas": [

  • {

    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "source_id": "ae50a35c-df42-4eff-ba26-f8bc28d2af81",
    • "name": "string",
    • "engine_id": "b1d2d00a-6e57-4e4b-9c8e-447d4c2457d0",
    • "datastore_id": "1c9da258-8b16-420b-b1ca-dda81ec7ed87",
    • "instance_type_id": "b67afca2-5b6f-43dd-b5de-7627dae240c8",
    • "flavor_id": "fa3e89aa-6829-47f5-8bf4-76d57211a9f1",
    • "volume": {

      • "size": 30,
      • "type": "CLOUD_NVME"

      },
    • "addresses": [

      • {

        • "access": "PRIVATE",
        • "type": "IPv4",
        • "address": "string"

        }

      ],
    • "status": "ACTIVE",
    • "generation": "G1B",
    • "parameters": [

      • {

        • "name": "LOWER_CASE_TABLE_NAMES",
        • "value": 0

        }

      ],
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z",
    • "started_at": "2019-08-24T14:15:22Z",
    • "finished_at": "2019-08-24T14:15:22Z",
    • "maintenance_scheduled_at": "2019-08-24T14:15:22Z"

    }

  ]

}

Stops a database instance.

Stops a database instance.

Authorizations:

bearerAuthOAuth2

path Parameters

instance_id required

string <uuid> (Instance Id) Example: f21999cb-302f-48f7-b584-6a84748e112c Value referring to instance Id.

Responses

https://api.magalu.cloud/br-ne-1/database/v1/instances/{instance_id}/stop

https://api.magalu.cloud/br-se1/database/v1/instances/{instance_id}/stop

Response samples

• 200
• 400
• 401
• 403
• 404
• 422
• 500

Content type

application/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "name": "mydbinstance",
• "engine_id": "b1d2d00a-6e57-4e4b-9c8e-447d4c2457d0",
• "datastore_id": "1c9da258-8b16-420b-b1ca-dda81ec7ed87",
• "flavor_id": "fa3e89aa-6829-47f5-8bf4-76d57211a9f1",
• "instance_type_id": "b67afca2-5b6f-43dd-b5de-7627dae240c8",
• "volume": {

  • "size": 30,
  • "type": "CLOUD_NVME"

  },
• "addresses": [

  • {

    • "access": "PRIVATE",
    • "type": "IPv4",
    • "address": "172.53.10.82"

    }

  ],
• "status": "ACTIVE",
• "generation": "G1B",
• "parameters": [

  • {

    • "name": "LOWER_CASE_TABLE_NAMES",
    • "value": 0

    }

  ],
• "backup_retention_days": 7,
• "backup_start_at": "04:00:00",
• "created_at": "2019-08-24T14:15:22Z",
• "updated_at": "2019-08-24T14:15:22Z",
• "started_at": "2019-08-24T14:15:22Z",
• "finished_at": "2019-08-24T14:15:22Z",
• "maintenance_scheduled_at": "2019-08-24T14:15:22Z",
• "replicas": [

  • {

    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "source_id": "ae50a35c-df42-4eff-ba26-f8bc28d2af81",
    • "name": "string",
    • "engine_id": "b1d2d00a-6e57-4e4b-9c8e-447d4c2457d0",
    • "datastore_id": "1c9da258-8b16-420b-b1ca-dda81ec7ed87",
    • "instance_type_id": "b67afca2-5b6f-43dd-b5de-7627dae240c8",
    • "flavor_id": "fa3e89aa-6829-47f5-8bf4-76d57211a9f1",
    • "volume": {

      • "size": 30,
      • "type": "CLOUD_NVME"

      },
    • "addresses": [

      • {

        • "access": "PRIVATE",
        • "type": "IPv4",
        • "address": "string"

        }

      ],
    • "status": "ACTIVE",
    • "generation": "G1B",
    • "parameters": [

      • {

        • "name": "LOWER_CASE_TABLE_NAMES",
        • "value": 0

        }

      ],
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z",
    • "started_at": "2019-08-24T14:15:22Z",
    • "finished_at": "2019-08-24T14:15:22Z",
    • "maintenance_scheduled_at": "2019-08-24T14:15:22Z"

    }

  ]

}

Backups List.

List all backups.

Authorizations:

bearerAuthOAuth2

path Parameters

instance_id required

string <uuid> (Instance Id) Example: f21999cb-302f-48f7-b584-6a84748e112c Value referring to instance Id.

query Parameters

_offset	integer >= 0 Default: 0 The number of items to skip before starting to collect the result set.
_limit	integer [ 1 .. 50 ] Default: 10 The maximum number of items per page.
type	string (Backup Type) Enum: "ON_DEMAND" "AUTOMATED" Value referring to backup type.
mode	string (Backup Mode) Enum: "FULL" "INCREMENTAL" Value referring to backup mode.
status	string (Backup Status) Enum: "PENDING" "CREATING" "CREATED" "ERROR" "DELETING" "DELETED" "ERROR_DELETING" Value referring to backup status.

Responses

https://api.magalu.cloud/br-ne-1/database/v1/instances/{instance_id}/backups

https://api.magalu.cloud/br-se1/database/v1/instances/{instance_id}/backups

Response samples

• 200
• 400
• 401
• 403
• 422
• 500

Content type

application/json

{

• "meta": {

  • "filters": [

    • {

      • "field": "string",
      • "value": "string"

      }

    ],
  • "page": {

    • "offset": 0,
    • "limit": 0,
    • "count": 0,
    • "total": 0,
    • "max_limit": 0

    }

  },
• "results": [

  • {

    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "instance_id": "06587974-2dbe-4e10-8bf9-38cce0f5a366",
    • "instance": {

      • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      • "name": "mydbinstance"

      },
    • "name": "string",
    • "location": "string",
    • "type": "ON_DEMAND",
    • "status": "PENDING",
    • "mode": "FULL",
    • "db_size": 0,
    • "size": 0,
    • "started_at": "2019-08-24T14:15:22Z",
    • "finished_at": "2019-08-24T14:15:22Z",
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z",
    • "engine_id": "b1d2d00a-6e57-4e4b-9c8e-447d4c2457d0"

    }

  ]

}

Backup Create.

Creates a new backup asynchronously.

Authorizations:

bearerAuthOAuth2

path Parameters

instance_id required

string <uuid> (Instance Id) Example: f21999cb-302f-48f7-b584-6a84748e112c Value referring to instance Id.

Request Body schema: application/json

required

mode required

string (Backup Mode Request) Value: "FULL" An enumeration.

Responses

https://api.magalu.cloud/br-ne-1/database/v1/instances/{instance_id}/backups

https://api.magalu.cloud/br-se1/database/v1/instances/{instance_id}/backups

Request samples

• Payload

Content type

application/json

{

• "mode": "FULL"

}

Response samples

• 202
• 400
• 401
• 403
• 404
• 422
• 500

Content type

application/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"

}

Backup Detail.

Get a backup detail.

Authorizations:

bearerAuthOAuth2

path Parameters

instance_id required	string <uuid> (Instance Id) Example: f21999cb-302f-48f7-b584-6a84748e112c Value referring to instance Id.
backup_id required	string <uuid> (Backup Id) Example: 1b65c0e4-94a1-4385-aedb-c1b34f6e8935 Value referring to backup Id.

Responses

https://api.magalu.cloud/br-ne-1/database/v1/instances/{instance_id}/backups/{backup_id}

https://api.magalu.cloud/br-se1/database/v1/instances/{instance_id}/backups/{backup_id}

Response samples

• 200
• 400
• 401
• 403
• 404
• 422
• 500

Content type

application/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "instance_id": "06587974-2dbe-4e10-8bf9-38cce0f5a366",
• "instance": {

  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "mydbinstance"

  },
• "name": "string",
• "location": "string",
• "type": "ON_DEMAND",
• "status": "PENDING",
• "mode": "FULL",
• "db_size": 0,
• "size": 0,
• "started_at": "2019-08-24T14:15:22Z",
• "finished_at": "2019-08-24T14:15:22Z",
• "created_at": "2019-08-24T14:15:22Z",
• "updated_at": "2019-08-24T14:15:22Z",
• "engine_id": "b1d2d00a-6e57-4e4b-9c8e-447d4c2457d0"

}

Delete Backup.

Deletes a database backup.

Authorizations:

bearerAuthOAuth2

path Parameters

instance_id required	string <uuid> (Instance Id) Example: f21999cb-302f-48f7-b584-6a84748e112c Value referring to instance Id.
backup_id required	string <uuid> (Backup Id) Example: 1b65c0e4-94a1-4385-aedb-c1b34f6e8935 Value referring to backup Id.

Responses

https://api.magalu.cloud/br-ne-1/database/v1/instances/{instance_id}/backups/{backup_id}

https://api.magalu.cloud/br-se1/database/v1/instances/{instance_id}/backups/{backup_id}

Response samples

• 202
• 400
• 401
• 403
• 404
• 422
• 500

Content type

application/json

null

Backup restore.

Restores a backup for an instance asynchronously.

Authorizations:

bearerAuthOAuth2

path Parameters

instance_id required

string <uuid> (Instance Id) Example: f21999cb-302f-48f7-b584-6a84748e112c Value referring to instance Id.

Request Body schema: application/json

required

backup_id required

string <uuid> (Backup Id)

Responses

https://api.magalu.cloud/br-ne-1/database/v1/instances/{instance_id}/restores

https://api.magalu.cloud/br-se1/database/v1/instances/{instance_id}/restores

Request samples

• Payload

Content type

application/json

{

• "backup_id": "dc6df094-e377-4015-b87b-a5d80b7a0935"

}

Response samples

• 202
• 400
• 401
• 403
• 404
• 422
• 500

Content type

application/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"

}

Snapshots List.

List all snapshots.

Authorizations:

bearerAuthOAuth2

path Parameters

instance_id required

string <uuid> (Instance Id) Example: f21999cb-302f-48f7-b584-6a84748e112c Value referring to instance Id.

query Parameters

_offset	integer >= 0 Default: 0 The number of items to skip before starting to collect the result set.
_limit	integer [ 1 .. 50 ] Default: 10 The maximum number of items per page.
type	string (Backup Type) Enum: "ON_DEMAND" "AUTOMATED" Value referring to snapshot type.
status	string (Snapshot Status) Enum: "PENDING" "CREATING" "AVAILABLE" "RESTORING" "ERROR" "DELETING" "DELETED" Value referring to snapshot status.

Responses

https://api.magalu.cloud/br-ne-1/database/v1/instances/{instance_id}/snapshots

https://api.magalu.cloud/br-se1/database/v1/instances/{instance_id}/snapshots

Response samples

• 200
• 400
• 401
• 403
• 422
• 500

Content type

application/json

{

• "meta": {

  • "filters": [

    • {

      • "field": "string",
      • "value": "string"

      }

    ],
  • "page": {

    • "offset": 0,
    • "limit": 0,
    • "count": 0,
    • "total": 0,
    • "max_limit": 0

    }

  },
• "results": [

  • {

    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "instance": {

      • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      • "name": "mydbinstance"

      },
    • "name": "string",
    • "description": "string",
    • "type": "ON_DEMAND",
    • "status": "PENDING",
    • "allocated_size": 0,
    • "created_at": "2019-08-24T14:15:22Z",
    • "started_at": "2019-08-24T14:15:22Z",
    • "finished_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z"

    }

  ]

}

Snapshot Create.

Creates a new snapshot asynchronously.

Authorizations:

bearerAuthOAuth2

path Parameters

instance_id required

string <uuid> (Instance Id) Example: f21999cb-302f-48f7-b584-6a84748e112c Value referring to instance Id.

Request Body schema: application/json

required

name required	string (Name) <= 100 characters Snapshot unique name.
description required	string (Description) <= 255 characters Snapshot description.

Responses

https://api.magalu.cloud/br-ne-1/database/v1/instances/{instance_id}/snapshots

https://api.magalu.cloud/br-se1/database/v1/instances/{instance_id}/snapshots

Request samples

• Payload

Content type

application/json

{

• "name": "mysnapshot",
• "description": "mydescription"

}

Response samples

• 202
• 400
• 401
• 403
• 404
• 422
• 500

Content type

application/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"

}

Snapshot Detail.

Get a snapshot detail.

Authorizations:

bearerAuthOAuth2

path Parameters

instance_id required	string <uuid> (Instance Id) Example: f21999cb-302f-48f7-b584-6a84748e112c Value referring to instance Id.
snapshot_id required	string <uuid> (Snapshot Id) Example: c1b34f6e-94a1-4385-aedb-1b65c0e48935 Value referring to snapshot Id.

Responses

https://api.magalu.cloud/br-ne-1/database/v1/instances/{instance_id}/snapshots/{snapshot_id}

https://api.magalu.cloud/br-se1/database/v1/instances/{instance_id}/snapshots/{snapshot_id}

Response samples

• 200
• 400
• 401
• 403
• 404
• 422
• 500

Content type

application/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "instance": {

  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "mydbinstance"

  },
• "name": "string",
• "description": "string",
• "type": "ON_DEMAND",
• "status": "PENDING",
• "allocated_size": 0,
• "created_at": "2019-08-24T14:15:22Z",
• "started_at": "2019-08-24T14:15:22Z",
• "finished_at": "2019-08-24T14:15:22Z",
• "updated_at": "2019-08-24T14:15:22Z"

}

Snapshot Update.

Updates a snapshot.

Authorizations:

bearerAuthOAuth2

path Parameters

instance_id required	string <uuid> (Instance Id) Example: f21999cb-302f-48f7-b584-6a84748e112c Value referring to instance Id.
snapshot_id required	string <uuid> (Snapshot Id) Example: c1b34f6e-94a1-4385-aedb-1b65c0e48935 Value referring to snapshot Id.

Request Body schema: application/json

required

name	string (Name) <= 100 characters Snapshot unique name.
description	string (Description) <= 255 characters Snapshot description.

Responses

https://api.magalu.cloud/br-ne-1/database/v1/instances/{instance_id}/snapshots/{snapshot_id}

https://api.magalu.cloud/br-se1/database/v1/instances/{instance_id}/snapshots/{snapshot_id}

Request samples

• Payload

Content type

application/json

{

• "name": "mysnapshotupdated",
• "description": "mydescriptionupdated"

}

Response samples

• 200
• 400
• 401
• 403
• 404
• 422
• 500

Content type

application/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "instance": {

  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "mydbinstance"

  },
• "name": "string",
• "description": "string",
• "type": "ON_DEMAND",
• "status": "PENDING",
• "allocated_size": 0,
• "created_at": "2019-08-24T14:15:22Z",
• "started_at": "2019-08-24T14:15:22Z",
• "finished_at": "2019-08-24T14:15:22Z",
• "updated_at": "2019-08-24T14:15:22Z"

}

Delete Snapshot.

Deletes a database snapshot.

Authorizations:

bearerAuthOAuth2

path Parameters

instance_id required	string <uuid> (Instance Id) Example: f21999cb-302f-48f7-b584-6a84748e112c Value referring to instance Id.
snapshot_id required	string <uuid> (Snapshot Id) Example: c1b34f6e-94a1-4385-aedb-1b65c0e48935 Value referring to snapshot Id.

Responses

https://api.magalu.cloud/br-ne-1/database/v1/instances/{instance_id}/snapshots/{snapshot_id}

https://api.magalu.cloud/br-se1/database/v1/instances/{instance_id}/snapshots/{snapshot_id}

Response samples

• 202
• 400
• 401
• 403
• 404
• 422
• 500

Content type

application/json

null

backups

Database backups management.

Backups List.

List all backups.

Authorizations:

bearerAuthOAuth2

query Parameters

_offset	integer >= 0 Default: 0 The number of items to skip before starting to collect the result set.
_limit	integer [ 1 .. 50 ] Default: 10 The maximum number of items per page.
type	string (Backup Type) Enum: "ON_DEMAND" "AUTOMATED" Value referring to backup type.
mode	string (Backup Mode) Enum: "FULL" "INCREMENTAL" Value referring to backup mode.
status	string (Backup Status) Enum: "PENDING" "CREATING" "CREATED" "ERROR" "DELETING" "DELETED" "ERROR_DELETING" Value referring to backup status.
instance_id	string <uuid> (Instance Id) Example: instance_id=f21999cb-302f-48f7-b584-6a84748e112c Value referring to instance Id.

Responses

https://api.magalu.cloud/br-ne-1/database/v1/backups

https://api.magalu.cloud/br-se1/database/v1/backups

Response samples

• 200
• 400
• 401
• 403
• 422
• 500

Content type

application/json

{

• "meta": {

  • "filters": [

    • {

      • "field": "string",
      • "value": "string"

      }

    ],
  • "page": {

    • "offset": 0,
    • "limit": 0,
    • "count": 0,
    • "total": 0,
    • "max_limit": 0

    }

  },
• "results": [

  • {

    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "instance_id": "06587974-2dbe-4e10-8bf9-38cce0f5a366",
    • "instance": {

      • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      • "name": "mydbinstance"

      },
    • "name": "string",
    • "location": "string",
    • "type": "ON_DEMAND",
    • "status": "PENDING",
    • "mode": "FULL",
    • "db_size": 0,
    • "size": 0,
    • "started_at": "2019-08-24T14:15:22Z",
    • "finished_at": "2019-08-24T14:15:22Z",
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z",
    • "engine_id": "b1d2d00a-6e57-4e4b-9c8e-447d4c2457d0"

    }

  ]

}

Backup Detail.

Get a backup detail.

Authorizations:

bearerAuthOAuth2

path Parameters

backup_id required

string <uuid> (Backup Id) Example: 1b65c0e4-94a1-4385-aedb-c1b34f6e8935 Value referring to backup Id.

Responses

https://api.magalu.cloud/br-ne-1/database/v1/backups/{backup_id}

https://api.magalu.cloud/br-se1/database/v1/backups/{backup_id}

Response samples

• 200
• 400
• 401
• 403
• 404
• 422
• 500

Content type

application/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "instance_id": "06587974-2dbe-4e10-8bf9-38cce0f5a366",
• "instance": {

  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "mydbinstance"

  },
• "name": "string",
• "location": "string",
• "type": "ON_DEMAND",
• "status": "PENDING",
• "mode": "FULL",
• "db_size": 0,
• "size": 0,
• "started_at": "2019-08-24T14:15:22Z",
• "finished_at": "2019-08-24T14:15:22Z",
• "created_at": "2019-08-24T14:15:22Z",
• "updated_at": "2019-08-24T14:15:22Z",
• "engine_id": "b1d2d00a-6e57-4e4b-9c8e-447d4c2457d0"

}

Delete Backup.

Deletes a database backup.

Authorizations:

bearerAuthOAuth2

path Parameters

backup_id required

string <uuid> (Backup Id) Example: 1b65c0e4-94a1-4385-aedb-c1b34f6e8935 Value referring to backup Id.

Responses

https://api.magalu.cloud/br-ne-1/database/v1/backups/{backup_id}

https://api.magalu.cloud/br-se1/database/v1/backups/{backup_id}

Response samples

• 202
• 400
• 401
• 403
• 404
• 422
• 500

Content type

application/json

null

replicas

Database replicas management.

Replicas List.

List all replicas for a given instance.

Authorizations:

bearerAuthOAuth2

query Parameters

source_id	string <uuid> (Source Id) Example: source_id=9959ee7a-0710-4faa-9f10-6845819e8ac0 Value referring to source Id.
_offset	integer >= 0 Default: 0 The number of items to skip before starting to collect the result set.
_limit	integer [ 1 .. 50 ] Default: 10 The maximum number of items per page.

Responses

https://api.magalu.cloud/br-ne-1/database/v1/replicas

https://api.magalu.cloud/br-se1/database/v1/replicas

Response samples

• 200
• 400
• 401
• 403
• 404
• 422
• 500

Content type

application/json

{

• "meta": {

  • "filters": [

    • {

      • "field": "string",
      • "value": "string"

      }

    ],
  • "page": {

    • "offset": 0,
    • "limit": 0,
    • "count": 0,
    • "total": 0,
    • "max_limit": 0

    }

  },
• "results": [

  • {

    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "source_id": "ae50a35c-df42-4eff-ba26-f8bc28d2af81",
    • "name": "string",
    • "engine_id": "b1d2d00a-6e57-4e4b-9c8e-447d4c2457d0",
    • "datastore_id": "1c9da258-8b16-420b-b1ca-dda81ec7ed87",
    • "instance_type_id": "b67afca2-5b6f-43dd-b5de-7627dae240c8",
    • "flavor_id": "fa3e89aa-6829-47f5-8bf4-76d57211a9f1",
    • "volume": {

      • "size": 30,
      • "type": "CLOUD_NVME"

      },
    • "addresses": [

      • {

        • "access": "PRIVATE",
        • "type": "IPv4",
        • "address": "string"

        }

      ],
    • "status": "ACTIVE",
    • "generation": "G1B",
    • "parameters": [

      • {

        • "name": "LOWER_CASE_TABLE_NAMES",
        • "value": 0

        }

      ],
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z",
    • "started_at": "2019-08-24T14:15:22Z",
    • "finished_at": "2019-08-24T14:15:22Z",
    • "maintenance_scheduled_at": "2019-08-24T14:15:22Z"

    }

  ]

}

Replica Create.

Creates a new replica for an instance asynchronously.

Authorizations:

bearerAuthOAuth2

Request Body schema: application/json

required

source_id required	string <uuid> (Source Id)
name required	string (Name) <= 255 characters
flavor_id	string <uuid> Deprecated Flavor Id (Deprecated). Deprecated: This property is being deprecated in favor of instance_type_id. Please update your requests to use instance_type_id for improved functionality and future compatibility.
instance_type_id	string <uuid> (Instance Type Id)

Responses

https://api.magalu.cloud/br-ne-1/database/v1/replicas

https://api.magalu.cloud/br-se1/database/v1/replicas

Request samples

• Payload

Content type

application/json

{

• "source_id": "ae50a35c-df42-4eff-ba26-f8bc28d2af81",
• "name": "string",
• "flavor_id": "fa3e89aa-6829-47f5-8bf4-76d57211a9f1",
• "instance_type_id": "b67afca2-5b6f-43dd-b5de-7627dae240c8"

}

Response samples

• 202
• 400
• 401
• 403
• 404
• 422
• 500

Content type

application/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"

}

Replica Detail.

Get an instance replica detail.

Authorizations:

bearerAuthOAuth2

path Parameters

replica_id required

string <uuid> (Replica Id) Example: 2218ad95-6ba2-4fef-8302-a31cb1062412 Value referring to replica Id.

Responses

https://api.magalu.cloud/br-ne-1/database/v1/replicas/{replica_id}

https://api.magalu.cloud/br-se1/database/v1/replicas/{replica_id}

Response samples

• 200
• 400
• 401
• 403
• 404
• 422
• 500

Content type

application/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "source_id": "ae50a35c-df42-4eff-ba26-f8bc28d2af81",
• "name": "string",
• "engine_id": "b1d2d00a-6e57-4e4b-9c8e-447d4c2457d0",
• "datastore_id": "1c9da258-8b16-420b-b1ca-dda81ec7ed87",
• "instance_type_id": "b67afca2-5b6f-43dd-b5de-7627dae240c8",
• "flavor_id": "fa3e89aa-6829-47f5-8bf4-76d57211a9f1",
• "volume": {

  • "size": 30,
  • "type": "CLOUD_NVME"

  },
• "addresses": [

  • {

    • "access": "PRIVATE",
    • "type": "IPv4",
    • "address": "string"

    }

  ],
• "status": "ACTIVE",
• "generation": "G1B",
• "parameters": [

  • {

    • "name": "LOWER_CASE_TABLE_NAMES",
    • "value": 0

    }

  ],
• "created_at": "2019-08-24T14:15:22Z",
• "updated_at": "2019-08-24T14:15:22Z",
• "started_at": "2019-08-24T14:15:22Z",
• "finished_at": "2019-08-24T14:15:22Z",
• "maintenance_scheduled_at": "2019-08-24T14:15:22Z"

}

Deletes a replica instance.

Deletes a replica instance.

Authorizations:

bearerAuthOAuth2

path Parameters

replica_id required

string <uuid> (Database Replica Id) Database Replica Unique Id

Responses

https://api.magalu.cloud/br-ne-1/database/v1/replicas/{replica_id}

https://api.magalu.cloud/br-se1/database/v1/replicas/{replica_id}

Response samples

• 400
• 401
• 403
• 404
• 422
• 500

Content type

application/json

{

• "slug": "bad_request",
• "message": "Bad request"

}

Replica Resize.

Resize an instance replica.

Authorizations:

bearerAuthOAuth2

path Parameters

replica_id required

string <uuid> (Replica Id) Example: 2218ad95-6ba2-4fef-8302-a31cb1062412 Value referring to replica Id.

Request Body schema: application/json

required

instance_type_id	string <uuid> (Instance Type Id)
flavor_id	string <uuid> (Flavor Id) Deprecated

Responses

https://api.magalu.cloud/br-ne-1/database/v1/replicas/{replica_id}/resize

https://api.magalu.cloud/br-se1/database/v1/replicas/{replica_id}/resize

Request samples

• Payload

Content type

application/json

{

• "instance_type_id": "b67afca2-5b6f-43dd-b5de-7627dae240c8",
• "flavor_id": "fa3e89aa-6829-47f5-8bf4-76d57211a9f1"

}

Response samples

• 200
• 400
• 401
• 403
• 404
• 422
• 500

Content type

application/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "source_id": "ae50a35c-df42-4eff-ba26-f8bc28d2af81",
• "name": "string",
• "engine_id": "b1d2d00a-6e57-4e4b-9c8e-447d4c2457d0",
• "datastore_id": "1c9da258-8b16-420b-b1ca-dda81ec7ed87",
• "instance_type_id": "b67afca2-5b6f-43dd-b5de-7627dae240c8",
• "flavor_id": "fa3e89aa-6829-47f5-8bf4-76d57211a9f1",
• "volume": {

  • "size": 30,
  • "type": "CLOUD_NVME"

  },
• "addresses": [

  • {

    • "access": "PRIVATE",
    • "type": "IPv4",
    • "address": "string"

    }

  ],
• "status": "ACTIVE",
• "generation": "G1B",
• "parameters": [

  • {

    • "name": "LOWER_CASE_TABLE_NAMES",
    • "value": 0

    }

  ],
• "created_at": "2019-08-24T14:15:22Z",
• "updated_at": "2019-08-24T14:15:22Z",
• "started_at": "2019-08-24T14:15:22Z",
• "finished_at": "2019-08-24T14:15:22Z",
• "maintenance_scheduled_at": "2019-08-24T14:15:22Z"

}

Replica Start.

Start an instance replica.

Authorizations:

bearerAuthOAuth2

path Parameters

replica_id required

string <uuid> (Replica Id) Example: 2218ad95-6ba2-4fef-8302-a31cb1062412 Value referring to replica Id.

Responses

https://api.magalu.cloud/br-ne-1/database/v1/replicas/{replica_id}/start

https://api.magalu.cloud/br-se1/database/v1/replicas/{replica_id}/start

Response samples

• 200
• 400
• 401
• 403
• 404
• 422
• 500

Content type

application/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "source_id": "ae50a35c-df42-4eff-ba26-f8bc28d2af81",
• "name": "string",
• "engine_id": "b1d2d00a-6e57-4e4b-9c8e-447d4c2457d0",
• "datastore_id": "1c9da258-8b16-420b-b1ca-dda81ec7ed87",
• "instance_type_id": "b67afca2-5b6f-43dd-b5de-7627dae240c8",
• "flavor_id": "fa3e89aa-6829-47f5-8bf4-76d57211a9f1",
• "volume": {

  • "size": 30,
  • "type": "CLOUD_NVME"

  },
• "addresses": [

  • {

    • "access": "PRIVATE",
    • "type": "IPv4",
    • "address": "string"

    }

  ],
• "status": "ACTIVE",
• "generation": "G1B",
• "parameters": [

  • {

    • "name": "LOWER_CASE_TABLE_NAMES",
    • "value": 0

    }

  ],
• "created_at": "2019-08-24T14:15:22Z",
• "updated_at": "2019-08-24T14:15:22Z",
• "started_at": "2019-08-24T14:15:22Z",
• "finished_at": "2019-08-24T14:15:22Z",
• "maintenance_scheduled_at": "2019-08-24T14:15:22Z"

}

Replica Stop.

Stop an instance replica.

Authorizations:

bearerAuthOAuth2

path Parameters

replica_id required

string <uuid> (Replica Id) Example: 2218ad95-6ba2-4fef-8302-a31cb1062412 Value referring to replica Id.

Responses

https://api.magalu.cloud/br-ne-1/database/v1/replicas/{replica_id}/stop

https://api.magalu.cloud/br-se1/database/v1/replicas/{replica_id}/stop

Response samples

• 200
• 400
• 401
• 403
• 404
• 422
• 500

Content type

application/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "source_id": "ae50a35c-df42-4eff-ba26-f8bc28d2af81",
• "name": "string",
• "engine_id": "b1d2d00a-6e57-4e4b-9c8e-447d4c2457d0",
• "datastore_id": "1c9da258-8b16-420b-b1ca-dda81ec7ed87",
• "instance_type_id": "b67afca2-5b6f-43dd-b5de-7627dae240c8",
• "flavor_id": "fa3e89aa-6829-47f5-8bf4-76d57211a9f1",
• "volume": {

  • "size": 30,
  • "type": "CLOUD_NVME"

  },
• "addresses": [

  • {

    • "access": "PRIVATE",
    • "type": "IPv4",
    • "address": "string"

    }

  ],
• "status": "ACTIVE",
• "generation": "G1B",
• "parameters": [

  • {

    • "name": "LOWER_CASE_TABLE_NAMES",
    • "value": 0

    }

  ],
• "created_at": "2019-08-24T14:15:22Z",
• "updated_at": "2019-08-24T14:15:22Z",
• "started_at": "2019-08-24T14:15:22Z",
• "finished_at": "2019-08-24T14:15:22Z",
• "maintenance_scheduled_at": "2019-08-24T14:15:22Z"

}

snapshots

Snapshots management.

Create a new instance from snapshot asynchronously.

Create a new instance from snapshot.

Authorizations:

bearerAuthOAuth2

path Parameters

snapshot_id required

string <uuid> (Snapshot Id) Example: c1b34f6e-94a1-4385-aedb-1b65c0e48935 Value referring to snapshot Id.

Request Body schema: application/json

required

name required	string (Name) <= 100 characters
instance_type_id required	string <uuid> (Instance Type Id)
	object (Instance Volume Request)
backup_retention_days	integer (Backup Retention Days) Default: 7 The number of days that a particular backup is kept until its deletion.
backup_start_at	string <time> (Backup Start At) Default: "04:00:00" Start time (UTC timezone) which is allowed to start the automated backup process.

Responses

https://api.magalu.cloud/br-ne-1/database/v1/snapshots/{snapshot_id}/restores

https://api.magalu.cloud/br-se1/database/v1/snapshots/{snapshot_id}/restores

Request samples

• Payload

Content type

application/json

{

• "name": "string",
• "instance_type_id": "b67afca2-5b6f-43dd-b5de-7627dae240c8",
• "volume": {

  • "size": 30,
  • "type": "CLOUD_NVME_15K"

  },
• "backup_retention_days": 7,
• "backup_start_at": "04:00:00"

}

Response samples

• 202
• 400
• 401
• 403
• 422
• 500

Content type

application/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"

}