Access Keys Actions

https://api.app.wnology.io/applications/APPLICATION_ID/keys

Below are the various requests that can be performed against the Access 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.app.wnology.io/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.bounded, all.Application.read, all.Organization, all.Organization.bounded, all.Organization.read, all.User, all.User.bounded, 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, name	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, name		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.app.wnology.io/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.app.wnology.io/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.bounded, all.Organization, all.Organization.bounded, all.User, all.User.bounded, 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.app.wnology.io/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

Schemas

Advanced Application Key Query

Schema for advanced application key queries

Advanced Application Key Query Schema

▶
(root){} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 17 keys
▶
$and:{} 3 keys
▶
$or:{} 3 keys
▶
$nor:{} 3 keys
▶
id:{} 1 key
▶
creationDate:{} 1 key
▶
lastUpdated:{} 1 key
▶
status:{} 1 key
▶
deviceIds:{} 1 key
▶
deviceTags:{} 1 key
▶
key:{} 1 key
▶
name:{} 1 key
▶
description:{} 1 key
▶
filterType:{} 1 key
▶
pubTopics:{} 1 key
▶
subTopics:{} 1 key
▶
addressFilterType:{} 1 key
▶
addresses:{} 1 key

Advanced Application Key Query Example

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

Application Key Post

Schema for the body of an Application Key creation request

Application Key Post Schema

▶
(root){} 4 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 9 keys
▶
deviceIds:{} 3 keys
▶
deviceTags:{} 3 keys
▶
name:{} 3 keys
▶
description:{} 2 keys
▶
filterType:{} 1 key
▶
pubTopics:{} 2 keys
▶
subTopics:{} 2 keys
▶
addressFilterType:{} 2 keys
▶
addresses:{} 3 keys
additionalProperties:false

Application Key Post Example

▶
(root){} 4 keys
description:"An example new key description"
filterType:"all"
pubTopics:[] 0 items
subTopics:[] 0 items

Application Key Post Response

Schema for a response of Application Key creation

Application Key Post Response Schema

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

Application Key Post Response Example

▶
(root){} 12 keys
id:"575ec76c7ae143cd83dc4a96"
applicationKeyId:"575ec76c7ae143cd83dc4a96"
applicationId:"575ec8687ae143cd83dc4a97"
creationDate:"2016-06-13T04:00:00.000Z"
lastUpdated:"2016-06-13T04:00:00.000Z"
key:"this_would_be_the_key"
status:"active"
secret:"shhhSecret"
description:"An example key description"
filterType:"all"
pubTopics:[] 0 items
subTopics:[] 0 items

Application Keys

Schema for a collection of Application Keys

Application Keys 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 Keys 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:{} 2 keys
▶
type:{} 1 key
▶
message:{} 1 key

Error Example

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