Create DatabaseBackup

POST 
/projects/:projectId/providers/Aruba.Database/backups

Create DatabaseBackup

Request

Path Parameters

projectId stringrequired

Unique identifier of the project CMP.

Query Parameters

api-version string
The requested API version
Default value: 1

application/json

Body

The dbaasBackup request to validate.

metadata

object

Metadata of the resource

namestring

Name of the resource

location

object

Contains information about the Region of a resource

valuestring

Value of the region in which the resource will be located. Available regions at present:

• ITBG-Bergamo

For more information, check the documentation.

tagsstring[]nullable

List of tags for the resource

properties

object

Dto properties request Database Backup.

dataCenterstringnullable

Data center.

For more information, check the documentation.

dbaas

object

uristringnullable

database

object

namestringnullable

billingPlan

object

Dto Billing Plan.

billingPeriodstringnullable

Type of billing period to use.

text/json

Body

The dbaasBackup request to validate.

metadata

object

Metadata of the resource

namestring

Name of the resource

location

object

Contains information about the Region of a resource

valuestring

Value of the region in which the resource will be located. Available regions at present:

• ITBG-Bergamo

For more information, check the documentation.

tagsstring[]nullable

List of tags for the resource

properties

object

Dto properties request Database Backup.

dataCenterstringnullable

Data center.

For more information, check the documentation.

dbaas

object

uristringnullable

database

object

namestringnullable

billingPlan

object

Dto Billing Plan.

billingPeriodstringnullable

Type of billing period to use.

application/*+json

Body

The dbaasBackup request to validate.

metadata

object

Metadata of the resource

namestring

Name of the resource

location

object

Contains information about the Region of a resource

valuestring

Value of the region in which the resource will be located. Available regions at present:

• ITBG-Bergamo

For more information, check the documentation.

tagsstring[]nullable

List of tags for the resource

properties

object

Dto properties request Database Backup.

dataCenterstringnullable

Data center.

For more information, check the documentation.

dbaas

object

uristringnullable

database

object

namestringnullable

billingPlan

object

Dto Billing Plan.

billingPeriodstringnullable

Type of billing period to use.

Responses

201

Created

text/plain

Schema

Schema

metadata

object

idstringnullable

uristringnullable

namestringnullable

location

object

codestringnullable

countrystringnullable

citystringnullable

namestringnullable

valuestringnullable

project

object

idstringnullable

tagsstring[]nullable

category

object

namestringnullable

providerstringnullable

typology

object

idstringnullable

namestringnullable

creationDatedate-timenullable

createdBystringnullable

updateDatedate-timenullable

updatedBystringnullable

versionstringnullable

createdUserstringnullable

updatedUserstringnullable

status

object

statestringnullable

creationDatedate-timenullable

disableStatusInfo

object

isDisabledboolean

reasonsstring[]

previousStatus

object

statestringnullable

creationDatedate-timenullable

failureReasonstringnullable

properties

object

linkedResources

object[]

Array [

uristringnullable

strictCorrelationboolean

]

dataCenterstringnullable

For more information, check the documentation.

dbaas

object

DbaasReference response class.

uristringnullable

namestringnullable

database

object

DbaasReference response class.

namestringnullable

billingPlan

object

BillingPlan response class.

billingPeriodstringnullable

storage

object

sizeint64nullable

Size is in bytes

Example (from schema)

{
  "metadata": {
    "id": "string",
    "uri": "string",
    "name": "string",
    "location": {
      "code": "string",
      "country": "string",
      "city": "string",
      "name": "string",
      "value": "string"
    },
    "project": {
      "id": "string"
    },
    "tags": [
      "string"
    ],
    "category": {
      "name": "string",
      "provider": "string",
      "typology": {
        "id": "string",
        "name": "string"
      }
    },
    "creationDate": "2024-07-29T15:51:28.071Z",
    "createdBy": "string",
    "updateDate": "2024-07-29T15:51:28.071Z",
    "updatedBy": "string",
    "version": "string",
    "createdUser": "string",
    "updatedUser": "string"
  },
  "status": {
    "state": "string",
    "creationDate": "2024-07-29T15:51:28.071Z",
    "disableStatusInfo": {
      "isDisabled": true,
      "reasons": [
        "string"
      ],
      "previousStatus": {
        "state": "string",
        "creationDate": "2024-07-29T15:51:28.071Z"
      }
    },
    "failureReason": "string"
  },
  "properties": {
    "linkedResources": [
      {
        "uri": "string",
        "strictCorrelation": true
      }
    ],
    "dataCenter": "string",
    "dbaas": {
      "uri": "string",
      "name": "string"
    },
    "database": {
      "name": "string"
    },
    "billingPlan": {
      "billingPeriod": "string"
    },
    "storage": {
      "size": 0
    }
  }
}

application/json

Schema

Schema

metadata

object

idstringnullable

uristringnullable

namestringnullable

location

object

codestringnullable

countrystringnullable

citystringnullable

namestringnullable

valuestringnullable

project

object

idstringnullable

tagsstring[]nullable

category

object

namestringnullable

providerstringnullable

typology

object

idstringnullable

namestringnullable

creationDatedate-timenullable

createdBystringnullable

updateDatedate-timenullable

updatedBystringnullable

versionstringnullable

createdUserstringnullable

updatedUserstringnullable

status

object

statestringnullable

creationDatedate-timenullable

disableStatusInfo

object

isDisabledboolean

reasonsstring[]

previousStatus

object

statestringnullable

creationDatedate-timenullable

failureReasonstringnullable

properties

object

linkedResources

object[]

Array [

uristringnullable

strictCorrelationboolean

]

dataCenterstringnullable

For more information, check the documentation.

dbaas

object

DbaasReference response class.

uristringnullable

namestringnullable

database

object

DbaasReference response class.

namestringnullable

billingPlan

object

BillingPlan response class.

billingPeriodstringnullable

storage

object

sizeint64nullable

Size is in bytes

Example (from schema)

{
  "metadata": {
    "id": "string",
    "uri": "string",
    "name": "string",
    "location": {
      "code": "string",
      "country": "string",
      "city": "string",
      "name": "string",
      "value": "string"
    },
    "project": {
      "id": "string"
    },
    "tags": [
      "string"
    ],
    "category": {
      "name": "string",
      "provider": "string",
      "typology": {
        "id": "string",
        "name": "string"
      }
    },
    "creationDate": "2024-07-29T15:51:28.071Z",
    "createdBy": "string",
    "updateDate": "2024-07-29T15:51:28.071Z",
    "updatedBy": "string",
    "version": "string",
    "createdUser": "string",
    "updatedUser": "string"
  },
  "status": {
    "state": "string",
    "creationDate": "2024-07-29T15:51:28.071Z",
    "disableStatusInfo": {
      "isDisabled": true,
      "reasons": [
        "string"
      ],
      "previousStatus": {
        "state": "string",
        "creationDate": "2024-07-29T15:51:28.071Z"
      }
    },
    "failureReason": "string"
  },
  "properties": {
    "linkedResources": [
      {
        "uri": "string",
        "strictCorrelation": true
      }
    ],
    "dataCenter": "string",
    "dbaas": {
      "uri": "string",
      "name": "string"
    },
    "database": {
      "name": "string"
    },
    "billingPlan": {
      "billingPeriod": "string"
    },
    "storage": {
      "size": 0
    }
  }
}

text/json

Schema

Schema

metadata

object

idstringnullable

uristringnullable

namestringnullable

location

object

codestringnullable

countrystringnullable

citystringnullable

namestringnullable

valuestringnullable

project

object

idstringnullable

tagsstring[]nullable

category

object

namestringnullable

providerstringnullable

typology

object

idstringnullable

namestringnullable

creationDatedate-timenullable

createdBystringnullable

updateDatedate-timenullable

updatedBystringnullable

versionstringnullable

createdUserstringnullable

updatedUserstringnullable

status

object

statestringnullable

creationDatedate-timenullable

disableStatusInfo

object

isDisabledboolean

reasonsstring[]

previousStatus

object

statestringnullable

creationDatedate-timenullable

failureReasonstringnullable

properties

object

linkedResources

object[]

Array [

uristringnullable

strictCorrelationboolean

]

dataCenterstringnullable

For more information, check the documentation.

dbaas

object

DbaasReference response class.

uristringnullable

namestringnullable

database

object

DbaasReference response class.

namestringnullable

billingPlan

object

BillingPlan response class.

billingPeriodstringnullable

storage

object

sizeint64nullable

Size is in bytes

Example (from schema)

{
  "metadata": {
    "id": "string",
    "uri": "string",
    "name": "string",
    "location": {
      "code": "string",
      "country": "string",
      "city": "string",
      "name": "string",
      "value": "string"
    },
    "project": {
      "id": "string"
    },
    "tags": [
      "string"
    ],
    "category": {
      "name": "string",
      "provider": "string",
      "typology": {
        "id": "string",
        "name": "string"
      }
    },
    "creationDate": "2024-07-29T15:51:28.071Z",
    "createdBy": "string",
    "updateDate": "2024-07-29T15:51:28.071Z",
    "updatedBy": "string",
    "version": "string",
    "createdUser": "string",
    "updatedUser": "string"
  },
  "status": {
    "state": "string",
    "creationDate": "2024-07-29T15:51:28.071Z",
    "disableStatusInfo": {
      "isDisabled": true,
      "reasons": [
        "string"
      ],
      "previousStatus": {
        "state": "string",
        "creationDate": "2024-07-29T15:51:28.071Z"
      }
    },
    "failureReason": "string"
  },
  "properties": {
    "linkedResources": [
      {
        "uri": "string",
        "strictCorrelation": true
      }
    ],
    "dataCenter": "string",
    "dbaas": {
      "uri": "string",
      "name": "string"
    },
    "database": {
      "name": "string"
    },
    "billingPlan": {
      "billingPeriod": "string"
    },
    "storage": {
      "size": 0
    }
  }
}

400

Bad Request

text/plain

Schema

Schema

typestringnullable
titlestringnullable
statusint32nullable
detailstringnullable
instancestringnullable
property name*any

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

application/json

Schema

Schema

typestringnullable
titlestringnullable
statusint32nullable
detailstringnullable
instancestringnullable
property name*any

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

text/json

Schema

Schema

typestringnullable
titlestringnullable
statusint32nullable
detailstringnullable
instancestringnullable
property name*any

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

500

Internal Server Error