AllowedCertificates

The following resources are applicable:

/allowedCertificates

Mount Point: /v2/allowedCertificates

The following operations are supported on this resource:

GET

Returns the list of all the AllowedCertificate.

If the flag AllowedCertificatesResult.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 AllowedCertificates:

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

AllowedCertificatesResult 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(AllowedCertificatesResult.class);
offset += limit;
} while (result.isLimitExceeded()):

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

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: allowedCerticatesResult
media types: application/xml
application/json

The list of requested AllowedCertificates.

POST

Creates a new AllowedCertificate based on the information provided in AllowedCertificateCreator parameter.

Request Body

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

Provides the information for the new AllowedCertificate to be created.

Response Body

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

The newly created AllowedCertificate.

PUT

Updates the AllowedCertificate provided in the request body.

Request Body

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

The modified AllowedCertificate whose attributes need to be updated.

Response Body

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

The updated AllowedCertificate.

/allowedCertificates/{allowedCertificateId}

Mount Point: /v2/allowedCertificates/{allowedCertificateId}

GET

Returns the AllowedCertificate identified by the specified allowedCertificateId.

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

Parameters

name description type default
allowedCertificateId The AllowedCertificate ID of the AllowedCertificate requested. path

Response Body

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

The AllowedCertificate requested.

DELETE

Deletes the AllowedCertificate specified by the "allowedCertificateId" path parameter.

Parameters

name description type default
allowedCertificateId The id of the AllowedCertificate to be deleted. path

/allowedCertificates/install/{allowedCertificateId}

Mount Point: /v2/allowedCertificates/install/{allowedCertificateId}

POST

try to install the AllowedCertificate specified by the "allowedCertificateId" path parameter into the message broker truststore.

Parameters

name description type default
allowedCertificateId The id of the AllowedCertificate to be installed. path

/allowedCertificates/revoke/{allowedCertificateId}

Mount Point: /v2/allowedCertificates/revoke/{allowedCertificateId}

POST

revoke the AllowedCertificate specified by the "allowedCertificateId" path parameter.

Parameters

name description type default
allowedCertificateId The id of the AllowedCertificate to be revoked. path

Response Body

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

(no documentation provided)

/allowedCertificates/revokedList

Mount Point: /v2/allowedCertificates/revokedList

GET

Returns the list of all the revoked AllowedCertificate.

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: allowedCerticatesResult
media types: application/xml
application/json

The list of requested revoked AllowedCertificates.