DeviceMgmtPkis

The following resources are applicable:

/deviceMgmtPkis

Mount Point: /v2/deviceMgmtPkis

The following operations are supported on this resource:

GET

Returns the list of all the DeviceMgmtPki.

If the flag DeviceMgmtPkisResult.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 DeviceMgmtPkis:

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

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

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

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

The list of requested DeviceMgmtPkis.

POST

Creates a new DeviceMgmtPki based on the information provided in DeviceMgmtPkiCreator parameter. *

Example of query in CURL (PLEASE note the --data-binary option):
curl -X PUT --data-binary \@DeviceMgmtPkiFile.xml -H "Content-type:application/xml" --user 'username:password' -k https://api-sandbox.everyware-cloud.com/v2/deviceMgmtPkis

Request Body

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

Provides the information for the new DeviceMgmtPki to be created.

Response Body

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

The newly created DeviceMgmtPki.

PUT

Updates the DeviceMgmtPki provided in the request body. * Example of query in CURL (PLEASE note the --data-binary option):
curl -X PUT --data-binary \@DeviceMgmtPkiCreatorFile.xml -H "Content-type:application/xml" --user 'username:password' -k https://api-sandbox.everyware-cloud.com/v2/deviceMgmtPkis

Request Body

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

The modified DeviceMgmtPki whose attributes need to be updated.

Response Body

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

The updated DeviceMgmtPki.

/deviceMgmtPkis/{deviceMgmtPkiId}

Mount Point: /v2/deviceMgmtPkis/{deviceMgmtPkiId}

GET

Returns the DeviceMgmtPki identified by the specified deviceMgmtPkiId.

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

Parameters

name description type default
deviceMgmtPkiId The DeviceMgmtPki ID of the DeviceMgmtPki requested. path

Response Body

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

The DeviceMgmtPki requested.

DELETE

Deletes the DeviceMgmtPki specified by the "deviceMgmtPki" path parameter.

Parameters

name description type default
deviceMgmtPkiId (no documentation provided) path

/deviceMgmtPkis/certificatesChain/{deviceMgmtPkiId}

Mount Point: /v2/deviceMgmtPkis/certificatesChain/{deviceMgmtPkiId}

GET

Returns the chain, up to the root certification authority, related to the DeviceMgmtPki identified by deviceMgmtPkiId

Parameters

name description type default
deviceMgmtPkiId The id of the DeviceMgmtPki leaf of the chain path

Response Body

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

The list of requested DeviceMgmtPkis.

/deviceMgmtPkis/certificatesTree/{deviceMgmtPkiId}

Mount Point: /v2/deviceMgmtPkis/certificatesTree/{deviceMgmtPkiId}

GET

Returns the list of all the DeviceMgmPkis that are son of a the DeviceMgmtPki identified by deviceMgmtPkiId

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
deviceMgmtPkiId The id of the DeviceMgmtPki root of the tree path

Response Body

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

The list of requested DeviceMgmtPkis.

/deviceMgmtPkis/defaultPki

Mount Point: /v2/deviceMgmtPkis/defaultPki

GET

Returns the DeviceMgmtPki used as default to sign the command message by the platform

Response Body

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

The default DeviceMgmtPkis.

/deviceMgmtPkis/findCAs

Mount Point: /v2/deviceMgmtPkis/findCAs

GET

Returns the list of all the DeviceMgmtPki that are Certification Authority.

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

The list of requested Certification Authority DeviceMgmtPkis.

/deviceMgmtPkis/findNotCAs

Mount Point: /v2/deviceMgmtPkis/findNotCAs

GET

Returns the list of all the DeviceMgmtPki that aren't Certification Authority.

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

The list of requested DeviceMgmtPkis.

/deviceMgmtPkis/revokedList

Mount Point: /v2/deviceMgmtPkis/revokedList

GET

Returns the list of all the revoked DeviceMgmtPki.

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

The list of requested revoked DeviceMgmtPkis.