Device Certificate Actions

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

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

Delete

Deletes an application certificate

Method And Url

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

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, applicationCertificate.*, or applicationCertificate.delete.

Request Path Components

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

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 DELETE \
    https://api.losant.com/applications/APPLICATION_ID/certificates/APPLICATION_CERTIFICATE_ID

Successful Responses

Code	Type	Description
200	Success	If application certificate was successfully deleted

Error Responses

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

Get

Retrieves information on an application certificate

Method And Url

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

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, applicationCertificate.*, or applicationCertificate.get.

Request Path Components

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

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/APPLICATION_CERTIFICATE_ID

Successful Responses

Code	Type	Description
200	Application Certificate	Application certificate information

Error Responses

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

Patch

Updates information about an application certificate

Method And Url

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

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, applicationCertificate.*, or applicationCertificate.patch.

Request Path Components

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

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 Patch schema. For example, the following would be a valid body for this request:

{
  "status": "active",
  "description": "An example updated certificate description"
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X PATCH \
    -d '{"status":"active","description":"An example updated certificate description"}' \
    https://api.losant.com/applications/APPLICATION_ID/certificates/APPLICATION_CERTIFICATE_ID

Successful Responses

Code	Type	Description
200	Application Certificate	Updated application certificate information

Error Responses

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

Schemas

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 Patch

Schema for the body of an Application Certificate modification request

Application Certificate Patch Schema

▶
(root){} 4 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
additionalProperties:false

Application Certificate Patch Example

▶
(root){} 2 keys
status:"active"
description:"An example updated certificate description"

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"

Success

Schema for reporting a successful operation

Success Schema

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

Success Example

▶
(root){} 1 key
success:true