Install Prometheus Integration

Installs all the the supported cloud native foundation integrations.

Path Parameters

  • tenantIdstringrequired

    Described the uuid of the tenant

Request Body

application/json

  • displayNamestring

    Name used to identify the integration.

  • batchExpConfigobject

  • exportConfigobject

  • streamExpConfigobject

  • integrationobject

  • ipAddressstring

    This field is only used for compute integration in the private cloud. When you assign a static IP address (for example, 192.168.64.6), the system uses that specific IP. However, if you specify the IP in any of the following formats, it represents a range of addresses: - 172.26.1.0/24 - 172.26.1.* - 172.26.1.0-172.26.1.255

  • credentialSetstring

    Name of credentialSets. Only used for compute Integration.

  • credentialobject

    Credential details of cloud/saas-apps

  • logosobject

  • categorystring

    Category describes the behavior of custom integration. Applicable only for Custom Integration installation. Example: If monitoring is selected as category, the integration will work as monitoring integration.

    Enum:
    CustomCollaborationMonitoringSSOAutomationADAPTER_INTEGRATIONREPORTING_APPS
  • installedBystring

  • installedTimestring

  • statusstring

  • alertSourceobject

    Source of alert. Applicable only when installing category is Monitoring. Default Alert Source is taken as Custom.

  • directionstring

    Direction of the installation. Applicable only when installing category is Collaboration. The default direction is taken as Inbound-Outbound.

    Enum:
    InboundOutboundInbound-Outbound
  • descriptionstring

  • singleSignOnAuthenticationobject

  • discoveryProfilesarray

    Discovery profile configurations for Cloud and Cloud native resources.

  • inboundConfigobject

  • outboundConfigobject

  • emailPropsarray

  • configDetailsobject

    Export Integration details

  • emailAddressstring

  • ticketTypestring

    OpsRamp supports the following ticket types:

    Enum:
    INCIDENTSERVICEREQUESTCHANGE
  • parentIntgobject

  • deploymentstring

    Specify the k8s deployment environment where k8s cluster is onprem cluster or deployed using cloud provider. **Applicable to prometheus integration** : Optional to specify the deployment environment where the Prometheus agent will be installed.

    Enum:
    cloudonPremVM_UbuntuVM_Redhat

    Default: onPrem

  • containerEngineTypestring

    Specify container runtime engine either Docker, ContainerD, CRI-O

    Enum:
    DockerContainerDCRI-O

    Default: Docker

  • configFilesarray

  • profileobject

Request Body Samples

{
  "displayName": "Kube-Intg",
  "deployment": "onPrem",
  "containerEngineType": "Docker"
}

Responses

    Response Samples

    {
  "id": "INTG-3dabbf8d-af66-4a4f-a8d4-d7ffeb496ba7",
  "displayName": "Kube-Intg",
  "integration": {
    "id": "KUBERNETES",
    "name": "Kubernetes",
    "multipleInstallations": true
  },
  "deployment": "onPrem",
  "configFiles": [
    {
      "id": 0,
      "name": "Kubernetes.yaml",
      "contentURL": "https://cloud-native.api.opsramp.net/api/v2/tenants/client_498/integrations/installed/INTG-3dabbf8d-af66-4a4f-a8d4-d7ffeb496ba7/configFile/Kubernetes"
    },
    {
      "id": 0,
      "name": "statsDMonitoringKubernetes.yaml",
      "contentURL": "https://cloud-native.api.opsramp.net/api/v2/tenants/client_498/integrations/installed/INTG-3dabbf8d-af66-4a4f-a8d4-d7ffeb496ba7/configFile/statsDMonitoringKubernetes"
    }
  ],
  "installedBy": "opsramp_api_user",
  "installedTime": "2020-09-24T05:07:28+0100",
  "containerEngineType": "Docker",
  "status": "enabled"
}