Application API Token Actions

https://api.losant.com/applications/APPLICATION_ID/tokens/API_TOKEN_ID

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

Delete

Deletes an API Token

Method And Url

DELETE https://api.losant.com/applications/APPLICATION_ID/tokens/API_TOKEN_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, applicationApiToken.*, or applicationApiToken.delete.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID associated with the application	575ec8687ae143cd83dc4a97
API_TOKEN_ID	ID associated with the API token	575ec7417ae143cd83dc4a95

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/tokens/API_TOKEN_ID

Successful Responses

Code	Type	Description
200	Success	If API token was successfully deleted

Error Responses

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

Get

Retrieves information on an API token

Method And Url

GET https://api.losant.com/applications/APPLICATION_ID/tokens/API_TOKEN_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.bounded, all.Application.read, all.Organization, all.Organization.bounded, all.Organization.read, all.User, all.User.bounded, all.User.read, applicationApiToken.*, or applicationApiToken.get.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID associated with the application	575ec8687ae143cd83dc4a97
API_TOKEN_ID	ID associated with the API token	575ec7417ae143cd83dc4a95

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/tokens/API_TOKEN_ID

Successful Responses

Code	Type	Description
200	API Token	API token information

Error Responses

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

Patch

Updates information about an API token

Method And Url

PATCH https://api.losant.com/applications/APPLICATION_ID/tokens/API_TOKEN_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, applicationApiToken.*, or applicationApiToken.patch.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID associated with the application	575ec8687ae143cd83dc4a97
API_TOKEN_ID	ID associated with the API token	575ec7417ae143cd83dc4a95

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 API Token Patch schema. For example, the following would be a valid body for this request:

{
  "name": "My Updated API Token",
  "status": "inactive"
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X PATCH \
    -d '{"name":"My Updated API Token","status":"inactive"}' \
    https://api.losant.com/applications/APPLICATION_ID/tokens/API_TOKEN_ID

Successful Responses

Code	Type	Description
200	API Token	Updated API token information

Error Responses

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

Schemas

API Token

Schema for a single API Token

API Token Schema

▶
(root){} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 19 keys
▶
id:{} 2 keys
▶
apiTokenId:{} 2 keys
▶
ownerId:{} 2 keys
▶
ownerType:{} 2 keys
▶
applicationId:{} 2 keys
▶
instanceId:{} 2 keys
▶
creatorId:{} 2 keys
▶
creatorType:{} 2 keys
▶
creatorName:{} 2 keys
▶
name:{} 3 keys
▶
description:{} 2 keys
▶
creationDate:{} 2 keys
▶
lastUpdated:{} 2 keys
▶
expirationDate:{} 2 keys
▶
defaultRole:{} 2 keys
▶
orgRoles:{} 3 keys
▶
scope:{} 2 keys
▶
status:{} 2 keys
▶
token:{} 2 keys

API Token Example

▶
(root){} 13 keys
id:"575ec7417ae143cd83dc4a95"
apiTokenId:"575ec7417ae143cd83dc4a95"
creatorId:"575ed70c7ae143cd83dc4aa9"
creatorType:"user"
ownerId:"575ec8687ae143cd83dc4a97"
ownerType:"application"
name:"My API Token"
creationDate:"2016-06-13T04:00:00.000Z"
lastUpdated:"2016-06-13T04:00:00.000Z"
expirationDate:"2017-06-13T04:00:00.000Z"
▶
scope:[] 1 item
status:"active"
token:"the_actual_token_string"

API Token Patch

Schema for the body of an API Token modification request

API Token Patch Schema

▶
(root){} 4 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 5 keys
▶
name:{} 3 keys
▶
description:{} 2 keys
▶
defaultRole:{} 2 keys
▶
orgRoles:{} 3 keys
▶
status:{} 2 keys
additionalProperties:false

API Token Patch Example

▶
(root){} 2 keys
name:"My Updated API Token"
status:"inactive"

Error

Schema for errors returned by the API

Error Schema

▶
(root){} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 3 keys
▶
type:{} 1 key
▶
message:{} 1 key
▶
validationErrors:{} 2 keys

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