Create Backup

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

Create Backup

Request

Path Parameters

projectId stringrequired

Query Parameters

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

application/json

Body

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

typestringnullable

The backup type (Full, Incremental)

sourceVolume

object

uristringnullable

retentionDaysint32nullable

Retention days for the backup

billingPeriodstringnullable

Retention days for the backup

text/json

Body

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

typestringnullable

The backup type (Full, Incremental)

sourceVolume

object

uristringnullable

retentionDaysint32nullable

Retention days for the backup

billingPeriodstringnullable

Retention days for the backup

application/*+json

Body

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

typestringnullable

The backup type (Full, Incremental)

sourceVolume

object

uristringnullable

retentionDaysint32nullable

Retention days for the backup

billingPeriodstringnullable

Retention days for the backup

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[]nullable

previousStatus

object

statestringnullable

creationDatedate-timenullable

failureReasonstringnullable

properties

object

typestringnullable

The backup type (Full, Incremental)

sourceVolume

object

Source volume of backup

uristringnullable

Uri of the volume

namestringnullable

Current name of the volume

retentionDaysint32nullable

Retention days for the backup

billingPeriodstringnullable

The backup type (Full, Incremental)

data

object

infrastructure

object

typestringnullable

value

object

uidstringnullable

resourceIdstringnullable

namestringnullable

nameSpacestringnullable

projectIdstringnullable

info

object

sizeBytesint64nullable

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": {
    "type": "string",
    "sourceVolume": {
      "uri": "string",
      "name": "string"
    },
    "retentionDays": 0,
    "billingPeriod": "string"
  },
  "data": {
    "infrastructure": {
      "type": "string",
      "value": {
        "uid": "string",
        "resourceId": "string",
        "name": "string",
        "nameSpace": "string",
        "projectId": "string"
      }
    },
    "info": {
      "sizeBytes": 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[]nullable

previousStatus

object

statestringnullable

creationDatedate-timenullable

failureReasonstringnullable

properties

object

typestringnullable

The backup type (Full, Incremental)

sourceVolume

object

Source volume of backup

uristringnullable

Uri of the volume

namestringnullable

Current name of the volume

retentionDaysint32nullable

Retention days for the backup

billingPeriodstringnullable

The backup type (Full, Incremental)

data

object

infrastructure

object

typestringnullable

value

object

uidstringnullable

resourceIdstringnullable

namestringnullable

nameSpacestringnullable

projectIdstringnullable

info

object

sizeBytesint64nullable

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": {
    "type": "string",
    "sourceVolume": {
      "uri": "string",
      "name": "string"
    },
    "retentionDays": 0,
    "billingPeriod": "string"
  },
  "data": {
    "infrastructure": {
      "type": "string",
      "value": {
        "uid": "string",
        "resourceId": "string",
        "name": "string",
        "nameSpace": "string",
        "projectId": "string"
      }
    },
    "info": {
      "sizeBytes": 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[]nullable

previousStatus

object

statestringnullable

creationDatedate-timenullable

failureReasonstringnullable

properties

object

typestringnullable

The backup type (Full, Incremental)

sourceVolume

object

Source volume of backup

uristringnullable

Uri of the volume

namestringnullable

Current name of the volume

retentionDaysint32nullable

Retention days for the backup

billingPeriodstringnullable

The backup type (Full, Incremental)

data

object

infrastructure

object

typestringnullable

value

object

uidstringnullable

resourceIdstringnullable

namestringnullable

nameSpacestringnullable

projectIdstringnullable

info

object

sizeBytesint64nullable

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": {
    "type": "string",
    "sourceVolume": {
      "uri": "string",
      "name": "string"
    },
    "retentionDays": 0,
    "billingPeriod": "string"
  },
  "data": {
    "infrastructure": {
      "type": "string",
      "value": {
        "uid": "string",
        "resourceId": "string",
        "name": "string",
        "nameSpace": "string",
        "projectId": "string"
      }
    },
    "info": {
      "sizeBytes": 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

Server Error