REST API Services for Oracle CPQ

Get List of All Certificates

get

/rest/v16/certificates

This endpoint returns a list of all certificates for a site.

Request

There are no request parameters for this operation.

Response

Supported Media Types

application/json

Default Response

The response contains a collection of certificates for the site.

Root Schema : certificate-collection

Type: object

Show Source

items: array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/certificate"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

Array of: object certificate

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/certificate"
    }
}

Nested Schema : certificate

Type: object

Show Source

certificate: string

Title: Certificate

The Base64 encoded certificate data.
name: string

Title: Name

The name of the certificate.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the certificate.",
            "title":"Name"
        },
        "certificate":{
            "type":"string",
            "description":"The Base64 encoded certificate data.",
            "title":"Certificate"
        }
    }
}

Examples

The following example shows how to get a list of all certificates for a site by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X POST -i -H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" -H "Accept: application/json"
https://sitename.oracle.com/rest/v16/certificates

Response Body Sample

{
  "items": [{
      "name": "testCertificate",
      "certificate": "-----BEGIN CERTIFICATE-----\nMIIDUzCCAjugAwIBAgIEFD7AEDANBgkqhkiG9w0BAQsFADBZMQswCQYDVQQGEwJVUzELMAkGA1UECBMCQ0ExCzAJBgNVBAcTAlNGMQ8wDQYDVQQKEwZvcmFjbGUxDDAKBgNVBAsTA2NwcTERMA8GA1UEAxMIY3BxY2xvdWQwIBcNMTgwMjA4MTYxMzM1WhgPMzAxNzA2MTExNjEzMzVaMFkxCzAJBgNVBAYTAlVTMQswCQYDVQQIEwJDQTELMAkGA1UEBxMCU0YxDzANBgNVBAoTBm9yYWNsZTEMMAoGA1UECxMDY3BxMREwDwYDVQQDEwhjcHFjbG91ZDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAIxidEpJ6oMD/CEg6y4MiOgGm8pPofNqMnnzTuPQoHeclI2wy9c3KhPc5i+ffu+87r9kGKiEAzS+nZmcQeWxYZgfhT+9m8Ch5QB5FIM+Bl62JzI+EV27PT7C2gY939tRvjyq9KUSxDZcTN5T5nl5jdo+iRMh76AMYzUAB2oIREkJYP3VPV/spD/hldje5XNLqAnrKftZS+xCTZe274/G4L3zJcFhZmn5UY5/JaV6/titvOi4TY29Jl1OQQAeT4nccvZN2+cFTmURLB2JS0xqvrSEJwjRVaf6oiTx2SxUL/bDtaGCraSmsD1Fj6wMfoV/iINovxIuWR0G40Sp2LeFQ8cCAwEAAaMhMB8wHQYDVR0OBBYEFF5dxm3b/k9K2Io7cVtClIcjMGlbMA0GCSqGSIb3DQEBCwUAA4IBAQAUe7HxVYPEuRClPKTP29g3DxbpuFWMkrvqIJqhYjeb7IkCMwqWn+gM48OZ1TYgZSQM8Ga3NNQsWtkOGFKoqFbrHRanMy9A5lUBy0HHwZjw3ebGaDXDuExNec5fP85QnA5gVpmzsfzkN0xB6wJV+svDGl1xpy1XrLeSuOz/4Zk83gjSm4t+cbod+Ad8YvMaEU6k5EXsCuupmvcBvSR2sXta2ny0qtGRnwULKbY0vhPH8uIzil2/eN7OUrLcLmjIezJGcC9X8rHSz90T9RNuI1d/2Fo9w1HlctsimQzJnwW4xM9jLLZlccMZ13ta4M4CAPM3ujfhQROL+MzzPdioCXWI\n-----END CERTIFICATE-----",
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/certificates/testCertificate"
        }
      ]
    }
  ],
  "links": [{
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v16/certificates"
    }
  ]
}