- API >
- Public API Resources >
- Measurements and Alerts >
- Third-Party Integration Settings >
- Create a Configuration for a Third-Party Service Integration
Create a Configuration for a Third-Party Service Integration¶
On this page
Note
Groups and projects are synonymous terms. Your {PROJECT-ID}
is the
same as your project id. For existing groups, your group/project id
remains the same. This page uses the more familiar term group when
referring to descriptions. The endpoint remains as stated in the
document.
Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Syntax¶
Request Path Parameters¶
Parameter | Necessity | Description |
---|---|---|
{PROJECT-ID} |
Required | Project identifier. |
{INTEGRATION-TYPE} |
Required | Third-party service identifier. Accepted values are:
|
Request Query Parameters¶
Name | Type | Description | Default |
---|---|---|---|
pageNum |
number | One-based integer that returns a subsection of results. | 1 |
itemsPerPage |
number | Number of items to return per page, up to a maximum of 500. | 100 |
pretty |
boolean | Flag that indicates whether the response body should be in a prettyprint format. | false |
envelope |
boolean | Flag that indicates whether or not to wrap the response in an envelope. Some API clients cannot access the HTTP response headers or
status code. To remediate this, set For endpoints that return a list of results, the |
false |
Request Body Parameters¶
The request body should be a single integration view (like a JSON
configuration object) for a single third-party service to add to the
project. Always include a type
property equal to the third-party
service INTEGRATION_TYPE
.
Service | Configuration Options | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
PagerDuty | You must provide the following fields when you configure a PagerDuty integration:
|
||||||||||||
Slack | Important Slack integrations now use the OAuth2 verification method and must be initially configured, or updated from a legacy integration, through Ops Manager third-party service integrations. Legacy tokens will soon no longer be supported. You must provide the following fields when you reconfigure an existing Slack integration:
You may also include the following fields:
|
||||||||||||
New Relic | You must provide the following fields when you configure a New Relic integration:
|
||||||||||||
Datadog | You must provide the following fields when you configure a Datadog integration:
|
||||||||||||
HipChat | You must provide the following fields when you configure a HipChat integration:
|
||||||||||||
Opsgenie | You must provide the following fields when you configure a Opsgenie integration:
Note To set |
||||||||||||
VictorOps | You must provide the following fields when you configure a VictorOps integration:
You may also include the following fields:
|
||||||||||||
Flowdock | You must provide the following fields when you configure a VictorOps integration:
|
||||||||||||
Webhook Settings | You must provide the following fields when you configure webhook settings:
You may also include the following fields:
|
Response Elements¶
The response includes a results
array which lists all third-party
integration configurations for the project as objects, and a
totalCount
of the services integrated with the project.
Each third-party integration configuration object includes a type
property equal to its own integration type ("type": "PAGER_DUTY"
for the PagerDuty service). Additionally, each third-party service
configuration object provides details specific to that service. The
following lists the properties returned for each third-party service
configuration object:
Service | Result | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
PagerDuty | PagerDuty integration configuration objects return the following fields:
|
||||||||||||
Slack | Slack integration configuration objects return the following fields:
|
||||||||||||
Datadog | Datadog integration configuration objects return the following fields:
|
||||||||||||
New Relic | New Relic integration configuration objects return the following fields:
|
||||||||||||
HipChat | HipChat integration configuration objects return the following fields:
|
||||||||||||
Opsgenie | Opsgenie integration configuration objects return the following fields:
Note To set |
||||||||||||
VictorOps | VictorOps integration configuration objects return the following fields:
The configuration object may also contain the following fields, depending on your configuration:
|
||||||||||||
Flowdock | Flowdock integration configuration objects return the following fields:
|
||||||||||||
Webhook Settings | Webhook configuration objects return the following fields:
The configuration object may also contain the following fields, depending on your configuration:
|