BlockedCertificates

The following resources are applicable:

/blockedCertificates

Mount Point: /v2/blockedCertificates

The following operations are supported on this resource:

GET

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

Parameters

name description type default
limit Maximum number of entries to be returned. Note that an error will be returned if the maximum allowed value is exceeded. query 50
offset Starting offset for the entries to be returned. Note that an error will be returned if the maximum allowed value is exceeded. query 0

Response Body

element: blockedCerticatesResult
media types: application/xml
application/json

The list of requested BlockedCertificates.

POST

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

Request Body

element: blockedCertificateCreator
media types: application/xml
application/json

Provides the information for the new BlockedCertificate to be created.

Response Body

element: BlockedCertificate
media types: application/xml
application/json

The newly created BlockedCertificate.

PUT

Updates the BlockedCertificate provided in the request body.

Request Body

element: BlockedCertificate
media types: application/xml
application/json

The modified BlockedCertificate whose attributes need to be updated.

Response Body

element: BlockedCertificate
media types: application/xml
application/json

The updated BlockedCertificate.

/blockedCertificates/{blockedCertificateId}

Mount Point: /v2/blockedCertificates/{blockedCertificateId}

GET

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 -

Parameters

name description type default
blockedCertificateId The BlockedCertificate ID of the BlockedCertificate requested. path

Response Body

element: BlockedCertificate
media types: application/xml
application/json

The BlockedCertificate requested.

DELETE

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

Parameters

name description type default
blockedCertificateId (no documentation provided) path