Instance Custom Nodes Actions

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

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

Get

Returns the Custom Nodes for an instance

Method And Url

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

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.bounded, all.Instance.read, all.User, all.User.bounded, all.User.read, instanceCustomNodes.*, or instanceCustomNodes.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, id, creationDate, lastUpdated	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		`filterField=key`
filter	N	Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.		`filter=my*node`

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/nodes

Successful Responses

Code	Type	Description
200	Instance Custom Nodes	Collection of Custom Nodes

Error Responses

Code	Type	Description
400	Error	Error if malformed request

Post

Create a new Custom Node for an instance

Method And Url

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

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.bounded, all.User, all.User.bounded, instanceCustomNodes.*, or instanceCustomNodes.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 Instance Custom Node Post schema. For example, the following would be a valid body for this request:

{
  "name": "My New Instance Custom Node",
  "description": "Description of my new instance custom node",
  "triggers": [
    {
      "type": "customNodeStart",
      "meta": {
        "category": "trigger",
        "name": "customNodeStart"
      }
    }
  ],
  "nodes": [
    {
      "type": "CustomNodeCapNode",
      "meta": {
        "name": "CustomNodeCapNode"
      }
    }
  ]
}

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 Instance Custom Node","description":"Description of my new instance custom node","triggers":[{"type":"customNodeStart","meta":{"category":"trigger","name":"customNodeStart"}}],"nodes":[{"type":"CustomNodeCapNode","meta":{"name":"CustomNodeCapNode"}}]}' \
    https://api.losant.com/instances/INSTANCE_ID/nodes

Successful Responses

Code	Type	Description
201	Instance Custom Node	The successfully created Custom Node

Error Responses

Code	Type	Description
400	Error	Error if malformed request

Schemas

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 keystype:"NotFound"
message:"Application was not found"