Application Key Actions

https://api.losant.com/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.losant.com/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
APPLICATIONKEYID 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.losant.com/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.losant.com/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
APPLICATIONKEYID 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.losant.com/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.losant.com/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
APPLICATIONKEYID 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.losant.com/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