BlockedCertificates Resource

GET /blockedCertificates

Returns the list of all the BlockedCertificate.

If the flag BlockedCertificatesResult.limitExceeded is set, the maximum number of entries to be returned has been reached, more pkis exist and can be read by moving the offset forward in a new request

Example to get all BlockedCertificates: 

 String apiPath = "blockedCertificates.xml";
 WebResource apisWeb = client.resource(API_URL).path(apiPath);

 BlockedCertificatesResult result;
 int offset = 0;
 do {
 // if the "limit" queryParam is not initialized, limit default value = 50
 // if the "offset" queryParam is not initialized, offset default value = 0
 apisWeb = apisWeb.queryParam("limit", "" + limit);
 if (offset > 0)
 apisWeb = apisWeb.queryParam("offset", "" + offset);
 result = apisWeb.get(BlockedCertificatesResult.class);
 offset += limit;
 } while (result.isLimitExceeded()):

Example of query in CURL :
curl --user 'username:password' -k https://api-sandbox.everyware-cloud.com/v2/blockedCertificates

Request Parameters
name type description default constraints
limit query Maximum number of entries to be returned. Note that an error will be returned if the maximum allowed value is exceeded. 50 required
offset query Starting offset for the entries to be returned. Note that an error will be returned if the maximum allowed value is exceeded. 0 required
Response Body
media type data type description
application/json BlockedCertificatesResult (JSON) The list of requested BlockedCertificates.
application/xml blockedCertificatesResult (XML)

Example

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

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

                
{
  "limitExceeded" : true,
  "blockedCertificate" : [ {
    "digest" : "...",
    "id" : 12345,
    "certificate" : "...",
    "accountId" : 12345,
    "version" : 12345,
    "serial" : "...",
    "algorithm" : "...",
    "subject" : "...",
    "issuer" : "...",
    "notBefore" : 12345,
    "notAfter" : 12345,
    "createdOn" : 12345,
    "createdBy" : 12345,
    "modifiedOn" : 12345,
    "modifiedBy" : 12345,
    "name" : "...",
    "optlock" : 12345
  }, {
    "digest" : "...",
    "id" : 12345,
    "certificate" : "...",
    "accountId" : 12345,
    "version" : 12345,
    "serial" : "...",
    "algorithm" : "...",
    "subject" : "...",
    "issuer" : "...",
    "notBefore" : 12345,
    "notAfter" : 12345,
    "createdOn" : 12345,
    "createdBy" : 12345,
    "modifiedOn" : 12345,
    "modifiedBy" : 12345,
    "name" : "...",
    "optlock" : 12345
  } ]
}

POST /blockedCertificates

Creates a new BlockedCertificate based on the information provided in BlockedCertificateCreator parameter.

Request Body
media type data type description
application/json BlockedCertificateCreator (JSON) Provides the information for the new BlockedCertificate to be created.
application/xml blockedCertificateCreator (XML)
Response Body
media type data type description
application/json BlockedCertificate (JSON) The newly created BlockedCertificate.
application/xml blockedCertificate (XML)

Example

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

                
{
  "certificate" : "...",
  "privateKey" : "...",
  "password" : "...",
  "accountId" : 12345,
  "version" : 12345,
  "serial" : "...",
  "algorithm" : "...",
  "subject" : "...",
  "issuer" : "...",
  "notBefore" : 12345,
  "notAfter" : 12345,
  "createdOn" : 12345,
  "createdBy" : 12345,
  "name" : "..."
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "digest" : "...",
  "id" : 12345,
  "certificate" : "...",
  "accountId" : 12345,
  "version" : 12345,
  "serial" : "...",
  "algorithm" : "...",
  "subject" : "...",
  "issuer" : "...",
  "notBefore" : 12345,
  "notAfter" : 12345,
  "createdOn" : 12345,
  "createdBy" : 12345,
  "modifiedOn" : 12345,
  "modifiedBy" : 12345,
  "name" : "...",
  "optlock" : 12345
}

PUT /blockedCertificates

Updates the BlockedCertificate provided in the request body.

Request Body
media type data type description
application/json BlockedCertificate (JSON) The modified BlockedCertificate whose attributes need to be updated.
application/xml blockedCertificate (XML)
Response Body
media type data type description
application/json BlockedCertificate (JSON) The updated BlockedCertificate.
application/xml blockedCertificate (XML)

Example

Request
PUT /blockedCertificates
Content-Type: application/json
Accept: application/json

                
{
  "digest" : "...",
  "id" : 12345,
  "certificate" : "...",
  "accountId" : 12345,
  "version" : 12345,
  "serial" : "...",
  "algorithm" : "...",
  "subject" : "...",
  "issuer" : "...",
  "notBefore" : 12345,
  "notAfter" : 12345,
  "createdOn" : 12345,
  "createdBy" : 12345,
  "modifiedOn" : 12345,
  "modifiedBy" : 12345,
  "name" : "...",
  "optlock" : 12345
}
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "digest" : "...",
  "id" : 12345,
  "certificate" : "...",
  "accountId" : 12345,
  "version" : 12345,
  "serial" : "...",
  "algorithm" : "...",
  "subject" : "...",
  "issuer" : "...",
  "notBefore" : 12345,
  "notAfter" : 12345,
  "createdOn" : 12345,
  "createdBy" : 12345,
  "modifiedOn" : 12345,
  "modifiedBy" : 12345,
  "name" : "...",
  "optlock" : 12345
}

DELETE /blockedCertificates/{blockedCertificateId}

Deletes the BlockedCertificate specified by the "blockedCertificateId" path parameter.

Request Parameters
name type description
blockedCertificateId path

Example

Request
DELETE /blockedCertificates/{blockedCertificateId}
Content-Type: */*

                
...
Response
HTTP/1.1 204 No Content

GET /blockedCertificates/{blockedCertificateId}

Returns the BlockedCertificate identified by the specified blockedCertificateId.

Example of query in CURL :
curl --user 'username:password' -k https://api-sandbox.everyware-cloud.com/v2/blockedCertificates/{blockedCertificateId}.xml | xmllint --format -

Request Parameters
name type description
blockedCertificateId path The BlockedCertificate ID of the BlockedCertificate requested.
Response Body
media type data type description
application/json BlockedCertificate (JSON) The BlockedCertificate requested.
application/xml blockedCertificate (XML)

Example

Request
GET /blockedCertificates/{blockedCertificateId}
Content-Type: */*
Accept: application/json

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

                
{
  "digest" : "...",
  "id" : 12345,
  "certificate" : "...",
  "accountId" : 12345,
  "version" : 12345,
  "serial" : "...",
  "algorithm" : "...",
  "subject" : "...",
  "issuer" : "...",
  "notBefore" : 12345,
  "notAfter" : 12345,
  "createdOn" : 12345,
  "createdBy" : 12345,
  "modifiedOn" : 12345,
  "modifiedBy" : 12345,
  "name" : "...",
  "optlock" : 12345
}