Access Key Actions

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

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

Delete

Deletes an applicationKey

Method And Url

DELETE https://api.app.wnology.io/applications/APPLICATION_ID/keys/APPLICATION_KEY_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.Organization, all.User, applicationKey.*, or applicationKey.delete.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID associated with the application	575ec8687ae143cd83dc4a97
APPLICATION_KEY_ID	ID associated with the applicationKey	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.app.wnology.io/applications/APPLICATION_ID/keys/APPLICATION_KEY_ID

Successful Responses

Code	Type	Description
200	Success	If applicationKey was successfully deleted

Error Responses

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

Get

Retrieves information on an applicationKey

Method And Url

GET https://api.app.wnology.io/applications/APPLICATION_ID/keys/APPLICATION_KEY_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.read, all.Organization, all.Organization.read, all.User, all.User.read, applicationKey.*, or applicationKey.get.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID associated with the application	575ec8687ae143cd83dc4a97
APPLICATION_KEY_ID	ID associated with the applicationKey	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.app.wnology.io/applications/APPLICATION_ID/keys/APPLICATION_KEY_ID

Successful Responses

Code	Type	Description
200	Application Key	applicationKey information

Error Responses

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

Patch

Updates information about an applicationKey

Method And Url

PATCH https://api.app.wnology.io/applications/APPLICATION_ID/keys/APPLICATION_KEY_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.Organization, all.User, applicationKey.*, or applicationKey.patch.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID associated with the application	575ec8687ae143cd83dc4a97
APPLICATION_KEY_ID	ID associated with the applicationKey	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 Key Patch schema. For example, the following would be a valid body for this request:

{
  "status": "active",
  "description": "An example updated key 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 key description"}' \
    https://api.app.wnology.io/applications/APPLICATION_ID/keys/APPLICATION_KEY_ID

Successful Responses

Code	Type	Description
200	Application Key	Updated applicationKey information

Error Responses

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

Schemas

Application Key

Schema for a single Application Key

Application Key Schema

▶
(root){} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 20 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
▶
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 Example

▶
(root){} 11 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"
description:"An example key description"
filterType:"all"
pubTopics:[] 0 items
subTopics:[] 0 items

Application Key Patch

Schema for the body of an Application Key modification request

Application Key Patch Schema

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

Application Key Patch Example

▶
(root){} 2 keys
status:"active"
description:"An example updated key 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:{} 2 keys
▶
type:{} 1 key
▶
message:{} 1 key

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