Default

View root of System hierarchy

get

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful Response

application/json

Responseany

get

/api/v3/system

HTTPcURLJavaScriptPython

GET /api/v3/system HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful Response

No content

Bulk update root of System hierarchy

put

Bulk update the root of the System hierarchy.

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

or

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

put

/api/v3/system

HTTPcURLJavaScriptPython

PUT /api/v3/system HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

No content

Get Attribute

get

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

pathstringRequired

attr_namestringRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/api/v3/system/{path}/attr/{attr_name}

HTTPcURLJavaScriptPython

GET /api/v3/system/{path}/attr/{attr_name} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Set Attribute

put

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

pathstringRequired

attr_namestringRequired

Body

application/json

anyOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

put

/api/v3/system/{path}/attr/{attr_name}

HTTPcURLJavaScriptPython

PUT /api/v3/system/{path}/attr/{attr_name} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*

No content

Get Node

get

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

pathstringRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/api/v3/system/{path}

HTTPcURLJavaScriptPython

GET /api/v3/system/{path} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Bulk update attributes on a component

put

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

pathstringRequired

Body

application/json

or

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

put

/api/v3/system/{path}

HTTPcURLJavaScriptPython

PUT /api/v3/system/{path} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

No content

Delete a component node

delete

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

pathstringRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

delete

/api/v3/system/{path}

HTTPcURLJavaScriptPython

DELETE /api/v3/system/{path} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Invoke a method on the root component

post

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

method_namestringRequired

Body

application/json

or

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/api/v3/system/method/{method_name}

HTTPcURLJavaScriptPython

POST /api/v3/system/method/{method_name} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

No content

Invoke a method on a component

post

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

pathstringRequired

method_namestringRequired

Body

application/json

or

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/api/v3/system/{path}/method/{method_name}

HTTPcURLJavaScriptPython

POST /api/v3/system/{path}/method/{method_name} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

No content