Versions Compared

Version Old Version 7 New Version 8
Changes made by

Former user

Former user

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
minLevel2
maxLevel2
typeflat

Overview

Check the list of available endpoints and methods in the Aggregation task API:

...

Endpoints and methods

...

Description

...

Status
colourYellow
titleGET
 /models/{name} see below

...

Get detailed information about a model.

...

Status
colourBlue
titlePUT
/models/{name} see below

...

Replace the data of an existing model.

...

Status
colourGreen
titlePOST
/models/{name} see below

...

Create a new model.

...

Status
colourRed
titleDELETE
 /models/{name} see below

...

Delete a model.

...

Status
colourGreen
titlePATCH
/models/{name} see below

...

Update an existing model.

...

Status
colourYellow
titleGET
/models/{name} see below

...

List the available models in the current domain.

...

Status
colourYellow
titleGET
/images/{name} see below

...

Get the binary image of a model.

Endpoints and methods

...

Get information about all the aggregation tasks in a domain.

Note

In order to work with Model Management you need to activate Machine Learning permissions in your role. Go to Administration → Roles → Permissions → Machine Learning and activate the view and manage permissions in Models.

Learn more about roles and permissions in Role permissions.

...

titleRequest

Path parameters

Add the following path parameters as part of the endpoint:

...

Parameter

...

Type

...

Description

...

domain required

...

string

...

Enter the domain of the aggregation tasks you want to get information about.

Query string parameters

Query string parameters are optionally added after the path parameters, preceded by a question mark (?) and separated by an ampersand (&)

...

Parameter

...

Type

...

Description

...

skipCache

...

boolean

...

If it is true, skips the cache that contains the status of the aggregation tasks and force the system to tell you where to find them.

Default value is false.

...

status

...

string

...

Execution status of the aggregation tasks. Available values are:

  • RUNNING

  • STOPPED

  • DELETED

  • ERROR

  • PARTIAL_STOPPED

  • PENDING_CREATE

  • PENDING_START

  • PENDING_STOP

  • PENDING_UPDATE

  • PENDING_REBUILD

  • PENDING_DELETE

  • PENDING_RESUME

  • PENDING_EXTEND

...

id

...

string

...

If you want to get details about a specific aggregation task only, enter its ID here.

Note

How can I get the ID of an aggregation task?

To get the ID of an aggregation task, log in to the Devo platform and go to Administration → Data management, locate your aggregation task in the table, click the ellipsis button in its row and select View details. You can copy the internal ID in the details shown in the window that appears.

Learn more about this in Aggregation tasks.

...

fromDate

...

integer

...

Timestamp from when the aggregation tasks to be returned were created. Format is a timestamp in milliseconds, for example 1652400000000

...

name

...

string

...

If you want to get details about a specific aggregation task only, you can enter its name.

...

ownerEmail

...

string

...

Email of the aggregation tasks' owner.

...

negated

...

boolean

...

Set this to true to negate all other parameters. Default value is false.

Example

Find below a request example in cURL language. In this case, we are requesting all the aggregation tasks with status STOPPED created in the given domain. Learn how to authorize your request in this article.

Code Block
curl -H "standAloneToken:YOUR_TOKEN" -X GET "https://api-us.devo.com/aggregations/v2/aggrtasks/myDomain?status=STOPPED"

...

titleResponse

...

Code

...

Description

...

200

Successful response. List of aggregation tasks retrieved.

...

Table of Contents
minLevel2
maxLevel2
typeflat

Overview

Check the list of available endpoints and methods in the Aggregation task API:

Endpoints and methods

Description

Status
colourYellow
titleGET
 /models/{name} see below

Get detailed information about a model.

Status
colourBlue
titlePUT
/models/{name} see below

Replace the data of an existing model.

Status
colourGreen
titlePOST
/models/{name} see below

Create a new model.

Status
colourRed
titleDELETE
 /models/{name} see below

Delete a model.

Status
colourGreen
titlePATCH
/models/{name} see below

Update an existing model.

Status
colourYellow
titleGET
/models/{name} see below

List the available models in the current domain.

Status
colourYellow
titleGET
/images/{name} see below

Get the binary image of a model.

Endpoints and methods

Anchor
path1
path1
GET /models/{name}

Get detailed information about a model.

Note

In order to work with Model Management you need to activate Machine Learning permissions in your role. Go to Administration → Roles → Permissions → Machine Learning and activate the view and manage permissions in Models.

Learn more about roles and permissions in Role permissions.

Expand
titleRequest

Path parameters

Add the following path parameters as part of the endpoint:

Parameter

Type

Description

name required

string

Enter the name of the model you want to get information about.

Query string parameters

Query string parameters are optionally added after the path parameters, preceded by a question mark (?) and separated by an ampersand (&)

Parameter

Type

Description

fast

boolean

If it is true, it does not show the model image in details.

Default value is -.

Example

Find below a request example in cURL language:

Code Block
curl -X GET "https://api.stage.devo.com/mlmodelmanager/v3/models/MY FIRST MODEL?fast=true" -H "accept: application/json" -H "standAloneToken: cc81f6f5c73634002183d80b1fb736ec"
Expand
titleResponse

Code

Description

200

Returns the retrieved model.

Code Block
{
  "id": 22,
  "name": "MY FIRST MODEL",
  "engine": "H2O",
  "location": "domains/self/632bfd1c-f734-44fd-af66-732410b953f1",
  "description": "A BRIEF DESCRIPTION",
  "updateDate": 1683714063000,
  "creationDate": 1683714063000,
  "domainName": "self",
  "outputType": "float8",
  "image": null,
  "category": "Regression",
  "fields": [
    {
      "id": 0,
      "name": "length",
      "description": "",
      "type": "float8"
    },
    {
      "id": 1,
      "name": "entropy",
      "description": "",
      "type": "float8"
    },
    {
      "id": 2,
      "name": "p_vowels",
      "description": "",
      "type": "float8"
    }
  ],
  "clusters": [],
  "parentId": null,
  "hidden": false,
  "runtimeSize": 78608,
  "fileSize": 77728
}

404

Returns a message when the model name is not found in the server.

500

Returned when an error occurred internally in the server.

Anchor
path2
path2
PUT /models/{name}

Replace the data of an existing model.

Note

In order to work with Model Management you need to activate Machine Learning permissions in your role. Go to Administration → Roles → Permissions → Machine Learning and active the view and manage permissions in Models.

Learn more about roles and permissions in Role permissions.

Expand
titleRequest

Path parameters

Add the following path parameters as part of the endpoint:

Parameter

Type

Description

name required

string

Enter the name of the model you want to replace the data of.

Request body

The request JSON body must include an object with the following key-value pairs:

Parameter

Type

Description

engine

string

The engine used to train and execute the model.

fileName

string

description

string

The description of the model.

Example

Find below a request example in cURL language:

Code Block
curl -H "standAloneToken:YOUR_TOKEN" -X GET "https://api-us.devo.com/aggregations/v2/aggrtasks/myDomain/cc_myDomain:abcDE123?skipCache=true"
Expand
titleResponse

Code

Description

200

Returns a replaced model.

Code Block
{
  "name": "
test1
string",
  
"
delay
engine":
0
"string",

  
"
domainName
location": "
myDomain
string",

  "
ownerEmail
description": "
john.smith@devo.com
string",
  
"
jobs
updateDate":
[
0,
  "creationDate": 0,
{ 
"domainName": "string",
  
"
grain
outputType": "
1m
string",
  "image": {
    "
status
image": "
STOPPED
string"
,

  
},
  "
from
category":
1652400000000
"string",
  "fields": [
"to":
{
1652432340000
      "id":
}
0,
{ 
"name": "string",
      
"
grain
description": "
5m
string",
      
"
status
type": "
STOPPED
string"
,

    }
"from": 1652400000000, 
],
  
"
to
clusters":
1652400000000
[
},
{
{ 
"id": 0,
      
"
grain
name": "
1h
string",

      "
status
description": "
STOPPED
string",
      
"
from
centroid": [
1652400000000,
        0
"to":
1652400000000
    ]
}
  }
  ],
  
"
creationDate
runtimeSize":
1652432342000
0,

  
"
updateDate
fileSize":
1652432342000, "status": "STOPPED", "statusData": "INCOMPLETE", "fromDate": 1652400000000 }, { "id": "cc_myDomain:oYckc691", "name": "test2", "delay": 0, "domainName": "myDomain", "ownerEmail": "john.smith@devo.com", "jobs": [ { "grain": "1m", "status": "STOPPED", "from": 1652400000000, "to": 1652436480000 }, { "grain": "5m", "status": "STOPPED", 
0
}

500

Returned when an error occurred internally in the server.

Anchor
path3
path3
POST /models/{name}

Create a model.

Note

In order to work with Model Management you need to activate Machine Learning permissions in your role. Go to Administration → Roles → Permissions → Machine Learning and activate the view and manage permissions in Models.

Learn more about roles and permissions in Role permissions.

Expand
titleRequest

Path parameters

Add the following path parameters as part of the endpoint:

Parameter

Type

Description

name required

string

Enter the name of the model you want to create.

Request body

The request JSON body must include an object with the following key-value pairs:

Parameter

Type

Description

engine

string

The engine used to train and execute the model.

fileName

string

description

string

The description of the model.

Example

Find below a request example in cURL language:

Code Block
 Expand
titleResponse
Get information about a specific aggregation task in a given domain.
 Note
Code
Description
200
Model has been successfully saved to the server.
 Code Block
{
  "name": "string",
  "engine": "string",
  "location": "string",
  "description": "string",
  "updateDate": 0,
  "creationDate": 0,
  "domainName": "string",
  "outputType": "string",
  "image": {
    "image": "string"
  },
  "category": "string",
  "fields": [
    {
      "
from
id": 
1652400000000
0,
      
  
"
to
name": 
1652436300000
"string",
      
}
"description": "string",
      
{
"type": "string"
    }
  ],
  "
grain
clusters":
 "1h",
 [
    {
      "
status
id": 
"STOPPED"
0,
      
  
"
from
name": 
1652400000000
"string",

 

      "
to
description": 
1652436000000
"string",
      
}
"centroid": [
   
],
     
"creationDate": 1652436468000,
0
     
"updateDate": 1652436468000,
 ]
    
"status": "STOPPED",
}
  ],
  "
statusData
runtimeSize": 
"INCOMPLETE"
0,
  
  
"
fromDate
fileSize": 
1652400000000
0

  
}

]

400
Error in request
401
Unauthorized error.
403
Forbidden request.
404
Not found.
405
Method not allowed.
500
Server error and Java exception.
...
409
The model already exists.
500
Returned when an error occurred internally in the server.
 Anchor
path4
path4
DELETE/models/{name}
Delete a model.
 Note
In order to work with Model Management you need to activate Machine Learning permissions in your role. Go to Administration → Roles → Permissions → Machine Learning and active activate the view and manage permissions in Models.
Learn more about roles and permissions in Role permissions.
Query string parameters
Query string parameters are optionally added after the path parameters, preceded by a question mark (?) and separated by an ampersand (&)
Example
Find below a request example in cURL language. In this case, we are requesting details about the aggregation task with ID cc_myDomain:abcDE123 created in the domain called myDomain. Also, we want to skip the cache about its status. Learn how to authorize your request in this article.
 Expand
titleRequest
Path parameters
Add the following path parameters as part of the endpoint:
Parameter
Type
Description
domain 
name required
string
Enter the 
 domain 
name of the 
 aggregation task 
model you want to 
 get information about
delete.
aggrId required
string
Enter the ID of the aggregation task you want to get information about.
 Note
How can I get the ID of an aggregation task?
To get the ID of an aggregation task, log in to the Devo platform and go to Administration → Data management, locate your aggregation task in the table, click the ellipsis button in its row and select View details. You can copy the internal ID in the details shown in the window that appears.
Learn more about this in Aggregation tasks.
Parameter
Type
Description
skipCache
boolean
If it is true, skips the cache that contains the status of the aggregation task and force the system to tell you where to find it.
Default value is false.
 Code Block
curl -H "standAloneToken:YOUR_TOKEN" -X GET "https://api-us.devo.com/aggregations/v2/aggrtasks/myDomain/cc_myDomain:abcDE123?skipCache=true"
 Expand
titleResponse
Code
Description
200
Successful response. aggregation task details retrieved.
 Code Block
{
  "id": "cc_myDomain:abcDE123",
  "name": "Test",
  "table": "demo.ecommerce.data`1234`.`345`",
  "wheres": [
    "eq(client, \"myDomain\")"
  ],
  "delay": 0,
  "query": {
    "linq": "from demo.ecommerce.data`1234`.`345` where eq(client, \"myDomain\") group every 60000 by level, type, message, client"
  },
  "domainName": "myDomain",
  "ownerEmail": "john.smith@devo.com",
  "jobs": [
    {
      "grain": "1m",
      "status": "STOPPED",
      "from": 1652400000000,
      "to": 1652432040000
    },
    {
      "grain": "5m",
      "status": "STOPPED",
      "from": 1652400000000,
      "to": 1652400000000
    },
    {
      "grain": "1h",
      "status": "STOPPED",
      "from": 1652400000000,
      "to": 1652400000000
    }
  ],
  "creationDate": 1652432055000,
  "updateDate": 1652432055000,
  "status": "STOPPED",
  "statusData": "INCOMPLETE",
  "fromDate": 1652400000000
}
400
Error in request
401
Unauthorized error.
403
Forbidden request.
404
Not found.
405
Method not allowed.
500
Server error and Java exception.
...
Get the measures of an aggregation task.
 Note
In order to work with Model Management you need to activate Machine Learning permissions in your role. Go to Administration → Roles → Permissions → Machine Learning and activate the view and manage permissions in Models.
Learn more about roles and permissions in Role permissions.
...
titleRequest
Path parameters
Add the following path parameters as part of the endpoint:
...
Parameter
...
Type
...
Parameter
...
domain required
...
string
...
Enter the domain of the aggregation task you want to get information about.
...
aggrId required
...
string
...
Enter the ID of the aggregation task you want to get information about.
 Note
How can I get the ID of an aggregation task?
To get the ID of an aggregation task, log in to the Devo platform and go to Administration → Data management, locate your aggregation task in the table, click the ellipsis button in its row and select View details. You can copy the internal ID in the details shown in the window that appears.
Learn more about this in Aggregation tasks.
Example
Find below a request example in cURL language. In this case, we are requesting the measures of the aggregation task with ID cc_myDomain:abcDE123 created in the domain called myDomain. Also, we want to skip the cache about its status. Learn how to authorize your request in this article.
 Code Block
curl -H "standAloneToken:YOUR_TOKEN" -X GET "https://api-us.devo.com/aggregations/v2/aggrtasks/myDomain/cc_myDomain:abcDE123/measures"
...
titleResponse
...
Code
...
Description
...
200
...
Successful response. In this example, the task is calculating three aggregations: 
  • count()
  • avg(responseTime)
  • sum(responseTime)
 Code Block
{
  "responseTime": [
    "avg",
    "sum"
  ],
  "count": []
}
...
400
...
Error in request
...
401
...
Unauthorized error.
...
403
...
Forbidden request.
...
404
...
Not found.
...
405
...
Method not allowed.
...
500
...
Server error and Java exception.
...
Create a new aggregation task.
 Note
In order to work with Model Management you need to activate Machine Learning permissions in your role. Go to Administration → Roles → Permissions → Machine Learning and activate the view and manage permissions in Models.
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:
Example
Find below a request example in cURL language. In this case, we are creating a new aggregation task in the domain called myDomain. Learn how to authorize your request in this article.
curl --location -g 'https://api-us.devo.com/aggregations/v2/aggrtasks/myDomain' --header 'standAloneToken:YOUR_TOKEN' --header 'Content-Type: application/json' --data '{
    "name": "MyNewAggTask",
    "description": "This is a test aggregation task",
    "fromDate": "06/02/2023",
    "minGrain": "30m",
    "query": {
Example
Find below a request example in cURL language. 
 Expand
titleRequest
Path parameters
Add the following path parameters as part of the endpoint:
Parameter
Type
Description
domain required
string
Enter the domain where you want to create the aggregation task.
Parameter
Type
Description
name required
string
Aggregation task's name, which must be unique in the domain.
query required
object
An object that contains three parameters: 
  • LINQ - Base query of the aggregation task, written in LINQ syntax.
  • timezone - Timezone of the aggregation task query, in the following format: Europe/Madrid
  • locale - Locale of the aggregation task query, in the following format: en
fromDate required
string
Date from which the aggregation task searches to calculate the aggregated data. Valid format is dd/mm/yyyy
description
string
Brief description of the aggregation task.
delay
integer
Maximum acceptable time difference between the current time and the last event displayed. You can indicate it in seconds (1s), minutes (1m), hours (1h) and days (1d).
Default value is 0
minGrain
string
Minimum granularity of the aggregation task. Available values are:
  • AUTO - Calculate best aggregation according to the given query.
  • 1m - Aggregate every minute.
  • 5m - Aggregate every 5 minutes.
  • 30m - Aggregate every 30 minutes.
 Code Block
 Code Block
curl -X DELETE "https://api.stage.devo.com/mlmodelmanager/v3/models/MY FIRST MODEL" -H "accept: */*" -H "standAloneToken: cc81f6f5c73634002183d80b1fb736ec"
 Expand
titleResponse
Code
Description
200
Model successfully deleted.
404
Model not found.
500
Returned when an error occurred internally in the server.
 Anchor
path5
path5
PATCH/models/{name}
Update an existing model.
 Note
In order to work with Model Management you need to activate Machine Learning permissions in your role. Go to Administration → Roles → Permissions → Machine Learning and activate the view and manage permissions in Models.
Learn more about roles and permissions in Role permissions.
 Expand
titleRequest
Path parameters
Add the following path parameters as part of the endpoint:
Parameter
Type
Description
name required
string
Enter the name of the model you want to update.
Request body
The request JSON body must include an object with the following key-value pairs:
Parameter
Type
Description
name
string
engine
string
location
string
description
string
updateDate
integer
creationDate
integer
domainName
string
outputType
string
image
category
string
runtimeSize
integer
fileSize
integer
Example
Find below a request example in cURL language.
 Code Block
 Expand
titleResponse
Code
Description
200
Returns the patched model.
400
Returns a message when the model name is not found in the server or the received patch JSON is incorrect.
500
Returned when an error occurred internally in the server.
 Anchor
path6
path6
GET/models/{name}
List the available models in the current domain.
 Note
In order to work with Model Management you need to activate Machine Learning permissions in your role. Go to Administration → Roles → Permissions → Machine Learning and activate the view and manage permissions in Models.
Learn more about roles and permissions in Role permissions.
 Expand
titleRequest
Path parameters
There are no path parameters for this request.
Example
Find below a request example in cURL language.
 Code Block
curl -X GET "https://api.stage.devo.com/mlmodelmanager/v3/models" -H "accept: application/json" -H "standAloneToken: cc81f6f5c73634002183d80b1fb736ec"
 Expand
titleResponse
Code
Description
200
Successful response.
 Code Block
[
  {
    "id": 23,
    "name": "a new model",
    "engine": "H2O",
    "location": "domains/self/e27dd5ef-aedb-42ba-b0b9-21bca5338714",
    "description": "new",
    "updateDate": 1683718486000,
    "creationDate": 1683718486000,
    "domainName": "self",
    "outputType": "float8",
    "image": null,
    "category": "Regression",
    "fields": [
      {
        "id": 0,
        "name": "length",
        "description": "",
        "type": "float8"
      },
      {
        "id": 1,
        "name": "entropy",
        "description": "",
        "type": "float8"
      },
      {
        "id": 2,
        "name": "p_vowels",
        "description": "",
        "type": "float8"
      }
    ],
    "clusters": [],
    "parentId": null,
    "hidden": false,
    "runtimeSize": 78608,
    "fileSize": 77728
  },
  {
    "id": 21,
    "name": "dga_classifier_onnx_demo",
    "engine": "ONNX",
    "location": "domains/self/823b3522-895c-411e-a4f3-2762db27a6fc",
    "description": null,
    "updateDate": 1681900499000,
    "creationDate": 1681900499000,
    "domainName": "self",
    "outputType": "array(float4)",
    "image": null,
    "category": "ONNX",
    "fields": [
      {
        "id": 0,
        "name": "field_0",
        "description": "",
        "type": "array(float4)"
      }
    ],
    "clusters": [],
    "parentId": null,
    "hidden": false,
    "runtimeSize": 880,
    "fileSize": 3881
  },
  {
    "id": 20,
    "name": "graeme_test2",
    "engine": "ONNX",
    "location": "domains/self/b96fe0d9-74f2-4f51-a301-ff7573c0f6bd",
    "description": null,
    "updateDate": 1681804104000,
    "creationDate": 1681804104000,
    "domainName": "self",
    "outputType": "array(float4)",
    "image": null,
    "category": "ONNX",
    "fields": [
      {
        "id": 0,
        "name": "field_0",
        "
timeZone
description": "
Europe/Madrid
",
        "
locale
type": "
es",
array(float4)"
      }
  
"linq":
 
"from siem.logtrust.web.activity group every 5m by username every 5m select avg(responseTime) as responseTime"

 ],
    "clusters": [],
    "parentId": null,
   
}
 
   
}'
 Expand
titleResponse
Update a specific aggregation task.
 Note
In order to work with Model Management you need to activate Machine Learning permissions in your role. Go to Administration → Roles → Permissions → Machine Learning and activate the view and manage permissions in Models.
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:
Example
Find below a request example in cURL language. In this case, we are updating an aggregation task with ID cc_myDomain:abcDE123 in the domain called myDomain. Learn how to authorize your request in this article.
curl --location --request PUT 'https://api-us.devo.com/aggregations/v2/aggrtasks/myDomain/cc_myDomain:abcDE123' --header 'standAloneToken:YOUR_TOKEN' --header 'Content-Type: application/json' --data '{
    "description": "Aggregation task updated",
    "minGrain": "5m
Successful response. Aggregation task created.
{
 Expand
titleRequest
Path parameters
Add the following path parameters as part of the endpoint:
Parameter
Type
Description
domain required
string
Enter the domain of the aggregation task that you want to update.
aggrId required
string
Enter the ID of the aggregation task that you want to update.
 Note
How can I get the ID of an aggregation task?
To get the ID of an aggregation task, log in to the Devo platform and go to Administration → Data management, locate your aggregation task in the table, click the ellipsis button in its row and select View details. You can copy the internal ID in the details shown in the window that appears.
Learn more about this in Aggregation tasks.
Parameter
Type
Description
query
object
An object that contains three parameters: 
  • LINQ - Base query of the aggregation task, written in LINQ syntax.
  • timezone - Timezone of the aggregation task query, in the following format: Europe/Madrid
  • locale - Locale of the aggregation task query, in the following format: en
description
string
Brief description of the aggregation task.
delay
integer
Maximum acceptable time difference between the current time and the last event displayed. You can indicate it in seconds (1s), minutes (1m), hours (1h) and days (1d).
Default value is 0
minGrain
string
Minimum granularity of the aggregation task. Available values are:
  • AUTO - Calculate best aggregation according to the given query.
  • 1m - Aggregate every minute.
  • 5m - Aggregate every 5 minutes.
  • 30m - Aggregate every 30 minutes.
 Code Block
Code
Description
200
 Code Block
"hidden": false,
    "
id
runtimeSize": 
"cc_myDomain:abcDE123",
876,
    "
name
fileSize": 
"MyNewAggTask"
229468
  },
  {
    "id": 19,
    "
table
name": "
siem.logtrust.web.activity
graeme_test",
    "
wheres
engine": 
[
"ONNX",
    
"eq(client, \"myDomain\")"
"location": "domains/self/82178f93-af1b-4d1b-9438-67b842a6bee8",
  
],
  
 
"
delay
description": 
0
null,
    "
query
updateDate": 
{
1681738747000,
    "
linq
creationDate": 1681738724000,

"from
 
siem.logtrust.web.activity
 
where
 
eq(client,
 
\
"
integrations_factory\") group every 60000 by username, client select sumf(responseTime) as responseTime_sumf
domainName": "self",
    "outputType": "array(float4)",
    "
timeZone
image": 
"Europe/Madrid"
null,
    "
locale
category": "
es
ONNX",
  
},
  
 
"
description
fields": 
"my
[
 
new
 
aggregation
 
task",
   
"domainName
{
        "id": 
"myDomain"
0,
        "
ownerEmail
name": "
john.smith@devo.com
field_0",
        "
creationDate
description": 
1677087818714
"",
    
"updateDate":
 
1677087818714,
   "
status
type": "
PENDING_CREATE",
array(float4)"
      }
   
"statusData":
 
null
],
    "
fromDate
clusters": 
0
}
400
Error in request
401
Unauthorized error.
403
Forbidden request.
404
Not found.
405
Method not allowed.
500
Server error and Java exception.
...
[],
    "parentId": null,
    "hidden": false,
    "runtimeSize": 876,
    "fileSize": 229468
  },
  {
    "id": 17,
    "name": "dga_scoring",
    "engine": "ONNX",
    "location": "domains/self/85132b1f-59fa-4859-9198-e6ce49258916",
    "description": "DGA domain label scoring",
    "updateDate": 1678361980000,
    "creationDate": 1678361980000,
    "domainName": "self",
    "outputType": "array(float4)",
    "image": null,
    "category": "ONNX",
    "fields": [
      {
        "id": 0,
        "name": "field_0",
        "description": "",
        "type": "array(float4)"
      }
    ],
    "clusters": [],
    "parentId": null,
    "hidden": false,
    "runtimeSize": 892,
    "fileSize": null
  },
  {
    "id": 16,
    "name": "pokemon_onnx",
    "
query
engine": 
{
 
"ONNX",
    
  
"
timeZone
location": "
Europe/Madrid",
   
domains/self/dd374598-af8e-4542-8663-e7e8e0cdbf38",
    "
locale
description": "
es",
this is the description",
    
 
"
linq
updateDate": 
"from siem.logtrust.web.activity group every 10m by username every 5m select avg(responseTime) as responseTime"
1678201475000,
    "creationDate": 1678201449000,
    "domainName": "self",
    
} 
"outputType": "array(float4)",
   
}'
 Expand
titleResponse
Stop an aggregation task.
 Note
In order to work with Model Management you need to activate Machine Learning permissions in your role. Go to Administration → Roles → Permissions → Machine Learning and activate the view and manage permissions in Models.
Learn more about roles and permissions in Role permissions.
Path parameters
Add the following path parameters as part of the endpoint:
Example
Find below a request example in cURL language. In this case, we want to stop the aggregation task with ID cc_myDomain:abcDE123 in the domain called myDomain. Learn how to authorize your request in this article.
 Expand
titleRequest
Parameter
Type
Description
domain required
string
Enter the domain of the aggregation task that you want to stop.
aggrId required
string
Enter the ID of the aggregation task that you want to stop.
 Note
How can I get the ID of an aggregation task?
To get the ID of an aggregation task, log in to the Devo platform and go to Administration → Data management, locate your aggregation task in the table, click the ellipsis button in its row and select View details. You can copy the internal ID in the details shown in the window that appears.
Learn more about this in Aggregation tasks.
 Code Block
curl -H "standAloneToken:YOUR_TOKEN" -X PUT "https://api-us.devo.com/aggregations/v2/aggrtasks/myDomain/cc_myDomain:abcDE123/stop"
 Expand
titleResponse
Code
Description
200
Aggregation task successfully updated.
 Code Block{
 
  
"
id
image": 
"cc_myDomain:abcDE123",
null,
    "
name
category": "
MyNewAggTask
ONNX",
    "
table
fields": 
"siem.logtrust.web.activity",
[
  
"wheres":
 
[
   {
 
"eq(client,
 
\"myDomain\")"
   
],
   "
delay
id": 0,
  
"query
      "name": 
{
"field_0",
        "
linq
description": "
from siem.logtrust.web.activity where eq(client, \"integrations_factory\") group every 60000 by username, client select sumf(responseTime) as responseTime_sumf"
",
        "type": "array(float4)"
      }
    ],
    "
timeZone
clusters": 
"Europe/Madrid"
[],
    "
locale
parentId": 
"es"
null,
  
},
  
 
"
description
hidden": 
"Aggregation
false,

task
 
updated",
   "
domainName
runtimeSize": 
"myDomain"
876,
    "
ownerEmail
fileSize": 
"john.smith@devo.com",
229468
  },
  {
    "id": 4,
    "
creationDate
name": 
1677087818714
"gptest",
    "
updateDate
engine": 
1677087818714
"ONNX",
    "
status
location": "
PENDING_CREATE
domains/self/126e92c2-d724-40cf-a6cf-3dc9f63e9219",
    "
statusData
description": 
null
"",
    "
fromDate
updateDate": 1676390228000,
   
0
}
400
Error in request
401
Unauthorized error.
403
Forbidden request.
404
Not found.
405
Method not allowed.
500
Server error and Java exception.
...
Code
Description
200
Aggregation task stopped.
 Code Block
true
400
Error in request
401
Unauthorized error.
403
Forbidden request.
404
Not found.
405
Method not allowed.
500
Server error and Java exception
 "creationDate": 1676390228000,
    "domainName": "self",
    "outputType": "array(float4)",
    "image": null,
    "category": "ONNX",
    "fields": [
      {
        "id": 0,
        "name": "field_0",
        "description": "",
        "type": "array(float4)"
      }
    ],
    "clusters": [],
    "parentId": null,
    "hidden": false,
    "runtimeSize": 876,
    "fileSize": 229468
  },
  {
    "id": 2,
    "name": "RRCF",
    "engine": "IDA",
    "location": "domains/self/f868583b-011d-48ea-970c-eb059f06b951",
    "description": "Testing RRCF in Flow",
    "updateDate": 1676291578000,
    "creationDate": 1676291578000,
    "domainName": "self",
    "outputType": "float8",
    "image": null,
    "category": "Rrcf",
    "fields": [
      {
        "id": 0,
        "name": "dimension_0",
        "description": "",
        "type": "float8"
      }
    ],
    "clusters": [],
    "parentId": null,
    "hidden": false,
    "runtimeSize": 23764,
    "fileSize": 227
  }
]
500
Returned when an error occurred internally in the server.
 Anchor
path7
path7
GET/images/{name}
Start a new task and add aggregated data from a specific dateGet the binary image of a model.
 Note
In order to work with Model Management you need to activate Machine Learning permissions in your role. Go to Administration → Roles → Permissions → Machine Learning and activate the view and manage permissions in Models.
Learn more about roles and permissions in Role permissions.
Server error and Java exception.
 Expand
titleRequest
Path parameters
Add the following path parameters as part of the endpoint:
Code
Description
200
Aggregation task started.
 Code Block
true
400
Error in request
401
Unauthorized error.
403
Forbidden request.
404
Not found.
405
Method not allowed.
500
Parameter
Type
Description
domain required
string
Enter the domain where you want the aggregation task to be.
aggrId required
string
Enter the ID of the aggregation task that you want to start.
 Note
How can I get the ID of an aggregation task?
To get the ID of an aggregation task, log in to the Devo platform and go to Administration → Data management, locate your aggregation task in the table, click the ellipsis button in its row and select View details. You can copy the internal ID in the details shown in the window that appears.
Learn more about this in Aggregation tasks.
Query string parameters
Query string parameters are optionally added after the path parameters, preceded by a question mark (?) and separated by an ampersand (&)
Parameter
Type
Description
from required
integer
Timestamp from when the aggregation task will be started. Format is a timestamp in milliseconds, for example 1652400000000
Example
Find below a request example in cURL language. In this case, we want to start the aggregation task with ID cc_myDomain:abcDE123 in the domain called myDomain from a specific date indicated in the timestamp added to the URL. Learn how to authorize your request in this article.
 Code Block
curl -H "standAloneToken:YOUR_TOKEN" -X PUT "https://api-us.devo.com/aggregations/v2/aggrtasks/myDomain/cc_myDomain:abcDE123/start?from=1652400000000"
 Expand
titleResponse
name required
string
Enter the name of the model you want to get the binary image of.
Example
Find below a request example in cURL language. 
 Code Block
curl -X GET "https://api.stage.devo.com/mlmodelmanager/v3/images/RRCF" -H "accept: */*" -H "standAloneToken: cc81f6f5c73634002183d80b1fb736ec"
 Expand
titleResponse
Code
Description
200
Returns the model file as an octet stream.
 Code Block
{
  "metadata": {
    "id": 123456,
    "name": "human_usable_saved_name",
    "algorithm": "rrcf",
    "version": "1.0"
  },
  "data": {
    "dimensions": 1,
    "shingle": 10,
    "treeSize": 256,
    "trees": 20
  }
}
404
Model not found.
500
Returned when an error occurred internally in the server