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

Was this page helpful?

Still looking for help? You can also search the Losant Forums or submit your question there.