Create backup

POST 
/projects/:projectId/providers/Aruba.Container/kaas/:kaasId/backups

Create backup

Request

Path Parameters

projectId stringrequired
kaasId stringrequired

Query Parameters

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

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

billingPeriodstringnullable

typestringnullable

retentionDaysint32nullable

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

billingPeriodstringnullable

typestringnullable

retentionDaysint32nullable

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

billingPeriodstringnullable

typestringnullable

retentionDaysint32nullable

Responses

201

Created

text/plain

Schema

Schema

metadata

object

idstringnullable

uristringnullable

namestringnullable

location

object

codestringnullable

countrystringnullable

citystringnullable

namestringnullable

valuestringnullable

project

object

idstringnullable

folderIdstringnullable

tagsstring[]nullable

category

object

namestringnullable

providerstringnullable

typology

object

idstringnullable

namestringnullable

creationDatedate-timenullable

createdBystringnullable

updateDatedate-timenullable

updatedBystringnullable

versionstringnullable

createdUserstringnullable

updatedUserstringnullable

linkedResources

object[]

nullable

Array [

uristringnullable

strictCorrelationboolean

]

managedBystringnullable

status

object

statestringnullable

creationDatedate-timenullable

disableStatusInfo

object

isDisabledboolean

reasonsstring[]

previousStatus

object

statestringnullable

creationDatedate-timenullable

failureReasonstringnullable

error

object

reasonstringnullable

messagestringnullable

properties

object

linkedResources

object[]

nullable

Array [

uristringnullable

strictCorrelationboolean

]

billingPeriodstringnullable

typestringnullable

retentionDaysint32nullable

kaas

object

uristringnullable

idstringnullable

namestringnullable

data

object

info

object

sizeBytesint64nullable

expiresAtdate-timenullable

private

object

phase

object

namestringnullable

startDatedate-timenullable

Example (from schema)

{
  "metadata": {
    "id": "string",
    "uri": "string",
    "name": "string",
    "location": {
      "code": "string",
      "country": "string",
      "city": "string",
      "name": "string",
      "value": "string"
    },
    "project": {
      "id": "string",
      "folderId": "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",
    "linkedResources": [
      {
        "uri": "string",
        "strictCorrelation": true
      }
    ],
    "managedBy": "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",
    "error": {
      "reason": "string",
      "message": "string"
    }
  },
  "properties": {
    "linkedResources": [
      {
        "uri": "string",
        "strictCorrelation": true
      }
    ],
    "billingPeriod": "string",
    "type": "string",
    "retentionDays": 0,
    "kaas": {
      "uri": "string",
      "id": "string",
      "name": "string"
    }
  },
  "data": {
    "info": {
      "sizeBytes": 0,
      "expiresAt": "2024-07-29T15:51:28.071Z"
    },
    "private": {
      "phase": {
        "name": "string",
        "startDate": "2024-07-29T15:51:28.071Z"
      }
    }
  }
}

application/json

Schema

Schema

metadata

object

idstringnullable

uristringnullable

namestringnullable

location

object

codestringnullable

countrystringnullable

citystringnullable

namestringnullable

valuestringnullable

project

object

idstringnullable

folderIdstringnullable

tagsstring[]nullable

category

object

namestringnullable

providerstringnullable

typology

object

idstringnullable

namestringnullable

creationDatedate-timenullable

createdBystringnullable

updateDatedate-timenullable

updatedBystringnullable

versionstringnullable

createdUserstringnullable

updatedUserstringnullable

linkedResources

object[]

nullable

Array [

uristringnullable

strictCorrelationboolean

]

managedBystringnullable

status

object

statestringnullable

creationDatedate-timenullable

disableStatusInfo

object

isDisabledboolean

reasonsstring[]

previousStatus

object

statestringnullable

creationDatedate-timenullable

failureReasonstringnullable

error

object

reasonstringnullable

messagestringnullable

properties

object

linkedResources

object[]

nullable

Array [

uristringnullable

strictCorrelationboolean

]

billingPeriodstringnullable

typestringnullable

retentionDaysint32nullable

kaas

object

uristringnullable

idstringnullable

namestringnullable

data

object

info

object

sizeBytesint64nullable

expiresAtdate-timenullable

private

object

phase

object

namestringnullable

startDatedate-timenullable

Example (from schema)

{
  "metadata": {
    "id": "string",
    "uri": "string",
    "name": "string",
    "location": {
      "code": "string",
      "country": "string",
      "city": "string",
      "name": "string",
      "value": "string"
    },
    "project": {
      "id": "string",
      "folderId": "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",
    "linkedResources": [
      {
        "uri": "string",
        "strictCorrelation": true
      }
    ],
    "managedBy": "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",
    "error": {
      "reason": "string",
      "message": "string"
    }
  },
  "properties": {
    "linkedResources": [
      {
        "uri": "string",
        "strictCorrelation": true
      }
    ],
    "billingPeriod": "string",
    "type": "string",
    "retentionDays": 0,
    "kaas": {
      "uri": "string",
      "id": "string",
      "name": "string"
    }
  },
  "data": {
    "info": {
      "sizeBytes": 0,
      "expiresAt": "2024-07-29T15:51:28.071Z"
    },
    "private": {
      "phase": {
        "name": "string",
        "startDate": "2024-07-29T15:51:28.071Z"
      }
    }
  }
}

text/json

Schema

Schema

metadata

object

idstringnullable

uristringnullable

namestringnullable

location

object

codestringnullable

countrystringnullable

citystringnullable

namestringnullable

valuestringnullable

project

object

idstringnullable

folderIdstringnullable

tagsstring[]nullable

category

object

namestringnullable

providerstringnullable

typology

object

idstringnullable

namestringnullable

creationDatedate-timenullable

createdBystringnullable

updateDatedate-timenullable

updatedBystringnullable

versionstringnullable

createdUserstringnullable

updatedUserstringnullable

linkedResources

object[]

nullable

Array [

uristringnullable

strictCorrelationboolean

]

managedBystringnullable

status

object

statestringnullable

creationDatedate-timenullable

disableStatusInfo

object

isDisabledboolean

reasonsstring[]

previousStatus

object

statestringnullable

creationDatedate-timenullable

failureReasonstringnullable

error

object

reasonstringnullable

messagestringnullable

properties

object

linkedResources

object[]

nullable

Array [

uristringnullable

strictCorrelationboolean

]

billingPeriodstringnullable

typestringnullable

retentionDaysint32nullable

kaas

object

uristringnullable

idstringnullable

namestringnullable

data

object

info

object

sizeBytesint64nullable

expiresAtdate-timenullable

private

object

phase

object

namestringnullable

startDatedate-timenullable

Example (from schema)

{
  "metadata": {
    "id": "string",
    "uri": "string",
    "name": "string",
    "location": {
      "code": "string",
      "country": "string",
      "city": "string",
      "name": "string",
      "value": "string"
    },
    "project": {
      "id": "string",
      "folderId": "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",
    "linkedResources": [
      {
        "uri": "string",
        "strictCorrelation": true
      }
    ],
    "managedBy": "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",
    "error": {
      "reason": "string",
      "message": "string"
    }
  },
  "properties": {
    "linkedResources": [
      {
        "uri": "string",
        "strictCorrelation": true
      }
    ],
    "billingPeriod": "string",
    "type": "string",
    "retentionDays": 0,
    "kaas": {
      "uri": "string",
      "id": "string",
      "name": "string"
    }
  },
  "data": {
    "info": {
      "sizeBytes": 0,
      "expiresAt": "2024-07-29T15:51:28.071Z"
    },
    "private": {
      "phase": {
        "name": "string",
        "startDate": "2024-07-29T15:51:28.071Z"
      }
    }
  }
}

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