API >
Public API Resources >
Measurements and Alerts >
Third-Party Integration Settings >
Get the Configuration of a Third-Party Service Integration

Get the Configuration of a Third-Party Service Integration¶

On this page

Syntax
Response Elements
Example Request
Example Response

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¶

copy

GET /groups/{GROUP-ID}/integrations/{INTEGRATION-TYPE}

Request Path Parameters¶

Parameter Necessity Description

{PROJECT-ID} Required Project identifier.

{INTEGRATION-TYPE}

Required

Third-party service identifier. Accepted values are:

DATADOG
HIP_CHAT
PAGER_DUTY
SLACK
NEW_RELIC
OPS_GENIE
VICTOR_OPS
FLOWDOCK
WEBHOOK

Request Query Parameters¶

Name	Type	Necessity	Description	Default
pageNum	number	Optional	One-based integer that returns a subsection of results.	`1`
itemsPerPage	number	Optional	Number of items to return per page, up to a maximum of 500.	`100`
pretty	boolean	Optional	Flag that indicates whether the response body should be in a prettyprint format.	`false`
envelope	boolean	Optional	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 `envelope : true` in the query. For endpoints that return a list of results, the `results` object is an envelope. Ops Manager adds the `status` field to the response body.	`false`

Request Body Parameters¶

This endpoint does not use HTTP request body parameters.

Response Elements¶

The response returns the specified third-party integration configuration object if that service has been configured. If it has not been configured, the response will return an INTEGRATION_NOT_CONFIGURED error.

Each third-party integration configuration object includes a type property equal to its own integration type (like "type": "PAGER_DUTY"). 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

A returned PagerDuty integration configuration object contains the following fields:

Property	Description
`type`	`PAGER_DUTY`
`serviceKey`	Your Service Key.

Slack

A returned Slack integration configuration object contains the following fields:

Property	Description
`type`	`SLACK`
`apiToken`	Your API Token.
`teamName`	Your team name. This field may not be present with a legacy Slack integration.
`channelName`	The configured Slack channel name. An empty string if the value is not set.

Datadog

A returned Datadog integration configuration object contains the following fields:

Property	Description
`type`	`DATADOG`
`apiKey`	Your API Key.

HipChat

A returned HipChat integration configuration object contains the following fields:

Property	Description
`type`	`HIP_CHAT`
`notificationToken`	Notification token for your HipChat user account.
`roomName`	Your HipChat room name.

Opsgenie

A returned Opsgenie integration configuration object contains the following fields:

Property	Description
`type`	`OPS_GENIE`
`apiKey`	Your API Key.
`region`	Indicates which API URL to use, either `US` or `EU`. Opsgenie defaults to `US`.

Note

To set region to EU, you must set a customer setting of opsgenie.api.url.

VictorOps

A returned VictorOps integration configuration object contains the following fields:

Property	Description
`type`	`VICTOR_OPS`
`apiKey`	Your API Key.

The configuration object may also contain the following fields, depending on your configuration:

Property	Description
`routingKey`	An optional field returned if you have a Routing Key configured.

Flowdock

A returned Flowdock integration configuration object contains the following fields:

Property	Description
`type`	`FLOWDOCK`
`flowName`	Your Flowdock Flow name.
`apiToken`	Your API Token.
`orgName`	Your Flowdock organization name.

Webhook Settings

A returned webhook configuration object contains the following fields:

Property	Description
`type`	`WEBHOOK`
`url`	Your webhook URL.

The configuration object may also contain the following fields, depending on your configuration:

Property	Description
`secret`	An optional field returned if your webhook is configured with a secret.

Example Request¶

copy

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --include \
     --request GET "https://mongodb.prakticum-team.ru/proxy/cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/integrations/PAGER_DUTY"

Example Response¶

copy

{
  "serviceKey": "112233",
  "type": "PAGER_DUTY"
}

← Get All Configurations for Third-Party Service Integrations Create a Configuration for a Third-Party Service Integration →