Returns list of quotas filtered by specified query parameters.
name | type | description | constraints |
---|---|---|---|
active | query | boolean | |
direction | query | ||
filter | query | ||
hypervisor-manager | query | ||
nameLike | query | ||
orderBy | query | ||
page | query | ||
size | query |
media type | data type | description |
---|---|---|
application/json | array of QuotaListRecord (JSON) | list of quotas filtered by specified query parameters |
GET /quotas
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
[ {
"name" : "...",
"guid" : "...",
"active" : true
} ]
Create quota
media type | data type | description |
---|---|---|
application/json | QuotaRequest (JSON) | specify details for new quota |
media type | data type | description |
---|---|---|
application/json | QuotaDetails (JSON) | details for newly created quota |
POST /quotas
Content-Type: application/json
Accept: application/json
{
"name" : "...",
"active" : true,
"hypervisorManagerGuid" : "...",
"rules" : [ {
"ruleName" : "NUMBER_OF_RESTORES",
"type" : "TOTAL",
"active" : true,
"quotaConfig" : {
"hardLimitValue" : 12345,
"hardLimitTimeFrame" : 12345,
"softLimitValue" : 12345,
"softLimitTimeFrame" : 12345
}
}, {
"ruleName" : "NUMBER_OF_BACKUPS",
"type" : "TOTAL",
"active" : true,
"quotaConfig" : {
"hardLimitValue" : 12345,
"hardLimitTimeFrame" : 12345,
"softLimitValue" : 12345,
"softLimitTimeFrame" : 12345
}
} ]
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"name" : "...",
"guid" : "...",
"active" : true,
"hypervisorManagerGuid" : "...",
"rules" : [ {
"ruleName" : "LOGICAL_BACKUP_CAPACITY",
"type" : "PER_INSTANCE",
"active" : true,
"quotaConfig" : {
"hardLimitValue" : 12345,
"hardLimitTimeFrame" : 12345,
"softLimitValue" : 12345,
"softLimitTimeFrame" : 12345
}
}, {
"ruleName" : "LOGICAL_BACKUP_CAPACITY",
"type" : "PER_INSTANCE",
"active" : true,
"quotaConfig" : {
"hardLimitValue" : 12345,
"hardLimitTimeFrame" : 12345,
"softLimitValue" : 12345,
"softLimitTimeFrame" : 12345
}
} ]
}
Returns list of detailed quotas filtered by specified query parameters.
name | type | description | constraints |
---|---|---|---|
active | query | boolean | |
direction | query | ||
filter | query | ||
hypervisor-manager | query | ||
nameLike | query | ||
orderBy | query | ||
page | query | ||
size | query |
media type | data type | description |
---|---|---|
application/json | array of QuotaDetails (JSON) | list of quotas filtered by specified query parameters |
GET /quotas/detailed
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
[ {
"name" : "...",
"guid" : "...",
"active" : true,
"hypervisorManagerGuid" : "...",
"rules" : [ {
"ruleName" : "NUMBER_OF_BACKUPS",
"type" : "TOTAL",
"active" : true,
"quotaConfig" : {
"hardLimitValue" : 12345,
"hardLimitTimeFrame" : 12345,
"softLimitValue" : 12345,
"softLimitTimeFrame" : 12345
}
}, {
"ruleName" : "LOGICAL_BACKUP_CAPACITY",
"type" : "PER_INSTANCE",
"active" : true,
"quotaConfig" : {
"hardLimitValue" : 12345,
"hardLimitTimeFrame" : 12345,
"softLimitValue" : 12345,
"softLimitTimeFrame" : 12345
}
} ]
} ]
Remove quota
name | type | description |
---|---|---|
guid | path | specify local unique identifier for quota (use by vProtect) |
DELETE /quotas/{guid}
Content-Type: */*
...
HTTP/1.1 204 No Content
Get a single quota
name | type | description |
---|---|---|
guid | path | specify local unique identifier for quota (use by vProtect) |
media type | data type | description |
---|---|---|
application/json | QuotaDetails (JSON) | quota details |
GET /quotas/{guid}
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"name" : "...",
"guid" : "...",
"active" : true,
"hypervisorManagerGuid" : "...",
"rules" : [ {
"ruleName" : "NUMBER_OF_RESTORES",
"type" : "TOTAL",
"active" : true,
"quotaConfig" : {
"hardLimitValue" : 12345,
"hardLimitTimeFrame" : 12345,
"softLimitValue" : 12345,
"softLimitTimeFrame" : 12345
}
}, {
"ruleName" : "NUMBER_OF_RESTORES",
"type" : "PER_INSTANCE",
"active" : true,
"quotaConfig" : {
"hardLimitValue" : 12345,
"hardLimitTimeFrame" : 12345,
"softLimitValue" : 12345,
"softLimitTimeFrame" : 12345
}
} ]
}
Change quota details.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for quota (use by vProtect) |
media type | data type | description |
---|---|---|
application/json | QuotaRequest (JSON) | specify quota details to update |
media type | data type | description |
---|---|---|
application/json | QuotaDetails (JSON) | updated details for quota |
PUT /quotas/{guid}
Content-Type: application/json
Accept: application/json
{
"name" : "...",
"active" : true,
"hypervisorManagerGuid" : "...",
"rules" : [ {
"ruleName" : "LOGICAL_BACKUP_CAPACITY",
"type" : "PER_INSTANCE",
"active" : true,
"quotaConfig" : {
"hardLimitValue" : 12345,
"hardLimitTimeFrame" : 12345,
"softLimitValue" : 12345,
"softLimitTimeFrame" : 12345
}
}, {
"ruleName" : "NUMBER_OF_BACKUPS",
"type" : "PER_INSTANCE",
"active" : true,
"quotaConfig" : {
"hardLimitValue" : 12345,
"hardLimitTimeFrame" : 12345,
"softLimitValue" : 12345,
"softLimitTimeFrame" : 12345
}
} ]
}
HTTP/1.1 204 No Content
Content-Type: application/json
{
"name" : "...",
"guid" : "...",
"active" : true,
"hypervisorManagerGuid" : "...",
"rules" : [ {
"ruleName" : "LOGICAL_BACKUP_CAPACITY",
"type" : "TOTAL",
"active" : true,
"quotaConfig" : {
"hardLimitValue" : 12345,
"hardLimitTimeFrame" : 12345,
"softLimitValue" : 12345,
"softLimitTimeFrame" : 12345
}
}, {
"ruleName" : "NUMBER_OF_BACKUPS",
"type" : "TOTAL",
"active" : true,
"quotaConfig" : {
"hardLimitValue" : 12345,
"hardLimitTimeFrame" : 12345,
"softLimitValue" : 12345,
"softLimitTimeFrame" : 12345
}
} ]
}
Clone quota
name | type | description |
---|---|---|
guid | path | specify local unique identifier for quota (use by vProtect) |
name | query |
media type | data type | description |
---|---|---|
application/json | QuotaDetails (JSON) | details for newly created quota |
POST /quotas/{guid}/clone
Content-Type: application/json
Accept: application/json
...
HTTP/1.1 201 Created
Content-Type: application/json
{
"name" : "...",
"guid" : "...",
"active" : true,
"hypervisorManagerGuid" : "...",
"rules" : [ {
"ruleName" : "LOGICAL_BACKUP_CAPACITY",
"type" : "TOTAL",
"active" : true,
"quotaConfig" : {
"hardLimitValue" : 12345,
"hardLimitTimeFrame" : 12345,
"softLimitValue" : 12345,
"softLimitTimeFrame" : 12345
}
}, {
"ruleName" : "NUMBER_OF_RESTORES",
"type" : "PER_INSTANCE",
"active" : true,
"quotaConfig" : {
"hardLimitValue" : 12345,
"hardLimitTimeFrame" : 12345,
"softLimitValue" : 12345,
"softLimitTimeFrame" : 12345
}
} ]
}