Ctrlk
HomeSign UpGithub
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Glob APIs

Glob are fast key value stores which could be controlled to change the simulation behavior.

Glob APIs could be used in the template to access the global key-value store. These values are useful to enable interaction between templates and control the behaviour of simulation through the user.

Create a new Glob entry or update an existing Glob entry

POST https://nsim.iotify.io/api/datastore/:workspaceId/glob

This endpoint allows you to create/update a Glob entry

Path Parameters

Name
Type
Description

workspaceId*

String

The Workspace ID where the Glob is

Headers

Name
Type
Description

Content-Type*

String

application/json

domain*

String

The domain under which your account exists

key *

String

API token for the account

Request Body

Name
Type
Description

key*

String

The key for the Glob entry

value*

String

The value for the Glob entry

true
{
    // Response
}
// Example curl command

curl -X POST -H "Accept: application/json" -H "Content-Type: application/json" -H "key:$KEY" -H "domain:nsim.iotify.io" -d '{"key":"$GLOBKEY","value":"$GLOBVALUE"}' nsim.iotify.io/api/datastore/$WORKSPACE/glob

Get a Glob object

GET https://nsim.iotify.io/api/datastore/:workspaceId/glob/item/:globKey

Path Parameters

Name
Type
Description

workspaceId*

string

The workspace ID for the workspace where the Glob is present

globKey*

String

The key for the glob entry to be fetched

Headers

Name
Type
Description

key*

string

API token for the account

Content-Type*

String

application/json

domain*

String

The domain under which your account exists

Get all the Glob keys

GET nsim.iotify.io/api/datastore/:workspaceId/glob/keys

Path Parameters

Name
Type
Description

workspaceId*

String

The workspace ID for the workspace where the Glob is present

Headers

Name
Type
Description

Content-Type*

String

application/json

domain*

String

The domain under which your account exists

key*

String

API token for the account

Glob Delete

DELETE nsim.iotify.io/api/datastore/:workspaceId/glob/item/:globKey

Deletes the key value pair of the glob

Path Parameters

Name
Type
Description

globKey*

string

The key for the glob entry to be deleted

workspaceId*

String

The workspace ID for the workspace where the Glob is present

Headers

Name
Type
Description

Content-Type

string

application/json

key

String

API token for the account

domain

String

The domain under which your account exists

PreviousSimulation APINextMetrics API

Last updated

Was this helpful?