Application 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 Application 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

Request Headers

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

Error Responses

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

Request Headers

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

Error Responses

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

Request Headers

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

Error Responses