Document toolboxDocument toolbox

Working with Activeboards using the API

Owned by Borja Moro Moreno
Last updated: Apr 11, 2024 by Juan Tomás Alonso Nieto (Deactivated)
62 min read
[ 1 Overview ] [ 2 Endpoints and methods ]

Overview

Check the list of available endpoints and methods in the Activeboards API:

Endpoints and methods

Description

Endpoints and methods

Description

GET /activeboards see below

Get general information about all the Activeboards in a domain.

GET /activeboards/{id} see below

Get detailed information about a specific Activeboard.

GET /activeboards/default see below

Get general information about the Activeboard set as default.

POST /activeboards see below

Create a new Activeboard.

POST /activeboards/{id}/clone see below

Clone an Activeboard.

PUT /activeboards/{id} see below

Update an Activeboard.

PATCH /activeboards/{id}/privacy see below

Modify the scope of access of an Activeboard.

PATCH /activeboards/{id}/tags see below

Update the tags assigned to an Activeboard.

PATCH /activeboards/{id}/favorite see below

Mark or unmark an Activeboard as a favorite.

PATCH /activeboards/{id}/default see below

Mark or unmark an Activeboard as default. 

DELETe /activeboards/{id} see below

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

id required

integer

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 GET /v2/activeboards request explained above.

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.

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.

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.

POST /activeboards

Create a new Activeboard.

POST /activeboards/{id}/clone

Clone an Activeboard.

PUT /activeboards/{id}

Update a specific Activeboard.

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.

PATCH /activeboards/{id}/tags

Update the tags assigned to an Activeboard.

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.

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.

DELETE /activeboards/{id}

Delete an Activeboard.

Â