Get Backup Policy

GET 
/projects/:projectId/providers/Aruba.Schedule/backupPolicies/:id

Get Backup Policy

Request

Path Parameters

projectId stringrequired

unique identifier of the project CMP

id stringrequired

unique identifier of the Backup Policy

Query Parameters

includeDeleted boolean
Default value: false
api-version string
The requested API version
Default value: 1

Responses

200

OK

text/plain

Schema

Schema

metadata

object

idstringnullable

uristringnullable

namestringnullable

project

object

idstringnullable

folderIdstringnullable

tagsstring[]nullable

category

object

namestringnullable

providerstringnullable

typology

object

idstringnullable

namestringnullable

creationDatedate-timenullable

createdBystringnullable

ownerIdstringnullable

updateDatedate-timenullable

updatedBystringnullable

versionstringnullable

createdUserstringnullable

updatedUserstringnullable

managedBystringnullable

status

object

statestringnullable

creationDatedate-timenullable

failureReasonstringnullable

error

object

reasonstringnullable

messagestringnullable

properties

object

resourceTypestringnullable

schedules

object[]

Array [

backupTypestringnullable

frequencystringnullable

timedate-spannullable

dayOfWeekstringnullable

dayOfMonthstringnullable

retentionDaysint32nullable

]

Example (from schema)

{
  "metadata": {
    "id": "string",
    "uri": "string",
    "name": "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",
    "ownerId": "string",
    "updateDate": "2024-07-29T15:51:28.071Z",
    "updatedBy": "string",
    "version": "string",
    "createdUser": "string",
    "updatedUser": "string",
    "managedBy": "string"
  },
  "status": {
    "state": "string",
    "creationDate": "2024-07-29T15:51:28.071Z",
    "failureReason": "string",
    "error": {
      "reason": "string",
      "message": "string"
    }
  },
  "properties": {
    "resourceType": "string",
    "schedules": [
      {
        "backupType": "string",
        "frequency": "string",
        "time": "string",
        "dayOfWeek": "string",
        "dayOfMonth": "string",
        "retentionDays": 0
      }
    ]
  }
}

application/json

Schema

Schema

metadata

object

idstringnullable

uristringnullable

namestringnullable

project

object

idstringnullable

folderIdstringnullable

tagsstring[]nullable

category

object

namestringnullable

providerstringnullable

typology

object

idstringnullable

namestringnullable

creationDatedate-timenullable

createdBystringnullable

ownerIdstringnullable

updateDatedate-timenullable

updatedBystringnullable

versionstringnullable

createdUserstringnullable

updatedUserstringnullable

managedBystringnullable

status

object

statestringnullable

creationDatedate-timenullable

failureReasonstringnullable

error

object

reasonstringnullable

messagestringnullable

properties

object

resourceTypestringnullable

schedules

object[]

Array [

backupTypestringnullable

frequencystringnullable

timedate-spannullable

dayOfWeekstringnullable

dayOfMonthstringnullable

retentionDaysint32nullable

]

Example (from schema)

{
  "metadata": {
    "id": "string",
    "uri": "string",
    "name": "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",
    "ownerId": "string",
    "updateDate": "2024-07-29T15:51:28.071Z",
    "updatedBy": "string",
    "version": "string",
    "createdUser": "string",
    "updatedUser": "string",
    "managedBy": "string"
  },
  "status": {
    "state": "string",
    "creationDate": "2024-07-29T15:51:28.071Z",
    "failureReason": "string",
    "error": {
      "reason": "string",
      "message": "string"
    }
  },
  "properties": {
    "resourceType": "string",
    "schedules": [
      {
        "backupType": "string",
        "frequency": "string",
        "time": "string",
        "dayOfWeek": "string",
        "dayOfMonth": "string",
        "retentionDays": 0
      }
    ]
  }
}

text/json

Schema

Schema

metadata

object

idstringnullable

uristringnullable

namestringnullable

project

object

idstringnullable

folderIdstringnullable

tagsstring[]nullable

category

object

namestringnullable

providerstringnullable

typology

object

idstringnullable

namestringnullable

creationDatedate-timenullable

createdBystringnullable

ownerIdstringnullable

updateDatedate-timenullable

updatedBystringnullable

versionstringnullable

createdUserstringnullable

updatedUserstringnullable

managedBystringnullable

status

object

statestringnullable

creationDatedate-timenullable

failureReasonstringnullable

error

object

reasonstringnullable

messagestringnullable

properties

object

resourceTypestringnullable

schedules

object[]

Array [

backupTypestringnullable

frequencystringnullable

timedate-spannullable

dayOfWeekstringnullable

dayOfMonthstringnullable

retentionDaysint32nullable

]

Example (from schema)

{
  "metadata": {
    "id": "string",
    "uri": "string",
    "name": "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",
    "ownerId": "string",
    "updateDate": "2024-07-29T15:51:28.071Z",
    "updatedBy": "string",
    "version": "string",
    "createdUser": "string",
    "updatedUser": "string",
    "managedBy": "string"
  },
  "status": {
    "state": "string",
    "creationDate": "2024-07-29T15:51:28.071Z",
    "failureReason": "string",
    "error": {
      "reason": "string",
      "message": "string"
    }
  },
  "properties": {
    "resourceType": "string",
    "schedules": [
      {
        "backupType": "string",
        "frequency": "string",
        "time": "string",
        "dayOfWeek": "string",
        "dayOfMonth": "string",
        "retentionDays": 0
      }
    ]
  }
}

404

Not Found

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