Working with Activeboards using the API
Borja Moro Moreno (Deactivated)
Former user (Deleted)
Former user (Deleted)
Overview
Check the list of available endpoints and methods in the Activeboards API:
Endpoints and methods | Description |
|---|
Endpoints and methods | Description |
|---|---|
status:GET | Get general information about all the Activeboards in a domain. |
status:GET | Get detailed information about a specific Activeboard. |
status:GET | Get general information about the Activeboard set as default. |
status:POST | Create a new Activeboard. |
status:POST | Clone an Activeboard. |
status:PUT | Update an Activeboard. |
status:PATCH | Modify the scope of access of an Activeboard. |
status:PATCH | Update the tags assigned to an Activeboard. |
status:PATCH | Mark or unmark an Activeboard as a favorite. |
status:PATCH | Mark or unmark an Activeboard as default. |
status:DELETe | Delete an Activeboard. |
Endpoints and methods
GET /activeboards
Get information about all the Activeboards in a domain. This does not return information about the widgets and content in the Activeboards, only general data.
To perform this request, your Devo user must have at least the Activeboards (view) permission assigned. Learn more about roles and permissions in Role permissions.
Example
Find below a request example in cURL language. This request will return all the Activeboards created in the domain that corresponds to the given token. Learn how to authorize your request in this article.
curl -H "standAloneToken:YOUR_TOKEN" -X GET "https://api-us.devo.com/activeboards/v2/activeboards"Code | Description |
|---|
Code | Description |
|---|---|
200 | Successful response. Activeboards' general information retrieved. [
{
"categories": null,
"name": "myActiveboard",
"description": "This is my test Activeboard",
"updateDate": 1678719854000,
"creationDate": 1678719854000,
"isPrivate": true,
"isDefault": false,
"favorite": true,
"editable": true,
"tags": [
"marketing"
],
"id": 34567,
"owner": {
"id": "1234-5678",
"email": "user@devo.com",
"username": "Firewall Investigator",
"userDomain": 12345
},
"version": 0
"schedules": []
},
{
"categories": null,
"name": "Firewall incidents",
"description": "Check potential firewall incidents",
"updateDate": 1666852847000,
"creationDate": 1619512103000,
"isPrivate": false,
"isDefault": false,
"favorite": true,
"editable": false,
"tags": null,
"id": 1234,
"owner": {
"id": "4567-5678",
"email": "user2@devo.com",
"username": "Firewall Investigator",
"userDomain": 14829
},
"version": 0
"schedules": []
}
] |
400 | Error in request. |
401 | Unauthorized request. |
403 | Forbidden request. |
405 | Method not allowed. |
500 | Server error and Java exception. |
GET /activeboards/{id}
Get detailed information about a specific Activeboard in a domain, including information about the widgets it contains.
To perform this request, your Devo user must have at least the Activeboards (view) permission assigned. Learn more about roles and permissions in Role permissions.
Path parameters
Add the following path parameters as part of the endpoint:
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
|
| Enter the ID of the Activeboard you want to get information about. How can I get the ID of an Activeboard? Activeboards IDs are not displayed in the Devo platform, so you should get them using the |
Example
Find below a request example in cURL language. This request will return information about the Activeboard with ID 1234 created in the domain that corresponds to the given token. Learn how to authorize your request in this article.
curl -H "standAloneToken:YOUR_TOKEN" -X GET "https://api-us.devo.com/activeboards/v2/activeboards/1234"Code | Description |
|---|
Code | Description |
|---|---|
200 | Successful response. The response includes information about the requested Activeboard and the widgets it includes. {
"categories": null,
"name": "Firewall Incidents",
"description": "Check potential firewall incidents",
"updateDate": 1678785145000,
"creationDate": 1619512103000,
"isPrivate": false,
"isDefault": false,
"favorite": true,
"editable": false,
"tags": null,
"id": 1234,
"owner": {
"id": "4567-5678",
"email": "user2@devo.com",
"username": "Firewall investigator",
"userDomain": 14829
},
"version": 0,
"schedules": [],
"settings": {
"name": "Firewall Incidents",
"description": "",
"type": "container",
"subtype": "Grid",
"datasource": null,
"definitions": null,
"date": {
"realTime": false,
"from": "now() - 7d",
"to": "now()"
},
"settings": {
"layout": {
"Voronoi0": {
"w": 5,
"h": 12,
"x": 0,
"y": 0,
"i": "Voronoi0",
"moved": false,
"static": false
}
},
"header": false
},
"extra": {
"favourites": {
"widgets": "Line",
"inputs": "Input",
"containers": "Grid"
},
"autoRefreshPeriod": null,
"config": {
"theme": {}
}
},
"children": {
"Voronoi0": {
"name": "Denied Firewall Traffic By Source Country",
"description": "In this graph we can see the distribution of rejected packets by Country, ISP, Destination IP, protocol, port and source",
"type": "widget",
"subtype": "Voronoi",
"datasource": "\n query(from firewall.all.traffic\n where isnotnull(dstService)\n where ispublic(srcIp)\n where action = \"reject\" or action = \"deny\"\n select countryname(mmcountry(srcIp)) as country\n select mmisp(srcIp) as isp\n group every - by country, isp, srcIp, proto, dstIp, dstService\n every -\n select count() as count\n where isnotnull(country))",
"definitions": null,
"date": {},
"settings": {
"rainbowStartColor": "hsla( 0, 100%, 50%, 1)",
"groupLabelFontStyle": "normal",
"groupBorderRadius": "0.15",
"groupLabelLightColor": "#fff",
"layout": "relaxed",
"groupLabelDarkColor": "#000",
"rainbowEndColor": "hsla(360, 100%, 50%, 1)",
"groupInsetWidth": "6",
"groupBorderWidth": "4",
"fields": {
"keys": [
"country",
"isp",
"proto",
"dstService",
"srcIp",
"dstIp"
],
"weight": "count"
},
"relaxationInitializer": "fisheye",
"stacking": "hierarchical",
"groupLabelFontWeight": "400"
},
"extra": {
"lastMetadata": [
{
"name": "country",
"type": "str"
},
{
"name": "isp",
"type": "str"
},
{
"name": "srcIp",
"type": "ip4"
},
{
"name": "proto",
"type": "str"
},
{
"name": "dstIp",
"type": "ip4"
},
{
"name": "dstService",
"type": "str"
},
{
"name": "count",
"type": "int8"
}
]
},
"children": null,
"version": 3
}
},
"version": 3
}
} |
401 | Unauthorized error. |
403 | Forbidden request. |
404 | Not found. |
405 | Method not allowed. |
500 | Server error and Java exception. |
GET /activeboards/default
Get information about the default Activeboard. This does not return information about the widgets and content in the Activeboard, only general data.
To perform this request, your Devo user must have at least the Activeboards (view) permission assigned. Learn more about roles and permissions in Role permissions.
Example
Find below a request example in cURL language. This request will return the Activeboard set as default that corresponds to the given token. Learn how to authorize your request in this article.
curl -H "standAloneToken:YOUR_TOKEN" -X GET "https://api-us.devo.com/activeboards/v2/activeboards/default"Code | Description |
|---|
Code | Description |
|---|---|
200 | Successful response. Default Activeboards' general information retrieved. {
"categories": null,
"name": "myActiveboard",
"description": "This is my test Activeboard",
"updateDate": 1678719854000,
"creationDate": 1678719854000,
"isPrivate": true,
"isDefault": true,
"favorite": true,
"editable": true,
"tags": [
"marketing"
],
"id": 34567,
"owner": {
"id": "1234-5678",
"email": "user@devo.com",
"username": "Firewall Investigator",
"userDomain": 12345
},
"version": 0
"schedules": []
},
{
"categories": null,
"name": "Firewall incidents",
"description": "Check potential firewall incidents",
"updateDate": 1666852847000,
"creationDate": 1619512103000,
"isPrivate": false,
"isDefault": true,
"favorite": true,
"editable": false,
"tags": null,
"id": 1234,
"owner": {
"id": "4567-5678",
"email": "user2@devo.com",
"username": "Firewall Investigator",
"userDomain": 14829
},
"version": 0
"schedules": []
} |
400 | Error in request. |
401 | Unauthorized request. |
403 | Forbidden request. |
404 | There is not an AB by default. |
405 | Method not allowed. |
500 | Server error and Java exception. |
POST /activeboards
Create a new Activeboard.
To perform this request, your Devo role must have the Activeboards (manage) permission assigned. Learn more about roles and permissions in Role permissions.
Request body
The request JSON body must include an object with the following key-value pairs:
Parameter | Type | Parameter |
|---|
Parameter | Type | Parameter |
|---|---|---|
|
| Name of the new Activeboard. |
|
| Enter an optional description for the new Activeboard. |
|
| You must define a JSON object specifying the details of the content in the new Activeboard. How to generate this JSON object As the required JSON object may contain a complex list of key-value pairs to define all the widgets and content in the Activeboard, we recommend to get a JSON object from an Activeboard in the Devo platform and modify it accordingly to create the new Activeboard. In Devo, you can get an Activeboard JSON structure by clicking the ellipsis menu (…) and selecting Edit raw configuration. Learn more about how to do this in this article. |
Example
Find below a request example in cURL language. This request will create a new Activeboard named MyNewActiveboard in the domain that corresponds to the given token. Learn how to authorize your request in this article.
curl --location -g 'https://api-us.devo.com/activeboards/v2/activeboards' --header 'standAloneToken:YOUR_TOKEN' --header 'Content-Type: application/json' --data '{
"name":"MyNewActiveboard",
"settings":{
"description":"",
"type": "container",
"subtype": "Grid",
"datasource": null,
"definitions": null,
"date": {
"realTime": false,
"from": "now() - 15m",
"to": "now()"
},
"settings": {
"layout": {
"Table0": {
"w": 6,
"h": 14,
"x": 0,
"y": 0,
"i": "Table0",
"moved": false,
"static": false
}
},
"header": false
},
"extra": {
"favourites": {
"widgets": "Line",
"inputs": "Input",
"containers": "Grid"
},
"autoRefreshPeriod": null,
"config": {
"theme": {}
}
},
"children": {
"Table0": {
"name": "Table0",
"description": "This is my Table: Table0",
"type": "widget",
"subtype": "Table",
"datasource": "query(from siem.logtrust.web.activity)",
"definitions": null,
"date": {},
"settings": {
"pagination": false,
"topEnabled": true,
"topRowLimits": 10,
"originalLength": 86,
"typeSort": "desc",
"fieldOrder": "method",
"columnDefs": [
{
"headerName": "eventdate",
"field": "eventdate",
"width": 200,
"sort": null,
"hide": false,
"cellRenderer": "dateRenderer",
"cellRendererParams": {
"formatValues": []
},
"formatValue": "date",
"formatValues": []
},
{
"headerName": "level",
"field": "level",
"width": null,
"sort": null,
"hide": false,
"cellRenderer": "undefinedRenderer",
"cellRendererParams": {
"formatValues": []
},
"formatValues": []
},
{
"headerName": "domain",
"field": "domain",
"width": null,
"sort": "desc",
"hide": false,
"cellRenderer": "undefinedRenderer",
"cellRendererParams": {
"formatValues": []
},
"formatValues": []
}
]
},
"extra": {
"lastMetadata": [
{
"name": "eventdate",
"type": "timestamp"
},
{
"name": "level",
"type": "str"
},
{
"name": "domain",
"type": "str"
}
]
},
"children": null,
"version": 3
}
},
"version": 3
}
}'Code | Description |
|---|
Code | Description |
|---|---|
201 | Successful response. Activeboard created. {
"categories": null,
"name": "MyNewActiveboard",
"description": null,
"updateDate": 1678785762000,
"creationDate": 1678785762000,
"isPrivate": true,
"isDefault": false,
"favorite": false,
"editable": false,
"tags": null,
"id": 1234,
"owner": {
"id": "4567-5678",
"email": "user2@devo.com",
"username": "Firewall Investigator",
"userDomain": 14829
},
"version": 0,
"schedules": [],
"settings": {
"name": "MyNewActiveboard",
"description": null,
"type": "container",
"subtype": "Grid",
"datasource": null,
"definitions": null,
"date": {
"realTime": false,
"from": "now() - 15m",
"to": "now()"
},
"settings": {
"layout": {
"Table0": {
"w": 6,
"h": 14,
"x": 0,
"y": 0,
"i": "Table0",
"moved": false,
"static": false
}
},
"header": false
},
"extra": {
"favourites": {
"widgets": "Line",
"inputs": "Input",
"containers": "Grid"
},
"autoRefreshPeriod": null,
"config": {
"theme": {}
}
},
"children": {
"Table0": {
"name": "Table0",
"description": "This is my Table: Table0",
"type": "widget",
"subtype": "Table",
"datasource": "query(from siem.logtrust.web.activity)",
"definitions": null,
"date": {},
"settings": {
"pagination": false,
"topEnabled": true,
"topRowLimits": 10,
"originalLength": 86,
"typeSort": "desc",
"fieldOrder": "method",
"columnDefs": [
{
"headerName": "eventdate",
"field": "eventdate",
"width": 200,
"sort": null,
"hide": false,
"cellRenderer": "dateRenderer",
"cellRendererParams": {
"formatValues": []
},
"formatValue": "date",
"formatValues": []
},
{
"headerName": "level",
"field": "level",
"width": null,
"sort": null,
"hide": false,
"cellRenderer": "undefinedRenderer",
"cellRendererParams": {
"formatValues": []
},
"formatValues": []
},
{
"headerName": "domain",
"field": "domain",
"width": null,
"sort": "desc",
"hide": false,
"cellRenderer": "undefinedRenderer",
"cellRendererParams": {
"formatValues": []
},
"formatValues": []
}
]
},
"extra": {
"lastMetadata": [
{
"name": "eventdate",
"type": "timestamp"
},
{
"name": "level",
"type": "str"
},
{
"name": "domain",
"type": "str"
}
]
},
"children": null,
"version": 3
}
},
"version": 3
}
} |
400 | Error in request |
401 | Unauthorized error. |
403 | Forbidden request. |
405 | Method not allowed. |
500 | Server error and Java exception. |
POST /activeboards/{id}/clone
Clone an Activeboard.
To perform this request, your Devo role must have the Activeboards (manage) permission assigned. Learn more about roles and permissions in Role permissions.
Path parameters
Add the following path parameters as part of the endpoint:
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
|
| Enter the ID of the Activeboard you want to clone. How can I get the ID of an Activeboard? Activeboards IDs are not displayed in the Devo platform, so you should get them using the |
Request body
The request JSON body must include an object with the following key-value pairs:
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
|
| Enter the name of the cloned Activeboard. |
|
| Enter an optional description for the cloned Activeboard. |
Example
Find below a request example in cURL language. This request clone the Activeboard with ID 1234 created in the domain that corresponds to the given token. Learn how to authorize your request in this article.
curl -H "standAloneToken:YOUR_TOKEN" -H "Content-Type: application/json" -X POST "https://api-us.devo.com/activeboards/v2/activeboards/1234/clone" -d '{"name": "myClonedActiveboard", "description": "This is a cloned Activeboard"}'Code | Description |
|---|
Code | Description |
|---|---|
201 | Successful response. Activeboard cloned. {
"categories": null,
"name": "MyClonedActiveboard",
"description": "This is a cloned Activeboard",
"updateDate": 1678785762000,
"creationDate": 1678785762000,
"isPrivate": true,
"isDefault": false,
"favorite": false,
"editable": false,
"tags": null,
"id": 2536039,
"owner": {
"id": "4567-5678",
"email": "user2@devo.com",
"username": "Firewall Investigator",
"userDomain": 14829
},
"version": 0,
"schedules": [],
"settings": {
"name": "MyNewActiveboard",
"description": null,
"type": "container",
"subtype": "Grid",
"datasource": null,
"definitions": null,
"date": {
"realTime": false,
"from": "now() - 15m",
"to": "now()"
},
"settings": {
"layout": {
"Table0": {
"w": 6,
"h": 14,
"x": 0,
"y": 0,
"i": "Table0",
"moved": false,
"static": false
}
},
"header": false
},
"extra": {
"favourites": {
"widgets": "Line",
"inputs": "Input",
"containers": "Grid"
},
"autoRefreshPeriod": null,
"config": {
"theme": {}
}
},
"children": {
"Table0": {
"name": "Table0",
"description": "This is my Table: Table0",
"type": "widget",
"subtype": "Table",
"datasource": "query(from siem.logtrust.web.activity)",
"definitions": null,
"date": {},
"settings": {
"pagination": false,
"topEnabled": true,
"topRowLimits": 10,
"originalLength": 86,
"typeSort": "desc",
"fieldOrder": "method",
"columnDefs": [
{
"headerName": "eventdate",
"field": "eventdate",
"width": 200,
"sort": null,
"hide": false,
"cellRenderer": "dateRenderer",
"cellRendererParams": {
"formatValues": []
},
"formatValue": "date",
"formatValues": []
},
{
"headerName": "level",
"field": "level",
"width": null,
"sort": null,
"hide": false,
"cellRenderer": "undefinedRenderer",
"cellRendererParams": {
"formatValues": []
},
"formatValues": []
},
{
"headerName": "domain",
"field": "domain",
"width": null,
"sort": "desc",
"hide": false,
"cellRenderer": "undefinedRenderer",
"cellRendererParams": {
"formatValues": []
},
"formatValues": []
}
]
},
"extra": {
"lastMetadata": [
{
"name": "eventdate",
"type": "timestamp"
},
{
"name": "level",
"type": "str"
},
{
"name": "domain",
"type": "str"
}
]
},
"children": null,
"version": 3
}
},
"version": 3
}
}
|
400 | Error in request |
401 | Unauthorized error. |
403 | Forbidden request. |
404 | Not found. |
405 | Method not allowed. |
500 | Server error and Java exception. |
PUT /activeboards/{id}
Update a specific Activeboard.
To perform this request, your Devo role must have the Activeboards (manage) permission assigned. Learn more about roles and permissions in Role permissions.
Path parameters
Add the following path parameters as part of the endpoint:
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
|
| Enter the ID of the Activeboard you want to update. How can I get the ID of an Activeboard? Activeboards IDs are not displayed in the Devo platform, so you should get them using the |
Request body
The request JSON body must include an object with the following key-value pairs:
Parameter | Type | Parameter |
|---|
Parameter | Type | Parameter |
|---|---|---|
|
| Name of the Activeboard. |
|
| Enter an optional description for the Activeboard. |
|
| You must define a JSON object specifying the details of the content in the updated Activeboard. How to generate this JSON object You can get the JSON object of an Activeboard in the response of its creation request. Also, you can get it in the Devo platform, and modify it accordingly to update the Activeboard. You can get an Activeboard JSON structure by clicking the ellipsis menu (…) and selecting Edit raw configuration. Learn more about how to do this in this article. |
Example
Find below a request example in cURL language. This request will update the Activeboard named MyNewActiveboard (with ID 1234) in the domain that corresponds to the given token. We've updated the name and description of the Activeboard, as well as the query in its widget.
Learn how to authorize your request in this article.
curl --location --request PUT 'https://api-us.devo.com/activeboards/v2/activeboards/1234' --header 'standAloneToken:YOUR_TOKEN' --header 'Content-Type: application/json' --data '{
"name":"MyNewActiveboardUpdated",
"settings":{
"description":"Query updated",
"type": "container",
"subtype": "Grid",
"datasource": null,
"definitions": null,
"date": {
"realTime": false,
"from": "now() - 15m",
"to": "now()"
},
"settings": {
"layout": {
"Table0": {
"w": 6,
"h": 14,
"x": 0,
"y": 0,
"i": "Table0",
"moved": false,
"static": false
}
},
"header": false
},
"extra": {
"favourites": {
"widgets": "Line",
"inputs": "Input",
"containers": "Grid"
},
"autoRefreshPeriod": null,
"config": {
"theme": {}
}
},
"children": {
"Table0": {
"name": "Table0",
"description": "This is my Table: Table0",
"type": "widget",
"subtype": "Table",
"datasource": "query(from demo.ecommerce.data)",
"definitions": null,
"date": {},
"settings": {
"pagination": false,
"topEnabled": true,
"topRowLimits": 10,
"originalLength": 86,
"typeSort": "desc",
"fieldOrder": "method",
"columnDefs": [
{
"headerName": "eventdate",
"field": "eventdate",
"width": 200,
"sort": null,
"hide": false,
"cellRenderer": "dateRenderer",
"cellRendererParams": {
"formatValues": []
},
"formatValue": "date",
"formatValues": []
},
{
"headerName": "level",
"field": "level",
"width": null,
"sort": null,
"hide": false,
"cellRenderer": "undefinedRenderer",
"cellRendererParams": {
"formatValues": []
},
"formatValues": []
},
{
"headerName": "domain",
"field": "domain",
"width": null,
"sort": "desc",
"hide": false,
"cellRenderer": "undefinedRenderer",
"cellRendererParams": {
"formatValues": []
},
"formatValues": []
}
]
},
"extra": {
"lastMetadata": [
{
"name": "eventdate",
"type": "timestamp"
},
{
"name": "level",
"type": "str"
},
{
"name": "domain",
"type": "str"
}
]
},
"children": null,
"version": 3
}
},
"version": 3
}
}'Code | Description |
|---|
Code | Description |
|---|---|
200 | Successful response. Activeboard updated. {
"categories": null,
"name": "MyNewActiveboardUpdated",
"description": "Query updated",
"updateDate": 1678785762000,
"creationDate": 1678785762000,
"isPrivate": true,
"isDefault": false,
"favorite": false,
"editable": false,
"tags": null,
"id": 1234,
"owner": {
"id": "4567-5678",
"email": "user2@devo.com",
"username": "Firewall Investigator",
"userDomain": 14829
},
"version": 0,
"schedules": [],
"settings": {
"name": "MyNewActiveboardUpdated",
"description": null,
"type": "container",
"subtype": "Grid",
"datasource": null,
"definitions": null,
"date": {
"realTime": false,
"from": "now() - 15m",
"to": "now()"
},
"settings": {
"layout": {
"Table0": {
"w": 6,
"h": 14,
"x": 0,
"y": 0,
"i": "Table0",
"moved": false,
"static": false
}
},
"header": false
},
"extra": {
"favourites": {
"widgets": "Line",
"inputs": "Input",
"containers": "Grid"
},
"autoRefreshPeriod": null,
"config": {
"theme": {}
}
},
"children": {
"Table0": {
"name": "Table0",
"description": "This is my Table: Table0",
"type": "widget",
"subtype": "Table",
"datasource": "query(from demo.ecommerce.data)",
"definitions": null,
"date": {},
"settings": {
"pagination": false,
"topEnabled": true,
"topRowLimits": 10,
"originalLength": 86,
"typeSort": "desc",
"fieldOrder": "method",
"columnDefs": [
{
"headerName": "eventdate",
"field": "eventdate",
"width": 200,
"sort": null,
"hide": false,
"cellRenderer": "dateRenderer",
"cellRendererParams": {
"formatValues": []
},
"formatValue": "date",
"formatValues": []
},
{
"headerName": "level",
"field": "level",
"width": null,
"sort": null,
"hide": false,
"cellRenderer": "undefinedRenderer",
"cellRendererParams": {
"formatValues": []
},
"formatValues": []
},
{
"headerName": "domain",
"field": "domain",
"width": null,
"sort": "desc",
"hide": false,
"cellRenderer": "undefinedRenderer",
"cellRendererParams": {
"formatValues": []
},
"formatValues": []
}
]
},
"extra": {
"lastMetadata": [
{
"name": "eventdate",
"type": "timestamp"
},
{
"name": "level",
"type": "str"
},
{
"name": "domain",
"type": "str"
}
]
},
"children": null,
"version": 3
}
},
"version": 3
}
}
|
400 | Error in request |
401 | Unauthorized error. |
403 | Forbidden request. |
404 | Not found. |
405 | Method not allowed. |
500 | Server error and Java exception. |
PATCH /activeboards/{id}/privacy
Modify the scope of access of an Activeboard. You can mark your Activeboards as visible to make them shareable, or make them private.
To perform this request, your Devo role must have the Activeboards (manage) permission assigned. Learn more about roles and permissions in Role permissions.
Path parameters
Add the following path parameters as part of the endpoint:
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
|
| Enter the ID of the Activeboard you want to modify. How can I get the ID of an Activeboard? Activeboards IDs are not displayed in the Devo platform, so you should get them using the |
Request body
The request JSON body must include an object with the following key-value pairs:
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
|
| Set it to In the Devo app, you can modify the privacy level of your Activeboards by checking or unmarking the Make Activeboard visible option. Learn more about this in Share Activeboards. |
Example
Find below a request example in cURL language. This request will make visible the Activeboard with ID 1234 created in the domain that corresponds to the given token. Learn how to authorize your request in this article.
curl -H "standAloneToken:YOUR_TOKEN" -H "Content-Type: application/json" -X PATCH "https://api-us.devo.com/activeboards/v2/activeboards/1234/privacy" -d '{"privacy": false}'Code | Description |
|---|
Code | Description |
|---|---|
200 | Successful response. Activeboard privacy changed. {
"categories": null,
"name": "MyNewActiveboard",
"description": null,
"updateDate": 1678785762000,
"creationDate": 1678785762000,
"isPrivate": false,
"isDefault": false,
"favorite": false,
"editable": false,
"tags": null,
"id": 1234,
"owner": {
"id": "4567-5678",
"email": "user2@devo.com",
"username": "Firewall Investigator",
"userDomain": 14829
},
"version": 0,
"schedules": [],
"settings": {
"name": "MyNewActiveboard",
"description": null,
"type": "container",
"subtype": "Grid",
"datasource": null,
"definitions": null,
"date": {
"realTime": false,
"from": "now() - 15m",
"to": "now()"
},
"settings": {
"layout": {
"Table0": {
"w": 6,
"h": 14,
"x": 0,
"y": 0,
"i": "Table0",
"moved": false,
"static": false
}
},
"header": false
},
"extra": {
"favourites": {
"widgets": "Line",
"inputs": "Input",
"containers": "Grid"
},
"autoRefreshPeriod": null,
"config": {
"theme": {}
}
},
"children": {
"Table0": {
"name": "Table0",
"description": "This is my Table: Table0",
"type": "widget",
"subtype": "Table",
"datasource": "query(from siem.logtrust.web.activity)",
"definitions": null,
"date": {},
"settings": {
"pagination": false,
"topEnabled": true,
"topRowLimits": 10,
"originalLength": 86,
"typeSort": "desc",
"fieldOrder": "method",
"columnDefs": [
{
"headerName": "eventdate",
"field": "eventdate",
"width": 200,
"sort": null,
"hide": false,
"cellRenderer": "dateRenderer",
"cellRendererParams": {
"formatValues": []
},
"formatValue": "date",
"formatValues": []
},
{
"headerName": "level",
"field": "level",
"width": null,
"sort": null,
"hide": false,
"cellRenderer": "undefinedRenderer",
"cellRendererParams": {
"formatValues": []
},
"formatValues": []
},
{
"headerName": "domain",
"field": "domain",
"width": null,
"sort": "desc",
"hide": false,
"cellRenderer": "undefinedRenderer",
"cellRendererParams": {
"formatValues": []
},
"formatValues": []
}
]
},
"extra": {
"lastMetadata": [
{
"name": "eventdate",
"type": "timestamp"
},
{
"name": "level",
"type": "str"
},
{
"name": "domain",
"type": "str"
}
]
},
"children": null,
"version": 3
}
},
"version": 3
}
}
|
400 | Error in request |
401 | Unauthorized error. |
403 | Forbidden request. |
404 | Not found. |
405 | Method not allowed. |
500 | Server error and Java exception. |
PATCH /activeboards/{id}/tags
Update the tags assigned to an Activeboard.
To perform this request, your Devo user must have at least the Activeboards (view) permission assigned. Learn more about roles and permissions in Role permissions.
Path parameters
Add the following path parameters as part of the endpoint:
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
|
| Enter the ID of the Activeboard you want to update. How can I get the ID of an Activeboard? Activeboards IDs are not displayed in the Devo platform, so you should get them using the |
Request body
The request JSON body must include an object with the following key-value pairs:
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
|
| Enter the tags you want to add to the Activeboard, separated by commas. {"tags": "tag1, tag2, tag3"} |
Example
Find below a request example in cURL language. This request will add the tags marketing and ecommerce to the Activeboard with ID 1234 created in the domain that corresponds to the given token. Learn how to authorize your request in this article.
curl -H "standAloneToken:YOUR_TOKEN" -H "Content-Type: application/json" -X PATCH "https://api-us.devo.com/activeboards/v2/activeboards/1234/tags" -d '{"tags": "marketing, ecommerce"}'Code | Description |
|---|
Code | Description |
|---|---|
200 | Successful response. Activeboard tags updated. {
"categories": null,
"name": "MyNewActiveboard",
"description": null,
"updateDate": 1678785762000,
"creationDate": 1678785762000,
"isPrivate": false,
"isDefault": false,
"favorite": false,
"editable": false,
"tags": "marketing, ecommerce",
"id": 1234,
"owner": {
"id": "4567-5678",
"email": "user2@devo.com",
"username": "Firewall Investigator",
"userDomain": 14829
},
"version": 0,
"schedules": [],
"settings": {
"name": "MyNewActiveboard",
"description": null,
"type": "container",
"subtype": "Grid",
"datasource": null,
"definitions": null,
"date": {
"realTime": false,
"from": "now() - 15m",
"to": "now()"
},
"settings": {
"layout": {
"Table0": {
"w": 6,
"h": 14,
"x": 0,
"y": 0,
"i": "Table0",
"moved": false,
"static": false
}
},
"header": false
},
"extra": {
"favourites": {
"widgets": "Line",
"inputs": "Input",
"containers": "Grid"
},
"autoRefreshPeriod": null,
"config": {
"theme": {}
}
},
"children": {
"Table0": {
"name": "Table0",
"description": "This is my Table: Table0",
"type": "widget",
"subtype": "Table",
"datasource": "query(from siem.logtrust.web.activity)",
"definitions": null,
"date": {},
"settings": {
"pagination": false,
"topEnabled": true,
"topRowLimits": 10,
"originalLength": 86,
"typeSort": "desc",
"fieldOrder": "method",
"columnDefs": [
{
"headerName": "eventdate",
"field": "eventdate",
"width": 200,
"sort": null,
"hide": false,
"cellRenderer": "dateRenderer",
"cellRendererParams": {
"formatValues": []
},
"formatValue": "date",
"formatValues": []
},
{
"headerName": "level",
"field": "level",
"width": null,
"sort": null,
"hide": false,
"cellRenderer": "undefinedRenderer",
"cellRendererParams": {
"formatValues": []
},
"formatValues": []
},
{
"headerName": "domain",
"field": "domain",
"width": null,
"sort": "desc",
"hide": false,
"cellRenderer": "undefinedRenderer",
"cellRendererParams": {
"formatValues": []
},
"formatValues": []
}
]
},
"extra": {
"lastMetadata": [
{
"name": "eventdate",
"type": "timestamp"
},
{
"name": "level",
"type": "str"
},
{
"name": "domain",
"type": "str"
}
]
},
"children": null,
"version": 3
}
},
"version": 3
}
}
|
400 | Error in request |
401 | Unauthorized error. |
403 | Forbidden request. |
404 | Not found. |
405 | Method not allowed. |
500 | Server error and Java exception. |
PATCH /activeboards/{id}/favorite
Mark or unmark an Activeboard as a favorite. Favorite Activeboards are an easy way to find the Activeboards you use more frequently.
To perform this request, your Devo user must have at least the Activeboards (view) permission assigned. Learn more about roles and permissions in Role permissions.
Path parameters
Add the following path parameters as part of the endpoint:
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
|
| Enter the ID of the Activeboard you want to update. How can I get the ID of an Activeboard? Activeboards IDs are not displayed in the Devo platform, so you should get them using the |
Request body
The request JSON body must include an object with the following key-value pairs:
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
|
| Set it to |
Example
Find below a request example in cURL language. This request will set as favorite the Activeboard with ID 1234 created in the domain that corresponds to the given token. Learn how to authorize your request in this article.
curl -H "standAloneToken:YOUR_TOKEN" -H "Content-Type: application/json" -X PATCH "https://api-us.devo.com/activeboards/v2/activeboards/1234/favorite" -d '{"favorite": true}'Code | Description |
|---|
Code | Description |
|---|---|
200 | Activeboard set as favorite. {
"categories": null,
"name": "MyNewActiveboard",
"description": null,
"updateDate": 1678785762000,
"creationDate": 1678785762000,
"isPrivate": false,
"isDefault": false,
"favorite": true,
"editable": false,
"tags": "marketing, ecommerce",
"id": 1234,
"owner": {
"id": "4567-5678",
"email": "user2@devo.com",
"username": "Firewall Investigator",
"userDomain": 14829
},
"version": 0,
"schedules": [],
"settings": {
"name": "MyNewActiveboard",
"description": null,
"type": "container",
"subtype": "Grid",
"datasource": null,
"definitions": null,
"date": {
"realTime": false,
"from": "now() - 15m",
"to": "now()"
},
"settings": {
"layout": {
"Table0": {
"w": 6,
"h": 14,
"x": 0,
"y": 0,
"i": "Table0",
"moved": false,
"static": false
}
},
"header": false
},
"extra": {
"favourites": {
"widgets": "Line",
"inputs": "Input",
"containers": "Grid"
},
"autoRefreshPeriod": null,
"config": {
"theme": {}
}
},
"children": {
"Table0": {
"name": "Table0",
"description": "This is my Table: Table0",
"type": "widget",
"subtype": "Table",
"datasource": "query(from siem.logtrust.web.activity)",
"definitions": null,
"date": {},
"settings": {
"pagination": false,
"topEnabled": true,
"topRowLimits": 10,
"originalLength": 86,
"typeSort": "desc",
"fieldOrder": "method",
"columnDefs": [
{
"headerName": "eventdate",
"field": "eventdate",
"width": 200,
"sort": null,
"hide": false,
"cellRenderer": "dateRenderer",
"cellRendererParams": {
"formatValues": []
},
"formatValue": "date",
"formatValues": []
},
{
"headerName": "level",
"field": "level",
"width": null,
"sort": null,
"hide": false,
"cellRenderer": "undefinedRenderer",
"cellRendererParams": {
"formatValues": []
},
"formatValues": []
},
{
"headerName": "domain",
"field": "domain",
"width": null,
"sort": "desc",
"hide": false,
"cellRenderer": "undefinedRenderer",
"cellRendererParams": {
"formatValues": []
},
"formatValues": []
}
]
},
"extra": {
"lastMetadata": [
{
"name": "eventdate",
"type": "timestamp"
},
{
"name": "level",
"type": "str"
},
{
"name": "domain",
"type": "str"
}
]
},
"children": null,
"version": 3
}
},
"version": 3
}
}
|
400 | Error in request |
401 | Unauthorized error |
403 | Forbidden |
404 | Not Found |
405 | Method Not Allowed |
500 | Server error and java exception |
PATCH /activeboards/{id}/default
Mark or unmark an Activeboard as default. The default Activeboard is the one displayed when you access the Activeboards area in Devo.
To perform this request, your Devo user must have at least the Activeboards (view) permission assigned. Learn more about roles and permissions in Role permissions.
Path parameters
Add the following path parameters as part of the endpoint:
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
|
| Enter the ID of the required Activeboard in the request path. How can I get the ID of an Activeboard? Activeboards IDs are not displayed in the Devo platform, so you should get them using the |
Request body
The request JSON body must include an object with the following key-value pairs:
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
|
| Set it to |
Example
Find below a request example in cURL language. This request will set as default the Activeboard with ID 1234 created in the domain that corresponds to the given token. Learn how to authorize your request in this article.
curl -X PATCH "https://api-us.devo.com/activeboards/v2/activeboards/1234/default" -H "accept: application/json" -H "standAloneToken: YOUR_TOKEN" -H "Content-Type: application/json" -d "{\"markAsDefault\":true}"Code | Description |
|---|
Code | Description |
|---|---|
200 | Activeboard set as default. {
"categories": null,
"name": "MyNewActiveboard",
"description": null,
"updateDate": 1678785762000,
"creationDate": 1678785762000,
"isPrivate": false,
"isDefault": true,
"favorite": true,
"editable": false,
"tags": "marketing, ecommerce",
"id": 1234,
"owner": {
"id": "4567-5678",
"email": "user2@devo.com",
"username": "Firewall Investigator",
"userDomain": 14829
},
"version": 0,
"schedules": [],
"settings": {
"name": "MyNewActiveboard",
"description": null,
"type": "container",
"subtype": "Grid",
"datasource": null,
"definitions": null,
"date": {
"realTime": false,
"from": "now() - 15m",
"to": "now()"
},
"settings": {
"layout": {
"Table0": {
"w": 6,
"h": 14,
"x": 0,
"y": 0,
"i": "Table0",
"moved": false,
"static": false
}
},
"header": false
},
"extra": {
"favourites": {
"widgets": "Line",
"inputs": "Input",
"containers": "Grid"
},
"autoRefreshPeriod": null,
"config": {
"theme": {}
}
},
"children": {
"Table0": {
"name": "Table0",
"description": "This is my Table: Table0",
"type": "widget",
"subtype": "Table",
"datasource": "query(from siem.logtrust.web.activity)",
"definitions": null,
"date": {},
"settings": {
"pagination": false,
"topEnabled": true,
"topRowLimits": 10,
"originalLength": 86,
"typeSort": "desc",
"fieldOrder": "method",
"columnDefs": [
{
"headerName": "eventdate",
"field": "eventdate",
"width": 200,
"sort": null,
"hide": false,
"cellRenderer": "dateRenderer",
"cellRendererParams": {
"formatValues": []
},
"formatValue": "date",
"formatValues": []
},
{
"headerName": "level",
"field": "level",
"width": null,
"sort": null,
"hide": false,
"cellRenderer": "undefinedRenderer",
"cellRendererParams": {
"formatValues": []
},
"formatValues": []
},
{
"headerName": "domain",
"field": "domain",
"width": null,
"sort": "desc",
"hide": false,
"cellRenderer": "undefinedRenderer",
"cellRendererParams": {
"formatValues": []
},
"formatValues": []
}
]
},
"extra": {
"lastMetadata": [
{
"name": "eventdate",
"type": "timestamp"
},
{
"name": "level",
"type": "str"
},
{
"name": "domain",
"type": "str"
}
]
},
"children": null,
"version": 3
}
},
"version": 3
}
}
|
400 | Error in request |
401 | Unauthorized error |
403 | Forbidden |
404 | Not Found |
405 | Method Not Allowed |
500 | Server error and java exception |
DELETE /activeboards/{id}
Delete an Activeboard.
To perform this request, your Devo role must have the Activeboards (manage) permission assigned. Learn more about roles and permissions in Role permissions.
Path parameters
Add the following path parameters as part of the endpoint:
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
|
| Enter the ID of the Activeboard you want to delete. How can I get the ID of an Activeboard? Activeboards IDs are not displayed in the Devo platform, so you should get them using the |
Example
Find below a request example in cURL language. This request will delete the Activeboard with ID 1234 created in the domain that corresponds to the given token. Learn how to authorize your request in this article.
curl -H "standAloneToken:YOUR_TOKEN" -X DELETE "https://api-us.devo.com/activeboards/v2/activeboards/1234"Code | Description |
|---|
Code | Description |
|---|---|
204 | Activeboard deleted |
400 | Error in request |
401 | Unauthorized error |
403 | Forbidden |
404 | Not Found |
405 | Method Not Allowed |
500 | Server error and Java exception |