Database

• engines
  • getList available engines.
  • getEngine detail.
  • getList available engine parameters.
• instance_types
  • getList available instance types.
  • getInstance Type detail.
• instances
  • headHeader information for listing all database 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.
• replicas
  • getReplicas List.
  • postReplica Create.
  • getReplica Detail.
  • delDeletes a replica instance.
  • postReplica Resize.
  • postReplica Start.
  • postReplica Stop.
• clusters
  • getList all database clusters.
  • headHeader information for listing all database clusters.
  • postCreates a new database high availability cluster.
  • delDeletes a database cluster.
  • getDatabase cluster details.
  • patchDatabase cluster update.
  • postResizes a cluster database.
  • postStarts a database cluster.
  • postStops a database cluster.
• snapshots
  • getSnapshots List.
  • postSnapshot Create.
  • getSnapshot Detail.
  • patchSnapshot Update.
  • delDelete Snapshot.
  • postCreate a new instance from snapshot asynchronously.
  • getSnapshots List.
  • postSnapshot Create.
  • getSnapshot Detail.
  • patchSnapshot Update.
  • delDelete Snapshot.
  • postCreate a new cluster from snapshot asynchronously.
• parameter-groups
  • getList all Parameter Groups
  • postCreates a new parameter group.
  • delDeletes a parameter group.
  • getParameter group details.
  • patchParameter group update.
  • getParameters list.
  • postCreate a parameter.
  • patchUpdate a parameter.
  • delParameters delete.

API docs by Redocly

DBaaS API Product (2.33.3)

DBaaS API Product.

engines

Engines available for database instances.

List available engines.

Returns a list of available engines.

Authorizations:

OAuth2

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" "PREVIEW" Value referring to engine status.

Responses

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

https://api.magalu.cloud/br-se1/database/v2/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",
    • "name": "mysql",
    • "version": "5.7",
    • "status": "ACTIVE"

    }

  ]

}

Engine detail.

Returns a engine detail.

Authorizations:

OAuth2

path Parameters

engine_id required

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

Responses

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

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

Response samples

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

Content type

application/json

{

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

}

List available engine parameters.

Returns a list of available engine parameters.

Authorizations:

OAuth2

path Parameters

engine_id required

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

query Parameters

_offset	integer >= 0 Default: 0 The number of items to skip before starting to collect the result set.
_limit	integer >= 1 The maximum number of items per page.
name	string (Name) Value referring to engine parameter name.
dynamic	boolean (Dynamic) Parameters that can be modified while the database is running. Changes to these parameters take effect immediately without requiring a service restart.
modifiable	boolean (Modifiable) Parameters that influence the machine creation process. These parameters are set during instance provisioning and become immutable after the machine is created.

Responses

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

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

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": [

  • {

    • "allowed_values": [

      • 0,
      • 1

      ],
    • "data_type": "integer",
    • "default_value": 0,
    • "description": "string",
    • "dynamic": false,
    • "engine_id": "b1d2d00a-6e57-4e4b-9c8e-447d4c2457d0",
    • "modifiable": false,
    • "name": "LOWER_CASE_TABLE_NAMES",
    • "parameter_name": "lower_case_table_names",
    • "ranged_value": false

    }

  ]

}

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:

OAuth2

query Parameters

_offset	integer >= 0 Default: 0 The number of items to skip before starting to collect the result set.
_limit	integer [ 1 .. 200 ] Default: 10 The maximum number of items per page.
status	string (Instance Type Status) Enum: "ACTIVE" "DEPRECATED" An enumeration.
compatible_product	string (Instance Type Compatible per product) Enum: "CLUSTER" "SINGLE_INSTANCE" "SINGLE_INSTANCE_REPLICA" Value referring to instance type compatible products.
engine_id	string <uuid> (Engine Id) Value referring to engine Id.

Responses

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

https://api.magalu.cloud/br-se1/database/v2/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",
    • "compatible_product": "CLUSTER",
    • "engine_id": "b1d2d00a-6e57-4e4b-9c8e-447d4c2457d0",
    • "status": "ACTIVE"

    }

  ]

}

Instance Type detail.

Returns an instance type detail.

Authorizations:

OAuth2

path Parameters

instance_type_id required

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

Responses

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

https://api.magalu.cloud/br-se1/database/v2/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",
• "compatible_product": "CLUSTER",
• "engine_id": "b1d2d00a-6e57-4e4b-9c8e-447d4c2457d0",
• "status": "ACTIVE"

}

instances

Database instances management.

Header information for listing all database instances.

Returns headers containing information for the list of database instances, with no response body.

Authorizations:

OAuth2

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_RESIZING" "ERROR_STARTING" "ERROR_STOPPING" "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.
parameter_group_id	string <uuid> (Parameter Group Id) Example: parameter_group_id=f21999cb-302f-48f7-b584-6a84748e112c Value referring to parameter group Id.
deletion_protected	boolean (Deletion Protected)

Responses

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

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

Response samples

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

Content type

application/json

null

List all database instances.

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

Authorizations:

OAuth2

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_RESIZING" "ERROR_STARTING" "ERROR_STOPPING" "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.
parameter_group_id	string <uuid> (Parameter Group Id) Example: parameter_group_id=f21999cb-302f-48f7-b584-6a84748e112c Value referring to parameter group Id.
deletion_protected	boolean (Deletion Protected)

Responses

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

https://api.magalu.cloud/br-se1/database/v2/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": "my-db-instance",
    • "engine_id": "b1d2d00a-6e57-4e4b-9c8e-447d4c2457d0",
    • "parameter_group_id": "60517f0f-1194-4a4f-8234-33197a1e7381",
    • "port_id": "2b97437e-648a-4484-9174-d069ca9706be",
    • "apply_parameters_pending": true,
    • "deletion_protected": true,
    • "instance_type_id": "b67afca2-5b6f-43dd-b5de-7627dae240c8",
    • "volume": {

      • "size": 30,
      • "type": "CLOUD_HDD",
      • "encrypted": true

      },
    • "addresses": [

      • {

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

        }

      ],
    • "status": "ACTIVE",
    • "availability_zone": "br-ne1-a",
    • "generation": "G10",
    • "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",
        • "parameter_group_id": "60517f0f-1194-4a4f-8234-33197a1e7381",
        • "instance_type_id": "b67afca2-5b6f-43dd-b5de-7627dae240c8",
        • "volume": {

          • "size": 30,
          • "type": "CLOUD_HDD"

          },
        • "addresses": [

          • {

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

            }

          ],
        • "status": "ACTIVE",
        • "availability_zone": "br-ne1-a",
        • "generation": "G10",
        • "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",
        • "port_id": "2b97437e-648a-4484-9174-d069ca9706be"

        }

      ]

    }

  ]

}

Creates a new database instance.

Creates a new database instance asynchronously for a tenant.

Authorizations:

OAuth2

Request Body schema: application/json

required

name required	string (Name) <= 100 characters
engine_id required	string <uuid> (Engine Id)
instance_type_id required	string <uuid> (Instance Type Id)
deletion_protected	boolean (Deletion Protected) Default: false
user required	string (User) <= 25 characters
password required	string (Password) <= 50 characters
security_groups	Array of strings <uuid> (Security Group IDs) unique [ items <uuid > ] Security Group IDs from the Network API to control the database access rules.
required	object (Instance Volume Request)
parameter_group_id	string <uuid> (Parameter group Id)
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.
availability_zone	string (Availability Zone) Enum: "br-se1-a" "br-se1-b" "br-se1-c" "br-ne1-a" "br-ne1-b"

Responses

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

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

Request samples

• Payload

Content type

application/json

{

• "name": "string",
• "engine_id": "b1d2d00a-6e57-4e4b-9c8e-447d4c2457d0",
• "instance_type_id": "b67afca2-5b6f-43dd-b5de-7627dae240c8",
• "deletion_protected": false,
• "user": "string",
• "password": "string",
• "security_groups": [

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

  ],
• "volume": {

  • "size": 30,
  • "type": "CLOUD_NVME15K"

  },
• "parameter_group_id": "60517f0f-1194-4a4f-8234-33197a1e7381",
• "backup_retention_days": 7,
• "backup_start_at": "04:00:00",
• "availability_zone": "br-ne1-a"

}

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:

OAuth2

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/v2/instances/{instance_id}

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

Response samples

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

Content type

application/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "name": "my-db-instance",
• "engine_id": "b1d2d00a-6e57-4e4b-9c8e-447d4c2457d0",
• "parameter_group_id": "60517f0f-1194-4a4f-8234-33197a1e7381",
• "port_id": "2b97437e-648a-4484-9174-d069ca9706be",
• "apply_parameters_pending": true,
• "deletion_protected": true,
• "instance_type_id": "b67afca2-5b6f-43dd-b5de-7627dae240c8",
• "volume": {

  • "size": 30,
  • "type": "CLOUD_HDD",
  • "encrypted": true

  },
• "addresses": [

  • {

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

    }

  ],
• "status": "ACTIVE",
• "availability_zone": "br-ne1-a",
• "generation": "G10",
• "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",
    • "parameter_group_id": "60517f0f-1194-4a4f-8234-33197a1e7381",
    • "instance_type_id": "b67afca2-5b6f-43dd-b5de-7627dae240c8",
    • "volume": {

      • "size": 30,
      • "type": "CLOUD_HDD"

      },
    • "addresses": [

      • {

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

        }

      ],
    • "status": "ACTIVE",
    • "availability_zone": "br-ne1-a",
    • "generation": "G10",
    • "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",
    • "port_id": "2b97437e-648a-4484-9174-d069ca9706be"

    }

  ]

}

Database instance update.

Updates a database instance.

Authorizations:

OAuth2

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_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.
parameter_group_id	string <uuid> (Parameter group Id)
deletion_protected	boolean (Deletion Protected)

Responses

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

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

Request samples

• Payload

Content type

application/json

{

• "backup_retention_days": 7,
• "backup_start_at": "04:00:00",
• "parameter_group_id": "44ae8773-a21e-4d5e-a38f-b677ccfeb7f8",
• "deletion_protected": true

}

Response samples

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

Content type

application/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "name": "my-db-instance",
• "engine_id": "b1d2d00a-6e57-4e4b-9c8e-447d4c2457d0",
• "parameter_group_id": "60517f0f-1194-4a4f-8234-33197a1e7381",
• "port_id": "2b97437e-648a-4484-9174-d069ca9706be",
• "apply_parameters_pending": true,
• "deletion_protected": true,
• "instance_type_id": "b67afca2-5b6f-43dd-b5de-7627dae240c8",
• "volume": {

  • "size": 30,
  • "type": "CLOUD_HDD",
  • "encrypted": true

  },
• "addresses": [

  • {

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

    }

  ],
• "status": "ACTIVE",
• "availability_zone": "br-ne1-a",
• "generation": "G10",
• "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",
    • "parameter_group_id": "60517f0f-1194-4a4f-8234-33197a1e7381",
    • "instance_type_id": "b67afca2-5b6f-43dd-b5de-7627dae240c8",
    • "volume": {

      • "size": 30,
      • "type": "CLOUD_HDD"

      },
    • "addresses": [

      • {

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

        }

      ],
    • "status": "ACTIVE",
    • "availability_zone": "br-ne1-a",
    • "generation": "G10",
    • "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",
    • "port_id": "2b97437e-648a-4484-9174-d069ca9706be"

    }

  ]

}

Deletes a database instance.

Deletes a database instance.

Authorizations:

OAuth2

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/v2/instances/{instance_id}

https://api.magalu.cloud/br-se1/database/v2/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:

OAuth2

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)
	object (Instance Volume Request)

Responses

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

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

Request samples

• Payload

Content type

application/json

{

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

  • "size": 30

  }

}

Response samples

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

Content type

application/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "name": "my-db-instance",
• "engine_id": "b1d2d00a-6e57-4e4b-9c8e-447d4c2457d0",
• "parameter_group_id": "60517f0f-1194-4a4f-8234-33197a1e7381",
• "port_id": "2b97437e-648a-4484-9174-d069ca9706be",
• "apply_parameters_pending": true,
• "deletion_protected": true,
• "instance_type_id": "b67afca2-5b6f-43dd-b5de-7627dae240c8",
• "volume": {

  • "size": 30,
  • "type": "CLOUD_HDD",
  • "encrypted": true

  },
• "addresses": [

  • {

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

    }

  ],
• "status": "ACTIVE",
• "availability_zone": "br-ne1-a",
• "generation": "G10",
• "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",
    • "parameter_group_id": "60517f0f-1194-4a4f-8234-33197a1e7381",
    • "instance_type_id": "b67afca2-5b6f-43dd-b5de-7627dae240c8",
    • "volume": {

      • "size": 30,
      • "type": "CLOUD_HDD"

      },
    • "addresses": [

      • {

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

        }

      ],
    • "status": "ACTIVE",
    • "availability_zone": "br-ne1-a",
    • "generation": "G10",
    • "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",
    • "port_id": "2b97437e-648a-4484-9174-d069ca9706be"

    }

  ]

}

Starts a database instance.

Starts a database instance.

Authorizations:

OAuth2

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/v2/instances/{instance_id}/start

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

Response samples

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

Content type

application/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "name": "my-db-instance",
• "engine_id": "b1d2d00a-6e57-4e4b-9c8e-447d4c2457d0",
• "parameter_group_id": "60517f0f-1194-4a4f-8234-33197a1e7381",
• "port_id": "2b97437e-648a-4484-9174-d069ca9706be",
• "apply_parameters_pending": true,
• "deletion_protected": true,
• "instance_type_id": "b67afca2-5b6f-43dd-b5de-7627dae240c8",
• "volume": {

  • "size": 30,
  • "type": "CLOUD_HDD",
  • "encrypted": true

  },
• "addresses": [

  • {

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

    }

  ],
• "status": "ACTIVE",
• "availability_zone": "br-ne1-a",
• "generation": "G10",
• "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",
    • "parameter_group_id": "60517f0f-1194-4a4f-8234-33197a1e7381",
    • "instance_type_id": "b67afca2-5b6f-43dd-b5de-7627dae240c8",
    • "volume": {

      • "size": 30,
      • "type": "CLOUD_HDD"

      },
    • "addresses": [

      • {

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

        }

      ],
    • "status": "ACTIVE",
    • "availability_zone": "br-ne1-a",
    • "generation": "G10",
    • "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",
    • "port_id": "2b97437e-648a-4484-9174-d069ca9706be"

    }

  ]

}

Stops a database instance.

Stops a database instance.

Authorizations:

OAuth2

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/v2/instances/{instance_id}/stop

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

Response samples

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

Content type

application/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "name": "my-db-instance",
• "engine_id": "b1d2d00a-6e57-4e4b-9c8e-447d4c2457d0",
• "parameter_group_id": "60517f0f-1194-4a4f-8234-33197a1e7381",
• "port_id": "2b97437e-648a-4484-9174-d069ca9706be",
• "apply_parameters_pending": true,
• "deletion_protected": true,
• "instance_type_id": "b67afca2-5b6f-43dd-b5de-7627dae240c8",
• "volume": {

  • "size": 30,
  • "type": "CLOUD_HDD",
  • "encrypted": true

  },
• "addresses": [

  • {

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

    }

  ],
• "status": "ACTIVE",
• "availability_zone": "br-ne1-a",
• "generation": "G10",
• "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",
    • "parameter_group_id": "60517f0f-1194-4a4f-8234-33197a1e7381",
    • "instance_type_id": "b67afca2-5b6f-43dd-b5de-7627dae240c8",
    • "volume": {

      • "size": 30,
      • "type": "CLOUD_HDD"

      },
    • "addresses": [

      • {

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

        }

      ],
    • "status": "ACTIVE",
    • "availability_zone": "br-ne1-a",
    • "generation": "G10",
    • "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",
    • "port_id": "2b97437e-648a-4484-9174-d069ca9706be"

    }

  ]

}

replicas

Database replicas management.

Replicas List.

List all replicas for a given instance.

Authorizations:

OAuth2

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/v2/replicas

https://api.magalu.cloud/br-se1/database/v2/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",
    • "parameter_group_id": "60517f0f-1194-4a4f-8234-33197a1e7381",
    • "instance_type_id": "b67afca2-5b6f-43dd-b5de-7627dae240c8",
    • "volume": {

      • "size": 30,
      • "type": "CLOUD_HDD"

      },
    • "addresses": [

      • {

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

        }

      ],
    • "status": "ACTIVE",
    • "availability_zone": "br-ne1-a",
    • "generation": "G10",
    • "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",
    • "port_id": "2b97437e-648a-4484-9174-d069ca9706be"

    }

  ]

}

Replica Create.

Creates a new replica for an instance asynchronously.

Authorizations:

OAuth2

Request Body schema: application/json

required

source_id required	string <uuid> (Source Id)
name required	string (Name) <= 255 characters
instance_type_id	string <uuid> (Instance Type Id)
security_groups	Array of strings <uuid> (Security Group IDs) unique [ items <uuid > ] Security Group IDs from the Network API to control the database access rules.

Responses

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

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

Request samples

• Payload

Content type

application/json

{

• "source_id": "ae50a35c-df42-4eff-ba26-f8bc28d2af81",
• "name": "string",
• "instance_type_id": "b67afca2-5b6f-43dd-b5de-7627dae240c8",
• "security_groups": [

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

  ]

}

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:

OAuth2

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/v2/replicas/{replica_id}

https://api.magalu.cloud/br-se1/database/v2/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",
• "parameter_group_id": "60517f0f-1194-4a4f-8234-33197a1e7381",
• "instance_type_id": "b67afca2-5b6f-43dd-b5de-7627dae240c8",
• "volume": {

  • "size": 30,
  • "type": "CLOUD_HDD"

  },
• "addresses": [

  • {

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

    }

  ],
• "status": "ACTIVE",
• "availability_zone": "br-ne1-a",
• "generation": "G10",
• "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",
• "port_id": "2b97437e-648a-4484-9174-d069ca9706be"

}

Deletes a replica instance.

Deletes a replica instance.

Authorizations:

OAuth2

path Parameters

replica_id required

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

Responses

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

https://api.magalu.cloud/br-se1/database/v2/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:

OAuth2

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)
	object (Replica Volume Request)

Responses

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

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

Request samples

• Payload

Content type

application/json

{

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

  • "size": 30

  }

}

Response samples

• 200
• 400
• 401
• 403
• 404
• 409
• 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",
• "parameter_group_id": "60517f0f-1194-4a4f-8234-33197a1e7381",
• "instance_type_id": "b67afca2-5b6f-43dd-b5de-7627dae240c8",
• "volume": {

  • "size": 30,
  • "type": "CLOUD_HDD"

  },
• "addresses": [

  • {

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

    }

  ],
• "status": "ACTIVE",
• "availability_zone": "br-ne1-a",
• "generation": "G10",
• "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",
• "port_id": "2b97437e-648a-4484-9174-d069ca9706be"

}

Replica Start.

Start an instance replica.

Authorizations:

OAuth2

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/v2/replicas/{replica_id}/start

https://api.magalu.cloud/br-se1/database/v2/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",
• "parameter_group_id": "60517f0f-1194-4a4f-8234-33197a1e7381",
• "instance_type_id": "b67afca2-5b6f-43dd-b5de-7627dae240c8",
• "volume": {

  • "size": 30,
  • "type": "CLOUD_HDD"

  },
• "addresses": [

  • {

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

    }

  ],
• "status": "ACTIVE",
• "availability_zone": "br-ne1-a",
• "generation": "G10",
• "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",
• "port_id": "2b97437e-648a-4484-9174-d069ca9706be"

}

Replica Stop.

Stop an instance replica.

Authorizations:

OAuth2

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/v2/replicas/{replica_id}/stop

https://api.magalu.cloud/br-se1/database/v2/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",
• "parameter_group_id": "60517f0f-1194-4a4f-8234-33197a1e7381",
• "instance_type_id": "b67afca2-5b6f-43dd-b5de-7627dae240c8",
• "volume": {

  • "size": 30,
  • "type": "CLOUD_HDD"

  },
• "addresses": [

  • {

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

    }

  ],
• "status": "ACTIVE",
• "availability_zone": "br-ne1-a",
• "generation": "G10",
• "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",
• "port_id": "2b97437e-648a-4484-9174-d069ca9706be"

}

clusters

Clusters management.

List all database clusters.

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

Authorizations:

OAuth2

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 (Cluster Status) Enum: "ACTIVE" "ERROR" "PENDING" "CREATING" "DELETING" "DELETED" "ERROR_DELETING" "STARTING" "STOPPING" "STOPPED" "BACKING_UP" "BALANCING" "RESIZING" "ERROR_RESIZING" "ERROR_STOPPING" "ERROR_STARTING" Example: status=ACTIVE Value referring to cluster status.
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.
parameter_group_id	string <uuid> (Parameter Group Id) Example: parameter_group_id=f21999cb-302f-48f7-b584-6a84748e112c Value referring to parameter group Id.
deletion_protected	boolean (Deletion Protected)

Responses

https://api.magalu.cloud/br-ne-1/database/v2/clusters

https://api.magalu.cloud/br-se1/database/v2/clusters

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": [

  • {

    • "backup_retention_days": 0,
    • "backup_start_at": "14:15:22Z",
    • "created_at": "2019-08-24T14:15:22Z",
    • "engine_id": "b1d2d00a-6e57-4e4b-9c8e-447d4c2457d0",
    • "finished_at": "2019-08-24T14:15:22Z",
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "instance_type_id": "b67afca2-5b6f-43dd-b5de-7627dae240c8",
    • "name": "string",
    • "parameter_group_id": "60517f0f-1194-4a4f-8234-33197a1e7381",
    • "started_at": "2019-08-24T14:15:22Z",
    • "status": "ACTIVE",
    • "generation": "G10",
    • "updated_at": "2019-08-24T14:15:22Z",
    • "volume": {

      • "size": 20,
      • "type": "CLOUD_HDD",
      • "encrypted": true

      },
    • "apply_parameters_pending": true,
    • "addresses": [

      • {

        • "access": "PRIVATE",
        • "type": "IPv4",
        • "address": "172.53.10.82",
        • "port": "3306",
        • "purpose": "READ_WRITE"

        }

      ],
    • "ip_address": "172.53.10.82",
    • "deletion_protected": true

    }

  ]

}

Header information for listing all database clusters.

Returns headers containing information for the list of database clusters, with no response body.

Authorizations:

OAuth2

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 (Cluster Status) Enum: "ACTIVE" "ERROR" "PENDING" "CREATING" "DELETING" "DELETED" "ERROR_DELETING" "STARTING" "STOPPING" "STOPPED" "BACKING_UP" "BALANCING" "RESIZING" "ERROR_RESIZING" "ERROR_STOPPING" "ERROR_STARTING" Example: status=ACTIVE Value referring to cluster status.
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.
parameter_group_id	string <uuid> (Parameter Group Id) Example: parameter_group_id=f21999cb-302f-48f7-b584-6a84748e112c Value referring to parameter group Id.
deletion_protected	boolean (Deletion Protected)

Responses

https://api.magalu.cloud/br-ne-1/database/v2/clusters

https://api.magalu.cloud/br-se1/database/v2/clusters

Response samples

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

Content type

application/json

null

Creates a new database high availability cluster.

Creates a new database high availability cluster asynchronously for a tenant.

Authorizations:

OAuth2

Request Body schema: application/json

required

backup_retention_days	integer (Backup Retention Days) Default: 7
backup_start_at	string <time> (Backup Start At) Default: "04:00:00"
engine_id required	string <uuid> (Engine Id)
instance_type_id required	string <uuid> (Machine Type Id)
name required	string (Name) <= 100 characters
password required	string (Password) <= 50 characters
user required	string (User) <= 25 characters
required	object (Cluster Volume Request)
parameter_group_id	string <uuid> (Parameter group Id)
deletion_protected	boolean (Deletion Protected) Default: false

Responses

https://api.magalu.cloud/br-ne-1/database/v2/clusters

https://api.magalu.cloud/br-se1/database/v2/clusters

Request samples

• Payload

Content type

application/json

{

• "backup_retention_days": 7,
• "backup_start_at": "04:00:00",
• "engine_id": "b1d2d00a-6e57-4e4b-9c8e-447d4c2457d0",
• "instance_type_id": "b67afca2-5b6f-43dd-b5de-7627dae240c8",
• "name": "string",
• "password": "string",
• "user": "string",
• "volume": {

  • "size": 30,
  • "type": "CLOUD_NVME15K"

  },
• "parameter_group_id": "60517f0f-1194-4a4f-8234-33197a1e7381",
• "deletion_protected": false

}

Response samples

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

Content type

application/json

{

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

}

Deletes a database cluster.

Removes a database cluster and it"s instances for a tenant.

Authorizations:

OAuth2

path Parameters

cluster_id required

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

Responses

https://api.magalu.cloud/br-ne-1/database/v2/clusters/{cluster_id}

https://api.magalu.cloud/br-se1/database/v2/clusters/{cluster_id}

Response samples

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

Content type

application/json

null

Database cluster details.

Returns a database cluster detail.

Authorizations:

OAuth2

path Parameters

cluster_id required

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

Responses

https://api.magalu.cloud/br-ne-1/database/v2/clusters/{cluster_id}

https://api.magalu.cloud/br-se1/database/v2/clusters/{cluster_id}

Response samples

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

Content type

application/json

{

• "backup_retention_days": 0,
• "backup_start_at": "14:15:22Z",
• "created_at": "2019-08-24T14:15:22Z",
• "engine_id": "b1d2d00a-6e57-4e4b-9c8e-447d4c2457d0",
• "finished_at": "2019-08-24T14:15:22Z",
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "instance_type_id": "b67afca2-5b6f-43dd-b5de-7627dae240c8",
• "name": "string",
• "parameter_group_id": "60517f0f-1194-4a4f-8234-33197a1e7381",
• "started_at": "2019-08-24T14:15:22Z",
• "status": "ACTIVE",
• "generation": "G10",
• "updated_at": "2019-08-24T14:15:22Z",
• "volume": {

  • "size": 20,
  • "type": "CLOUD_HDD",
  • "encrypted": true

  },
• "apply_parameters_pending": true,
• "addresses": [

  • {

    • "access": "PRIVATE",
    • "type": "IPv4",
    • "address": "172.53.10.82",
    • "port": "3306",
    • "purpose": "READ_WRITE"

    }

  ],
• "ip_address": "172.53.10.82",
• "deletion_protected": true

}

Database cluster update.

Updates a database cluster.

Authorizations:

OAuth2

path Parameters

cluster_id required

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

Request Body schema: application/json

required

parameter_group_id	string <uuid> (Parameter group Id)
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.
deletion_protected	boolean (Deletion Protected)

Responses

https://api.magalu.cloud/br-ne-1/database/v2/clusters/{cluster_id}

https://api.magalu.cloud/br-se1/database/v2/clusters/{cluster_id}

Request samples

• Payload

Content type

application/json

{

• "parameter_group_id": "60517f0f-1194-4a4f-8234-33197a1e7381",
• "backup_retention_days": 7,
• "backup_start_at": "04:00:00",
• "deletion_protected": true

}

Response samples

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

Content type

application/json

{

• "backup_retention_days": 0,
• "backup_start_at": "14:15:22Z",
• "created_at": "2019-08-24T14:15:22Z",
• "engine_id": "b1d2d00a-6e57-4e4b-9c8e-447d4c2457d0",
• "finished_at": "2019-08-24T14:15:22Z",
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "instance_type_id": "b67afca2-5b6f-43dd-b5de-7627dae240c8",
• "name": "string",
• "parameter_group_id": "60517f0f-1194-4a4f-8234-33197a1e7381",
• "started_at": "2019-08-24T14:15:22Z",
• "status": "ACTIVE",
• "generation": "G10",
• "updated_at": "2019-08-24T14:15:22Z",
• "volume": {

  • "size": 20,
  • "type": "CLOUD_HDD",
  • "encrypted": true

  },
• "apply_parameters_pending": true,
• "addresses": [

  • {

    • "access": "PRIVATE",
    • "type": "IPv4",
    • "address": "172.53.10.82",
    • "port": "3306",
    • "purpose": "READ_WRITE"

    }

  ],
• "ip_address": "172.53.10.82",
• "deletion_protected": true

}

Resizes a cluster database.

Resizes a cluster database.

Authorizations:

OAuth2

path Parameters

cluster_id required

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

Request Body schema: application/json

required

instance_type_id	string <uuid> (Cluster Type Id)
	object (Cluster Volume Request)

Responses

https://api.magalu.cloud/br-ne-1/database/v2/clusters/{cluster_id}/resize

https://api.magalu.cloud/br-se1/database/v2/clusters/{cluster_id}/resize

Request samples

• Payload

Content type

application/json

{

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

  • "size": 30

  }

}

Response samples

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

Content type

application/json

{

• "backup_retention_days": 0,
• "backup_start_at": "14:15:22Z",
• "created_at": "2019-08-24T14:15:22Z",
• "engine_id": "b1d2d00a-6e57-4e4b-9c8e-447d4c2457d0",
• "finished_at": "2019-08-24T14:15:22Z",
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "instance_type_id": "b67afca2-5b6f-43dd-b5de-7627dae240c8",
• "name": "string",
• "parameter_group_id": "60517f0f-1194-4a4f-8234-33197a1e7381",
• "started_at": "2019-08-24T14:15:22Z",
• "status": "ACTIVE",
• "generation": "G10",
• "updated_at": "2019-08-24T14:15:22Z",
• "volume": {

  • "size": 20,
  • "type": "CLOUD_HDD",
  • "encrypted": true

  },
• "apply_parameters_pending": true,
• "addresses": [

  • {

    • "access": "PRIVATE",
    • "type": "IPv4",
    • "address": "172.53.10.82",
    • "port": "3306",
    • "purpose": "READ_WRITE"

    }

  ],
• "ip_address": "172.53.10.82",
• "deletion_protected": true

}

Starts a database cluster.

Starts a database cluster.

Authorizations:

OAuth2

path Parameters

cluster_id required

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

Responses

https://api.magalu.cloud/br-ne-1/database/v2/clusters/{cluster_id}/start

https://api.magalu.cloud/br-se1/database/v2/clusters/{cluster_id}/start

Response samples

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

Content type

application/json

{

• "backup_retention_days": 0,
• "backup_start_at": "14:15:22Z",
• "created_at": "2019-08-24T14:15:22Z",
• "engine_id": "b1d2d00a-6e57-4e4b-9c8e-447d4c2457d0",
• "finished_at": "2019-08-24T14:15:22Z",
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "instance_type_id": "b67afca2-5b6f-43dd-b5de-7627dae240c8",
• "name": "string",
• "parameter_group_id": "60517f0f-1194-4a4f-8234-33197a1e7381",
• "started_at": "2019-08-24T14:15:22Z",
• "status": "ACTIVE",
• "generation": "G10",
• "updated_at": "2019-08-24T14:15:22Z",
• "volume": {

  • "size": 20,
  • "type": "CLOUD_HDD",
  • "encrypted": true

  },
• "apply_parameters_pending": true,
• "addresses": [

  • {

    • "access": "PRIVATE",
    • "type": "IPv4",
    • "address": "172.53.10.82",
    • "port": "3306",
    • "purpose": "READ_WRITE"

    }

  ],
• "ip_address": "172.53.10.82",
• "deletion_protected": true

}

Stops a database cluster.

Stops a database cluster.

Authorizations:

OAuth2

path Parameters

cluster_id required

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

Responses

https://api.magalu.cloud/br-ne-1/database/v2/clusters/{cluster_id}/stop

https://api.magalu.cloud/br-se1/database/v2/clusters/{cluster_id}/stop

Response samples

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

Content type

application/json

{

• "backup_retention_days": 0,
• "backup_start_at": "14:15:22Z",
• "created_at": "2019-08-24T14:15:22Z",
• "engine_id": "b1d2d00a-6e57-4e4b-9c8e-447d4c2457d0",
• "finished_at": "2019-08-24T14:15:22Z",
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "instance_type_id": "b67afca2-5b6f-43dd-b5de-7627dae240c8",
• "name": "string",
• "parameter_group_id": "60517f0f-1194-4a4f-8234-33197a1e7381",
• "started_at": "2019-08-24T14:15:22Z",
• "status": "ACTIVE",
• "generation": "G10",
• "updated_at": "2019-08-24T14:15:22Z",
• "volume": {

  • "size": 20,
  • "type": "CLOUD_HDD",
  • "encrypted": true

  },
• "apply_parameters_pending": true,
• "addresses": [

  • {

    • "access": "PRIVATE",
    • "type": "IPv4",
    • "address": "172.53.10.82",
    • "port": "3306",
    • "purpose": "READ_WRITE"

    }

  ],
• "ip_address": "172.53.10.82",
• "deletion_protected": true

}

snapshots

Snapshots management.

Snapshots List.

List all snapshots.

Authorizations:

OAuth2

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 (Snapshot Type Filter) 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/v2/instances/{instance_id}/snapshots

https://api.magalu.cloud/br-se1/database/v2/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": "my-db-instance"

      },
    • "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",
    • "availability_zone": "br-ne1-a"

    }

  ]

}

Snapshot Create.

Creates a new snapshot asynchronously.

Authorizations:

OAuth2

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	string (Description) <= 255 characters Snapshot description.

Responses

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

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

Request samples

• Payload

Content type

application/json

{

• "name": "my-snapshot",
• "description": "my-description"

}

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:

OAuth2

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/v2/instances/{instance_id}/snapshots/{snapshot_id}

https://api.magalu.cloud/br-se1/database/v2/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": "my-db-instance"

  },
• "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",
• "availability_zone": "br-ne1-a"

}

Snapshot Update.

Updates a snapshot.

Authorizations:

OAuth2

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/v2/instances/{instance_id}/snapshots/{snapshot_id}

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

Request samples

• Payload

Content type

application/json

{

• "name": "my-snapshot-updated",
• "description": "my-description-updated"

}

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": "my-db-instance"

  },
• "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",
• "availability_zone": "br-ne1-a"

}

Delete Snapshot.

Deletes a database snapshot.

Authorizations:

OAuth2

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/v2/instances/{instance_id}/snapshots/{snapshot_id}

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

Response samples

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

Content type

application/json

null

Create a new instance from snapshot asynchronously.

Create a new instance from snapshot.

Authorizations:

OAuth2

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 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/v2/instances/{instance_id}/snapshots/{snapshot_id}/restore

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

Request samples

• Payload

Content type

application/json

{

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

  • "size": 30,
  • "type": "CLOUD_NVME15K"

  },
• "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",
• "name": "my-db-instance",
• "engine_id": "b1d2d00a-6e57-4e4b-9c8e-447d4c2457d0",
• "parameter_group_id": "60517f0f-1194-4a4f-8234-33197a1e7381",
• "port_id": "2b97437e-648a-4484-9174-d069ca9706be",
• "apply_parameters_pending": true,
• "deletion_protected": true,
• "instance_type_id": "b67afca2-5b6f-43dd-b5de-7627dae240c8",
• "volume": {

  • "size": 30,
  • "type": "CLOUD_HDD",
  • "encrypted": true

  },
• "addresses": [

  • {

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

    }

  ],
• "status": "ACTIVE",
• "availability_zone": "br-ne1-a",
• "generation": "G10",
• "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",
    • "parameter_group_id": "60517f0f-1194-4a4f-8234-33197a1e7381",
    • "instance_type_id": "b67afca2-5b6f-43dd-b5de-7627dae240c8",
    • "volume": {

      • "size": 30,
      • "type": "CLOUD_HDD"

      },
    • "addresses": [

      • {

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

        }

      ],
    • "status": "ACTIVE",
    • "availability_zone": "br-ne1-a",
    • "generation": "G10",
    • "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",
    • "port_id": "2b97437e-648a-4484-9174-d069ca9706be"

    }

  ]

}

Snapshots List.

List all snapshots.

Authorizations:

OAuth2

path Parameters

cluster_id required

string <uuid> (Cluster Id) Example: f21999cb-302f-48f7-b584-6a84748e112c Value referring to cluster 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 (Snapshot Type Filter) 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/v2/clusters/{cluster_id}/snapshots

https://api.magalu.cloud/br-se1/database/v2/clusters/{cluster_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",
    • "cluster": {

      • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      • "name": "my-db-cluster"

      },
    • "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:

OAuth2

path Parameters

cluster_id required

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

Request Body schema: application/json

required

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

Responses

https://api.magalu.cloud/br-ne-1/database/v2/clusters/{cluster_id}/snapshots

https://api.magalu.cloud/br-se1/database/v2/clusters/{cluster_id}/snapshots

Request samples

• Payload

Content type

application/json

{

• "description": "string",
• "name": "string"

}

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:

OAuth2

path Parameters

cluster_id required	string <uuid> (Cluster Id) Example: f21999cb-302f-48f7-b584-6a84748e112c Value referring to cluster 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/v2/clusters/{cluster_id}/snapshots/{snapshot_id}

https://api.magalu.cloud/br-se1/database/v2/clusters/{cluster_id}/snapshots/{snapshot_id}

Response samples

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

Content type

application/json

{

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

  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "my-db-cluster"

  },
• "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:

OAuth2

path Parameters

cluster_id required	string <uuid> (Cluster Id) Example: f21999cb-302f-48f7-b584-6a84748e112c Value referring to cluster 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/v2/clusters/{cluster_id}/snapshots/{snapshot_id}

https://api.magalu.cloud/br-se1/database/v2/clusters/{cluster_id}/snapshots/{snapshot_id}

Request samples

• Payload

Content type

application/json

{

• "name": "my-snapshot-updated",
• "description": "my-description-updated"

}

Response samples

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

Content type

application/json

{

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

  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "my-db-cluster"

  },
• "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:

OAuth2

path Parameters

cluster_id required	string <uuid> (Cluster Id) Example: f21999cb-302f-48f7-b584-6a84748e112c Value referring to cluster 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/v2/clusters/{cluster_id}/snapshots/{snapshot_id}

https://api.magalu.cloud/br-se1/database/v2/clusters/{cluster_id}/snapshots/{snapshot_id}

Response samples

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

Content type

application/json

null

Create a new cluster from snapshot asynchronously.

Create a new cluster from snapshot.

Authorizations:

OAuth2

path Parameters

cluster_id required	string <uuid> (Cluster Id) Example: f21999cb-302f-48f7-b584-6a84748e112c Value referring to cluster 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 required	string (Name) <= 100 characters
instance_type_id required	string <uuid> (Instance Type Id)
	object (Cluster 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/v2/clusters/{cluster_id}/snapshots/{snapshot_id}/restore

https://api.magalu.cloud/br-se1/database/v2/clusters/{cluster_id}/snapshots/{snapshot_id}/restore

Request samples

• Payload

Content type

application/json

{

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

  • "size": 30,
  • "type": "CLOUD_NVME15K"

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

}

Response samples

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

Content type

application/json

{

• "backup_retention_days": 0,
• "backup_start_at": "14:15:22Z",
• "created_at": "2019-08-24T14:15:22Z",
• "engine_id": "b1d2d00a-6e57-4e4b-9c8e-447d4c2457d0",
• "finished_at": "2019-08-24T14:15:22Z",
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "instance_type_id": "b67afca2-5b6f-43dd-b5de-7627dae240c8",
• "name": "string",
• "parameter_group_id": "60517f0f-1194-4a4f-8234-33197a1e7381",
• "started_at": "2019-08-24T14:15:22Z",
• "status": "ACTIVE",
• "generation": "G10",
• "updated_at": "2019-08-24T14:15:22Z",
• "volume": {

  • "size": 20,
  • "type": "CLOUD_HDD",
  • "encrypted": true

  },
• "apply_parameters_pending": true,
• "addresses": [

  • {

    • "access": "PRIVATE",
    • "type": "IPv4",
    • "address": "172.53.10.82",
    • "port": "3306",
    • "purpose": "READ_WRITE"

    }

  ],
• "ip_address": "172.53.10.82",
• "deletion_protected": true

}

parameter-groups

Parameter groups management.

List all Parameter Groups

List all Parameter Groups for a x-tenant-id

Authorizations:

OAuth2

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.
type	string (Type) Enum: "SYSTEM" "USER" Example: type=USER
engine_id	string <uuid> (Engine Id) Value referring to engine Id.

Responses

https://api.magalu.cloud/br-ne-1/database/v2/parameter-groups

https://api.magalu.cloud/br-se1/database/v2/parameter-groups

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",
    • "name": "my_parameter_group",
    • "description": "Parameter Group for MySQL 8 engine",
    • "type": "USER",
    • "engine_id": "b1d2d00a-6e57-4e4b-9c8e-447d4c2457d0"

    }

  ]

}

Creates a new parameter group.

Creates a new parameter group for a tenant.

Authorizations:

OAuth2

Request Body schema: application/json

required

description	string (Description) <= 255 characters
engine_id required	string <uuid> (Engine Id)
name required	string (Name) <= 100 characters

Responses

https://api.magalu.cloud/br-ne-1/database/v2/parameter-groups

https://api.magalu.cloud/br-se1/database/v2/parameter-groups

Request samples

• Payload

Content type

application/json

{

• "description": "Parameter Group for MySQL 8 engine",
• "engine_id": "b1d2d00a-6e57-4e4b-9c8e-447d4c2457d0",
• "name": "my_parameter_group"

}

Response samples

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

Content type

application/json

{

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

}

Deletes a parameter group.

Deletes a parameter group.

Authorizations:

OAuth2

path Parameters

parameter_group_id required

string <uuid> (Parameter Group Id) Example: f21999cb-302f-48f7-b584-6a84748e112c Value referring to parameter group Id.

Responses

https://api.magalu.cloud/br-ne-1/database/v2/parameter-groups/{parameter_group_id}

https://api.magalu.cloud/br-se1/database/v2/parameter-groups/{parameter_group_id}

Response samples

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

Content type

application/json

{

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

}

Parameter group details.

Returns a parameter group detail.

Authorizations:

OAuth2

path Parameters

parameter_group_id required

string <uuid> (Parameter Group Id) Example: f21999cb-302f-48f7-b584-6a84748e112c Value referring to parameter group Id.

Responses

https://api.magalu.cloud/br-ne-1/database/v2/parameter-groups/{parameter_group_id}

https://api.magalu.cloud/br-se1/database/v2/parameter-groups/{parameter_group_id}

Response samples

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

Content type

application/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "name": "my_parameter_group",
• "description": "Parameter Group for MySQL 8 engine",
• "type": "USER",
• "engine_id": "b1d2d00a-6e57-4e4b-9c8e-447d4c2457d0"

}

Parameter group update.

Updates a parameter group.

Authorizations:

OAuth2

path Parameters

parameter_group_id required

string <uuid> (Parameter Group Id) Example: f21999cb-302f-48f7-b584-6a84748e112c Value referring to parameter group Id.

Request Body schema: application/json

required

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

Responses

https://api.magalu.cloud/br-ne-1/database/v2/parameter-groups/{parameter_group_id}

https://api.magalu.cloud/br-se1/database/v2/parameter-groups/{parameter_group_id}

Request samples

• Payload

Content type

application/json

{

• "name": "production_parameter_group",
• "description": "Production parameter group for MySQL 8 engine"

}

Response samples

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

Content type

application/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "name": "my_parameter_group",
• "description": "Parameter Group for MySQL 8 engine",
• "type": "USER",
• "engine_id": "b1d2d00a-6e57-4e4b-9c8e-447d4c2457d0"

}

Parameters list.

Return details of a group's parameters.

Authorizations:

OAuth2

path Parameters

parameter_group_id required

string <uuid> (Parameter Group Id) Example: f21999cb-302f-48f7-b584-6a84748e112c Value referring to parameter group Id.

query Parameters

_offset	integer >= 0 Default: 0 The number of items to skip before starting to collect the result set.
_limit	integer >= 1 The maximum number of items per page.

Responses

https://api.magalu.cloud/br-ne-1/database/v2/parameter-groups/{parameter_group_id}/parameters

https://api.magalu.cloud/br-se1/database/v2/parameter-groups/{parameter_group_id}/parameters

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": "44ae8773-a21e-4d5e-a38f-b677ccfeb7f8",
    • "name": "LOWER_CASE_TABLE_NAMES",
    • "value": 1

    }

  ]

}

Create a parameter.

Create a parameter for a group.

Authorizations:

OAuth2

path Parameters

parameter_group_id required

string <uuid> (Parameter Group Id) Example: f21999cb-302f-48f7-b584-6a84748e112c Value referring to parameter group Id.

Request Body schema: application/json

required

required	EngineParametersMysql8 (string) or EngineParametersMysql84 (string) (Name)
required	Value (number) or Value (integer) or Value (boolean) or Value (string) (Value)

Responses

https://api.magalu.cloud/br-ne-1/database/v2/parameter-groups/{parameter_group_id}/parameters

https://api.magalu.cloud/br-se1/database/v2/parameter-groups/{parameter_group_id}/parameters

Request samples

• Payload

Content type

application/json

{

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

}

Response samples

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

Content type

application/json

{

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

}

Update a parameter.

Updates a parameter for a group.

Authorizations:

OAuth2

path Parameters

parameter_group_id required	string <uuid> (Parameter Group Id) Example: f21999cb-302f-48f7-b584-6a84748e112c Value referring to parameter group Id.
parameter_id required	string <uuid> (Parameter Id) Example: f21999cb-302f-48f7-b584-6a84748e112c Parameter Id.

Request Body schema: application/json

required

required	Value (number) or Value (integer) or Value (boolean) or Value (string) (Value)
Any of number (Value)

Responses

https://api.magalu.cloud/br-ne-1/database/v2/parameter-groups/{parameter_group_id}/parameters/{parameter_id}

https://api.magalu.cloud/br-se1/database/v2/parameter-groups/{parameter_group_id}/parameters/{parameter_id}

Request samples

• Payload

Content type

application/json

{

• "value": 0

}

Response samples

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

Content type

application/json

{

• "id": "44ae8773-a21e-4d5e-a38f-b677ccfeb7f8",
• "name": "LOWER_CASE_TABLE_NAMES",
• "value": 1

}

Parameters delete.

Deletes a parameter for a group.

Authorizations:

OAuth2

path Parameters

parameter_group_id required	string <uuid> (Parameter Group Id) Example: f21999cb-302f-48f7-b584-6a84748e112c Value referring to parameter group Id.
parameter_id required	string <uuid> (Parameter Id) Example: f21999cb-302f-48f7-b584-6a84748e112c Parameter Id.

Responses

https://api.magalu.cloud/br-ne-1/database/v2/parameter-groups/{parameter_group_id}/parameters/{parameter_id}

https://api.magalu.cloud/br-se1/database/v2/parameter-groups/{parameter_group_id}/parameters/{parameter_id}

Response samples

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

Content type

application/json

{

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

}