Access Key Controller Resource

The API allows you list and view Access Keys.

GET /access-keys

Returns list of access keys filtered by specified query parameters.

Request 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  
Response Body
media type data type description
application/json array of AccessKeyListRecord (JSON) list of access keys filtered by specified query parameters

Example

Request
GET /access-keys
Content-Type: */*
Accept: application/json

                
...
                
              
Response
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"
  }
} ]
                
              

GET /access-keys/detailed

Returns list of access keys with details filtered by specified query parameters.

Request 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  
Response Body
media type data type description
application/json array of AccessKeyDetails (JSON) list of access keys with details filtered by specified query parameters

Example

Request
GET /access-keys/detailed
Content-Type: */*
Accept: application/json

                
...
                
              
Response
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"
  }
} ]
                
              

GET /access-keys/for-restore

Returns list of access keys for restore filtered by specified query parameters.

Request 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  
Response Body
media type data type description
application/json array of AccessKeyForRestoreListRecord (JSON) list of access keys filtered by specified query parameters

Example

Request
GET /access-keys/for-restore
Content-Type: */*
Accept: application/json

                
...
                
              
Response
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"
  }
} ]
                
              

DELETE /access-keys/{guid}

Request Parameters
name type description
guid path

Example

Request
DELETE /access-keys/{guid}
Content-Type: */*

                
...
                
              
Response
HTTP/1.1 204 No Content

              

GET /access-keys/{guid}

Get a single access key.

Request Parameters
name type description
guid path specify local unique identifier for access key (use by vProtect)
Response Body
media type data type description
application/json AccessKeyDetails (JSON) access key details

Example

Request
GET /access-keys/{guid}
Content-Type: */*
Accept: application/json

                
...
                
              
Response
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"
  }
}