The API allows you list and view Access Keys.
Returns list of access keys filtered by specified query parameters.
name | type | description | constraints |
---|---|---|---|
authentication-domain | query | ||
data-center | query | ||
direction | query | ||
filter | query | ||
hypervisor-manager | query | ||
nameLike | query | ||
orderBy | query | ||
page | query | ||
present | query | boolean | |
project | query | ||
size | query |
media type | data type | description |
---|---|---|
application/json | array of AccessKeyListRecord (JSON) | list of access keys filtered by specified query parameters |
GET /access-keys
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
[ {
"guid" : "...",
"uuid" : "...",
"name" : "...",
"type" : "X509_CERTIFICATE",
"present" : true,
"hvManager" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"authenticationDomain" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"project" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"dataCenter" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}
} ]
Returns list of access keys with details filtered by specified query parameters.
name | type | description | constraints |
---|---|---|---|
authentication-domain | query | ||
data-center | query | ||
direction | query | ||
filter | query | ||
hypervisor-manager | query | ||
nameLike | query | ||
orderBy | query | ||
page | query | ||
present | query | boolean | |
project | query | ||
size | query |
media type | data type | description |
---|---|---|
application/json | array of AccessKeyDetails (JSON) | list of access keys with details filtered by specified query parameters |
GET /access-keys/detailed
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
[ {
"guid" : "...",
"uuid" : "...",
"name" : "...",
"userId" : "...",
"publicKey" : "...",
"type" : "X509_CERTIFICATE",
"present" : true,
"hvManager" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"authenticationDomain" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"project" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"dataCenter" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}
} ]
Returns list of access keys for restore filtered by specified query parameters.
name | type | description | constraints |
---|---|---|---|
authentication-domain | query | ||
data-center | query | ||
direction | query | ||
filter | query | ||
hypervisor-manager | query | ||
nameLike | query | ||
orderBy | query | ||
page | query | ||
present | query | boolean | |
project | query | ||
size | query |
media type | data type | description |
---|---|---|
application/json | array of AccessKeyForRestoreListRecord (JSON) | list of access keys filtered by specified query parameters |
GET /access-keys/for-restore
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
[ {
"guid" : "...",
"uuid" : "...",
"name" : "...",
"type" : "X509_CERTIFICATE",
"present" : true,
"hvManager" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"authenticationDomain" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"project" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"dataCenter" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}
} ]
name | type | description |
---|---|---|
guid | path |
DELETE /access-keys/{guid}
Content-Type: */*
...
HTTP/1.1 204 No Content
Get a single access key.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for access key (use by vProtect) |
media type | data type | description |
---|---|---|
application/json | AccessKeyDetails (JSON) | access key details |
GET /access-keys/{guid}
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"guid" : "...",
"uuid" : "...",
"name" : "...",
"userId" : "...",
"publicKey" : "...",
"type" : "SSH",
"present" : true,
"hvManager" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"authenticationDomain" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"project" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"dataCenter" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}
}