Application Keys Actions

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

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

Get

Returns the applicationKeys for an application

Method And Url

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

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.read, all.Organization, all.Organization.read, all.User, all.User.read, applicationKeys.*, or applicationKeys.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: key, status, id, creationDate, lastUpdated creationDate sortField=creationDate
sortDirection N Direction to sort the results by. Accepted values are: asc, desc desc 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: key, status filterField=key
filter N Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. filter=the*key
query N Application key filter JSON object which overrides the filterField and filter parameters. See Advanced Application Key Query for more details. query={”$nor”:[{”id”:”575ec8687ae143cd83dc4a97”},{”description”:”my access key”},{”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/keys

Successful Responses

Code Type Description
200 Application Keys Collection of applicationKeys

Error Responses

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

Post

Create a new applicationKey for an application

Method And Url

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

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.Organization, all.User, applicationKeys.*, or applicationKeys.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 Key Post schema. For example, the following would be a valid body for this request:

{
  "description": "An example new key description",
  "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 key description","filterType":"all","pubTopics":[],"subTopics":[]}' \
    https://api.losant.com/applications/APPLICATION_ID/keys

Successful Responses

Code Type Description
201 Application Key Post Response Successfully created applicationKey

Error Responses

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

Was this page helpful?

Still looking for help? You can also search the Losant Forums or submit your question there.