Keyword Controller | Version 2022

get

Authorizations

ins_access_tokenstringRequired

Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the ins_refresh_token cookie at the /refresh endpoint.

X-SpacestringRequired

Required active space header

Path parameters

keywordIdstringRequired

Responses

200

OK

*/*

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

get

/api/keywords/{keywordId}

GET /api/keywords/{keywordId} HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

{
  "creationDate": "2025-11-22T23:41:24.665Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-11-22T23:41:24.665Z",
  "id": "text",
  "key": "text",
  "dsc": "text",
  "type": "Logs Activity",
  "active": true,
  "props": "text"
}

put

Authorizations

ins_access_tokenstringRequired

Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the ins_refresh_token cookie at the /refresh endpoint.

X-SpacestringRequired

Required active space header

Path parameters

keywordIdstringRequired

Body

creationDatestring · date-timeRead-onlyOptional

lastModifiedBystringRead-onlyOptional

createdBystringRead-onlyOptional

lastModifiedDatestring · date-timeRead-onlyOptional

idstringOptional

keystring · max: 100Required

dscstring · max: 255Optional

typestring · enumRequiredPossible values:

activebooleanOptional

propsstringOptional

Responses

204

No Content

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

put

/api/keywords/{keywordId}

PUT /api/keywords/{keywordId} HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 91

{
  "id": "text",
  "key": "text",
  "dsc": "text",
  "type": "Logs Activity",
  "active": true,
  "props": "text"
}

No content

delete

Authorizations

ins_access_tokenstringRequired

Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the ins_refresh_token cookie at the /refresh endpoint.

X-SpacestringRequired

Required active space header

Path parameters

keywordIdstringRequired

Responses

204

No Content

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

delete

/api/keywords/{keywordId}

DELETE /api/keywords/{keywordId} HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

No content

get

Authorizations

ins_access_tokenstringRequired

Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the ins_refresh_token cookie at the /refresh endpoint.

X-SpacestringRequired

Required active space header

Responses

200

OK

*/*

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

get

/api/keywords

GET /api/keywords HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

[
  {
    "creationDate": "2025-11-22T23:41:24.665Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-11-22T23:41:24.665Z",
    "id": "text",
    "key": "text",
    "dsc": "text",
    "type": "Logs Activity",
    "active": true,
    "props": "text"
  }
]

post

Authorizations

ins_access_tokenstringRequired

Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the ins_refresh_token cookie at the /refresh endpoint.

X-SpacestringRequired

Required active space header

Body

creationDatestring · date-timeRead-onlyOptional

lastModifiedBystringRead-onlyOptional

createdBystringRead-onlyOptional

lastModifiedDatestring · date-timeRead-onlyOptional

idstringOptional

keystring · max: 100Required

dscstring · max: 255Optional

typestring · enumRequiredPossible values:

activebooleanOptional

propsstringOptional

Responses

200

OK

*/*

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

post

/api/keywords

POST /api/keywords HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 91

{
  "id": "text",
  "key": "text",
  "dsc": "text",
  "type": "Logs Activity",
  "active": true,
  "props": "text"
}

{
  "creationDate": "2025-11-22T23:41:24.665Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-11-22T23:41:24.665Z",
  "id": "text",
  "key": "text",
  "dsc": "text",
  "type": "Logs Activity",
  "active": true,
  "props": "text"
}

post

Authorizations

ins_access_tokenstringRequired

Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the ins_refresh_token cookie at the /refresh endpoint.

X-SpacestringRequired

Required active space header

Query parameters

Body

filestring · binaryRequired

Responses

200

OK

*/*

Responseobject

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

post

/api/keywords/import

POST /api/keywords/import HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "file": "binary"
}

{}

get

Authorizations

ins_access_tokenstringRequired

Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the ins_refresh_token cookie at the /refresh endpoint.

X-SpacestringRequired

Required active space header

Query parameters

typestringRequired

Responses

200

OK

*/*

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

get

/api/keywords/type

GET /api/keywords/type?type=text HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

[
  {
    "creationDate": "2025-11-22T23:41:24.665Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-11-22T23:41:24.665Z",
    "id": "text",
    "key": "text",
    "dsc": "text",
    "type": "Logs Activity",
    "active": true,
    "props": "text"
  }
]

get

Authorizations

ins_access_tokenstringRequired

Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the ins_refresh_token cookie at the /refresh endpoint.

X-SpacestringRequired

Required active space header

Query parameters

projectIdstringOptional

includeIdsbooleanOptionalDefault: false

Responses

200

OK

*/*

Responseobject

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

get

/api/keywords/export

GET /api/keywords/export HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

{}

delete

Authorizations

ins_access_tokenstringRequired

Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the ins_refresh_token cookie at the /refresh endpoint.

X-SpacestringRequired

Required active space header

Query parameters

keywordIdsstring[]Required

Responses

204

No Content

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

delete

/api/keywords/multi/by-ids

DELETE /api/keywords/multi/by-ids?keywordIds=text HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

No content