Device Certificates Actions

https://api.losant.com/applications/APPLICATION_ID/certificates

Below are the various requests that can be performed against the Device Certificates resource, as well as the expected parameters and the potential responses.

Get

Returns the application certificates for an application

Method And Url

GET https://api.losant.com/applications/APPLICATION_ID/certificates

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Application, all.Application.bounded, all.Application.read, all.Organization, all.Organization.bounded, all.Organization.read, all.User, all.User.bounded, all.User.read, applicationCertificates.*, or applicationCertificates.get.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID associated with the application	575ec8687ae143cd83dc4a97

Request Query Parameters

Name	Required	Description	Default	Example
sortField	N	Field to sort the results by. Accepted values are: name, certificateInfo.commonName, status, id, creationDate, lastUpdated	certificateInfo.commonName	sortField=status
sortDirection	N	Direction to sort the results by. Accepted values are: asc, desc	asc	sortDirection=asc
page	N	Which page of results to return	0	page=0
perPage	N	How many items to return per page	100	perPage=10
filterField	N	Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name, certificateInfo.commonName, status		filterField=status
filter	N	Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.		filter=the*status
query	N	Application certificate filter JSON object which overrides the filterField and filter parameters. See Advanced Application Certificate Query for more details.		query={"$nor":[{"id":"575ec8687ae143cd83dc4a97"},{"lastUpdated":{"$lt":1612189931000}}]}

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X GET \
    https://api.losant.com/applications/APPLICATION_ID/certificates

Successful Responses

Code	Type	Description
200	Application Certificates	Collection of application certificates

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if application was not found

Post

Create a new application certificate for an application

Method And Url

POST https://api.losant.com/applications/APPLICATION_ID/certificates

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Application, all.Application.bounded, all.Organization, all.Organization.bounded, all.User, all.User.bounded, applicationCertificates.*, or applicationCertificates.post.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID associated with the application	575ec8687ae143cd83dc4a97

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Request Body

The body of the request should be serialized JSON that validates against the Application Certificate Post schema. For example, the following would be a valid body for this request:

{
  "description": "An example new certificate description",
  "certificate": "-----BEGIN CERTIFICATE-----\nMY_SSL_CERTIFICATE\n-----END CERTIFICATE-----",
  "filterType": "all",
  "pubTopics": [],
  "subTopics": []
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X POST \
    -d '{"description":"An example new certificate description","certificate":"-----BEGIN CERTIFICATE-----\nMY_SSL_CERTIFICATE\n-----END CERTIFICATE-----","filterType":"all","pubTopics":[],"subTopics":[]}' \
    https://api.losant.com/applications/APPLICATION_ID/certificates

Successful Responses

Code	Type	Description
201	Application Certificate	Successfully created application certificate

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if application was not found

Schemas

Advanced Application Certificate Query

Schema for advanced application certificate queries

Advanced Application Certificate Query Schema

▶
(root){} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 21 keys
▶
$and:{} 3 keys
▶
$or:{} 3 keys
▶
$nor:{} 3 keys
▶
id:{} 1 key
▶
name:{} 1 key
▶
creationDate:{} 1 key
▶
lastUpdated:{} 1 key
▶
status:{} 1 key
▶
filterType:{} 1 key
▶
pubTopics:{} 1 key
▶
subTopics:{} 1 key
▶
addressFilterType:{} 1 key
▶
addresses:{} 1 key
▶
deviceId:{} 1 key
▶
serialNumber:{} 1 key
▶
fingerprint:{} 1 key
▶
commonName:{} 1 key
▶
issuerName:{} 1 key
▶
issuerSerialNumber:{} 1 key
▶
notValidBefore:{} 1 key
▶
notValidAfter:{} 1 key

Advanced Application Certificate Query Example

▶
(root){} 1 key
▶
$nor:[] 2 items

Application Certificate

Schema for a single Application Certificate

Application Certificate Schema

▶
(root){} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 21 keys
▶
id:{} 2 keys
▶
applicationId:{} 2 keys
▶
creationDate:{} 2 keys
▶
lastUpdated:{} 2 keys
▶
createdById:{} 2 keys
▶
createdByType:{} 2 keys
▶
lastUpdatedById:{} 2 keys
▶
lastUpdatedByType:{} 2 keys
▶
status:{} 2 keys
▶
description:{} 2 keys
▶
name:{} 3 keys
▶
filterType:{} 1 key
▶
pubTopics:{} 2 keys
▶
subTopics:{} 2 keys
▶
addressFilterType:{} 2 keys
▶
addresses:{} 3 keys
▶
applicationCertificateId:{} 2 keys
▶
deviceId:{} 2 keys
▶
deviceName:{} 3 keys
▶
certificateInfo:{} 2 keys
▶
certificate:{} 3 keys

Application Certificate Example

▶
(root){} 11 keys
id:"5cd02a50df66feb0994c7196"
applicationCertificateId:"5cd02a50df66feb0994c7196"
applicationId:"575ec8687ae143cd83dc4a97"
creationDate:"2016-06-13T04:00:00.000Z"
lastUpdated:"2016-06-13T04:00:00.000Z"
status:"active"
description:"An example certificate description"
▶
certificateInfo:{} 6 keys
filterType:"none"
pubTopics:[] 0 items
subTopics:[] 0 items

Application Certificate Post

Schema for the body of an Application Certificate creation request

Application Certificate Post Schema

▶
(root){} 5 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 10 keys
▶
status:{} 2 keys
▶
description:{} 2 keys
▶
name:{} 3 keys
▶
filterType:{} 1 key
▶
pubTopics:{} 2 keys
▶
subTopics:{} 2 keys
▶
addressFilterType:{} 2 keys
▶
addresses:{} 3 keys
▶
deviceId:{} 2 keys
▶
certificate:{} 3 keys
▶
required:[] 1 item
additionalProperties:false

Application Certificate Post Example

▶
(root){} 5 keys
description:"An example new certificate description"
certificate:"-----BEGIN CERTIFICATE-----
MY_SSL_CERTIFICATE
-----END CERTIFICATE-----"
filterType:"all"
pubTopics:[] 0 items
subTopics:[] 0 items

Application Certificates

Schema for a collection of Application Certificates

Application Certificates Schema

▶
(root){} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 10 keys
▶
items:{} 2 keys
▶
count:{} 1 key
▶
totalCount:{} 1 key
▶
perPage:{} 1 key
▶
page:{} 1 key
▶
filter:{} 1 key
▶
filterField:{} 1 key
▶
sortField:{} 1 key
▶
sortDirection:{} 2 keys
▶
applicationId:{} 2 keys

Application Certificates Example

▶
(root){} 8 keys
▶
items:[] 1 item
count:1
totalCount:4
perPage:1
page:0
sortField:"key"
sortDirection:"asc"
applicationId:"575ec8687ae143cd83dc4a97"

Error

Schema for errors returned by the API

Error Schema

▶
(root){} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 3 keys
▶
type:{} 1 key
▶
message:{} 1 key
▶
validationErrors:{} 2 keys

Error Example

▶
(root){} 2 keys
type:"NotFound"
message:"Application was not found"