Andrea Test

Return One Third-Party Service Integration

GET /api/atlas/v2/groups/{groupId}/integrations/{integrationType}
Digest auth

Returns the settings for configuring integration with one third-party service. These settings apply to all databases managed in one MongoDB Cloud project. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role.

Path parameters

  • groupId string Required

    Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access.

    NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

    Minimum length is 24, maximum length is 24. Format should match the following pattern: ^([a-f0-9]{24})$.

  • integrationType string Required

    Human-readable label that identifies the service which you want to integrate with MongoDB Cloud.

    Values are PAGER_DUTY, SLACK, DATADOG, NEW_RELIC, OPS_GENIE, VICTOR_OPS, WEBHOOK, HIP_CHAT, PROMETHEUS, or MICROSOFT_TEAMS.

Query parameters

  • envelope boolean

    Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

    Default value is false.

  • pretty boolean

    Flag that indicates whether the response body should be in the prettyprint format.

    Default value is false.

Responses

  • 200 application/vnd.atlas.2023-01-01+json

    OK

    One of:
    DATADOG object MICROSOFT_TEAMS object NEW_RELIC object OPS_GENIE object PAGER_DUTY object PROMETHEUS object SLACK object VICTOR_OPS object WEBHOOK object
  • 400 application/json

    Bad Request.

    Hide response attributes Show response attributes object
    • detail string

      Describes the specific conditions or reasons that cause each type of error.

    • error integer(int32)

      HTTP status code returned with this error.

      External documentation
    • errorCode string

      Application error code returned with this error.

    • parameters array[object]

      Parameters used to give more information about the error.

    • reason string

      Application error message returned with this error.
  • 401 application/json

    Unauthorized.

    Hide response attributes Show response attributes object
    • detail string

      Describes the specific conditions or reasons that cause each type of error.

    • error integer(int32)

      HTTP status code returned with this error.

      External documentation
    • errorCode string

      Application error code returned with this error.

    • parameters array[object]

      Parameters used to give more information about the error.

    • reason string

      Application error message returned with this error.
  • 404 application/json

    Not Found.

    Hide response attributes Show response attributes object
    • detail string

      Describes the specific conditions or reasons that cause each type of error.

    • error integer(int32)

      HTTP status code returned with this error.

      External documentation
    • errorCode string

      Application error code returned with this error.

    • parameters array[object]

      Parameters used to give more information about the error.

    • reason string

      Application error message returned with this error.
  • 500 application/json

    Internal Server Error.

    Hide response attributes Show response attributes object
    • detail string

      Describes the specific conditions or reasons that cause each type of error.

    • error integer(int32)

      HTTP status code returned with this error.

      External documentation
    • errorCode string

      Application error code returned with this error.

    • parameters array[object]

      Parameters used to give more information about the error.

    • reason string

      Application error message returned with this error.
GET /api/atlas/v2/groups/{groupId}/integrations/{integrationType} 
atlas api thirdPartyIntegrations getThirdPartyIntegration --help
import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20230101001/admin"
)

func main() {
	ctx := context.Background()
	clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
	clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")

	// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
	client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))

	if err != nil {
		log.Fatalf("Error: %v", err)
	}

	params = &sdk.GetThirdPartyIntegrationApiParams{}
	sdkResp, httpResp, err := client.Third - PartyIntegrationsApi.
		GetThirdPartyIntegrationWithParams(ctx, params).
		Execute()
}

curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2023-01-01+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}?pretty=true"
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2023-01-01+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}?pretty=true"
Response examples (200) 
{
  "id": "string",
  "type": "DATADOG",
  "apiKey": "****************************a23c",
  "region": "US"
}
{
  "id": "string",
  "type": "MICROSOFT_TEAMS",
  "microsoftTeamsWebhookUrl": "https://webhook.com/****"
}
{
  "id": "string",
  "type": "NEW_RELIC",
  "accountId": "bcc3c81b344a6030a3935c2527e2216535af7718",
  "licenseKey": "bc3768f44193c282b2688ab39e00f8e4fc8d75ea",
  "readToken": "193c96aee4a3ac640b98634562e2631f17ae0a69",
  "writeToken": "a67b10e5cd7f8fb6a34b501136c409f373edc218"
}
{
  "id": "string",
  "type": "OPS_GENIE",
  "apiKey": "********************************a111",
  "region": "US"
}
{
  "id": "string",
  "type": "PAGER_DUTY",
  "region": "US",
  "serviceKey": "****************************7890"
}
{
  "id": "string",
  "type": "PROMETHEUS",
  "enabled": true,
  "serviceDiscovery": "http",
  "username": "prom_user_618d48e05277a606ed2496fe"
}
{
  "id": "string",
  "type": "SLACK",
  "apiToken": "**********************************************************************abcd",
  "channelName": "alerts",
  "teamName": "MongoDB"
}
{
  "id": "string",
  "type": "VICTOR_OPS",
  "apiKey": "********************************9abc",
  "routingKey": "test routing"
}
{
  "id": "string",
  "type": "WEBHOOK",
  "secret": "******",
  "url": "https://webhook.com/****"
}
Response examples (400) 
{
  "error": 400,
  "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  "reason": "Bad Request",
  "errorCode": "VALIDATION_ERROR"
}
Response examples (401) 
{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}
Response examples (404) 
{
  "error": 404,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "reason": "Not Found",
  "errorCode": "RESOURCE_NOT_FOUND"
}
Response examples (500) 
{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}