System Route
On this page
System Route
| Name | Method | Endpoint |
|---|---|---|
| Create new global Param | POST | /api/v2/global-params |
| Delete specific global Param | DELETE | /api/v2/global-params/{key} |
| Get all global Params | GET | /api/v2/global-params |
| Retrieve Boomerang Flow Settings | GET | /api/v2/settings |
| Retrieve feature flags. | GET | /api/v2/features |
| Retrieve this instances context, features, and navigation. | GET | /api/v2/context |
| Retrieve navigation. | GET | /api/v2/navigation |
| Register and activate an installation of Flow | PUT | /api/v2/activate |
| **** | PUT | /api/v2/global-params |
| Update Boomerang Flow Settings | PUT | /api/v2/settings |
Create new global Param
POST /api/v2/global-params
Request Parameters
| Name | Type | Required | Description | Notes | Example |
|---|
Request Body
| Schema | Required |
|---|---|
| AbstractParam | true |
Authorization
Note: this section and the documentation around what is required is still actively being updated.
No authorization required
Request Headers
- Content-Type:
application/json - Accept:
*/*
Response
Delete specific global Param
DELETE /api/v2/global-params/{key}
Request Parameters
| Name | Type | Required | Description | Notes | Example |
|---|---|---|---|---|---|
| key | String | true | Defaults to null. | key_example |
Request Body
This endpoint does not require a request body.
Authorization
Note: this section and the documentation around what is required is still actively being updated.
No authorization required
Request Headers
- Content-Type:
Not defined - Accept:
Not defined
Response
null (empty response body)
Get all global Params
GET /api/v2/global-params
Request Parameters
This endpoint does not need any parameter.
Request Body
This endpoint does not require a request body.
Authorization
Note: this section and the documentation around what is required is still actively being updated.
No authorization required
Request Headers
- Content-Type:
Not defined - Accept:
*/*
Response
Retrieve Boomerang Flow Settings
GET /api/v2/settings
Request Parameters
This endpoint does not need any parameter.
Request Body
This endpoint does not require a request body.
Authorization
Note: this section and the documentation around what is required is still actively being updated.
No authorization required
Request Headers
- Content-Type:
Not defined - Accept:
*/*
Response
Retrieve feature flags.
GET /api/v2/features
Request Parameters
This endpoint does not need any parameter.
Request Body
This endpoint does not require a request body.
Authorization
Note: this section and the documentation around what is required is still actively being updated.
No authorization required
Request Headers
- Content-Type:
Not defined - Accept:
*/*
Response
Retrieve this instances context, features, and navigation.
GET /api/v2/context
Request Parameters
This endpoint does not need any parameter.
Request Body
This endpoint does not require a request body.
Authorization
Note: this section and the documentation around what is required is still actively being updated.
No authorization required
Request Headers
- Content-Type:
Not defined - Accept:
*/*
Response
Retrieve navigation.
GET /api/v2/navigation?team=my-amazing-team
Request Parameters
| Name | Type | Required | Description | Notes | Example |
|---|---|---|---|---|---|
| team | String | false | Team as owner reference | Defaults to null. | my-amazing-team |
Request Body
This endpoint does not require a request body.
Authorization
Note: this section and the documentation around what is required is still actively being updated.
No authorization required
Request Headers
- Content-Type:
Not defined - Accept:
*/*
Response
Register and activate an installation of Flow
PUT /api/v2/activate
Request Parameters
| Name | Type | Required | Description | Notes | Example |
|---|
Request Body
| Schema | Required |
|---|---|
| OneTimeCode | false |
Authorization
Note: this section and the documentation around what is required is still actively being updated.
No authorization required
Request Headers
- Content-Type:
application/json - Accept:
*/*
Response
Boolean
****
PUT /api/v2/global-params
Request Parameters
| Name | Type | Required | Description | Notes | Example |
|---|
Request Body
| Schema | Required |
|---|---|
| AbstractParam | true |
Authorization
Note: this section and the documentation around what is required is still actively being updated.
No authorization required
Request Headers
- Content-Type:
application/json - Accept:
*/*
Response
Update Boomerang Flow Settings
PUT /api/v2/settings
Request Parameters
| Name | Type | Required | Description | Notes | Example |
|---|
Request Body
| Schema | Required |
|---|---|
| List | true |
Authorization
Note: this section and the documentation around what is required is still actively being updated.
No authorization required
Request Headers
- Content-Type:
application/json - Accept:
*/*