{"type":"model","meta":{"id":"/apps/pubhub/media/000-v7-apis/dd098ea54fa0d8f2e015ecf2a096c5f457101655/2b318079-2de1-3227-83c2-794401863dd8","info":{"description":"The Cloud Insights Integrations API lets you programmatically manage **AWS** and **Azure** monitoring integrations in ThousandEyes.\n\n\n### What You Can Do\n\n- **List** all integrations.\n\n- **Get** details for a specific integration.\n\n- **Delete** an existing integration.\n\n- **Create** integrations for:\n\n - **AWS**: inventory monitoring and flow logs monitoring.\n \n - **Azure**: inventory monitoring and flow logs monitoring.\n \n- **Fetch AWS IAM policy documents** required to configure AWS inventory and flow-logs integrations.\n\n- **Retrieve** the current AWS and Azure integration policy settings to understand which AWS and Azure resource groups, AWS regions, Azure subscription rules are enabled and whether CloudTrail is enabled for Cloud Insights for inventory monitoring.\n\n- **Update** policy settings to change the approved AWS resource groups, AWS regions, and Azure subscription rules that ThousandEyes should inventory.\n\n\n### Scope and Tenancy\n\nAll operations are scoped to the authenticated account group. Responses include only resources associated with that group.\n\n\n### Payloads and formats\n\n- **Requests:** `application/json`\n\n- **Responses:** primarily `application/hal+json` for resource representations and `application/json` for policy documents.\n\n- HAL responses include `_links` with a `self` relation for direct navigation.\n\n\n### Integration Types\n\n- **Inventory monitoring**\n\n - AWS: reads inventory and network topology via read-only IAM permissions.\n \n - Azure: authenticates with a Service Principal to read inventory and network topology.\n \n- **Flow logs monitoring**\n\n - AWS: reads flow logs from S3 buckets and uses SNS for notifications.\n \n - Azure: reads flow logs via **Service Bus Queue** (`serviceBusQueueUrl`).\n \n\n### Policy Helpers (AWS)\n\nDedicated endpoints return **Trusted Policy**, **Permissions Policy**, and **SNS Topic Access Policy** documents to simplify role setup for inventory and flow logs integrations.\n\n\n### Notes\n\n- All example values in this specification are **fictitious**.\n\n\nFor more information about Cloud Insights, see [Cloud Insights](https://docs.thousandeyes.com/product-documentation/cloud-insights).\n","title":"Cloud Insights Integrations API","version":"7.0.81"},"security":[{"BearerAuth":[]}],"tags":[{"description":"Manage Cloud Insights integrations for AWS and Azure.","name":"Cloud Insights Integrations"},{"description":"Manage Cloud Insights integration policy settings for AWS and Azure.","name":"Cloud Insights Integration Policy Settings"}],"openapi":"3.0.1","servers":[{"description":"ThousandEyes API production URL","url":"https://api.thousandeyes.com/v7"}],"securitySchemes":{"BearerAuth":{"description":"Bearer authentication token","scheme":"bearer","type":"http"}}},"spec":{"description":"A HAL resource containing a list of Azure inventory and flow logs monitoring integrations.","properties":{"integrations":{"description":"The list of Azure inventory and flow logs monitoring integrations.","items":{"properties":{"id":{"description":"The unique ID for the Azure inventory or flow logs monitoring integration.","example":"e9c3bf02-a48c-4aa8-9e5f-898800d6f569","format":"uuid","type":"string"},"name":{"description":"The name of the Azure inventory or flow logs monitoring integration.","example":"integration name","type":"string"},"appId":{"description":"The Application (client) ID of the service principal.","example":"2f9b2a1c-6d87-4c92-9d51-37efc93c0a4f","type":"string"},"password":{"description":"The client secret value. For security reasons, the client secret value is masked.","example":"********","type":"string"},"azureTenantId":{"description":"The Azure Active Directory tenant ID.","example":"e3a72c9b-42b1-4e0b-9b9f-7f6a3b2a1c44","type":"string"},"serviceBusQueueUrl":{"description":"The URL of the Service Bus Queue. Relevant only for flow logs monitoring integrations.","example":"https://your-service-bus-namespace.servicebus.windows.net/your-queue-name","type":"string"},"monitoringType":{"description":"The type of monitoring integration.","enum":["azure-inventory-monitoring","azure-flow-logs-monitoring"],"example":"azure-inventory-monitoring","type":"string"},"_links":{"description":"A links object containing the self link.","properties":{"self":{"description":"A hyperlink from the containing resource to a URI.","properties":{"href":{"description":"Its value is either a URI [RFC3986] or a URI template [RFC6570].","example":"https://api.thousandeyes.com/v7/link/to/resource/id","type":"string"},"templated":{"description":"Should be true when the link object's \"href\" property is a URI template.","type":"boolean"},"type":{"description":"Used as a hint to indicate the media type expected when dereferencing the target resource.","type":"string"},"deprecation":{"description":"Its presence indicates that the link is to be deprecated at a future date. Its value is a URL that should provide further information about the deprecation.","type":"string"},"name":{"description":"Its value may be used as a secondary key for selecting link objects that share the same relation type.","type":"string"},"profile":{"description":"A URI that hints about the profile of the target resource.","type":"string"},"title":{"description":"Intended for labelling the link with a human-readable identifier","type":"string"},"hreflang":{"description":"Indicates the language of the target resource","type":"string"}},"required":["href"],"type":"object","$$ref":"#/components/schemas/Link"}},"readOnly":true,"type":"object","$$ref":"#/components/schemas/SelfLinks"}},"required":["appId","azureTenantId","id","monitoringType","name","password"],"type":"object","$$ref":"#/components/schemas/AzureMonitoringIntegration"},"type":"array"},"_links":{"description":"A links object containing the self link.","properties":{"self":{"description":"A hyperlink from the containing resource to a URI.","properties":{"href":{"description":"Its value is either a URI [RFC3986] or a URI template [RFC6570].","example":"https://api.thousandeyes.com/v7/link/to/resource/id","type":"string"},"templated":{"description":"Should be true when the link object's \"href\" property is a URI template.","type":"boolean"},"type":{"description":"Used as a hint to indicate the media type expected when dereferencing the target resource.","type":"string"},"deprecation":{"description":"Its presence indicates that the link is to be deprecated at a future date. Its value is a URL that should provide further information about the deprecation.","type":"string"},"name":{"description":"Its value may be used as a secondary key for selecting link objects that share the same relation type.","type":"string"},"profile":{"description":"A URI that hints about the profile of the target resource.","type":"string"},"title":{"description":"Intended for labelling the link with a human-readable identifier","type":"string"},"hreflang":{"description":"Indicates the language of the target resource","type":"string"}},"required":["href"],"type":"object","$$ref":"#/components/schemas/Link"}},"readOnly":true,"type":"object","$$ref":"#/components/schemas/SelfLinks"}},"required":["integrations"],"type":"object","$$ref":"#/components/schemas/AzureMonitoringIntegrations","title":"AzureMonitoringIntegrations"}}