Instance API Tokens Actions

https://api.losant.com/instances/INSTANCE_ID/tokens

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

Get

Returns the API tokens for an instance

Method And Url

GET https://api.losant.com/instances/INSTANCE_ID/tokens

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Instance, all.Instance.read, all.User, all.User.read, instanceApiTokens.*, or instanceApiTokens.get.

Request Path Components

Path Component	Description	Example
INSTANCE_ID	ID associated with the instance	575ec7417ae143cd83dc4a96

Request Query Parameters

Name	Required	Description	Default	Example
sortField	N	Field to sort the results by. Accepted values are: name, status, id, creationDate, lastUpdated, expirationDate	name	sortField=name
sortDirection	N	Direction to sort the results by. Accepted values are: asc, desc	asc	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: name, status		filterField=key
filter	N	Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.		filter=my*token

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/instances/INSTANCE_ID/tokens

Successful Responses

Code	Type	Description
200	API Token	Collection of API tokens

Error Responses

Code	Type	Description
400	Error	Error if malformed request

Post

Create a new API token for an instance

Method And Url

POST https://api.losant.com/instances/INSTANCE_ID/tokens

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Instance, all.User, instanceApiTokens.*, or instanceApiTokens.post.

Request Path Components

Path Component	Description	Example
INSTANCE_ID	ID associated with the instance	575ec7417ae143cd83dc4a96

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

{
  "name": "My New API Token",
  "expirationDate": "2017-06-13T04:00:00.000Z",
  "scope": [
    "all.Application"
  ],
  "status": "active"
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X POST \
    -d '{"name":"My New API Token","expirationDate":"2017-06-13T04:00:00.000Z","scope":["all.Application"],"status":"active"}' \
    https://api.losant.com/instances/INSTANCE_ID/tokens

Successful Responses

Code	Type	Description
201	API Token	The successfully created API token

Error Responses

Code	Type	Description
400	Error	Error if malformed request

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:{} 15 keys
▶
id:{} 2 keys
▶
apiTokenId:{} 2 keys
▶
ownerId:{} 2 keys
▶
ownerType:{} 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
▶
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 Post

Schema for the body of an API Token creation request

API Token Post Schema

▶
root:{} 5 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 5 keys
▶
name:{} 3 keys
▶
description:{} 2 keys
▶
expirationDate:{} 2 keys
▶
scope:{} 3 keys
▶
status:{} 2 keys
additionalProperties:false
▶
required:[] 1 item

API Token Post Example

▶
root:{} 4 keys
name:"My New API Token"
expirationDate:"2017-06-13T04:00:00.000Z"
▶
scope:[] 1 item
status:"active"

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"