Trusted Certificate Chain Controller Resource

GET /certificates

Returns list of details of certificate chains by given parameters.

Request Parameters
name type description constraints
source query  
source-type query "BACKUP_DESTINATION" or "HYPERVISOR" or "HYPERVISOR_MANAGER" or "STORAGE_PROVIDER"
type query "SSH_HOST_FINGERPRINT" or "X509"
Response Body
media type data type description
application/json array of TrustedCertificateChainDetails (JSON) list of details of certificate chains

Example

Request
GET /certificates
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "guid" : "...",
  "creationTime" : 12345,
  "hypervisor" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "hypervisorManager" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "storageProvider" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "backupDestination" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "trustedCertificates" : [ {
    "guid" : "...",
    "value" : "...",
    "notAfter" : 12345
  }, {
    "guid" : "...",
    "value" : "...",
    "notAfter" : 12345
  } ],
  "type" : "X509"
} ]
                
              

POST /certificates

Adds a certificate

Request Body
media type data type description
application/json TrustedCertificateChainRequest (JSON) specify details of a certificate
Response Body
media type data type description
application/json TrustedCertificateChainDetails (JSON) details of a certificate

Example

Request
POST /certificates
Content-Type: application/json
Accept: application/json

                
{
  "sourceId" : "...",
  "sourceType" : "HYPERVISOR",
  "trustedCertificates" : [ {
    "value" : "...",
    "notAfter" : 12345
  }, {
    "value" : "...",
    "notAfter" : 12345
  } ],
  "type" : "SSH_HOST_FINGERPRINT"
}
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "guid" : "...",
  "creationTime" : 12345,
  "hypervisor" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "hypervisorManager" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "storageProvider" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "backupDestination" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "trustedCertificates" : [ {
    "guid" : "...",
    "value" : "...",
    "notAfter" : 12345
  }, {
    "guid" : "...",
    "value" : "...",
    "notAfter" : 12345
  } ],
  "type" : "X509"
}
                
              

GET /certificates/{guid}

Returns details of a certificate.

Request Parameters
name type description
guid path specify local unique identifier for certificate (use by vProtect)
Response Body
media type data type description
application/json TrustedCertificateChainDetails (JSON) details of a certificate

Example

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

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "guid" : "...",
  "creationTime" : 12345,
  "hypervisor" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "hypervisorManager" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "storageProvider" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "backupDestination" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "trustedCertificates" : [ {
    "guid" : "...",
    "value" : "...",
    "notAfter" : 12345
  }, {
    "guid" : "...",
    "value" : "...",
    "notAfter" : 12345
  } ],
  "type" : "X509"
}
                
              

DELETE /certificates/source/{source}/{sourceType}

Deletes a certificate by source

Request Parameters
name type description constraints
source path specify source of a certificate  
sourceType path specify source type of certificate "BACKUP_DESTINATION" or "HYPERVISOR" or "HYPERVISOR_MANAGER" or "STORAGE_PROVIDER"

Example

Request
DELETE /certificates/source/{source}/{sourceType}
Content-Type: */*

                
...
                
              
Response
HTTP/1.1 204 No Content

              

GET /certificates/{sourceType}/{source}/{type}

Returns details of a certificate chain by given parameters.

Request Parameters
name type description constraints
source path guid of source of specified type  
sourceType path specify type of source "BACKUP_DESTINATION" or "HYPERVISOR" or "HYPERVISOR_MANAGER" or "STORAGE_PROVIDER"
type path a type of certificate chain "SSH_HOST_FINGERPRINT" or "X509"
Response Body
media type data type description
application/json TrustedCertificateChainDetails (JSON) details of a certificate

Example

Request
GET /certificates/{sourceType}/{source}/{type}
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "guid" : "...",
  "creationTime" : 12345,
  "hypervisor" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "hypervisorManager" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "storageProvider" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "backupDestination" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "trustedCertificates" : [ {
    "guid" : "...",
    "value" : "...",
    "notAfter" : 12345
  }, {
    "guid" : "...",
    "value" : "...",
    "notAfter" : 12345
  } ],
  "type" : "SSH_HOST_FINGERPRINT"
}