Integrations latest

Was this page helpful?

Use this endpoint to create, retrieve, update, and delete integrations, which define the connection between an external system and Splunk Observability Cloud.

Integrations store authentication and configuration information that Splunk Observability Cloud uses to connect to the
external system.

Each external provider has its own requirements for integration information. Read the documentation for the request body of the POST or PUT /integration to learn the requirements for the integration you want.

Requirements

You must have an organization access token with the API permission or a session token to use the API.
You have to have the Splunk Observability Cloud admin role to use the POST /integration, GET /integration, GET /integration/{id}, PUT /integration/{id}, DELETE /integration/{id}, and GET /integration/validate/{id} operations.

Authentication

Requests you send to the Integrations endpoint require an authentication token. The type of token you need to use is dependent on the operation you're performing:

To create, update, delete, or validate integrations, you need to use a session token associated with an administrator. This token type is sometimes referred to as an admin token.
To retrieve integrations, you can use an org token with an authScopes value that includes API, or a session token. The session token doesn't have to be an admin token.

Org tokens are also known as access tokens. Session tokens are also known as User API access tokens. To learn more about authentication tokens, see the Authentication Tokens topic in the Developer Guide for Splunk Observability Cloud.

Supported service types

Splunk Observability Cloud offers integrations for the following:

Cloud service providers such as AWS CloudWatch
SSO Authentication systems that use SAML, such as ADFS
Detector alert notification systems such as PagerDuty

Monitoring integrations

Splunk Observability Cloud provides integration support for the following cloud service providers:

Amazon Web Services (AWS)
Google Cloud Platform (GCP)
Microsoft Azure

SSO Authentication using SAML

Splunk Observability Cloud provides integration support for the following SSO systems that use SAML:

Microsoft Active Directory Federation Services (ADFS)
Okta
OneLogin
PingOne

Alert notification systems

Splunk Observability Cloud provides integration support for the following detector alert notification systems:

Amazon EventBridge
BigPanda
Jira
Microsoft Teams
Opsgenie
PagerDuty
ServiceNow
Slack
Splunk On-Call
Webhook
xMatters

Note: To ensure backward compatibility, the type property for a Microsoft Teams integration is Office365.

Viewing request body documentation

The request body format for the following operations depends on the type of integration you use:

POST /integration
PUT /integration/{id}

The response body format for the following operations also depends on the type of integration you use:

GET /integration
GET /integration/{id}

API Base URL

https://api.{REALM}.signalfx.com/v2

Copy to clipboard

Integrations API endpoint URL

GET

/integration

Copy full endpoint URL to clipboard

Retrieves one or more integration objects based on a query specified in query parameters encoded on the URL.

Notes:

To ensure security, the API omits some authentication and authorization properties from response objects.
Note: Splunk Observability Cloud returns a maximum of 10,000 objects, even if your organization contains more than 10,000. To learn more, see the Considerations for retrieve operations section in the Developer Guide for Splunk Observability Cloud.

Jira integration:

The response body for a Jira integration contains a union of the following response properties:

Properties common to all integration responses
Properties common to all Jira integration responses
Authentication credential properties for Jira Cloud integrations
Authentication credential properties for Jira Server integrations

Some Jira integration properties are set to null in the response:

Optional properties that you didn't specify in your creation request
Password or API token, to ensure security
Properties not used for a specific type of Jira integration.

For example, if you integrate with Jira Cloud, the response body contains "username"\: null because username isn't a valid property for a Jira Cloud integration.

Headers

Name	Description
X-SF-TOKEN Required	string Authentication token

Query Parameters

Name	Description
limit	integer <int32> >= 1 Default: 50 Number of integration objects to return from the result set
name	string Integration object name to search for. You can use wildcard characters to specify the name: `*`: Matches a run of any characters in any part of the name `?`: Matches any single character in any part of the name
offset	integer <int32> >= 0 Default: 0 0-relative position in the result set where the API should start returning integration objects.
type	string Type of integration to search for. This property is an enumerated string, and only the enumerated values are allowed. To search for a Microsoft Teams integration, use `Office365`.
userParam	string Return user name values in the response based on the full name value from the user's profile. To return the name of the user who created the integration, specify `userParam=creator`. The system responds by populating the `createdByName` field with the name of the user who created the integration, instead of the default value of `null`. To return the name of the user who last updated the integration, specify `userParam=lastUpdatedBy`. The system responds by populating the `lastUpdatedByName` field with the name of the user who last updated the integration, instead of the default value of `null`. You can specify one or both parameter values. For example, to include both parameters, specify `userParam=creator&userParam=lastUpdatedBy`. This property is an enumerated string, and only the enumerated values are allowed.

Code Examples

cURL

HTTP

curl -X GET "https://api.{REALM}.signalfx.com/v2/integration" \
    -H "Content-Type: application/json" \
    -H "X-SF-TOKEN: <value>"

Copy to clipboard

Response Body

Content Type: application/json

Success

Note: If the request is well-formed but Splunk Observability Cloud can't find any matching integration objects, the API still returns 200. In this case, the count property is set to 0, and the results array is empty.

Name	Description
count	integer <int64> Number of integrations that matched the search criteria. This value is not the number of integrations returned in the response body. To learn more, see the description of `results`.
results	array[object] List of integrations, in the form of a JSON array of JSON objects. Each object contains properties that are common to all integrations as well as properties that are specific to the integration type (`type` property) for the object. The size of `results` and the value of `count` are not necessarily equal: If you don't specify `limit` or `offset`: If `count > 50`, then `sizeOf(results) = 50`; otherwise `sizeOf(results) = count`. If you only specify `limit`: If `count > limit` then `sizeOf(results) = limit`; otherwise `sizeOf(results) = count`. If you specify `limit` and `offset`: If `count > (offset + limit)` then `sizeOf(results) = limit`; otherwise, `sizeOf(results) = limit`.

Response Examples

Content Type: application/json

Collapse children

Copy to clipboard

{  count: 0,
  results: [    {      type: "ADFS",
      created: 1556361030000,
      createdByName: "Dana Cruz",
      creator: "X_xxxx9XXXX",
      enabled: true,
      id: "XXxxxXXXXXX",
      issuerUrl: "https://www.buttercup.com/o/saml2?idpid=999",
      lastUpdated: 1556620230000,
      lastUpdatedBy: "Y_yyyy0YYYY",
      lastUpdatedByName: "Ariel Amal",
      metadata: "FederationMetadata.xml",
      name: "MyIntegration",
      publicKey: "string"
    }
  ]
}

POST

/integration

Copy full endpoint URL to clipboard

Creates an integration object that Splunk Observability Cloud uses to connect with a monitoring, SSO, or alerting service. The steps to establish a connection to a service differ for each type of service and might differ for individual services.

Each service has specific information requirements for integrating with Splunk Observability Cloud.

Notes:

To ensure security, the API omits authentication and authorization properties from response objects.
In the response object, the enabled property is always set to true.

Jira integration: For a Jira integration request, the response body contains a union of the following response properties:

Properties common to all integration responses
Properties common to all Jira integration responses
Authentication credential properties for Jira Cloud integrations
Authentication credential properties for Jira Server integrations

Some Jira integration properties are set to null in the response:

Optional properties that you didn't specify in your creation request
Password or API token, to ensure security
Properties not used for a specific type of Jira integration.

For example, if you integrate with Jira Cloud, the response body contains "username": null because username isn't a valid property for a Jira Cloud integration.

Headers

Name	Description
Content-Type Required	string Format of the request body. Always `"application/json"`.
X-SF-TOKEN Required	string Authentication token. Must be a session token (User API access token) associated with an administrator.

Query Parameters

Name	Description
skipValidation	boolean Flag that controls how Splunk Observability Cloud validates an alert integration object. If `true`, Splunk Observability Cloud doesn't send a test notification.

Code Examples

cURL

HTTP

curl -X POST "https://api.{REALM}.signalfx.com/v2/integration" \
    -H "Content-Type: application/json" \
    -H "X-SF-TOKEN: <value>" \
    -d '{
            "type": "ADFS",
            "enabled": true,
            "issuerUrl": "https://www.buttercup.com/o/saml2?idpid=999",
            "metadata": "FederationMetadata.xml",
            "name": "MyIntegration",
            "publicKey": "string"
        }'

Copy to clipboard

Request Body

Content Type: application/json

Properties of the integration.

Note: Because this is a request to create a new integration, you must specify the type and "name" properties:

type determines the type of integration that Splunk Observability Cloud creates.
name provides a unique name for the integration.

One of

Specifies the SAML integration between Active Directory Federation Services (ADFS) and Splunk Observability Cloud, in the form of a JSON object.

Name	Description
type Required	string Example: ADFS Type of service that this integration represents, in the form of an enumerated string, always `"ADFS"`.
enabled	boolean Example: true Indicates the state of the integration. If `true`, the integration is enabled. If `false`, the integration is disabled, and you must enable it by setting "enabled" to `true` in a PUT request that updates the object. When you create an integration, set this property according to the instructions in the user documentation. Some integrations, such as AWS, expect the initial value to be `false`, which lets you create the integration and use its properties to set values in AWS.
issuerUrl	string <uri> Example: https://www.buttercup.com/o/saml2?idpid=999 URL of the entity that issued the certificate for a SAML integration
metadata	string Example: FederationMetadata.xml File name of the SAML metadata XML file for the integration: `FederationMetadata.xml`
name	string Example: MyIntegration Human-readable label for the integration. Use this property to identify a specific integration when you're using multiple integrations for the same service.
publicKey	string <publickey> Contents of the `certificate.pem` file for the public key associated with the SAML integration

Request Examples

Content Type: application/json

Copy to clipboard

{  type: "ADFS",
  enabled: true,
  issuerUrl: "https://www.buttercup.com/o/saml2?idpid=999",
  metadata: "FederationMetadata.xml",
  name: "MyIntegration",
  publicKey: "string"
}

Response Body

Content Type: application/json

Success

One of

Specifies the SAML integration between Active Directory Federation Services (ADFS) and Splunk Observability Cloud, in the form of a JSON object.

Name	Description
type Required	string Example: ADFS Type of service that this integration represents, in the form of an enumerated string, always `"ADFS"`.
created	integer <int64> Example: 1556361030000 Date and time the integration was created, in the form of a *nix timestamp in milliseconds. Set by Splunk Observability Cloud; read-only
createdByName	string Example: Dana Cruz Name of the user that created the integration. Set to `null` by default. Use `GET /integration` or `GET /integration/{id}` with the `userParam` query parameter to return a user name instead of `null`. Set by Splunk Observability Cloud based on the full name value from the user's profile; read-only.
creator	string Example: X_xxxx9XXXX ID of the user that created the integration. If Splunk Observability Cloud created the object, the value is `"AAAAAAAAAA"`. Set by Splunk Observability Cloud; read-only
enabled	boolean Example: true Indicates the state of the integration. If `true`, the integration is enabled. If `false`, the integration is disabled, and you must enable it by setting "enabled" to `true` in a PUT request that updates the object. When you create an integration, set this property according to the instructions in the user documentation. Some integrations, such as AWS, expect the initial value to be `false`, which lets you create the integration and use its properties to set values in AWS.
id	string Example: XXxxxXXXXXX Splunk Observability Cloud-assigned ID of the integration. Use this property to refer to an integration using the GET, PUT, or DELETE `/integration/{id}` endpoints or the GET `/integration/validate{id}/` endpoint.
issuerUrl	string <uri> Example: https://www.buttercup.com/o/saml2?idpid=999 URL of the entity that issued the certificate for a SAML integration
lastUpdated	integer <int64> Example: 1556620230000 Integration last updated timestamp, in *nix time Set by Splunk Observability Cloud; read-only
lastUpdatedBy	string Example: Y_yyyy0YYYY ID of the user who last updated the integration. If Splunk Observability Cloud last updated the integration, the value is `"AAAAAAAAAA"`. Set by Splunk Observability Cloud; read-only
lastUpdatedByName	string Example: Ariel Amal Name of the user that last updated the integration. Set to `null` by default. Use `GET /integration` or `GET /integration/{id}` with the `userParam` query parameter to return a user name instead of `null`. Set by Splunk Observability Cloud based on the full name value from the user's profile; read-only.
metadata	string Example: FederationMetadata.xml File name of the SAML metadata XML file for the integration: `FederationMetadata.xml`
name	string Example: MyIntegration Human-readable label for the integration. Use this property to identify a specific integration when you're using multiple integrations for the same service.
publicKey	string <publickey> Contents of the `certificate.pem` file for the public key associated with the SAML integration

Response Examples

Content Type: application/json

Copy to clipboard

{  type: "ADFS",
  created: 1556361030000,
  createdByName: "Dana Cruz",
  creator: "X_xxxx9XXXX",
  enabled: true,
  id: "XXxxxXXXXXX",
  issuerUrl: "https://www.buttercup.com/o/saml2?idpid=999",
  lastUpdated: 1556620230000,
  lastUpdatedBy: "Y_yyyy0YYYY",
  lastUpdatedByName: "Ariel Amal",
  metadata: "FederationMetadata.xml",
  name: "MyIntegration",
  publicKey: "string"
}

Headers

Name	Description
X-SF-TOKEN Required	string Authentication token. Must be a session token (User API access token) associated with an administrator.

Path Parameters

Name	Description
id Required	string ID of the existing integration object that you want to validate

Code Examples

cURL

HTTP

curl -X GET "https://api.{REALM}.signalfx.com/v2/integration/validate/{id}" \
    -H "Content-Type: application/json" \
    -H "X-SF-TOKEN: <value>"

Copy to clipboard

Response Body

empty

Successful validation of the integration object

GET

/integration/{id}id (string): ID of the existing integration object that you want to retrieve

Copy full endpoint URL to clipboard

Retrieves the integration object specified by the id path parameter. Note: To ensure security, the API omits some authentication and authorization properties from response objects.

Jira integration:

For a Jira integration request, the response body contains a union of the following response properties:

Properties common to all integration responses
Properties common to all Jira integration responses
Authentication credential properties for Jira Cloud integrations
Authentication credential properties for Jira Server integrations

Some Jira integration properties are set to null in the response:

Optional properties that you didn't specify in your creation request
Password or API token, to ensure security
Properties not used for a specific type of Jira integration.

For example, if you integrate with Jira Cloud, the response body contains "username": null because username isn't a valid property for a Jira Cloud integration.

Headers

Name	Description
X-SF-Token Required	string Authentication token

Path Parameters

Name	Description
id Required	string ID of the existing integration object that you want to retrieve

Query Parameters

Name	Description
userParam	string Return user name values in the response based on the full name value from the user's profile. To return the name of the user who created the integration, specify `userParam=creator`. The system responds by populating the `createdByName` field with the name of the user who created the integration, instead of the default value of `null`. To return the name of the user who last updated the integration, specify `userParam=lastUpdatedBy`. The system responds by populating the `lastUpdatedByName` field with the name of the user who last updated the integration, instead of the default value of `null`. You can specify one or both parameter values. For example, to include both parameters, specify `userParam=creator&userParam=lastUpdatedBy`. This property is an enumerated string, and only the enumerated values are allowed.

Name

Description

userParam

string

Return user name values in the response based on the full name value from the user's profile.

To return the name of the user who created the integration, specify userParam=creator. The system responds by populating the createdByName field with the name of the user who created the integration, instead of the default value of null.

To return the name of the user who last updated the integration, specify userParam=lastUpdatedBy. The system responds by populating the lastUpdatedByName field with the name of the user who last updated the integration, instead of the default value of null.

You can specify one or both parameter values. For example, to include both parameters, specify userParam=creator&userParam=lastUpdatedBy. This property is an enumerated string, and only the enumerated values are allowed.

Code Examples

cURL

HTTP

curl -X GET "https://api.{REALM}.signalfx.com/v2/integration/{id}" \
    -H "Content-Type: application/json" \
    -H "X-SF-Token: <value>"

Copy to clipboard

Response Body

Content Type: application/json

Success

Note: If the request is well-formed but Splunk Observability Cloud can't find the object, the API still returns 200. In this case, the response body is empty.

One of

Specifies the SAML integration between Active Directory Federation Services (ADFS) and Splunk Observability Cloud, in the form of a JSON object.

Name	Description
type Required	string Example: ADFS Type of service that this integration represents, in the form of an enumerated string, always `"ADFS"`.
created	integer <int64> Example: 1556361030000 Date and time the integration was created, in the form of a *nix timestamp in milliseconds. Set by Splunk Observability Cloud; read-only
createdByName	string Example: Dana Cruz Name of the user that created the integration. Set to `null` by default. Use `GET /integration` or `GET /integration/{id}` with the `userParam` query parameter to return a user name instead of `null`. Set by Splunk Observability Cloud based on the full name value from the user's profile; read-only.
creator	string Example: X_xxxx9XXXX ID of the user that created the integration. If Splunk Observability Cloud created the object, the value is `"AAAAAAAAAA"`. Set by Splunk Observability Cloud; read-only
enabled	boolean Example: true Indicates the state of the integration. If `true`, the integration is enabled. If `false`, the integration is disabled, and you must enable it by setting "enabled" to `true` in a PUT request that updates the object. When you create an integration, set this property according to the instructions in the user documentation. Some integrations, such as AWS, expect the initial value to be `false`, which lets you create the integration and use its properties to set values in AWS.
id	string Example: XXxxxXXXXXX Splunk Observability Cloud-assigned ID of the integration. Use this property to refer to an integration using the GET, PUT, or DELETE `/integration/{id}` endpoints or the GET `/integration/validate{id}/` endpoint.
issuerUrl	string <uri> Example: https://www.buttercup.com/o/saml2?idpid=999 URL of the entity that issued the certificate for a SAML integration
lastUpdated	integer <int64> Example: 1556620230000 Integration last updated timestamp, in *nix time Set by Splunk Observability Cloud; read-only
lastUpdatedBy	string Example: Y_yyyy0YYYY ID of the user who last updated the integration. If Splunk Observability Cloud last updated the integration, the value is `"AAAAAAAAAA"`. Set by Splunk Observability Cloud; read-only
lastUpdatedByName	string Example: Ariel Amal Name of the user that last updated the integration. Set to `null` by default. Use `GET /integration` or `GET /integration/{id}` with the `userParam` query parameter to return a user name instead of `null`. Set by Splunk Observability Cloud based on the full name value from the user's profile; read-only.
metadata	string Example: FederationMetadata.xml File name of the SAML metadata XML file for the integration: `FederationMetadata.xml`
name	string Example: MyIntegration Human-readable label for the integration. Use this property to identify a specific integration when you're using multiple integrations for the same service.
publicKey	string <publickey> Contents of the `certificate.pem` file for the public key associated with the SAML integration

Response Examples

Content Type: application/json

Copy to clipboard

{  type: "ADFS",
  created: 1556361030000,
  createdByName: "Dana Cruz",
  creator: "X_xxxx9XXXX",
  enabled: true,
  id: "XXxxxXXXXXX",
  issuerUrl: "https://www.buttercup.com/o/saml2?idpid=999",
  lastUpdated: 1556620230000,
  lastUpdatedBy: "Y_yyyy0YYYY",
  lastUpdatedByName: "Ariel Amal",
  metadata: "FederationMetadata.xml",
  name: "MyIntegration",
  publicKey: "string"
}

PUT

/integration/{id}id (string): ID of the existing integration object that you want to update

Copy full endpoint URL to clipboard

Updates the integration object specified by the id path parameter.

Note: To ensure security, the API omits some authentication and authorization properties from response objects.

Jira integration:

For a Jira integration request, the response body contains a union of the following response properties:

Properties common to all integration responses
Properties common to all Jira integration responses
Authentication credential properties for Jira Cloud integrations
Authentication credential properties for Jira Server integrations

Some Jira integration properties are set to null in the response:

Optional properties that you didn't specify in your creation request
Password or API token, to ensure security
Properties not used for a specific type of Jira integration.

For example, if you integrate with Jira Cloud, the response body contains "username": null because username isn't a valid property for a Jira Cloud integration.

Headers

Name	Description
Content-Type Required	string Format of the request body. Always `"application/json"`.
X-SF-TOKEN Required	string Authentication token. Must be a session token (User API access token) associated with a user who has administrative privileges.

Path Parameters

Name	Description
id Required	string ID of the existing integration object that you want to update

Query Parameters

Name	Description
skipValidation	boolean Flag that controls how Splunk Observability Cloud validates an alert integration object. If `true`, Splunk Observability Cloud doesn't send a test notification.

Code Examples

cURL

HTTP

curl -X PUT "https://api.{REALM}.signalfx.com/v2/integration/{id}" \
    -H "Content-Type: application/json" \
    -H "X-SF-TOKEN: <value>" \
    -d '{
            "type": "ADFS",
            "enabled": true,
            "issuerUrl": "https://www.buttercup.com/o/saml2?idpid=999",
            "metadata": "FederationMetadata.xml",
            "name": "MyIntegration",
            "publicKey": "string"
        }'

Copy to clipboard

Request Body

Content Type: application/json

Properties that Splunk Observability Cloud uses to update the integration object. Each service that Splunk Observability Cloud integrates with has its own properties.

One of

Specifies the SAML integration between Active Directory Federation Services (ADFS) and Splunk Observability Cloud, in the form of a JSON object.

Name	Description
type Required	string Example: ADFS Type of service that this integration represents, in the form of an enumerated string, always `"ADFS"`.
enabled	boolean Example: true Indicates the state of the integration. If `true`, the integration is enabled. If `false`, the integration is disabled, and you must enable it by setting "enabled" to `true` in a PUT request that updates the object. When you create an integration, set this property according to the instructions in the user documentation. Some integrations, such as AWS, expect the initial value to be `false`, which lets you create the integration and use its properties to set values in AWS.
issuerUrl	string <uri> Example: https://www.buttercup.com/o/saml2?idpid=999 URL of the entity that issued the certificate for a SAML integration
metadata	string Example: FederationMetadata.xml File name of the SAML metadata XML file for the integration: `FederationMetadata.xml`
name	string Example: MyIntegration Human-readable label for the integration. Use this property to identify a specific integration when you're using multiple integrations for the same service.
publicKey	string <publickey> Contents of the `certificate.pem` file for the public key associated with the SAML integration

Request Examples

Content Type: application/json

Copy to clipboard

{  type: "ADFS",
  enabled: true,
  issuerUrl: "https://www.buttercup.com/o/saml2?idpid=999",
  metadata: "FederationMetadata.xml",
  name: "MyIntegration",
  publicKey: "string"
}

Response Body

Content Type: application/json

Successful update of the integration object

One of

Specifies the SAML integration between Active Directory Federation Services (ADFS) and Splunk Observability Cloud, in the form of a JSON object.

Name	Description
type Required	string Example: ADFS Type of service that this integration represents, in the form of an enumerated string, always `"ADFS"`.
created	integer <int64> Example: 1556361030000 Date and time the integration was created, in the form of a *nix timestamp in milliseconds. Set by Splunk Observability Cloud; read-only
createdByName	string Example: Dana Cruz Name of the user that created the integration. Set to `null` by default. Use `GET /integration` or `GET /integration/{id}` with the `userParam` query parameter to return a user name instead of `null`. Set by Splunk Observability Cloud based on the full name value from the user's profile; read-only.
creator	string Example: X_xxxx9XXXX ID of the user that created the integration. If Splunk Observability Cloud created the object, the value is `"AAAAAAAAAA"`. Set by Splunk Observability Cloud; read-only
enabled	boolean Example: true Indicates the state of the integration. If `true`, the integration is enabled. If `false`, the integration is disabled, and you must enable it by setting "enabled" to `true` in a PUT request that updates the object. When you create an integration, set this property according to the instructions in the user documentation. Some integrations, such as AWS, expect the initial value to be `false`, which lets you create the integration and use its properties to set values in AWS.
id	string Example: XXxxxXXXXXX Splunk Observability Cloud-assigned ID of the integration. Use this property to refer to an integration using the GET, PUT, or DELETE `/integration/{id}` endpoints or the GET `/integration/validate{id}/` endpoint.
issuerUrl	string <uri> Example: https://www.buttercup.com/o/saml2?idpid=999 URL of the entity that issued the certificate for a SAML integration
lastUpdated	integer <int64> Example: 1556620230000 Integration last updated timestamp, in *nix time Set by Splunk Observability Cloud; read-only
lastUpdatedBy	string Example: Y_yyyy0YYYY ID of the user who last updated the integration. If Splunk Observability Cloud last updated the integration, the value is `"AAAAAAAAAA"`. Set by Splunk Observability Cloud; read-only
lastUpdatedByName	string Example: Ariel Amal Name of the user that last updated the integration. Set to `null` by default. Use `GET /integration` or `GET /integration/{id}` with the `userParam` query parameter to return a user name instead of `null`. Set by Splunk Observability Cloud based on the full name value from the user's profile; read-only.
metadata	string Example: FederationMetadata.xml File name of the SAML metadata XML file for the integration: `FederationMetadata.xml`
name	string Example: MyIntegration Human-readable label for the integration. Use this property to identify a specific integration when you're using multiple integrations for the same service.
publicKey	string <publickey> Contents of the `certificate.pem` file for the public key associated with the SAML integration

Response Examples

Content Type: application/json

Copy to clipboard

{  type: "ADFS",
  created: 1556361030000,
  createdByName: "Dana Cruz",
  creator: "X_xxxx9XXXX",
  enabled: true,
  id: "XXxxxXXXXXX",
  issuerUrl: "https://www.buttercup.com/o/saml2?idpid=999",
  lastUpdated: 1556620230000,
  lastUpdatedBy: "Y_yyyy0YYYY",
  lastUpdatedByName: "Ariel Amal",
  metadata: "FederationMetadata.xml",
  name: "MyIntegration",
  publicKey: "string"
}

Headers

Name	Description
X-SF-TOKEN Required	string Authentication token. Must be a session token (User API access token) associated with an administrator.

Path Parameters

Name	Description
id Required	string ID of the existing integration object that you want to delete

Code Examples

cURL

HTTP

curl -X DELETE "https://api.{REALM}.signalfx.com/v2/integration/{id}" \
    -H "Content-Type: application/json" \
    -H "X-SF-TOKEN: <value>"

Copy to clipboard

Response Body

empty

Success

Response Examples

Content Type: application/json

Copy to clipboard

{  code: 400,
  message: "Invalid ID <ID_VALUE>"
}

Observability API

Integrations latest

Requirements

Authentication

Supported service types

Monitoring integrations

SSO Authentication using SAML

Alert notification systems

Viewing request body documentation

API Base URL

Headers

Query Parameters

Code Examples

Response Body

Response Examples

Headers

Query Parameters

Code Examples

Request Body

Request Examples

Response Body

Response Examples

Headers

Path Parameters

Code Examples

Response Body

Headers

Path Parameters

Query Parameters

Code Examples

Response Body

Response Examples

Headers

Path Parameters

Query Parameters

Code Examples

Request Body

Request Examples

Response Body

Response Examples

Headers

Path Parameters

Code Examples

Response Body

Response Examples