The API allows you to list, view, edit and create projects.
Returns list of projects filtered by specified query parameters.
name | type | description |
---|---|---|
authentication-domain | query | |
backup | query | |
direction | query | |
filter | query | |
hypervisor-manager | query | |
nameLike | query | |
orderBy | query | |
page | query | |
quota | query | |
size | query | |
uuid | query |
media type | data type | description |
---|---|---|
application/json | array of ProjectListRecord (JSON) | list of projects filtered by specified query parameters |
GET /projects
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
[ {
"guid" : "...",
"uuid" : "...",
"name" : "...",
"active" : true,
"present" : true,
"hvManager" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"quota" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"backupDestinations" : [ {
"type" : {
"name" : "ENUM_NAME",
"description" : "Enum description"
},
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"type" : {
"name" : "...",
"description" : "..."
},
"guid" : "...",
"name" : "..."
} ],
"authenticationDomains" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ]
} ]
Create project.
media type | data type | description |
---|---|---|
application/json | ProjectRequest (JSON) | specify details for new project |
media type | data type | description |
---|---|---|
application/json | ProjectListRecord (JSON) | details of newly created project |
POST /projects
Content-Type: application/json
Accept: application/json
{
"uuid" : "...",
"name" : "...",
"hvManager" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"active" : true,
"backupDestinations" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"authenticationDomains" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"sourceAuthenticationDomain" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"quota" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"guid" : "...",
"uuid" : "...",
"name" : "...",
"active" : true,
"present" : true,
"hvManager" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"quota" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"backupDestinations" : [ {
"type" : {
"name" : "ENUM_NAME",
"description" : "Enum description"
},
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"type" : {
"name" : "...",
"description" : "..."
},
"guid" : "...",
"name" : "..."
} ],
"authenticationDomains" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ]
}
Returns list of projects filtered by specified query parameters.
name | type | description |
---|---|---|
authentication-domain | query | |
backup | query | |
direction | query | |
filter | query | |
hypervisor-manager | query | |
nameLike | query | |
orderBy | query | |
page | query | |
quota | query | |
size | query | |
uuid | query |
media type | data type | description |
---|---|---|
application/json | array of ProjectForRestoreListRecord (JSON) | list of projects filtered by specified query parameters |
GET /projects/for-restore
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
[ {
"guid" : "...",
"uuid" : "...",
"name" : "..."
} ]
Change quota for specified list of projects.
media type | data type | description |
---|---|---|
application/json | SingleAttributeBatchUpdate (JSON) | specify quota and guids of projects |
media type | data type | description |
---|---|---|
application/json | BatchResponse (JSON) | list of successful and unsuccessful updates of quota |
PUT /projects/quota
Content-Type: application/json
Accept: application/json
{
"value" : "...",
"entities" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ]
}
HTTP/1.1 204 No Content
Content-Type: application/json
{
"successful" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"unsuccessful" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ]
}
Returns list of projects filtered by specified query parameters.
name | type | description | constraints |
---|---|---|---|
app-cmd-exec-config | query | ||
cloud-service-provider | query | ||
cluster | query | ||
data-center | query | ||
direction | query | ||
filter | query | ||
hypervisor | query | ||
hypervisor-manager | query | ||
nameLike | query | ||
orderBy | query | ||
page | query | ||
project | query | ||
size | query | ||
storage-pool | query | ||
storage-provider | query | ||
teams-group | query | boolean |
media type | data type | description |
---|---|---|
application/json | array of RbacContextListRecord (JSON) | list of projects filtered by specified query parameters |
GET /projects/rbac-contexts
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
[ {
"nameAndGuid" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"uuid" : "...",
"type" : "APPLICATION",
"checked" : true,
"lastLevel" : true,
"present" : true,
"entityType" : "...",
"childrenQueryType" : "..."
} ]
Remove project.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for project (use by vProtect) |
DELETE /projects/{guid}
Content-Type: */*
...
HTTP/1.1 204 No Content
Get a single project.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for project (use by vProtect) |
media type | data type | description |
---|---|---|
application/json | ProjectListRecord (JSON) | project details |
GET /projects/{guid}
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"guid" : "...",
"uuid" : "...",
"name" : "...",
"active" : true,
"present" : true,
"hvManager" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"quota" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"backupDestinations" : [ {
"type" : {
"name" : "ENUM_NAME",
"description" : "Enum description"
},
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"type" : {
"name" : "...",
"description" : "..."
},
"guid" : "...",
"name" : "..."
} ],
"authenticationDomains" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ]
}
Change project details.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for project (use by vProtect) |
media type | data type | description |
---|---|---|
application/json | ProjectUpdate (JSON) | specify project details to update |
media type | data type | description |
---|---|---|
application/json | ProjectListRecord (JSON) | updated details of project |
PUT /projects/{guid}
Content-Type: application/json
Accept: application/json
{
"name" : "...",
"active" : true,
"backupDestinations" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"authenticationDomains" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"sourceAuthenticationDomain" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"quota" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}
}
HTTP/1.1 204 No Content
Content-Type: application/json
{
"guid" : "...",
"uuid" : "...",
"name" : "...",
"active" : true,
"present" : true,
"hvManager" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"quota" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"backupDestinations" : [ {
"type" : {
"name" : "ENUM_NAME",
"description" : "Enum description"
},
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"type" : {
"name" : "...",
"description" : "..."
},
"guid" : "...",
"name" : "..."
} ],
"authenticationDomains" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ]
}