processes - Documentation

# processes

### Methods

#### (route) retrieveDeployments(:id)

##### Route:

Method | Path
--- | ---
POST | /api/bucket/:id/data/processEvents/deployments

Retrieve deployements of a process

##### Authentication

A authentication is needed to access this endpoint

##### Body Parameters:

Name | Type | Attributes | Description
--- | --- | --- | ---
app_name | String | optional | filter events by app source
server_name | String | optional | filter events by server source

##### Header Parameters:

Name | Type | Description
--- | --- | ---
Authorization | String | bearer access token issued for the user

##### Route Parameters:

Name | Type | Description
--- | --- | ---
:id | String | bucket id

##### Response:

Name | Type | Description
--- | --- | ---
. | Array | array of deployments

##### Response Code:

Type | Description
--- | ---
500 | database error
200 | succesfully retrieved data

##### Parameters:

Name | Type | Description
--- | --- | ---
`:id` |  | bucket id

#### (route) retrieveEvents(:id)

##### Route:

Method | Path
--- | ---
POST | /api/bucket/:id/data/processEvents

Retrieve events about a process

##### Authentication

A authentication is needed to access this endpoint

##### Body Parameters:

Name | Type | Attributes | Default | Description
--- | --- | --- | --- | ---
app_name | String | optional |  | filter events by app source
server_name | String | optional |  | filter events by server source
before | String | optional | 60 | filter out events that are after X minute

##### Header Parameters:

Name | Type | Description
--- | --- | ---
Authorization | String | bearer access token issued for the user

##### Route Parameters:

Name | Type | Description
--- | --- | ---
:id | String | bucket id

##### Response:

Name | Type | Description
--- | --- | ---
. | Array | array of process events

##### Response Code:

Type | Description
--- | ---
500 | database error
200 | succesfully retrieved data

##### Parameters:

Name | Type | Description
--- | --- | ---
`:id` |  | bucket id