diff --git a/assets/scripts/config/regions.config.js b/assets/scripts/config/regions.config.js index 074bcf1b03221..08e5425215064 100644 --- a/assets/scripts/config/regions.config.js +++ b/assets/scripts/config/regions.config.js @@ -561,5 +561,32 @@ export default { ap1: '720 hours (30 days)', ap2: '720 hours (30 days)', gov: '12 hours' + }, + jenkins_site_name: { + us: 'US1', + us3: 'US3', + us5: 'US5', + eu: 'EU1', + ap1: 'AP1', + ap2: 'AP2', + gov: 'US1_FED' + }, + synthetics_tunnel_endpoint: { + us: 'tunnel-us1.synthetics.datadoghq.com', + us3: 'tunnel-us3.synthetics.datadoghq.com', + us5: 'tunnel-us5.synthetics.datadoghq.com', + eu: 'tunnel-eu1.synthetics.datadoghq.com', + ap1: 'tunnel-ap1.synthetics.datadoghq.com', + ap2: 'tunnel-ap2.synthetics.datadoghq.com', + gov: 'N/A' + }, + dogwrap_site_flag: { + us: '', + us3: ' -s us3', + us5: ' -s us5', + eu: ' -s eu', + ap1: '', + ap2: '', + gov: '' } }; diff --git a/config/_default/menus/api.en.yaml b/config/_default/menus/api.en.yaml index 1a9592b48a332..9346226be7c8f 100644 --- a/config/_default/menus/api.en.yaml +++ b/config/_default/menus/api.en.yaml @@ -10994,6 +10994,49 @@ menu: unstable: - v2 order: 2 + - name: Team Connections + url: /api/latest/team-connections/ + identifier: team-connections + generated: true + - name: Create team connections + url: '#create-team-connections' + identifier: team-connections-create-team-connections + parent: team-connections + generated: true + params: + versions: + - v2 + operationids: + - CreateTeamConnections + unstable: + - v2 + order: 2 + - name: List team connections + url: '#list-team-connections' + identifier: team-connections-list-team-connections + parent: team-connections + generated: true + params: + versions: + - v2 + operationids: + - ListTeamConnections + unstable: + - v2 + order: 1 + - name: Delete team connections + url: '#delete-team-connections' + identifier: team-connections-delete-team-connections + parent: team-connections + generated: true + params: + versions: + - v2 + operationids: + - DeleteTeamConnections + unstable: + - v2 + order: 3 - name: Teams url: /api/latest/teams/ identifier: teams diff --git a/config/_default/menus/main.en.yaml b/config/_default/menus/main.en.yaml index 0a978c2138c9b..48f28f1688dea 100644 --- a/config/_default/menus/main.en.yaml +++ b/config/_default/menus/main.en.yaml @@ -2789,12 +2789,24 @@ menu: parent: case_management identifier: case_management_troubleshooting weight: 7 + - name: Action Interface + url: actions/action_interface/ + pre: bits-ai + parent: actions_heading + identifier: action_interface + weight: 10000 + - name: Agents + url: actions/agents/ + pre: robot-wui + identifier: agents + parent: actions_heading + weight: 20000 - name: Workflow Automation url: actions/workflows/ pre: workflows identifier: workflows parent: actions_heading - weight: 10000 + weight: 30000 - name: Build Workflows url: actions/workflows/build/ parent: workflows @@ -2855,7 +2867,7 @@ menu: pre: app-builder identifier: app_builder parent: actions_heading - weight: 20000 + weight: 40000 - name: Build Apps url: actions/app_builder/build/ parent: app_builder @@ -2948,7 +2960,7 @@ menu: pre: books parent: actions_heading identifier: action_catalog - weight: 50000 + weight: 60000 - name: Connections url: actions/connections/ parent: action_catalog @@ -3084,216 +3096,221 @@ menu: parent: infrastructure_livecontainers identifier: infrastructure_livecontainers_amazon_elastic_container_explorer weight: 106 + - name: Autoscaling + url: containers/autoscaling + parent: containers + identifier: containers_autoscaling + weight: 2 - name: Docker and other runtimes url: containers/docker/ parent: containers identifier: containers_docker - weight: 2 + weight: 3 - name: APM url: containers/docker/apm/ parent: containers_docker identifier: containers_docker_apm - weight: 201 + weight: 301 - name: Log collection url: containers/docker/log/ parent: containers_docker identifier: containers_docker_log - weight: 202 + weight: 302 - name: Tag extraction url: containers/docker/tag/ parent: containers_docker identifier: containers_docker_tag - weight: 203 + weight: 303 - name: Integrations url: containers/docker/integrations/ parent: containers_docker identifier: containers_docker_integrations - weight: 204 + weight: 304 - name: Prometheus url: containers/docker/prometheus/ parent: containers_docker identifier: containers_docker_prometheus - weight: 205 + weight: 305 - name: Data Collected url: containers/docker/data_collected/ parent: containers_docker identifier: containers_docker_data_collected - weight: 206 + weight: 306 - name: Kubernetes url: containers/kubernetes/ parent: containers identifier: containers_kubernetes - weight: 3 + weight: 4 - name: Installation url: containers/kubernetes/installation parent: containers_kubernetes identifier: containers_kubernetes_installation - weight: 301 + weight: 401 - name: Further Configuration url: containers/kubernetes/configuration parent: containers_kubernetes identifier: containers_kubernetes_configuration - weight: 302 + weight: 402 - name: Distributions url: containers/kubernetes/distributions parent: containers_kubernetes identifier: containers_kubernetes_distributions - weight: 303 + weight: 403 - name: APM url: containers/kubernetes/apm/ parent: containers_kubernetes identifier: containers_kubernetes_apm - weight: 304 + weight: 404 - name: Log collection url: containers/kubernetes/log/ parent: containers_kubernetes identifier: containers_kubernetes_log - weight: 305 + weight: 405 - name: Tag extraction url: containers/kubernetes/tag/ parent: containers_kubernetes identifier: containers_kubernetes_tag - weight: 306 + weight: 406 - name: Integrations url: containers/kubernetes/integrations/ parent: containers_kubernetes identifier: containers_kubernetes_integrations - weight: 307 + weight: 407 - name: Prometheus & OpenMetrics url: containers/kubernetes/prometheus/ parent: containers_kubernetes identifier: containers_kubernetes_prometheus - weight: 308 + weight: 408 - name: Control plane monitoring url: containers/kubernetes/control_plane/ parent: containers_kubernetes identifier: containers_kubernetes_control_plane - weight: 309 + weight: 409 - name: Data collected url: containers/kubernetes/data_collected/ parent: containers_kubernetes identifier: containers_kubernetes_data_collected - weight: 310 + weight: 410 + - name: Datadog CSI Driver + url: containers/kubernetes/csi_driver + parent: containers_kubernetes + identifier: csi_driver + weight: 411 - name: Data security url: data_security/kubernetes parent: containers_kubernetes identifier: container_kubernetes_data_security - weight: 311 + weight: 412 - name: Cluster Agent url: containers/cluster_agent/ parent: containers identifier: containers_cluster - weight: 4 + weight: 5 - name: Setup url: containers/cluster_agent/setup/ parent: containers_cluster identifier: cluster_agent_setup - weight: 401 + weight: 501 - name: Commands & Options url: containers/cluster_agent/commands/ identifier: cluster_agent_commands parent: containers_cluster - weight: 402 + weight: 502 - name: Cluster Checks identifier: containers_cluster_agent_clusterchecks url: containers/cluster_agent/clusterchecks/ parent: containers_cluster - weight: 403 + weight: 503 - name: Endpoint Checks identifier: containers_cluster_agent_endpoint_checks url: containers/cluster_agent/endpointschecks/ parent: containers_cluster - weight: 404 + weight: 504 - name: Admission Controller identifier: containers_cluster_agent_admission_controller url: containers/cluster_agent/admission_controller/ parent: containers_cluster - weight: 405 + weight: 505 - name: Amazon ECS url: containers/amazon_ecs/ parent: containers identifier: containers_amazon_ecs - weight: 5 + weight: 6 - name: APM url: containers/amazon_ecs/apm/ parent: containers_amazon_ecs identifier: containers_amazon_ecs_apm - weight: 501 + weight: 601 - name: Log collection url: containers/amazon_ecs/logs/ parent: containers_amazon_ecs identifier: containers_amazon_ecs_logs - weight: 502 + weight: 602 - name: Tag extraction url: containers/amazon_ecs/tags/ parent: containers_amazon_ecs identifier: containers_amazon_ecs_tags - weight: 503 + weight: 603 - name: Data collected url: containers/amazon_ecs/data_collected/ parent: containers_amazon_ecs identifier: containers_amazon_ecs_data_collected - weight: 504 + weight: 604 - name: AWS Fargate url: integrations/ecs_fargate/ parent: containers identifier: ecs_fargate - weight: 6 + weight: 7 - name: Datadog Operator url: containers/datadog_operator identifier: containers_datadog_operator parent: containers - weight: 7 + weight: 8 - name: Advanced Install url: containers/datadog_operator/advanced_install identifier: containers_datadog_operator_installation parent: containers_datadog_operator - weight: 701 + weight: 801 - name: Configuration url: containers/datadog_operator/config identifier: containers_datadog_operator_configuration parent: containers_datadog_operator - weight: 702 + weight: 802 - name: Custom Checks url: containers/datadog_operator/custom_check identifier: containers_datadog_operator_customchecks parent: containers_datadog_operator - weight: 703 + weight: 803 - name: Data Collected url: containers/datadog_operator/data_collected identifier: containers_datadog_operator_datacollected parent: containers_datadog_operator - weight: 704 + weight: 804 - name: kubectl Plugin url: containers/datadog_operator/kubectl_plugin identifier: containers_datadog_operator_kubectlplugin parent: containers_datadog_operator - weight: 705 + weight: 805 - name: Secret Management url: containers/datadog_operator/secret_management identifier: containers_datadog_operator_secretmanagement parent: containers_datadog_operator - weight: 706 + weight: 806 - name: DatadogDashboard CRD url: containers/datadog_operator/crd_dashboard identifier: containers_datadog_operator_crd_dashboard parent: containers_datadog_operator - weight: 707 + weight: 807 - name: DatadogMonitor CRD url: containers/datadog_operator/crd_monitor identifier: containers_datadog_operator_crd_monitor parent: containers_datadog_operator - weight: 708 + weight: 808 - name: DatadogSLO CRD url: containers/datadog_operator/crd_slo identifier: containers_datadog_operator_crd_slo parent: containers_datadog_operator - weight: 709 - - name: Datadog CSI Driver - url: containers/csi_driver - parent: containers - identifier: csi_driver - weight: 8 + weight: 809 - name: Troubleshooting url: containers/troubleshooting/ parent: containers @@ -3904,11 +3921,6 @@ menu: parent: cloud_cost_recommendations identifier: cloud_cost_custom_recommendations weight: 601 - - name: Savings - url: cloud_cost_management/recommendations/savings - parent: cloud_cost_recommendations - identifier: cloud_cost_savings - weight: 602 - name: Planning url: cloud_cost_management/planning parent: cloud_cost @@ -4936,11 +4948,16 @@ menu: parent: llm_obs_monitoring identifier: llm_obs_agent_monitoring weight: 304 + - name: Prompt Tracking + url: llm_observability/monitoring/prompt_tracking + parent: llm_obs_monitoring + identifier: llm_obs_prompt_tracking + weight: 305 - name: Metrics url: llm_observability/monitoring/metrics parent: llm_obs_monitoring identifier: llm_obs_monitoring_metrics - weight: 305 + weight: 306 - name: Evaluations url: llm_observability/evaluations/ parent: llm_obs @@ -5464,11 +5481,16 @@ menu: parent: software_delivery_heading identifier: feature_flags weight: 80000 + - name: MCP Server + url: feature_flags/feature_flag_mcp_server + parent: feature_flags + identifier: feature_flags_mcp_server + weight: 8 - name: Guides url: feature_flags/guide parent: feature_flags identifier: feature_flags_guide - weight: 1 + weight: 9 - name: Observability Pipelines url: observability_pipelines/ pre: pipelines @@ -5820,56 +5842,161 @@ menu: parent: observability_pipelines_destinations identifier: observability_pipelines_syslog weight: 421 + - name: Packs + url: observability_pipelines/packs/ + parent: observability_pipelines + identifier: observability_pipelines_packs + weight: 5 + - name: Akamai CDN + url: observability_pipelines/packs/akamai_cdn/ + parent: observability_pipelines_packs + identifier: observability_pipelines_packs_akamai_cdn + weight: 501 + - name: Amazon CloudFront + url: observability_pipelines/packs/amazon_cloudfront/ + parent: observability_pipelines_packs + identifier: observability_pipelines_packs_amazon_cloudfront + weight: 502 + - name: Amazon VPC Flow Logs + url: observability_pipelines/packs/amazon_vpc_flow_logs/ + parent: observability_pipelines_packs + identifier: observability_pipelines_packs_amazon_vpc_flow_logs + weight: 503 + - name: AWS CloudTrail + url: observability_pipelines/packs/aws_cloudtrail/ + parent: observability_pipelines_packs + identifier: observability_pipelines_packs_aws_cloudtrail + weight: 504 + - name: Cisco ASA + url: observability_pipelines/packs/cisco_asa/ + parent: observability_pipelines_packs + identifier: observability_pipelines_packs_cisco_asa + weight: 505 + - name: Cloudflare + url: observability_pipelines/packs/cloudflare/ + parent: observability_pipelines_packs + identifier: observability_pipelines_packs_cloudflare + weight: 506 + - name: F5 + url: observability_pipelines/packs/f5/ + parent: observability_pipelines_packs + identifier: observability_pipelines_packs_f5 + weight: 507 + - name: Fastly + url: observability_pipelines/packs/fastly/ + parent: observability_pipelines_packs + identifier: observability_pipelines_packs_fastly + weight: 508 + - name: Fortinet Firewall + url: observability_pipelines/packs/fortinet_firewall/ + parent: observability_pipelines_packs + identifier: observability_pipelines_packs_fortinet_firewall + weight: 509 + - name: HAProxy Ingress + url: observability_pipelines/packs/haproxy_ingress/ + parent: observability_pipelines_packs + identifier: observability_pipelines_packs_haproxy_ingress + weight: 510 + - name: Istio Proxy + url: observability_pipelines/packs/istio_proxy/ + parent: observability_pipelines_packs + identifier: observability_pipelines_packs_istio_proxy + weight: 511 + - name: Netskope + url: observability_pipelines/packs/netskope/ + parent: observability_pipelines_packs + identifier: observability_pipelines_packs_netskope + weight: 512 + - name: NGINX + url: observability_pipelines/packs/nginx/ + parent: observability_pipelines_packs + identifier: observability_pipelines_packs_nginx + weight: 513 + - name: Okta + url: observability_pipelines/packs/okta/ + parent: observability_pipelines_packs + identifier: observability_pipelines_packs_okta + weight: 514 + - name: Palo Alto Firewall + url: observability_pipelines/packs/palo_alto_firewall/ + parent: observability_pipelines_packs + identifier: observability_pipelines_packs_palo_alto_firewall + weight: 515 + - name: Windows XML + url: observability_pipelines/packs/windows_xml/ + parent: observability_pipelines_packs + identifier: observability_pipelines_packs_windows_xml + weight: 516 + - name: ZScaler ZIA DNS + url: observability_pipelines/packs/zscaler_zia_dns/ + parent: observability_pipelines_packs + identifier: observability_pipelines_packs_zscaler_zia_dns + weight: 517 + - name: Zscaler ZIA Firewall + url: observability_pipelines/packs/zscaler_zia_firewall/ + parent: observability_pipelines_packs + identifier: observability_pipelines_packs_zscaler_zia_firewall + weight: 518 + - name: Zscaler ZIA Tunnel + url: observability_pipelines/packs/zscaler_zia_tunnel/ + parent: observability_pipelines_packs + identifier: observability_pipelines_packs_zscaler_zia_tunnel + weight: 519 + - name: Zscaler ZIA Web Logs + url: observability_pipelines/packs/zscaler_zia_web_logs/ + parent: observability_pipelines_packs + identifier: observability_pipelines_packs_zscaler_zia_web_logs + weight: 520 - name: Search Syntax url: observability_pipelines/search_syntax/ parent: observability_pipelines identifier: observability_pipelines_search_syntax - weight: 5 + weight: 6 - name: Scaling and Performance url: observability_pipelines/scaling_and_performance/ parent: observability_pipelines identifier: observability_pipelines_scaling_and_performance - weight: 6 + weight: 7 - name: Handling Load and Backpressure url: observability_pipelines/scaling_and_performance/handling_load_and_backpressure/ parent: observability_pipelines_scaling_and_performance identifier: observability_pipelines_handling_load_and_backpressure - weight: 601 + weight: 701 - name: Best Practices for Scaling Observability Pipelines url: observability_pipelines/scaling_and_performance/best_practices_for_scaling_observability_pipelines/ parent: observability_pipelines_scaling_and_performance identifier: observability_pipelines_best_practices_for_scaling_observability_pipelines - weight: 602 + weight: 702 - name: Monitoring and Troubleshooting url: observability_pipelines/monitoring_and_troubleshooting/ parent: observability_pipelines identifier: observability_pipelines_monitoring_and_troubleshooting - weight: 7 + weight: 8 - name: Worker CLI Commands url: observability_pipelines/monitoring_and_troubleshooting/worker_cli_commands/ parent: observability_pipelines_monitoring_and_troubleshooting identifier: observability_pipelines_worker_cli_commands - weight: 701 + weight: 801 - name: Monitoring Pipelines url: observability_pipelines/monitoring_and_troubleshooting/monitoring_pipelines/ parent: observability_pipelines_monitoring_and_troubleshooting identifier: observability_pipelines_monitoring_pipelines - weight: 702 + weight: 802 - name: Pipeline Usage Metrics url: observability_pipelines/monitoring_and_troubleshooting/pipeline_usage_metrics/ parent: observability_pipelines_monitoring_and_troubleshooting identifier: observability_pipelines_pipeline_usage_metrics - weight: 703 + weight: 803 - name: Troubleshooting url: observability_pipelines/monitoring_and_troubleshooting/troubleshooting/ identifier: observability_pipelines_troubleshooting parent: observability_pipelines_monitoring_and_troubleshooting - weight: 704 + weight: 804 - name: Guides url: observability_pipelines/guide/ parent: observability_pipelines identifier: observability_pipelines_guide - weight: 8 + weight: 9 - name: Log Management url: logs/ pre: log @@ -7039,6 +7166,11 @@ menu: url: /security/code_security/secret_scanning/generic_ci_providers/ parent: sec_secret_scanning weight: 2 + - name: Secret Validation + identifier: sec_secret_scanning_secret_validation + url: /security/code_security/secret_scanning/secret_validation/ + parent: sec_secret_scanning + weight: 3 - name: Runtime Code Analysis (IAST) identifier: sec_iast url: /security/code_security/iast/ @@ -7667,6 +7799,11 @@ menu: parent: rum_mobile_ios identifier: rum_mobile_ios_supported_versions weight: 110 + - name: SDK Performance Impact + url: real_user_monitoring/application_monitoring/ios/sdk_performance_impact + parent: rum_mobile_ios + identifier: rum_mobile_ios_performance_overhead + weight: 111 - name: Flutter url: real_user_monitoring/application_monitoring/flutter parent: application_monitoring @@ -8344,51 +8481,56 @@ menu: identifier: account_management_saml parent: account_management weight: 4 + - name: Configuring SAML + url: account_management/saml/configuration/ + identifier: account_management_saml_configuration + parent: account_management_saml + weight: 401 - name: User Group Mapping url: account_management/saml/mapping/ identifier: account_management_saml_mapping parent: account_management_saml - weight: 401 + weight: 402 - name: Active Directory url: account_management/saml/activedirectory/ identifier: account_management_saml_activedirectory parent: account_management_saml - weight: 402 + weight: 403 - name: Auth0 url: account_management/saml/auth0/ identifier: account_management_saml_auth0 parent: account_management_saml - weight: 403 + weight: 404 - name: Entra ID url: account_management/saml/entra/ identifier: account_management_saml_entra parent: account_management_saml - weight: 404 + weight: 405 - name: Google url: account_management/saml/google/ identifier: account_management_saml_google parent: account_management_saml - weight: 405 + weight: 406 - name: LastPass url: account_management/saml/lastpass/ identifier: account_management_saml_lastpass parent: account_management_saml - weight: 406 + weight: 407 - name: Okta url: account_management/saml/okta/ identifier: account_management_saml_okta parent: account_management_saml - weight: 407 + weight: 408 - name: SafeNet url: account_management/saml/safenet/ identifier: account_management_saml_safenet parent: account_management_saml - weight: 408 + weight: 409 - name: Troubleshooting url: account_management/saml/troubleshooting/ identifier: account_management_samle_troubleshooting parent: account_management_saml - weight: 409 + weight: 410 - name: SCIM url: account_management/scim/ parent: account_management diff --git a/config/_default/params.yaml b/config/_default/params.yaml index c7c79cf9d97a5..18f15cf49beb7 100644 --- a/config/_default/params.yaml +++ b/config/_default/params.yaml @@ -277,6 +277,7 @@ unsupported_sites: continuous_delivery: [gov] continuous_integration: [gov] correlation: [gov] #Event management correlation + cloudprem: [gov] data_jobs: [gov] datadog_cloudcraft: [gov] ddot_collector: [gov] @@ -307,7 +308,6 @@ unsupported_sites: pr_gates: [gov] remote_config: [gov] remote_configuration: [gov] - resource_catalog: [gov] roku_error_tracking: [gov] roku_log_collection: [gov] rum_roku: [gov] diff --git a/content/en/account_management/saml/_index.md b/content/en/account_management/saml/_index.md index 94f8a63d43b62..905c0f97f77b9 100644 --- a/content/en/account_management/saml/_index.md +++ b/content/en/account_management/saml/_index.md @@ -28,30 +28,7 @@ Configuring [SAML (Security Assertion Markup Language)][1] for your Datadog acco ## Configuring SAML -1. To begin configuration, see your IdP's documentation: - - * [Active Directory][10] - * [Auth0][11] - * [Google][13] - * [Microsoft Entra ID][12] - * [NoPassword][14] - * [Okta][15] - * [SafeNet][16] - -2. In the Datadog app, hover over your username in the bottom left corner and select Organization Settings. Select [Login Methods][17] and click on **Configure** under SAML. - -3. Upload the IdP metadata from your SAML identity provider by clicking the **Choose File** button. After choosing the file, click **Upload File**. - -**Note:** The IdP metadata must contain ASCII characters only. - -4. Download Datadog's [Service Provider metadata][18] to configure your IdP to recognize Datadog as a Service Provider. - -5. After you upload the IdP metadata and configure your IdP, enable SAML in Datadog by clicking the **Upload and Enable** button. - {{< img src="account_management/saml/saml_enable_cropped.png" alt="Configure SAML by uploading your IdP metadata" >}} - -6. After uploading the IdP metadata, return to the **Login Methods** page and turn SAML `on` by default. - -**Note**: To configure SAML for a multi-org, see [Managing Multiple-Organization Accounts][21]. +See [Configuring Single Sign-On With SAML][2] for instructions. ## Using SAML @@ -59,7 +36,7 @@ After SAML is configured in Datadog and your IdP is set up to accept requests fr ### SP-initiated login -SP-initiated, or Service Provider-initiated, means login initiated from Datadog. Users log in through the **Single Sign-on URL** shown in the status box at the top of the [SAML Configuration page][19]. The **Single Sign-on URL** is also displayed on the [Team page][20]. Loading this URL initiates a SAML authentication against your IdP. **Note**: This URL only displays if SAML is enabled for your account and you are using SP-initiated login. +SP-initiated, or Service Provider-initiated, means login initiated from Datadog. Users log in through the **Single Sign-on URL** shown in the status box at the top of the [SAML Configuration page][4]. Loading this URL initiates a SAML authentication against your IdP. **Note**: This URL only displays if SAML is enabled for your account and you are using SP-initiated login. {{< img src="account_management/saml/saml_enabled_cropped.png" alt="Confirmation that SAML Enabled" >}} @@ -83,7 +60,7 @@ When a login occurs, a SAML Assertion containing user authorization is sent from * Assertions must be signed. * Assertions can be encrypted, but unencrypted assertions are accepted. -* Reference [Datadog's Service Provider metadata][18] for more information. You must be signed in to Datadog to access the file. +* Reference [Datadog's Service Provider metadata][3] for more information. You must be signed in to Datadog to access the file. ### Supported attributes @@ -115,9 +92,9 @@ If **sn** and **givenName** are provided, they are used to update the user's nam ## Additional features -To map attributes in your identity provider's response to Datadog roles and teams, see [SAML group mapping][22]. +To map attributes in your identity provider's response to Datadog roles and teams, see [SAML group mapping][5]. -The following features can be enabled through the [SAML Configuration dialog][19]: +The following features can be enabled through the [SAML Configuration dialog][4]: **Note:** You must have Admin permissions to see the SAML Configuration dialog. @@ -145,7 +122,7 @@ If you do not use the updated SP metadata, Datadog is not able to associate the ### SAML strict -You can make your organization SAML Strict by disabling other login method types in the **Login Methods** UI. When this option is configured, all users must, by default, log in with SAML. An existing username/password or Google OAuth login does not work. This ensures that all users with access to Datadog must have valid credentials in your company's identity provider/directory service to access your Datadog account. Org administrators can set per-user [overrides][23] to allow certain users to be SAML Strict exempt. +You can make your organization SAML Strict by disabling other login method types in the **Login Methods** UI. When this option is configured, all users must, by default, log in with SAML. An existing username and password, or Google OAuth login, does not work. This ensures that all users with access to Datadog must have valid credentials in your company's identity provider or directory service to access your Datadog account. Org administrators can set per-user [overrides][6] to allow certain users to be SAML Strict exempt. ### Self-updating Datadog SP metadata @@ -158,25 +135,8 @@ Certain Identity Providers (such as Microsoft's ADFS) can be configured to pull {{< partial name="whats-next/whats-next.html" >}} [1]: http://en.wikipedia.org/wiki/Security_Assertion_Markup_Language -[2]: /help/ -[3]: https://learn.microsoft.com/en-us/entra/architecture/auth-saml -[4]: https://auth0.com/docs/protocols/saml-protocol -[5]: https://cloud.google.com/architecture/identity/single-sign-on -[6]: https://support.logmeininc.com/lastpass/help/lastpass-admin-toolkit-using-single-sign-on-sso -[7]: https://developer.okta.com/docs/concepts/saml/ -[8]: https://thalesdocs.com/sta/operator/applications/apps_saml/index.html -[9]: /account_management/users/default_roles/ -[10]: /account_management/saml/activedirectory/ -[11]: /account_management/saml/auth0/ -[12]: /account_management/saml/entra/ -[13]: /account_management/saml/google/ -[14]: /account_management/saml/nopassword/ -[15]: /account_management/saml/okta/ -[16]: /account_management/saml/safenet/ -[17]: https://app.datadoghq.com/organization-settings/login-methods -[18]: https://app.datadoghq.com/account/saml/metadata.xml -[19]: https://app.datadoghq.com/saml/saml_setup -[20]: https://app.datadoghq.com/account/team -[21]: /account_management/multi_organization/#setting-up-saml -[22]: /account_management/saml/mapping/ -[23]: /account_management/login_methods/#reviewing-user-overrides +[2]: /account_management/saml/configuration +[3]: https://app.datadoghq.com/account/saml/metadata.xml +[4]: https://app.datadoghq.com/organization-settings/login-methods/saml +[5]: /account_management/saml/mapping/ +[6]: /account_management/login_methods/#reviewing-user-overrides diff --git a/content/en/account_management/saml/configuration.md b/content/en/account_management/saml/configuration.md new file mode 100644 index 0000000000000..022353fe53d66 --- /dev/null +++ b/content/en/account_management/saml/configuration.md @@ -0,0 +1,101 @@ +--- +title: Configuring Single Sign-On With SAML +description: Configure SAML authentication for Datadog with identity providers like Active Directory, Auth0, Google, Okta, and Microsoft Entra ID for secure single sign-on. +disable_toc: false +further_reading: +- link: "/account_management/saml/" + tag: "Documentation" + text: "Single Sign-On With SAML" +- link: "account_management/saml/mapping/" + tag: "Documentation" + text: "SAML Group Mapping" +algolia: + tags: ['saml'] +--- + +## Overview + +This page covers how to enable single sign-on (SSO) with SAML in Datadog, as well as how enterprise customers can enable multiple SAML identity providers (IdPs). + +**Notes**: + +{{% site-region region="us,us3,us5,eu,ap1,ap2" %}} +- If you don't have SAML enabled on your Datadog account, reach out to [support][1] to enable it. +- This documentation assumes that you already have a SAML Identity Provider (IdP). If you do not have a SAML IdP, there are several IdPs that have integrations with Datadog such as [Active Directory][9], [Auth0][3], [Google][4], [LastPass][5], [Microsoft Entra ID][2], [Okta][6], and [SafeNet][7]. +- SAML configuration requires [Datadog Administrator][8] access, or the `Org Management` permission if you're using custom roles. +{{% /site-region %}} + +{{% site-region region="gov" %}} +- This documentation assumes that you already have a SAML Identity Provider (IdP). If you do not have a SAML IdP, there are several IdPs that have integrations with Datadog such as [Active Directory][9], [Auth0][3], [Google][4], [LastPass][5], [Microsoft Entra ID][2], [Okta][6], and [SafeNet][7]. +- SAML configuration requires [Datadog Administrator][8] access, or the `Org Management` permission if you're using custom roles. +{{% /site-region %}} + +## Configuring SAML + +1. To begin configuration, see your IdP's documentation: + + * [Active Directory][9] + * [Auth0][10] + * [Google][12] + * [Microsoft Entra ID][11] + * [LastPass][13] + * [Okta][14] + * [SafeNet][15] + +2. Download Datadog's [Service Provider metadata][17] to configure your IdP to recognize Datadog as a Service Provider. + +3. In Datadog, hover over your username in the bottom left corner and select **Organization Settings**. Select [**Login Methods**][16] and click **Configure** under SAML. + +4. Click **Add SAML**. + +5. In the configuration modal: + * Create a user-friendly name for this SAML provider. The name appears to end users when they choose a login method. + * Upload the IdP metadata from your SAML identity provider by clicking **browse files** or dragging and dropping the XML metadata file onto the modal. +
+
The IdP metadata must contain ASCII characters only.
+ + {{< img src="account_management/saml/saml_configure.png" alt="Configure SAML by uploading your IdP metadata" style="width:100%;" >}} + +6. Click **Save**. + +**Note**: To configure SAML for a multi-org, see [Managing Multiple-Organization Accounts][18]. + +## Configuring multiple SAML providers + +Enterprise customers can have multiple SAML configurations per organization (up to three at the same time). This feature simplifies identity management across complex environments, such as during IdP changes, mergers, or contractor onboarding. + +To configure additional SAML providers: + +1. Navigate to **Organization Settings > Login Methods**. Under **SAML**, click **Update**, then **Add SAML**. +2. In the configuration modal: + + - Create a user-friendly name for this SAML provider. The name appears to end users when they choose a login method. +
+
All users can see and access all configured IdPs; there is no way to assign specific user groups to specific configurations. Setting clear and descriptive names for each provider helps users select the appropriate IdP during login. Also note that there is no way to set a default configuration.
+ - Upload the IdP metadata from your SAML identity provider by clicking **browse files** or dragging and dropping the XML metadata file onto the modal. +4. Click **Save**. + +### Role mapping with multiple SAML providers + +If you use SAML [role mapping][19] or [team mapping][20] and want to use the same mappings in any additional providers you add, make sure the attributes in the new IdP(s) match what is defined in your mappings. If you add a new IdP, make sure to either use the same attribute names as your existing IdP, or add new mappings that align with the new IdP's attributes to ensure roles and teams are assigned correctly when users log in with different IdPs. + +[1]: /help/ +[2]: https://learn.microsoft.com/en-us/entra/architecture/auth-saml +[3]: https://auth0.com/docs/protocols/saml-protocol +[4]: https://cloud.google.com/architecture/identity/single-sign-on +[5]: https://support.logmeininc.com/lastpass/help/lastpass-admin-toolkit-using-single-sign-on-sso +[6]: https://developer.okta.com/docs/concepts/saml/ +[7]: https://thalesdocs.com/sta/operator/applications/apps_saml/index.html +[8]: /account_management/users/default_roles/ +[9]: /account_management/saml/activedirectory/ +[10]: /account_management/saml/auth0/ +[11]: /account_management/saml/entra/ +[12]: /account_management/saml/google/ +[13]: /account_management/saml/lastpass/ +[14]: /account_management/saml/okta/ +[15]: /account_management/saml/safenet/ +[16]: /account_management/login_methods/ +[17]: https://app.datadoghq.com/account/saml/metadata.xml +[18]: /account_management/multi_organization/#setting-up-saml +[19]: /account_management/saml/mapping/#map-saml-attributes-to-datadog-roles +[20]: /account_management/saml/mapping/#map-saml-attributes-to-teams \ No newline at end of file diff --git a/content/en/actions/agents/_index.md b/content/en/actions/agents/_index.md new file mode 100644 index 0000000000000..e740411b77f5d --- /dev/null +++ b/content/en/actions/agents/_index.md @@ -0,0 +1,154 @@ +--- +title: Agents +description: Build custom AI agents that can access the Action Catalog. +disable_toc: false +further_reading: +- link: "/actions/actions_catalog/" + tag: "Documentation" + text: "Action Catalog" +- link: "https://www.datadoghq.com/knowledge-center/aiops/ai-agents/" + tag: "Knowledge Center" + text: "What are AI agents and how do they work?" +--- + +{{< callout url="https://app.datadoghq.com/actions/agents" btn_hidden="false" header="Join the Preview!" >}} +Agents are in Preview. Click Request Access and fill in the Datadog Product Preview Program form. +{{< /callout >}} + +## Overview + +You can build custom AI agents to act on your observability data and third-party integrations. Agents can use any action from the [Action Catalog][7] to investigate problems, start remediation, or manage resources. + +When building an agent, choose a blueprint to get started. Blueprints come with pre-filled instructions and relevant tools. They're named after their main role, like Security Analyst, Log Analyzer, Incident Responder, or DevOps Assistant. + +{{< img src="/actions/agents/blank-new-agent.png" alt="The Agents page, filtered to show only 'My agents'" style="width:100%;" >}} + +## Agents page + +You can create a new agent from the [Agents][1] page. The page lists information about existing agents, including the following: +- Agent Name +- Description +- Author +- Creation date + +Hover over an agent for options to clone or delete it. You can also enable the **My agents** toggle to see only agents that you've created: + +{{< img src="/actions/agents/agent-dashboard.png" alt="The Agents page, filtered to show only 'My agents'" style="width:100%;" >}} + +## Create an agent + +### Build an agent from a blueprint + +Blueprints are starter agents that cover common use cases. They come loaded with instructions for the agent's behavior and related tools from the Action Catalog. Blueprints also showcase best practices for setting up agent functionality. + +To build an agent from a blueprint: + +1. Navigate to the [Agents][1] page. +1. In **Agent Blueprints**, click the blueprint you want to use. Alternatively, you can click **New Agent** and browse the full list of blueprints. +1. Click **Create From Blueprint**. +1. Your new agent has pre-populated settings and tools. You can immediately start chatting with the agent or [further customize it](#customize-your-agent). + +### Create a custom agent + +To build an agent from scratch: + +1. Navigate to the [Agents][1] page. +1. Click **New Agent**. +1. [Customize your agent](#customize-your-agent). Changes are saved automatically. +1. Start chatting with your agent. + +## Customize your agent + +When configuring your agent, you have the following options for customization. + +### Instructions + +Enter the instructions for your agent to follow when performing tasks. You can describe the agent as if it were a person, including its role, specialties, and steps to follow. Click **Suggest With AI** to get help with writing and refining your instructions. + +Below is a sample set of instructions for an agent acting as an incident responder. + +``` +You are an Incident Responder AI assistant specialized in managing and coordinating incident response activities. + +Your role involves: +- Guiding incident response procedures and best practices +- Helping assess incident severity and impact +- Coordinating communication between teams and stakeholders +- Managing incident lifecycle from detection to resolution +- Facilitating post-incident reviews and improvements + +During incident response: +1. Help classify incident severity (P0/P1/P2/etc.) +2. Guide through incident response runbooks and procedures +3. Assist with stakeholder communication and updates +4. Track action items and follow-up tasks +5. Support post-mortem analysis and lessons learned + +Focus on clear communication, structured processes, and continuous improvement of incident response capabilities. +``` + +### Model + +By default, new custom agents run on the latest GPT model. + +To change your agent's model, click **Auto** in the chatbox to open a dropdown menu and choose another model. You can compare these models using [OpenAI's comparison tool][6] and [Anthropic's models comparison][5]. + +### Self Improve + +By default, the **Self Improve** feature is not enabled. Self improvement allows the agent to read its own configuration and update it when requested or when it determines its configuration can be changed to improve. + +To enable this feature, click the settings **** icon, then the toggle button next to **Self Improve**. + +### Actions + +Click the plus **** icon to add actions from the [Action Catalog][7] for the agent to use. The agent is restricted to only its added tools. For example, if you encounter an error when the agent attempts to perform a task you've requested, it might be missing a necessary action. + +### MCP Server + +Click the toggle button to enable the [Datadog MCP Server][8]. MCP servers use the Model Context Protocol to provide additional tools and capabilities that the agent can use to interact with external systems. + +## Add an agent action + +After you create an agent, you can add it to a workflow or app. + +### Add to a workflow + +To invoke an agent in a workflow step: +1. In [Workflow Automation][9], navigate to a workflow and click **Edit**. +1. Click the plus **** icon. +1. Select the **Execute Custom Agent** action. +1. Configure the action: + 1. Enter a **Step name**. + 1. Selection a **Connection**. + 1. Select a **Custom Agent ID**. + 1. Enter a **User Prompt**. + 1. Optionally, add a [**Wait until condition**][11]. + 1. Optionally, add [**Retries**][12]. +1. Click **Save**. + +### Add to an app + +To invoke an agent in an app: +1. In [App Builder][10], navigate to an app and click **Edit**. +1. Click the plus **** icon, then click **Actions**. +1. Select the **Execute Custom Agent** action. +1. Configure the action: + 1. Select the **Run Settings**. + 1. Selection a **Connection**. + 1. Select a **Custom Agent ID**. + 1. Enter a **User Prompt**. +1. Click **Save**. + +## Further Reading + +{{< partial name="whats-next/whats-next.html" >}} + +[1]: https://app.datadoghq.com/actions/agents +[5]: https://docs.claude.com/en/docs/about-claude/models/overview#latest-models-comparison +[6]: https://platform.openai.com/docs/models +[7]: /actions/actions_catalog/ +[8]: /bits_ai/mcp_server +[9]: https://app.datadoghq.com/workflow +[10]: https://app.datadoghq.com/app-builder/apps/list +[11]: /actions/workflows/build/#wait-until-condition +[12]: /actions/workflows/build/#retries \ No newline at end of file diff --git a/content/en/actions/app_builder/_index.md b/content/en/actions/app_builder/_index.md index 50298740549b3..16fb4a4fd6e8f 100644 --- a/content/en/actions/app_builder/_index.md +++ b/content/en/actions/app_builder/_index.md @@ -85,7 +85,7 @@ The App Builder Overview dashboard provides a high-level overview of your Datado [1]: https://app.datadoghq.com/actions/action-catalog/ [2]: /service_management/workflows/ [3]: https://app.datadoghq.com/app-builder/blueprints -[4]: https://datadoghq.slack.com/ +[4]: https://chat.datadoghq.com/ [5]: /service_management/app_builder/build/#build-an-app-from-a-blueprint [6]: /service_management/app_builder/embedded_apps/#add-apps-to-your-dashboard [7]: https://app.datadoghq.com/dash/integration/60 diff --git a/content/en/actions/app_builder/access_and_auth.md b/content/en/actions/app_builder/access_and_auth.md index 5e96ba233c5ff..2a3b438343898 100644 --- a/content/en/actions/app_builder/access_and_auth.md +++ b/content/en/actions/app_builder/access_and_auth.md @@ -141,7 +141,7 @@ To restrict access to the app, perform the following steps in the app canvas: [2]: /account_management/org_settings/service_accounts#permissions [3]: /account_management/rbac/?tab=datadogapplication#role-based-access-control [5]: https://app.datadoghq.com/app-builder/ -[6]: https://datadoghq.slack.com/ +[6]: https://chat.datadoghq.com/ [7]: /account_management/audit_trail/#overview [8]: /actions/connections/ [9]: /actions/workflows/ diff --git a/content/en/actions/app_builder/components/_index.md b/content/en/actions/app_builder/components/_index.md index 3ffa8e04073d2..daae550446130 100644 --- a/content/en/actions/app_builder/components/_index.md +++ b/content/en/actions/app_builder/components/_index.md @@ -81,7 +81,7 @@ Displays property and value pairs in JSON format. ### Example To view this component in context, see the [Metrics Explorer & Monitors Builder][2] app blueprint. -{{% /collapse-content %}} +{{% /collapse-content %}} {{% collapse-content title="Callout value" level="h3" %}} @@ -906,7 +906,7 @@ Type ### Sorting -Select the column and direction for default table sorting. +Select the column and direction for default table sorting. Column : The column to sort by.
**Value**: column name @@ -1168,7 +1168,7 @@ To view this component in context, see the [Metrics Explorer & Monitors Builder] [2]: https://app.datadoghq.com/app-builder/apps/edit?activeTab=queries&showActionCatalog=false&template=datadog_metrics_and_monitors&viewMode=preview [3]: https://app.datadoghq.com/app-builder/apps/edit?activeTab=queries&showActionCatalog=false&template=ec2_instance_manager&viewMode=preview [4]: https://app.datadoghq.com/app-builder/apps/edit?activeTab=queries&showActionCatalog=false&template=ecs_task_manager&viewMode=preview -[5]: https://datadoghq.slack.com/ +[5]: https://chat.datadoghq.com/ [6]: /service_management/app_builder/components/tables/ [7]: /service_management/app_builder/expressions [8]: https://www.markdownguide.org/basic-syntax/ diff --git a/content/en/actions/app_builder/components/custom_charts.md b/content/en/actions/app_builder/components/custom_charts.md index 4cf72b51a6914..69d4265c87431 100644 --- a/content/en/actions/app_builder/components/custom_charts.md +++ b/content/en/actions/app_builder/components/custom_charts.md @@ -96,5 +96,5 @@ A histogram chart with your Datadog Logs data displays.
Do you have questions or feedback? Join the **#app-builder** channel on the [Datadog Community Slack][0]. -[0]: https://datadoghq.slack.com/ +[0]: https://chat.datadoghq.com/ [1]: https://vega.github.io/vega-lite/examples/ \ No newline at end of file diff --git a/content/en/actions/app_builder/components/tables.md b/content/en/actions/app_builder/components/tables.md index 3521b0ee82914..63010457f9cc1 100644 --- a/content/en/actions/app_builder/components/tables.md +++ b/content/en/actions/app_builder/components/tables.md @@ -36,7 +36,7 @@ To add a search bar to your table, under **Appearance**, enable the **Is Searcha One common use case is filtering a table component using the value in a text input component. -For example, if you want to list your dashboards in a table that you can filter using a text input component, you could do the following: +For example, if you want to list your dashboards in a table that you can filter using a text input component, you could do the following: 1. Add a new query using the **+** button. 1. Search for "list dashboards" and click the **List Dashboards** action. Name your query `listDashboards0`. @@ -54,7 +54,7 @@ You can type text into the text input component and the rows of table are filter Another common use case is filtering a table using a select component. -For example, if you want to list your dashboards in a table that you can filter using a select component, you could do the following: +For example, if you want to list your dashboards in a table that you can filter using a select component, you could do the following: 1. Add a new query using the **+** button. 1. Search for "list dashboards" and click the **List Dashboards** action. Name your query `listDashboards0`. @@ -89,9 +89,9 @@ If you need the original, untransformed query result, you can reference it as `$ ## Server-side filtering -In some cases, you might want to filter values server-side and issue new requests when the user enters a value in an input such as a text input component. +In some cases, you might want to filter values server-side and issue new requests when the user enters a value in an input such as a text input component. -In this case, you can enable server-side filtering by editing the query directly. +In this case, you can enable server-side filtering by editing the query directly. For example, in the [GitHub PR pipeline][4] blueprint, the `listOpenedPulls` query has an input that gets the following URL: @@ -156,7 +156,7 @@ In the table, the **User** column fills with an avatar and GitHub username for e
Do you have questions or feedback? Join the **#app-builder** channel on the [Datadog Community Slack][0]. -[0]: https://datadoghq.slack.com/ +[0]: https://chat.datadoghq.com/ [1]: https://app.datadoghq.com/app-builder/apps/edit?activeTab=queries&showActionCatalog=false&template=pagerduty_oncall_manager&viewMode=preview [2]: /service_management/app_builder/components/tables/#filtering-with-a-text-input [3]: https://app.datadoghq.com/app-builder/apps/edit?viewMode=edit&template=github-pr-summarizer diff --git a/content/en/actions/app_builder/embedded_apps.md b/content/en/actions/app_builder/embedded_apps.md index ad26dae82fc63..4990d9965fd50 100644 --- a/content/en/actions/app_builder/embedded_apps.md +++ b/content/en/actions/app_builder/embedded_apps.md @@ -117,6 +117,6 @@ Once added, you can view and use your app in Software Catalog.
Do you have questions or feedback? Join the **#app-builder** channel on the [Datadog Community Slack][1]. -[1]: https://datadoghq.slack.com/ +[1]: https://chat.datadoghq.com/ [2]: https://app.datadoghq.com/software/self-service [3]: https://app.datadoghq.com/software diff --git a/content/en/actions/app_builder/events.md b/content/en/actions/app_builder/events.md index 31beb44adf830..230124d12768d 100644 --- a/content/en/actions/app_builder/events.md +++ b/content/en/actions/app_builder/events.md @@ -62,4 +62,4 @@ To see what state functions are available for a given component, see [Components [1]: /service_management/app_builder/components [2]: https://app.datadoghq.com/app-builder/apps/edit?viewMode=edit&template=github-pr-summarizer -[8]: https://datadoghq.slack.com/ +[8]: https://chat.datadoghq.com/ diff --git a/content/en/actions/app_builder/queries.md b/content/en/actions/app_builder/queries.md index cf56b25d28dd0..c45e348faa00a 100644 --- a/content/en/actions/app_builder/queries.md +++ b/content/en/actions/app_builder/queries.md @@ -109,7 +109,7 @@ To provide mocked outputs manually, perform the following steps: 1. In the **Mocked outputs** section of the query, click the **JSON** tab. 1. Paste in JSON that matches the expected output format of the query.
If you do not know the expected output format, you can run the query once and then reference `outputs` in the **Inspect Data** section of the query. -{{% /collapse-content %}} +{{% /collapse-content %}} ## Order of operations @@ -119,9 +119,9 @@ When executing a query, App Builder performs the following steps in the order li 1. Checks if there is a **Condition** expression for the query, and if so, checks that the condition is met. If it is not, execution stops. 2. Evaluates any expressions in **Inputs** to determine the input data for the query. 3. If the **Debounce** property is set, delays execution for the interval defined by the debounce value. If query inputs or their dependencies update during this time, the current query execution is stopped, and a new one starts from the beginning using the updated inputs.
- **Note**: If more than one query request occurs within the debounce interval, all requests except the last execution request are canceled. + **Note**: If more than one query request occurs within the debounce interval, all requests except the last execution request are canceled. 4. Executes the query. -5. Stores the raw query response in `query.rawOutputs`. +5. Stores the raw query response in `query.rawOutputs`. 6. Runs any post query transformation and sets `query.outputs` equal to the result. This process takes a snapshot of app data and passes it to the post query transformation.
**Note**: Post query transformations should be pure functions without side effects. For example, do not update a state variable in your post query transformation. 7. Computes any expressions in the app that depend on data from the query output. @@ -142,7 +142,7 @@ This app provides a button to trigger a workflow. The workflow sends a poll to a ##### Create workflow -1. In a new workflow canvas, under **Datadog Triggers**, click **App**. +1. In a new workflow canvas, under **Datadog Triggers**, click **App**. 1. Under the **App** trigger step, click the plus (**+**) icon, then search for "Make a decision" and select the **Make a decision** Slack action. 1. Select your workspace and choose a channel to poll. 1. Fill in the prompt text "Cat fact or dog fact?" and change the button choices to "Cat fact" and "Dog fact". @@ -197,7 +197,7 @@ To connect App Builder to the workflow, perform the following steps: 1. Click the **Trigger Workflow** button. 1. In the Slack channel you selected, answer the poll question.
Your app displays a result related to the option you chose. -{{% /collapse-content %}} +{{% /collapse-content %}} ### Combine and transform query output data After you get data from a query in App Builder, you can use data transformers to combine and transform that data. @@ -263,7 +263,7 @@ This app provides buttons to fetch facts about two numbers from an API. It then 1. Click **Generate fact 1**, then click **Generate fact 2**.
Your app updates the number facts and the sum of the numbers as you click each button. -{{% /collapse-content %}} +{{% /collapse-content %}} ## Further reading @@ -275,7 +275,7 @@ This app provides buttons to fetch facts about two numbers from an API. It then [5]: /service_management/workflows/connections [6]: /service_management/workflows [7]: https://app.datadoghq.com/app-builder/apps/edit?viewMode=edit&template=ecs_task_manager -[8]: https://datadoghq.slack.com/ +[8]: https://chat.datadoghq.com/ [10]: https://app.datadoghq.com/actions/action-catalog/ [11]: /service_management/app_builder/events [12]: /service_management/app_builder/events/#state-functions \ No newline at end of file diff --git a/content/en/actions/app_builder/saved_actions.md b/content/en/actions/app_builder/saved_actions.md index f04f4521f10ee..c87028ca802f1 100644 --- a/content/en/actions/app_builder/saved_actions.md +++ b/content/en/actions/app_builder/saved_actions.md @@ -43,9 +43,9 @@ You can edit, clone, or delete your saved actions from the Action Catalog. To find a saved action: 1. In Datadog, navigate to the [**Action Catalog**][2]. -1. Click **Saved Actions**. +1. Click **Saved Actions**. 1. Browse through the list of saved actions or use the search bar to search for actions by name. Hover over the saved action you'd like to edit, clone, or delete. -1. Click **Manage Saved Actions**. +1. Click **Manage Saved Actions**. 1. Select the icon to edit {{< img src="icons/pencil.png" inline="true" style="width:14px;">}}, clone {{< img src="icons/clone.png" inline="true" style="width:14px;">}}, or delete {{< img src="icons/delete.png" inline="true" style="width:14px;">}} the saved action. ## Further Reading @@ -56,4 +56,4 @@ To find a saved action: [1]: https://app.datadoghq.com/app-builder/apps/list [2]: https://app.datadoghq.com/actions/action-catalog -[3]: https://datadoghq.slack.com/ \ No newline at end of file +[3]: https://chat.datadoghq.com/ \ No newline at end of file diff --git a/content/en/actions/app_builder/variables.md b/content/en/actions/app_builder/variables.md index 57fc251ca0125..b61f15707460b 100644 --- a/content/en/actions/app_builder/variables.md +++ b/content/en/actions/app_builder/variables.md @@ -69,4 +69,4 @@ To create an app that uses a button to change a callout value component's style
Do you have questions or feedback? Join the **#app-builder** channel on the [Datadog Community Slack][1]. -[1]: https://datadoghq.slack.com/ \ No newline at end of file +[1]: https://chat.datadoghq.com/ \ No newline at end of file diff --git a/content/en/actions/connections/_index.md b/content/en/actions/connections/_index.md index 2fe30a222bd82..d9b731eb88c8a 100644 --- a/content/en/actions/connections/_index.md +++ b/content/en/actions/connections/_index.md @@ -143,7 +143,7 @@ You can add identifier tags to connections. The tagging rules for connections ar ## Connection groups -You can create groups of connections so that your workflows and apps can authenticate into the correct account or accounts based on the given inputs. Connections can be grouped together only if they share the same integration (for example, you cannot group GCP and AWS connections within the same group). +You can create groups of connections so that your workflows and apps can authenticate into the correct account or accounts based on the given inputs. Connections can be grouped together only if they share the same integration (for example, you cannot group GCP and AWS connections within the same group). You define the members of a connection group using a connection's _Identifier Tags_. For example, you can create a connection group consisting of AWS accounts that have the `account_id` tag. @@ -206,7 +206,7 @@ To delete a connection group: [8]: /service_management/workflows/actions/ [9]: https://app.datadoghq.com/workflow [10]: /actions/connections/http/ -[11]: https://datadoghq.slack.com/ +[11]: https://chat.datadoghq.com/ [12]: /actions/workflows/access_and_auth/#restrict-access-on-a-specific-connection [13]: /getting_started/tagging/ [14]: https://app.datadoghq.com/app-builder/ diff --git a/content/en/actions/connections/http.md b/content/en/actions/connections/http.md index 2c773aecd7ffe..9d0b648471448 100644 --- a/content/en/actions/connections/http.md +++ b/content/en/actions/connections/http.md @@ -189,6 +189,6 @@ To configure a private HTTP request: [1]: https://docs.datadoghq.com/api/latest/ip-ranges/#list-ip-ranges [3]: https://learn.microsoft.com/en-us/azure/active-directory/develop/scopes-oidc#the-default-scope -[4]: https://datadoghq.slack.com/ +[4]: https://chat.datadoghq.com/ [5]: /actions/private_actions [6]: /actions/private_actions/private_action_credentials/?tab=httpsaction#credential-files \ No newline at end of file diff --git a/content/en/actions/workflows/_index.md b/content/en/actions/workflows/_index.md index 5a989a7b051ca..4990f4c41e2c3 100644 --- a/content/en/actions/workflows/_index.md +++ b/content/en/actions/workflows/_index.md @@ -73,4 +73,4 @@ Below are a few examples of workflows you can build: [1]: /actions/actions_catalog/ [2]: /workflows/build/#build-a-workflow-from-a-blueprint [3]: https://app.datadoghq.com/dashboard/lists -[4]: https://datadoghq.slack.com/ +[4]: https://chat.datadoghq.com/ diff --git a/content/en/actions/workflows/access_and_auth.md b/content/en/actions/workflows/access_and_auth.md index 0765c0427abcc..2b86fafe8d2b2 100644 --- a/content/en/actions/workflows/access_and_auth.md +++ b/content/en/actions/workflows/access_and_auth.md @@ -151,4 +151,4 @@ You can restrict access on a specific workflow either from the workflow list pag [6]: /service_management/workflows/connections/ [7]: /account_management/rbac/permissions/#workflow-automation [8]: https://app.datadoghq.com/workflow -[9]: https://datadoghq.slack.com/ +[9]: https://chat.datadoghq.com/ diff --git a/content/en/actions/workflows/actions/_index.md b/content/en/actions/workflows/actions/_index.md index e6fe13c860f71..f45a9736ab453 100644 --- a/content/en/actions/workflows/actions/_index.md +++ b/content/en/actions/workflows/actions/_index.md @@ -37,4 +37,4 @@ If your use case is not covered by an integration or generic Datadog action, you
Do you have questions or feedback? Join the **#workflows** channel on the [Datadog Community Slack][2]. [1]: https://forms.gle/JzPazvxXox7fvA2R8 -[2]: https://datadoghq.slack.com/ +[2]: https://chat.datadoghq.com/ diff --git a/content/en/actions/workflows/actions/flow_control.md b/content/en/actions/workflows/actions/flow_control.md index 840ab80d1bfa8..56649f2c99ac3 100644 --- a/content/en/actions/workflows/actions/flow_control.md +++ b/content/en/actions/workflows/actions/flow_control.md @@ -79,4 +79,4 @@ When a run completes, the workflow enters **Debug** mode. Select a step within t
Do you have questions or feedback? Join the **#workflows** channel on the [Datadog Community Slack][2]. [1]: https://app.datadoghq.com/workflow/action-catalog#logic//com.datadoghq.core.if -[2]: https://datadoghq.slack.com/ +[2]: https://chat.datadoghq.com/ diff --git a/content/en/actions/workflows/build.md b/content/en/actions/workflows/build.md index def54270e2f89..97ae63a157377 100644 --- a/content/en/actions/workflows/build.md +++ b/content/en/actions/workflows/build.md @@ -56,7 +56,7 @@ To iterate on an existing workflow: 1. Enter a detailed prompt for the behavior you'd like to add to your workflow. Include the integrations and actions you'd like to use. 1. Click the up arrow (**↑**) to add the functionality to your workflow. -
The Workflow Automation AI does not answer questions about the product. If you have questions or feedback, consider joining the #workflows channel on the Datadog Community Slack
+
The Workflow Automation AI does not answer questions about the product. If you have questions or feedback, consider joining the #workflows channel on the Datadog Community Slack
## Create a custom workflow @@ -111,7 +111,7 @@ You can update published workflows without affecting the live version until you Editing a published workflow creates a draft. All changes made to the draft do not alter the published workflow. Each workflow can have one active draft, which all editors can modify. When ready, click on **Publish Changes** to replace the published version. -Drafts execute all configured steps like any normal workflow. You can only run drafts from the workflow editor. +Drafts execute all configured steps like any normal workflow. You can only run drafts from the workflow editor. To discard the draft, click the **cog icon** in the top-right corner of the editor and select **Discard draft**. @@ -205,7 +205,7 @@ To perform tasks using the API, see the [Workflow Automation API documentation][ [7]: /getting_started/tagging/ [8]: /glossary/#service [9]: /account_management/teams/ -[10]: https://datadoghq.slack.com/ +[10]: https://chat.datadoghq.com/ [11]: /service_management/workflows/test_and_debug/#test-a-step [12]: /service_management/workflows/variables/ [13]: /api/latest/workflow-automation/ diff --git a/content/en/actions/workflows/expressions.md b/content/en/actions/workflows/expressions.md index 69182a380b6f9..74110ca1847d3 100644 --- a/content/en/actions/workflows/expressions.md +++ b/content/en/actions/workflows/expressions.md @@ -102,6 +102,6 @@ See the test and debug page to learn how to [test a workflow step][3].
Do you have questions or feedback? Join the **#workflows** channel on the [Datadog Community Slack][2]. [1]: https://lodash.com/ -[2]: https://datadoghq.slack.com/ +[2]: https://chat.datadoghq.com/ [3]: /service_management/workflows/test_and_debug/#test-a-step [4]: /service_management/workflows/actions/set_variables \ No newline at end of file diff --git a/content/en/actions/workflows/limits.md b/content/en/actions/workflows/limits.md index 13ef0e358a294..34d6a471768e6 100644 --- a/content/en/actions/workflows/limits.md +++ b/content/en/actions/workflows/limits.md @@ -63,4 +63,4 @@ When an organization exceeds a threshold, pending execution requests queue up to [1]: /service_management/workflows/actions/flow_control/#for-loop [2]: /service_management/workflows/trigger/#trigger-a-workflow-from-a-workflow -[9]: https://datadoghq.slack.com/ +[9]: https://chat.datadoghq.com/ diff --git a/content/en/actions/workflows/saved_actions.md b/content/en/actions/workflows/saved_actions.md index 94c1be8b2be12..847e949c5e2db 100644 --- a/content/en/actions/workflows/saved_actions.md +++ b/content/en/actions/workflows/saved_actions.md @@ -67,4 +67,4 @@ If you did not create the action, you cannot edit it directly. Instead select th [1]: https://app.datadoghq.com/workflow/action-catalog [2]: https://app.datadoghq.com/workflow/ -[3]: https://datadoghq.slack.com/ \ No newline at end of file +[3]: https://chat.datadoghq.com/ \ No newline at end of file diff --git a/content/en/actions/workflows/test_and_debug.md b/content/en/actions/workflows/test_and_debug.md index 9f8dc7ce4d40e..f2b0529671539 100644 --- a/content/en/actions/workflows/test_and_debug.md +++ b/content/en/actions/workflows/test_and_debug.md @@ -62,4 +62,4 @@ The initial run history for a workflow provides a panel with the list of previou
Do you have questions or feedback? Join the **#workflows** channel on the [Datadog Community Slack][10]. [6]: #test-expressions-and-functions -[10]: https://datadoghq.slack.com/ \ No newline at end of file +[10]: https://chat.datadoghq.com/ \ No newline at end of file diff --git a/content/en/actions/workflows/track.md b/content/en/actions/workflows/track.md index aede197c0147e..f08fb76389458 100644 --- a/content/en/actions/workflows/track.md +++ b/content/en/actions/workflows/track.md @@ -109,7 +109,7 @@ To track billing for your workflow executions, perform the following steps:
Do you have questions or feedback? Join the **#workflows** channel on the [Datadog Community Slack][1]. -[1]: https://datadoghq.slack.com/ +[1]: https://chat.datadoghq.com/ [2]: https://app.datadoghq.com/dashboard/lists [3]: /service_management/workflows/build/#workflow-notifications [4]: https://app.datadoghq.com/monitors/create diff --git a/content/en/actions/workflows/trigger.md b/content/en/actions/workflows/trigger.md index b4d0e74dc6b85..a8f10058e30bc 100644 --- a/content/en/actions/workflows/trigger.md +++ b/content/en/actions/workflows/trigger.md @@ -285,7 +285,7 @@ After you trigger a workflow, the workflow page switches to the workflow's **Run [4]: /security/cloud_security_management/workflows [5]: /service_management/workflows/build/#input-parameters [6]: https://app.datadoghq.com/incidents/settings#Rules -[7]: https://datadoghq.slack.com/ +[7]: https://chat.datadoghq.com/ [8]: /account_management/api-app-keys/#api-keys [9]: /account_management/api-app-keys/#application-keys [10]: /account_management/api-app-keys/#scopes diff --git a/content/en/actions/workflows/variables.md b/content/en/actions/workflows/variables.md index f022a1657e1b3..7c9ebd3c60a36 100644 --- a/content/en/actions/workflows/variables.md +++ b/content/en/actions/workflows/variables.md @@ -145,7 +145,7 @@ To avoid a type error resulting from an undefined variable, assign a custom vari [1]: https://app.datadoghq.com/workflow/action-catalog#/com.datadoghq.core/com.datadoghq.core.setVariable [2]: /service_management/workflows/actions/flow_control#for-loop -[3]: https://datadoghq.slack.com/ +[3]: https://chat.datadoghq.com/ [4]: https://handlebarsjs.com/guide/expressions.html#expressions [5]: /service_management/workflows/trigger [6]: /service_management/app_builder/queries/#return-workflow-results-to-an-app diff --git a/content/en/agent/logs/_index.md b/content/en/agent/logs/_index.md index 47ac2baca8758..2fb7dc37b4b86 100644 --- a/content/en/agent/logs/_index.md +++ b/content/en/agent/logs/_index.md @@ -78,7 +78,7 @@ logs: source: "" ``` -On **Windows**, use the path `:\\\\.log`, and verify that the user `ddagentuser` has read and write access to the log file. +On **Windows**, use the path `:\\\\.log`, and verify that the user `ddagentuser` has read access to the log file. **Note**: A log line needs to be terminated with a newline character, `\n` or `\r\n`, otherwise the Agent waits indefinitely and does not send the log line. diff --git a/content/en/agent/logs/log_transport.md b/content/en/agent/logs/log_transport.md index 02af59985a8b7..5766c6a36f880 100644 --- a/content/en/agent/logs/log_transport.md +++ b/content/en/agent/logs/log_transport.md @@ -20,7 +20,7 @@ further_reading: --- -## Default agent behavior +## Default Agent behavior For Agent v6.19+/v7.19+, the default transport used for your logs is compressed HTTPS instead of TCP for the previous versions. When the Agent starts, if log collection is enabled, it runs a HTTPS connectivity test. If successful, then the Agent uses the compressed HTTPS transport, otherwise the Agent falls back to a TCP transport. @@ -33,7 +33,7 @@ To check which transport is used by the Agent, run the [Agent status command][1] **Notes**: -* For older Agent versions, TCP transport is used by default. Datadog strongly recommends you to enforce HTTPS transport if you are running v6.14+/v7.14+ and HTTPS compression if you are running v6.16+/v7.16+. +* For older Agent versions, TCP transport is used by default. **Datadog strongly recommends** you to enforce HTTPS transport if you are running v6.14+/v7.14+ and HTTPS compression if you are running v6.16+/v7.16+. * Always enforce a specific transport (either TCP or HTTPS) when using a proxy to forwards logs to Datadog ## Enforce a specific transport @@ -111,6 +111,9 @@ When logs are sent through HTTPS, use the same [set of proxy settings][3] as the {{% tab "TCP" %}} {{< site-region region="us,eu,us3,us5,ap1,ap2" >}} +{{% logs-tcp-disclaimer %}} + + To enforce TCP transport, update the Agent's [main configuration file][1] (`datadog.yaml`) with: ```yaml diff --git a/content/en/agent/logs/proxy.md b/content/en/agent/logs/proxy.md index 2afff5ba24c0c..76a4b9d44aeda 100644 --- a/content/en/agent/logs/proxy.md +++ b/content/en/agent/logs/proxy.md @@ -13,7 +13,9 @@ further_reading: text: "Collect your traces" --- -{{% site-region region="us3,eu,us5,gov,ap1,ap2" %}} +{{% logs-tcp-disclaimer %}} + +{{% site-region region="us3,us5,gov,ap1,ap2" %}}
TCP is not available for the {{< region-param key="dd_site_name" >}} site. Contact support for more information.
diff --git a/content/en/api/latest/team-connections/_index.md b/content/en/api/latest/team-connections/_index.md new file mode 100644 index 0000000000000..ff0fe3ed06e30 --- /dev/null +++ b/content/en/api/latest/team-connections/_index.md @@ -0,0 +1,3 @@ +--- +title: Team Connections +--- diff --git a/content/en/api/v1/usage-metering/examples.json b/content/en/api/v1/usage-metering/examples.json index de3ac4a305250..51dbead256450 100644 --- a/content/en/api/v1/usage-metering/examples.json +++ b/content/en/api/v1/usage-metering/examples.json @@ -2680,8 +2680,10 @@ "agent_host_top99p_sum": "integer", "apm_azure_app_service_host_top99p_sum": "integer", "apm_devsecops_host_top99p_sum": "integer", + "apm_enterprise_standalone_hosts_top99p_sum": "integer", "apm_fargate_count_avg_sum": "integer", "apm_host_top99p_sum": "integer", + "apm_pro_standalone_hosts_top99p_sum": "integer", "appsec_fargate_count_avg_sum": "integer", "asm_serverless_agg_sum": "integer", "audit_logs_lines_indexed_agg_sum": "integer", @@ -2926,8 +2928,10 @@ "agent_host_top99p": "integer", "apm_azure_app_service_host_top99p": "integer", "apm_devsecops_host_top99p": "integer", + "apm_enterprise_standalone_hosts_top99p": "integer", "apm_fargate_count_avg": "integer", "apm_host_top99p": "integer", + "apm_pro_standalone_hosts_top99p": "integer", "appsec_fargate_count_avg": "integer", "asm_serverless_sum": "integer", "audit_logs_lines_indexed_sum": "integer", @@ -3053,8 +3057,10 @@ "agent_host_top99p": "integer", "apm_azure_app_service_host_top99p": "integer", "apm_devsecops_host_top99p": "integer", + "apm_enterprise_standalone_hosts_top99p": "integer", "apm_fargate_count_avg": "integer", "apm_host_top99p": "integer", + "apm_pro_standalone_hosts_top99p": "integer", "appsec_fargate_count_avg": "integer", "asm_serverless_sum": "integer", "audit_logs_lines_indexed_sum": "integer", @@ -3344,7 +3350,7 @@ "vuln_management_host_count_top99p_sum": "integer", "workflow_executions_usage_agg_sum": "integer" }, - "html": "
\n
\n
\n
\n

agent_host_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of all agent hosts over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

apm_azure_app_service_host_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of all Azure app services using APM over all hours in the current month all organizations.

\n
\n \n
\n
\n
\n
\n
\n

apm_devsecops_host_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of all APM DevSecOps hosts over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

apm_fargate_count_avg_sum

\n
\n

int64

\n

Shows the average of all APM ECS Fargate tasks over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

apm_host_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of all distinct APM hosts over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

appsec_fargate_count_avg_sum

\n
\n

int64

\n

Shows the average of all Application Security Monitoring ECS Fargate tasks over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

asm_serverless_agg_sum

\n
\n

int64

\n

Shows the sum of all Application Security Monitoring Serverless invocations over all hours in the current months for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

audit_logs_lines_indexed_agg_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all audit logs lines indexed over all hours in the current month for all organizations (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

audit_trail_enabled_hwm_sum

\n
\n

int64

\n

Shows the total number of organizations that had Audit Trail enabled over a specific number of months.

\n
\n \n
\n
\n
\n
\n
\n

avg_profiled_fargate_tasks_sum

\n
\n

int64

\n

The average total count for Fargate Container Profiler over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

aws_host_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of all AWS hosts over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

aws_lambda_func_count

\n
\n

int64

\n

Shows the average of the number of functions that executed 1 or more times each hour in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

aws_lambda_invocations_sum

\n
\n

int64

\n

Shows the sum of all AWS Lambda invocations over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

azure_app_service_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of all Azure app services over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

azure_host_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of all Azure hosts over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

billable_ingested_bytes_agg_sum

\n
\n

int64

\n

Shows the sum of all log bytes ingested over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

bits_ai_investigations_agg_sum

\n
\n

int64

\n

Shows the sum of all Bits AI Investigations over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

browser_rum_lite_session_count_agg_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all browser lite sessions over all hours in the current month for all organizations (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

browser_rum_replay_session_count_agg_sum

\n
\n

int64

\n

Shows the sum of all browser replay sessions over all hours in the current month for all organizations (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

browser_rum_units_agg_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all browser RUM units over all hours in the current month for all organizations (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

ci_pipeline_indexed_spans_agg_sum

\n
\n

int64

\n

Shows the sum of all CI pipeline indexed spans over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

ci_test_indexed_spans_agg_sum

\n
\n

int64

\n

Shows the sum of all CI test indexed spans over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

ci_visibility_itr_committers_hwm_sum

\n
\n

int64

\n

Shows the high-water mark of all CI visibility intelligent test runner committers over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

ci_visibility_pipeline_committers_hwm_sum

\n
\n

int64

\n

Shows the high-water mark of all CI visibility pipeline committers over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

ci_visibility_test_committers_hwm_sum

\n
\n

int64

\n

Shows the high-water mark of all CI visibility test committers over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

cloud_cost_management_aws_host_count_avg_sum

\n
\n

int64

\n

Sum of the host count average for Cloud Cost Management for AWS.

\n
\n \n
\n
\n
\n
\n
\n

cloud_cost_management_azure_host_count_avg_sum

\n
\n

int64

\n

Sum of the host count average for Cloud Cost Management for Azure.

\n
\n \n
\n
\n
\n
\n
\n

cloud_cost_management_gcp_host_count_avg_sum

\n
\n

int64

\n

Sum of the host count average for Cloud Cost Management for GCP.

\n
\n \n
\n
\n
\n
\n
\n

cloud_cost_management_host_count_avg_sum

\n
\n

int64

\n

Sum of the host count average for Cloud Cost Management for all cloud providers.

\n
\n \n
\n
\n
\n
\n
\n

cloud_siem_events_agg_sum

\n
\n

int64

\n

Shows the sum of all Cloud Security Information and Event Management events over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

code_analysis_sa_committers_hwm_sum

\n
\n

int64

\n

Shows the high-water mark of all Static Analysis committers over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

code_analysis_sca_committers_hwm_sum

\n
\n

int64

\n

Shows the high-water mark of all static Software Composition Analysis committers over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

code_security_host_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of all Code Security hosts over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

container_avg_sum

\n
\n

int64

\n

Shows the average of all distinct containers over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

container_excl_agent_avg_sum

\n
\n

int64

\n

Shows the average of the containers without the Datadog Agent over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

container_hwm_sum

\n
\n

int64

\n

Shows the sum of the high-water marks of all distinct containers over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

csm_container_enterprise_compliance_count_agg_sum

\n
\n

int64

\n

Shows the sum of all Cloud Security Management Enterprise compliance containers over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

csm_container_enterprise_cws_count_agg_sum

\n
\n

int64

\n

Shows the sum of all Cloud Security Management Enterprise Cloud Workload Security containers over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

csm_container_enterprise_total_count_agg_sum

\n
\n

int64

\n

Shows the sum of all Cloud Security Management Enterprise containers over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

csm_host_enterprise_aas_host_count_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Security Management Enterprise Azure app services hosts over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

csm_host_enterprise_aws_host_count_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Security Management Enterprise AWS hosts over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

csm_host_enterprise_azure_host_count_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Security Management Enterprise Azure hosts over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

csm_host_enterprise_compliance_host_count_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Security Management Enterprise compliance hosts over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

csm_host_enterprise_cws_host_count_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Security Management Enterprise Cloud Workload Security hosts over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

csm_host_enterprise_gcp_host_count_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Security Management Enterprise GCP hosts over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

csm_host_enterprise_total_host_count_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Security Management Enterprise hosts over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

cspm_aas_host_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Security Management Pro Azure app services hosts over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

cspm_aws_host_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Security Management Pro AWS hosts over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

cspm_azure_host_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Security Management Pro Azure hosts over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

cspm_container_avg_sum

\n
\n

int64

\n

Shows the average number of Cloud Security Management Pro containers over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

cspm_container_hwm_sum

\n
\n

int64

\n

Shows the sum of the high-water marks of Cloud Security Management Pro containers over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

cspm_gcp_host_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Security Management Pro GCP hosts over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

cspm_host_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Security Management Pro hosts over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

custom_historical_ts_sum

\n
\n

int64

\n

Shows the average number of distinct historical custom metrics over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

custom_live_ts_sum

\n
\n

int64

\n

Shows the average number of distinct live custom metrics over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

custom_ts_sum

\n
\n

int64

\n

Shows the average number of distinct custom metrics over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

cws_container_avg_sum

\n
\n

int64

\n

Shows the average of all distinct Cloud Workload Security containers over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

cws_fargate_task_avg_sum

\n
\n

int64

\n

Shows the average of all distinct Cloud Workload Security Fargate tasks over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

cws_host_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Workload Security hosts over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

data_jobs_monitoring_host_hr_agg_sum

\n
\n

int64

\n

Shows the sum of Data Jobs Monitoring hosts over all hours in the current months for all organizations

\n
\n \n
\n
\n
\n
\n
\n

dbm_host_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of all Database Monitoring hosts over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

dbm_queries_avg_sum

\n
\n

int64

\n

Shows the average of all distinct Database Monitoring Normalized Queries over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

end_date

\n
\n

date-time

\n

Shows the last date of usage in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_agent_agg_sum

\n
\n

int64

\n

Shows the sum of all ephemeral infrastructure hosts with the Datadog Agent over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_alibaba_agg_sum

\n
\n

int64

\n

Shows the sum of all ephemeral infrastructure hosts on Alibaba over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_aws_agg_sum

\n
\n

int64

\n

Shows the sum of all ephemeral infrastructure hosts on AWS over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_azure_agg_sum

\n
\n

int64

\n

Shows the sum of all ephemeral infrastructure hosts on Azure over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_ent_agg_sum

\n
\n

int64

\n

Shows the sum of all ephemeral infrastructure hosts for Enterprise over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_gcp_agg_sum

\n
\n

int64

\n

Shows the sum of all ephemeral infrastructure hosts on GCP over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_heroku_agg_sum

\n
\n

int64

\n

Shows the sum of all ephemeral infrastructure hosts on Heroku over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_only_aas_agg_sum

\n
\n

int64

\n

Shows the sum of all ephemeral infrastructure hosts with only Azure App Services over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_only_vsphere_agg_sum

\n
\n

int64

\n

Shows the sum of all ephemeral infrastructure hosts with only vSphere over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_opentelemetry_agg_sum

\n
\n

int64

\n

Shows the sum of all ephemeral hosts reported by the Datadog exporter for the OpenTelemetry Collector over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_opentelemetry_apm_agg_sum

\n
\n

int64

\n

Shows the sum of all ephemeral APM hosts reported by the Datadog exporter for the OpenTelemetry Collector over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_pro_agg_sum

\n
\n

int64

\n

Shows the sum of all ephemeral infrastructure hosts for Pro over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_proplus_agg_sum

\n
\n

int64

\n

Shows the sum of all ephemeral infrastructure hosts for Pro Plus over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

error_tracking_apm_error_events_agg_sum

\n
\n

int64

\n

Shows the sum of all Error Tracking APM error events over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

error_tracking_error_events_agg_sum

\n
\n

int64

\n

Shows the sum of all Error Tracking error events over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

error_tracking_events_agg_sum

\n
\n

int64

\n

Shows the sum of all Error Tracking events over all hours in the current months for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

error_tracking_rum_error_events_agg_sum

\n
\n

int64

\n

Shows the sum of all Error Tracking RUM error events over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

event_management_correlation_agg_sum

\n
\n

int64

\n

Shows the sum of all Event Management correlations over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

event_management_correlation_correlated_events_agg_sum

\n
\n

int64

\n

Shows the sum of all Event Management correlated events over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

event_management_correlation_correlated_related_events_agg_sum

\n
\n

int64

\n

Shows the sum of all Event Management correlated related events over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

fargate_container_profiler_profiling_fargate_avg_sum

\n
\n

int64

\n

The average number of Profiling Fargate tasks over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

fargate_container_profiler_profiling_fargate_eks_avg_sum

\n
\n

int64

\n

The average number of Profiling Fargate Elastic Kubernetes Service tasks over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

fargate_tasks_count_avg_sum

\n
\n

int64

\n

Shows the average of all Fargate tasks over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

fargate_tasks_count_hwm_sum

\n
\n

int64

\n

Shows the sum of the high-water marks of all Fargate tasks over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

flex_logs_compute_large_avg_sum

\n
\n

int64

\n

Shows the average number of Flex Logs Compute Large Instances over all hours in the current months for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

flex_logs_compute_medium_avg_sum

\n
\n

int64

\n

Shows the average number of Flex Logs Compute Medium Instances over all hours in the current months for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

flex_logs_compute_small_avg_sum

\n
\n

int64

\n

Shows the average number of Flex Logs Compute Small Instances over all hours in the current months for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

flex_logs_compute_xlarge_avg_sum

\n
\n

int64

\n

Shows the average number of Flex Logs Compute Extra Large Instances over all hours in the current months for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

flex_logs_compute_xsmall_avg_sum

\n
\n

int64

\n

Shows the average number of Flex Logs Compute Extra Small Instances over all hours in the current months for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

flex_logs_starter_avg_sum

\n
\n

int64

\n

Shows the average number of Flex Logs Starter Instances over all hours in the current months for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

flex_logs_starter_storage_index_avg_sum

\n
\n

int64

\n

Shows the average number of Flex Logs Starter Storage Index Instances over all hours in the current months for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

flex_logs_starter_storage_retention_adjustment_avg_sum

\n
\n

int64

\n

Shows the average number of Flex Logs Starter Storage Retention Adjustment Instances over all hours in the current months for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

flex_stored_logs_avg_sum

\n
\n

int64

\n

Shows the average of all Flex Stored Logs over all hours in the current months for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

forwarding_events_bytes_agg_sum

\n
\n

int64

\n

Shows the sum of all logs forwarding bytes over all hours in the current month for all organizations (data available as of April 1, 2023)

\n
\n \n
\n
\n
\n
\n
\n

gcp_host_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of all GCP hosts over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

heroku_host_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of all Heroku dynos over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

incident_management_monthly_active_users_hwm_sum

\n
\n

int64

\n

Shows sum of the high-water marks of incident management monthly active users in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

indexed_events_count_agg_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all log events indexed over all hours in the current month for all organizations (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

infra_host_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of all distinct infrastructure hosts over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

ingested_events_bytes_agg_sum

\n
\n

int64

\n

Shows the sum of all log bytes ingested over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

iot_device_agg_sum

\n
\n

int64

\n

Shows the sum of all IoT devices over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

iot_device_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of all IoT devices over all hours in the current month of all organizations.

\n
\n \n
\n
\n
\n
\n
\n

last_updated

\n
\n

date-time

\n

Shows the most recent hour in the current month for all organizations for which all usages were calculated.

\n
\n \n
\n
\n
\n
\n
\n

live_indexed_events_agg_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all live logs indexed over all hours in the current month for all organization (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

live_ingested_bytes_agg_sum

\n
\n

int64

\n

Shows the sum of all live logs bytes ingested over all hours in the current month for all organizations (data available as of December 1, 2020).

\n
\n \n
\n
\n
\n
\n
\n

llm_observability_agg_sum

\n
\n

int64

\n

Sum of all LLM observability sessions for all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

llm_observability_min_spend_agg_sum

\n
\n

int64

\n

Minimum spend for LLM observability sessions for all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

logs_by_retention

\n
\n

object

\n

Object containing logs usage data broken down by retention period.

\n
\n
\n
\n
\n
\n

orgs

\n
\n

object

\n

Indexed logs usage summary for each organization for each retention period with usage.

\n
\n
\n
\n
\n
\n

usage

\n
\n

[object]

\n

Indexed logs usage summary for each organization.

\n
\n
\n
\n
\n
\n

usage

\n
\n

[object]

\n

Indexed logs usage for each active retention for the organization.

\n
\n
\n
\n
\n
\n

logs_indexed_logs_usage_sum

\n
\n

int64

\n

Total indexed logs for this retention period.

\n
\n \n
\n
\n
\n
\n
\n

logs_live_indexed_logs_usage_sum

\n
\n

int64

\n

Live indexed logs for this retention period.

\n
\n \n
\n
\n
\n
\n
\n

logs_rehydrated_indexed_logs_usage_sum

\n
\n

int64

\n

Rehydrated indexed logs for this retention period.

\n
\n \n
\n
\n
\n
\n
\n

retention

\n
\n

string

\n

The retention period in days or "custom" for all custom retention periods.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

usage

\n
\n

[object]

\n

Aggregated index logs usage for each retention period with usage.

\n
\n
\n
\n
\n
\n

logs_indexed_logs_usage_agg_sum

\n
\n

int64

\n

Total indexed logs for this retention period.

\n
\n \n
\n
\n
\n
\n
\n

logs_live_indexed_logs_usage_agg_sum

\n
\n

int64

\n

Live indexed logs for this retention period.

\n
\n \n
\n
\n
\n
\n
\n

logs_rehydrated_indexed_logs_usage_agg_sum

\n
\n

int64

\n

Rehydrated indexed logs for this retention period.

\n
\n \n
\n
\n
\n
\n
\n

retention

\n
\n

string

\n

The retention period in days or "custom" for all custom retention periods.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

usage_by_month

\n
\n

object

\n

Object containing a summary of indexed logs usage by retention period for a single month.

\n
\n
\n
\n
\n
\n

date

\n
\n

date-time

\n

The month for the usage.

\n
\n \n
\n
\n
\n
\n
\n

usage

\n
\n

[object]

\n

Indexed logs usage for each active retention for the month.

\n
\n
\n
\n
\n
\n

logs_indexed_logs_usage_sum

\n
\n

int64

\n

Total indexed logs for this retention period.

\n
\n \n
\n
\n
\n
\n
\n

logs_live_indexed_logs_usage_sum

\n
\n

int64

\n

Live indexed logs for this retention period.

\n
\n \n
\n
\n
\n
\n
\n

logs_rehydrated_indexed_logs_usage_sum

\n
\n

int64

\n

Rehydrated indexed logs for this retention period.

\n
\n \n
\n
\n
\n
\n
\n

retention

\n
\n

string

\n

The retention period in days or "custom" for all custom retention periods.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

mobile_rum_lite_session_count_agg_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all mobile lite sessions over all hours in the current month for all organizations (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

mobile_rum_session_count_agg_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all mobile RUM sessions over all hours in the current month for all organizations (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

mobile_rum_session_count_android_agg_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all mobile RUM sessions on Android over all hours in the current month for all organizations (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

mobile_rum_session_count_flutter_agg_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all mobile RUM sessions on Flutter over all hours in the current month for all organizations (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

mobile_rum_session_count_ios_agg_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all mobile RUM sessions on iOS over all hours in the current month for all organizations (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

mobile_rum_session_count_reactnative_agg_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all mobile RUM sessions on React Native over all hours in the current month for all organizations (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

mobile_rum_session_count_roku_agg_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all mobile RUM sessions on Roku over all hours in the current month for all organizations (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

mobile_rum_units_agg_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all mobile RUM units over all hours in the current month for all organizations (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

ndm_netflow_events_agg_sum

\n
\n

int64

\n

Shows the sum of all Network Device Monitoring NetFlow events over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

netflow_indexed_events_count_agg_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all Network flows indexed over all hours in the current month for all organizations (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

network_device_wireless_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of all Network Device Monitoring wireless devices over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

npm_host_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of all distinct Cloud Network Monitoring hosts (formerly known as Network hosts) over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

observability_pipelines_bytes_processed_agg_sum

\n
\n

int64

\n

Sum of all observability pipelines bytes processed over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

oci_host_agg_sum

\n
\n

int64

\n

Shows the sum of Oracle Cloud Infrastructure hosts over all hours in the current months for all organizations

\n
\n \n
\n
\n
\n
\n
\n

oci_host_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of Oracle Cloud Infrastructure hosts over all hours in the current months for all organizations

\n
\n \n
\n
\n
\n
\n
\n

on_call_seat_hwm_sum

\n
\n

int64

\n

Shows the sum of the high-water marks of On-Call seats over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

online_archive_events_count_agg_sum

\n
\n

int64

\n

Sum of all online archived events over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

opentelemetry_apm_host_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of APM hosts reported by the Datadog exporter for the OpenTelemetry Collector over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

opentelemetry_host_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of all hosts reported by the Datadog exporter for the OpenTelemetry Collector over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

product_analytics_agg_sum

\n
\n

int64

\n

Sum of all product analytics sessions for all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

profiling_aas_count_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of all profiled Azure app services over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

profiling_container_agent_count_avg

\n
\n

int64

\n

Shows the average number of profiled containers over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

profiling_host_count_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of all profiled hosts over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

published_app_hwm_sum

\n
\n

int64

\n

Shows the high-water mark of all published applications over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

rehydrated_indexed_events_agg_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all rehydrated logs indexed over all hours in the current month for all organizations (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rehydrated_ingested_bytes_agg_sum

\n
\n

int64

\n

Shows the sum of all rehydrated logs bytes ingested over all hours in the current month for all organizations (data available as of December 1, 2020).

\n
\n \n
\n
\n
\n
\n
\n

rum_browser_and_mobile_session_count

\n
\n

int64

\n

Shows the sum of all mobile sessions and all browser lite and legacy sessions over all hours in the current month for all organizations (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_browser_legacy_session_count_agg_sum

\n
\n

int64

\n

Shows the sum of all browser RUM legacy sessions over all hours in the current month for all organizations (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_browser_lite_session_count_agg_sum

\n
\n

int64

\n

Shows the sum of all browser RUM lite sessions over all hours in the current month for all organizations (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_browser_replay_session_count_agg_sum

\n
\n

int64

\n

Shows the sum of all browser RUM Session Replay counts over all hours in the current month for all organizations (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_indexed_sessions_agg_sum

\n
\n

int64

\n

Sum of all RUM indexed sessions for all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

rum_ingested_sessions_agg_sum

\n
\n

int64

\n

Sum of all RUM ingested sessions for all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

rum_lite_session_count_agg_sum

\n
\n

int64

\n

Shows the sum of all RUM lite sessions (browser and mobile) over all hours in the current month for all organizations (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_legacy_session_count_android_agg_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM legacy sessions on Android over all hours in the current month for all organizations (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_legacy_session_count_flutter_agg_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM legacy sessions on Flutter over all hours in the current month for all organizations (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_legacy_session_count_ios_agg_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM legacy sessions on iOS over all hours in the current month for all organizations (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_legacy_session_count_reactnative_agg_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM legacy sessions on React Native over all hours in the current month for all organizations (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_legacy_session_count_roku_agg_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM legacy sessions on Roku over all hours in the current month for all organizations (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_lite_session_count_android_agg_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM lite sessions on Android over all hours in the current month for all organizations (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_lite_session_count_flutter_agg_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM lite sessions on Flutter over all hours in the current month for all organizations (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_lite_session_count_ios_agg_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM lite sessions on iOS over all hours in the current month for all organizations (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_lite_session_count_kotlinmultiplatform_agg_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM lite sessions on Kotlin Multiplatform over all hours within the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_lite_session_count_reactnative_agg_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM lite sessions on React Native over all hours in the current month for all organizations (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_lite_session_count_roku_agg_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM lite sessions on Roku over all hours within the current month for all organizations (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_lite_session_count_unity_agg_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM lite sessions on Unity over all hours within the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_replay_session_count_android_agg_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM replay sessions on Android over all hours within the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_replay_session_count_ios_agg_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM replay sessions on iOS over all hours within the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_replay_session_count_kotlinmultiplatform_agg_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM replay sessions on Kotlin Multiplatform over all hours within the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_replay_session_count_reactnative_agg_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM replay sessions on React Native over all hours within the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

rum_replay_session_count_agg_sum

\n
\n

int64

\n

Shows the sum of all RUM Session Replay counts over all hours in the current month for all organizations (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_session_count_agg_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all browser RUM lite sessions over all hours in the current month for all organizations (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_session_replay_add_on_agg_sum

\n
\n

int64

\n

Sum of all RUM session replay add-on sessions for all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

rum_total_session_count_agg_sum

\n
\n

int64

\n

Shows the sum of RUM sessions (browser and mobile) over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

rum_units_agg_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all browser and mobile RUM units over all hours in the current month for all organizations (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

sca_fargate_count_avg_sum

\n
\n

int64

\n

Shows the average of all Software Composition Analysis Fargate tasks over all hours in the current months for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

sca_fargate_count_hwm_sum

\n
\n

int64

\n

Shows the sum of the high-water marks of all Software Composition Analysis Fargate tasks over all hours in the current months for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

sds_apm_scanned_bytes_sum

\n
\n

int64

\n

Sum of all APM bytes scanned with sensitive data scanner in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

sds_events_scanned_bytes_sum

\n
\n

int64

\n

Sum of all event stream events bytes scanned with sensitive data scanner in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

sds_logs_scanned_bytes_sum

\n
\n

int64

\n

Shows the sum of all bytes scanned of logs usage by the Sensitive Data Scanner over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

sds_rum_scanned_bytes_sum

\n
\n

int64

\n

Sum of all RUM bytes scanned with sensitive data scanner in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

sds_total_scanned_bytes_sum

\n
\n

int64

\n

Shows the sum of all bytes scanned across all usage types by the Sensitive Data Scanner over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_apm_azure_appservice_instances_avg_sum

\n
\n

int64

\n

Sum of the average number of Serverless Apps with Application Performance Monitoring for Azure App Service instances in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_apm_azure_azurefunction_instances_avg_sum

\n
\n

int64

\n

Sum of the average number of Serverless Apps with Application Performance Monitoring for Azure Function instances in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_apm_azure_containerapp_instances_avg_sum

\n
\n

int64

\n

Sum of the average number of Serverless Apps with Application Performance Monitoring for Azure Container App instances in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_apm_fargate_ecs_tasks_avg_sum

\n
\n

int64

\n

Sum of the average number of Serverless Apps with Application Performance Monitoring for Fargate Elastic Container Service tasks in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_apm_gcp_cloudfunction_instances_avg_sum

\n
\n

int64

\n

Sum of the average number of Serverless Apps with Application Performance Monitoring for Google Cloud Platform Cloud Function instances in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_apm_gcp_cloudrun_instances_avg_sum

\n
\n

int64

\n

Sum of the average number of Serverless Apps with Application Performance Monitoring for Google Cloud Platform Cloud Run instances in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_avg_sum

\n
\n

int64

\n

Sum of the average number of Serverless Apps with Application Performance Monitoring in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_excl_fargate_apm_azure_appservice_instances_avg_sum

\n
\n

int64

\n

Sum of the average number of Serverless Apps with Application Performance Monitoring excluding Fargate for Azure App Service instances in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_excl_fargate_apm_azure_azurefunction_instances_avg_sum

\n
\n

int64

\n

Sum of the average number of Serverless Apps with Application Performance Monitoring excluding Fargate for Azure Function instances in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_excl_fargate_apm_azure_containerapp_instances_avg_sum

\n
\n

int64

\n

Sum of the average number of Serverless Apps with Application Performance Monitoring excluding Fargate for Azure Container App instances in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_excl_fargate_apm_gcp_cloudfunction_instances_avg_sum

\n
\n

int64

\n

Sum of the average number of Serverless Apps with Application Performance Monitoring excluding Fargate for Google Cloud Platform Cloud Function instances in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_excl_fargate_apm_gcp_cloudrun_instances_avg_sum

\n
\n

int64

\n

Sum of the average number of Serverless Apps with Application Performance Monitoring excluding Fargate for Google Cloud Platform Cloud Run instances in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_excl_fargate_avg_sum

\n
\n

int64

\n

Sum of the average number of Serverless Apps with Application Performance Monitoring excluding Fargate in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_azure_container_app_instances_avg_sum

\n
\n

int64

\n

Sum of the average number of Serverless Apps for Azure Container App instances in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_azure_count_avg_sum

\n
\n

int64

\n

Sum of the average number of Serverless Apps for Azure in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_azure_function_app_instances_avg_sum

\n
\n

int64

\n

Sum of the average number of Serverless Apps for Azure Function App instances in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_azure_web_app_instances_avg_sum

\n
\n

int64

\n

Sum of the average number of Serverless Apps for Azure Web App instances in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_ecs_avg_sum

\n
\n

int64

\n

Sum of the average number of Serverless Apps for Elastic Container Service in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_eks_avg_sum

\n
\n

int64

\n

Sum of the average number of Serverless Apps for Elastic Kubernetes Service in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_excl_fargate_avg_sum

\n
\n

int64

\n

Sum of the average number of Serverless Apps excluding Fargate in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_excl_fargate_azure_container_app_instances_avg_sum

\n
\n

int64

\n

Sum of the average number of Serverless Apps excluding Fargate for Azure Container App instances in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_excl_fargate_azure_function_app_instances_avg_sum

\n
\n

int64

\n

Sum of the average number of Serverless Apps excluding Fargate for Azure Function App instances in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_excl_fargate_azure_web_app_instances_avg_sum

\n
\n

int64

\n

Sum of the average number of Serverless Apps excluding Fargate for Azure Web App instances in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_excl_fargate_google_cloud_functions_instances_avg_sum

\n
\n

int64

\n

Sum of the average number of Serverless Apps excluding Fargate for Google Cloud Platform Cloud Functions instances in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_excl_fargate_google_cloud_run_instances_avg_sum

\n
\n

int64

\n

Sum of the average number of Serverless Apps excluding Fargate for Google Cloud Platform Cloud Run instances in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_google_cloud_functions_instances_avg_sum

\n
\n

int64

\n

Sum of the average number of Serverless Apps for Google Cloud Platform Cloud Functions instances in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_google_cloud_run_instances_avg_sum

\n
\n

int64

\n

Sum of the average number of Serverless Apps for Google Cloud Platform Cloud Run instances in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_google_count_avg_sum

\n
\n

int64

\n

Sum of the average number of Serverless Apps for Google Cloud in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_total_count_avg_sum

\n
\n

int64

\n

Sum of the average number of Serverless Apps for Azure and Google Cloud in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

siem_analyzed_logs_add_on_count_agg_sum

\n
\n

int64

\n

Shows the sum of all log events analyzed by Cloud SIEM over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

start_date

\n
\n

date-time

\n

Shows the first date of usage in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

synthetics_browser_check_calls_count_agg_sum

\n
\n

int64

\n

Shows the sum of all Synthetic browser tests over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

synthetics_check_calls_count_agg_sum

\n
\n

int64

\n

Shows the sum of all Synthetic API tests over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

synthetics_mobile_test_runs_agg_sum

\n
\n

int64

\n

Shows the sum of Synthetic mobile application tests over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

synthetics_parallel_testing_max_slots_hwm_sum

\n
\n

int64

\n

Shows the sum of the high-water marks of used synthetics parallel testing slots over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

trace_search_indexed_events_count_agg_sum

\n
\n

int64

\n

Shows the sum of all Indexed Spans indexed over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

twol_ingested_events_bytes_agg_sum

\n
\n

int64

\n

Shows the sum of all ingested APM span bytes over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

universal_service_monitoring_host_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of all Universal Service Monitoring hosts over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

usage

\n
\n

[object]

\n

An array of objects regarding hourly usage.

\n
\n
\n
\n
\n
\n

agent_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all agent hosts over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

apm_azure_app_service_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Azure app services using APM over all hours in the current date all organizations.

\n
\n \n
\n
\n
\n
\n
\n

apm_devsecops_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all APM DevSecOps hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

apm_fargate_count_avg

\n
\n

int64

\n

Shows the average of all APM ECS Fargate tasks over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

apm_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all distinct APM hosts over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

appsec_fargate_count_avg

\n
\n

int64

\n

Shows the average of all Application Security Monitoring ECS Fargate tasks over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

asm_serverless_sum

\n
\n

int64

\n

Shows the sum of all Application Security Monitoring Serverless invocations over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

audit_logs_lines_indexed_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of audit logs lines indexed over all hours in the current date for all organizations (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

audit_trail_enabled_hwm

\n
\n

int64

\n

Shows the number of organizations that had Audit Trail enabled in the current date.

\n
\n \n
\n
\n
\n
\n
\n

avg_profiled_fargate_tasks

\n
\n

int64

\n

The average total count for Fargate Container Profiler over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

aws_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all AWS hosts over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

aws_lambda_func_count

\n
\n

int64

\n

Shows the average of the number of functions that executed 1 or more times each hour in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

aws_lambda_invocations_sum

\n
\n

int64

\n

Shows the sum of all AWS Lambda invocations over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

azure_app_service_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Azure app services over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

billable_ingested_bytes_sum

\n
\n

int64

\n

Shows the sum of all log bytes ingested over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

bits_ai_investigations_sum

\n
\n

int64

\n

Shows the sum of all Bits AI Investigations over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

browser_rum_lite_session_count_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all browser lite sessions over all hours in the current date for all organizations (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

browser_rum_replay_session_count_sum

\n
\n

int64

\n

Shows the sum of all browser replay sessions over all hours in the current date for all organizations (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

browser_rum_units_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all browser RUM units over all hours in the current date for all organizations (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

ci_pipeline_indexed_spans_sum

\n
\n

int64

\n

Shows the sum of all CI pipeline indexed spans over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

ci_test_indexed_spans_sum

\n
\n

int64

\n

Shows the sum of all CI test indexed spans over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

ci_visibility_itr_committers_hwm

\n
\n

int64

\n

Shows the high-water mark of all CI visibility intelligent test runner committers over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

ci_visibility_pipeline_committers_hwm

\n
\n

int64

\n

Shows the high-water mark of all CI visibility pipeline committers over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

ci_visibility_test_committers_hwm

\n
\n

int64

\n

Shows the high-water mark of all CI visibility test committers over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

cloud_cost_management_aws_host_count_avg

\n
\n

int64

\n

Host count average of Cloud Cost Management for AWS for the given date and given organization.

\n
\n \n
\n
\n
\n
\n
\n

cloud_cost_management_azure_host_count_avg

\n
\n

int64

\n

Host count average of Cloud Cost Management for Azure for the given date and given organization.

\n
\n \n
\n
\n
\n
\n
\n

cloud_cost_management_gcp_host_count_avg

\n
\n

int64

\n

Host count average of Cloud Cost Management for GCP for the given date and given organization.

\n
\n \n
\n
\n
\n
\n
\n

cloud_cost_management_host_count_avg

\n
\n

int64

\n

Host count average of Cloud Cost Management for all cloud providers for the given date and given organization.

\n
\n \n
\n
\n
\n
\n
\n

cloud_siem_events_sum

\n
\n

int64

\n

Shows the sum of all Cloud Security Information and Event Management events over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

code_analysis_sa_committers_hwm

\n
\n

int64

\n

Shows the high-water mark of all Static Analysis committers over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

code_analysis_sca_committers_hwm

\n
\n

int64

\n

Shows the high-water mark of all static Software Composition Analysis committers over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

code_security_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Code Security hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

container_avg

\n
\n

int64

\n

Shows the average of all distinct containers over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

container_excl_agent_avg

\n
\n

int64

\n

Shows the average of containers without the Datadog Agent over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

container_hwm

\n
\n

int64

\n

Shows the high-water mark of all distinct containers over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

csm_container_enterprise_compliance_count_sum

\n
\n

int64

\n

Shows the sum of all Cloud Security Management Enterprise compliance containers over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

csm_container_enterprise_cws_count_sum

\n
\n

int64

\n

Shows the sum of all Cloud Security Management Enterprise Cloud Workload Security containers over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

csm_container_enterprise_total_count_sum

\n
\n

int64

\n

Shows the sum of all Cloud Security Management Enterprise containers over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

csm_host_enterprise_aas_host_count_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Security Management Enterprise Azure app services hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

csm_host_enterprise_aws_host_count_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Security Management Enterprise AWS hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

csm_host_enterprise_azure_host_count_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Security Management Enterprise Azure hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

csm_host_enterprise_compliance_host_count_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Security Management Enterprise compliance hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

csm_host_enterprise_cws_host_count_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Security Management Enterprise Cloud Workload Security hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

csm_host_enterprise_gcp_host_count_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Security Management Enterprise GCP hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

csm_host_enterprise_total_host_count_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Security Management Enterprise hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

cspm_aas_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Security Management Pro Azure app services hosts over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

cspm_aws_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Security Management Pro AWS hosts over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

cspm_azure_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Security Management Pro Azure hosts over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

cspm_container_avg

\n
\n

int64

\n

Shows the average number of Cloud Security Management Pro containers over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

cspm_container_hwm

\n
\n

int64

\n

Shows the high-water mark of Cloud Security Management Pro containers over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

cspm_gcp_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Security Management Pro GCP hosts over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

cspm_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Security Management Pro hosts over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

custom_ts_avg

\n
\n

int64

\n

Shows the average number of distinct custom metrics over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

cws_container_count_avg

\n
\n

int64

\n

Shows the average of all distinct Cloud Workload Security containers over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

cws_fargate_task_avg

\n
\n

int64

\n

Shows the average of all distinct Cloud Workload Security Fargate tasks over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

cws_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Workload Security hosts over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

data_jobs_monitoring_host_hr_sum

\n
\n

int64

\n

Shows the sum of all Data Jobs Monitoring hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

date

\n
\n

date-time

\n

The date for the usage.

\n
\n \n
\n
\n
\n
\n
\n

dbm_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Database Monitoring hosts over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

dbm_queries_count_avg

\n
\n

int64

\n

Shows the average of all normalized Database Monitoring queries over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_agent_sum

\n
\n

int64

\n

Shows the sum of all ephemeral infrastructure hosts with the Datadog Agent over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_alibaba_sum

\n
\n

int64

\n

Shows the sum of all ephemeral infrastructure hosts on Alibaba over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_aws_sum

\n
\n

int64

\n

Shows the sum of all ephemeral infrastructure hosts on AWS over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_azure_sum

\n
\n

int64

\n

Shows the sum of all ephemeral infrastructure hosts on Azure over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_ent_sum

\n
\n

int64

\n

Shows the sum of all ephemeral infrastructure hosts for Enterprise over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_gcp_sum

\n
\n

int64

\n

Shows the sum of all ephemeral infrastructure hosts on GCP over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_heroku_sum

\n
\n

int64

\n

Shows the sum of all ephemeral infrastructure hosts on Heroku over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_only_aas_sum

\n
\n

int64

\n

Shows the sum of all ephemeral infrastructure hosts with only Azure App Services over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_only_vsphere_sum

\n
\n

int64

\n

Shows the sum of all ephemeral infrastructure hosts with only vSphere over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_opentelemetry_apm_sum

\n
\n

int64

\n

Shows the sum of all ephemeral APM hosts reported by the Datadog exporter for the OpenTelemetry Collector over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_opentelemetry_sum

\n
\n

int64

\n

Shows the sum of all ephemeral hosts reported by the Datadog exporter for the OpenTelemetry Collector over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_pro_sum

\n
\n

int64

\n

Shows the sum of all ephemeral infrastructure hosts for Pro over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_proplus_sum

\n
\n

int64

\n

Shows the sum of all ephemeral infrastructure hosts for Pro Plus over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

error_tracking_apm_error_events_sum

\n
\n

int64

\n

Shows the sum of all Error Tracking APM error events over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

error_tracking_error_events_sum

\n
\n

int64

\n

Shows the sum of all Error Tracking error events over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

error_tracking_events_sum

\n
\n

int64

\n

Shows the sum of all Error Tracking events over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

error_tracking_rum_error_events_sum

\n
\n

int64

\n

Shows the sum of all Error Tracking RUM error events over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

event_management_correlation_correlated_events_sum

\n
\n

int64

\n

Shows the sum of all Event Management correlated events over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

event_management_correlation_correlated_related_events_sum

\n
\n

int64

\n

Shows the sum of all Event Management correlated related events over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

event_management_correlation_sum

\n
\n

int64

\n

Shows the sum of all Event Management correlations over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

fargate_container_profiler_profiling_fargate_avg

\n
\n

int64

\n

The average number of Profiling Fargate tasks over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

fargate_container_profiler_profiling_fargate_eks_avg

\n
\n

int64

\n

The average number of Profiling Fargate Elastic Kubernetes Service tasks over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

fargate_tasks_count_avg

\n
\n

int64

\n

Shows the high-watermark of all Fargate tasks over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

fargate_tasks_count_hwm

\n
\n

int64

\n

Shows the average of all Fargate tasks over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

flex_logs_compute_large_avg

\n
\n

int64

\n

Shows the average number of Flex Logs Compute Large Instances over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

flex_logs_compute_medium_avg

\n
\n

int64

\n

Shows the average number of Flex Logs Compute Medium Instances over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

flex_logs_compute_small_avg

\n
\n

int64

\n

Shows the average number of Flex Logs Compute Small Instances over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

flex_logs_compute_xlarge_avg

\n
\n

int64

\n

Shows the average number of Flex Logs Compute Extra Large Instances over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

flex_logs_compute_xsmall_avg

\n
\n

int64

\n

Shows the average number of Flex Logs Compute Extra Small Instances over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

flex_logs_starter_avg

\n
\n

int64

\n

Shows the average number of Flex Logs Starter Instances over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

flex_logs_starter_storage_index_avg

\n
\n

int64

\n

Shows the average number of Flex Logs Starter Storage Index Instances over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

flex_logs_starter_storage_retention_adjustment_avg

\n
\n

int64

\n

Shows the average number of Flex Logs Starter Storage Retention Adjustment Instances over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

flex_stored_logs_avg

\n
\n

int64

\n

Shows the average of all Flex Stored Logs over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

forwarding_events_bytes_sum

\n
\n

int64

\n

Shows the sum of all log bytes forwarded over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

gcp_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all GCP hosts over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

heroku_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Heroku dynos over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

incident_management_monthly_active_users_hwm

\n
\n

int64

\n

Shows the high-water mark of incident management monthly active users over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

indexed_events_count_sum

\n
\n

int64

\n

Shows the sum of all log events indexed over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

infra_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all distinct infrastructure hosts over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

ingested_events_bytes_sum

\n
\n

int64

\n

Shows the sum of all log bytes ingested over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

iot_device_sum

\n
\n

int64

\n

Shows the sum of all IoT devices over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

iot_device_top99p

\n
\n

int64

\n

Shows the 99th percentile of all IoT devices over all hours in the current date all organizations.

\n
\n \n
\n
\n
\n
\n
\n

llm_observability_min_spend_sum

\n
\n

int64

\n

Sum of all LLM observability minimum spend over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

llm_observability_sum

\n
\n

int64

\n

Sum of all LLM observability sessions over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

mobile_rum_lite_session_count_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all mobile lite sessions over all hours in the current date for all organizations (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

mobile_rum_session_count_android_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all mobile RUM sessions on Android over all hours in the current date for all organizations (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

mobile_rum_session_count_flutter_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all mobile RUM sessions on Flutter over all hours in the current date for all organizations (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

mobile_rum_session_count_ios_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all mobile RUM sessions on iOS over all hours in the current date for all organizations (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

mobile_rum_session_count_reactnative_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all mobile RUM sessions on React Native over all hours in the current date for all organizations (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

mobile_rum_session_count_roku_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all mobile RUM sessions on Roku over all hours in the current date for all organizations (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

mobile_rum_session_count_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all mobile RUM sessions over all hours in the current date for all organizations (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

mobile_rum_units_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all mobile RUM units over all hours in the current date for all organizations (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

ndm_netflow_events_sum

\n
\n

int64

\n

Shows the sum of all Network Device Monitoring NetFlow events over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

netflow_indexed_events_count_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all Network flows indexed over all hours in the current date for all organizations (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

network_device_wireless_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Network Device Monitoring wireless devices over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

npm_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all distinct Cloud Network Monitoring hosts (formerly known as Network hosts) over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

observability_pipelines_bytes_processed_sum

\n
\n

int64

\n

Sum of all observability pipelines bytes processed over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

oci_host_sum

\n
\n

int64

\n

Shows the sum of all Oracle Cloud Infrastructure hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

oci_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Oracle Cloud Infrastructure hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

on_call_seat_hwm

\n
\n

int64

\n

Shows the high-water mark of On-Call seats over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

online_archive_events_count_sum

\n
\n

int64

\n

Sum of all online archived events over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

opentelemetry_apm_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of APM hosts reported by the Datadog exporter for the OpenTelemetry Collector over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

opentelemetry_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all hosts reported by the Datadog exporter for the OpenTelemetry Collector over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

orgs

\n
\n

[object]

\n

Organizations associated with a user.

\n
\n
\n
\n
\n
\n

account_name

\n
\n

string

\n

The account name.

\n
\n \n
\n
\n
\n
\n
\n

account_public_id

\n
\n

string

\n

The account public id.

\n
\n \n
\n
\n
\n
\n
\n

agent_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all agent hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

apm_azure_app_service_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Azure app services using APM over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

apm_devsecops_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all APM DevSecOps hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

apm_fargate_count_avg

\n
\n

int64

\n

Shows the average of all APM ECS Fargate tasks over all hours in the current month for the given org.

\n
\n \n
\n
\n
\n
\n
\n

apm_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all distinct APM hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

appsec_fargate_count_avg

\n
\n

int64

\n

Shows the average of all Application Security Monitoring ECS Fargate tasks over all hours in the current month for the given org.

\n
\n \n
\n
\n
\n
\n
\n

asm_serverless_sum

\n
\n

int64

\n

Shows the sum of all Application Security Monitoring Serverless invocations over all hours in the current month for the given org.

\n
\n \n
\n
\n
\n
\n
\n

audit_logs_lines_indexed_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all audit logs lines indexed over all hours in the current date for the given org (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

audit_trail_enabled_hwm

\n
\n

int64

\n

Shows whether Audit Trail is enabled for the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

avg_profiled_fargate_tasks

\n
\n

int64

\n

The average total count for Fargate Container Profiler over all hours in the current month for the given org.

\n
\n \n
\n
\n
\n
\n
\n

aws_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all AWS hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

aws_lambda_func_count

\n
\n

int64

\n

Shows the sum of all AWS Lambda invocations over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

aws_lambda_invocations_sum

\n
\n

int64

\n

Shows the sum of all AWS Lambda invocations over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

azure_app_service_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Azure app services over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

billable_ingested_bytes_sum

\n
\n

int64

\n

Shows the sum of all log bytes ingested over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

bits_ai_investigations_sum

\n
\n

int64

\n

Shows the sum of all Bits AI Investigations over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

browser_rum_lite_session_count_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all browser lite sessions over all hours in the current date for the given org (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

browser_rum_replay_session_count_sum

\n
\n

int64

\n

Shows the sum of all browser replay sessions over all hours in the current date for the given org (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

browser_rum_units_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all browser RUM units over all hours in the current date for the given org (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

ci_pipeline_indexed_spans_sum

\n
\n

int64

\n

Shows the sum of all CI pipeline indexed spans over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

ci_test_indexed_spans_sum

\n
\n

int64

\n

Shows the sum of all CI test indexed spans over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

ci_visibility_itr_committers_hwm

\n
\n

int64

\n

Shows the high-water mark of all CI visibility intelligent test runner committers over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

ci_visibility_pipeline_committers_hwm

\n
\n

int64

\n

Shows the high-water mark of all CI visibility pipeline committers over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

ci_visibility_test_committers_hwm

\n
\n

int64

\n

Shows the high-water mark of all CI visibility test committers over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

cloud_cost_management_aws_host_count_avg

\n
\n

int64

\n

Host count average of Cloud Cost Management for AWS for the given date and given org.

\n
\n \n
\n
\n
\n
\n
\n

cloud_cost_management_azure_host_count_avg

\n
\n

int64

\n

Host count average of Cloud Cost Management for Azure for the given date and given org.

\n
\n \n
\n
\n
\n
\n
\n

cloud_cost_management_gcp_host_count_avg

\n
\n

int64

\n

Host count average of Cloud Cost Management for GCP for the given date and given org.

\n
\n \n
\n
\n
\n
\n
\n

cloud_cost_management_host_count_avg

\n
\n

int64

\n

Host count average of Cloud Cost Management for all cloud providers for the given date and given org.

\n
\n \n
\n
\n
\n
\n
\n

cloud_siem_events_sum

\n
\n

int64

\n

Shows the sum of all Cloud Security Information and Event Management events over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

code_analysis_sa_committers_hwm

\n
\n

int64

\n

Shows the high-water mark of all Static Analysis committers over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

code_analysis_sca_committers_hwm

\n
\n

int64

\n

Shows the high-water mark of all static Software Composition Analysis committers over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

code_security_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Code Security hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

container_avg

\n
\n

int64

\n

Shows the average of all distinct containers over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

container_excl_agent_avg

\n
\n

int64

\n

Shows the average of containers without the Datadog Agent over all hours in the current date for the given organization.

\n
\n \n
\n
\n
\n
\n
\n

container_hwm

\n
\n

int64

\n

Shows the high-water mark of all distinct containers over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

csm_container_enterprise_compliance_count_sum

\n
\n

int64

\n

Shows the sum of all Cloud Security Management Enterprise compliance containers over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

csm_container_enterprise_cws_count_sum

\n
\n

int64

\n

Shows the sum of all Cloud Security Management Enterprise Cloud Workload Security containers over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

csm_container_enterprise_total_count_sum

\n
\n

int64

\n

Shows the sum of all Cloud Security Management Enterprise containers over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

csm_host_enterprise_aas_host_count_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Security Management Enterprise Azure app services hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

csm_host_enterprise_aws_host_count_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Security Management Enterprise AWS hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

csm_host_enterprise_azure_host_count_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Security Management Enterprise Azure hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

csm_host_enterprise_compliance_host_count_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Security Management Enterprise compliance hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

csm_host_enterprise_cws_host_count_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Security Management Enterprise Cloud Workload Security hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

csm_host_enterprise_gcp_host_count_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Security Management Enterprise GCP hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

csm_host_enterprise_total_host_count_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Security Management Enterprise hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

cspm_aas_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Security Management Pro Azure app services hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

cspm_aws_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Security Management Pro AWS hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

cspm_azure_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Security Management Pro Azure hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

cspm_container_avg

\n
\n

int64

\n

Shows the average number of Cloud Security Management Pro containers over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

cspm_container_hwm

\n
\n

int64

\n

Shows the high-water mark of Cloud Security Management Pro containers over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

cspm_gcp_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Security Management Pro GCP hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

cspm_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Security Management Pro hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

custom_historical_ts_avg

\n
\n

int64

\n

Shows the average number of distinct historical custom metrics over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

custom_live_ts_avg

\n
\n

int64

\n

Shows the average number of distinct live custom metrics over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

custom_ts_avg

\n
\n

int64

\n

Shows the average number of distinct custom metrics over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

cws_container_count_avg

\n
\n

int64

\n

Shows the average of all distinct Cloud Workload Security containers over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

cws_fargate_task_avg

\n
\n

int64

\n

Shows the average of all distinct Cloud Workload Security Fargate tasks over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

cws_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Workload Security hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

data_jobs_monitoring_host_hr_sum

\n
\n

int64

\n

Shows the sum of all Data Jobs Monitoring hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

dbm_host_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of all Database Monitoring hosts over all hours in the current month for the given org.

\n
\n \n
\n
\n
\n
\n
\n

dbm_queries_avg_sum

\n
\n

int64

\n

Shows the average of all distinct Database Monitoring normalized queries over all hours in the current month for the given org.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_agent_sum

\n
\n

int64

\n

Shows the sum of all ephemeral infrastructure hosts with the Datadog Agent over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_alibaba_sum

\n
\n

int64

\n

Shows the sum of all ephemeral infrastructure hosts on Alibaba over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_aws_sum

\n
\n

int64

\n

Shows the sum of all ephemeral infrastructure hosts on AWS over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_azure_sum

\n
\n

int64

\n

Shows the sum of all ephemeral infrastructure hosts on Azure over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_ent_sum

\n
\n

int64

\n

Shows the sum of all ephemeral infrastructure hosts for Enterprise over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_gcp_sum

\n
\n

int64

\n

Shows the sum of all ephemeral infrastructure hosts on GCP over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_heroku_sum

\n
\n

int64

\n

Shows the sum of all ephemeral infrastructure hosts on Heroku over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_only_aas_sum

\n
\n

int64

\n

Shows the sum of all ephemeral infrastructure hosts with only Azure App Services over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_only_vsphere_sum

\n
\n

int64

\n

Shows the sum of all ephemeral infrastructure hosts with only vSphere over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_opentelemetry_apm_sum

\n
\n

int64

\n

Shows the sum of all ephemeral APM hosts reported by the Datadog exporter for the OpenTelemetry Collector over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_opentelemetry_sum

\n
\n

int64

\n

Shows the sum of all ephemeral hosts reported by the Datadog exporter for the OpenTelemetry Collector over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_pro_sum

\n
\n

int64

\n

Shows the sum of all ephemeral infrastructure hosts for Pro over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_proplus_sum

\n
\n

int64

\n

Shows the sum of all ephemeral infrastructure hosts for Pro Plus over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

error_tracking_apm_error_events_sum

\n
\n

int64

\n

Shows the sum of all Error Tracking APM error events over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

error_tracking_error_events_sum

\n
\n

int64

\n

Shows the sum of all Error Tracking error events over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

error_tracking_events_sum

\n
\n

int64

\n

Shows the sum of all Error Tracking events over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

error_tracking_rum_error_events_sum

\n
\n

int64

\n

Shows the sum of all Error Tracking RUM error events over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

event_management_correlation_correlated_events_sum

\n
\n

int64

\n

Shows the sum of all Event Management correlated events over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

event_management_correlation_correlated_related_events_sum

\n
\n

int64

\n

Shows the sum of all Event Management correlated related events over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

event_management_correlation_sum

\n
\n

int64

\n

Shows the sum of all Event Management correlations over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

fargate_container_profiler_profiling_fargate_avg

\n
\n

int64

\n

The average number of Profiling Fargate tasks over all hours in the current month for the given org.

\n
\n \n
\n
\n
\n
\n
\n

fargate_container_profiler_profiling_fargate_eks_avg

\n
\n

int64

\n

The average number of Profiling Fargate Elastic Kubernetes Service tasks over all hours in the current month for the given org.

\n
\n \n
\n
\n
\n
\n
\n

fargate_tasks_count_avg

\n
\n

int64

\n

The average task count for Fargate.

\n
\n \n
\n
\n
\n
\n
\n

fargate_tasks_count_hwm

\n
\n

int64

\n

Shows the high-water mark of all Fargate tasks over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

flex_logs_compute_large_avg

\n
\n

int64

\n

Shows the average number of Flex Logs Compute Large Instances over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

flex_logs_compute_medium_avg

\n
\n

int64

\n

Shows the average number of Flex Logs Compute Medium Instances over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

flex_logs_compute_small_avg

\n
\n

int64

\n

Shows the average number of Flex Logs Compute Small Instances over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

flex_logs_compute_xlarge_avg

\n
\n

int64

\n

Shows the average number of Flex Logs Compute Extra Large Instances over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

flex_logs_compute_xsmall_avg

\n
\n

int64

\n

Shows the average number of Flex Logs Compute Extra Small Instances over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

flex_logs_starter_avg

\n
\n

int64

\n

Shows the average number of Flex Logs Starter Instances over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

flex_logs_starter_storage_index_avg

\n
\n

int64

\n

Shows the average number of Flex Logs Starter Storage Index Instances over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

flex_logs_starter_storage_retention_adjustment_avg

\n
\n

int64

\n

Shows the average number of Flex Logs Starter Storage Retention Adjustment Instances over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

flex_stored_logs_avg

\n
\n

int64

\n

Shows the average of all Flex Stored Logs over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

forwarding_events_bytes_sum

\n
\n

int64

\n

Shows the sum of all log bytes forwarded over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

gcp_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all GCP hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

heroku_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Heroku dynos over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The organization id.

\n
\n \n
\n
\n
\n
\n
\n

incident_management_monthly_active_users_hwm

\n
\n

int64

\n

Shows the high-water mark of incident management monthly active users over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

indexed_events_count_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all log events indexed over all hours in the current date for the given org (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

infra_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all distinct infrastructure hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

ingested_events_bytes_sum

\n
\n

int64

\n

Shows the sum of all log bytes ingested over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

iot_device_agg_sum

\n
\n

int64

\n

Shows the sum of all IoT devices over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

iot_device_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of all IoT devices over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

llm_observability_min_spend_sum

\n
\n

int64

\n

Shows the sum of all LLM Observability minimum spend over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

llm_observability_sum

\n
\n

int64

\n

Shows the sum of all LLM observability sessions over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

mobile_rum_lite_session_count_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all mobile lite sessions over all hours in the current date for the given org (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

mobile_rum_session_count_android_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all mobile RUM sessions on Android over all hours in the current date for the given org (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

mobile_rum_session_count_flutter_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all mobile RUM sessions on Flutter over all hours in the current date for the given org (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

mobile_rum_session_count_ios_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all mobile RUM sessions on iOS over all hours in the current date for the given org (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

mobile_rum_session_count_reactnative_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all mobile RUM sessions on React Native over all hours in the current date for the given org (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

mobile_rum_session_count_roku_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all mobile RUM sessions on Roku over all hours in the current date for the given org (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

mobile_rum_session_count_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all mobile RUM sessions over all hours in the current date for the given org (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

mobile_rum_units_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all mobile RUM units over all hours in the current date for the given org (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The organization name.

\n
\n \n
\n
\n
\n
\n
\n

ndm_netflow_events_sum

\n
\n

int64

\n

Shows the sum of all Network Device Monitoring NetFlow events over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

netflow_indexed_events_count_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all Network flows indexed over all hours in the current date for the given org (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

network_device_wireless_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Network Device Monitoring wireless devices over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

npm_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all distinct Cloud Network Monitoring hosts (formerly known as Network hosts) over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

observability_pipelines_bytes_processed_sum

\n
\n

int64

\n

Sum of all observability pipelines bytes processed over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

oci_host_sum

\n
\n

int64

\n

Shows the sum of all Oracle Cloud Infrastructure hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

oci_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Oracle Cloud Infrastructure hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

on_call_seat_hwm

\n
\n

int64

\n

Shows the high-water mark of On-Call seats over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

online_archive_events_count_sum

\n
\n

int64

\n

Sum of all online archived events over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

opentelemetry_apm_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of APM hosts reported by the Datadog exporter for the OpenTelemetry Collector over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

opentelemetry_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all hosts reported by the Datadog exporter for the OpenTelemetry Collector over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

product_analytics_sum

\n
\n

int64

\n

Shows the sum of all product analytics sessions over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

profiling_aas_count_top99p

\n
\n

int64

\n

Shows the 99th percentile of all profiled Azure app services over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

profiling_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all profiled hosts over all hours within the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

public_id

\n
\n

string

\n

The organization public id.

\n
\n \n
\n
\n
\n
\n
\n

published_app_hwm

\n
\n

int64

\n

Shows the high-water mark of all published applications over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

The region of the organization.

\n
\n \n
\n
\n
\n
\n
\n

rum_browser_and_mobile_session_count

\n
\n

int64

\n

Shows the sum of all mobile sessions and all browser lite and legacy sessions over all hours in the current date for the given org (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_browser_legacy_session_count_sum

\n
\n

int64

\n

Shows the sum of all browser RUM legacy sessions over all hours in the current date for the given org (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_browser_lite_session_count_sum

\n
\n

int64

\n

Shows the sum of all browser RUM lite sessions over all hours in the current date for the given org (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_browser_replay_session_count_sum

\n
\n

int64

\n

Shows the sum of all browser RUM Session Replay counts over all hours in the current date for the given org (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_indexed_sessions_sum

\n
\n

int64

\n

Shows the sum of all RUM indexed sessions over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

rum_ingested_sessions_sum

\n
\n

int64

\n

Shows the sum of all RUM ingested sessions over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

rum_lite_session_count_sum

\n
\n

int64

\n

Shows the sum of all RUM lite sessions (browser and mobile) over all hours in the current date for the given org (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_legacy_session_count_android_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM legacy sessions on Android over all hours in the current date for the given org (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_legacy_session_count_flutter_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM legacy sessions on Flutter over all hours in the current date for the given org (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_legacy_session_count_ios_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM legacy sessions on iOS over all hours in the current date for the given org (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_legacy_session_count_reactnative_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM legacy sessions on React Native over all hours in the current date for the given org (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_legacy_session_count_roku_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM legacy sessions on Roku over all hours in the current date for the given org (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_lite_session_count_android_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM lite sessions on Android over all hours in the current date for the given org (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_lite_session_count_flutter_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM lite sessions on Flutter over all hours in the current date for the given org (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_lite_session_count_ios_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM lite sessions on iOS over all hours in the current date for the given org (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_lite_session_count_kotlinmultiplatform_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM lite sessions on Kotlin Multiplatform over all hours within the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_lite_session_count_reactnative_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM lite sessions on React Native over all hours in the current date for the given org (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_lite_session_count_roku_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM lite sessions on Roku over all hours in the current date for the given org (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_lite_session_count_unity_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM lite sessions on Unity over all hours within the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_replay_session_count_android_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM replay sessions on Android over all hours within the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_replay_session_count_ios_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM replay sessions on iOS over all hours within the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_replay_session_count_kotlinmultiplatform_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM replay sessions on Kotlin Multiplatform over all hours within the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_replay_session_count_reactnative_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM replay sessions on React Native over all hours within the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

rum_replay_session_count_sum

\n
\n

int64

\n

Shows the sum of all RUM Session Replay counts over all hours in the current date for the given org (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_session_count_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all browser RUM lite sessions over all hours in the current date for the given org (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_session_replay_add_on_sum

\n
\n

int64

\n

Shows the sum of all RUM session replay add-on sessions over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

rum_total_session_count_sum

\n
\n

int64

\n

Shows the sum of RUM sessions (browser and mobile) over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

rum_units_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all browser and mobile RUM units over all hours in the current date for the given org (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

sca_fargate_count_avg

\n
\n

int64

\n

Shows the average of all Software Composition Analysis Fargate tasks over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

sca_fargate_count_hwm

\n
\n

int64

\n

Shows the sum of the high-water marks of all Software Composition Analysis Fargate tasks over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

sds_apm_scanned_bytes_sum

\n
\n

int64

\n

Sum of all APM bytes scanned with sensitive data scanner over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

sds_events_scanned_bytes_sum

\n
\n

int64

\n

Sum of all event stream events bytes scanned with sensitive data scanner over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

sds_logs_scanned_bytes_sum

\n
\n

int64

\n

Shows the sum of all bytes scanned of logs usage by the Sensitive Data Scanner over all hours in the current month for the given org.

\n
\n \n
\n
\n
\n
\n
\n

sds_rum_scanned_bytes_sum

\n
\n

int64

\n

Sum of all RUM bytes scanned with sensitive data scanner over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

sds_total_scanned_bytes_sum

\n
\n

int64

\n

Shows the sum of all bytes scanned across all usage types by the Sensitive Data Scanner over all hours in the current month for the given org.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_apm_azure_appservice_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps with Application Performance Monitoring for Azure App Service instances for the given date and given org.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_apm_azure_azurefunction_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps with Application Performance Monitoring for Azure Function instances for the given date and given org.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_apm_azure_containerapp_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps with Application Performance Monitoring for Azure Container App instances for the given date and given org.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_apm_fargate_ecs_tasks_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps with Application Performance Monitoring for Fargate Elastic Container Service tasks for the given date and given org.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_apm_gcp_cloudfunction_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps with Application Performance Monitoring for Google Cloud Platform Cloud Function instances for the given date and given org.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_apm_gcp_cloudrun_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps with Application Performance Monitoring for Google Cloud Platform Cloud Run instances for the given date and given org.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps with Application Performance Monitoring for the given date and given org.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_excl_fargate_apm_azure_appservice_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps with Application Performance Monitoring excluding Fargate for Azure App Service instances for the given date and given org.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_excl_fargate_apm_azure_azurefunction_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps with Application Performance Monitoring excluding Fargate for Azure Function instances for the given date and given org.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_excl_fargate_apm_azure_containerapp_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps with Application Performance Monitoring excluding Fargate for Azure Container App instances for the given date and given org.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_excl_fargate_apm_gcp_cloudfunction_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps with Application Performance Monitoring excluding Fargate for Google Cloud Platform Cloud Function instances for the given date and given org.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_excl_fargate_apm_gcp_cloudrun_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps with Application Performance Monitoring excluding Fargate for Google Cloud Platform Cloud Run instances for the given date and given org.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_excl_fargate_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps with Application Performance Monitoring excluding Fargate for the given date and given org.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_azure_container_app_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps for Azure Container App instances for the given date and given org.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_azure_count_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps for Azure for the given date and given org.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_azure_function_app_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps for Azure Function App instances for the given date and given org.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_azure_web_app_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps for Azure Web App instances for the given date and given org.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_ecs_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps for Elastic Container Service for the given date and given org.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_eks_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps for Elastic Kubernetes Service for the given date and given org.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_excl_fargate_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps excluding Fargate for the given date and given org.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_excl_fargate_azure_container_app_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps excluding Fargate for Azure Container App instances for the given date and given org.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_excl_fargate_azure_function_app_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps excluding Fargate for Azure Function App instances for the given date and given org.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_excl_fargate_azure_web_app_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps excluding Fargate for Azure Web App instances for the given date and given org.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_excl_fargate_google_cloud_functions_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps excluding Fargate for Google Cloud Platform Cloud Functions instances for the given date and given org.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_excl_fargate_google_cloud_run_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps excluding Fargate for Google Cloud Platform Cloud Run instances for the given date and given org.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_google_cloud_functions_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps for Google Cloud Platform Cloud Functions instances for the given date and given org.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_google_cloud_run_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps for Google Cloud Platform Cloud Run instances for the given date and given org.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_google_count_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps for Google Cloud for the given date and given org.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_total_count_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps for Azure and Google Cloud for the given date and given org.

\n
\n \n
\n
\n
\n
\n
\n

siem_analyzed_logs_add_on_count_sum

\n
\n

int64

\n

Shows the sum of all log events analyzed by Cloud SIEM over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

synthetics_browser_check_calls_count_sum

\n
\n

int64

\n

Shows the sum of all Synthetic browser tests over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

synthetics_check_calls_count_sum

\n
\n

int64

\n

Shows the sum of all Synthetic API tests over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

synthetics_mobile_test_runs_sum

\n
\n

int64

\n

Shows the sum of all Synthetic mobile application tests over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

synthetics_parallel_testing_max_slots_hwm

\n
\n

int64

\n

Shows the high-water mark of used synthetics parallel testing slots over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

trace_search_indexed_events_count_sum

\n
\n

int64

\n

Shows the sum of all Indexed Spans indexed over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

twol_ingested_events_bytes_sum

\n
\n

int64

\n

Shows the sum of all ingested APM span bytes over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

universal_service_monitoring_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Universal Service Monitoring hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

vsphere_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all vSphere hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

vuln_management_host_count_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Application Vulnerability Management hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

workflow_executions_usage_sum

\n
\n

int64

\n

Sum of all workflows executed over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

product_analytics_sum

\n
\n

int64

\n

Sum of all product analytics sessions over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

profiling_aas_count_top99p

\n
\n

int64

\n

Shows the 99th percentile of all profiled Azure app services over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

profiling_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all profiled hosts over all hours within the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

published_app_hwm

\n
\n

int64

\n

Shows the high-water mark of all published applications over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

rum_browser_and_mobile_session_count

\n
\n

int64

\n

Shows the sum of all mobile sessions and all browser lite and legacy sessions over all hours in the current month for all organizations (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_browser_legacy_session_count_sum

\n
\n

int64

\n

Shows the sum of all browser RUM legacy sessions over all hours in the current date for all organizations (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_browser_lite_session_count_sum

\n
\n

int64

\n

Shows the sum of all browser RUM lite sessions over all hours in the current date for all organizations (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_browser_replay_session_count_sum

\n
\n

int64

\n

Shows the sum of all browser RUM Session Replay counts over all hours in the current date for all organizations (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_indexed_sessions_sum

\n
\n

int64

\n

Sum of all RUM indexed sessions over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

rum_ingested_sessions_sum

\n
\n

int64

\n

Sum of all RUM ingested sessions over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

rum_lite_session_count_sum

\n
\n

int64

\n

Shows the sum of all RUM lite sessions (browser and mobile) over all hours in the current date for all organizations (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_legacy_session_count_android_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM legacy sessions on Android over all hours in the current date for all organizations (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_legacy_session_count_flutter_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM legacy Sessions on Flutter over all hours in the current date for all organizations (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_legacy_session_count_ios_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM legacy sessions on iOS over all hours in the current date for all organizations (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_legacy_session_count_reactnative_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM legacy sessions on React Native over all hours in the current date for all organizations (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_legacy_session_count_roku_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM legacy sessions on Roku over all hours in the current date for all organizations (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_lite_session_count_android_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM lite sessions on Android over all hours in the current date for all organizations (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_lite_session_count_flutter_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM lite sessions on Flutter over all hours in the current date for all organizations (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_lite_session_count_ios_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM lite sessions on iOS over all hours in the current date for all organizations (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_lite_session_count_kotlinmultiplatform_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM lite sessions on Kotlin Multiplatform over all hours within the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_lite_session_count_reactnative_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM lite sessions on React Native over all hours in the current date for all organizations (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_lite_session_count_roku_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM lite sessions on Roku over all hours within the current date for all organizations (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_lite_session_count_unity_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM lite sessions on Unity over all hours within the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_replay_session_count_android_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM replay sessions on Android over all hours within the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_replay_session_count_ios_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM replay sessions on iOS over all hours within the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_replay_session_count_kotlinmultiplatform_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM replay sessions on Kotlin Multiplatform over all hours within the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_replay_session_count_reactnative_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM replay sessions on React Native over all hours within the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

rum_replay_session_count_sum

\n
\n

int64

\n

Shows the sum of all RUM Session Replay counts over all hours in the current date for all organizations (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_session_count_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all browser RUM lite sessions over all hours in the current date for all organizations (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_session_replay_add_on_sum

\n
\n

int64

\n

Sum of all RUM session replay add-on sessions over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

rum_total_session_count_sum

\n
\n

int64

\n

Shows the sum of RUM sessions (browser and mobile) over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

rum_units_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all browser and mobile RUM units over all hours in the current date for all organizations (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

sca_fargate_count_avg

\n
\n

int64

\n

Shows the average of all Software Composition Analysis Fargate tasks over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

sca_fargate_count_hwm

\n
\n

int64

\n

Shows the sum of the high-water marks of all Software Composition Analysis Fargate tasks over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

sds_apm_scanned_bytes_sum

\n
\n

int64

\n

Sum of all APM bytes scanned with sensitive data scanner over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

sds_events_scanned_bytes_sum

\n
\n

int64

\n

Sum of all event stream events bytes scanned with sensitive data scanner over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

sds_logs_scanned_bytes_sum

\n
\n

int64

\n

Shows the sum of all bytes scanned of logs usage by the Sensitive Data Scanner over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

sds_rum_scanned_bytes_sum

\n
\n

int64

\n

Sum of all RUM bytes scanned with sensitive data scanner over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

sds_total_scanned_bytes_sum

\n
\n

int64

\n

Shows the sum of all bytes scanned across all usage types by the Sensitive Data Scanner over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_apm_azure_appservice_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps with Application Performance Monitoring for Azure App Service instances for the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_apm_azure_azurefunction_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps with Application Performance Monitoring for Azure Function instances for the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_apm_azure_containerapp_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps with Application Performance Monitoring for Azure Container App instances for the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_apm_fargate_ecs_tasks_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps with Application Performance Monitoring for Fargate Elastic Container Service tasks for the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_apm_gcp_cloudfunction_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps with Application Performance Monitoring for Google Cloud Platform Cloud Function instances for the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_apm_gcp_cloudrun_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps with Application Performance Monitoring for Google Cloud Platform Cloud Run instances for the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps with Application Performance Monitoring for the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_excl_fargate_apm_azure_appservice_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps with Application Performance Monitoring excluding Fargate for Azure App Service instances for the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_excl_fargate_apm_azure_azurefunction_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps with Application Performance Monitoring excluding Fargate for Azure Function instances for the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_excl_fargate_apm_azure_containerapp_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps with Application Performance Monitoring excluding Fargate for Azure Container App instances for the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_excl_fargate_apm_gcp_cloudfunction_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps with Application Performance Monitoring excluding Fargate for Google Cloud Platform Cloud Function instances for the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_excl_fargate_apm_gcp_cloudrun_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps with Application Performance Monitoring excluding Fargate for Google Cloud Platform Cloud Run instances for the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_excl_fargate_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps with Application Performance Monitoring excluding Fargate for the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_azure_container_app_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps for Azure Container App instances for the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_azure_count_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps for Azure for the given date and given org.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_azure_function_app_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps for Azure Function App instances for the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_azure_web_app_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps for Azure Web App instances for the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_ecs_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps for Elastic Container Service for the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_eks_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps for Elastic Kubernetes Service for the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_excl_fargate_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps excluding Fargate for the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_excl_fargate_azure_container_app_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps excluding Fargate for Azure Container App instances for the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_excl_fargate_azure_function_app_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps excluding Fargate for Azure Function App instances for the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_excl_fargate_azure_web_app_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps excluding Fargate for Azure Web App instances for the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_excl_fargate_google_cloud_functions_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps excluding Fargate for Google Cloud Platform Cloud Functions instances for the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_excl_fargate_google_cloud_run_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps excluding Fargate for Google Cloud Platform Cloud Run instances for the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_google_cloud_functions_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps for Google Cloud Platform Cloud Functions instances for the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_google_cloud_run_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps for Google Cloud Platform Cloud Run instances for the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_google_count_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps for Google Cloud for the given date and given org.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_total_count_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps for Azure and Google Cloud for the given date and given org.

\n
\n \n
\n
\n
\n
\n
\n

siem_analyzed_logs_add_on_count_sum

\n
\n

int64

\n

Shows the sum of all log events analyzed by Cloud SIEM over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

synthetics_browser_check_calls_count_sum

\n
\n

int64

\n

Shows the sum of all Synthetic browser tests over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

synthetics_check_calls_count_sum

\n
\n

int64

\n

Shows the sum of all Synthetic API tests over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

synthetics_mobile_test_runs_sum

\n
\n

int64

\n

Shows the sum of all Synthetic mobile application tests over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

synthetics_parallel_testing_max_slots_hwm

\n
\n

int64

\n

Shows the high-water mark of used synthetics parallel testing slots over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

trace_search_indexed_events_count_sum

\n
\n

int64

\n

Shows the sum of all Indexed Spans indexed over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

twol_ingested_events_bytes_sum

\n
\n

int64

\n

Shows the sum of all ingested APM span bytes over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

universal_service_monitoring_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all universal service management hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

vsphere_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all vSphere hosts over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

vuln_management_host_count_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Application Vulnerability Management hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

workflow_executions_usage_sum

\n
\n

int64

\n

Sum of all workflows executed over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

vsphere_host_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of all vSphere hosts over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

vuln_management_host_count_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of all Application Vulnerability Management hosts over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

workflow_executions_usage_agg_sum

\n
\n

int64

\n

Sum of all workflows executed over all hours in the current month for all organizations.

\n
\n \n
\n
" + "html": "
\n
\n
\n
\n

agent_host_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of all agent hosts over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

apm_azure_app_service_host_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of all Azure app services using APM over all hours in the current month all organizations.

\n
\n \n
\n
\n
\n
\n
\n

apm_devsecops_host_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of all APM DevSecOps hosts over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

apm_enterprise_standalone_hosts_top99p_sum

\n
\n

int64

\n

Shows the sum of the 99th percentile of all distinct standalone Enterprise hosts over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

apm_fargate_count_avg_sum

\n
\n

int64

\n

Shows the average of all APM ECS Fargate tasks over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

apm_host_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of all distinct APM hosts over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

apm_pro_standalone_hosts_top99p_sum

\n
\n

int64

\n

Shows the sum of the 99th percentile of all distinct standalone Pro hosts over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

appsec_fargate_count_avg_sum

\n
\n

int64

\n

Shows the average of all Application Security Monitoring ECS Fargate tasks over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

asm_serverless_agg_sum

\n
\n

int64

\n

Shows the sum of all Application Security Monitoring Serverless invocations over all hours in the current months for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

audit_logs_lines_indexed_agg_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all audit logs lines indexed over all hours in the current month for all organizations (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

audit_trail_enabled_hwm_sum

\n
\n

int64

\n

Shows the total number of organizations that had Audit Trail enabled over a specific number of months.

\n
\n \n
\n
\n
\n
\n
\n

avg_profiled_fargate_tasks_sum

\n
\n

int64

\n

The average total count for Fargate Container Profiler over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

aws_host_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of all AWS hosts over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

aws_lambda_func_count

\n
\n

int64

\n

Shows the average of the number of functions that executed 1 or more times each hour in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

aws_lambda_invocations_sum

\n
\n

int64

\n

Shows the sum of all AWS Lambda invocations over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

azure_app_service_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of all Azure app services over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

azure_host_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of all Azure hosts over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

billable_ingested_bytes_agg_sum

\n
\n

int64

\n

Shows the sum of all log bytes ingested over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

bits_ai_investigations_agg_sum

\n
\n

int64

\n

Shows the sum of all Bits AI Investigations over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

browser_rum_lite_session_count_agg_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all browser lite sessions over all hours in the current month for all organizations (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

browser_rum_replay_session_count_agg_sum

\n
\n

int64

\n

Shows the sum of all browser replay sessions over all hours in the current month for all organizations (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

browser_rum_units_agg_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all browser RUM units over all hours in the current month for all organizations (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

ci_pipeline_indexed_spans_agg_sum

\n
\n

int64

\n

Shows the sum of all CI pipeline indexed spans over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

ci_test_indexed_spans_agg_sum

\n
\n

int64

\n

Shows the sum of all CI test indexed spans over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

ci_visibility_itr_committers_hwm_sum

\n
\n

int64

\n

Shows the high-water mark of all CI visibility intelligent test runner committers over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

ci_visibility_pipeline_committers_hwm_sum

\n
\n

int64

\n

Shows the high-water mark of all CI visibility pipeline committers over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

ci_visibility_test_committers_hwm_sum

\n
\n

int64

\n

Shows the high-water mark of all CI visibility test committers over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

cloud_cost_management_aws_host_count_avg_sum

\n
\n

int64

\n

Sum of the host count average for Cloud Cost Management for AWS.

\n
\n \n
\n
\n
\n
\n
\n

cloud_cost_management_azure_host_count_avg_sum

\n
\n

int64

\n

Sum of the host count average for Cloud Cost Management for Azure.

\n
\n \n
\n
\n
\n
\n
\n

cloud_cost_management_gcp_host_count_avg_sum

\n
\n

int64

\n

Sum of the host count average for Cloud Cost Management for GCP.

\n
\n \n
\n
\n
\n
\n
\n

cloud_cost_management_host_count_avg_sum

\n
\n

int64

\n

Sum of the host count average for Cloud Cost Management for all cloud providers.

\n
\n \n
\n
\n
\n
\n
\n

cloud_siem_events_agg_sum

\n
\n

int64

\n

Shows the sum of all Cloud Security Information and Event Management events over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

code_analysis_sa_committers_hwm_sum

\n
\n

int64

\n

Shows the high-water mark of all Static Analysis committers over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

code_analysis_sca_committers_hwm_sum

\n
\n

int64

\n

Shows the high-water mark of all static Software Composition Analysis committers over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

code_security_host_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of all Code Security hosts over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

container_avg_sum

\n
\n

int64

\n

Shows the average of all distinct containers over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

container_excl_agent_avg_sum

\n
\n

int64

\n

Shows the average of the containers without the Datadog Agent over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

container_hwm_sum

\n
\n

int64

\n

Shows the sum of the high-water marks of all distinct containers over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

csm_container_enterprise_compliance_count_agg_sum

\n
\n

int64

\n

Shows the sum of all Cloud Security Management Enterprise compliance containers over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

csm_container_enterprise_cws_count_agg_sum

\n
\n

int64

\n

Shows the sum of all Cloud Security Management Enterprise Cloud Workload Security containers over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

csm_container_enterprise_total_count_agg_sum

\n
\n

int64

\n

Shows the sum of all Cloud Security Management Enterprise containers over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

csm_host_enterprise_aas_host_count_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Security Management Enterprise Azure app services hosts over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

csm_host_enterprise_aws_host_count_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Security Management Enterprise AWS hosts over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

csm_host_enterprise_azure_host_count_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Security Management Enterprise Azure hosts over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

csm_host_enterprise_compliance_host_count_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Security Management Enterprise compliance hosts over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

csm_host_enterprise_cws_host_count_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Security Management Enterprise Cloud Workload Security hosts over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

csm_host_enterprise_gcp_host_count_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Security Management Enterprise GCP hosts over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

csm_host_enterprise_total_host_count_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Security Management Enterprise hosts over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

cspm_aas_host_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Security Management Pro Azure app services hosts over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

cspm_aws_host_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Security Management Pro AWS hosts over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

cspm_azure_host_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Security Management Pro Azure hosts over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

cspm_container_avg_sum

\n
\n

int64

\n

Shows the average number of Cloud Security Management Pro containers over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

cspm_container_hwm_sum

\n
\n

int64

\n

Shows the sum of the high-water marks of Cloud Security Management Pro containers over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

cspm_gcp_host_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Security Management Pro GCP hosts over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

cspm_host_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Security Management Pro hosts over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

custom_historical_ts_sum

\n
\n

int64

\n

Shows the average number of distinct historical custom metrics over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

custom_live_ts_sum

\n
\n

int64

\n

Shows the average number of distinct live custom metrics over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

custom_ts_sum

\n
\n

int64

\n

Shows the average number of distinct custom metrics over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

cws_container_avg_sum

\n
\n

int64

\n

Shows the average of all distinct Cloud Workload Security containers over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

cws_fargate_task_avg_sum

\n
\n

int64

\n

Shows the average of all distinct Cloud Workload Security Fargate tasks over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

cws_host_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Workload Security hosts over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

data_jobs_monitoring_host_hr_agg_sum

\n
\n

int64

\n

Shows the sum of Data Jobs Monitoring hosts over all hours in the current months for all organizations

\n
\n \n
\n
\n
\n
\n
\n

dbm_host_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of all Database Monitoring hosts over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

dbm_queries_avg_sum

\n
\n

int64

\n

Shows the average of all distinct Database Monitoring Normalized Queries over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

end_date

\n
\n

date-time

\n

Shows the last date of usage in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_agent_agg_sum

\n
\n

int64

\n

Shows the sum of all ephemeral infrastructure hosts with the Datadog Agent over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_alibaba_agg_sum

\n
\n

int64

\n

Shows the sum of all ephemeral infrastructure hosts on Alibaba over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_aws_agg_sum

\n
\n

int64

\n

Shows the sum of all ephemeral infrastructure hosts on AWS over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_azure_agg_sum

\n
\n

int64

\n

Shows the sum of all ephemeral infrastructure hosts on Azure over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_ent_agg_sum

\n
\n

int64

\n

Shows the sum of all ephemeral infrastructure hosts for Enterprise over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_gcp_agg_sum

\n
\n

int64

\n

Shows the sum of all ephemeral infrastructure hosts on GCP over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_heroku_agg_sum

\n
\n

int64

\n

Shows the sum of all ephemeral infrastructure hosts on Heroku over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_only_aas_agg_sum

\n
\n

int64

\n

Shows the sum of all ephemeral infrastructure hosts with only Azure App Services over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_only_vsphere_agg_sum

\n
\n

int64

\n

Shows the sum of all ephemeral infrastructure hosts with only vSphere over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_opentelemetry_agg_sum

\n
\n

int64

\n

Shows the sum of all ephemeral hosts reported by the Datadog exporter for the OpenTelemetry Collector over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_opentelemetry_apm_agg_sum

\n
\n

int64

\n

Shows the sum of all ephemeral APM hosts reported by the Datadog exporter for the OpenTelemetry Collector over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_pro_agg_sum

\n
\n

int64

\n

Shows the sum of all ephemeral infrastructure hosts for Pro over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_proplus_agg_sum

\n
\n

int64

\n

Shows the sum of all ephemeral infrastructure hosts for Pro Plus over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

error_tracking_apm_error_events_agg_sum

\n
\n

int64

\n

Shows the sum of all Error Tracking APM error events over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

error_tracking_error_events_agg_sum

\n
\n

int64

\n

Shows the sum of all Error Tracking error events over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

error_tracking_events_agg_sum

\n
\n

int64

\n

Shows the sum of all Error Tracking events over all hours in the current months for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

error_tracking_rum_error_events_agg_sum

\n
\n

int64

\n

Shows the sum of all Error Tracking RUM error events over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

event_management_correlation_agg_sum

\n
\n

int64

\n

Shows the sum of all Event Management correlations over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

event_management_correlation_correlated_events_agg_sum

\n
\n

int64

\n

Shows the sum of all Event Management correlated events over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

event_management_correlation_correlated_related_events_agg_sum

\n
\n

int64

\n

Shows the sum of all Event Management correlated related events over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

fargate_container_profiler_profiling_fargate_avg_sum

\n
\n

int64

\n

The average number of Profiling Fargate tasks over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

fargate_container_profiler_profiling_fargate_eks_avg_sum

\n
\n

int64

\n

The average number of Profiling Fargate Elastic Kubernetes Service tasks over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

fargate_tasks_count_avg_sum

\n
\n

int64

\n

Shows the average of all Fargate tasks over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

fargate_tasks_count_hwm_sum

\n
\n

int64

\n

Shows the sum of the high-water marks of all Fargate tasks over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

flex_logs_compute_large_avg_sum

\n
\n

int64

\n

Shows the average number of Flex Logs Compute Large Instances over all hours in the current months for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

flex_logs_compute_medium_avg_sum

\n
\n

int64

\n

Shows the average number of Flex Logs Compute Medium Instances over all hours in the current months for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

flex_logs_compute_small_avg_sum

\n
\n

int64

\n

Shows the average number of Flex Logs Compute Small Instances over all hours in the current months for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

flex_logs_compute_xlarge_avg_sum

\n
\n

int64

\n

Shows the average number of Flex Logs Compute Extra Large Instances over all hours in the current months for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

flex_logs_compute_xsmall_avg_sum

\n
\n

int64

\n

Shows the average number of Flex Logs Compute Extra Small Instances over all hours in the current months for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

flex_logs_starter_avg_sum

\n
\n

int64

\n

Shows the average number of Flex Logs Starter Instances over all hours in the current months for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

flex_logs_starter_storage_index_avg_sum

\n
\n

int64

\n

Shows the average number of Flex Logs Starter Storage Index Instances over all hours in the current months for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

flex_logs_starter_storage_retention_adjustment_avg_sum

\n
\n

int64

\n

Shows the average number of Flex Logs Starter Storage Retention Adjustment Instances over all hours in the current months for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

flex_stored_logs_avg_sum

\n
\n

int64

\n

Shows the average of all Flex Stored Logs over all hours in the current months for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

forwarding_events_bytes_agg_sum

\n
\n

int64

\n

Shows the sum of all logs forwarding bytes over all hours in the current month for all organizations (data available as of April 1, 2023)

\n
\n \n
\n
\n
\n
\n
\n

gcp_host_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of all GCP hosts over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

heroku_host_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of all Heroku dynos over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

incident_management_monthly_active_users_hwm_sum

\n
\n

int64

\n

Shows sum of the high-water marks of incident management monthly active users in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

indexed_events_count_agg_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all log events indexed over all hours in the current month for all organizations (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

infra_host_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of all distinct infrastructure hosts over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

ingested_events_bytes_agg_sum

\n
\n

int64

\n

Shows the sum of all log bytes ingested over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

iot_device_agg_sum

\n
\n

int64

\n

Shows the sum of all IoT devices over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

iot_device_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of all IoT devices over all hours in the current month of all organizations.

\n
\n \n
\n
\n
\n
\n
\n

last_updated

\n
\n

date-time

\n

Shows the most recent hour in the current month for all organizations for which all usages were calculated.

\n
\n \n
\n
\n
\n
\n
\n

live_indexed_events_agg_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all live logs indexed over all hours in the current month for all organization (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

live_ingested_bytes_agg_sum

\n
\n

int64

\n

Shows the sum of all live logs bytes ingested over all hours in the current month for all organizations (data available as of December 1, 2020).

\n
\n \n
\n
\n
\n
\n
\n

llm_observability_agg_sum

\n
\n

int64

\n

Sum of all LLM observability sessions for all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

llm_observability_min_spend_agg_sum

\n
\n

int64

\n

Minimum spend for LLM observability sessions for all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

logs_by_retention

\n
\n

object

\n

Object containing logs usage data broken down by retention period.

\n
\n
\n
\n
\n
\n

orgs

\n
\n

object

\n

Indexed logs usage summary for each organization for each retention period with usage.

\n
\n
\n
\n
\n
\n

usage

\n
\n

[object]

\n

Indexed logs usage summary for each organization.

\n
\n
\n
\n
\n
\n

usage

\n
\n

[object]

\n

Indexed logs usage for each active retention for the organization.

\n
\n
\n
\n
\n
\n

logs_indexed_logs_usage_sum

\n
\n

int64

\n

Total indexed logs for this retention period.

\n
\n \n
\n
\n
\n
\n
\n

logs_live_indexed_logs_usage_sum

\n
\n

int64

\n

Live indexed logs for this retention period.

\n
\n \n
\n
\n
\n
\n
\n

logs_rehydrated_indexed_logs_usage_sum

\n
\n

int64

\n

Rehydrated indexed logs for this retention period.

\n
\n \n
\n
\n
\n
\n
\n

retention

\n
\n

string

\n

The retention period in days or "custom" for all custom retention periods.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

usage

\n
\n

[object]

\n

Aggregated index logs usage for each retention period with usage.

\n
\n
\n
\n
\n
\n

logs_indexed_logs_usage_agg_sum

\n
\n

int64

\n

Total indexed logs for this retention period.

\n
\n \n
\n
\n
\n
\n
\n

logs_live_indexed_logs_usage_agg_sum

\n
\n

int64

\n

Live indexed logs for this retention period.

\n
\n \n
\n
\n
\n
\n
\n

logs_rehydrated_indexed_logs_usage_agg_sum

\n
\n

int64

\n

Rehydrated indexed logs for this retention period.

\n
\n \n
\n
\n
\n
\n
\n

retention

\n
\n

string

\n

The retention period in days or "custom" for all custom retention periods.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

usage_by_month

\n
\n

object

\n

Object containing a summary of indexed logs usage by retention period for a single month.

\n
\n
\n
\n
\n
\n

date

\n
\n

date-time

\n

The month for the usage.

\n
\n \n
\n
\n
\n
\n
\n

usage

\n
\n

[object]

\n

Indexed logs usage for each active retention for the month.

\n
\n
\n
\n
\n
\n

logs_indexed_logs_usage_sum

\n
\n

int64

\n

Total indexed logs for this retention period.

\n
\n \n
\n
\n
\n
\n
\n

logs_live_indexed_logs_usage_sum

\n
\n

int64

\n

Live indexed logs for this retention period.

\n
\n \n
\n
\n
\n
\n
\n

logs_rehydrated_indexed_logs_usage_sum

\n
\n

int64

\n

Rehydrated indexed logs for this retention period.

\n
\n \n
\n
\n
\n
\n
\n

retention

\n
\n

string

\n

The retention period in days or "custom" for all custom retention periods.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

mobile_rum_lite_session_count_agg_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all mobile lite sessions over all hours in the current month for all organizations (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

mobile_rum_session_count_agg_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all mobile RUM sessions over all hours in the current month for all organizations (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

mobile_rum_session_count_android_agg_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all mobile RUM sessions on Android over all hours in the current month for all organizations (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

mobile_rum_session_count_flutter_agg_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all mobile RUM sessions on Flutter over all hours in the current month for all organizations (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

mobile_rum_session_count_ios_agg_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all mobile RUM sessions on iOS over all hours in the current month for all organizations (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

mobile_rum_session_count_reactnative_agg_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all mobile RUM sessions on React Native over all hours in the current month for all organizations (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

mobile_rum_session_count_roku_agg_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all mobile RUM sessions on Roku over all hours in the current month for all organizations (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

mobile_rum_units_agg_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all mobile RUM units over all hours in the current month for all organizations (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

ndm_netflow_events_agg_sum

\n
\n

int64

\n

Shows the sum of all Network Device Monitoring NetFlow events over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

netflow_indexed_events_count_agg_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all Network flows indexed over all hours in the current month for all organizations (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

network_device_wireless_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of all Network Device Monitoring wireless devices over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

npm_host_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of all distinct Cloud Network Monitoring hosts (formerly known as Network hosts) over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

observability_pipelines_bytes_processed_agg_sum

\n
\n

int64

\n

Sum of all observability pipelines bytes processed over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

oci_host_agg_sum

\n
\n

int64

\n

Shows the sum of Oracle Cloud Infrastructure hosts over all hours in the current months for all organizations

\n
\n \n
\n
\n
\n
\n
\n

oci_host_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of Oracle Cloud Infrastructure hosts over all hours in the current months for all organizations

\n
\n \n
\n
\n
\n
\n
\n

on_call_seat_hwm_sum

\n
\n

int64

\n

Shows the sum of the high-water marks of On-Call seats over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

online_archive_events_count_agg_sum

\n
\n

int64

\n

Sum of all online archived events over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

opentelemetry_apm_host_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of APM hosts reported by the Datadog exporter for the OpenTelemetry Collector over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

opentelemetry_host_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of all hosts reported by the Datadog exporter for the OpenTelemetry Collector over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

product_analytics_agg_sum

\n
\n

int64

\n

Sum of all product analytics sessions for all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

profiling_aas_count_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of all profiled Azure app services over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

profiling_container_agent_count_avg

\n
\n

int64

\n

Shows the average number of profiled containers over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

profiling_host_count_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of all profiled hosts over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

published_app_hwm_sum

\n
\n

int64

\n

Shows the high-water mark of all published applications over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

rehydrated_indexed_events_agg_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all rehydrated logs indexed over all hours in the current month for all organizations (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rehydrated_ingested_bytes_agg_sum

\n
\n

int64

\n

Shows the sum of all rehydrated logs bytes ingested over all hours in the current month for all organizations (data available as of December 1, 2020).

\n
\n \n
\n
\n
\n
\n
\n

rum_browser_and_mobile_session_count

\n
\n

int64

\n

Shows the sum of all mobile sessions and all browser lite and legacy sessions over all hours in the current month for all organizations (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_browser_legacy_session_count_agg_sum

\n
\n

int64

\n

Shows the sum of all browser RUM legacy sessions over all hours in the current month for all organizations (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_browser_lite_session_count_agg_sum

\n
\n

int64

\n

Shows the sum of all browser RUM lite sessions over all hours in the current month for all organizations (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_browser_replay_session_count_agg_sum

\n
\n

int64

\n

Shows the sum of all browser RUM Session Replay counts over all hours in the current month for all organizations (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_indexed_sessions_agg_sum

\n
\n

int64

\n

Sum of all RUM indexed sessions for all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

rum_ingested_sessions_agg_sum

\n
\n

int64

\n

Sum of all RUM ingested sessions for all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

rum_lite_session_count_agg_sum

\n
\n

int64

\n

Shows the sum of all RUM lite sessions (browser and mobile) over all hours in the current month for all organizations (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_legacy_session_count_android_agg_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM legacy sessions on Android over all hours in the current month for all organizations (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_legacy_session_count_flutter_agg_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM legacy sessions on Flutter over all hours in the current month for all organizations (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_legacy_session_count_ios_agg_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM legacy sessions on iOS over all hours in the current month for all organizations (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_legacy_session_count_reactnative_agg_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM legacy sessions on React Native over all hours in the current month for all organizations (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_legacy_session_count_roku_agg_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM legacy sessions on Roku over all hours in the current month for all organizations (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_lite_session_count_android_agg_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM lite sessions on Android over all hours in the current month for all organizations (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_lite_session_count_flutter_agg_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM lite sessions on Flutter over all hours in the current month for all organizations (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_lite_session_count_ios_agg_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM lite sessions on iOS over all hours in the current month for all organizations (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_lite_session_count_kotlinmultiplatform_agg_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM lite sessions on Kotlin Multiplatform over all hours within the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_lite_session_count_reactnative_agg_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM lite sessions on React Native over all hours in the current month for all organizations (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_lite_session_count_roku_agg_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM lite sessions on Roku over all hours within the current month for all organizations (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_lite_session_count_unity_agg_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM lite sessions on Unity over all hours within the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_replay_session_count_android_agg_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM replay sessions on Android over all hours within the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_replay_session_count_ios_agg_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM replay sessions on iOS over all hours within the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_replay_session_count_kotlinmultiplatform_agg_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM replay sessions on Kotlin Multiplatform over all hours within the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_replay_session_count_reactnative_agg_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM replay sessions on React Native over all hours within the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

rum_replay_session_count_agg_sum

\n
\n

int64

\n

Shows the sum of all RUM Session Replay counts over all hours in the current month for all organizations (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_session_count_agg_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all browser RUM lite sessions over all hours in the current month for all organizations (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_session_replay_add_on_agg_sum

\n
\n

int64

\n

Sum of all RUM session replay add-on sessions for all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

rum_total_session_count_agg_sum

\n
\n

int64

\n

Shows the sum of RUM sessions (browser and mobile) over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

rum_units_agg_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all browser and mobile RUM units over all hours in the current month for all organizations (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

sca_fargate_count_avg_sum

\n
\n

int64

\n

Shows the average of all Software Composition Analysis Fargate tasks over all hours in the current months for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

sca_fargate_count_hwm_sum

\n
\n

int64

\n

Shows the sum of the high-water marks of all Software Composition Analysis Fargate tasks over all hours in the current months for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

sds_apm_scanned_bytes_sum

\n
\n

int64

\n

Sum of all APM bytes scanned with sensitive data scanner in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

sds_events_scanned_bytes_sum

\n
\n

int64

\n

Sum of all event stream events bytes scanned with sensitive data scanner in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

sds_logs_scanned_bytes_sum

\n
\n

int64

\n

Shows the sum of all bytes scanned of logs usage by the Sensitive Data Scanner over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

sds_rum_scanned_bytes_sum

\n
\n

int64

\n

Sum of all RUM bytes scanned with sensitive data scanner in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

sds_total_scanned_bytes_sum

\n
\n

int64

\n

Shows the sum of all bytes scanned across all usage types by the Sensitive Data Scanner over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_apm_azure_appservice_instances_avg_sum

\n
\n

int64

\n

Sum of the average number of Serverless Apps with Application Performance Monitoring for Azure App Service instances in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_apm_azure_azurefunction_instances_avg_sum

\n
\n

int64

\n

Sum of the average number of Serverless Apps with Application Performance Monitoring for Azure Function instances in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_apm_azure_containerapp_instances_avg_sum

\n
\n

int64

\n

Sum of the average number of Serverless Apps with Application Performance Monitoring for Azure Container App instances in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_apm_fargate_ecs_tasks_avg_sum

\n
\n

int64

\n

Sum of the average number of Serverless Apps with Application Performance Monitoring for Fargate Elastic Container Service tasks in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_apm_gcp_cloudfunction_instances_avg_sum

\n
\n

int64

\n

Sum of the average number of Serverless Apps with Application Performance Monitoring for Google Cloud Platform Cloud Function instances in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_apm_gcp_cloudrun_instances_avg_sum

\n
\n

int64

\n

Sum of the average number of Serverless Apps with Application Performance Monitoring for Google Cloud Platform Cloud Run instances in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_avg_sum

\n
\n

int64

\n

Sum of the average number of Serverless Apps with Application Performance Monitoring in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_excl_fargate_apm_azure_appservice_instances_avg_sum

\n
\n

int64

\n

Sum of the average number of Serverless Apps with Application Performance Monitoring excluding Fargate for Azure App Service instances in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_excl_fargate_apm_azure_azurefunction_instances_avg_sum

\n
\n

int64

\n

Sum of the average number of Serverless Apps with Application Performance Monitoring excluding Fargate for Azure Function instances in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_excl_fargate_apm_azure_containerapp_instances_avg_sum

\n
\n

int64

\n

Sum of the average number of Serverless Apps with Application Performance Monitoring excluding Fargate for Azure Container App instances in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_excl_fargate_apm_gcp_cloudfunction_instances_avg_sum

\n
\n

int64

\n

Sum of the average number of Serverless Apps with Application Performance Monitoring excluding Fargate for Google Cloud Platform Cloud Function instances in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_excl_fargate_apm_gcp_cloudrun_instances_avg_sum

\n
\n

int64

\n

Sum of the average number of Serverless Apps with Application Performance Monitoring excluding Fargate for Google Cloud Platform Cloud Run instances in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_excl_fargate_avg_sum

\n
\n

int64

\n

Sum of the average number of Serverless Apps with Application Performance Monitoring excluding Fargate in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_azure_container_app_instances_avg_sum

\n
\n

int64

\n

Sum of the average number of Serverless Apps for Azure Container App instances in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_azure_count_avg_sum

\n
\n

int64

\n

Sum of the average number of Serverless Apps for Azure in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_azure_function_app_instances_avg_sum

\n
\n

int64

\n

Sum of the average number of Serverless Apps for Azure Function App instances in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_azure_web_app_instances_avg_sum

\n
\n

int64

\n

Sum of the average number of Serverless Apps for Azure Web App instances in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_ecs_avg_sum

\n
\n

int64

\n

Sum of the average number of Serverless Apps for Elastic Container Service in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_eks_avg_sum

\n
\n

int64

\n

Sum of the average number of Serverless Apps for Elastic Kubernetes Service in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_excl_fargate_avg_sum

\n
\n

int64

\n

Sum of the average number of Serverless Apps excluding Fargate in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_excl_fargate_azure_container_app_instances_avg_sum

\n
\n

int64

\n

Sum of the average number of Serverless Apps excluding Fargate for Azure Container App instances in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_excl_fargate_azure_function_app_instances_avg_sum

\n
\n

int64

\n

Sum of the average number of Serverless Apps excluding Fargate for Azure Function App instances in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_excl_fargate_azure_web_app_instances_avg_sum

\n
\n

int64

\n

Sum of the average number of Serverless Apps excluding Fargate for Azure Web App instances in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_excl_fargate_google_cloud_functions_instances_avg_sum

\n
\n

int64

\n

Sum of the average number of Serverless Apps excluding Fargate for Google Cloud Platform Cloud Functions instances in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_excl_fargate_google_cloud_run_instances_avg_sum

\n
\n

int64

\n

Sum of the average number of Serverless Apps excluding Fargate for Google Cloud Platform Cloud Run instances in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_google_cloud_functions_instances_avg_sum

\n
\n

int64

\n

Sum of the average number of Serverless Apps for Google Cloud Platform Cloud Functions instances in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_google_cloud_run_instances_avg_sum

\n
\n

int64

\n

Sum of the average number of Serverless Apps for Google Cloud Platform Cloud Run instances in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_google_count_avg_sum

\n
\n

int64

\n

Sum of the average number of Serverless Apps for Google Cloud in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_total_count_avg_sum

\n
\n

int64

\n

Sum of the average number of Serverless Apps for Azure and Google Cloud in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

siem_analyzed_logs_add_on_count_agg_sum

\n
\n

int64

\n

Shows the sum of all log events analyzed by Cloud SIEM over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

start_date

\n
\n

date-time

\n

Shows the first date of usage in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

synthetics_browser_check_calls_count_agg_sum

\n
\n

int64

\n

Shows the sum of all Synthetic browser tests over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

synthetics_check_calls_count_agg_sum

\n
\n

int64

\n

Shows the sum of all Synthetic API tests over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

synthetics_mobile_test_runs_agg_sum

\n
\n

int64

\n

Shows the sum of Synthetic mobile application tests over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

synthetics_parallel_testing_max_slots_hwm_sum

\n
\n

int64

\n

Shows the sum of the high-water marks of used synthetics parallel testing slots over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

trace_search_indexed_events_count_agg_sum

\n
\n

int64

\n

Shows the sum of all Indexed Spans indexed over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

twol_ingested_events_bytes_agg_sum

\n
\n

int64

\n

Shows the sum of all ingested APM span bytes over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

universal_service_monitoring_host_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of all Universal Service Monitoring hosts over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

usage

\n
\n

[object]

\n

An array of objects regarding hourly usage.

\n
\n
\n
\n
\n
\n

agent_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all agent hosts over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

apm_azure_app_service_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Azure app services using APM over all hours in the current date all organizations.

\n
\n \n
\n
\n
\n
\n
\n

apm_devsecops_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all APM DevSecOps hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

apm_enterprise_standalone_hosts_top99p

\n
\n

int64

\n

Shows the 99th percentile of all distinct standalone Enterprise hosts over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

apm_fargate_count_avg

\n
\n

int64

\n

Shows the average of all APM ECS Fargate tasks over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

apm_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all distinct APM hosts over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

apm_pro_standalone_hosts_top99p

\n
\n

int64

\n

Shows the 99th percentile of all distinct standalone Pro hosts over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

appsec_fargate_count_avg

\n
\n

int64

\n

Shows the average of all Application Security Monitoring ECS Fargate tasks over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

asm_serverless_sum

\n
\n

int64

\n

Shows the sum of all Application Security Monitoring Serverless invocations over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

audit_logs_lines_indexed_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of audit logs lines indexed over all hours in the current date for all organizations (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

audit_trail_enabled_hwm

\n
\n

int64

\n

Shows the number of organizations that had Audit Trail enabled in the current date.

\n
\n \n
\n
\n
\n
\n
\n

avg_profiled_fargate_tasks

\n
\n

int64

\n

The average total count for Fargate Container Profiler over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

aws_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all AWS hosts over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

aws_lambda_func_count

\n
\n

int64

\n

Shows the average of the number of functions that executed 1 or more times each hour in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

aws_lambda_invocations_sum

\n
\n

int64

\n

Shows the sum of all AWS Lambda invocations over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

azure_app_service_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Azure app services over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

billable_ingested_bytes_sum

\n
\n

int64

\n

Shows the sum of all log bytes ingested over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

bits_ai_investigations_sum

\n
\n

int64

\n

Shows the sum of all Bits AI Investigations over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

browser_rum_lite_session_count_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all browser lite sessions over all hours in the current date for all organizations (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

browser_rum_replay_session_count_sum

\n
\n

int64

\n

Shows the sum of all browser replay sessions over all hours in the current date for all organizations (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

browser_rum_units_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all browser RUM units over all hours in the current date for all organizations (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

ci_pipeline_indexed_spans_sum

\n
\n

int64

\n

Shows the sum of all CI pipeline indexed spans over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

ci_test_indexed_spans_sum

\n
\n

int64

\n

Shows the sum of all CI test indexed spans over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

ci_visibility_itr_committers_hwm

\n
\n

int64

\n

Shows the high-water mark of all CI visibility intelligent test runner committers over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

ci_visibility_pipeline_committers_hwm

\n
\n

int64

\n

Shows the high-water mark of all CI visibility pipeline committers over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

ci_visibility_test_committers_hwm

\n
\n

int64

\n

Shows the high-water mark of all CI visibility test committers over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

cloud_cost_management_aws_host_count_avg

\n
\n

int64

\n

Host count average of Cloud Cost Management for AWS for the given date and given organization.

\n
\n \n
\n
\n
\n
\n
\n

cloud_cost_management_azure_host_count_avg

\n
\n

int64

\n

Host count average of Cloud Cost Management for Azure for the given date and given organization.

\n
\n \n
\n
\n
\n
\n
\n

cloud_cost_management_gcp_host_count_avg

\n
\n

int64

\n

Host count average of Cloud Cost Management for GCP for the given date and given organization.

\n
\n \n
\n
\n
\n
\n
\n

cloud_cost_management_host_count_avg

\n
\n

int64

\n

Host count average of Cloud Cost Management for all cloud providers for the given date and given organization.

\n
\n \n
\n
\n
\n
\n
\n

cloud_siem_events_sum

\n
\n

int64

\n

Shows the sum of all Cloud Security Information and Event Management events over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

code_analysis_sa_committers_hwm

\n
\n

int64

\n

Shows the high-water mark of all Static Analysis committers over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

code_analysis_sca_committers_hwm

\n
\n

int64

\n

Shows the high-water mark of all static Software Composition Analysis committers over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

code_security_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Code Security hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

container_avg

\n
\n

int64

\n

Shows the average of all distinct containers over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

container_excl_agent_avg

\n
\n

int64

\n

Shows the average of containers without the Datadog Agent over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

container_hwm

\n
\n

int64

\n

Shows the high-water mark of all distinct containers over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

csm_container_enterprise_compliance_count_sum

\n
\n

int64

\n

Shows the sum of all Cloud Security Management Enterprise compliance containers over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

csm_container_enterprise_cws_count_sum

\n
\n

int64

\n

Shows the sum of all Cloud Security Management Enterprise Cloud Workload Security containers over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

csm_container_enterprise_total_count_sum

\n
\n

int64

\n

Shows the sum of all Cloud Security Management Enterprise containers over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

csm_host_enterprise_aas_host_count_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Security Management Enterprise Azure app services hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

csm_host_enterprise_aws_host_count_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Security Management Enterprise AWS hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

csm_host_enterprise_azure_host_count_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Security Management Enterprise Azure hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

csm_host_enterprise_compliance_host_count_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Security Management Enterprise compliance hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

csm_host_enterprise_cws_host_count_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Security Management Enterprise Cloud Workload Security hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

csm_host_enterprise_gcp_host_count_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Security Management Enterprise GCP hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

csm_host_enterprise_total_host_count_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Security Management Enterprise hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

cspm_aas_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Security Management Pro Azure app services hosts over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

cspm_aws_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Security Management Pro AWS hosts over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

cspm_azure_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Security Management Pro Azure hosts over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

cspm_container_avg

\n
\n

int64

\n

Shows the average number of Cloud Security Management Pro containers over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

cspm_container_hwm

\n
\n

int64

\n

Shows the high-water mark of Cloud Security Management Pro containers over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

cspm_gcp_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Security Management Pro GCP hosts over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

cspm_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Security Management Pro hosts over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

custom_ts_avg

\n
\n

int64

\n

Shows the average number of distinct custom metrics over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

cws_container_count_avg

\n
\n

int64

\n

Shows the average of all distinct Cloud Workload Security containers over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

cws_fargate_task_avg

\n
\n

int64

\n

Shows the average of all distinct Cloud Workload Security Fargate tasks over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

cws_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Workload Security hosts over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

data_jobs_monitoring_host_hr_sum

\n
\n

int64

\n

Shows the sum of all Data Jobs Monitoring hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

date

\n
\n

date-time

\n

The date for the usage.

\n
\n \n
\n
\n
\n
\n
\n

dbm_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Database Monitoring hosts over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

dbm_queries_count_avg

\n
\n

int64

\n

Shows the average of all normalized Database Monitoring queries over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_agent_sum

\n
\n

int64

\n

Shows the sum of all ephemeral infrastructure hosts with the Datadog Agent over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_alibaba_sum

\n
\n

int64

\n

Shows the sum of all ephemeral infrastructure hosts on Alibaba over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_aws_sum

\n
\n

int64

\n

Shows the sum of all ephemeral infrastructure hosts on AWS over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_azure_sum

\n
\n

int64

\n

Shows the sum of all ephemeral infrastructure hosts on Azure over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_ent_sum

\n
\n

int64

\n

Shows the sum of all ephemeral infrastructure hosts for Enterprise over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_gcp_sum

\n
\n

int64

\n

Shows the sum of all ephemeral infrastructure hosts on GCP over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_heroku_sum

\n
\n

int64

\n

Shows the sum of all ephemeral infrastructure hosts on Heroku over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_only_aas_sum

\n
\n

int64

\n

Shows the sum of all ephemeral infrastructure hosts with only Azure App Services over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_only_vsphere_sum

\n
\n

int64

\n

Shows the sum of all ephemeral infrastructure hosts with only vSphere over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_opentelemetry_apm_sum

\n
\n

int64

\n

Shows the sum of all ephemeral APM hosts reported by the Datadog exporter for the OpenTelemetry Collector over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_opentelemetry_sum

\n
\n

int64

\n

Shows the sum of all ephemeral hosts reported by the Datadog exporter for the OpenTelemetry Collector over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_pro_sum

\n
\n

int64

\n

Shows the sum of all ephemeral infrastructure hosts for Pro over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_proplus_sum

\n
\n

int64

\n

Shows the sum of all ephemeral infrastructure hosts for Pro Plus over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

error_tracking_apm_error_events_sum

\n
\n

int64

\n

Shows the sum of all Error Tracking APM error events over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

error_tracking_error_events_sum

\n
\n

int64

\n

Shows the sum of all Error Tracking error events over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

error_tracking_events_sum

\n
\n

int64

\n

Shows the sum of all Error Tracking events over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

error_tracking_rum_error_events_sum

\n
\n

int64

\n

Shows the sum of all Error Tracking RUM error events over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

event_management_correlation_correlated_events_sum

\n
\n

int64

\n

Shows the sum of all Event Management correlated events over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

event_management_correlation_correlated_related_events_sum

\n
\n

int64

\n

Shows the sum of all Event Management correlated related events over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

event_management_correlation_sum

\n
\n

int64

\n

Shows the sum of all Event Management correlations over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

fargate_container_profiler_profiling_fargate_avg

\n
\n

int64

\n

The average number of Profiling Fargate tasks over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

fargate_container_profiler_profiling_fargate_eks_avg

\n
\n

int64

\n

The average number of Profiling Fargate Elastic Kubernetes Service tasks over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

fargate_tasks_count_avg

\n
\n

int64

\n

Shows the high-watermark of all Fargate tasks over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

fargate_tasks_count_hwm

\n
\n

int64

\n

Shows the average of all Fargate tasks over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

flex_logs_compute_large_avg

\n
\n

int64

\n

Shows the average number of Flex Logs Compute Large Instances over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

flex_logs_compute_medium_avg

\n
\n

int64

\n

Shows the average number of Flex Logs Compute Medium Instances over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

flex_logs_compute_small_avg

\n
\n

int64

\n

Shows the average number of Flex Logs Compute Small Instances over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

flex_logs_compute_xlarge_avg

\n
\n

int64

\n

Shows the average number of Flex Logs Compute Extra Large Instances over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

flex_logs_compute_xsmall_avg

\n
\n

int64

\n

Shows the average number of Flex Logs Compute Extra Small Instances over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

flex_logs_starter_avg

\n
\n

int64

\n

Shows the average number of Flex Logs Starter Instances over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

flex_logs_starter_storage_index_avg

\n
\n

int64

\n

Shows the average number of Flex Logs Starter Storage Index Instances over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

flex_logs_starter_storage_retention_adjustment_avg

\n
\n

int64

\n

Shows the average number of Flex Logs Starter Storage Retention Adjustment Instances over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

flex_stored_logs_avg

\n
\n

int64

\n

Shows the average of all Flex Stored Logs over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

forwarding_events_bytes_sum

\n
\n

int64

\n

Shows the sum of all log bytes forwarded over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

gcp_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all GCP hosts over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

heroku_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Heroku dynos over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

incident_management_monthly_active_users_hwm

\n
\n

int64

\n

Shows the high-water mark of incident management monthly active users over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

indexed_events_count_sum

\n
\n

int64

\n

Shows the sum of all log events indexed over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

infra_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all distinct infrastructure hosts over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

ingested_events_bytes_sum

\n
\n

int64

\n

Shows the sum of all log bytes ingested over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

iot_device_sum

\n
\n

int64

\n

Shows the sum of all IoT devices over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

iot_device_top99p

\n
\n

int64

\n

Shows the 99th percentile of all IoT devices over all hours in the current date all organizations.

\n
\n \n
\n
\n
\n
\n
\n

llm_observability_min_spend_sum

\n
\n

int64

\n

Sum of all LLM observability minimum spend over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

llm_observability_sum

\n
\n

int64

\n

Sum of all LLM observability sessions over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

mobile_rum_lite_session_count_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all mobile lite sessions over all hours in the current date for all organizations (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

mobile_rum_session_count_android_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all mobile RUM sessions on Android over all hours in the current date for all organizations (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

mobile_rum_session_count_flutter_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all mobile RUM sessions on Flutter over all hours in the current date for all organizations (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

mobile_rum_session_count_ios_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all mobile RUM sessions on iOS over all hours in the current date for all organizations (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

mobile_rum_session_count_reactnative_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all mobile RUM sessions on React Native over all hours in the current date for all organizations (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

mobile_rum_session_count_roku_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all mobile RUM sessions on Roku over all hours in the current date for all organizations (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

mobile_rum_session_count_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all mobile RUM sessions over all hours in the current date for all organizations (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

mobile_rum_units_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all mobile RUM units over all hours in the current date for all organizations (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

ndm_netflow_events_sum

\n
\n

int64

\n

Shows the sum of all Network Device Monitoring NetFlow events over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

netflow_indexed_events_count_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all Network flows indexed over all hours in the current date for all organizations (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

network_device_wireless_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Network Device Monitoring wireless devices over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

npm_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all distinct Cloud Network Monitoring hosts (formerly known as Network hosts) over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

observability_pipelines_bytes_processed_sum

\n
\n

int64

\n

Sum of all observability pipelines bytes processed over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

oci_host_sum

\n
\n

int64

\n

Shows the sum of all Oracle Cloud Infrastructure hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

oci_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Oracle Cloud Infrastructure hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

on_call_seat_hwm

\n
\n

int64

\n

Shows the high-water mark of On-Call seats over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

online_archive_events_count_sum

\n
\n

int64

\n

Sum of all online archived events over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

opentelemetry_apm_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of APM hosts reported by the Datadog exporter for the OpenTelemetry Collector over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

opentelemetry_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all hosts reported by the Datadog exporter for the OpenTelemetry Collector over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

orgs

\n
\n

[object]

\n

Organizations associated with a user.

\n
\n
\n
\n
\n
\n

account_name

\n
\n

string

\n

The account name.

\n
\n \n
\n
\n
\n
\n
\n

account_public_id

\n
\n

string

\n

The account public id.

\n
\n \n
\n
\n
\n
\n
\n

agent_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all agent hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

apm_azure_app_service_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Azure app services using APM over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

apm_devsecops_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all APM DevSecOps hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

apm_enterprise_standalone_hosts_top99p

\n
\n

int64

\n

Shows the 99th percentile of all distinct standalone Enterprise hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

apm_fargate_count_avg

\n
\n

int64

\n

Shows the average of all APM ECS Fargate tasks over all hours in the current month for the given org.

\n
\n \n
\n
\n
\n
\n
\n

apm_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all distinct APM hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

apm_pro_standalone_hosts_top99p

\n
\n

int64

\n

Shows the 99th percentile of all distinct standalone Pro hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

appsec_fargate_count_avg

\n
\n

int64

\n

Shows the average of all Application Security Monitoring ECS Fargate tasks over all hours in the current month for the given org.

\n
\n \n
\n
\n
\n
\n
\n

asm_serverless_sum

\n
\n

int64

\n

Shows the sum of all Application Security Monitoring Serverless invocations over all hours in the current month for the given org.

\n
\n \n
\n
\n
\n
\n
\n

audit_logs_lines_indexed_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all audit logs lines indexed over all hours in the current date for the given org (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

audit_trail_enabled_hwm

\n
\n

int64

\n

Shows whether Audit Trail is enabled for the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

avg_profiled_fargate_tasks

\n
\n

int64

\n

The average total count for Fargate Container Profiler over all hours in the current month for the given org.

\n
\n \n
\n
\n
\n
\n
\n

aws_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all AWS hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

aws_lambda_func_count

\n
\n

int64

\n

Shows the sum of all AWS Lambda invocations over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

aws_lambda_invocations_sum

\n
\n

int64

\n

Shows the sum of all AWS Lambda invocations over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

azure_app_service_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Azure app services over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

billable_ingested_bytes_sum

\n
\n

int64

\n

Shows the sum of all log bytes ingested over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

bits_ai_investigations_sum

\n
\n

int64

\n

Shows the sum of all Bits AI Investigations over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

browser_rum_lite_session_count_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all browser lite sessions over all hours in the current date for the given org (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

browser_rum_replay_session_count_sum

\n
\n

int64

\n

Shows the sum of all browser replay sessions over all hours in the current date for the given org (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

browser_rum_units_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all browser RUM units over all hours in the current date for the given org (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

ci_pipeline_indexed_spans_sum

\n
\n

int64

\n

Shows the sum of all CI pipeline indexed spans over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

ci_test_indexed_spans_sum

\n
\n

int64

\n

Shows the sum of all CI test indexed spans over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

ci_visibility_itr_committers_hwm

\n
\n

int64

\n

Shows the high-water mark of all CI visibility intelligent test runner committers over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

ci_visibility_pipeline_committers_hwm

\n
\n

int64

\n

Shows the high-water mark of all CI visibility pipeline committers over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

ci_visibility_test_committers_hwm

\n
\n

int64

\n

Shows the high-water mark of all CI visibility test committers over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

cloud_cost_management_aws_host_count_avg

\n
\n

int64

\n

Host count average of Cloud Cost Management for AWS for the given date and given org.

\n
\n \n
\n
\n
\n
\n
\n

cloud_cost_management_azure_host_count_avg

\n
\n

int64

\n

Host count average of Cloud Cost Management for Azure for the given date and given org.

\n
\n \n
\n
\n
\n
\n
\n

cloud_cost_management_gcp_host_count_avg

\n
\n

int64

\n

Host count average of Cloud Cost Management for GCP for the given date and given org.

\n
\n \n
\n
\n
\n
\n
\n

cloud_cost_management_host_count_avg

\n
\n

int64

\n

Host count average of Cloud Cost Management for all cloud providers for the given date and given org.

\n
\n \n
\n
\n
\n
\n
\n

cloud_siem_events_sum

\n
\n

int64

\n

Shows the sum of all Cloud Security Information and Event Management events over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

code_analysis_sa_committers_hwm

\n
\n

int64

\n

Shows the high-water mark of all Static Analysis committers over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

code_analysis_sca_committers_hwm

\n
\n

int64

\n

Shows the high-water mark of all static Software Composition Analysis committers over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

code_security_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Code Security hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

container_avg

\n
\n

int64

\n

Shows the average of all distinct containers over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

container_excl_agent_avg

\n
\n

int64

\n

Shows the average of containers without the Datadog Agent over all hours in the current date for the given organization.

\n
\n \n
\n
\n
\n
\n
\n

container_hwm

\n
\n

int64

\n

Shows the high-water mark of all distinct containers over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

csm_container_enterprise_compliance_count_sum

\n
\n

int64

\n

Shows the sum of all Cloud Security Management Enterprise compliance containers over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

csm_container_enterprise_cws_count_sum

\n
\n

int64

\n

Shows the sum of all Cloud Security Management Enterprise Cloud Workload Security containers over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

csm_container_enterprise_total_count_sum

\n
\n

int64

\n

Shows the sum of all Cloud Security Management Enterprise containers over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

csm_host_enterprise_aas_host_count_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Security Management Enterprise Azure app services hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

csm_host_enterprise_aws_host_count_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Security Management Enterprise AWS hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

csm_host_enterprise_azure_host_count_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Security Management Enterprise Azure hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

csm_host_enterprise_compliance_host_count_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Security Management Enterprise compliance hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

csm_host_enterprise_cws_host_count_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Security Management Enterprise Cloud Workload Security hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

csm_host_enterprise_gcp_host_count_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Security Management Enterprise GCP hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

csm_host_enterprise_total_host_count_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Security Management Enterprise hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

cspm_aas_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Security Management Pro Azure app services hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

cspm_aws_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Security Management Pro AWS hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

cspm_azure_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Security Management Pro Azure hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

cspm_container_avg

\n
\n

int64

\n

Shows the average number of Cloud Security Management Pro containers over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

cspm_container_hwm

\n
\n

int64

\n

Shows the high-water mark of Cloud Security Management Pro containers over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

cspm_gcp_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Security Management Pro GCP hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

cspm_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Security Management Pro hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

custom_historical_ts_avg

\n
\n

int64

\n

Shows the average number of distinct historical custom metrics over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

custom_live_ts_avg

\n
\n

int64

\n

Shows the average number of distinct live custom metrics over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

custom_ts_avg

\n
\n

int64

\n

Shows the average number of distinct custom metrics over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

cws_container_count_avg

\n
\n

int64

\n

Shows the average of all distinct Cloud Workload Security containers over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

cws_fargate_task_avg

\n
\n

int64

\n

Shows the average of all distinct Cloud Workload Security Fargate tasks over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

cws_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Cloud Workload Security hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

data_jobs_monitoring_host_hr_sum

\n
\n

int64

\n

Shows the sum of all Data Jobs Monitoring hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

dbm_host_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of all Database Monitoring hosts over all hours in the current month for the given org.

\n
\n \n
\n
\n
\n
\n
\n

dbm_queries_avg_sum

\n
\n

int64

\n

Shows the average of all distinct Database Monitoring normalized queries over all hours in the current month for the given org.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_agent_sum

\n
\n

int64

\n

Shows the sum of all ephemeral infrastructure hosts with the Datadog Agent over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_alibaba_sum

\n
\n

int64

\n

Shows the sum of all ephemeral infrastructure hosts on Alibaba over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_aws_sum

\n
\n

int64

\n

Shows the sum of all ephemeral infrastructure hosts on AWS over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_azure_sum

\n
\n

int64

\n

Shows the sum of all ephemeral infrastructure hosts on Azure over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_ent_sum

\n
\n

int64

\n

Shows the sum of all ephemeral infrastructure hosts for Enterprise over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_gcp_sum

\n
\n

int64

\n

Shows the sum of all ephemeral infrastructure hosts on GCP over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_heroku_sum

\n
\n

int64

\n

Shows the sum of all ephemeral infrastructure hosts on Heroku over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_only_aas_sum

\n
\n

int64

\n

Shows the sum of all ephemeral infrastructure hosts with only Azure App Services over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_only_vsphere_sum

\n
\n

int64

\n

Shows the sum of all ephemeral infrastructure hosts with only vSphere over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_opentelemetry_apm_sum

\n
\n

int64

\n

Shows the sum of all ephemeral APM hosts reported by the Datadog exporter for the OpenTelemetry Collector over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_opentelemetry_sum

\n
\n

int64

\n

Shows the sum of all ephemeral hosts reported by the Datadog exporter for the OpenTelemetry Collector over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_pro_sum

\n
\n

int64

\n

Shows the sum of all ephemeral infrastructure hosts for Pro over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

eph_infra_host_proplus_sum

\n
\n

int64

\n

Shows the sum of all ephemeral infrastructure hosts for Pro Plus over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

error_tracking_apm_error_events_sum

\n
\n

int64

\n

Shows the sum of all Error Tracking APM error events over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

error_tracking_error_events_sum

\n
\n

int64

\n

Shows the sum of all Error Tracking error events over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

error_tracking_events_sum

\n
\n

int64

\n

Shows the sum of all Error Tracking events over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

error_tracking_rum_error_events_sum

\n
\n

int64

\n

Shows the sum of all Error Tracking RUM error events over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

event_management_correlation_correlated_events_sum

\n
\n

int64

\n

Shows the sum of all Event Management correlated events over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

event_management_correlation_correlated_related_events_sum

\n
\n

int64

\n

Shows the sum of all Event Management correlated related events over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

event_management_correlation_sum

\n
\n

int64

\n

Shows the sum of all Event Management correlations over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

fargate_container_profiler_profiling_fargate_avg

\n
\n

int64

\n

The average number of Profiling Fargate tasks over all hours in the current month for the given org.

\n
\n \n
\n
\n
\n
\n
\n

fargate_container_profiler_profiling_fargate_eks_avg

\n
\n

int64

\n

The average number of Profiling Fargate Elastic Kubernetes Service tasks over all hours in the current month for the given org.

\n
\n \n
\n
\n
\n
\n
\n

fargate_tasks_count_avg

\n
\n

int64

\n

The average task count for Fargate.

\n
\n \n
\n
\n
\n
\n
\n

fargate_tasks_count_hwm

\n
\n

int64

\n

Shows the high-water mark of all Fargate tasks over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

flex_logs_compute_large_avg

\n
\n

int64

\n

Shows the average number of Flex Logs Compute Large Instances over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

flex_logs_compute_medium_avg

\n
\n

int64

\n

Shows the average number of Flex Logs Compute Medium Instances over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

flex_logs_compute_small_avg

\n
\n

int64

\n

Shows the average number of Flex Logs Compute Small Instances over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

flex_logs_compute_xlarge_avg

\n
\n

int64

\n

Shows the average number of Flex Logs Compute Extra Large Instances over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

flex_logs_compute_xsmall_avg

\n
\n

int64

\n

Shows the average number of Flex Logs Compute Extra Small Instances over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

flex_logs_starter_avg

\n
\n

int64

\n

Shows the average number of Flex Logs Starter Instances over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

flex_logs_starter_storage_index_avg

\n
\n

int64

\n

Shows the average number of Flex Logs Starter Storage Index Instances over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

flex_logs_starter_storage_retention_adjustment_avg

\n
\n

int64

\n

Shows the average number of Flex Logs Starter Storage Retention Adjustment Instances over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

flex_stored_logs_avg

\n
\n

int64

\n

Shows the average of all Flex Stored Logs over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

forwarding_events_bytes_sum

\n
\n

int64

\n

Shows the sum of all log bytes forwarded over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

gcp_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all GCP hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

heroku_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Heroku dynos over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The organization id.

\n
\n \n
\n
\n
\n
\n
\n

incident_management_monthly_active_users_hwm

\n
\n

int64

\n

Shows the high-water mark of incident management monthly active users over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

indexed_events_count_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all log events indexed over all hours in the current date for the given org (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

infra_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all distinct infrastructure hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

ingested_events_bytes_sum

\n
\n

int64

\n

Shows the sum of all log bytes ingested over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

iot_device_agg_sum

\n
\n

int64

\n

Shows the sum of all IoT devices over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

iot_device_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of all IoT devices over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

llm_observability_min_spend_sum

\n
\n

int64

\n

Shows the sum of all LLM Observability minimum spend over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

llm_observability_sum

\n
\n

int64

\n

Shows the sum of all LLM observability sessions over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

mobile_rum_lite_session_count_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all mobile lite sessions over all hours in the current date for the given org (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

mobile_rum_session_count_android_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all mobile RUM sessions on Android over all hours in the current date for the given org (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

mobile_rum_session_count_flutter_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all mobile RUM sessions on Flutter over all hours in the current date for the given org (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

mobile_rum_session_count_ios_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all mobile RUM sessions on iOS over all hours in the current date for the given org (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

mobile_rum_session_count_reactnative_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all mobile RUM sessions on React Native over all hours in the current date for the given org (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

mobile_rum_session_count_roku_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all mobile RUM sessions on Roku over all hours in the current date for the given org (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

mobile_rum_session_count_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all mobile RUM sessions over all hours in the current date for the given org (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

mobile_rum_units_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all mobile RUM units over all hours in the current date for the given org (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The organization name.

\n
\n \n
\n
\n
\n
\n
\n

ndm_netflow_events_sum

\n
\n

int64

\n

Shows the sum of all Network Device Monitoring NetFlow events over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

netflow_indexed_events_count_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all Network flows indexed over all hours in the current date for the given org (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

network_device_wireless_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Network Device Monitoring wireless devices over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

npm_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all distinct Cloud Network Monitoring hosts (formerly known as Network hosts) over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

observability_pipelines_bytes_processed_sum

\n
\n

int64

\n

Sum of all observability pipelines bytes processed over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

oci_host_sum

\n
\n

int64

\n

Shows the sum of all Oracle Cloud Infrastructure hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

oci_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Oracle Cloud Infrastructure hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

on_call_seat_hwm

\n
\n

int64

\n

Shows the high-water mark of On-Call seats over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

online_archive_events_count_sum

\n
\n

int64

\n

Sum of all online archived events over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

opentelemetry_apm_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of APM hosts reported by the Datadog exporter for the OpenTelemetry Collector over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

opentelemetry_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all hosts reported by the Datadog exporter for the OpenTelemetry Collector over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

product_analytics_sum

\n
\n

int64

\n

Shows the sum of all product analytics sessions over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

profiling_aas_count_top99p

\n
\n

int64

\n

Shows the 99th percentile of all profiled Azure app services over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

profiling_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all profiled hosts over all hours within the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

public_id

\n
\n

string

\n

The organization public id.

\n
\n \n
\n
\n
\n
\n
\n

published_app_hwm

\n
\n

int64

\n

Shows the high-water mark of all published applications over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

The region of the organization.

\n
\n \n
\n
\n
\n
\n
\n

rum_browser_and_mobile_session_count

\n
\n

int64

\n

Shows the sum of all mobile sessions and all browser lite and legacy sessions over all hours in the current date for the given org (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_browser_legacy_session_count_sum

\n
\n

int64

\n

Shows the sum of all browser RUM legacy sessions over all hours in the current date for the given org (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_browser_lite_session_count_sum

\n
\n

int64

\n

Shows the sum of all browser RUM lite sessions over all hours in the current date for the given org (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_browser_replay_session_count_sum

\n
\n

int64

\n

Shows the sum of all browser RUM Session Replay counts over all hours in the current date for the given org (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_indexed_sessions_sum

\n
\n

int64

\n

Shows the sum of all RUM indexed sessions over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

rum_ingested_sessions_sum

\n
\n

int64

\n

Shows the sum of all RUM ingested sessions over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

rum_lite_session_count_sum

\n
\n

int64

\n

Shows the sum of all RUM lite sessions (browser and mobile) over all hours in the current date for the given org (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_legacy_session_count_android_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM legacy sessions on Android over all hours in the current date for the given org (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_legacy_session_count_flutter_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM legacy sessions on Flutter over all hours in the current date for the given org (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_legacy_session_count_ios_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM legacy sessions on iOS over all hours in the current date for the given org (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_legacy_session_count_reactnative_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM legacy sessions on React Native over all hours in the current date for the given org (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_legacy_session_count_roku_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM legacy sessions on Roku over all hours in the current date for the given org (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_lite_session_count_android_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM lite sessions on Android over all hours in the current date for the given org (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_lite_session_count_flutter_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM lite sessions on Flutter over all hours in the current date for the given org (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_lite_session_count_ios_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM lite sessions on iOS over all hours in the current date for the given org (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_lite_session_count_kotlinmultiplatform_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM lite sessions on Kotlin Multiplatform over all hours within the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_lite_session_count_reactnative_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM lite sessions on React Native over all hours in the current date for the given org (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_lite_session_count_roku_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM lite sessions on Roku over all hours in the current date for the given org (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_lite_session_count_unity_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM lite sessions on Unity over all hours within the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_replay_session_count_android_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM replay sessions on Android over all hours within the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_replay_session_count_ios_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM replay sessions on iOS over all hours within the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_replay_session_count_kotlinmultiplatform_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM replay sessions on Kotlin Multiplatform over all hours within the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_replay_session_count_reactnative_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM replay sessions on React Native over all hours within the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

rum_replay_session_count_sum

\n
\n

int64

\n

Shows the sum of all RUM Session Replay counts over all hours in the current date for the given org (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_session_count_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all browser RUM lite sessions over all hours in the current date for the given org (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_session_replay_add_on_sum

\n
\n

int64

\n

Shows the sum of all RUM session replay add-on sessions over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

rum_total_session_count_sum

\n
\n

int64

\n

Shows the sum of RUM sessions (browser and mobile) over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

rum_units_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all browser and mobile RUM units over all hours in the current date for the given org (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

sca_fargate_count_avg

\n
\n

int64

\n

Shows the average of all Software Composition Analysis Fargate tasks over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

sca_fargate_count_hwm

\n
\n

int64

\n

Shows the sum of the high-water marks of all Software Composition Analysis Fargate tasks over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

sds_apm_scanned_bytes_sum

\n
\n

int64

\n

Sum of all APM bytes scanned with sensitive data scanner over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

sds_events_scanned_bytes_sum

\n
\n

int64

\n

Sum of all event stream events bytes scanned with sensitive data scanner over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

sds_logs_scanned_bytes_sum

\n
\n

int64

\n

Shows the sum of all bytes scanned of logs usage by the Sensitive Data Scanner over all hours in the current month for the given org.

\n
\n \n
\n
\n
\n
\n
\n

sds_rum_scanned_bytes_sum

\n
\n

int64

\n

Sum of all RUM bytes scanned with sensitive data scanner over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

sds_total_scanned_bytes_sum

\n
\n

int64

\n

Shows the sum of all bytes scanned across all usage types by the Sensitive Data Scanner over all hours in the current month for the given org.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_apm_azure_appservice_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps with Application Performance Monitoring for Azure App Service instances for the given date and given org.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_apm_azure_azurefunction_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps with Application Performance Monitoring for Azure Function instances for the given date and given org.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_apm_azure_containerapp_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps with Application Performance Monitoring for Azure Container App instances for the given date and given org.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_apm_fargate_ecs_tasks_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps with Application Performance Monitoring for Fargate Elastic Container Service tasks for the given date and given org.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_apm_gcp_cloudfunction_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps with Application Performance Monitoring for Google Cloud Platform Cloud Function instances for the given date and given org.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_apm_gcp_cloudrun_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps with Application Performance Monitoring for Google Cloud Platform Cloud Run instances for the given date and given org.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps with Application Performance Monitoring for the given date and given org.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_excl_fargate_apm_azure_appservice_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps with Application Performance Monitoring excluding Fargate for Azure App Service instances for the given date and given org.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_excl_fargate_apm_azure_azurefunction_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps with Application Performance Monitoring excluding Fargate for Azure Function instances for the given date and given org.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_excl_fargate_apm_azure_containerapp_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps with Application Performance Monitoring excluding Fargate for Azure Container App instances for the given date and given org.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_excl_fargate_apm_gcp_cloudfunction_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps with Application Performance Monitoring excluding Fargate for Google Cloud Platform Cloud Function instances for the given date and given org.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_excl_fargate_apm_gcp_cloudrun_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps with Application Performance Monitoring excluding Fargate for Google Cloud Platform Cloud Run instances for the given date and given org.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_excl_fargate_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps with Application Performance Monitoring excluding Fargate for the given date and given org.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_azure_container_app_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps for Azure Container App instances for the given date and given org.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_azure_count_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps for Azure for the given date and given org.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_azure_function_app_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps for Azure Function App instances for the given date and given org.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_azure_web_app_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps for Azure Web App instances for the given date and given org.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_ecs_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps for Elastic Container Service for the given date and given org.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_eks_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps for Elastic Kubernetes Service for the given date and given org.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_excl_fargate_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps excluding Fargate for the given date and given org.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_excl_fargate_azure_container_app_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps excluding Fargate for Azure Container App instances for the given date and given org.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_excl_fargate_azure_function_app_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps excluding Fargate for Azure Function App instances for the given date and given org.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_excl_fargate_azure_web_app_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps excluding Fargate for Azure Web App instances for the given date and given org.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_excl_fargate_google_cloud_functions_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps excluding Fargate for Google Cloud Platform Cloud Functions instances for the given date and given org.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_excl_fargate_google_cloud_run_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps excluding Fargate for Google Cloud Platform Cloud Run instances for the given date and given org.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_google_cloud_functions_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps for Google Cloud Platform Cloud Functions instances for the given date and given org.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_google_cloud_run_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps for Google Cloud Platform Cloud Run instances for the given date and given org.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_google_count_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps for Google Cloud for the given date and given org.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_total_count_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps for Azure and Google Cloud for the given date and given org.

\n
\n \n
\n
\n
\n
\n
\n

siem_analyzed_logs_add_on_count_sum

\n
\n

int64

\n

Shows the sum of all log events analyzed by Cloud SIEM over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

synthetics_browser_check_calls_count_sum

\n
\n

int64

\n

Shows the sum of all Synthetic browser tests over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

synthetics_check_calls_count_sum

\n
\n

int64

\n

Shows the sum of all Synthetic API tests over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

synthetics_mobile_test_runs_sum

\n
\n

int64

\n

Shows the sum of all Synthetic mobile application tests over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

synthetics_parallel_testing_max_slots_hwm

\n
\n

int64

\n

Shows the high-water mark of used synthetics parallel testing slots over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

trace_search_indexed_events_count_sum

\n
\n

int64

\n

Shows the sum of all Indexed Spans indexed over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

twol_ingested_events_bytes_sum

\n
\n

int64

\n

Shows the sum of all ingested APM span bytes over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

universal_service_monitoring_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Universal Service Monitoring hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

vsphere_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all vSphere hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

vuln_management_host_count_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Application Vulnerability Management hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

workflow_executions_usage_sum

\n
\n

int64

\n

Sum of all workflows executed over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

product_analytics_sum

\n
\n

int64

\n

Sum of all product analytics sessions over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

profiling_aas_count_top99p

\n
\n

int64

\n

Shows the 99th percentile of all profiled Azure app services over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

profiling_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all profiled hosts over all hours within the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

published_app_hwm

\n
\n

int64

\n

Shows the high-water mark of all published applications over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

rum_browser_and_mobile_session_count

\n
\n

int64

\n

Shows the sum of all mobile sessions and all browser lite and legacy sessions over all hours in the current month for all organizations (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_browser_legacy_session_count_sum

\n
\n

int64

\n

Shows the sum of all browser RUM legacy sessions over all hours in the current date for all organizations (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_browser_lite_session_count_sum

\n
\n

int64

\n

Shows the sum of all browser RUM lite sessions over all hours in the current date for all organizations (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_browser_replay_session_count_sum

\n
\n

int64

\n

Shows the sum of all browser RUM Session Replay counts over all hours in the current date for all organizations (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_indexed_sessions_sum

\n
\n

int64

\n

Sum of all RUM indexed sessions over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

rum_ingested_sessions_sum

\n
\n

int64

\n

Sum of all RUM ingested sessions over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

rum_lite_session_count_sum

\n
\n

int64

\n

Shows the sum of all RUM lite sessions (browser and mobile) over all hours in the current date for all organizations (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_legacy_session_count_android_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM legacy sessions on Android over all hours in the current date for all organizations (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_legacy_session_count_flutter_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM legacy Sessions on Flutter over all hours in the current date for all organizations (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_legacy_session_count_ios_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM legacy sessions on iOS over all hours in the current date for all organizations (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_legacy_session_count_reactnative_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM legacy sessions on React Native over all hours in the current date for all organizations (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_legacy_session_count_roku_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM legacy sessions on Roku over all hours in the current date for all organizations (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_lite_session_count_android_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM lite sessions on Android over all hours in the current date for all organizations (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_lite_session_count_flutter_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM lite sessions on Flutter over all hours in the current date for all organizations (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_lite_session_count_ios_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM lite sessions on iOS over all hours in the current date for all organizations (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_lite_session_count_kotlinmultiplatform_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM lite sessions on Kotlin Multiplatform over all hours within the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_lite_session_count_reactnative_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM lite sessions on React Native over all hours in the current date for all organizations (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_lite_session_count_roku_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM lite sessions on Roku over all hours within the current date for all organizations (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_lite_session_count_unity_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM lite sessions on Unity over all hours within the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_replay_session_count_android_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM replay sessions on Android over all hours within the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_replay_session_count_ios_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM replay sessions on iOS over all hours within the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_replay_session_count_kotlinmultiplatform_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM replay sessions on Kotlin Multiplatform over all hours within the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

rum_mobile_replay_session_count_reactnative_sum

\n
\n

int64

\n

Shows the sum of all mobile RUM replay sessions on React Native over all hours within the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

rum_replay_session_count_sum

\n
\n

int64

\n

Shows the sum of all RUM Session Replay counts over all hours in the current date for all organizations (To be introduced on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_session_count_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all browser RUM lite sessions over all hours in the current date for all organizations (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

rum_session_replay_add_on_sum

\n
\n

int64

\n

Sum of all RUM session replay add-on sessions over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

rum_total_session_count_sum

\n
\n

int64

\n

Shows the sum of RUM sessions (browser and mobile) over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

rum_units_sum

\n
\n

int64

\n

DEPRECATED: Shows the sum of all browser and mobile RUM units over all hours in the current date for all organizations (To be deprecated on October 1st, 2024).

\n
\n \n
\n
\n
\n
\n
\n

sca_fargate_count_avg

\n
\n

int64

\n

Shows the average of all Software Composition Analysis Fargate tasks over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

sca_fargate_count_hwm

\n
\n

int64

\n

Shows the sum of the high-water marks of all Software Composition Analysis Fargate tasks over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

sds_apm_scanned_bytes_sum

\n
\n

int64

\n

Sum of all APM bytes scanned with sensitive data scanner over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

sds_events_scanned_bytes_sum

\n
\n

int64

\n

Sum of all event stream events bytes scanned with sensitive data scanner over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

sds_logs_scanned_bytes_sum

\n
\n

int64

\n

Shows the sum of all bytes scanned of logs usage by the Sensitive Data Scanner over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

sds_rum_scanned_bytes_sum

\n
\n

int64

\n

Sum of all RUM bytes scanned with sensitive data scanner over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

sds_total_scanned_bytes_sum

\n
\n

int64

\n

Shows the sum of all bytes scanned across all usage types by the Sensitive Data Scanner over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_apm_azure_appservice_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps with Application Performance Monitoring for Azure App Service instances for the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_apm_azure_azurefunction_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps with Application Performance Monitoring for Azure Function instances for the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_apm_azure_containerapp_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps with Application Performance Monitoring for Azure Container App instances for the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_apm_fargate_ecs_tasks_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps with Application Performance Monitoring for Fargate Elastic Container Service tasks for the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_apm_gcp_cloudfunction_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps with Application Performance Monitoring for Google Cloud Platform Cloud Function instances for the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_apm_gcp_cloudrun_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps with Application Performance Monitoring for Google Cloud Platform Cloud Run instances for the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps with Application Performance Monitoring for the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_excl_fargate_apm_azure_appservice_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps with Application Performance Monitoring excluding Fargate for Azure App Service instances for the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_excl_fargate_apm_azure_azurefunction_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps with Application Performance Monitoring excluding Fargate for Azure Function instances for the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_excl_fargate_apm_azure_containerapp_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps with Application Performance Monitoring excluding Fargate for Azure Container App instances for the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_excl_fargate_apm_gcp_cloudfunction_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps with Application Performance Monitoring excluding Fargate for Google Cloud Platform Cloud Function instances for the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_excl_fargate_apm_gcp_cloudrun_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps with Application Performance Monitoring excluding Fargate for Google Cloud Platform Cloud Run instances for the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_apm_excl_fargate_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps with Application Performance Monitoring excluding Fargate for the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_azure_container_app_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps for Azure Container App instances for the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_azure_count_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps for Azure for the given date and given org.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_azure_function_app_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps for Azure Function App instances for the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_azure_web_app_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps for Azure Web App instances for the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_ecs_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps for Elastic Container Service for the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_eks_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps for Elastic Kubernetes Service for the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_excl_fargate_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps excluding Fargate for the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_excl_fargate_azure_container_app_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps excluding Fargate for Azure Container App instances for the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_excl_fargate_azure_function_app_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps excluding Fargate for Azure Function App instances for the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_excl_fargate_azure_web_app_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps excluding Fargate for Azure Web App instances for the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_excl_fargate_google_cloud_functions_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps excluding Fargate for Google Cloud Platform Cloud Functions instances for the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_excl_fargate_google_cloud_run_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps excluding Fargate for Google Cloud Platform Cloud Run instances for the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_google_cloud_functions_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps for Google Cloud Platform Cloud Functions instances for the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_google_cloud_run_instances_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps for Google Cloud Platform Cloud Run instances for the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_google_count_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps for Google Cloud for the given date and given org.

\n
\n \n
\n
\n
\n
\n
\n

serverless_apps_total_count_avg

\n
\n

int64

\n

Shows the average number of Serverless Apps for Azure and Google Cloud for the given date and given org.

\n
\n \n
\n
\n
\n
\n
\n

siem_analyzed_logs_add_on_count_sum

\n
\n

int64

\n

Shows the sum of all log events analyzed by Cloud SIEM over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

synthetics_browser_check_calls_count_sum

\n
\n

int64

\n

Shows the sum of all Synthetic browser tests over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

synthetics_check_calls_count_sum

\n
\n

int64

\n

Shows the sum of all Synthetic API tests over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

synthetics_mobile_test_runs_sum

\n
\n

int64

\n

Shows the sum of all Synthetic mobile application tests over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

synthetics_parallel_testing_max_slots_hwm

\n
\n

int64

\n

Shows the high-water mark of used synthetics parallel testing slots over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

trace_search_indexed_events_count_sum

\n
\n

int64

\n

Shows the sum of all Indexed Spans indexed over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

twol_ingested_events_bytes_sum

\n
\n

int64

\n

Shows the sum of all ingested APM span bytes over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

universal_service_monitoring_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all universal service management hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

vsphere_host_top99p

\n
\n

int64

\n

Shows the 99th percentile of all vSphere hosts over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

vuln_management_host_count_top99p

\n
\n

int64

\n

Shows the 99th percentile of all Application Vulnerability Management hosts over all hours in the current date for the given org.

\n
\n \n
\n
\n
\n
\n
\n

workflow_executions_usage_sum

\n
\n

int64

\n

Sum of all workflows executed over all hours in the current date for all organizations.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

vsphere_host_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of all vSphere hosts over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

vuln_management_host_count_top99p_sum

\n
\n

int64

\n

Shows the 99th percentile of all Application Vulnerability Management hosts over all hours in the current month for all organizations.

\n
\n \n
\n
\n
\n
\n
\n

workflow_executions_usage_agg_sum

\n
\n

int64

\n

Sum of all workflows executed over all hours in the current month for all organizations.

\n
\n \n
\n
" }, "400": { "json": { diff --git a/content/en/api/v2/downtimes/examples.json b/content/en/api/v2/downtimes/examples.json index c9793d6cc892d..b3972c66e9c87 100644 --- a/content/en/api/v2/downtimes/examples.json +++ b/content/en/api/v2/downtimes/examples.json @@ -66,6 +66,7 @@ "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", "mfa_enabled": false, "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", @@ -116,7 +117,7 @@ } } }, - "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array of downtimes.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Downtime details.

\n
\n
\n
\n
\n
\n

canceled

\n
\n

date-time

\n

Time that the downtime was canceled.

\n
\n \n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Creation time of the downtime.

\n
\n \n
\n
\n
\n
\n
\n

display_timezone

\n
\n

string

\n

The timezone in which to display the downtime's start and end times in Datadog applications. This is not used\nas an offset for scheduling.

default: UTC

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

A message to include with notifications for this downtime. Email notifications can be sent to specific users\nby using the same @username notation as events.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Time that the downtime was last modified.

\n
\n \n
\n
\n
\n
\n
\n

monitor_identifier

\n
\n

 <oneOf>

\n

Monitor identifier for the downtime.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Object of the monitor identifier.

\n
\n
\n
\n
\n
\n

monitor_id [required]

\n
\n

int64

\n

ID of the monitor to prevent notifications.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Object of the monitor tags.

\n
\n
\n
\n
\n
\n

monitor_tags [required]

\n
\n

[string]

\n

A list of monitor tags. For example, tags that are applied directly to monitors,\nnot tags that are used in monitor queries (which are filtered by the scope parameter), to which the downtime applies.\nThe resulting downtime applies to monitors that match all provided monitor tags. Setting monitor_tags\nto [*] configures the downtime to mute all monitors for the given scope.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

mute_first_recovery_notification

\n
\n

boolean

\n

If the first recovery notification during a downtime should be muted.

\n
\n \n
\n
\n
\n
\n
\n

notify_end_states

\n
\n

[string]

\n

States that will trigger a monitor notification when the notify_end_types action occurs.

\n
\n \n
\n
\n
\n
\n
\n

notify_end_types

\n
\n

[string]

\n

Actions that will trigger a monitor notification if the downtime is in the notify_end_types state.

\n
\n \n
\n
\n
\n
\n
\n

schedule

\n
\n

 <oneOf>

\n

The schedule that defines when the monitor starts, stops, and recurs. There are two types of schedules:\none-time and recurring. Recurring schedules may have up to five RRULE-based recurrences. If no schedules are\nprovided, the downtime will begin immediately and never end.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

A recurring downtime schedule definition.

\n
\n
\n
\n
\n
\n

current_downtime

\n
\n

object

\n

The most recent actual start and end dates for a recurring downtime. For a canceled downtime,\nthis is the previously occurring downtime. For active downtimes, this is the ongoing downtime, and for scheduled\ndowntimes it is the upcoming downtime.

\n
\n
\n
\n
\n
\n

end

\n
\n

date-time

\n

The end of the current downtime.

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

date-time

\n

The start of the current downtime.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

recurrences [required]

\n
\n

[object]

\n

A list of downtime recurrences.

\n
\n
\n
\n
\n
\n

duration

\n
\n

string

\n

The length of the downtime. Must begin with an integer and end with one of 'm', 'h', d', or 'w'.

\n
\n \n
\n
\n
\n
\n
\n

rrule

\n
\n

string

\n

The RRULE standard for defining recurring events.\nFor example, to have a recurring event on the first day of each month, set the type to rrule and set the FREQ to MONTHLY and BYMONTHDAY to 1.\nMost common rrule options from the iCalendar Spec are supported.

\n

Note: Attributes specifying the duration in RRULE are not supported (for example, DTSTART, DTEND, DURATION).\nMore examples available in this downtime guide.

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

string

\n

ISO-8601 Datetime to start the downtime. Must not include a UTC offset. If not provided, the\ndowntime starts the moment it is created.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

timezone

\n
\n

string

\n

The timezone in which to schedule the downtime. This affects recurring start and end dates.\nMust match display_timezone.

default: UTC

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A one-time downtime definition.

\n
\n
\n
\n
\n
\n

end

\n
\n

date-time

\n

ISO-8601 Datetime to end the downtime.

\n
\n \n
\n
\n
\n
\n
\n

start [required]

\n
\n

date-time

\n

ISO-8601 Datetime to start the downtime.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

The scope to which the downtime applies. Must follow the common search syntax.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The current status of the downtime. \nAllowed enum values: active,canceled,ended,scheduled

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The downtime ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

All relationships associated with downtime.

\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

The user who created the downtime.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Data for the user who created the downtime.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

User ID of the downtime creator.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

monitor

\n
\n

object

\n

The monitor identified by the downtime.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Data for the monitor.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Monitor ID of the downtime.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Monitor resource type. \nAllowed enum values: monitors

default: monitors

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Downtime resource type. \nAllowed enum values: downtime

default: downtime

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of objects related to the downtimes.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Information about the monitor identified by the downtime.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the monitor identified by the downtime.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the monitor identified by the downtime.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

int64

\n

ID of the monitor identified by the downtime.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Monitor resource type. \nAllowed enum values: monitors

default: monitors

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Pagination metadata returned by the API.

\n
\n
\n
\n
\n
\n

page

\n
\n

object

\n

Object containing the total filtered count.

\n
\n
\n
\n
\n
\n

total_filtered_count

\n
\n

int64

\n

Total count of elements matched by the filter.

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array of downtimes.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Downtime details.

\n
\n
\n
\n
\n
\n

canceled

\n
\n

date-time

\n

Time that the downtime was canceled.

\n
\n \n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Creation time of the downtime.

\n
\n \n
\n
\n
\n
\n
\n

display_timezone

\n
\n

string

\n

The timezone in which to display the downtime's start and end times in Datadog applications. This is not used\nas an offset for scheduling.

default: UTC

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

A message to include with notifications for this downtime. Email notifications can be sent to specific users\nby using the same @username notation as events.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Time that the downtime was last modified.

\n
\n \n
\n
\n
\n
\n
\n

monitor_identifier

\n
\n

 <oneOf>

\n

Monitor identifier for the downtime.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Object of the monitor identifier.

\n
\n
\n
\n
\n
\n

monitor_id [required]

\n
\n

int64

\n

ID of the monitor to prevent notifications.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Object of the monitor tags.

\n
\n
\n
\n
\n
\n

monitor_tags [required]

\n
\n

[string]

\n

A list of monitor tags. For example, tags that are applied directly to monitors,\nnot tags that are used in monitor queries (which are filtered by the scope parameter), to which the downtime applies.\nThe resulting downtime applies to monitors that match all provided monitor tags. Setting monitor_tags\nto [*] configures the downtime to mute all monitors for the given scope.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

mute_first_recovery_notification

\n
\n

boolean

\n

If the first recovery notification during a downtime should be muted.

\n
\n \n
\n
\n
\n
\n
\n

notify_end_states

\n
\n

[string]

\n

States that will trigger a monitor notification when the notify_end_types action occurs.

\n
\n \n
\n
\n
\n
\n
\n

notify_end_types

\n
\n

[string]

\n

Actions that will trigger a monitor notification if the downtime is in the notify_end_types state.

\n
\n \n
\n
\n
\n
\n
\n

schedule

\n
\n

 <oneOf>

\n

The schedule that defines when the monitor starts, stops, and recurs. There are two types of schedules:\none-time and recurring. Recurring schedules may have up to five RRULE-based recurrences. If no schedules are\nprovided, the downtime will begin immediately and never end.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

A recurring downtime schedule definition.

\n
\n
\n
\n
\n
\n

current_downtime

\n
\n

object

\n

The most recent actual start and end dates for a recurring downtime. For a canceled downtime,\nthis is the previously occurring downtime. For active downtimes, this is the ongoing downtime, and for scheduled\ndowntimes it is the upcoming downtime.

\n
\n
\n
\n
\n
\n

end

\n
\n

date-time

\n

The end of the current downtime.

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

date-time

\n

The start of the current downtime.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

recurrences [required]

\n
\n

[object]

\n

A list of downtime recurrences.

\n
\n
\n
\n
\n
\n

duration

\n
\n

string

\n

The length of the downtime. Must begin with an integer and end with one of 'm', 'h', d', or 'w'.

\n
\n \n
\n
\n
\n
\n
\n

rrule

\n
\n

string

\n

The RRULE standard for defining recurring events.\nFor example, to have a recurring event on the first day of each month, set the type to rrule and set the FREQ to MONTHLY and BYMONTHDAY to 1.\nMost common rrule options from the iCalendar Spec are supported.

\n

Note: Attributes specifying the duration in RRULE are not supported (for example, DTSTART, DTEND, DURATION).\nMore examples available in this downtime guide.

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

string

\n

ISO-8601 Datetime to start the downtime. Must not include a UTC offset. If not provided, the\ndowntime starts the moment it is created.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

timezone

\n
\n

string

\n

The timezone in which to schedule the downtime. This affects recurring start and end dates.\nMust match display_timezone.

default: UTC

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A one-time downtime definition.

\n
\n
\n
\n
\n
\n

end

\n
\n

date-time

\n

ISO-8601 Datetime to end the downtime.

\n
\n \n
\n
\n
\n
\n
\n

start [required]

\n
\n

date-time

\n

ISO-8601 Datetime to start the downtime.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

The scope to which the downtime applies. Must follow the common search syntax.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The current status of the downtime. \nAllowed enum values: active,canceled,ended,scheduled

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The downtime ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

All relationships associated with downtime.

\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

The user who created the downtime.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Data for the user who created the downtime.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

User ID of the downtime creator.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

monitor

\n
\n

object

\n

The monitor identified by the downtime.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Data for the monitor.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Monitor ID of the downtime.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Monitor resource type. \nAllowed enum values: monitors

default: monitors

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Downtime resource type. \nAllowed enum values: downtime

default: downtime

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of objects related to the downtimes.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Information about the monitor identified by the downtime.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the monitor identified by the downtime.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the monitor identified by the downtime.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

int64

\n

ID of the monitor identified by the downtime.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Monitor resource type. \nAllowed enum values: monitors

default: monitors

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Pagination metadata returned by the API.

\n
\n
\n
\n
\n
\n

page

\n
\n

object

\n

Object containing the total filtered count.

\n
\n
\n
\n
\n
\n

total_filtered_count

\n
\n

int64

\n

Total count of elements matched by the filter.

\n
\n \n
\n
\n
\n
\n
\n
" }, "403": { "json": { @@ -206,6 +207,7 @@ "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", "mfa_enabled": false, "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", @@ -251,7 +253,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Downtime data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Downtime details.

\n
\n
\n
\n
\n
\n

canceled

\n
\n

date-time

\n

Time that the downtime was canceled.

\n
\n \n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Creation time of the downtime.

\n
\n \n
\n
\n
\n
\n
\n

display_timezone

\n
\n

string

\n

The timezone in which to display the downtime's start and end times in Datadog applications. This is not used\nas an offset for scheduling.

default: UTC

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

A message to include with notifications for this downtime. Email notifications can be sent to specific users\nby using the same @username notation as events.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Time that the downtime was last modified.

\n
\n \n
\n
\n
\n
\n
\n

monitor_identifier

\n
\n

 <oneOf>

\n

Monitor identifier for the downtime.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Object of the monitor identifier.

\n
\n
\n
\n
\n
\n

monitor_id [required]

\n
\n

int64

\n

ID of the monitor to prevent notifications.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Object of the monitor tags.

\n
\n
\n
\n
\n
\n

monitor_tags [required]

\n
\n

[string]

\n

A list of monitor tags. For example, tags that are applied directly to monitors,\nnot tags that are used in monitor queries (which are filtered by the scope parameter), to which the downtime applies.\nThe resulting downtime applies to monitors that match all provided monitor tags. Setting monitor_tags\nto [*] configures the downtime to mute all monitors for the given scope.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

mute_first_recovery_notification

\n
\n

boolean

\n

If the first recovery notification during a downtime should be muted.

\n
\n \n
\n
\n
\n
\n
\n

notify_end_states

\n
\n

[string]

\n

States that will trigger a monitor notification when the notify_end_types action occurs.

\n
\n \n
\n
\n
\n
\n
\n

notify_end_types

\n
\n

[string]

\n

Actions that will trigger a monitor notification if the downtime is in the notify_end_types state.

\n
\n \n
\n
\n
\n
\n
\n

schedule

\n
\n

 <oneOf>

\n

The schedule that defines when the monitor starts, stops, and recurs. There are two types of schedules:\none-time and recurring. Recurring schedules may have up to five RRULE-based recurrences. If no schedules are\nprovided, the downtime will begin immediately and never end.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

A recurring downtime schedule definition.

\n
\n
\n
\n
\n
\n

current_downtime

\n
\n

object

\n

The most recent actual start and end dates for a recurring downtime. For a canceled downtime,\nthis is the previously occurring downtime. For active downtimes, this is the ongoing downtime, and for scheduled\ndowntimes it is the upcoming downtime.

\n
\n
\n
\n
\n
\n

end

\n
\n

date-time

\n

The end of the current downtime.

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

date-time

\n

The start of the current downtime.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

recurrences [required]

\n
\n

[object]

\n

A list of downtime recurrences.

\n
\n
\n
\n
\n
\n

duration

\n
\n

string

\n

The length of the downtime. Must begin with an integer and end with one of 'm', 'h', d', or 'w'.

\n
\n \n
\n
\n
\n
\n
\n

rrule

\n
\n

string

\n

The RRULE standard for defining recurring events.\nFor example, to have a recurring event on the first day of each month, set the type to rrule and set the FREQ to MONTHLY and BYMONTHDAY to 1.\nMost common rrule options from the iCalendar Spec are supported.

\n

Note: Attributes specifying the duration in RRULE are not supported (for example, DTSTART, DTEND, DURATION).\nMore examples available in this downtime guide.

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

string

\n

ISO-8601 Datetime to start the downtime. Must not include a UTC offset. If not provided, the\ndowntime starts the moment it is created.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

timezone

\n
\n

string

\n

The timezone in which to schedule the downtime. This affects recurring start and end dates.\nMust match display_timezone.

default: UTC

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A one-time downtime definition.

\n
\n
\n
\n
\n
\n

end

\n
\n

date-time

\n

ISO-8601 Datetime to end the downtime.

\n
\n \n
\n
\n
\n
\n
\n

start [required]

\n
\n

date-time

\n

ISO-8601 Datetime to start the downtime.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

The scope to which the downtime applies. Must follow the common search syntax.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The current status of the downtime. \nAllowed enum values: active,canceled,ended,scheduled

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The downtime ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

All relationships associated with downtime.

\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

The user who created the downtime.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Data for the user who created the downtime.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

User ID of the downtime creator.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

monitor

\n
\n

object

\n

The monitor identified by the downtime.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Data for the monitor.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Monitor ID of the downtime.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Monitor resource type. \nAllowed enum values: monitors

default: monitors

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Downtime resource type. \nAllowed enum values: downtime

default: downtime

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of objects related to the downtime that the user requested.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Information about the monitor identified by the downtime.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the monitor identified by the downtime.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the monitor identified by the downtime.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

int64

\n

ID of the monitor identified by the downtime.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Monitor resource type. \nAllowed enum values: monitors

default: monitors

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Downtime data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Downtime details.

\n
\n
\n
\n
\n
\n

canceled

\n
\n

date-time

\n

Time that the downtime was canceled.

\n
\n \n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Creation time of the downtime.

\n
\n \n
\n
\n
\n
\n
\n

display_timezone

\n
\n

string

\n

The timezone in which to display the downtime's start and end times in Datadog applications. This is not used\nas an offset for scheduling.

default: UTC

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

A message to include with notifications for this downtime. Email notifications can be sent to specific users\nby using the same @username notation as events.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Time that the downtime was last modified.

\n
\n \n
\n
\n
\n
\n
\n

monitor_identifier

\n
\n

 <oneOf>

\n

Monitor identifier for the downtime.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Object of the monitor identifier.

\n
\n
\n
\n
\n
\n

monitor_id [required]

\n
\n

int64

\n

ID of the monitor to prevent notifications.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Object of the monitor tags.

\n
\n
\n
\n
\n
\n

monitor_tags [required]

\n
\n

[string]

\n

A list of monitor tags. For example, tags that are applied directly to monitors,\nnot tags that are used in monitor queries (which are filtered by the scope parameter), to which the downtime applies.\nThe resulting downtime applies to monitors that match all provided monitor tags. Setting monitor_tags\nto [*] configures the downtime to mute all monitors for the given scope.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

mute_first_recovery_notification

\n
\n

boolean

\n

If the first recovery notification during a downtime should be muted.

\n
\n \n
\n
\n
\n
\n
\n

notify_end_states

\n
\n

[string]

\n

States that will trigger a monitor notification when the notify_end_types action occurs.

\n
\n \n
\n
\n
\n
\n
\n

notify_end_types

\n
\n

[string]

\n

Actions that will trigger a monitor notification if the downtime is in the notify_end_types state.

\n
\n \n
\n
\n
\n
\n
\n

schedule

\n
\n

 <oneOf>

\n

The schedule that defines when the monitor starts, stops, and recurs. There are two types of schedules:\none-time and recurring. Recurring schedules may have up to five RRULE-based recurrences. If no schedules are\nprovided, the downtime will begin immediately and never end.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

A recurring downtime schedule definition.

\n
\n
\n
\n
\n
\n

current_downtime

\n
\n

object

\n

The most recent actual start and end dates for a recurring downtime. For a canceled downtime,\nthis is the previously occurring downtime. For active downtimes, this is the ongoing downtime, and for scheduled\ndowntimes it is the upcoming downtime.

\n
\n
\n
\n
\n
\n

end

\n
\n

date-time

\n

The end of the current downtime.

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

date-time

\n

The start of the current downtime.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

recurrences [required]

\n
\n

[object]

\n

A list of downtime recurrences.

\n
\n
\n
\n
\n
\n

duration

\n
\n

string

\n

The length of the downtime. Must begin with an integer and end with one of 'm', 'h', d', or 'w'.

\n
\n \n
\n
\n
\n
\n
\n

rrule

\n
\n

string

\n

The RRULE standard for defining recurring events.\nFor example, to have a recurring event on the first day of each month, set the type to rrule and set the FREQ to MONTHLY and BYMONTHDAY to 1.\nMost common rrule options from the iCalendar Spec are supported.

\n

Note: Attributes specifying the duration in RRULE are not supported (for example, DTSTART, DTEND, DURATION).\nMore examples available in this downtime guide.

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

string

\n

ISO-8601 Datetime to start the downtime. Must not include a UTC offset. If not provided, the\ndowntime starts the moment it is created.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

timezone

\n
\n

string

\n

The timezone in which to schedule the downtime. This affects recurring start and end dates.\nMust match display_timezone.

default: UTC

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A one-time downtime definition.

\n
\n
\n
\n
\n
\n

end

\n
\n

date-time

\n

ISO-8601 Datetime to end the downtime.

\n
\n \n
\n
\n
\n
\n
\n

start [required]

\n
\n

date-time

\n

ISO-8601 Datetime to start the downtime.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

The scope to which the downtime applies. Must follow the common search syntax.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The current status of the downtime. \nAllowed enum values: active,canceled,ended,scheduled

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The downtime ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

All relationships associated with downtime.

\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

The user who created the downtime.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Data for the user who created the downtime.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

User ID of the downtime creator.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

monitor

\n
\n

object

\n

The monitor identified by the downtime.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Data for the monitor.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Monitor ID of the downtime.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Monitor resource type. \nAllowed enum values: monitors

default: monitors

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Downtime resource type. \nAllowed enum values: downtime

default: downtime

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of objects related to the downtime that the user requested.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Information about the monitor identified by the downtime.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the monitor identified by the downtime.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the monitor identified by the downtime.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

int64

\n

ID of the monitor identified by the downtime.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Monitor resource type. \nAllowed enum values: monitors

default: monitors

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { @@ -429,6 +431,7 @@ "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", "mfa_enabled": false, "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", @@ -474,7 +477,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Downtime data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Downtime details.

\n
\n
\n
\n
\n
\n

canceled

\n
\n

date-time

\n

Time that the downtime was canceled.

\n
\n \n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Creation time of the downtime.

\n
\n \n
\n
\n
\n
\n
\n

display_timezone

\n
\n

string

\n

The timezone in which to display the downtime's start and end times in Datadog applications. This is not used\nas an offset for scheduling.

default: UTC

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

A message to include with notifications for this downtime. Email notifications can be sent to specific users\nby using the same @username notation as events.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Time that the downtime was last modified.

\n
\n \n
\n
\n
\n
\n
\n

monitor_identifier

\n
\n

 <oneOf>

\n

Monitor identifier for the downtime.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Object of the monitor identifier.

\n
\n
\n
\n
\n
\n

monitor_id [required]

\n
\n

int64

\n

ID of the monitor to prevent notifications.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Object of the monitor tags.

\n
\n
\n
\n
\n
\n

monitor_tags [required]

\n
\n

[string]

\n

A list of monitor tags. For example, tags that are applied directly to monitors,\nnot tags that are used in monitor queries (which are filtered by the scope parameter), to which the downtime applies.\nThe resulting downtime applies to monitors that match all provided monitor tags. Setting monitor_tags\nto [*] configures the downtime to mute all monitors for the given scope.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

mute_first_recovery_notification

\n
\n

boolean

\n

If the first recovery notification during a downtime should be muted.

\n
\n \n
\n
\n
\n
\n
\n

notify_end_states

\n
\n

[string]

\n

States that will trigger a monitor notification when the notify_end_types action occurs.

\n
\n \n
\n
\n
\n
\n
\n

notify_end_types

\n
\n

[string]

\n

Actions that will trigger a monitor notification if the downtime is in the notify_end_types state.

\n
\n \n
\n
\n
\n
\n
\n

schedule

\n
\n

 <oneOf>

\n

The schedule that defines when the monitor starts, stops, and recurs. There are two types of schedules:\none-time and recurring. Recurring schedules may have up to five RRULE-based recurrences. If no schedules are\nprovided, the downtime will begin immediately and never end.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

A recurring downtime schedule definition.

\n
\n
\n
\n
\n
\n

current_downtime

\n
\n

object

\n

The most recent actual start and end dates for a recurring downtime. For a canceled downtime,\nthis is the previously occurring downtime. For active downtimes, this is the ongoing downtime, and for scheduled\ndowntimes it is the upcoming downtime.

\n
\n
\n
\n
\n
\n

end

\n
\n

date-time

\n

The end of the current downtime.

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

date-time

\n

The start of the current downtime.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

recurrences [required]

\n
\n

[object]

\n

A list of downtime recurrences.

\n
\n
\n
\n
\n
\n

duration

\n
\n

string

\n

The length of the downtime. Must begin with an integer and end with one of 'm', 'h', d', or 'w'.

\n
\n \n
\n
\n
\n
\n
\n

rrule

\n
\n

string

\n

The RRULE standard for defining recurring events.\nFor example, to have a recurring event on the first day of each month, set the type to rrule and set the FREQ to MONTHLY and BYMONTHDAY to 1.\nMost common rrule options from the iCalendar Spec are supported.

\n

Note: Attributes specifying the duration in RRULE are not supported (for example, DTSTART, DTEND, DURATION).\nMore examples available in this downtime guide.

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

string

\n

ISO-8601 Datetime to start the downtime. Must not include a UTC offset. If not provided, the\ndowntime starts the moment it is created.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

timezone

\n
\n

string

\n

The timezone in which to schedule the downtime. This affects recurring start and end dates.\nMust match display_timezone.

default: UTC

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A one-time downtime definition.

\n
\n
\n
\n
\n
\n

end

\n
\n

date-time

\n

ISO-8601 Datetime to end the downtime.

\n
\n \n
\n
\n
\n
\n
\n

start [required]

\n
\n

date-time

\n

ISO-8601 Datetime to start the downtime.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

The scope to which the downtime applies. Must follow the common search syntax.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The current status of the downtime. \nAllowed enum values: active,canceled,ended,scheduled

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The downtime ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

All relationships associated with downtime.

\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

The user who created the downtime.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Data for the user who created the downtime.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

User ID of the downtime creator.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

monitor

\n
\n

object

\n

The monitor identified by the downtime.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Data for the monitor.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Monitor ID of the downtime.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Monitor resource type. \nAllowed enum values: monitors

default: monitors

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Downtime resource type. \nAllowed enum values: downtime

default: downtime

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of objects related to the downtime that the user requested.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Information about the monitor identified by the downtime.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the monitor identified by the downtime.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the monitor identified by the downtime.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

int64

\n

ID of the monitor identified by the downtime.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Monitor resource type. \nAllowed enum values: monitors

default: monitors

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Downtime data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Downtime details.

\n
\n
\n
\n
\n
\n

canceled

\n
\n

date-time

\n

Time that the downtime was canceled.

\n
\n \n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Creation time of the downtime.

\n
\n \n
\n
\n
\n
\n
\n

display_timezone

\n
\n

string

\n

The timezone in which to display the downtime's start and end times in Datadog applications. This is not used\nas an offset for scheduling.

default: UTC

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

A message to include with notifications for this downtime. Email notifications can be sent to specific users\nby using the same @username notation as events.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Time that the downtime was last modified.

\n
\n \n
\n
\n
\n
\n
\n

monitor_identifier

\n
\n

 <oneOf>

\n

Monitor identifier for the downtime.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Object of the monitor identifier.

\n
\n
\n
\n
\n
\n

monitor_id [required]

\n
\n

int64

\n

ID of the monitor to prevent notifications.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Object of the monitor tags.

\n
\n
\n
\n
\n
\n

monitor_tags [required]

\n
\n

[string]

\n

A list of monitor tags. For example, tags that are applied directly to monitors,\nnot tags that are used in monitor queries (which are filtered by the scope parameter), to which the downtime applies.\nThe resulting downtime applies to monitors that match all provided monitor tags. Setting monitor_tags\nto [*] configures the downtime to mute all monitors for the given scope.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

mute_first_recovery_notification

\n
\n

boolean

\n

If the first recovery notification during a downtime should be muted.

\n
\n \n
\n
\n
\n
\n
\n

notify_end_states

\n
\n

[string]

\n

States that will trigger a monitor notification when the notify_end_types action occurs.

\n
\n \n
\n
\n
\n
\n
\n

notify_end_types

\n
\n

[string]

\n

Actions that will trigger a monitor notification if the downtime is in the notify_end_types state.

\n
\n \n
\n
\n
\n
\n
\n

schedule

\n
\n

 <oneOf>

\n

The schedule that defines when the monitor starts, stops, and recurs. There are two types of schedules:\none-time and recurring. Recurring schedules may have up to five RRULE-based recurrences. If no schedules are\nprovided, the downtime will begin immediately and never end.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

A recurring downtime schedule definition.

\n
\n
\n
\n
\n
\n

current_downtime

\n
\n

object

\n

The most recent actual start and end dates for a recurring downtime. For a canceled downtime,\nthis is the previously occurring downtime. For active downtimes, this is the ongoing downtime, and for scheduled\ndowntimes it is the upcoming downtime.

\n
\n
\n
\n
\n
\n

end

\n
\n

date-time

\n

The end of the current downtime.

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

date-time

\n

The start of the current downtime.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

recurrences [required]

\n
\n

[object]

\n

A list of downtime recurrences.

\n
\n
\n
\n
\n
\n

duration

\n
\n

string

\n

The length of the downtime. Must begin with an integer and end with one of 'm', 'h', d', or 'w'.

\n
\n \n
\n
\n
\n
\n
\n

rrule

\n
\n

string

\n

The RRULE standard for defining recurring events.\nFor example, to have a recurring event on the first day of each month, set the type to rrule and set the FREQ to MONTHLY and BYMONTHDAY to 1.\nMost common rrule options from the iCalendar Spec are supported.

\n

Note: Attributes specifying the duration in RRULE are not supported (for example, DTSTART, DTEND, DURATION).\nMore examples available in this downtime guide.

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

string

\n

ISO-8601 Datetime to start the downtime. Must not include a UTC offset. If not provided, the\ndowntime starts the moment it is created.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

timezone

\n
\n

string

\n

The timezone in which to schedule the downtime. This affects recurring start and end dates.\nMust match display_timezone.

default: UTC

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A one-time downtime definition.

\n
\n
\n
\n
\n
\n

end

\n
\n

date-time

\n

ISO-8601 Datetime to end the downtime.

\n
\n \n
\n
\n
\n
\n
\n

start [required]

\n
\n

date-time

\n

ISO-8601 Datetime to start the downtime.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

The scope to which the downtime applies. Must follow the common search syntax.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The current status of the downtime. \nAllowed enum values: active,canceled,ended,scheduled

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The downtime ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

All relationships associated with downtime.

\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

The user who created the downtime.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Data for the user who created the downtime.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

User ID of the downtime creator.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

monitor

\n
\n

object

\n

The monitor identified by the downtime.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Data for the monitor.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Monitor ID of the downtime.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Monitor resource type. \nAllowed enum values: monitors

default: monitors

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Downtime resource type. \nAllowed enum values: downtime

default: downtime

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of objects related to the downtime that the user requested.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Information about the monitor identified by the downtime.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the monitor identified by the downtime.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the monitor identified by the downtime.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

int64

\n

ID of the monitor identified by the downtime.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Monitor resource type. \nAllowed enum values: monitors

default: monitors

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { @@ -580,6 +583,7 @@ "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", "mfa_enabled": false, "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", @@ -625,7 +629,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Downtime data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Downtime details.

\n
\n
\n
\n
\n
\n

canceled

\n
\n

date-time

\n

Time that the downtime was canceled.

\n
\n \n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Creation time of the downtime.

\n
\n \n
\n
\n
\n
\n
\n

display_timezone

\n
\n

string

\n

The timezone in which to display the downtime's start and end times in Datadog applications. This is not used\nas an offset for scheduling.

default: UTC

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

A message to include with notifications for this downtime. Email notifications can be sent to specific users\nby using the same @username notation as events.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Time that the downtime was last modified.

\n
\n \n
\n
\n
\n
\n
\n

monitor_identifier

\n
\n

 <oneOf>

\n

Monitor identifier for the downtime.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Object of the monitor identifier.

\n
\n
\n
\n
\n
\n

monitor_id [required]

\n
\n

int64

\n

ID of the monitor to prevent notifications.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Object of the monitor tags.

\n
\n
\n
\n
\n
\n

monitor_tags [required]

\n
\n

[string]

\n

A list of monitor tags. For example, tags that are applied directly to monitors,\nnot tags that are used in monitor queries (which are filtered by the scope parameter), to which the downtime applies.\nThe resulting downtime applies to monitors that match all provided monitor tags. Setting monitor_tags\nto [*] configures the downtime to mute all monitors for the given scope.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

mute_first_recovery_notification

\n
\n

boolean

\n

If the first recovery notification during a downtime should be muted.

\n
\n \n
\n
\n
\n
\n
\n

notify_end_states

\n
\n

[string]

\n

States that will trigger a monitor notification when the notify_end_types action occurs.

\n
\n \n
\n
\n
\n
\n
\n

notify_end_types

\n
\n

[string]

\n

Actions that will trigger a monitor notification if the downtime is in the notify_end_types state.

\n
\n \n
\n
\n
\n
\n
\n

schedule

\n
\n

 <oneOf>

\n

The schedule that defines when the monitor starts, stops, and recurs. There are two types of schedules:\none-time and recurring. Recurring schedules may have up to five RRULE-based recurrences. If no schedules are\nprovided, the downtime will begin immediately and never end.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

A recurring downtime schedule definition.

\n
\n
\n
\n
\n
\n

current_downtime

\n
\n

object

\n

The most recent actual start and end dates for a recurring downtime. For a canceled downtime,\nthis is the previously occurring downtime. For active downtimes, this is the ongoing downtime, and for scheduled\ndowntimes it is the upcoming downtime.

\n
\n
\n
\n
\n
\n

end

\n
\n

date-time

\n

The end of the current downtime.

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

date-time

\n

The start of the current downtime.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

recurrences [required]

\n
\n

[object]

\n

A list of downtime recurrences.

\n
\n
\n
\n
\n
\n

duration

\n
\n

string

\n

The length of the downtime. Must begin with an integer and end with one of 'm', 'h', d', or 'w'.

\n
\n \n
\n
\n
\n
\n
\n

rrule

\n
\n

string

\n

The RRULE standard for defining recurring events.\nFor example, to have a recurring event on the first day of each month, set the type to rrule and set the FREQ to MONTHLY and BYMONTHDAY to 1.\nMost common rrule options from the iCalendar Spec are supported.

\n

Note: Attributes specifying the duration in RRULE are not supported (for example, DTSTART, DTEND, DURATION).\nMore examples available in this downtime guide.

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

string

\n

ISO-8601 Datetime to start the downtime. Must not include a UTC offset. If not provided, the\ndowntime starts the moment it is created.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

timezone

\n
\n

string

\n

The timezone in which to schedule the downtime. This affects recurring start and end dates.\nMust match display_timezone.

default: UTC

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A one-time downtime definition.

\n
\n
\n
\n
\n
\n

end

\n
\n

date-time

\n

ISO-8601 Datetime to end the downtime.

\n
\n \n
\n
\n
\n
\n
\n

start [required]

\n
\n

date-time

\n

ISO-8601 Datetime to start the downtime.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

The scope to which the downtime applies. Must follow the common search syntax.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The current status of the downtime. \nAllowed enum values: active,canceled,ended,scheduled

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The downtime ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

All relationships associated with downtime.

\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

The user who created the downtime.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Data for the user who created the downtime.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

User ID of the downtime creator.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

monitor

\n
\n

object

\n

The monitor identified by the downtime.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Data for the monitor.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Monitor ID of the downtime.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Monitor resource type. \nAllowed enum values: monitors

default: monitors

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Downtime resource type. \nAllowed enum values: downtime

default: downtime

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of objects related to the downtime that the user requested.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Information about the monitor identified by the downtime.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the monitor identified by the downtime.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the monitor identified by the downtime.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

int64

\n

ID of the monitor identified by the downtime.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Monitor resource type. \nAllowed enum values: monitors

default: monitors

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Downtime data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Downtime details.

\n
\n
\n
\n
\n
\n

canceled

\n
\n

date-time

\n

Time that the downtime was canceled.

\n
\n \n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Creation time of the downtime.

\n
\n \n
\n
\n
\n
\n
\n

display_timezone

\n
\n

string

\n

The timezone in which to display the downtime's start and end times in Datadog applications. This is not used\nas an offset for scheduling.

default: UTC

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

A message to include with notifications for this downtime. Email notifications can be sent to specific users\nby using the same @username notation as events.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Time that the downtime was last modified.

\n
\n \n
\n
\n
\n
\n
\n

monitor_identifier

\n
\n

 <oneOf>

\n

Monitor identifier for the downtime.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Object of the monitor identifier.

\n
\n
\n
\n
\n
\n

monitor_id [required]

\n
\n

int64

\n

ID of the monitor to prevent notifications.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Object of the monitor tags.

\n
\n
\n
\n
\n
\n

monitor_tags [required]

\n
\n

[string]

\n

A list of monitor tags. For example, tags that are applied directly to monitors,\nnot tags that are used in monitor queries (which are filtered by the scope parameter), to which the downtime applies.\nThe resulting downtime applies to monitors that match all provided monitor tags. Setting monitor_tags\nto [*] configures the downtime to mute all monitors for the given scope.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

mute_first_recovery_notification

\n
\n

boolean

\n

If the first recovery notification during a downtime should be muted.

\n
\n \n
\n
\n
\n
\n
\n

notify_end_states

\n
\n

[string]

\n

States that will trigger a monitor notification when the notify_end_types action occurs.

\n
\n \n
\n
\n
\n
\n
\n

notify_end_types

\n
\n

[string]

\n

Actions that will trigger a monitor notification if the downtime is in the notify_end_types state.

\n
\n \n
\n
\n
\n
\n
\n

schedule

\n
\n

 <oneOf>

\n

The schedule that defines when the monitor starts, stops, and recurs. There are two types of schedules:\none-time and recurring. Recurring schedules may have up to five RRULE-based recurrences. If no schedules are\nprovided, the downtime will begin immediately and never end.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

A recurring downtime schedule definition.

\n
\n
\n
\n
\n
\n

current_downtime

\n
\n

object

\n

The most recent actual start and end dates for a recurring downtime. For a canceled downtime,\nthis is the previously occurring downtime. For active downtimes, this is the ongoing downtime, and for scheduled\ndowntimes it is the upcoming downtime.

\n
\n
\n
\n
\n
\n

end

\n
\n

date-time

\n

The end of the current downtime.

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

date-time

\n

The start of the current downtime.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

recurrences [required]

\n
\n

[object]

\n

A list of downtime recurrences.

\n
\n
\n
\n
\n
\n

duration

\n
\n

string

\n

The length of the downtime. Must begin with an integer and end with one of 'm', 'h', d', or 'w'.

\n
\n \n
\n
\n
\n
\n
\n

rrule

\n
\n

string

\n

The RRULE standard for defining recurring events.\nFor example, to have a recurring event on the first day of each month, set the type to rrule and set the FREQ to MONTHLY and BYMONTHDAY to 1.\nMost common rrule options from the iCalendar Spec are supported.

\n

Note: Attributes specifying the duration in RRULE are not supported (for example, DTSTART, DTEND, DURATION).\nMore examples available in this downtime guide.

\n
\n \n
\n
\n
\n
\n
\n

start

\n
\n

string

\n

ISO-8601 Datetime to start the downtime. Must not include a UTC offset. If not provided, the\ndowntime starts the moment it is created.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

timezone

\n
\n

string

\n

The timezone in which to schedule the downtime. This affects recurring start and end dates.\nMust match display_timezone.

default: UTC

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A one-time downtime definition.

\n
\n
\n
\n
\n
\n

end

\n
\n

date-time

\n

ISO-8601 Datetime to end the downtime.

\n
\n \n
\n
\n
\n
\n
\n

start [required]

\n
\n

date-time

\n

ISO-8601 Datetime to start the downtime.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

The scope to which the downtime applies. Must follow the common search syntax.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The current status of the downtime. \nAllowed enum values: active,canceled,ended,scheduled

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The downtime ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

All relationships associated with downtime.

\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

The user who created the downtime.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Data for the user who created the downtime.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

User ID of the downtime creator.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

monitor

\n
\n

object

\n

The monitor identified by the downtime.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Data for the monitor.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Monitor ID of the downtime.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Monitor resource type. \nAllowed enum values: monitors

default: monitors

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Downtime resource type. \nAllowed enum values: downtime

default: downtime

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of objects related to the downtime that the user requested.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Information about the monitor identified by the downtime.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the monitor identified by the downtime.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the monitor identified by the downtime.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

int64

\n

ID of the monitor identified by the downtime.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Monitor resource type. \nAllowed enum values: monitors

default: monitors

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { diff --git a/content/en/api/v2/incident-services/examples.json b/content/en/api/v2/incident-services/examples.json index bc01f8f632af3..26fb6b183ab40 100644 --- a/content/en/api/v2/incident-services/examples.json +++ b/content/en/api/v2/incident-services/examples.json @@ -36,6 +36,7 @@ "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", "mfa_enabled": false, "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", @@ -88,7 +89,7 @@ } } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of incident services.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The incident service's attributes from a response.

\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp of when the incident service was created.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp of when the incident service was modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the incident service.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident service's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident service's relationships.

\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident service resource type. \nAllowed enum values: services

default: services

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Included related resources which the user requested.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

The metadata object containing pagination metadata.

\n
\n
\n
\n
\n
\n

pagination

\n
\n

object

\n

Pagination properties.

\n
\n
\n
\n
\n
\n

next_offset

\n
\n

int64

\n

The index of the first element in the next page of results. Equal to page size added to the current offset.

\n
\n \n
\n
\n
\n
\n
\n

offset

\n
\n

int64

\n

The index of the first element in the results.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

Maximum size of pages to return.

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of incident services.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The incident service's attributes from a response.

\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp of when the incident service was created.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp of when the incident service was modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the incident service.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident service's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident service's relationships.

\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident service resource type. \nAllowed enum values: services

default: services

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Included related resources which the user requested.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

The metadata object containing pagination metadata.

\n
\n
\n
\n
\n
\n

pagination

\n
\n

object

\n

Pagination properties.

\n
\n
\n
\n
\n
\n

next_offset

\n
\n

int64

\n

The index of the first element in the next page of results. Equal to page size added to the current offset.

\n
\n \n
\n
\n
\n
\n
\n

offset

\n
\n

int64

\n

The index of the first element in the results.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

Maximum size of pages to return.

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { @@ -172,6 +173,7 @@ "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", "mfa_enabled": false, "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", @@ -217,7 +219,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident Service data from responses.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The incident service's attributes from a response.

\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp of when the incident service was created.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp of when the incident service was modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the incident service.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident service's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident service's relationships.

\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident service resource type. \nAllowed enum values: services

default: services

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Included objects from relationships.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident Service data from responses.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The incident service's attributes from a response.

\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp of when the incident service was created.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp of when the incident service was modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the incident service.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident service's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident service's relationships.

\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident service resource type. \nAllowed enum values: services

default: services

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Included objects from relationships.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { @@ -364,6 +366,7 @@ "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", "mfa_enabled": false, "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", @@ -409,7 +412,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident Service data from responses.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The incident service's attributes from a response.

\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp of when the incident service was created.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp of when the incident service was modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the incident service.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident service's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident service's relationships.

\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident service resource type. \nAllowed enum values: services

default: services

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Included objects from relationships.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident Service data from responses.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The incident service's attributes from a response.

\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp of when the incident service was created.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp of when the incident service was modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the incident service.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident service's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident service's relationships.

\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident service resource type. \nAllowed enum values: services

default: services

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Included objects from relationships.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { @@ -493,6 +496,7 @@ "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", "mfa_enabled": false, "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", @@ -538,7 +542,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident Service data from responses.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The incident service's attributes from a response.

\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp of when the incident service was created.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp of when the incident service was modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the incident service.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident service's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident service's relationships.

\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident service resource type. \nAllowed enum values: services

default: services

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Included objects from relationships.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident Service data from responses.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The incident service's attributes from a response.

\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp of when the incident service was created.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp of when the incident service was modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the incident service.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident service's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident service's relationships.

\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident service resource type. \nAllowed enum values: services

default: services

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Included objects from relationships.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { diff --git a/content/en/api/v2/incident-teams/examples.json b/content/en/api/v2/incident-teams/examples.json index 43f3d38c0f7ad..19bc8dc503387 100644 --- a/content/en/api/v2/incident-teams/examples.json +++ b/content/en/api/v2/incident-teams/examples.json @@ -36,6 +36,7 @@ "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", "mfa_enabled": false, "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", @@ -88,7 +89,7 @@ } } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of incident teams.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The incident team's attributes from a response.

\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp of when the incident team was created.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp of when the incident team was modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the incident team.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The incident team's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident team's relationships.

\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Incident Team resource type. \nAllowed enum values: teams

default: teams

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Included related resources which the user requested.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

The metadata object containing pagination metadata.

\n
\n
\n
\n
\n
\n

pagination

\n
\n

object

\n

Pagination properties.

\n
\n
\n
\n
\n
\n

next_offset

\n
\n

int64

\n

The index of the first element in the next page of results. Equal to page size added to the current offset.

\n
\n \n
\n
\n
\n
\n
\n

offset

\n
\n

int64

\n

The index of the first element in the results.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

Maximum size of pages to return.

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of incident teams.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The incident team's attributes from a response.

\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp of when the incident team was created.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp of when the incident team was modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the incident team.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The incident team's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident team's relationships.

\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Incident Team resource type. \nAllowed enum values: teams

default: teams

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Included related resources which the user requested.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

The metadata object containing pagination metadata.

\n
\n
\n
\n
\n
\n

pagination

\n
\n

object

\n

Pagination properties.

\n
\n
\n
\n
\n
\n

next_offset

\n
\n

int64

\n

The index of the first element in the next page of results. Equal to page size added to the current offset.

\n
\n \n
\n
\n
\n
\n
\n

offset

\n
\n

int64

\n

The index of the first element in the results.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

Maximum size of pages to return.

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { @@ -172,6 +173,7 @@ "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", "mfa_enabled": false, "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", @@ -217,7 +219,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident Team data from a response.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The incident team's attributes from a response.

\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp of when the incident team was created.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp of when the incident team was modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the incident team.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The incident team's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident team's relationships.

\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Incident Team resource type. \nAllowed enum values: teams

default: teams

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Included objects from relationships.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident Team data from a response.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The incident team's attributes from a response.

\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp of when the incident team was created.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp of when the incident team was modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the incident team.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The incident team's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident team's relationships.

\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Incident Team resource type. \nAllowed enum values: teams

default: teams

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Included objects from relationships.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { @@ -364,6 +366,7 @@ "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", "mfa_enabled": false, "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", @@ -409,7 +412,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident Team data from a response.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The incident team's attributes from a response.

\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp of when the incident team was created.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp of when the incident team was modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the incident team.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The incident team's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident team's relationships.

\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Incident Team resource type. \nAllowed enum values: teams

default: teams

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Included objects from relationships.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident Team data from a response.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The incident team's attributes from a response.

\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp of when the incident team was created.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp of when the incident team was modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the incident team.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The incident team's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident team's relationships.

\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Incident Team resource type. \nAllowed enum values: teams

default: teams

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Included objects from relationships.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { @@ -493,6 +496,7 @@ "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", "mfa_enabled": false, "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", @@ -538,7 +542,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident Team data from a response.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The incident team's attributes from a response.

\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp of when the incident team was created.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp of when the incident team was modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the incident team.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The incident team's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident team's relationships.

\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Incident Team resource type. \nAllowed enum values: teams

default: teams

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Included objects from relationships.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident Team data from a response.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The incident team's attributes from a response.

\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp of when the incident team was created.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp of when the incident team was modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the incident team.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The incident team's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident team's relationships.

\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Incident Team resource type. \nAllowed enum values: teams

default: teams

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Included objects from relationships.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { diff --git a/content/en/api/v2/incidents/examples.json b/content/en/api/v2/incidents/examples.json index 8839f9f384d50..41a55c32b8628 100644 --- a/content/en/api/v2/incidents/examples.json +++ b/content/en/api/v2/incidents/examples.json @@ -489,6 +489,7 @@ "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", "mfa_enabled": false, "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", @@ -541,7 +542,7 @@ } } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

The NotificationRuleArray data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The notification rule's attributes.

\n
\n
\n
\n
\n
\n

conditions [required]

\n
\n

[object]

\n

The conditions that trigger this notification rule.

\n
\n
\n
\n
\n
\n

field [required]

\n
\n

string

\n

The incident field to evaluate

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The value(s) to compare against. Multiple values are ORed together.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created [required]

\n
\n

date-time

\n

Timestamp when the notification rule was created.

\n
\n \n
\n
\n
\n
\n
\n

enabled [required]

\n
\n

boolean

\n

Whether the notification rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

handles [required]

\n
\n

[string]

\n

The notification handles (targets) for this rule.

\n
\n \n
\n
\n
\n
\n
\n

modified [required]

\n
\n

date-time

\n

Timestamp when the notification rule was last modified.

\n
\n \n
\n
\n
\n
\n
\n

renotify_on

\n
\n

[string]

\n

List of incident fields that trigger re-notification when changed.

\n
\n \n
\n
\n
\n
\n
\n

trigger [required]

\n
\n

string

\n

The trigger event for this notification rule.

\n
\n \n
\n
\n
\n
\n
\n

visibility [required]

\n
\n

enum

\n

The visibility of the notification rule. \nAllowed enum values: all,organization,private

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the notification rule.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The notification rule's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

notification_template

\n
\n

object

\n

A relationship reference to a notification template.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The notification template relationship data.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification templates resource type. \nAllowed enum values: notification_templates

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification rules resource type. \nAllowed enum values: incident_notification_rules

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Related objects that are included in the response.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Incident type response data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident type's attributes.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

date-time

\n

Timestamp when the incident type was created.

\n
\n \n
\n
\n
\n
\n
\n

createdBy

\n
\n

string

\n

A unique identifier that represents the user that created the incident type.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Text that describes the incident type.

\n
\n \n
\n
\n
\n
\n
\n

is_default

\n
\n

boolean

\n

If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.

\n
\n \n
\n
\n
\n
\n
\n

lastModifiedBy

\n
\n

string

\n

A unique identifier that represents the user that last modified the incident type.

\n
\n \n
\n
\n
\n
\n
\n

modifiedAt

\n
\n

date-time

\n

Timestamp when the incident type was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the incident type.

\n
\n \n
\n
\n
\n
\n
\n

prefix

\n
\n

string

\n

The string that will be prepended to the incident title across the Datadog app.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident type's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

google_meet_configuration

\n
\n

object

\n

A reference to a Google Meet Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Google Meet configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

microsoft_teams_configuration

\n
\n

object

\n

A reference to a Microsoft Teams Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Microsoft Teams configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

zoom_configuration

\n
\n

object

\n

A reference to a Zoom configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Zoom configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

A notification template object for inclusion in other resources.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The notification template's attributes.

\n
\n
\n
\n
\n
\n

category [required]

\n
\n

string

\n

The category of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

content [required]

\n
\n

string

\n

The content body of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

created [required]

\n
\n

date-time

\n

Timestamp when the notification template was created.

\n
\n \n
\n
\n
\n
\n
\n

modified [required]

\n
\n

date-time

\n

Timestamp when the notification template was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

subject [required]

\n
\n

string

\n

The subject line of the notification template.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The notification template's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification templates resource type. \nAllowed enum values: notification_templates

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Response metadata.

\n
\n
\n
\n
\n
\n

pagination

\n
\n

object

\n

Pagination metadata.

\n
\n
\n
\n
\n
\n

next_offset

\n
\n

int64

\n

The offset for the next page of results.

\n
\n \n
\n
\n
\n
\n
\n

offset

\n
\n

int64

\n

The current offset in the results.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

The number of results returned per page.

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

The NotificationRuleArray data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The notification rule's attributes.

\n
\n
\n
\n
\n
\n

conditions [required]

\n
\n

[object]

\n

The conditions that trigger this notification rule.

\n
\n
\n
\n
\n
\n

field [required]

\n
\n

string

\n

The incident field to evaluate

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The value(s) to compare against. Multiple values are ORed together.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created [required]

\n
\n

date-time

\n

Timestamp when the notification rule was created.

\n
\n \n
\n
\n
\n
\n
\n

enabled [required]

\n
\n

boolean

\n

Whether the notification rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

handles [required]

\n
\n

[string]

\n

The notification handles (targets) for this rule.

\n
\n \n
\n
\n
\n
\n
\n

modified [required]

\n
\n

date-time

\n

Timestamp when the notification rule was last modified.

\n
\n \n
\n
\n
\n
\n
\n

renotify_on

\n
\n

[string]

\n

List of incident fields that trigger re-notification when changed.

\n
\n \n
\n
\n
\n
\n
\n

trigger [required]

\n
\n

string

\n

The trigger event for this notification rule.

\n
\n \n
\n
\n
\n
\n
\n

visibility [required]

\n
\n

enum

\n

The visibility of the notification rule. \nAllowed enum values: all,organization,private

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the notification rule.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The notification rule's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

notification_template

\n
\n

object

\n

A relationship reference to a notification template.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The notification template relationship data.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification templates resource type. \nAllowed enum values: notification_templates

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification rules resource type. \nAllowed enum values: incident_notification_rules

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Related objects that are included in the response.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Incident type response data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident type's attributes.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

date-time

\n

Timestamp when the incident type was created.

\n
\n \n
\n
\n
\n
\n
\n

createdBy

\n
\n

string

\n

A unique identifier that represents the user that created the incident type.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Text that describes the incident type.

\n
\n \n
\n
\n
\n
\n
\n

is_default

\n
\n

boolean

\n

If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.

\n
\n \n
\n
\n
\n
\n
\n

lastModifiedBy

\n
\n

string

\n

A unique identifier that represents the user that last modified the incident type.

\n
\n \n
\n
\n
\n
\n
\n

modifiedAt

\n
\n

date-time

\n

Timestamp when the incident type was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the incident type.

\n
\n \n
\n
\n
\n
\n
\n

prefix

\n
\n

string

\n

The string that will be prepended to the incident title across the Datadog app.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident type's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

google_meet_configuration

\n
\n

object

\n

A reference to a Google Meet Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Google Meet configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

microsoft_teams_configuration

\n
\n

object

\n

A reference to a Microsoft Teams Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Microsoft Teams configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

zoom_configuration

\n
\n

object

\n

A reference to a Zoom configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Zoom configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

A notification template object for inclusion in other resources.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The notification template's attributes.

\n
\n
\n
\n
\n
\n

category [required]

\n
\n

string

\n

The category of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

content [required]

\n
\n

string

\n

The content body of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

created [required]

\n
\n

date-time

\n

Timestamp when the notification template was created.

\n
\n \n
\n
\n
\n
\n
\n

modified [required]

\n
\n

date-time

\n

Timestamp when the notification template was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

subject [required]

\n
\n

string

\n

The subject line of the notification template.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The notification template's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification templates resource type. \nAllowed enum values: notification_templates

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Response metadata.

\n
\n
\n
\n
\n
\n

pagination

\n
\n

object

\n

Pagination metadata.

\n
\n
\n
\n
\n
\n

next_offset

\n
\n

int64

\n

The offset for the next page of results.

\n
\n \n
\n
\n
\n
\n
\n

offset

\n
\n

int64

\n

The current offset in the results.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

The number of results returned per page.

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { @@ -656,6 +657,7 @@ "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", "mfa_enabled": false, "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", @@ -701,7 +703,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Notification rule data from a response.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The notification rule's attributes.

\n
\n
\n
\n
\n
\n

conditions [required]

\n
\n

[object]

\n

The conditions that trigger this notification rule.

\n
\n
\n
\n
\n
\n

field [required]

\n
\n

string

\n

The incident field to evaluate

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The value(s) to compare against. Multiple values are ORed together.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created [required]

\n
\n

date-time

\n

Timestamp when the notification rule was created.

\n
\n \n
\n
\n
\n
\n
\n

enabled [required]

\n
\n

boolean

\n

Whether the notification rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

handles [required]

\n
\n

[string]

\n

The notification handles (targets) for this rule.

\n
\n \n
\n
\n
\n
\n
\n

modified [required]

\n
\n

date-time

\n

Timestamp when the notification rule was last modified.

\n
\n \n
\n
\n
\n
\n
\n

renotify_on

\n
\n

[string]

\n

List of incident fields that trigger re-notification when changed.

\n
\n \n
\n
\n
\n
\n
\n

trigger [required]

\n
\n

string

\n

The trigger event for this notification rule.

\n
\n \n
\n
\n
\n
\n
\n

visibility [required]

\n
\n

enum

\n

The visibility of the notification rule. \nAllowed enum values: all,organization,private

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the notification rule.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The notification rule's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

notification_template

\n
\n

object

\n

A relationship reference to a notification template.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The notification template relationship data.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification templates resource type. \nAllowed enum values: notification_templates

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification rules resource type. \nAllowed enum values: incident_notification_rules

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Related objects that are included in the response.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Incident type response data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident type's attributes.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

date-time

\n

Timestamp when the incident type was created.

\n
\n \n
\n
\n
\n
\n
\n

createdBy

\n
\n

string

\n

A unique identifier that represents the user that created the incident type.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Text that describes the incident type.

\n
\n \n
\n
\n
\n
\n
\n

is_default

\n
\n

boolean

\n

If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.

\n
\n \n
\n
\n
\n
\n
\n

lastModifiedBy

\n
\n

string

\n

A unique identifier that represents the user that last modified the incident type.

\n
\n \n
\n
\n
\n
\n
\n

modifiedAt

\n
\n

date-time

\n

Timestamp when the incident type was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the incident type.

\n
\n \n
\n
\n
\n
\n
\n

prefix

\n
\n

string

\n

The string that will be prepended to the incident title across the Datadog app.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident type's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

google_meet_configuration

\n
\n

object

\n

A reference to a Google Meet Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Google Meet configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

microsoft_teams_configuration

\n
\n

object

\n

A reference to a Microsoft Teams Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Microsoft Teams configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

zoom_configuration

\n
\n

object

\n

A reference to a Zoom configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Zoom configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

A notification template object for inclusion in other resources.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The notification template's attributes.

\n
\n
\n
\n
\n
\n

category [required]

\n
\n

string

\n

The category of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

content [required]

\n
\n

string

\n

The content body of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

created [required]

\n
\n

date-time

\n

Timestamp when the notification template was created.

\n
\n \n
\n
\n
\n
\n
\n

modified [required]

\n
\n

date-time

\n

Timestamp when the notification template was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

subject [required]

\n
\n

string

\n

The subject line of the notification template.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The notification template's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification templates resource type. \nAllowed enum values: notification_templates

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Notification rule data from a response.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The notification rule's attributes.

\n
\n
\n
\n
\n
\n

conditions [required]

\n
\n

[object]

\n

The conditions that trigger this notification rule.

\n
\n
\n
\n
\n
\n

field [required]

\n
\n

string

\n

The incident field to evaluate

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The value(s) to compare against. Multiple values are ORed together.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created [required]

\n
\n

date-time

\n

Timestamp when the notification rule was created.

\n
\n \n
\n
\n
\n
\n
\n

enabled [required]

\n
\n

boolean

\n

Whether the notification rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

handles [required]

\n
\n

[string]

\n

The notification handles (targets) for this rule.

\n
\n \n
\n
\n
\n
\n
\n

modified [required]

\n
\n

date-time

\n

Timestamp when the notification rule was last modified.

\n
\n \n
\n
\n
\n
\n
\n

renotify_on

\n
\n

[string]

\n

List of incident fields that trigger re-notification when changed.

\n
\n \n
\n
\n
\n
\n
\n

trigger [required]

\n
\n

string

\n

The trigger event for this notification rule.

\n
\n \n
\n
\n
\n
\n
\n

visibility [required]

\n
\n

enum

\n

The visibility of the notification rule. \nAllowed enum values: all,organization,private

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the notification rule.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The notification rule's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

notification_template

\n
\n

object

\n

A relationship reference to a notification template.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The notification template relationship data.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification templates resource type. \nAllowed enum values: notification_templates

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification rules resource type. \nAllowed enum values: incident_notification_rules

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Related objects that are included in the response.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Incident type response data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident type's attributes.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

date-time

\n

Timestamp when the incident type was created.

\n
\n \n
\n
\n
\n
\n
\n

createdBy

\n
\n

string

\n

A unique identifier that represents the user that created the incident type.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Text that describes the incident type.

\n
\n \n
\n
\n
\n
\n
\n

is_default

\n
\n

boolean

\n

If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.

\n
\n \n
\n
\n
\n
\n
\n

lastModifiedBy

\n
\n

string

\n

A unique identifier that represents the user that last modified the incident type.

\n
\n \n
\n
\n
\n
\n
\n

modifiedAt

\n
\n

date-time

\n

Timestamp when the incident type was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the incident type.

\n
\n \n
\n
\n
\n
\n
\n

prefix

\n
\n

string

\n

The string that will be prepended to the incident title across the Datadog app.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident type's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

google_meet_configuration

\n
\n

object

\n

A reference to a Google Meet Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Google Meet configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

microsoft_teams_configuration

\n
\n

object

\n

A reference to a Microsoft Teams Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Microsoft Teams configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

zoom_configuration

\n
\n

object

\n

A reference to a Zoom configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Zoom configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

A notification template object for inclusion in other resources.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The notification template's attributes.

\n
\n
\n
\n
\n
\n

category [required]

\n
\n

string

\n

The category of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

content [required]

\n
\n

string

\n

The content body of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

created [required]

\n
\n

date-time

\n

Timestamp when the notification template was created.

\n
\n \n
\n
\n
\n
\n
\n

modified [required]

\n
\n

date-time

\n

Timestamp when the notification template was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

subject [required]

\n
\n

string

\n

The subject line of the notification template.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The notification template's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification templates resource type. \nAllowed enum values: notification_templates

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { @@ -939,6 +941,7 @@ "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", "mfa_enabled": false, "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", @@ -984,7 +987,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Notification rule data from a response.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The notification rule's attributes.

\n
\n
\n
\n
\n
\n

conditions [required]

\n
\n

[object]

\n

The conditions that trigger this notification rule.

\n
\n
\n
\n
\n
\n

field [required]

\n
\n

string

\n

The incident field to evaluate

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The value(s) to compare against. Multiple values are ORed together.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created [required]

\n
\n

date-time

\n

Timestamp when the notification rule was created.

\n
\n \n
\n
\n
\n
\n
\n

enabled [required]

\n
\n

boolean

\n

Whether the notification rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

handles [required]

\n
\n

[string]

\n

The notification handles (targets) for this rule.

\n
\n \n
\n
\n
\n
\n
\n

modified [required]

\n
\n

date-time

\n

Timestamp when the notification rule was last modified.

\n
\n \n
\n
\n
\n
\n
\n

renotify_on

\n
\n

[string]

\n

List of incident fields that trigger re-notification when changed.

\n
\n \n
\n
\n
\n
\n
\n

trigger [required]

\n
\n

string

\n

The trigger event for this notification rule.

\n
\n \n
\n
\n
\n
\n
\n

visibility [required]

\n
\n

enum

\n

The visibility of the notification rule. \nAllowed enum values: all,organization,private

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the notification rule.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The notification rule's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

notification_template

\n
\n

object

\n

A relationship reference to a notification template.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The notification template relationship data.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification templates resource type. \nAllowed enum values: notification_templates

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification rules resource type. \nAllowed enum values: incident_notification_rules

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Related objects that are included in the response.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Incident type response data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident type's attributes.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

date-time

\n

Timestamp when the incident type was created.

\n
\n \n
\n
\n
\n
\n
\n

createdBy

\n
\n

string

\n

A unique identifier that represents the user that created the incident type.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Text that describes the incident type.

\n
\n \n
\n
\n
\n
\n
\n

is_default

\n
\n

boolean

\n

If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.

\n
\n \n
\n
\n
\n
\n
\n

lastModifiedBy

\n
\n

string

\n

A unique identifier that represents the user that last modified the incident type.

\n
\n \n
\n
\n
\n
\n
\n

modifiedAt

\n
\n

date-time

\n

Timestamp when the incident type was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the incident type.

\n
\n \n
\n
\n
\n
\n
\n

prefix

\n
\n

string

\n

The string that will be prepended to the incident title across the Datadog app.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident type's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

google_meet_configuration

\n
\n

object

\n

A reference to a Google Meet Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Google Meet configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

microsoft_teams_configuration

\n
\n

object

\n

A reference to a Microsoft Teams Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Microsoft Teams configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

zoom_configuration

\n
\n

object

\n

A reference to a Zoom configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Zoom configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

A notification template object for inclusion in other resources.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The notification template's attributes.

\n
\n
\n
\n
\n
\n

category [required]

\n
\n

string

\n

The category of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

content [required]

\n
\n

string

\n

The content body of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

created [required]

\n
\n

date-time

\n

Timestamp when the notification template was created.

\n
\n \n
\n
\n
\n
\n
\n

modified [required]

\n
\n

date-time

\n

Timestamp when the notification template was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

subject [required]

\n
\n

string

\n

The subject line of the notification template.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The notification template's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification templates resource type. \nAllowed enum values: notification_templates

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Notification rule data from a response.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The notification rule's attributes.

\n
\n
\n
\n
\n
\n

conditions [required]

\n
\n

[object]

\n

The conditions that trigger this notification rule.

\n
\n
\n
\n
\n
\n

field [required]

\n
\n

string

\n

The incident field to evaluate

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The value(s) to compare against. Multiple values are ORed together.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created [required]

\n
\n

date-time

\n

Timestamp when the notification rule was created.

\n
\n \n
\n
\n
\n
\n
\n

enabled [required]

\n
\n

boolean

\n

Whether the notification rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

handles [required]

\n
\n

[string]

\n

The notification handles (targets) for this rule.

\n
\n \n
\n
\n
\n
\n
\n

modified [required]

\n
\n

date-time

\n

Timestamp when the notification rule was last modified.

\n
\n \n
\n
\n
\n
\n
\n

renotify_on

\n
\n

[string]

\n

List of incident fields that trigger re-notification when changed.

\n
\n \n
\n
\n
\n
\n
\n

trigger [required]

\n
\n

string

\n

The trigger event for this notification rule.

\n
\n \n
\n
\n
\n
\n
\n

visibility [required]

\n
\n

enum

\n

The visibility of the notification rule. \nAllowed enum values: all,organization,private

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the notification rule.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The notification rule's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

notification_template

\n
\n

object

\n

A relationship reference to a notification template.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The notification template relationship data.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification templates resource type. \nAllowed enum values: notification_templates

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification rules resource type. \nAllowed enum values: incident_notification_rules

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Related objects that are included in the response.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Incident type response data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident type's attributes.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

date-time

\n

Timestamp when the incident type was created.

\n
\n \n
\n
\n
\n
\n
\n

createdBy

\n
\n

string

\n

A unique identifier that represents the user that created the incident type.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Text that describes the incident type.

\n
\n \n
\n
\n
\n
\n
\n

is_default

\n
\n

boolean

\n

If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.

\n
\n \n
\n
\n
\n
\n
\n

lastModifiedBy

\n
\n

string

\n

A unique identifier that represents the user that last modified the incident type.

\n
\n \n
\n
\n
\n
\n
\n

modifiedAt

\n
\n

date-time

\n

Timestamp when the incident type was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the incident type.

\n
\n \n
\n
\n
\n
\n
\n

prefix

\n
\n

string

\n

The string that will be prepended to the incident title across the Datadog app.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident type's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

google_meet_configuration

\n
\n

object

\n

A reference to a Google Meet Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Google Meet configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

microsoft_teams_configuration

\n
\n

object

\n

A reference to a Microsoft Teams Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Microsoft Teams configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

zoom_configuration

\n
\n

object

\n

A reference to a Zoom configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Zoom configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

A notification template object for inclusion in other resources.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The notification template's attributes.

\n
\n
\n
\n
\n
\n

category [required]

\n
\n

string

\n

The category of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

content [required]

\n
\n

string

\n

The content body of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

created [required]

\n
\n

date-time

\n

Timestamp when the notification template was created.

\n
\n \n
\n
\n
\n
\n
\n

modified [required]

\n
\n

date-time

\n

Timestamp when the notification template was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

subject [required]

\n
\n

string

\n

The subject line of the notification template.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The notification template's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification templates resource type. \nAllowed enum values: notification_templates

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { @@ -1099,6 +1102,7 @@ "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", "mfa_enabled": false, "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", @@ -1144,7 +1148,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Notification rule data from a response.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The notification rule's attributes.

\n
\n
\n
\n
\n
\n

conditions [required]

\n
\n

[object]

\n

The conditions that trigger this notification rule.

\n
\n
\n
\n
\n
\n

field [required]

\n
\n

string

\n

The incident field to evaluate

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The value(s) to compare against. Multiple values are ORed together.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created [required]

\n
\n

date-time

\n

Timestamp when the notification rule was created.

\n
\n \n
\n
\n
\n
\n
\n

enabled [required]

\n
\n

boolean

\n

Whether the notification rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

handles [required]

\n
\n

[string]

\n

The notification handles (targets) for this rule.

\n
\n \n
\n
\n
\n
\n
\n

modified [required]

\n
\n

date-time

\n

Timestamp when the notification rule was last modified.

\n
\n \n
\n
\n
\n
\n
\n

renotify_on

\n
\n

[string]

\n

List of incident fields that trigger re-notification when changed.

\n
\n \n
\n
\n
\n
\n
\n

trigger [required]

\n
\n

string

\n

The trigger event for this notification rule.

\n
\n \n
\n
\n
\n
\n
\n

visibility [required]

\n
\n

enum

\n

The visibility of the notification rule. \nAllowed enum values: all,organization,private

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the notification rule.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The notification rule's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

notification_template

\n
\n

object

\n

A relationship reference to a notification template.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The notification template relationship data.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification templates resource type. \nAllowed enum values: notification_templates

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification rules resource type. \nAllowed enum values: incident_notification_rules

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Related objects that are included in the response.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Incident type response data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident type's attributes.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

date-time

\n

Timestamp when the incident type was created.

\n
\n \n
\n
\n
\n
\n
\n

createdBy

\n
\n

string

\n

A unique identifier that represents the user that created the incident type.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Text that describes the incident type.

\n
\n \n
\n
\n
\n
\n
\n

is_default

\n
\n

boolean

\n

If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.

\n
\n \n
\n
\n
\n
\n
\n

lastModifiedBy

\n
\n

string

\n

A unique identifier that represents the user that last modified the incident type.

\n
\n \n
\n
\n
\n
\n
\n

modifiedAt

\n
\n

date-time

\n

Timestamp when the incident type was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the incident type.

\n
\n \n
\n
\n
\n
\n
\n

prefix

\n
\n

string

\n

The string that will be prepended to the incident title across the Datadog app.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident type's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

google_meet_configuration

\n
\n

object

\n

A reference to a Google Meet Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Google Meet configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

microsoft_teams_configuration

\n
\n

object

\n

A reference to a Microsoft Teams Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Microsoft Teams configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

zoom_configuration

\n
\n

object

\n

A reference to a Zoom configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Zoom configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

A notification template object for inclusion in other resources.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The notification template's attributes.

\n
\n
\n
\n
\n
\n

category [required]

\n
\n

string

\n

The category of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

content [required]

\n
\n

string

\n

The content body of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

created [required]

\n
\n

date-time

\n

Timestamp when the notification template was created.

\n
\n \n
\n
\n
\n
\n
\n

modified [required]

\n
\n

date-time

\n

Timestamp when the notification template was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

subject [required]

\n
\n

string

\n

The subject line of the notification template.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The notification template's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification templates resource type. \nAllowed enum values: notification_templates

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Notification rule data from a response.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The notification rule's attributes.

\n
\n
\n
\n
\n
\n

conditions [required]

\n
\n

[object]

\n

The conditions that trigger this notification rule.

\n
\n
\n
\n
\n
\n

field [required]

\n
\n

string

\n

The incident field to evaluate

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The value(s) to compare against. Multiple values are ORed together.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created [required]

\n
\n

date-time

\n

Timestamp when the notification rule was created.

\n
\n \n
\n
\n
\n
\n
\n

enabled [required]

\n
\n

boolean

\n

Whether the notification rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

handles [required]

\n
\n

[string]

\n

The notification handles (targets) for this rule.

\n
\n \n
\n
\n
\n
\n
\n

modified [required]

\n
\n

date-time

\n

Timestamp when the notification rule was last modified.

\n
\n \n
\n
\n
\n
\n
\n

renotify_on

\n
\n

[string]

\n

List of incident fields that trigger re-notification when changed.

\n
\n \n
\n
\n
\n
\n
\n

trigger [required]

\n
\n

string

\n

The trigger event for this notification rule.

\n
\n \n
\n
\n
\n
\n
\n

visibility [required]

\n
\n

enum

\n

The visibility of the notification rule. \nAllowed enum values: all,organization,private

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the notification rule.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The notification rule's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

notification_template

\n
\n

object

\n

A relationship reference to a notification template.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The notification template relationship data.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification templates resource type. \nAllowed enum values: notification_templates

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification rules resource type. \nAllowed enum values: incident_notification_rules

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Related objects that are included in the response.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Incident type response data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident type's attributes.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

date-time

\n

Timestamp when the incident type was created.

\n
\n \n
\n
\n
\n
\n
\n

createdBy

\n
\n

string

\n

A unique identifier that represents the user that created the incident type.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Text that describes the incident type.

\n
\n \n
\n
\n
\n
\n
\n

is_default

\n
\n

boolean

\n

If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.

\n
\n \n
\n
\n
\n
\n
\n

lastModifiedBy

\n
\n

string

\n

A unique identifier that represents the user that last modified the incident type.

\n
\n \n
\n
\n
\n
\n
\n

modifiedAt

\n
\n

date-time

\n

Timestamp when the incident type was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the incident type.

\n
\n \n
\n
\n
\n
\n
\n

prefix

\n
\n

string

\n

The string that will be prepended to the incident title across the Datadog app.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident type's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

google_meet_configuration

\n
\n

object

\n

A reference to a Google Meet Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Google Meet configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

microsoft_teams_configuration

\n
\n

object

\n

A reference to a Microsoft Teams Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Microsoft Teams configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

zoom_configuration

\n
\n

object

\n

A reference to a Zoom configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Zoom configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

A notification template object for inclusion in other resources.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The notification template's attributes.

\n
\n
\n
\n
\n
\n

category [required]

\n
\n

string

\n

The category of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

content [required]

\n
\n

string

\n

The content body of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

created [required]

\n
\n

date-time

\n

Timestamp when the notification template was created.

\n
\n \n
\n
\n
\n
\n
\n

modified [required]

\n
\n

date-time

\n

Timestamp when the notification template was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

subject [required]

\n
\n

string

\n

The subject line of the notification template.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The notification template's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification templates resource type. \nAllowed enum values: notification_templates

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { @@ -1315,6 +1319,7 @@ "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", "mfa_enabled": false, "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", @@ -1366,7 +1371,7 @@ } } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

The NotificationTemplateArray data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The notification template's attributes.

\n
\n
\n
\n
\n
\n

category [required]

\n
\n

string

\n

The category of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

content [required]

\n
\n

string

\n

The content body of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

created [required]

\n
\n

date-time

\n

Timestamp when the notification template was created.

\n
\n \n
\n
\n
\n
\n
\n

modified [required]

\n
\n

date-time

\n

Timestamp when the notification template was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

subject [required]

\n
\n

string

\n

The subject line of the notification template.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The notification template's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification templates resource type. \nAllowed enum values: notification_templates

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Related objects that are included in the response.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Incident type response data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident type's attributes.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

date-time

\n

Timestamp when the incident type was created.

\n
\n \n
\n
\n
\n
\n
\n

createdBy

\n
\n

string

\n

A unique identifier that represents the user that created the incident type.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Text that describes the incident type.

\n
\n \n
\n
\n
\n
\n
\n

is_default

\n
\n

boolean

\n

If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.

\n
\n \n
\n
\n
\n
\n
\n

lastModifiedBy

\n
\n

string

\n

A unique identifier that represents the user that last modified the incident type.

\n
\n \n
\n
\n
\n
\n
\n

modifiedAt

\n
\n

date-time

\n

Timestamp when the incident type was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the incident type.

\n
\n \n
\n
\n
\n
\n
\n

prefix

\n
\n

string

\n

The string that will be prepended to the incident title across the Datadog app.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident type's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

google_meet_configuration

\n
\n

object

\n

A reference to a Google Meet Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Google Meet configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

microsoft_teams_configuration

\n
\n

object

\n

A reference to a Microsoft Teams Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Microsoft Teams configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

zoom_configuration

\n
\n

object

\n

A reference to a Zoom configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Zoom configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Response metadata.

\n
\n
\n
\n
\n
\n

page

\n
\n

object

\n

Pagination metadata.

\n
\n
\n
\n
\n
\n

total_count

\n
\n

int64

\n

Total number of notification templates.

\n
\n \n
\n
\n
\n
\n
\n

total_filtered_count

\n
\n

int64

\n

Total number of notification templates matching the filter.

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

The NotificationTemplateArray data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The notification template's attributes.

\n
\n
\n
\n
\n
\n

category [required]

\n
\n

string

\n

The category of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

content [required]

\n
\n

string

\n

The content body of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

created [required]

\n
\n

date-time

\n

Timestamp when the notification template was created.

\n
\n \n
\n
\n
\n
\n
\n

modified [required]

\n
\n

date-time

\n

Timestamp when the notification template was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

subject [required]

\n
\n

string

\n

The subject line of the notification template.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The notification template's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification templates resource type. \nAllowed enum values: notification_templates

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Related objects that are included in the response.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Incident type response data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident type's attributes.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

date-time

\n

Timestamp when the incident type was created.

\n
\n \n
\n
\n
\n
\n
\n

createdBy

\n
\n

string

\n

A unique identifier that represents the user that created the incident type.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Text that describes the incident type.

\n
\n \n
\n
\n
\n
\n
\n

is_default

\n
\n

boolean

\n

If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.

\n
\n \n
\n
\n
\n
\n
\n

lastModifiedBy

\n
\n

string

\n

A unique identifier that represents the user that last modified the incident type.

\n
\n \n
\n
\n
\n
\n
\n

modifiedAt

\n
\n

date-time

\n

Timestamp when the incident type was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the incident type.

\n
\n \n
\n
\n
\n
\n
\n

prefix

\n
\n

string

\n

The string that will be prepended to the incident title across the Datadog app.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident type's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

google_meet_configuration

\n
\n

object

\n

A reference to a Google Meet Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Google Meet configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

microsoft_teams_configuration

\n
\n

object

\n

A reference to a Microsoft Teams Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Microsoft Teams configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

zoom_configuration

\n
\n

object

\n

A reference to a Zoom configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Zoom configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Response metadata.

\n
\n
\n
\n
\n
\n

page

\n
\n

object

\n

Pagination metadata.

\n
\n
\n
\n
\n
\n

total_count

\n
\n

int64

\n

Total number of notification templates.

\n
\n \n
\n
\n
\n
\n
\n

total_filtered_count

\n
\n

int64

\n

Total number of notification templates matching the filter.

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { @@ -1459,6 +1464,7 @@ "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", "mfa_enabled": false, "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", @@ -1504,7 +1510,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Notification template data from a response.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The notification template's attributes.

\n
\n
\n
\n
\n
\n

category [required]

\n
\n

string

\n

The category of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

content [required]

\n
\n

string

\n

The content body of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

created [required]

\n
\n

date-time

\n

Timestamp when the notification template was created.

\n
\n \n
\n
\n
\n
\n
\n

modified [required]

\n
\n

date-time

\n

Timestamp when the notification template was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

subject [required]

\n
\n

string

\n

The subject line of the notification template.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The notification template's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification templates resource type. \nAllowed enum values: notification_templates

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Related objects that are included in the response.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Incident type response data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident type's attributes.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

date-time

\n

Timestamp when the incident type was created.

\n
\n \n
\n
\n
\n
\n
\n

createdBy

\n
\n

string

\n

A unique identifier that represents the user that created the incident type.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Text that describes the incident type.

\n
\n \n
\n
\n
\n
\n
\n

is_default

\n
\n

boolean

\n

If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.

\n
\n \n
\n
\n
\n
\n
\n

lastModifiedBy

\n
\n

string

\n

A unique identifier that represents the user that last modified the incident type.

\n
\n \n
\n
\n
\n
\n
\n

modifiedAt

\n
\n

date-time

\n

Timestamp when the incident type was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the incident type.

\n
\n \n
\n
\n
\n
\n
\n

prefix

\n
\n

string

\n

The string that will be prepended to the incident title across the Datadog app.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident type's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

google_meet_configuration

\n
\n

object

\n

A reference to a Google Meet Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Google Meet configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

microsoft_teams_configuration

\n
\n

object

\n

A reference to a Microsoft Teams Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Microsoft Teams configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

zoom_configuration

\n
\n

object

\n

A reference to a Zoom configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Zoom configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Notification template data from a response.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The notification template's attributes.

\n
\n
\n
\n
\n
\n

category [required]

\n
\n

string

\n

The category of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

content [required]

\n
\n

string

\n

The content body of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

created [required]

\n
\n

date-time

\n

Timestamp when the notification template was created.

\n
\n \n
\n
\n
\n
\n
\n

modified [required]

\n
\n

date-time

\n

Timestamp when the notification template was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

subject [required]

\n
\n

string

\n

The subject line of the notification template.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The notification template's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification templates resource type. \nAllowed enum values: notification_templates

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Related objects that are included in the response.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Incident type response data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident type's attributes.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

date-time

\n

Timestamp when the incident type was created.

\n
\n \n
\n
\n
\n
\n
\n

createdBy

\n
\n

string

\n

A unique identifier that represents the user that created the incident type.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Text that describes the incident type.

\n
\n \n
\n
\n
\n
\n
\n

is_default

\n
\n

boolean

\n

If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.

\n
\n \n
\n
\n
\n
\n
\n

lastModifiedBy

\n
\n

string

\n

A unique identifier that represents the user that last modified the incident type.

\n
\n \n
\n
\n
\n
\n
\n

modifiedAt

\n
\n

date-time

\n

Timestamp when the incident type was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the incident type.

\n
\n \n
\n
\n
\n
\n
\n

prefix

\n
\n

string

\n

The string that will be prepended to the incident title across the Datadog app.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident type's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

google_meet_configuration

\n
\n

object

\n

A reference to a Google Meet Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Google Meet configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

microsoft_teams_configuration

\n
\n

object

\n

A reference to a Microsoft Teams Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Microsoft Teams configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

zoom_configuration

\n
\n

object

\n

A reference to a Zoom configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Zoom configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { @@ -1682,6 +1688,7 @@ "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", "mfa_enabled": false, "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", @@ -1727,7 +1734,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Notification template data from a response.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The notification template's attributes.

\n
\n
\n
\n
\n
\n

category [required]

\n
\n

string

\n

The category of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

content [required]

\n
\n

string

\n

The content body of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

created [required]

\n
\n

date-time

\n

Timestamp when the notification template was created.

\n
\n \n
\n
\n
\n
\n
\n

modified [required]

\n
\n

date-time

\n

Timestamp when the notification template was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

subject [required]

\n
\n

string

\n

The subject line of the notification template.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The notification template's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification templates resource type. \nAllowed enum values: notification_templates

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Related objects that are included in the response.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Incident type response data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident type's attributes.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

date-time

\n

Timestamp when the incident type was created.

\n
\n \n
\n
\n
\n
\n
\n

createdBy

\n
\n

string

\n

A unique identifier that represents the user that created the incident type.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Text that describes the incident type.

\n
\n \n
\n
\n
\n
\n
\n

is_default

\n
\n

boolean

\n

If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.

\n
\n \n
\n
\n
\n
\n
\n

lastModifiedBy

\n
\n

string

\n

A unique identifier that represents the user that last modified the incident type.

\n
\n \n
\n
\n
\n
\n
\n

modifiedAt

\n
\n

date-time

\n

Timestamp when the incident type was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the incident type.

\n
\n \n
\n
\n
\n
\n
\n

prefix

\n
\n

string

\n

The string that will be prepended to the incident title across the Datadog app.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident type's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

google_meet_configuration

\n
\n

object

\n

A reference to a Google Meet Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Google Meet configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

microsoft_teams_configuration

\n
\n

object

\n

A reference to a Microsoft Teams Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Microsoft Teams configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

zoom_configuration

\n
\n

object

\n

A reference to a Zoom configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Zoom configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Notification template data from a response.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The notification template's attributes.

\n
\n
\n
\n
\n
\n

category [required]

\n
\n

string

\n

The category of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

content [required]

\n
\n

string

\n

The content body of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

created [required]

\n
\n

date-time

\n

Timestamp when the notification template was created.

\n
\n \n
\n
\n
\n
\n
\n

modified [required]

\n
\n

date-time

\n

Timestamp when the notification template was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

subject [required]

\n
\n

string

\n

The subject line of the notification template.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The notification template's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification templates resource type. \nAllowed enum values: notification_templates

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Related objects that are included in the response.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Incident type response data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident type's attributes.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

date-time

\n

Timestamp when the incident type was created.

\n
\n \n
\n
\n
\n
\n
\n

createdBy

\n
\n

string

\n

A unique identifier that represents the user that created the incident type.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Text that describes the incident type.

\n
\n \n
\n
\n
\n
\n
\n

is_default

\n
\n

boolean

\n

If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.

\n
\n \n
\n
\n
\n
\n
\n

lastModifiedBy

\n
\n

string

\n

A unique identifier that represents the user that last modified the incident type.

\n
\n \n
\n
\n
\n
\n
\n

modifiedAt

\n
\n

date-time

\n

Timestamp when the incident type was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the incident type.

\n
\n \n
\n
\n
\n
\n
\n

prefix

\n
\n

string

\n

The string that will be prepended to the incident title across the Datadog app.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident type's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

google_meet_configuration

\n
\n

object

\n

A reference to a Google Meet Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Google Meet configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

microsoft_teams_configuration

\n
\n

object

\n

A reference to a Microsoft Teams Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Microsoft Teams configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

zoom_configuration

\n
\n

object

\n

A reference to a Zoom configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Zoom configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { @@ -1820,6 +1827,7 @@ "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", "mfa_enabled": false, "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", @@ -1865,7 +1873,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Notification template data from a response.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The notification template's attributes.

\n
\n
\n
\n
\n
\n

category [required]

\n
\n

string

\n

The category of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

content [required]

\n
\n

string

\n

The content body of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

created [required]

\n
\n

date-time

\n

Timestamp when the notification template was created.

\n
\n \n
\n
\n
\n
\n
\n

modified [required]

\n
\n

date-time

\n

Timestamp when the notification template was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

subject [required]

\n
\n

string

\n

The subject line of the notification template.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The notification template's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification templates resource type. \nAllowed enum values: notification_templates

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Related objects that are included in the response.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Incident type response data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident type's attributes.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

date-time

\n

Timestamp when the incident type was created.

\n
\n \n
\n
\n
\n
\n
\n

createdBy

\n
\n

string

\n

A unique identifier that represents the user that created the incident type.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Text that describes the incident type.

\n
\n \n
\n
\n
\n
\n
\n

is_default

\n
\n

boolean

\n

If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.

\n
\n \n
\n
\n
\n
\n
\n

lastModifiedBy

\n
\n

string

\n

A unique identifier that represents the user that last modified the incident type.

\n
\n \n
\n
\n
\n
\n
\n

modifiedAt

\n
\n

date-time

\n

Timestamp when the incident type was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the incident type.

\n
\n \n
\n
\n
\n
\n
\n

prefix

\n
\n

string

\n

The string that will be prepended to the incident title across the Datadog app.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident type's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

google_meet_configuration

\n
\n

object

\n

A reference to a Google Meet Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Google Meet configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

microsoft_teams_configuration

\n
\n

object

\n

A reference to a Microsoft Teams Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Microsoft Teams configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

zoom_configuration

\n
\n

object

\n

A reference to a Zoom configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Zoom configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Notification template data from a response.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The notification template's attributes.

\n
\n
\n
\n
\n
\n

category [required]

\n
\n

string

\n

The category of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

content [required]

\n
\n

string

\n

The content body of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

created [required]

\n
\n

date-time

\n

Timestamp when the notification template was created.

\n
\n \n
\n
\n
\n
\n
\n

modified [required]

\n
\n

date-time

\n

Timestamp when the notification template was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

subject [required]

\n
\n

string

\n

The subject line of the notification template.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The unique identifier of the notification template.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The notification template's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

incident_type

\n
\n

object

\n

Relationship to an incident type.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to incident type object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Notification templates resource type. \nAllowed enum values: notification_templates

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Related objects that are included in the response.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Incident type response data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident type's attributes.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

date-time

\n

Timestamp when the incident type was created.

\n
\n \n
\n
\n
\n
\n
\n

createdBy

\n
\n

string

\n

A unique identifier that represents the user that created the incident type.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Text that describes the incident type.

\n
\n \n
\n
\n
\n
\n
\n

is_default

\n
\n

boolean

\n

If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.

\n
\n \n
\n
\n
\n
\n
\n

lastModifiedBy

\n
\n

string

\n

A unique identifier that represents the user that last modified the incident type.

\n
\n \n
\n
\n
\n
\n
\n

modifiedAt

\n
\n

date-time

\n

Timestamp when the incident type was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the incident type.

\n
\n \n
\n
\n
\n
\n
\n

prefix

\n
\n

string

\n

The string that will be prepended to the incident title across the Datadog app.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident type's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident type's resource relationships.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

google_meet_configuration

\n
\n

object

\n

A reference to a Google Meet Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Google Meet configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Google Meet configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

microsoft_teams_configuration

\n
\n

object

\n

A reference to a Microsoft Teams Configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Microsoft Teams configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Microsoft Teams configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

zoom_configuration

\n
\n

object

\n

A reference to a Zoom configuration resource.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The Zoom configuration relationship data object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the Zoom configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Incident type resource type. \nAllowed enum values: incident_types

default: incident_types

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { @@ -3210,6 +3218,7 @@ "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", "mfa_enabled": false, "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", @@ -3255,7 +3264,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of incident attachments.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

 <oneOf>

\n

The attributes object for an attachment.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

The attributes object for a postmortem attachment.

\n
\n
\n
\n
\n
\n

attachment [required]

\n
\n

object

\n

The postmortem attachment.

\n
\n
\n
\n
\n
\n

documentUrl [required]

\n
\n

string

\n

The URL of this notebook attachment.

\n
\n \n
\n
\n
\n
\n
\n

title [required]

\n
\n

string

\n

The title of this postmortem attachment.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

attachment_type [required]

\n
\n

enum

\n

The type of postmortem attachment attributes. \nAllowed enum values: postmortem

default: postmortem

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

The attributes object for a link attachment.

\n
\n
\n
\n
\n
\n

attachment [required]

\n
\n

object

\n

The link attachment.

\n
\n
\n
\n
\n
\n

documentUrl [required]

\n
\n

string

\n

The URL of this link attachment.

\n
\n \n
\n
\n
\n
\n
\n

title [required]

\n
\n

string

\n

The title of this link attachment.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

attachment_type [required]

\n
\n

enum

\n

The type of link attachment attributes. \nAllowed enum values: link

default: link

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the incident attachment link was last modified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the incident attachment.

\n
\n \n
\n
\n
\n
\n
\n

relationships [required]

\n
\n

object

\n

The incident attachment's relationships.

\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident attachment resource type. \nAllowed enum values: incident_attachments

default: incident_attachments

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Included related resources that the user requested.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of incident attachments.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

 <oneOf>

\n

The attributes object for an attachment.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

The attributes object for a postmortem attachment.

\n
\n
\n
\n
\n
\n

attachment [required]

\n
\n

object

\n

The postmortem attachment.

\n
\n
\n
\n
\n
\n

documentUrl [required]

\n
\n

string

\n

The URL of this notebook attachment.

\n
\n \n
\n
\n
\n
\n
\n

title [required]

\n
\n

string

\n

The title of this postmortem attachment.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

attachment_type [required]

\n
\n

enum

\n

The type of postmortem attachment attributes. \nAllowed enum values: postmortem

default: postmortem

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

The attributes object for a link attachment.

\n
\n
\n
\n
\n
\n

attachment [required]

\n
\n

object

\n

The link attachment.

\n
\n
\n
\n
\n
\n

documentUrl [required]

\n
\n

string

\n

The URL of this link attachment.

\n
\n \n
\n
\n
\n
\n
\n

title [required]

\n
\n

string

\n

The title of this link attachment.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

attachment_type [required]

\n
\n

enum

\n

The type of link attachment attributes. \nAllowed enum values: link

default: link

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the incident attachment link was last modified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the incident attachment.

\n
\n \n
\n
\n
\n
\n
\n

relationships [required]

\n
\n

object

\n

The incident attachment's relationships.

\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident attachment resource type. \nAllowed enum values: incident_attachments

default: incident_attachments

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Included related resources that the user requested.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { @@ -3337,6 +3346,7 @@ "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", "mfa_enabled": false, "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", @@ -3382,7 +3392,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of incident attachments. Only the attachments that were created or updated by the request are\nreturned.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

 <oneOf>

\n

The attributes object for an attachment.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

The attributes object for a postmortem attachment.

\n
\n
\n
\n
\n
\n

attachment [required]

\n
\n

object

\n

The postmortem attachment.

\n
\n
\n
\n
\n
\n

documentUrl [required]

\n
\n

string

\n

The URL of this notebook attachment.

\n
\n \n
\n
\n
\n
\n
\n

title [required]

\n
\n

string

\n

The title of this postmortem attachment.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

attachment_type [required]

\n
\n

enum

\n

The type of postmortem attachment attributes. \nAllowed enum values: postmortem

default: postmortem

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

The attributes object for a link attachment.

\n
\n
\n
\n
\n
\n

attachment [required]

\n
\n

object

\n

The link attachment.

\n
\n
\n
\n
\n
\n

documentUrl [required]

\n
\n

string

\n

The URL of this link attachment.

\n
\n \n
\n
\n
\n
\n
\n

title [required]

\n
\n

string

\n

The title of this link attachment.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

attachment_type [required]

\n
\n

enum

\n

The type of link attachment attributes. \nAllowed enum values: link

default: link

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the incident attachment link was last modified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the incident attachment.

\n
\n \n
\n
\n
\n
\n
\n

relationships [required]

\n
\n

object

\n

The incident attachment's relationships.

\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident attachment resource type. \nAllowed enum values: incident_attachments

default: incident_attachments

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Included related resources that the user requested.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of incident attachments. Only the attachments that were created or updated by the request are\nreturned.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

 <oneOf>

\n

The attributes object for an attachment.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

The attributes object for a postmortem attachment.

\n
\n
\n
\n
\n
\n

attachment [required]

\n
\n

object

\n

The postmortem attachment.

\n
\n
\n
\n
\n
\n

documentUrl [required]

\n
\n

string

\n

The URL of this notebook attachment.

\n
\n \n
\n
\n
\n
\n
\n

title [required]

\n
\n

string

\n

The title of this postmortem attachment.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

attachment_type [required]

\n
\n

enum

\n

The type of postmortem attachment attributes. \nAllowed enum values: postmortem

default: postmortem

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

The attributes object for a link attachment.

\n
\n
\n
\n
\n
\n

attachment [required]

\n
\n

object

\n

The link attachment.

\n
\n
\n
\n
\n
\n

documentUrl [required]

\n
\n

string

\n

The URL of this link attachment.

\n
\n \n
\n
\n
\n
\n
\n

title [required]

\n
\n

string

\n

The title of this link attachment.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

attachment_type [required]

\n
\n

enum

\n

The type of link attachment attributes. \nAllowed enum values: link

default: link

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the incident attachment link was last modified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the incident attachment.

\n
\n \n
\n
\n
\n
\n
\n

relationships [required]

\n
\n

object

\n

The incident attachment's relationships.

\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The incident attachment resource type. \nAllowed enum values: incident_attachments

default: incident_attachments

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Included related resources that the user requested.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { @@ -3779,6 +3789,7 @@ "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", "mfa_enabled": false, "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", @@ -3831,7 +3842,7 @@ } } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of incident integration metadata.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident integration metadata's attributes for a create request.

\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp when the incident todo was created.

\n
\n \n
\n
\n
\n
\n
\n

incident_id

\n
\n

string

\n

UUID of the incident this integration metadata is connected to.

\n
\n \n
\n
\n
\n
\n
\n

integration_type [required]

\n
\n

int32

\n

A number indicating the type of integration this metadata is for. 1 indicates Slack;\n8 indicates Jira.

\n
\n \n
\n
\n
\n
\n
\n

metadata [required]

\n
\n

 <oneOf>

\n

Incident integration metadata's metadata attribute.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Incident integration metadata for the Slack integration.

\n
\n
\n
\n
\n
\n

channels [required]

\n
\n

[object]

\n

Array of Slack channels in this integration metadata.

\n
\n
\n
\n
\n
\n

channel_id [required]

\n
\n

string

\n

Slack channel ID.

\n
\n \n
\n
\n
\n
\n
\n

channel_name [required]

\n
\n

string

\n

Name of the Slack channel.

\n
\n \n
\n
\n
\n
\n
\n

redirect_url [required]

\n
\n

string

\n

URL redirecting to the Slack channel.

\n
\n \n
\n
\n
\n
\n
\n

team_id

\n
\n

string

\n

Slack team ID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Incident integration metadata for the Jira integration.

\n
\n
\n
\n
\n
\n

issues [required]

\n
\n

[object]

\n

Array of Jira issues in this integration metadata.

\n
\n
\n
\n
\n
\n

account [required]

\n
\n

string

\n

URL of issue's Jira account.

\n
\n \n
\n
\n
\n
\n
\n

issue_key

\n
\n

string

\n

Jira issue's issue key.

\n
\n \n
\n
\n
\n
\n
\n

issuetype_id

\n
\n

string

\n

Jira issue's issue type.

\n
\n \n
\n
\n
\n
\n
\n

project_key [required]

\n
\n

string

\n

Jira issue's project keys.

\n
\n \n
\n
\n
\n
\n
\n

redirect_url

\n
\n

string

\n

URL redirecting to the Jira issue.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Incident integration metadata for the Microsoft Teams integration.

\n
\n
\n
\n
\n
\n

teams [required]

\n
\n

[object]

\n

Array of Microsoft Teams in this integration metadata.

\n
\n
\n
\n
\n
\n

ms_channel_id [required]

\n
\n

string

\n

Microsoft Teams channel ID.

\n
\n \n
\n
\n
\n
\n
\n

ms_channel_name [required]

\n
\n

string

\n

Microsoft Teams channel name.

\n
\n \n
\n
\n
\n
\n
\n

ms_tenant_id [required]

\n
\n

string

\n

Microsoft Teams tenant ID.

\n
\n \n
\n
\n
\n
\n
\n

redirect_url [required]

\n
\n

string

\n

URL redirecting to the Microsoft Teams channel.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the incident todo was last modified.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

int32

\n

A number indicating the status of this integration metadata. 0 indicates unknown;\n1 indicates pending; 2 indicates complete; 3 indicates manually created;\n4 indicates manually updated; 5 indicates failed.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident integration metadata's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident's integration relationships from a response.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Integration metadata resource type. \nAllowed enum values: incident_integrations

default: incident_integrations

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Included related resources that the user requested.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

The metadata object containing pagination metadata.

\n
\n
\n
\n
\n
\n

pagination

\n
\n

object

\n

Pagination properties.

\n
\n
\n
\n
\n
\n

next_offset

\n
\n

int64

\n

The index of the first element in the next page of results. Equal to page size added to the current offset.

\n
\n \n
\n
\n
\n
\n
\n

offset

\n
\n

int64

\n

The index of the first element in the results.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

Maximum size of pages to return.

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of incident integration metadata.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident integration metadata's attributes for a create request.

\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp when the incident todo was created.

\n
\n \n
\n
\n
\n
\n
\n

incident_id

\n
\n

string

\n

UUID of the incident this integration metadata is connected to.

\n
\n \n
\n
\n
\n
\n
\n

integration_type [required]

\n
\n

int32

\n

A number indicating the type of integration this metadata is for. 1 indicates Slack;\n8 indicates Jira.

\n
\n \n
\n
\n
\n
\n
\n

metadata [required]

\n
\n

 <oneOf>

\n

Incident integration metadata's metadata attribute.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Incident integration metadata for the Slack integration.

\n
\n
\n
\n
\n
\n

channels [required]

\n
\n

[object]

\n

Array of Slack channels in this integration metadata.

\n
\n
\n
\n
\n
\n

channel_id [required]

\n
\n

string

\n

Slack channel ID.

\n
\n \n
\n
\n
\n
\n
\n

channel_name [required]

\n
\n

string

\n

Name of the Slack channel.

\n
\n \n
\n
\n
\n
\n
\n

redirect_url [required]

\n
\n

string

\n

URL redirecting to the Slack channel.

\n
\n \n
\n
\n
\n
\n
\n

team_id

\n
\n

string

\n

Slack team ID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Incident integration metadata for the Jira integration.

\n
\n
\n
\n
\n
\n

issues [required]

\n
\n

[object]

\n

Array of Jira issues in this integration metadata.

\n
\n
\n
\n
\n
\n

account [required]

\n
\n

string

\n

URL of issue's Jira account.

\n
\n \n
\n
\n
\n
\n
\n

issue_key

\n
\n

string

\n

Jira issue's issue key.

\n
\n \n
\n
\n
\n
\n
\n

issuetype_id

\n
\n

string

\n

Jira issue's issue type.

\n
\n \n
\n
\n
\n
\n
\n

project_key [required]

\n
\n

string

\n

Jira issue's project keys.

\n
\n \n
\n
\n
\n
\n
\n

redirect_url

\n
\n

string

\n

URL redirecting to the Jira issue.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Incident integration metadata for the Microsoft Teams integration.

\n
\n
\n
\n
\n
\n

teams [required]

\n
\n

[object]

\n

Array of Microsoft Teams in this integration metadata.

\n
\n
\n
\n
\n
\n

ms_channel_id [required]

\n
\n

string

\n

Microsoft Teams channel ID.

\n
\n \n
\n
\n
\n
\n
\n

ms_channel_name [required]

\n
\n

string

\n

Microsoft Teams channel name.

\n
\n \n
\n
\n
\n
\n
\n

ms_tenant_id [required]

\n
\n

string

\n

Microsoft Teams tenant ID.

\n
\n \n
\n
\n
\n
\n
\n

redirect_url [required]

\n
\n

string

\n

URL redirecting to the Microsoft Teams channel.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the incident todo was last modified.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

int32

\n

A number indicating the status of this integration metadata. 0 indicates unknown;\n1 indicates pending; 2 indicates complete; 3 indicates manually created;\n4 indicates manually updated; 5 indicates failed.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident integration metadata's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident's integration relationships from a response.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Integration metadata resource type. \nAllowed enum values: incident_integrations

default: incident_integrations

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Included related resources that the user requested.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

The metadata object containing pagination metadata.

\n
\n
\n
\n
\n
\n

pagination

\n
\n

object

\n

Pagination properties.

\n
\n
\n
\n
\n
\n

next_offset

\n
\n

int64

\n

The index of the first element in the next page of results. Equal to page size added to the current offset.

\n
\n \n
\n
\n
\n
\n
\n

offset

\n
\n

int64

\n

The index of the first element in the results.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

Maximum size of pages to return.

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { @@ -3927,6 +3938,7 @@ "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", "mfa_enabled": false, "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", @@ -3972,7 +3984,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident integration metadata from a response.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident integration metadata's attributes for a create request.

\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp when the incident todo was created.

\n
\n \n
\n
\n
\n
\n
\n

incident_id

\n
\n

string

\n

UUID of the incident this integration metadata is connected to.

\n
\n \n
\n
\n
\n
\n
\n

integration_type [required]

\n
\n

int32

\n

A number indicating the type of integration this metadata is for. 1 indicates Slack;\n8 indicates Jira.

\n
\n \n
\n
\n
\n
\n
\n

metadata [required]

\n
\n

 <oneOf>

\n

Incident integration metadata's metadata attribute.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Incident integration metadata for the Slack integration.

\n
\n
\n
\n
\n
\n

channels [required]

\n
\n

[object]

\n

Array of Slack channels in this integration metadata.

\n
\n
\n
\n
\n
\n

channel_id [required]

\n
\n

string

\n

Slack channel ID.

\n
\n \n
\n
\n
\n
\n
\n

channel_name [required]

\n
\n

string

\n

Name of the Slack channel.

\n
\n \n
\n
\n
\n
\n
\n

redirect_url [required]

\n
\n

string

\n

URL redirecting to the Slack channel.

\n
\n \n
\n
\n
\n
\n
\n

team_id

\n
\n

string

\n

Slack team ID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Incident integration metadata for the Jira integration.

\n
\n
\n
\n
\n
\n

issues [required]

\n
\n

[object]

\n

Array of Jira issues in this integration metadata.

\n
\n
\n
\n
\n
\n

account [required]

\n
\n

string

\n

URL of issue's Jira account.

\n
\n \n
\n
\n
\n
\n
\n

issue_key

\n
\n

string

\n

Jira issue's issue key.

\n
\n \n
\n
\n
\n
\n
\n

issuetype_id

\n
\n

string

\n

Jira issue's issue type.

\n
\n \n
\n
\n
\n
\n
\n

project_key [required]

\n
\n

string

\n

Jira issue's project keys.

\n
\n \n
\n
\n
\n
\n
\n

redirect_url

\n
\n

string

\n

URL redirecting to the Jira issue.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Incident integration metadata for the Microsoft Teams integration.

\n
\n
\n
\n
\n
\n

teams [required]

\n
\n

[object]

\n

Array of Microsoft Teams in this integration metadata.

\n
\n
\n
\n
\n
\n

ms_channel_id [required]

\n
\n

string

\n

Microsoft Teams channel ID.

\n
\n \n
\n
\n
\n
\n
\n

ms_channel_name [required]

\n
\n

string

\n

Microsoft Teams channel name.

\n
\n \n
\n
\n
\n
\n
\n

ms_tenant_id [required]

\n
\n

string

\n

Microsoft Teams tenant ID.

\n
\n \n
\n
\n
\n
\n
\n

redirect_url [required]

\n
\n

string

\n

URL redirecting to the Microsoft Teams channel.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the incident todo was last modified.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

int32

\n

A number indicating the status of this integration metadata. 0 indicates unknown;\n1 indicates pending; 2 indicates complete; 3 indicates manually created;\n4 indicates manually updated; 5 indicates failed.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident integration metadata's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident's integration relationships from a response.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Integration metadata resource type. \nAllowed enum values: incident_integrations

default: incident_integrations

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Included related resources that the user requested.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident integration metadata from a response.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident integration metadata's attributes for a create request.

\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp when the incident todo was created.

\n
\n \n
\n
\n
\n
\n
\n

incident_id

\n
\n

string

\n

UUID of the incident this integration metadata is connected to.

\n
\n \n
\n
\n
\n
\n
\n

integration_type [required]

\n
\n

int32

\n

A number indicating the type of integration this metadata is for. 1 indicates Slack;\n8 indicates Jira.

\n
\n \n
\n
\n
\n
\n
\n

metadata [required]

\n
\n

 <oneOf>

\n

Incident integration metadata's metadata attribute.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Incident integration metadata for the Slack integration.

\n
\n
\n
\n
\n
\n

channels [required]

\n
\n

[object]

\n

Array of Slack channels in this integration metadata.

\n
\n
\n
\n
\n
\n

channel_id [required]

\n
\n

string

\n

Slack channel ID.

\n
\n \n
\n
\n
\n
\n
\n

channel_name [required]

\n
\n

string

\n

Name of the Slack channel.

\n
\n \n
\n
\n
\n
\n
\n

redirect_url [required]

\n
\n

string

\n

URL redirecting to the Slack channel.

\n
\n \n
\n
\n
\n
\n
\n

team_id

\n
\n

string

\n

Slack team ID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Incident integration metadata for the Jira integration.

\n
\n
\n
\n
\n
\n

issues [required]

\n
\n

[object]

\n

Array of Jira issues in this integration metadata.

\n
\n
\n
\n
\n
\n

account [required]

\n
\n

string

\n

URL of issue's Jira account.

\n
\n \n
\n
\n
\n
\n
\n

issue_key

\n
\n

string

\n

Jira issue's issue key.

\n
\n \n
\n
\n
\n
\n
\n

issuetype_id

\n
\n

string

\n

Jira issue's issue type.

\n
\n \n
\n
\n
\n
\n
\n

project_key [required]

\n
\n

string

\n

Jira issue's project keys.

\n
\n \n
\n
\n
\n
\n
\n

redirect_url

\n
\n

string

\n

URL redirecting to the Jira issue.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Incident integration metadata for the Microsoft Teams integration.

\n
\n
\n
\n
\n
\n

teams [required]

\n
\n

[object]

\n

Array of Microsoft Teams in this integration metadata.

\n
\n
\n
\n
\n
\n

ms_channel_id [required]

\n
\n

string

\n

Microsoft Teams channel ID.

\n
\n \n
\n
\n
\n
\n
\n

ms_channel_name [required]

\n
\n

string

\n

Microsoft Teams channel name.

\n
\n \n
\n
\n
\n
\n
\n

ms_tenant_id [required]

\n
\n

string

\n

Microsoft Teams tenant ID.

\n
\n \n
\n
\n
\n
\n
\n

redirect_url [required]

\n
\n

string

\n

URL redirecting to the Microsoft Teams channel.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the incident todo was last modified.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

int32

\n

A number indicating the status of this integration metadata. 0 indicates unknown;\n1 indicates pending; 2 indicates complete; 3 indicates manually created;\n4 indicates manually updated; 5 indicates failed.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident integration metadata's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident's integration relationships from a response.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Integration metadata resource type. \nAllowed enum values: incident_integrations

default: incident_integrations

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Included related resources that the user requested.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { @@ -4152,6 +4164,7 @@ "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", "mfa_enabled": false, "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", @@ -4197,7 +4210,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident integration metadata from a response.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident integration metadata's attributes for a create request.

\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp when the incident todo was created.

\n
\n \n
\n
\n
\n
\n
\n

incident_id

\n
\n

string

\n

UUID of the incident this integration metadata is connected to.

\n
\n \n
\n
\n
\n
\n
\n

integration_type [required]

\n
\n

int32

\n

A number indicating the type of integration this metadata is for. 1 indicates Slack;\n8 indicates Jira.

\n
\n \n
\n
\n
\n
\n
\n

metadata [required]

\n
\n

 <oneOf>

\n

Incident integration metadata's metadata attribute.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Incident integration metadata for the Slack integration.

\n
\n
\n
\n
\n
\n

channels [required]

\n
\n

[object]

\n

Array of Slack channels in this integration metadata.

\n
\n
\n
\n
\n
\n

channel_id [required]

\n
\n

string

\n

Slack channel ID.

\n
\n \n
\n
\n
\n
\n
\n

channel_name [required]

\n
\n

string

\n

Name of the Slack channel.

\n
\n \n
\n
\n
\n
\n
\n

redirect_url [required]

\n
\n

string

\n

URL redirecting to the Slack channel.

\n
\n \n
\n
\n
\n
\n
\n

team_id

\n
\n

string

\n

Slack team ID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Incident integration metadata for the Jira integration.

\n
\n
\n
\n
\n
\n

issues [required]

\n
\n

[object]

\n

Array of Jira issues in this integration metadata.

\n
\n
\n
\n
\n
\n

account [required]

\n
\n

string

\n

URL of issue's Jira account.

\n
\n \n
\n
\n
\n
\n
\n

issue_key

\n
\n

string

\n

Jira issue's issue key.

\n
\n \n
\n
\n
\n
\n
\n

issuetype_id

\n
\n

string

\n

Jira issue's issue type.

\n
\n \n
\n
\n
\n
\n
\n

project_key [required]

\n
\n

string

\n

Jira issue's project keys.

\n
\n \n
\n
\n
\n
\n
\n

redirect_url

\n
\n

string

\n

URL redirecting to the Jira issue.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Incident integration metadata for the Microsoft Teams integration.

\n
\n
\n
\n
\n
\n

teams [required]

\n
\n

[object]

\n

Array of Microsoft Teams in this integration metadata.

\n
\n
\n
\n
\n
\n

ms_channel_id [required]

\n
\n

string

\n

Microsoft Teams channel ID.

\n
\n \n
\n
\n
\n
\n
\n

ms_channel_name [required]

\n
\n

string

\n

Microsoft Teams channel name.

\n
\n \n
\n
\n
\n
\n
\n

ms_tenant_id [required]

\n
\n

string

\n

Microsoft Teams tenant ID.

\n
\n \n
\n
\n
\n
\n
\n

redirect_url [required]

\n
\n

string

\n

URL redirecting to the Microsoft Teams channel.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the incident todo was last modified.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

int32

\n

A number indicating the status of this integration metadata. 0 indicates unknown;\n1 indicates pending; 2 indicates complete; 3 indicates manually created;\n4 indicates manually updated; 5 indicates failed.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident integration metadata's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident's integration relationships from a response.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Integration metadata resource type. \nAllowed enum values: incident_integrations

default: incident_integrations

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Included related resources that the user requested.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident integration metadata from a response.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident integration metadata's attributes for a create request.

\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp when the incident todo was created.

\n
\n \n
\n
\n
\n
\n
\n

incident_id

\n
\n

string

\n

UUID of the incident this integration metadata is connected to.

\n
\n \n
\n
\n
\n
\n
\n

integration_type [required]

\n
\n

int32

\n

A number indicating the type of integration this metadata is for. 1 indicates Slack;\n8 indicates Jira.

\n
\n \n
\n
\n
\n
\n
\n

metadata [required]

\n
\n

 <oneOf>

\n

Incident integration metadata's metadata attribute.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Incident integration metadata for the Slack integration.

\n
\n
\n
\n
\n
\n

channels [required]

\n
\n

[object]

\n

Array of Slack channels in this integration metadata.

\n
\n
\n
\n
\n
\n

channel_id [required]

\n
\n

string

\n

Slack channel ID.

\n
\n \n
\n
\n
\n
\n
\n

channel_name [required]

\n
\n

string

\n

Name of the Slack channel.

\n
\n \n
\n
\n
\n
\n
\n

redirect_url [required]

\n
\n

string

\n

URL redirecting to the Slack channel.

\n
\n \n
\n
\n
\n
\n
\n

team_id

\n
\n

string

\n

Slack team ID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Incident integration metadata for the Jira integration.

\n
\n
\n
\n
\n
\n

issues [required]

\n
\n

[object]

\n

Array of Jira issues in this integration metadata.

\n
\n
\n
\n
\n
\n

account [required]

\n
\n

string

\n

URL of issue's Jira account.

\n
\n \n
\n
\n
\n
\n
\n

issue_key

\n
\n

string

\n

Jira issue's issue key.

\n
\n \n
\n
\n
\n
\n
\n

issuetype_id

\n
\n

string

\n

Jira issue's issue type.

\n
\n \n
\n
\n
\n
\n
\n

project_key [required]

\n
\n

string

\n

Jira issue's project keys.

\n
\n \n
\n
\n
\n
\n
\n

redirect_url

\n
\n

string

\n

URL redirecting to the Jira issue.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Incident integration metadata for the Microsoft Teams integration.

\n
\n
\n
\n
\n
\n

teams [required]

\n
\n

[object]

\n

Array of Microsoft Teams in this integration metadata.

\n
\n
\n
\n
\n
\n

ms_channel_id [required]

\n
\n

string

\n

Microsoft Teams channel ID.

\n
\n \n
\n
\n
\n
\n
\n

ms_channel_name [required]

\n
\n

string

\n

Microsoft Teams channel name.

\n
\n \n
\n
\n
\n
\n
\n

ms_tenant_id [required]

\n
\n

string

\n

Microsoft Teams tenant ID.

\n
\n \n
\n
\n
\n
\n
\n

redirect_url [required]

\n
\n

string

\n

URL redirecting to the Microsoft Teams channel.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the incident todo was last modified.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

int32

\n

A number indicating the status of this integration metadata. 0 indicates unknown;\n1 indicates pending; 2 indicates complete; 3 indicates manually created;\n4 indicates manually updated; 5 indicates failed.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident integration metadata's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident's integration relationships from a response.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Integration metadata resource type. \nAllowed enum values: incident_integrations

default: incident_integrations

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Included related resources that the user requested.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { @@ -4293,6 +4306,7 @@ "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", "mfa_enabled": false, "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", @@ -4338,7 +4352,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident integration metadata from a response.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident integration metadata's attributes for a create request.

\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp when the incident todo was created.

\n
\n \n
\n
\n
\n
\n
\n

incident_id

\n
\n

string

\n

UUID of the incident this integration metadata is connected to.

\n
\n \n
\n
\n
\n
\n
\n

integration_type [required]

\n
\n

int32

\n

A number indicating the type of integration this metadata is for. 1 indicates Slack;\n8 indicates Jira.

\n
\n \n
\n
\n
\n
\n
\n

metadata [required]

\n
\n

 <oneOf>

\n

Incident integration metadata's metadata attribute.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Incident integration metadata for the Slack integration.

\n
\n
\n
\n
\n
\n

channels [required]

\n
\n

[object]

\n

Array of Slack channels in this integration metadata.

\n
\n
\n
\n
\n
\n

channel_id [required]

\n
\n

string

\n

Slack channel ID.

\n
\n \n
\n
\n
\n
\n
\n

channel_name [required]

\n
\n

string

\n

Name of the Slack channel.

\n
\n \n
\n
\n
\n
\n
\n

redirect_url [required]

\n
\n

string

\n

URL redirecting to the Slack channel.

\n
\n \n
\n
\n
\n
\n
\n

team_id

\n
\n

string

\n

Slack team ID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Incident integration metadata for the Jira integration.

\n
\n
\n
\n
\n
\n

issues [required]

\n
\n

[object]

\n

Array of Jira issues in this integration metadata.

\n
\n
\n
\n
\n
\n

account [required]

\n
\n

string

\n

URL of issue's Jira account.

\n
\n \n
\n
\n
\n
\n
\n

issue_key

\n
\n

string

\n

Jira issue's issue key.

\n
\n \n
\n
\n
\n
\n
\n

issuetype_id

\n
\n

string

\n

Jira issue's issue type.

\n
\n \n
\n
\n
\n
\n
\n

project_key [required]

\n
\n

string

\n

Jira issue's project keys.

\n
\n \n
\n
\n
\n
\n
\n

redirect_url

\n
\n

string

\n

URL redirecting to the Jira issue.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Incident integration metadata for the Microsoft Teams integration.

\n
\n
\n
\n
\n
\n

teams [required]

\n
\n

[object]

\n

Array of Microsoft Teams in this integration metadata.

\n
\n
\n
\n
\n
\n

ms_channel_id [required]

\n
\n

string

\n

Microsoft Teams channel ID.

\n
\n \n
\n
\n
\n
\n
\n

ms_channel_name [required]

\n
\n

string

\n

Microsoft Teams channel name.

\n
\n \n
\n
\n
\n
\n
\n

ms_tenant_id [required]

\n
\n

string

\n

Microsoft Teams tenant ID.

\n
\n \n
\n
\n
\n
\n
\n

redirect_url [required]

\n
\n

string

\n

URL redirecting to the Microsoft Teams channel.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the incident todo was last modified.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

int32

\n

A number indicating the status of this integration metadata. 0 indicates unknown;\n1 indicates pending; 2 indicates complete; 3 indicates manually created;\n4 indicates manually updated; 5 indicates failed.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident integration metadata's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident's integration relationships from a response.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Integration metadata resource type. \nAllowed enum values: incident_integrations

default: incident_integrations

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Included related resources that the user requested.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident integration metadata from a response.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident integration metadata's attributes for a create request.

\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp when the incident todo was created.

\n
\n \n
\n
\n
\n
\n
\n

incident_id

\n
\n

string

\n

UUID of the incident this integration metadata is connected to.

\n
\n \n
\n
\n
\n
\n
\n

integration_type [required]

\n
\n

int32

\n

A number indicating the type of integration this metadata is for. 1 indicates Slack;\n8 indicates Jira.

\n
\n \n
\n
\n
\n
\n
\n

metadata [required]

\n
\n

 <oneOf>

\n

Incident integration metadata's metadata attribute.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Incident integration metadata for the Slack integration.

\n
\n
\n
\n
\n
\n

channels [required]

\n
\n

[object]

\n

Array of Slack channels in this integration metadata.

\n
\n
\n
\n
\n
\n

channel_id [required]

\n
\n

string

\n

Slack channel ID.

\n
\n \n
\n
\n
\n
\n
\n

channel_name [required]

\n
\n

string

\n

Name of the Slack channel.

\n
\n \n
\n
\n
\n
\n
\n

redirect_url [required]

\n
\n

string

\n

URL redirecting to the Slack channel.

\n
\n \n
\n
\n
\n
\n
\n

team_id

\n
\n

string

\n

Slack team ID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Incident integration metadata for the Jira integration.

\n
\n
\n
\n
\n
\n

issues [required]

\n
\n

[object]

\n

Array of Jira issues in this integration metadata.

\n
\n
\n
\n
\n
\n

account [required]

\n
\n

string

\n

URL of issue's Jira account.

\n
\n \n
\n
\n
\n
\n
\n

issue_key

\n
\n

string

\n

Jira issue's issue key.

\n
\n \n
\n
\n
\n
\n
\n

issuetype_id

\n
\n

string

\n

Jira issue's issue type.

\n
\n \n
\n
\n
\n
\n
\n

project_key [required]

\n
\n

string

\n

Jira issue's project keys.

\n
\n \n
\n
\n
\n
\n
\n

redirect_url

\n
\n

string

\n

URL redirecting to the Jira issue.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Incident integration metadata for the Microsoft Teams integration.

\n
\n
\n
\n
\n
\n

teams [required]

\n
\n

[object]

\n

Array of Microsoft Teams in this integration metadata.

\n
\n
\n
\n
\n
\n

ms_channel_id [required]

\n
\n

string

\n

Microsoft Teams channel ID.

\n
\n \n
\n
\n
\n
\n
\n

ms_channel_name [required]

\n
\n

string

\n

Microsoft Teams channel name.

\n
\n \n
\n
\n
\n
\n
\n

ms_tenant_id [required]

\n
\n

string

\n

Microsoft Teams tenant ID.

\n
\n \n
\n
\n
\n
\n
\n

redirect_url [required]

\n
\n

string

\n

URL redirecting to the Microsoft Teams channel.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the incident todo was last modified.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

int32

\n

A number indicating the status of this integration metadata. 0 indicates unknown;\n1 indicates pending; 2 indicates complete; 3 indicates manually created;\n4 indicates manually updated; 5 indicates failed.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident integration metadata's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident's integration relationships from a response.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Integration metadata resource type. \nAllowed enum values: incident_integrations

default: incident_integrations

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Included related resources that the user requested.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { @@ -4469,6 +4483,7 @@ "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", "mfa_enabled": false, "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", @@ -4521,7 +4536,7 @@ } } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of incident todos.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident todo's attributes.

\n
\n
\n
\n
\n
\n

assignees [required]

\n
\n

[ <oneOf>]

\n

Array of todo assignees.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

string

\n

Assignee's @-handle.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Anonymous assignee entity.

\n
\n
\n
\n
\n
\n

icon [required]

\n
\n

string

\n

URL for assignee's icon.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Anonymous assignee's ID.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Assignee's name.

\n
\n \n
\n
\n
\n
\n
\n

source [required]

\n
\n

enum

\n

The source of the anonymous assignee. \nAllowed enum values: slack,microsoft_teams

default: slack

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

completed

\n
\n

string

\n

Timestamp when the todo was completed.

\n
\n \n
\n
\n
\n
\n
\n

content [required]

\n
\n

string

\n

The follow-up task's content.

\n
\n \n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp when the incident todo was created.

\n
\n \n
\n
\n
\n
\n
\n

due_date

\n
\n

string

\n

Timestamp when the todo should be completed by.

\n
\n \n
\n
\n
\n
\n
\n

incident_id

\n
\n

string

\n

UUID of the incident this todo is connected to.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the incident todo was last modified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident todo's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident's relationships from a response.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Todo resource type. \nAllowed enum values: incident_todos

default: incident_todos

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Included related resources that the user requested.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

The metadata object containing pagination metadata.

\n
\n
\n
\n
\n
\n

pagination

\n
\n

object

\n

Pagination properties.

\n
\n
\n
\n
\n
\n

next_offset

\n
\n

int64

\n

The index of the first element in the next page of results. Equal to page size added to the current offset.

\n
\n \n
\n
\n
\n
\n
\n

offset

\n
\n

int64

\n

The index of the first element in the results.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

Maximum size of pages to return.

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of incident todos.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident todo's attributes.

\n
\n
\n
\n
\n
\n

assignees [required]

\n
\n

[ <oneOf>]

\n

Array of todo assignees.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

string

\n

Assignee's @-handle.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Anonymous assignee entity.

\n
\n
\n
\n
\n
\n

icon [required]

\n
\n

string

\n

URL for assignee's icon.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Anonymous assignee's ID.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Assignee's name.

\n
\n \n
\n
\n
\n
\n
\n

source [required]

\n
\n

enum

\n

The source of the anonymous assignee. \nAllowed enum values: slack,microsoft_teams

default: slack

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

completed

\n
\n

string

\n

Timestamp when the todo was completed.

\n
\n \n
\n
\n
\n
\n
\n

content [required]

\n
\n

string

\n

The follow-up task's content.

\n
\n \n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp when the incident todo was created.

\n
\n \n
\n
\n
\n
\n
\n

due_date

\n
\n

string

\n

Timestamp when the todo should be completed by.

\n
\n \n
\n
\n
\n
\n
\n

incident_id

\n
\n

string

\n

UUID of the incident this todo is connected to.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the incident todo was last modified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident todo's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident's relationships from a response.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Todo resource type. \nAllowed enum values: incident_todos

default: incident_todos

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Included related resources that the user requested.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

The metadata object containing pagination metadata.

\n
\n
\n
\n
\n
\n

pagination

\n
\n

object

\n

Pagination properties.

\n
\n
\n
\n
\n
\n

next_offset

\n
\n

int64

\n

The index of the first element in the next page of results. Equal to page size added to the current offset.

\n
\n \n
\n
\n
\n
\n
\n

offset

\n
\n

int64

\n

The index of the first element in the results.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

Maximum size of pages to return.

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { @@ -4615,6 +4630,7 @@ "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", "mfa_enabled": false, "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", @@ -4660,7 +4676,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident todo response data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident todo's attributes.

\n
\n
\n
\n
\n
\n

assignees [required]

\n
\n

[ <oneOf>]

\n

Array of todo assignees.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

string

\n

Assignee's @-handle.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Anonymous assignee entity.

\n
\n
\n
\n
\n
\n

icon [required]

\n
\n

string

\n

URL for assignee's icon.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Anonymous assignee's ID.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Assignee's name.

\n
\n \n
\n
\n
\n
\n
\n

source [required]

\n
\n

enum

\n

The source of the anonymous assignee. \nAllowed enum values: slack,microsoft_teams

default: slack

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

completed

\n
\n

string

\n

Timestamp when the todo was completed.

\n
\n \n
\n
\n
\n
\n
\n

content [required]

\n
\n

string

\n

The follow-up task's content.

\n
\n \n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp when the incident todo was created.

\n
\n \n
\n
\n
\n
\n
\n

due_date

\n
\n

string

\n

Timestamp when the todo should be completed by.

\n
\n \n
\n
\n
\n
\n
\n

incident_id

\n
\n

string

\n

UUID of the incident this todo is connected to.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the incident todo was last modified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident todo's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident's relationships from a response.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Todo resource type. \nAllowed enum values: incident_todos

default: incident_todos

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Included related resources that the user requested.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident todo response data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident todo's attributes.

\n
\n
\n
\n
\n
\n

assignees [required]

\n
\n

[ <oneOf>]

\n

Array of todo assignees.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

string

\n

Assignee's @-handle.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Anonymous assignee entity.

\n
\n
\n
\n
\n
\n

icon [required]

\n
\n

string

\n

URL for assignee's icon.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Anonymous assignee's ID.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Assignee's name.

\n
\n \n
\n
\n
\n
\n
\n

source [required]

\n
\n

enum

\n

The source of the anonymous assignee. \nAllowed enum values: slack,microsoft_teams

default: slack

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

completed

\n
\n

string

\n

Timestamp when the todo was completed.

\n
\n \n
\n
\n
\n
\n
\n

content [required]

\n
\n

string

\n

The follow-up task's content.

\n
\n \n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp when the incident todo was created.

\n
\n \n
\n
\n
\n
\n
\n

due_date

\n
\n

string

\n

Timestamp when the todo should be completed by.

\n
\n \n
\n
\n
\n
\n
\n

incident_id

\n
\n

string

\n

UUID of the incident this todo is connected to.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the incident todo was last modified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident todo's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident's relationships from a response.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Todo resource type. \nAllowed enum values: incident_todos

default: incident_todos

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Included related resources that the user requested.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { @@ -4830,6 +4846,7 @@ "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", "mfa_enabled": false, "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", @@ -4875,7 +4892,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident todo response data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident todo's attributes.

\n
\n
\n
\n
\n
\n

assignees [required]

\n
\n

[ <oneOf>]

\n

Array of todo assignees.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

string

\n

Assignee's @-handle.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Anonymous assignee entity.

\n
\n
\n
\n
\n
\n

icon [required]

\n
\n

string

\n

URL for assignee's icon.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Anonymous assignee's ID.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Assignee's name.

\n
\n \n
\n
\n
\n
\n
\n

source [required]

\n
\n

enum

\n

The source of the anonymous assignee. \nAllowed enum values: slack,microsoft_teams

default: slack

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

completed

\n
\n

string

\n

Timestamp when the todo was completed.

\n
\n \n
\n
\n
\n
\n
\n

content [required]

\n
\n

string

\n

The follow-up task's content.

\n
\n \n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp when the incident todo was created.

\n
\n \n
\n
\n
\n
\n
\n

due_date

\n
\n

string

\n

Timestamp when the todo should be completed by.

\n
\n \n
\n
\n
\n
\n
\n

incident_id

\n
\n

string

\n

UUID of the incident this todo is connected to.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the incident todo was last modified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident todo's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident's relationships from a response.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Todo resource type. \nAllowed enum values: incident_todos

default: incident_todos

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Included related resources that the user requested.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident todo response data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident todo's attributes.

\n
\n
\n
\n
\n
\n

assignees [required]

\n
\n

[ <oneOf>]

\n

Array of todo assignees.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

string

\n

Assignee's @-handle.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Anonymous assignee entity.

\n
\n
\n
\n
\n
\n

icon [required]

\n
\n

string

\n

URL for assignee's icon.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Anonymous assignee's ID.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Assignee's name.

\n
\n \n
\n
\n
\n
\n
\n

source [required]

\n
\n

enum

\n

The source of the anonymous assignee. \nAllowed enum values: slack,microsoft_teams

default: slack

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

completed

\n
\n

string

\n

Timestamp when the todo was completed.

\n
\n \n
\n
\n
\n
\n
\n

content [required]

\n
\n

string

\n

The follow-up task's content.

\n
\n \n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp when the incident todo was created.

\n
\n \n
\n
\n
\n
\n
\n

due_date

\n
\n

string

\n

Timestamp when the todo should be completed by.

\n
\n \n
\n
\n
\n
\n
\n

incident_id

\n
\n

string

\n

UUID of the incident this todo is connected to.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the incident todo was last modified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident todo's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident's relationships from a response.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Todo resource type. \nAllowed enum values: incident_todos

default: incident_todos

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Included related resources that the user requested.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { @@ -4969,6 +4986,7 @@ "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", "mfa_enabled": false, "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", @@ -5014,7 +5032,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident todo response data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident todo's attributes.

\n
\n
\n
\n
\n
\n

assignees [required]

\n
\n

[ <oneOf>]

\n

Array of todo assignees.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

string

\n

Assignee's @-handle.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Anonymous assignee entity.

\n
\n
\n
\n
\n
\n

icon [required]

\n
\n

string

\n

URL for assignee's icon.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Anonymous assignee's ID.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Assignee's name.

\n
\n \n
\n
\n
\n
\n
\n

source [required]

\n
\n

enum

\n

The source of the anonymous assignee. \nAllowed enum values: slack,microsoft_teams

default: slack

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

completed

\n
\n

string

\n

Timestamp when the todo was completed.

\n
\n \n
\n
\n
\n
\n
\n

content [required]

\n
\n

string

\n

The follow-up task's content.

\n
\n \n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp when the incident todo was created.

\n
\n \n
\n
\n
\n
\n
\n

due_date

\n
\n

string

\n

Timestamp when the todo should be completed by.

\n
\n \n
\n
\n
\n
\n
\n

incident_id

\n
\n

string

\n

UUID of the incident this todo is connected to.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the incident todo was last modified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident todo's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident's relationships from a response.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Todo resource type. \nAllowed enum values: incident_todos

default: incident_todos

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Included related resources that the user requested.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Incident todo response data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident todo's attributes.

\n
\n
\n
\n
\n
\n

assignees [required]

\n
\n

[ <oneOf>]

\n

Array of todo assignees.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

string

\n

Assignee's @-handle.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Anonymous assignee entity.

\n
\n
\n
\n
\n
\n

icon [required]

\n
\n

string

\n

URL for assignee's icon.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Anonymous assignee's ID.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Assignee's name.

\n
\n \n
\n
\n
\n
\n
\n

source [required]

\n
\n

enum

\n

The source of the anonymous assignee. \nAllowed enum values: slack,microsoft_teams

default: slack

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

completed

\n
\n

string

\n

Timestamp when the todo was completed.

\n
\n \n
\n
\n
\n
\n
\n

content [required]

\n
\n

string

\n

The follow-up task's content.

\n
\n \n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Timestamp when the incident todo was created.

\n
\n \n
\n
\n
\n
\n
\n

due_date

\n
\n

string

\n

Timestamp when the todo should be completed by.

\n
\n \n
\n
\n
\n
\n
\n

incident_id

\n
\n

string

\n

UUID of the incident this todo is connected to.

\n
\n \n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Timestamp when the incident todo was last modified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The incident todo's ID.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The incident's relationships from a response.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Todo resource type. \nAllowed enum values: incident_todos

default: incident_todos

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Included related resources that the user requested.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { diff --git a/content/en/api/v2/key-management/examples.json b/content/en/api/v2/key-management/examples.json index 0ec0593c2bcf2..7a51ba8d280ac 100644 --- a/content/en/api/v2/key-management/examples.json +++ b/content/en/api/v2/key-management/examples.json @@ -40,6 +40,7 @@ "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", "mfa_enabled": false, "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", @@ -91,7 +92,7 @@ } } }, - "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

Array of API keys.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of a partial API key.

\n
\n
\n
\n
\n
\n

category

\n
\n

string

\n

The category of the API key.

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

string

\n

Creation date of the API key.

\n
\n \n
\n
\n
\n
\n
\n

date_last_used

\n
\n

date-time

\n

Date the API Key was last used.

\n
\n \n
\n
\n
\n
\n
\n

last4

\n
\n

string

\n

The last four characters of the API key.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

string

\n

Date the API key was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the API key.

\n
\n \n
\n
\n
\n
\n
\n

remote_config_read_enabled

\n
\n

boolean

\n

The remote config read enabled status.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the API key.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to the API key.

\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

API Keys resource type. \nAllowed enum values: api_keys

default: api_keys

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of objects related to the API key.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

The definition of LeakedKey object.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The definition of LeakedKeyAttributes object.

\n
\n
\n
\n
\n
\n

date [required]

\n
\n

date-time

\n

The LeakedKeyAttributes date.

\n
\n \n
\n
\n
\n
\n
\n

leak_source

\n
\n

string

\n

The LeakedKeyAttributes leak_source.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The LeakedKey id.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of LeakedKeyType object. \nAllowed enum values: leaked_keys

default: leaked_keys

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Additional information related to api keys response.

\n
\n
\n
\n
\n
\n

max_allowed

\n
\n

int64

\n

Max allowed number of API keys.

\n
\n \n
\n
\n
\n
\n
\n

page

\n
\n

object

\n

Additional information related to the API keys response.

\n
\n
\n
\n
\n
\n

total_filtered_count

\n
\n

int64

\n

Total filtered application key count.

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

Array of API keys.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of a partial API key.

\n
\n
\n
\n
\n
\n

category

\n
\n

string

\n

The category of the API key.

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

string

\n

Creation date of the API key.

\n
\n \n
\n
\n
\n
\n
\n

date_last_used

\n
\n

date-time

\n

Date the API Key was last used.

\n
\n \n
\n
\n
\n
\n
\n

last4

\n
\n

string

\n

The last four characters of the API key.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

string

\n

Date the API key was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the API key.

\n
\n \n
\n
\n
\n
\n
\n

remote_config_read_enabled

\n
\n

boolean

\n

The remote config read enabled status.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the API key.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to the API key.

\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

API Keys resource type. \nAllowed enum values: api_keys

default: api_keys

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of objects related to the API key.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

The definition of LeakedKey object.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The definition of LeakedKeyAttributes object.

\n
\n
\n
\n
\n
\n

date [required]

\n
\n

date-time

\n

The LeakedKeyAttributes date.

\n
\n \n
\n
\n
\n
\n
\n

leak_source

\n
\n

string

\n

The LeakedKeyAttributes leak_source.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The LeakedKey id.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of LeakedKeyType object. \nAllowed enum values: leaked_keys

default: leaked_keys

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Additional information related to api keys response.

\n
\n
\n
\n
\n
\n

max_allowed

\n
\n

int64

\n

Max allowed number of API keys.

\n
\n \n
\n
\n
\n
\n
\n

page

\n
\n

object

\n

Additional information related to the API keys response.

\n
\n
\n
\n
\n
\n

total_filtered_count

\n
\n

int64

\n

Total filtered application key count.

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { @@ -164,6 +165,7 @@ "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", "mfa_enabled": false, "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", @@ -209,7 +211,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Datadog API key.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of a full API key.

\n
\n
\n
\n
\n
\n

category

\n
\n

string

\n

The category of the API key.

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation date of the API key.

\n
\n \n
\n
\n
\n
\n
\n

date_last_used

\n
\n

date-time

\n

Date the API Key was last used

\n
\n \n
\n
\n
\n
\n
\n

key

\n
\n

string

\n

The API key.

\n
\n \n
\n
\n
\n
\n
\n

last4

\n
\n

string

\n

The last four characters of the API key.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Date the API key was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the API key.

\n
\n \n
\n
\n
\n
\n
\n

remote_config_read_enabled

\n
\n

boolean

\n

The remote config read enabled status.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the API key.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to the API key.

\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

API Keys resource type. \nAllowed enum values: api_keys

default: api_keys

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of objects related to the API key.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

The definition of LeakedKey object.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The definition of LeakedKeyAttributes object.

\n
\n
\n
\n
\n
\n

date [required]

\n
\n

date-time

\n

The LeakedKeyAttributes date.

\n
\n \n
\n
\n
\n
\n
\n

leak_source

\n
\n

string

\n

The LeakedKeyAttributes leak_source.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The LeakedKey id.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of LeakedKeyType object. \nAllowed enum values: leaked_keys

default: leaked_keys

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Datadog API key.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of a full API key.

\n
\n
\n
\n
\n
\n

category

\n
\n

string

\n

The category of the API key.

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation date of the API key.

\n
\n \n
\n
\n
\n
\n
\n

date_last_used

\n
\n

date-time

\n

Date the API Key was last used

\n
\n \n
\n
\n
\n
\n
\n

key

\n
\n

string

\n

The API key.

\n
\n \n
\n
\n
\n
\n
\n

last4

\n
\n

string

\n

The last four characters of the API key.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Date the API key was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the API key.

\n
\n \n
\n
\n
\n
\n
\n

remote_config_read_enabled

\n
\n

boolean

\n

The remote config read enabled status.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the API key.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to the API key.

\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

API Keys resource type. \nAllowed enum values: api_keys

default: api_keys

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of objects related to the API key.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

The definition of LeakedKey object.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The definition of LeakedKeyAttributes object.

\n
\n
\n
\n
\n
\n

date [required]

\n
\n

date-time

\n

The LeakedKeyAttributes date.

\n
\n \n
\n
\n
\n
\n
\n

leak_source

\n
\n

string

\n

The LeakedKeyAttributes leak_source.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The LeakedKey id.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of LeakedKeyType object. \nAllowed enum values: leaked_keys

default: leaked_keys

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { @@ -331,6 +333,7 @@ "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", "mfa_enabled": false, "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", @@ -376,7 +379,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Datadog API key.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of a full API key.

\n
\n
\n
\n
\n
\n

category

\n
\n

string

\n

The category of the API key.

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation date of the API key.

\n
\n \n
\n
\n
\n
\n
\n

date_last_used

\n
\n

date-time

\n

Date the API Key was last used

\n
\n \n
\n
\n
\n
\n
\n

key

\n
\n

string

\n

The API key.

\n
\n \n
\n
\n
\n
\n
\n

last4

\n
\n

string

\n

The last four characters of the API key.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Date the API key was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the API key.

\n
\n \n
\n
\n
\n
\n
\n

remote_config_read_enabled

\n
\n

boolean

\n

The remote config read enabled status.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the API key.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to the API key.

\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

API Keys resource type. \nAllowed enum values: api_keys

default: api_keys

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of objects related to the API key.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

The definition of LeakedKey object.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The definition of LeakedKeyAttributes object.

\n
\n
\n
\n
\n
\n

date [required]

\n
\n

date-time

\n

The LeakedKeyAttributes date.

\n
\n \n
\n
\n
\n
\n
\n

leak_source

\n
\n

string

\n

The LeakedKeyAttributes leak_source.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The LeakedKey id.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of LeakedKeyType object. \nAllowed enum values: leaked_keys

default: leaked_keys

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Datadog API key.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of a full API key.

\n
\n
\n
\n
\n
\n

category

\n
\n

string

\n

The category of the API key.

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation date of the API key.

\n
\n \n
\n
\n
\n
\n
\n

date_last_used

\n
\n

date-time

\n

Date the API Key was last used

\n
\n \n
\n
\n
\n
\n
\n

key

\n
\n

string

\n

The API key.

\n
\n \n
\n
\n
\n
\n
\n

last4

\n
\n

string

\n

The last four characters of the API key.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Date the API key was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the API key.

\n
\n \n
\n
\n
\n
\n
\n

remote_config_read_enabled

\n
\n

boolean

\n

The remote config read enabled status.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the API key.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to the API key.

\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

API Keys resource type. \nAllowed enum values: api_keys

default: api_keys

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of objects related to the API key.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

The definition of LeakedKey object.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The definition of LeakedKeyAttributes object.

\n
\n
\n
\n
\n
\n

date [required]

\n
\n

date-time

\n

The LeakedKeyAttributes date.

\n
\n \n
\n
\n
\n
\n
\n

leak_source

\n
\n

string

\n

The LeakedKeyAttributes leak_source.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The LeakedKey id.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of LeakedKeyType object. \nAllowed enum values: leaked_keys

default: leaked_keys

\n
\n \n
\n
\n
\n
\n
\n
" }, "403": { "json": { @@ -449,6 +452,7 @@ "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", "mfa_enabled": false, "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", @@ -494,7 +498,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Datadog API key.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of a full API key.

\n
\n
\n
\n
\n
\n

category

\n
\n

string

\n

The category of the API key.

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation date of the API key.

\n
\n \n
\n
\n
\n
\n
\n

date_last_used

\n
\n

date-time

\n

Date the API Key was last used

\n
\n \n
\n
\n
\n
\n
\n

key

\n
\n

string

\n

The API key.

\n
\n \n
\n
\n
\n
\n
\n

last4

\n
\n

string

\n

The last four characters of the API key.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Date the API key was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the API key.

\n
\n \n
\n
\n
\n
\n
\n

remote_config_read_enabled

\n
\n

boolean

\n

The remote config read enabled status.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the API key.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to the API key.

\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

API Keys resource type. \nAllowed enum values: api_keys

default: api_keys

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of objects related to the API key.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

The definition of LeakedKey object.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The definition of LeakedKeyAttributes object.

\n
\n
\n
\n
\n
\n

date [required]

\n
\n

date-time

\n

The LeakedKeyAttributes date.

\n
\n \n
\n
\n
\n
\n
\n

leak_source

\n
\n

string

\n

The LeakedKeyAttributes leak_source.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The LeakedKey id.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of LeakedKeyType object. \nAllowed enum values: leaked_keys

default: leaked_keys

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Datadog API key.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of a full API key.

\n
\n
\n
\n
\n
\n

category

\n
\n

string

\n

The category of the API key.

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation date of the API key.

\n
\n \n
\n
\n
\n
\n
\n

date_last_used

\n
\n

date-time

\n

Date the API Key was last used

\n
\n \n
\n
\n
\n
\n
\n

key

\n
\n

string

\n

The API key.

\n
\n \n
\n
\n
\n
\n
\n

last4

\n
\n

string

\n

The last four characters of the API key.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Date the API key was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the API key.

\n
\n \n
\n
\n
\n
\n
\n

remote_config_read_enabled

\n
\n

boolean

\n

The remote config read enabled status.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the API key.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to the API key.

\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

API Keys resource type. \nAllowed enum values: api_keys

default: api_keys

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of objects related to the API key.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

The definition of LeakedKey object.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The definition of LeakedKeyAttributes object.

\n
\n
\n
\n
\n
\n

date [required]

\n
\n

date-time

\n

The LeakedKeyAttributes date.

\n
\n \n
\n
\n
\n
\n
\n

leak_source

\n
\n

string

\n

The LeakedKeyAttributes leak_source.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The LeakedKey id.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of LeakedKeyType object. \nAllowed enum values: leaked_keys

default: leaked_keys

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { @@ -590,6 +594,7 @@ "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", "mfa_enabled": false, "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", @@ -641,7 +646,7 @@ } } }, - "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

Array of application keys.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of a partial application key.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

string

\n

Creation date of the application key.

\n
\n \n
\n
\n
\n
\n
\n

last4

\n
\n

string

\n

The last four characters of the application key.

\n
\n \n
\n
\n
\n
\n
\n

last_used_at

\n
\n

string

\n

Last usage timestamp of the application key.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the application key.

\n
\n \n
\n
\n
\n
\n
\n

scopes

\n
\n

[string]

\n

Array of scopes to grant the application key.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the application key.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to the application key.

\n
\n
\n
\n
\n
\n

owned_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Application Keys resource type. \nAllowed enum values: application_keys

default: application_keys

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of objects related to the application key.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Role object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the role.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the role.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time of last role modification.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the role. The name is neither unique nor a stable identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int64

\n

Number of users with that role.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the role object returned by the API.

\n
\n
\n
\n
\n
\n

permissions

\n
\n

object

\n

Relationship to multiple permissions objects.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Relationships to permission objects.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the permission.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Permissions resource type. \nAllowed enum values: permissions

default: permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

The definition of LeakedKey object.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The definition of LeakedKeyAttributes object.

\n
\n
\n
\n
\n
\n

date [required]

\n
\n

date-time

\n

The LeakedKeyAttributes date.

\n
\n \n
\n
\n
\n
\n
\n

leak_source

\n
\n

string

\n

The LeakedKeyAttributes leak_source.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The LeakedKey id.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of LeakedKeyType object. \nAllowed enum values: leaked_keys

default: leaked_keys

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Additional information related to the application key response.

\n
\n
\n
\n
\n
\n

max_allowed_per_user

\n
\n

int64

\n

Max allowed number of application keys per user.

\n
\n \n
\n
\n
\n
\n
\n

page

\n
\n

object

\n

Additional information related to the application key response.

\n
\n
\n
\n
\n
\n

total_filtered_count

\n
\n

int64

\n

Total filtered application key count.

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

Array of application keys.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of a partial application key.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

string

\n

Creation date of the application key.

\n
\n \n
\n
\n
\n
\n
\n

last4

\n
\n

string

\n

The last four characters of the application key.

\n
\n \n
\n
\n
\n
\n
\n

last_used_at

\n
\n

string

\n

Last usage timestamp of the application key.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the application key.

\n
\n \n
\n
\n
\n
\n
\n

scopes

\n
\n

[string]

\n

Array of scopes to grant the application key.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the application key.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to the application key.

\n
\n
\n
\n
\n
\n

owned_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Application Keys resource type. \nAllowed enum values: application_keys

default: application_keys

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of objects related to the application key.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Role object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the role.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the role.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time of last role modification.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the role. The name is neither unique nor a stable identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int64

\n

Number of users with that role.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the role object returned by the API.

\n
\n
\n
\n
\n
\n

permissions

\n
\n

object

\n

Relationship to multiple permissions objects.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Relationships to permission objects.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the permission.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Permissions resource type. \nAllowed enum values: permissions

default: permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

The definition of LeakedKey object.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The definition of LeakedKeyAttributes object.

\n
\n
\n
\n
\n
\n

date [required]

\n
\n

date-time

\n

The LeakedKeyAttributes date.

\n
\n \n
\n
\n
\n
\n
\n

leak_source

\n
\n

string

\n

The LeakedKeyAttributes leak_source.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The LeakedKey id.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of LeakedKeyType object. \nAllowed enum values: leaked_keys

default: leaked_keys

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Additional information related to the application key response.

\n
\n
\n
\n
\n
\n

max_allowed_per_user

\n
\n

int64

\n

Max allowed number of application keys per user.

\n
\n \n
\n
\n
\n
\n
\n

page

\n
\n

object

\n

Additional information related to the application key response.

\n
\n
\n
\n
\n
\n

total_filtered_count

\n
\n

int64

\n

Total filtered application key count.

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { @@ -751,6 +756,7 @@ "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", "mfa_enabled": false, "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", @@ -796,7 +802,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Datadog application key.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of a full application key.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation date of the application key.

\n
\n \n
\n
\n
\n
\n
\n

key

\n
\n

string

\n

The application key.

\n
\n \n
\n
\n
\n
\n
\n

last4

\n
\n

string

\n

The last four characters of the application key.

\n
\n \n
\n
\n
\n
\n
\n

last_used_at

\n
\n

date-time

\n

Last usage timestamp of the application key.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the application key.

\n
\n \n
\n
\n
\n
\n
\n

scopes

\n
\n

[string]

\n

Array of scopes to grant the application key.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the application key.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to the application key.

\n
\n
\n
\n
\n
\n

owned_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Application Keys resource type. \nAllowed enum values: application_keys

default: application_keys

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of objects related to the application key.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Role object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the role.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the role.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time of last role modification.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the role. The name is neither unique nor a stable identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int64

\n

Number of users with that role.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the role object returned by the API.

\n
\n
\n
\n
\n
\n

permissions

\n
\n

object

\n

Relationship to multiple permissions objects.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Relationships to permission objects.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the permission.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Permissions resource type. \nAllowed enum values: permissions

default: permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

The definition of LeakedKey object.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The definition of LeakedKeyAttributes object.

\n
\n
\n
\n
\n
\n

date [required]

\n
\n

date-time

\n

The LeakedKeyAttributes date.

\n
\n \n
\n
\n
\n
\n
\n

leak_source

\n
\n

string

\n

The LeakedKeyAttributes leak_source.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The LeakedKey id.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of LeakedKeyType object. \nAllowed enum values: leaked_keys

default: leaked_keys

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Datadog application key.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of a full application key.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation date of the application key.

\n
\n \n
\n
\n
\n
\n
\n

key

\n
\n

string

\n

The application key.

\n
\n \n
\n
\n
\n
\n
\n

last4

\n
\n

string

\n

The last four characters of the application key.

\n
\n \n
\n
\n
\n
\n
\n

last_used_at

\n
\n

date-time

\n

Last usage timestamp of the application key.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the application key.

\n
\n \n
\n
\n
\n
\n
\n

scopes

\n
\n

[string]

\n

Array of scopes to grant the application key.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the application key.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to the application key.

\n
\n
\n
\n
\n
\n

owned_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Application Keys resource type. \nAllowed enum values: application_keys

default: application_keys

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of objects related to the application key.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Role object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the role.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the role.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time of last role modification.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the role. The name is neither unique nor a stable identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int64

\n

Number of users with that role.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the role object returned by the API.

\n
\n
\n
\n
\n
\n

permissions

\n
\n

object

\n

Relationship to multiple permissions objects.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Relationships to permission objects.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the permission.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Permissions resource type. \nAllowed enum values: permissions

default: permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

The definition of LeakedKey object.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The definition of LeakedKeyAttributes object.

\n
\n
\n
\n
\n
\n

date [required]

\n
\n

date-time

\n

The LeakedKeyAttributes date.

\n
\n \n
\n
\n
\n
\n
\n

leak_source

\n
\n

string

\n

The LeakedKeyAttributes leak_source.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The LeakedKey id.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of LeakedKeyType object. \nAllowed enum values: leaked_keys

default: leaked_keys

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { @@ -873,6 +879,7 @@ "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", "mfa_enabled": false, "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", @@ -918,7 +925,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Datadog application key.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of a full application key.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation date of the application key.

\n
\n \n
\n
\n
\n
\n
\n

key

\n
\n

string

\n

The application key.

\n
\n \n
\n
\n
\n
\n
\n

last4

\n
\n

string

\n

The last four characters of the application key.

\n
\n \n
\n
\n
\n
\n
\n

last_used_at

\n
\n

date-time

\n

Last usage timestamp of the application key.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the application key.

\n
\n \n
\n
\n
\n
\n
\n

scopes

\n
\n

[string]

\n

Array of scopes to grant the application key.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the application key.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to the application key.

\n
\n
\n
\n
\n
\n

owned_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Application Keys resource type. \nAllowed enum values: application_keys

default: application_keys

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of objects related to the application key.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Role object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the role.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the role.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time of last role modification.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the role. The name is neither unique nor a stable identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int64

\n

Number of users with that role.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the role object returned by the API.

\n
\n
\n
\n
\n
\n

permissions

\n
\n

object

\n

Relationship to multiple permissions objects.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Relationships to permission objects.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the permission.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Permissions resource type. \nAllowed enum values: permissions

default: permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

The definition of LeakedKey object.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The definition of LeakedKeyAttributes object.

\n
\n
\n
\n
\n
\n

date [required]

\n
\n

date-time

\n

The LeakedKeyAttributes date.

\n
\n \n
\n
\n
\n
\n
\n

leak_source

\n
\n

string

\n

The LeakedKeyAttributes leak_source.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The LeakedKey id.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of LeakedKeyType object. \nAllowed enum values: leaked_keys

default: leaked_keys

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Datadog application key.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of a full application key.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation date of the application key.

\n
\n \n
\n
\n
\n
\n
\n

key

\n
\n

string

\n

The application key.

\n
\n \n
\n
\n
\n
\n
\n

last4

\n
\n

string

\n

The last four characters of the application key.

\n
\n \n
\n
\n
\n
\n
\n

last_used_at

\n
\n

date-time

\n

Last usage timestamp of the application key.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the application key.

\n
\n \n
\n
\n
\n
\n
\n

scopes

\n
\n

[string]

\n

Array of scopes to grant the application key.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the application key.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to the application key.

\n
\n
\n
\n
\n
\n

owned_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Application Keys resource type. \nAllowed enum values: application_keys

default: application_keys

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of objects related to the application key.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Role object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the role.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the role.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time of last role modification.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the role. The name is neither unique nor a stable identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int64

\n

Number of users with that role.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the role object returned by the API.

\n
\n
\n
\n
\n
\n

permissions

\n
\n

object

\n

Relationship to multiple permissions objects.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Relationships to permission objects.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the permission.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Permissions resource type. \nAllowed enum values: permissions

default: permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

The definition of LeakedKey object.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The definition of LeakedKeyAttributes object.

\n
\n
\n
\n
\n
\n

date [required]

\n
\n

date-time

\n

The LeakedKeyAttributes date.

\n
\n \n
\n
\n
\n
\n
\n

leak_source

\n
\n

string

\n

The LeakedKeyAttributes leak_source.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The LeakedKey id.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of LeakedKeyType object. \nAllowed enum values: leaked_keys

default: leaked_keys

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { @@ -1015,6 +1022,7 @@ "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", "mfa_enabled": false, "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", @@ -1066,7 +1074,7 @@ } } }, - "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

Array of application keys.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of a partial application key.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

string

\n

Creation date of the application key.

\n
\n \n
\n
\n
\n
\n
\n

last4

\n
\n

string

\n

The last four characters of the application key.

\n
\n \n
\n
\n
\n
\n
\n

last_used_at

\n
\n

string

\n

Last usage timestamp of the application key.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the application key.

\n
\n \n
\n
\n
\n
\n
\n

scopes

\n
\n

[string]

\n

Array of scopes to grant the application key.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the application key.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to the application key.

\n
\n
\n
\n
\n
\n

owned_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Application Keys resource type. \nAllowed enum values: application_keys

default: application_keys

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of objects related to the application key.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Role object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the role.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the role.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time of last role modification.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the role. The name is neither unique nor a stable identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int64

\n

Number of users with that role.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the role object returned by the API.

\n
\n
\n
\n
\n
\n

permissions

\n
\n

object

\n

Relationship to multiple permissions objects.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Relationships to permission objects.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the permission.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Permissions resource type. \nAllowed enum values: permissions

default: permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

The definition of LeakedKey object.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The definition of LeakedKeyAttributes object.

\n
\n
\n
\n
\n
\n

date [required]

\n
\n

date-time

\n

The LeakedKeyAttributes date.

\n
\n \n
\n
\n
\n
\n
\n

leak_source

\n
\n

string

\n

The LeakedKeyAttributes leak_source.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The LeakedKey id.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of LeakedKeyType object. \nAllowed enum values: leaked_keys

default: leaked_keys

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Additional information related to the application key response.

\n
\n
\n
\n
\n
\n

max_allowed_per_user

\n
\n

int64

\n

Max allowed number of application keys per user.

\n
\n \n
\n
\n
\n
\n
\n

page

\n
\n

object

\n

Additional information related to the application key response.

\n
\n
\n
\n
\n
\n

total_filtered_count

\n
\n

int64

\n

Total filtered application key count.

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

Array of application keys.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of a partial application key.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

string

\n

Creation date of the application key.

\n
\n \n
\n
\n
\n
\n
\n

last4

\n
\n

string

\n

The last four characters of the application key.

\n
\n \n
\n
\n
\n
\n
\n

last_used_at

\n
\n

string

\n

Last usage timestamp of the application key.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the application key.

\n
\n \n
\n
\n
\n
\n
\n

scopes

\n
\n

[string]

\n

Array of scopes to grant the application key.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the application key.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to the application key.

\n
\n
\n
\n
\n
\n

owned_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Application Keys resource type. \nAllowed enum values: application_keys

default: application_keys

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of objects related to the application key.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Role object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the role.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the role.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time of last role modification.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the role. The name is neither unique nor a stable identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int64

\n

Number of users with that role.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the role object returned by the API.

\n
\n
\n
\n
\n
\n

permissions

\n
\n

object

\n

Relationship to multiple permissions objects.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Relationships to permission objects.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the permission.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Permissions resource type. \nAllowed enum values: permissions

default: permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

The definition of LeakedKey object.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The definition of LeakedKeyAttributes object.

\n
\n
\n
\n
\n
\n

date [required]

\n
\n

date-time

\n

The LeakedKeyAttributes date.

\n
\n \n
\n
\n
\n
\n
\n

leak_source

\n
\n

string

\n

The LeakedKeyAttributes leak_source.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The LeakedKey id.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of LeakedKeyType object. \nAllowed enum values: leaked_keys

default: leaked_keys

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Additional information related to the application key response.

\n
\n
\n
\n
\n
\n

max_allowed_per_user

\n
\n

int64

\n

Max allowed number of application keys per user.

\n
\n \n
\n
\n
\n
\n
\n

page

\n
\n

object

\n

Additional information related to the application key response.

\n
\n
\n
\n
\n
\n

total_filtered_count

\n
\n

int64

\n

Total filtered application key count.

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { @@ -1143,6 +1151,7 @@ "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", "mfa_enabled": false, "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", @@ -1188,7 +1197,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Datadog application key.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of a full application key.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation date of the application key.

\n
\n \n
\n
\n
\n
\n
\n

key

\n
\n

string

\n

The application key.

\n
\n \n
\n
\n
\n
\n
\n

last4

\n
\n

string

\n

The last four characters of the application key.

\n
\n \n
\n
\n
\n
\n
\n

last_used_at

\n
\n

date-time

\n

Last usage timestamp of the application key.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the application key.

\n
\n \n
\n
\n
\n
\n
\n

scopes

\n
\n

[string]

\n

Array of scopes to grant the application key.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the application key.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to the application key.

\n
\n
\n
\n
\n
\n

owned_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Application Keys resource type. \nAllowed enum values: application_keys

default: application_keys

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of objects related to the application key.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Role object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the role.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the role.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time of last role modification.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the role. The name is neither unique nor a stable identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int64

\n

Number of users with that role.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the role object returned by the API.

\n
\n
\n
\n
\n
\n

permissions

\n
\n

object

\n

Relationship to multiple permissions objects.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Relationships to permission objects.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the permission.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Permissions resource type. \nAllowed enum values: permissions

default: permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

The definition of LeakedKey object.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The definition of LeakedKeyAttributes object.

\n
\n
\n
\n
\n
\n

date [required]

\n
\n

date-time

\n

The LeakedKeyAttributes date.

\n
\n \n
\n
\n
\n
\n
\n

leak_source

\n
\n

string

\n

The LeakedKeyAttributes leak_source.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The LeakedKey id.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of LeakedKeyType object. \nAllowed enum values: leaked_keys

default: leaked_keys

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Datadog application key.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of a full application key.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation date of the application key.

\n
\n \n
\n
\n
\n
\n
\n

key

\n
\n

string

\n

The application key.

\n
\n \n
\n
\n
\n
\n
\n

last4

\n
\n

string

\n

The last four characters of the application key.

\n
\n \n
\n
\n
\n
\n
\n

last_used_at

\n
\n

date-time

\n

Last usage timestamp of the application key.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the application key.

\n
\n \n
\n
\n
\n
\n
\n

scopes

\n
\n

[string]

\n

Array of scopes to grant the application key.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the application key.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to the application key.

\n
\n
\n
\n
\n
\n

owned_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Application Keys resource type. \nAllowed enum values: application_keys

default: application_keys

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of objects related to the application key.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Role object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the role.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the role.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time of last role modification.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the role. The name is neither unique nor a stable identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int64

\n

Number of users with that role.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the role object returned by the API.

\n
\n
\n
\n
\n
\n

permissions

\n
\n

object

\n

Relationship to multiple permissions objects.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Relationships to permission objects.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the permission.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Permissions resource type. \nAllowed enum values: permissions

default: permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

The definition of LeakedKey object.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The definition of LeakedKeyAttributes object.

\n
\n
\n
\n
\n
\n

date [required]

\n
\n

date-time

\n

The LeakedKeyAttributes date.

\n
\n \n
\n
\n
\n
\n
\n

leak_source

\n
\n

string

\n

The LeakedKeyAttributes leak_source.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The LeakedKey id.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of LeakedKeyType object. \nAllowed enum values: leaked_keys

default: leaked_keys

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { @@ -1309,6 +1318,7 @@ "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", "mfa_enabled": false, "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", @@ -1354,7 +1364,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Datadog application key.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of a full application key.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation date of the application key.

\n
\n \n
\n
\n
\n
\n
\n

key

\n
\n

string

\n

The application key.

\n
\n \n
\n
\n
\n
\n
\n

last4

\n
\n

string

\n

The last four characters of the application key.

\n
\n \n
\n
\n
\n
\n
\n

last_used_at

\n
\n

date-time

\n

Last usage timestamp of the application key.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the application key.

\n
\n \n
\n
\n
\n
\n
\n

scopes

\n
\n

[string]

\n

Array of scopes to grant the application key.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the application key.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to the application key.

\n
\n
\n
\n
\n
\n

owned_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Application Keys resource type. \nAllowed enum values: application_keys

default: application_keys

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of objects related to the application key.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Role object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the role.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the role.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time of last role modification.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the role. The name is neither unique nor a stable identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int64

\n

Number of users with that role.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the role object returned by the API.

\n
\n
\n
\n
\n
\n

permissions

\n
\n

object

\n

Relationship to multiple permissions objects.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Relationships to permission objects.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the permission.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Permissions resource type. \nAllowed enum values: permissions

default: permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

The definition of LeakedKey object.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The definition of LeakedKeyAttributes object.

\n
\n
\n
\n
\n
\n

date [required]

\n
\n

date-time

\n

The LeakedKeyAttributes date.

\n
\n \n
\n
\n
\n
\n
\n

leak_source

\n
\n

string

\n

The LeakedKeyAttributes leak_source.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The LeakedKey id.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of LeakedKeyType object. \nAllowed enum values: leaked_keys

default: leaked_keys

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Datadog application key.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of a full application key.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation date of the application key.

\n
\n \n
\n
\n
\n
\n
\n

key

\n
\n

string

\n

The application key.

\n
\n \n
\n
\n
\n
\n
\n

last4

\n
\n

string

\n

The last four characters of the application key.

\n
\n \n
\n
\n
\n
\n
\n

last_used_at

\n
\n

date-time

\n

Last usage timestamp of the application key.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the application key.

\n
\n \n
\n
\n
\n
\n
\n

scopes

\n
\n

[string]

\n

Array of scopes to grant the application key.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the application key.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to the application key.

\n
\n
\n
\n
\n
\n

owned_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Application Keys resource type. \nAllowed enum values: application_keys

default: application_keys

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of objects related to the application key.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Role object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the role.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the role.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time of last role modification.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the role. The name is neither unique nor a stable identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int64

\n

Number of users with that role.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the role object returned by the API.

\n
\n
\n
\n
\n
\n

permissions

\n
\n

object

\n

Relationship to multiple permissions objects.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Relationships to permission objects.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the permission.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Permissions resource type. \nAllowed enum values: permissions

default: permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

The definition of LeakedKey object.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The definition of LeakedKeyAttributes object.

\n
\n
\n
\n
\n
\n

date [required]

\n
\n

date-time

\n

The LeakedKeyAttributes date.

\n
\n \n
\n
\n
\n
\n
\n

leak_source

\n
\n

string

\n

The LeakedKeyAttributes leak_source.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The LeakedKey id.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of LeakedKeyType object. \nAllowed enum values: leaked_keys

default: leaked_keys

\n
\n \n
\n
\n
\n
\n
\n
" }, "403": { "json": { @@ -1423,6 +1433,7 @@ "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", "mfa_enabled": false, "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", @@ -1468,7 +1479,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Datadog application key.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of a full application key.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation date of the application key.

\n
\n \n
\n
\n
\n
\n
\n

key

\n
\n

string

\n

The application key.

\n
\n \n
\n
\n
\n
\n
\n

last4

\n
\n

string

\n

The last four characters of the application key.

\n
\n \n
\n
\n
\n
\n
\n

last_used_at

\n
\n

date-time

\n

Last usage timestamp of the application key.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the application key.

\n
\n \n
\n
\n
\n
\n
\n

scopes

\n
\n

[string]

\n

Array of scopes to grant the application key.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the application key.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to the application key.

\n
\n
\n
\n
\n
\n

owned_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Application Keys resource type. \nAllowed enum values: application_keys

default: application_keys

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of objects related to the application key.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Role object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the role.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the role.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time of last role modification.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the role. The name is neither unique nor a stable identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int64

\n

Number of users with that role.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the role object returned by the API.

\n
\n
\n
\n
\n
\n

permissions

\n
\n

object

\n

Relationship to multiple permissions objects.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Relationships to permission objects.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the permission.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Permissions resource type. \nAllowed enum values: permissions

default: permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

The definition of LeakedKey object.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The definition of LeakedKeyAttributes object.

\n
\n
\n
\n
\n
\n

date [required]

\n
\n

date-time

\n

The LeakedKeyAttributes date.

\n
\n \n
\n
\n
\n
\n
\n

leak_source

\n
\n

string

\n

The LeakedKeyAttributes leak_source.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The LeakedKey id.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of LeakedKeyType object. \nAllowed enum values: leaked_keys

default: leaked_keys

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Datadog application key.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of a full application key.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation date of the application key.

\n
\n \n
\n
\n
\n
\n
\n

key

\n
\n

string

\n

The application key.

\n
\n \n
\n
\n
\n
\n
\n

last4

\n
\n

string

\n

The last four characters of the application key.

\n
\n \n
\n
\n
\n
\n
\n

last_used_at

\n
\n

date-time

\n

Last usage timestamp of the application key.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the application key.

\n
\n \n
\n
\n
\n
\n
\n

scopes

\n
\n

[string]

\n

Array of scopes to grant the application key.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the application key.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to the application key.

\n
\n
\n
\n
\n
\n

owned_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Application Keys resource type. \nAllowed enum values: application_keys

default: application_keys

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of objects related to the application key.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Role object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the role.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the role.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time of last role modification.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the role. The name is neither unique nor a stable identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int64

\n

Number of users with that role.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the role object returned by the API.

\n
\n
\n
\n
\n
\n

permissions

\n
\n

object

\n

Relationship to multiple permissions objects.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Relationships to permission objects.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the permission.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Permissions resource type. \nAllowed enum values: permissions

default: permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

The definition of LeakedKey object.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The definition of LeakedKeyAttributes object.

\n
\n
\n
\n
\n
\n

date [required]

\n
\n

date-time

\n

The LeakedKeyAttributes date.

\n
\n \n
\n
\n
\n
\n
\n

leak_source

\n
\n

string

\n

The LeakedKeyAttributes leak_source.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The LeakedKey id.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of LeakedKeyType object. \nAllowed enum values: leaked_keys

default: leaked_keys

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { diff --git a/content/en/api/v2/monitors/examples.json b/content/en/api/v2/monitors/examples.json index 0433d3bbf90f8..aadd419de0c25 100644 --- a/content/en/api/v2/monitors/examples.json +++ b/content/en/api/v2/monitors/examples.json @@ -55,6 +55,7 @@ "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", "mfa_enabled": false, "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", @@ -100,7 +101,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

A list of monitor notification rules.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the monitor notification rule.

\n
\n
\n
\n
\n
\n

conditional_recipients

\n
\n

object

\n

Use conditional recipients to define different recipients for different situations.

\n
\n
\n
\n
\n
\n

conditions [required]

\n
\n

[object]

\n

Conditions of the notification rule.

\n
\n
\n
\n
\n
\n

recipients [required]

\n
\n

[string]

\n

A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'.

\n
\n \n
\n
\n
\n
\n
\n

scope [required]

\n
\n

string

\n

The scope to which the monitor applied.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

fallback_recipients

\n
\n

[string]

\n

If none of the conditions applied, fallback_recipients will get notified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Creation time of the monitor notification rule.

\n
\n \n
\n
\n
\n
\n
\n

filter

\n
\n

 <oneOf>

\n

Filter used to associate the notification rule with monitors.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Filter monitors by tags. Monitors must match all tags.

\n
\n
\n
\n
\n
\n

tags [required]

\n
\n

[string]

\n

A list of monitor tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Time the monitor notification rule was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the monitor notification rule.

\n
\n \n
\n
\n
\n
\n
\n

recipients

\n
\n

[string]

\n

A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the monitor notification rule.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

All relationships associated with monitor notification rule.

\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

The user who created the monitor notification rule.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Data for the user who created the monitor notification rule.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

User ID of the monitor notification rule creator.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Monitor notification rule resource type. \nAllowed enum values: monitor-notification-rule

default: monitor-notification-rule

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of objects related to the monitor notification rules.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

A list of monitor notification rules.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the monitor notification rule.

\n
\n
\n
\n
\n
\n

conditional_recipients

\n
\n

object

\n

Use conditional recipients to define different recipients for different situations.

\n
\n
\n
\n
\n
\n

conditions [required]

\n
\n

[object]

\n

Conditions of the notification rule.

\n
\n
\n
\n
\n
\n

recipients [required]

\n
\n

[string]

\n

A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'.

\n
\n \n
\n
\n
\n
\n
\n

scope [required]

\n
\n

string

\n

The scope to which the monitor applied.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

fallback_recipients

\n
\n

[string]

\n

If none of the conditions applied, fallback_recipients will get notified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Creation time of the monitor notification rule.

\n
\n \n
\n
\n
\n
\n
\n

filter

\n
\n

 <oneOf>

\n

Filter used to associate the notification rule with monitors.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Filter monitors by tags. Monitors must match all tags.

\n
\n
\n
\n
\n
\n

tags [required]

\n
\n

[string]

\n

A list of monitor tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Time the monitor notification rule was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the monitor notification rule.

\n
\n \n
\n
\n
\n
\n
\n

recipients

\n
\n

[string]

\n

A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the monitor notification rule.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

All relationships associated with monitor notification rule.

\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

The user who created the monitor notification rule.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Data for the user who created the monitor notification rule.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

User ID of the monitor notification rule creator.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Monitor notification rule resource type. \nAllowed enum values: monitor-notification-rule

default: monitor-notification-rule

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of objects related to the monitor notification rules.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
" }, "403": { "json": { @@ -179,6 +180,7 @@ "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", "mfa_enabled": false, "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", @@ -224,7 +226,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Monitor notification rule data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the monitor notification rule.

\n
\n
\n
\n
\n
\n

conditional_recipients

\n
\n

object

\n

Use conditional recipients to define different recipients for different situations.

\n
\n
\n
\n
\n
\n

conditions [required]

\n
\n

[object]

\n

Conditions of the notification rule.

\n
\n
\n
\n
\n
\n

recipients [required]

\n
\n

[string]

\n

A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'.

\n
\n \n
\n
\n
\n
\n
\n

scope [required]

\n
\n

string

\n

The scope to which the monitor applied.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

fallback_recipients

\n
\n

[string]

\n

If none of the conditions applied, fallback_recipients will get notified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Creation time of the monitor notification rule.

\n
\n \n
\n
\n
\n
\n
\n

filter

\n
\n

 <oneOf>

\n

Filter used to associate the notification rule with monitors.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Filter monitors by tags. Monitors must match all tags.

\n
\n
\n
\n
\n
\n

tags [required]

\n
\n

[string]

\n

A list of monitor tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Time the monitor notification rule was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the monitor notification rule.

\n
\n \n
\n
\n
\n
\n
\n

recipients

\n
\n

[string]

\n

A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the monitor notification rule.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

All relationships associated with monitor notification rule.

\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

The user who created the monitor notification rule.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Data for the user who created the monitor notification rule.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

User ID of the monitor notification rule creator.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Monitor notification rule resource type. \nAllowed enum values: monitor-notification-rule

default: monitor-notification-rule

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of objects related to the monitor notification rule that the user requested.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Monitor notification rule data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the monitor notification rule.

\n
\n
\n
\n
\n
\n

conditional_recipients

\n
\n

object

\n

Use conditional recipients to define different recipients for different situations.

\n
\n
\n
\n
\n
\n

conditions [required]

\n
\n

[object]

\n

Conditions of the notification rule.

\n
\n
\n
\n
\n
\n

recipients [required]

\n
\n

[string]

\n

A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'.

\n
\n \n
\n
\n
\n
\n
\n

scope [required]

\n
\n

string

\n

The scope to which the monitor applied.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

fallback_recipients

\n
\n

[string]

\n

If none of the conditions applied, fallback_recipients will get notified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Creation time of the monitor notification rule.

\n
\n \n
\n
\n
\n
\n
\n

filter

\n
\n

 <oneOf>

\n

Filter used to associate the notification rule with monitors.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Filter monitors by tags. Monitors must match all tags.

\n
\n
\n
\n
\n
\n

tags [required]

\n
\n

[string]

\n

A list of monitor tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Time the monitor notification rule was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the monitor notification rule.

\n
\n \n
\n
\n
\n
\n
\n

recipients

\n
\n

[string]

\n

A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the monitor notification rule.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

All relationships associated with monitor notification rule.

\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

The user who created the monitor notification rule.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Data for the user who created the monitor notification rule.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

User ID of the monitor notification rule creator.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Monitor notification rule resource type. \nAllowed enum values: monitor-notification-rule

default: monitor-notification-rule

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of objects related to the monitor notification rule that the user requested.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { @@ -393,6 +395,7 @@ "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", "mfa_enabled": false, "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", @@ -438,7 +441,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Monitor notification rule data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the monitor notification rule.

\n
\n
\n
\n
\n
\n

conditional_recipients

\n
\n

object

\n

Use conditional recipients to define different recipients for different situations.

\n
\n
\n
\n
\n
\n

conditions [required]

\n
\n

[object]

\n

Conditions of the notification rule.

\n
\n
\n
\n
\n
\n

recipients [required]

\n
\n

[string]

\n

A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'.

\n
\n \n
\n
\n
\n
\n
\n

scope [required]

\n
\n

string

\n

The scope to which the monitor applied.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

fallback_recipients

\n
\n

[string]

\n

If none of the conditions applied, fallback_recipients will get notified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Creation time of the monitor notification rule.

\n
\n \n
\n
\n
\n
\n
\n

filter

\n
\n

 <oneOf>

\n

Filter used to associate the notification rule with monitors.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Filter monitors by tags. Monitors must match all tags.

\n
\n
\n
\n
\n
\n

tags [required]

\n
\n

[string]

\n

A list of monitor tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Time the monitor notification rule was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the monitor notification rule.

\n
\n \n
\n
\n
\n
\n
\n

recipients

\n
\n

[string]

\n

A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the monitor notification rule.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

All relationships associated with monitor notification rule.

\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

The user who created the monitor notification rule.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Data for the user who created the monitor notification rule.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

User ID of the monitor notification rule creator.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Monitor notification rule resource type. \nAllowed enum values: monitor-notification-rule

default: monitor-notification-rule

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of objects related to the monitor notification rule that the user requested.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Monitor notification rule data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the monitor notification rule.

\n
\n
\n
\n
\n
\n

conditional_recipients

\n
\n

object

\n

Use conditional recipients to define different recipients for different situations.

\n
\n
\n
\n
\n
\n

conditions [required]

\n
\n

[object]

\n

Conditions of the notification rule.

\n
\n
\n
\n
\n
\n

recipients [required]

\n
\n

[string]

\n

A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'.

\n
\n \n
\n
\n
\n
\n
\n

scope [required]

\n
\n

string

\n

The scope to which the monitor applied.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

fallback_recipients

\n
\n

[string]

\n

If none of the conditions applied, fallback_recipients will get notified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Creation time of the monitor notification rule.

\n
\n \n
\n
\n
\n
\n
\n

filter

\n
\n

 <oneOf>

\n

Filter used to associate the notification rule with monitors.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Filter monitors by tags. Monitors must match all tags.

\n
\n
\n
\n
\n
\n

tags [required]

\n
\n

[string]

\n

A list of monitor tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Time the monitor notification rule was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the monitor notification rule.

\n
\n \n
\n
\n
\n
\n
\n

recipients

\n
\n

[string]

\n

A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the monitor notification rule.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

All relationships associated with monitor notification rule.

\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

The user who created the monitor notification rule.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Data for the user who created the monitor notification rule.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

User ID of the monitor notification rule creator.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Monitor notification rule resource type. \nAllowed enum values: monitor-notification-rule

default: monitor-notification-rule

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of objects related to the monitor notification rule that the user requested.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
" }, "403": { "json": { @@ -525,6 +528,7 @@ "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", "mfa_enabled": false, "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", @@ -570,7 +574,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Monitor notification rule data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the monitor notification rule.

\n
\n
\n
\n
\n
\n

conditional_recipients

\n
\n

object

\n

Use conditional recipients to define different recipients for different situations.

\n
\n
\n
\n
\n
\n

conditions [required]

\n
\n

[object]

\n

Conditions of the notification rule.

\n
\n
\n
\n
\n
\n

recipients [required]

\n
\n

[string]

\n

A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'.

\n
\n \n
\n
\n
\n
\n
\n

scope [required]

\n
\n

string

\n

The scope to which the monitor applied.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

fallback_recipients

\n
\n

[string]

\n

If none of the conditions applied, fallback_recipients will get notified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Creation time of the monitor notification rule.

\n
\n \n
\n
\n
\n
\n
\n

filter

\n
\n

 <oneOf>

\n

Filter used to associate the notification rule with monitors.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Filter monitors by tags. Monitors must match all tags.

\n
\n
\n
\n
\n
\n

tags [required]

\n
\n

[string]

\n

A list of monitor tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Time the monitor notification rule was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the monitor notification rule.

\n
\n \n
\n
\n
\n
\n
\n

recipients

\n
\n

[string]

\n

A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the monitor notification rule.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

All relationships associated with monitor notification rule.

\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

The user who created the monitor notification rule.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Data for the user who created the monitor notification rule.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

User ID of the monitor notification rule creator.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Monitor notification rule resource type. \nAllowed enum values: monitor-notification-rule

default: monitor-notification-rule

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of objects related to the monitor notification rule that the user requested.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Monitor notification rule data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the monitor notification rule.

\n
\n
\n
\n
\n
\n

conditional_recipients

\n
\n

object

\n

Use conditional recipients to define different recipients for different situations.

\n
\n
\n
\n
\n
\n

conditions [required]

\n
\n

[object]

\n

Conditions of the notification rule.

\n
\n
\n
\n
\n
\n

recipients [required]

\n
\n

[string]

\n

A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'.

\n
\n \n
\n
\n
\n
\n
\n

scope [required]

\n
\n

string

\n

The scope to which the monitor applied.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

fallback_recipients

\n
\n

[string]

\n

If none of the conditions applied, fallback_recipients will get notified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Creation time of the monitor notification rule.

\n
\n \n
\n
\n
\n
\n
\n

filter

\n
\n

 <oneOf>

\n

Filter used to associate the notification rule with monitors.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Filter monitors by tags. Monitors must match all tags.

\n
\n
\n
\n
\n
\n

tags [required]

\n
\n

[string]

\n

A list of monitor tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified

\n
\n

date-time

\n

Time the monitor notification rule was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the monitor notification rule.

\n
\n \n
\n
\n
\n
\n
\n

recipients

\n
\n

[string]

\n

A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the monitor notification rule.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

All relationships associated with monitor notification rule.

\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

The user who created the monitor notification rule.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Data for the user who created the monitor notification rule.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

User ID of the monitor notification rule creator.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Monitor notification rule resource type. \nAllowed enum values: monitor-notification-rule

default: monitor-notification-rule

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of objects related to the monitor notification rule that the user requested.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { diff --git a/content/en/api/v2/on-call/examples.json b/content/en/api/v2/on-call/examples.json index 3d99176ac963d..cb07e403c70bd 100644 --- a/content/en/api/v2/on-call/examples.json +++ b/content/en/api/v2/on-call/examples.json @@ -1276,7 +1276,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Defines the main on-call responder object for a team, including relationships and metadata.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Unique identifier of the on-call responder configuration.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationship objects linked to a team's on-call responder configuration, including escalations and responders.

\n
\n
\n
\n
\n
\n

escalations

\n
\n

object

\n

Defines the escalation policy steps linked to the team's on-call configuration.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Array of escalation step references.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Unique identifier of the escalation step.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Identifies the resource type for escalation policy steps linked to a team's on-call configuration. \nAllowed enum values: escalation_policy_steps

default: escalation_policy_steps

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

responders

\n
\n

object

\n

Defines the list of users assigned as on-call responders for the team.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Array of user references associated as responders.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Unique identifier of the responder.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Identifies the resource type for individual user entities associated with on-call response. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Represents the resource type for a group of users assigned to handle on-call duties within a team. \nAllowed enum values: team_oncall_responders

default: team_oncall_responders

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

The TeamOnCallResponders included.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Represents an escalation policy step.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Unique identifier of the escalation step.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Contains the relationships of an escalation object, including its responders.

\n
\n
\n
\n
\n
\n

responders

\n
\n

object

\n

Lists the users involved in a specific step of the escalation policy.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Array of user references assigned as responders for this escalation step.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Unique identifier of the user assigned to the escalation step.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Represents the resource type for users assigned as responders in an escalation step. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Represents the resource type for individual steps in an escalation policy used during incident response. \nAllowed enum values: escalation_policy_steps

default: escalation_policy_steps

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Defines the main on-call responder object for a team, including relationships and metadata.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Unique identifier of the on-call responder configuration.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationship objects linked to a team's on-call responder configuration, including escalations and responders.

\n
\n
\n
\n
\n
\n

escalations

\n
\n

object

\n

Defines the escalation policy steps linked to the team's on-call configuration.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Array of escalation step references.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Unique identifier of the escalation step.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Identifies the resource type for escalation policy steps linked to a team's on-call configuration. \nAllowed enum values: escalation_policy_steps

default: escalation_policy_steps

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

responders

\n
\n

object

\n

Defines the list of users assigned as on-call responders for the team.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Array of user references associated as responders.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Unique identifier of the responder.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Identifies the resource type for individual user entities associated with on-call response. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Represents the resource type for a group of users assigned to handle on-call duties within a team. \nAllowed enum values: team_oncall_responders

default: team_oncall_responders

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

The TeamOnCallResponders included.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Represents an escalation policy step.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Unique identifier of the escalation step.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Contains the relationships of an escalation object, including its responders.

\n
\n
\n
\n
\n
\n

responders

\n
\n

object

\n

Lists the users involved in a specific step of the escalation policy.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Array of user references assigned as responders for this escalation step.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Unique identifier of the user assigned to the escalation step.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Represents the resource type for users assigned as responders in an escalation step. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Represents the resource type for individual steps in an escalation policy used during incident response. \nAllowed enum values: escalation_policy_steps

default: escalation_policy_steps

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { diff --git a/content/en/api/v2/powerpack/examples.json b/content/en/api/v2/powerpack/examples.json index 87269c5297c54..7758850162112 100644 --- a/content/en/api/v2/powerpack/examples.json +++ b/content/en/api/v2/powerpack/examples.json @@ -77,6 +77,7 @@ "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", "mfa_enabled": false, "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", @@ -141,7 +142,7 @@ } } }, - "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

List of powerpack definitions.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Powerpack attribute object.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of this powerpack.

\n
\n \n
\n
\n
\n
\n
\n

group_widget [required]

\n
\n

object

\n

Powerpack group widget definition object.

\n
\n
\n
\n
\n
\n

definition [required]

\n
\n

object

\n

Powerpack group widget object.

\n
\n
\n
\n
\n
\n

layout_type [required]

\n
\n

string

\n

Layout type of widgets.

\n
\n \n
\n
\n
\n
\n
\n

show_title

\n
\n

boolean

\n

Boolean indicating whether powerpack group title should be visible or not.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Name for the group widget.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Type of widget, must be group.

\n
\n \n
\n
\n
\n
\n
\n

widgets [required]

\n
\n

[object]

\n

Widgets inside the powerpack.

\n
\n
\n
\n
\n
\n

definition [required]

\n
\n

object

\n

Information about widget.

\n
\n \n
\n
\n
\n
\n
\n

layout

\n
\n

object

\n

Powerpack inner widget layout.

\n
\n
\n
\n
\n
\n

height [required]

\n
\n

int64

\n

The height of the widget. Should be a non-negative integer.

\n
\n \n
\n
\n
\n
\n
\n

width [required]

\n
\n

int64

\n

The width of the widget. Should be a non-negative integer.

\n
\n \n
\n
\n
\n
\n
\n

x [required]

\n
\n

int64

\n

The position of the widget on the x (horizontal) axis. Should be a non-negative integer.

\n
\n \n
\n
\n
\n
\n
\n

y [required]

\n
\n

int64

\n

The position of the widget on the y (vertical) axis. Should be a non-negative integer.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

layout

\n
\n

object

\n

Powerpack group widget layout.

\n
\n
\n
\n
\n
\n

height [required]

\n
\n

int64

\n

The height of the widget. Should be a non-negative integer.

\n
\n \n
\n
\n
\n
\n
\n

width [required]

\n
\n

int64

\n

The width of the widget. Should be a non-negative integer.

\n
\n \n
\n
\n
\n
\n
\n

x [required]

\n
\n

int64

\n

The position of the widget on the x (horizontal) axis. Should be a non-negative integer.

\n
\n \n
\n
\n
\n
\n
\n

y [required]

\n
\n

int64

\n

The position of the widget on the y (vertical) axis. Should be a non-negative integer.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

live_span

\n
\n

enum

\n

The available timeframes depend on the widget you are using. \nAllowed enum values: 1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,1y,alert

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the powerpack.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

List of tags to identify this powerpack.

\n
\n \n
\n
\n
\n
\n
\n

template_variables

\n
\n

[object]

\n

List of template variables for this powerpack.

\n
\n
\n
\n
\n
\n

available_values

\n
\n

[string]

\n

The list of values that the template variable drop-down is limited to.

\n
\n \n
\n
\n
\n
\n
\n

defaults

\n
\n

[string]

\n

One or many template variable default values within the saved view, which are unioned together using OR if more than one is specified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the variable.

\n
\n \n
\n
\n
\n
\n
\n

prefix

\n
\n

string

\n

The tag prefix associated with the variable. Only tags with this prefix appear in the variable drop-down.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the powerpack.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Powerpack relationship object.

\n
\n
\n
\n
\n
\n

author

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Type of widget, must be powerpack.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[object]

\n

Array of objects related to the users.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Links attributes.

\n
\n
\n
\n
\n
\n

first

\n
\n

string

\n

Link to last page.

\n
\n \n
\n
\n
\n
\n
\n

last

\n
\n

string

\n

Link to first page.

\n
\n \n
\n
\n
\n
\n
\n

next

\n
\n

string

\n

Link for the next set of results.

\n
\n \n
\n
\n
\n
\n
\n

prev

\n
\n

string

\n

Link for the previous set of results.

\n
\n \n
\n
\n
\n
\n
\n

self

\n
\n

string

\n

Link to current page.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Powerpack response metadata.

\n
\n
\n
\n
\n
\n

pagination

\n
\n

object

\n

Powerpack response pagination metadata.

\n
\n
\n
\n
\n
\n

first_offset

\n
\n

int64

\n

The first offset.

\n
\n \n
\n
\n
\n
\n
\n

last_offset

\n
\n

int64

\n

The last offset.

\n
\n \n
\n
\n
\n
\n
\n

limit

\n
\n

int64

\n

Pagination limit.

\n
\n \n
\n
\n
\n
\n
\n

next_offset

\n
\n

int64

\n

The next offset.

\n
\n \n
\n
\n
\n
\n
\n

offset

\n
\n

int64

\n

The offset.

\n
\n \n
\n
\n
\n
\n
\n

prev_offset

\n
\n

int64

\n

The previous offset.

\n
\n \n
\n
\n
\n
\n
\n

total

\n
\n

int64

\n

Total results.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Offset type.

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

List of powerpack definitions.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Powerpack attribute object.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of this powerpack.

\n
\n \n
\n
\n
\n
\n
\n

group_widget [required]

\n
\n

object

\n

Powerpack group widget definition object.

\n
\n
\n
\n
\n
\n

definition [required]

\n
\n

object

\n

Powerpack group widget object.

\n
\n
\n
\n
\n
\n

layout_type [required]

\n
\n

string

\n

Layout type of widgets.

\n
\n \n
\n
\n
\n
\n
\n

show_title

\n
\n

boolean

\n

Boolean indicating whether powerpack group title should be visible or not.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Name for the group widget.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Type of widget, must be group.

\n
\n \n
\n
\n
\n
\n
\n

widgets [required]

\n
\n

[object]

\n

Widgets inside the powerpack.

\n
\n
\n
\n
\n
\n

definition [required]

\n
\n

object

\n

Information about widget.

\n
\n \n
\n
\n
\n
\n
\n

layout

\n
\n

object

\n

Powerpack inner widget layout.

\n
\n
\n
\n
\n
\n

height [required]

\n
\n

int64

\n

The height of the widget. Should be a non-negative integer.

\n
\n \n
\n
\n
\n
\n
\n

width [required]

\n
\n

int64

\n

The width of the widget. Should be a non-negative integer.

\n
\n \n
\n
\n
\n
\n
\n

x [required]

\n
\n

int64

\n

The position of the widget on the x (horizontal) axis. Should be a non-negative integer.

\n
\n \n
\n
\n
\n
\n
\n

y [required]

\n
\n

int64

\n

The position of the widget on the y (vertical) axis. Should be a non-negative integer.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

layout

\n
\n

object

\n

Powerpack group widget layout.

\n
\n
\n
\n
\n
\n

height [required]

\n
\n

int64

\n

The height of the widget. Should be a non-negative integer.

\n
\n \n
\n
\n
\n
\n
\n

width [required]

\n
\n

int64

\n

The width of the widget. Should be a non-negative integer.

\n
\n \n
\n
\n
\n
\n
\n

x [required]

\n
\n

int64

\n

The position of the widget on the x (horizontal) axis. Should be a non-negative integer.

\n
\n \n
\n
\n
\n
\n
\n

y [required]

\n
\n

int64

\n

The position of the widget on the y (vertical) axis. Should be a non-negative integer.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

live_span

\n
\n

enum

\n

The available timeframes depend on the widget you are using. \nAllowed enum values: 1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,1y,alert

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the powerpack.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

List of tags to identify this powerpack.

\n
\n \n
\n
\n
\n
\n
\n

template_variables

\n
\n

[object]

\n

List of template variables for this powerpack.

\n
\n
\n
\n
\n
\n

available_values

\n
\n

[string]

\n

The list of values that the template variable drop-down is limited to.

\n
\n \n
\n
\n
\n
\n
\n

defaults

\n
\n

[string]

\n

One or many template variable default values within the saved view, which are unioned together using OR if more than one is specified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the variable.

\n
\n \n
\n
\n
\n
\n
\n

prefix

\n
\n

string

\n

The tag prefix associated with the variable. Only tags with this prefix appear in the variable drop-down.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the powerpack.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Powerpack relationship object.

\n
\n
\n
\n
\n
\n

author

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Type of widget, must be powerpack.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[object]

\n

Array of objects related to the users.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Links attributes.

\n
\n
\n
\n
\n
\n

first

\n
\n

string

\n

Link to last page.

\n
\n \n
\n
\n
\n
\n
\n

last

\n
\n

string

\n

Link to first page.

\n
\n \n
\n
\n
\n
\n
\n

next

\n
\n

string

\n

Link for the next set of results.

\n
\n \n
\n
\n
\n
\n
\n

prev

\n
\n

string

\n

Link for the previous set of results.

\n
\n \n
\n
\n
\n
\n
\n

self

\n
\n

string

\n

Link to current page.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Powerpack response metadata.

\n
\n
\n
\n
\n
\n

pagination

\n
\n

object

\n

Powerpack response pagination metadata.

\n
\n
\n
\n
\n
\n

first_offset

\n
\n

int64

\n

The first offset.

\n
\n \n
\n
\n
\n
\n
\n

last_offset

\n
\n

int64

\n

The last offset.

\n
\n \n
\n
\n
\n
\n
\n

limit

\n
\n

int64

\n

Pagination limit.

\n
\n \n
\n
\n
\n
\n
\n

next_offset

\n
\n

int64

\n

The next offset.

\n
\n \n
\n
\n
\n
\n
\n

offset

\n
\n

int64

\n

The offset.

\n
\n \n
\n
\n
\n
\n
\n

prev_offset

\n
\n

int64

\n

The previous offset.

\n
\n \n
\n
\n
\n
\n
\n

total

\n
\n

int64

\n

Total results.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Offset type.

\n
\n \n
\n
\n
\n
\n
\n
" }, "429": { "json": { @@ -234,6 +235,7 @@ "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", "mfa_enabled": false, "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", @@ -279,7 +281,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Powerpack data object.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Powerpack attribute object.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of this powerpack.

\n
\n \n
\n
\n
\n
\n
\n

group_widget [required]

\n
\n

object

\n

Powerpack group widget definition object.

\n
\n
\n
\n
\n
\n

definition [required]

\n
\n

object

\n

Powerpack group widget object.

\n
\n
\n
\n
\n
\n

layout_type [required]

\n
\n

string

\n

Layout type of widgets.

\n
\n \n
\n
\n
\n
\n
\n

show_title

\n
\n

boolean

\n

Boolean indicating whether powerpack group title should be visible or not.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Name for the group widget.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Type of widget, must be group.

\n
\n \n
\n
\n
\n
\n
\n

widgets [required]

\n
\n

[object]

\n

Widgets inside the powerpack.

\n
\n
\n
\n
\n
\n

definition [required]

\n
\n

object

\n

Information about widget.

\n
\n \n
\n
\n
\n
\n
\n

layout

\n
\n

object

\n

Powerpack inner widget layout.

\n
\n
\n
\n
\n
\n

height [required]

\n
\n

int64

\n

The height of the widget. Should be a non-negative integer.

\n
\n \n
\n
\n
\n
\n
\n

width [required]

\n
\n

int64

\n

The width of the widget. Should be a non-negative integer.

\n
\n \n
\n
\n
\n
\n
\n

x [required]

\n
\n

int64

\n

The position of the widget on the x (horizontal) axis. Should be a non-negative integer.

\n
\n \n
\n
\n
\n
\n
\n

y [required]

\n
\n

int64

\n

The position of the widget on the y (vertical) axis. Should be a non-negative integer.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

layout

\n
\n

object

\n

Powerpack group widget layout.

\n
\n
\n
\n
\n
\n

height [required]

\n
\n

int64

\n

The height of the widget. Should be a non-negative integer.

\n
\n \n
\n
\n
\n
\n
\n

width [required]

\n
\n

int64

\n

The width of the widget. Should be a non-negative integer.

\n
\n \n
\n
\n
\n
\n
\n

x [required]

\n
\n

int64

\n

The position of the widget on the x (horizontal) axis. Should be a non-negative integer.

\n
\n \n
\n
\n
\n
\n
\n

y [required]

\n
\n

int64

\n

The position of the widget on the y (vertical) axis. Should be a non-negative integer.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

live_span

\n
\n

enum

\n

The available timeframes depend on the widget you are using. \nAllowed enum values: 1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,1y,alert

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the powerpack.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

List of tags to identify this powerpack.

\n
\n \n
\n
\n
\n
\n
\n

template_variables

\n
\n

[object]

\n

List of template variables for this powerpack.

\n
\n
\n
\n
\n
\n

available_values

\n
\n

[string]

\n

The list of values that the template variable drop-down is limited to.

\n
\n \n
\n
\n
\n
\n
\n

defaults

\n
\n

[string]

\n

One or many template variable default values within the saved view, which are unioned together using OR if more than one is specified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the variable.

\n
\n \n
\n
\n
\n
\n
\n

prefix

\n
\n

string

\n

The tag prefix associated with the variable. Only tags with this prefix appear in the variable drop-down.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the powerpack.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Powerpack relationship object.

\n
\n
\n
\n
\n
\n

author

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Type of widget, must be powerpack.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[object]

\n

Array of objects related to the users.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Powerpack data object.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Powerpack attribute object.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of this powerpack.

\n
\n \n
\n
\n
\n
\n
\n

group_widget [required]

\n
\n

object

\n

Powerpack group widget definition object.

\n
\n
\n
\n
\n
\n

definition [required]

\n
\n

object

\n

Powerpack group widget object.

\n
\n
\n
\n
\n
\n

layout_type [required]

\n
\n

string

\n

Layout type of widgets.

\n
\n \n
\n
\n
\n
\n
\n

show_title

\n
\n

boolean

\n

Boolean indicating whether powerpack group title should be visible or not.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Name for the group widget.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Type of widget, must be group.

\n
\n \n
\n
\n
\n
\n
\n

widgets [required]

\n
\n

[object]

\n

Widgets inside the powerpack.

\n
\n
\n
\n
\n
\n

definition [required]

\n
\n

object

\n

Information about widget.

\n
\n \n
\n
\n
\n
\n
\n

layout

\n
\n

object

\n

Powerpack inner widget layout.

\n
\n
\n
\n
\n
\n

height [required]

\n
\n

int64

\n

The height of the widget. Should be a non-negative integer.

\n
\n \n
\n
\n
\n
\n
\n

width [required]

\n
\n

int64

\n

The width of the widget. Should be a non-negative integer.

\n
\n \n
\n
\n
\n
\n
\n

x [required]

\n
\n

int64

\n

The position of the widget on the x (horizontal) axis. Should be a non-negative integer.

\n
\n \n
\n
\n
\n
\n
\n

y [required]

\n
\n

int64

\n

The position of the widget on the y (vertical) axis. Should be a non-negative integer.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

layout

\n
\n

object

\n

Powerpack group widget layout.

\n
\n
\n
\n
\n
\n

height [required]

\n
\n

int64

\n

The height of the widget. Should be a non-negative integer.

\n
\n \n
\n
\n
\n
\n
\n

width [required]

\n
\n

int64

\n

The width of the widget. Should be a non-negative integer.

\n
\n \n
\n
\n
\n
\n
\n

x [required]

\n
\n

int64

\n

The position of the widget on the x (horizontal) axis. Should be a non-negative integer.

\n
\n \n
\n
\n
\n
\n
\n

y [required]

\n
\n

int64

\n

The position of the widget on the y (vertical) axis. Should be a non-negative integer.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

live_span

\n
\n

enum

\n

The available timeframes depend on the widget you are using. \nAllowed enum values: 1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,1y,alert

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the powerpack.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

List of tags to identify this powerpack.

\n
\n \n
\n
\n
\n
\n
\n

template_variables

\n
\n

[object]

\n

List of template variables for this powerpack.

\n
\n
\n
\n
\n
\n

available_values

\n
\n

[string]

\n

The list of values that the template variable drop-down is limited to.

\n
\n \n
\n
\n
\n
\n
\n

defaults

\n
\n

[string]

\n

One or many template variable default values within the saved view, which are unioned together using OR if more than one is specified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the variable.

\n
\n \n
\n
\n
\n
\n
\n

prefix

\n
\n

string

\n

The tag prefix associated with the variable. Only tags with this prefix appear in the variable drop-down.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the powerpack.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Powerpack relationship object.

\n
\n
\n
\n
\n
\n

author

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Type of widget, must be powerpack.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[object]

\n

Array of objects related to the users.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -517,6 +519,7 @@ "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", "mfa_enabled": false, "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", @@ -562,7 +565,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Powerpack data object.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Powerpack attribute object.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of this powerpack.

\n
\n \n
\n
\n
\n
\n
\n

group_widget [required]

\n
\n

object

\n

Powerpack group widget definition object.

\n
\n
\n
\n
\n
\n

definition [required]

\n
\n

object

\n

Powerpack group widget object.

\n
\n
\n
\n
\n
\n

layout_type [required]

\n
\n

string

\n

Layout type of widgets.

\n
\n \n
\n
\n
\n
\n
\n

show_title

\n
\n

boolean

\n

Boolean indicating whether powerpack group title should be visible or not.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Name for the group widget.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Type of widget, must be group.

\n
\n \n
\n
\n
\n
\n
\n

widgets [required]

\n
\n

[object]

\n

Widgets inside the powerpack.

\n
\n
\n
\n
\n
\n

definition [required]

\n
\n

object

\n

Information about widget.

\n
\n \n
\n
\n
\n
\n
\n

layout

\n
\n

object

\n

Powerpack inner widget layout.

\n
\n
\n
\n
\n
\n

height [required]

\n
\n

int64

\n

The height of the widget. Should be a non-negative integer.

\n
\n \n
\n
\n
\n
\n
\n

width [required]

\n
\n

int64

\n

The width of the widget. Should be a non-negative integer.

\n
\n \n
\n
\n
\n
\n
\n

x [required]

\n
\n

int64

\n

The position of the widget on the x (horizontal) axis. Should be a non-negative integer.

\n
\n \n
\n
\n
\n
\n
\n

y [required]

\n
\n

int64

\n

The position of the widget on the y (vertical) axis. Should be a non-negative integer.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

layout

\n
\n

object

\n

Powerpack group widget layout.

\n
\n
\n
\n
\n
\n

height [required]

\n
\n

int64

\n

The height of the widget. Should be a non-negative integer.

\n
\n \n
\n
\n
\n
\n
\n

width [required]

\n
\n

int64

\n

The width of the widget. Should be a non-negative integer.

\n
\n \n
\n
\n
\n
\n
\n

x [required]

\n
\n

int64

\n

The position of the widget on the x (horizontal) axis. Should be a non-negative integer.

\n
\n \n
\n
\n
\n
\n
\n

y [required]

\n
\n

int64

\n

The position of the widget on the y (vertical) axis. Should be a non-negative integer.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

live_span

\n
\n

enum

\n

The available timeframes depend on the widget you are using. \nAllowed enum values: 1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,1y,alert

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the powerpack.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

List of tags to identify this powerpack.

\n
\n \n
\n
\n
\n
\n
\n

template_variables

\n
\n

[object]

\n

List of template variables for this powerpack.

\n
\n
\n
\n
\n
\n

available_values

\n
\n

[string]

\n

The list of values that the template variable drop-down is limited to.

\n
\n \n
\n
\n
\n
\n
\n

defaults

\n
\n

[string]

\n

One or many template variable default values within the saved view, which are unioned together using OR if more than one is specified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the variable.

\n
\n \n
\n
\n
\n
\n
\n

prefix

\n
\n

string

\n

The tag prefix associated with the variable. Only tags with this prefix appear in the variable drop-down.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the powerpack.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Powerpack relationship object.

\n
\n
\n
\n
\n
\n

author

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Type of widget, must be powerpack.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[object]

\n

Array of objects related to the users.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Powerpack data object.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Powerpack attribute object.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of this powerpack.

\n
\n \n
\n
\n
\n
\n
\n

group_widget [required]

\n
\n

object

\n

Powerpack group widget definition object.

\n
\n
\n
\n
\n
\n

definition [required]

\n
\n

object

\n

Powerpack group widget object.

\n
\n
\n
\n
\n
\n

layout_type [required]

\n
\n

string

\n

Layout type of widgets.

\n
\n \n
\n
\n
\n
\n
\n

show_title

\n
\n

boolean

\n

Boolean indicating whether powerpack group title should be visible or not.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Name for the group widget.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Type of widget, must be group.

\n
\n \n
\n
\n
\n
\n
\n

widgets [required]

\n
\n

[object]

\n

Widgets inside the powerpack.

\n
\n
\n
\n
\n
\n

definition [required]

\n
\n

object

\n

Information about widget.

\n
\n \n
\n
\n
\n
\n
\n

layout

\n
\n

object

\n

Powerpack inner widget layout.

\n
\n
\n
\n
\n
\n

height [required]

\n
\n

int64

\n

The height of the widget. Should be a non-negative integer.

\n
\n \n
\n
\n
\n
\n
\n

width [required]

\n
\n

int64

\n

The width of the widget. Should be a non-negative integer.

\n
\n \n
\n
\n
\n
\n
\n

x [required]

\n
\n

int64

\n

The position of the widget on the x (horizontal) axis. Should be a non-negative integer.

\n
\n \n
\n
\n
\n
\n
\n

y [required]

\n
\n

int64

\n

The position of the widget on the y (vertical) axis. Should be a non-negative integer.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

layout

\n
\n

object

\n

Powerpack group widget layout.

\n
\n
\n
\n
\n
\n

height [required]

\n
\n

int64

\n

The height of the widget. Should be a non-negative integer.

\n
\n \n
\n
\n
\n
\n
\n

width [required]

\n
\n

int64

\n

The width of the widget. Should be a non-negative integer.

\n
\n \n
\n
\n
\n
\n
\n

x [required]

\n
\n

int64

\n

The position of the widget on the x (horizontal) axis. Should be a non-negative integer.

\n
\n \n
\n
\n
\n
\n
\n

y [required]

\n
\n

int64

\n

The position of the widget on the y (vertical) axis. Should be a non-negative integer.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

live_span

\n
\n

enum

\n

The available timeframes depend on the widget you are using. \nAllowed enum values: 1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,1y,alert

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the powerpack.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

List of tags to identify this powerpack.

\n
\n \n
\n
\n
\n
\n
\n

template_variables

\n
\n

[object]

\n

List of template variables for this powerpack.

\n
\n
\n
\n
\n
\n

available_values

\n
\n

[string]

\n

The list of values that the template variable drop-down is limited to.

\n
\n \n
\n
\n
\n
\n
\n

defaults

\n
\n

[string]

\n

One or many template variable default values within the saved view, which are unioned together using OR if more than one is specified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the variable.

\n
\n \n
\n
\n
\n
\n
\n

prefix

\n
\n

string

\n

The tag prefix associated with the variable. Only tags with this prefix appear in the variable drop-down.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the powerpack.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Powerpack relationship object.

\n
\n
\n
\n
\n
\n

author

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Type of widget, must be powerpack.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[object]

\n

Array of objects related to the users.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
" }, "404": { "json": { @@ -663,6 +666,7 @@ "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", "mfa_enabled": false, "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", @@ -708,7 +712,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Powerpack data object.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Powerpack attribute object.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of this powerpack.

\n
\n \n
\n
\n
\n
\n
\n

group_widget [required]

\n
\n

object

\n

Powerpack group widget definition object.

\n
\n
\n
\n
\n
\n

definition [required]

\n
\n

object

\n

Powerpack group widget object.

\n
\n
\n
\n
\n
\n

layout_type [required]

\n
\n

string

\n

Layout type of widgets.

\n
\n \n
\n
\n
\n
\n
\n

show_title

\n
\n

boolean

\n

Boolean indicating whether powerpack group title should be visible or not.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Name for the group widget.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Type of widget, must be group.

\n
\n \n
\n
\n
\n
\n
\n

widgets [required]

\n
\n

[object]

\n

Widgets inside the powerpack.

\n
\n
\n
\n
\n
\n

definition [required]

\n
\n

object

\n

Information about widget.

\n
\n \n
\n
\n
\n
\n
\n

layout

\n
\n

object

\n

Powerpack inner widget layout.

\n
\n
\n
\n
\n
\n

height [required]

\n
\n

int64

\n

The height of the widget. Should be a non-negative integer.

\n
\n \n
\n
\n
\n
\n
\n

width [required]

\n
\n

int64

\n

The width of the widget. Should be a non-negative integer.

\n
\n \n
\n
\n
\n
\n
\n

x [required]

\n
\n

int64

\n

The position of the widget on the x (horizontal) axis. Should be a non-negative integer.

\n
\n \n
\n
\n
\n
\n
\n

y [required]

\n
\n

int64

\n

The position of the widget on the y (vertical) axis. Should be a non-negative integer.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

layout

\n
\n

object

\n

Powerpack group widget layout.

\n
\n
\n
\n
\n
\n

height [required]

\n
\n

int64

\n

The height of the widget. Should be a non-negative integer.

\n
\n \n
\n
\n
\n
\n
\n

width [required]

\n
\n

int64

\n

The width of the widget. Should be a non-negative integer.

\n
\n \n
\n
\n
\n
\n
\n

x [required]

\n
\n

int64

\n

The position of the widget on the x (horizontal) axis. Should be a non-negative integer.

\n
\n \n
\n
\n
\n
\n
\n

y [required]

\n
\n

int64

\n

The position of the widget on the y (vertical) axis. Should be a non-negative integer.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

live_span

\n
\n

enum

\n

The available timeframes depend on the widget you are using. \nAllowed enum values: 1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,1y,alert

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the powerpack.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

List of tags to identify this powerpack.

\n
\n \n
\n
\n
\n
\n
\n

template_variables

\n
\n

[object]

\n

List of template variables for this powerpack.

\n
\n
\n
\n
\n
\n

available_values

\n
\n

[string]

\n

The list of values that the template variable drop-down is limited to.

\n
\n \n
\n
\n
\n
\n
\n

defaults

\n
\n

[string]

\n

One or many template variable default values within the saved view, which are unioned together using OR if more than one is specified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the variable.

\n
\n \n
\n
\n
\n
\n
\n

prefix

\n
\n

string

\n

The tag prefix associated with the variable. Only tags with this prefix appear in the variable drop-down.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the powerpack.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Powerpack relationship object.

\n
\n
\n
\n
\n
\n

author

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Type of widget, must be powerpack.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[object]

\n

Array of objects related to the users.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Powerpack data object.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Powerpack attribute object.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of this powerpack.

\n
\n \n
\n
\n
\n
\n
\n

group_widget [required]

\n
\n

object

\n

Powerpack group widget definition object.

\n
\n
\n
\n
\n
\n

definition [required]

\n
\n

object

\n

Powerpack group widget object.

\n
\n
\n
\n
\n
\n

layout_type [required]

\n
\n

string

\n

Layout type of widgets.

\n
\n \n
\n
\n
\n
\n
\n

show_title

\n
\n

boolean

\n

Boolean indicating whether powerpack group title should be visible or not.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Name for the group widget.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Type of widget, must be group.

\n
\n \n
\n
\n
\n
\n
\n

widgets [required]

\n
\n

[object]

\n

Widgets inside the powerpack.

\n
\n
\n
\n
\n
\n

definition [required]

\n
\n

object

\n

Information about widget.

\n
\n \n
\n
\n
\n
\n
\n

layout

\n
\n

object

\n

Powerpack inner widget layout.

\n
\n
\n
\n
\n
\n

height [required]

\n
\n

int64

\n

The height of the widget. Should be a non-negative integer.

\n
\n \n
\n
\n
\n
\n
\n

width [required]

\n
\n

int64

\n

The width of the widget. Should be a non-negative integer.

\n
\n \n
\n
\n
\n
\n
\n

x [required]

\n
\n

int64

\n

The position of the widget on the x (horizontal) axis. Should be a non-negative integer.

\n
\n \n
\n
\n
\n
\n
\n

y [required]

\n
\n

int64

\n

The position of the widget on the y (vertical) axis. Should be a non-negative integer.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

layout

\n
\n

object

\n

Powerpack group widget layout.

\n
\n
\n
\n
\n
\n

height [required]

\n
\n

int64

\n

The height of the widget. Should be a non-negative integer.

\n
\n \n
\n
\n
\n
\n
\n

width [required]

\n
\n

int64

\n

The width of the widget. Should be a non-negative integer.

\n
\n \n
\n
\n
\n
\n
\n

x [required]

\n
\n

int64

\n

The position of the widget on the x (horizontal) axis. Should be a non-negative integer.

\n
\n \n
\n
\n
\n
\n
\n

y [required]

\n
\n

int64

\n

The position of the widget on the y (vertical) axis. Should be a non-negative integer.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

live_span

\n
\n

enum

\n

The available timeframes depend on the widget you are using. \nAllowed enum values: 1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,1y,alert

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the powerpack.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

List of tags to identify this powerpack.

\n
\n \n
\n
\n
\n
\n
\n

template_variables

\n
\n

[object]

\n

List of template variables for this powerpack.

\n
\n
\n
\n
\n
\n

available_values

\n
\n

[string]

\n

The list of values that the template variable drop-down is limited to.

\n
\n \n
\n
\n
\n
\n
\n

defaults

\n
\n

[string]

\n

One or many template variable default values within the saved view, which are unioned together using OR if more than one is specified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the variable.

\n
\n \n
\n
\n
\n
\n
\n

prefix

\n
\n

string

\n

The tag prefix associated with the variable. Only tags with this prefix appear in the variable drop-down.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the powerpack.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Powerpack relationship object.

\n
\n
\n
\n
\n
\n

author

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Type of widget, must be powerpack.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[object]

\n

Array of objects related to the users.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
" }, "400": { "json": { diff --git a/content/en/api/v2/roles/examples.json b/content/en/api/v2/roles/examples.json index e414dfd38e7aa..d61f8710285cf 100644 --- a/content/en/api/v2/roles/examples.json +++ b/content/en/api/v2/roles/examples.json @@ -697,6 +697,7 @@ "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", "mfa_enabled": false, "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", @@ -764,7 +765,7 @@ } } }, - "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

Array of returned users.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of objects related to the users.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Organization object.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the organization.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the organization.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the organization.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether or not the organization is disabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time of last organization modification.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the organization.

\n
\n \n
\n
\n
\n
\n
\n

public_id

\n
\n

string

\n

Public ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

sharing

\n
\n

string

\n

Sharing type of the organization.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL of the site that this organization exists at.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Permission object.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of a permission.

\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Creation time of the permission.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the permission.

\n
\n \n
\n
\n
\n
\n
\n

display_name

\n
\n

string

\n

Displayed name for the permission.

\n
\n \n
\n
\n
\n
\n
\n

display_type

\n
\n

string

\n

Display type.

\n
\n \n
\n
\n
\n
\n
\n

group_name

\n
\n

string

\n

Name of the permission group.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the permission.

\n
\n \n
\n
\n
\n
\n
\n

restricted

\n
\n

boolean

\n

Whether or not the permission is restricted.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the permission.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Permissions resource type. \nAllowed enum values: permissions

default: permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Role object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the role.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the role.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time of last role modification.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the role. The name is neither unique nor a stable identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int64

\n

Number of users with that role.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the role object returned by the API.

\n
\n
\n
\n
\n
\n

permissions

\n
\n

object

\n

Relationship to multiple permissions objects.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Relationships to permission objects.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the permission.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Permissions resource type. \nAllowed enum values: permissions

default: permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Object describing meta attributes of response.

\n
\n
\n
\n
\n
\n

page

\n
\n

object

\n

Pagination object.

\n
\n
\n
\n
\n
\n

total_count

\n
\n

int64

\n

Total count.

\n
\n \n
\n
\n
\n
\n
\n

total_filtered_count

\n
\n

int64

\n

Total count of elements matched by the filter.

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

Array of returned users.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of objects related to the users.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Organization object.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the organization.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the organization.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the organization.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether or not the organization is disabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time of last organization modification.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the organization.

\n
\n \n
\n
\n
\n
\n
\n

public_id

\n
\n

string

\n

Public ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

sharing

\n
\n

string

\n

Sharing type of the organization.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL of the site that this organization exists at.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Permission object.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of a permission.

\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Creation time of the permission.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the permission.

\n
\n \n
\n
\n
\n
\n
\n

display_name

\n
\n

string

\n

Displayed name for the permission.

\n
\n \n
\n
\n
\n
\n
\n

display_type

\n
\n

string

\n

Display type.

\n
\n \n
\n
\n
\n
\n
\n

group_name

\n
\n

string

\n

Name of the permission group.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the permission.

\n
\n \n
\n
\n
\n
\n
\n

restricted

\n
\n

boolean

\n

Whether or not the permission is restricted.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the permission.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Permissions resource type. \nAllowed enum values: permissions

default: permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Role object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the role.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the role.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time of last role modification.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the role. The name is neither unique nor a stable identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int64

\n

Number of users with that role.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the role object returned by the API.

\n
\n
\n
\n
\n
\n

permissions

\n
\n

object

\n

Relationship to multiple permissions objects.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Relationships to permission objects.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the permission.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Permissions resource type. \nAllowed enum values: permissions

default: permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Object describing meta attributes of response.

\n
\n
\n
\n
\n
\n

page

\n
\n

object

\n

Pagination object.

\n
\n
\n
\n
\n
\n

total_count

\n
\n

int64

\n

Total count.

\n
\n \n
\n
\n
\n
\n
\n

total_filtered_count

\n
\n

int64

\n

Total count of elements matched by the filter.

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { @@ -827,6 +828,7 @@ "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", "mfa_enabled": false, "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", @@ -894,7 +896,7 @@ } } }, - "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

Array of returned users.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of objects related to the users.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Organization object.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the organization.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the organization.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the organization.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether or not the organization is disabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time of last organization modification.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the organization.

\n
\n \n
\n
\n
\n
\n
\n

public_id

\n
\n

string

\n

Public ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

sharing

\n
\n

string

\n

Sharing type of the organization.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL of the site that this organization exists at.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Permission object.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of a permission.

\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Creation time of the permission.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the permission.

\n
\n \n
\n
\n
\n
\n
\n

display_name

\n
\n

string

\n

Displayed name for the permission.

\n
\n \n
\n
\n
\n
\n
\n

display_type

\n
\n

string

\n

Display type.

\n
\n \n
\n
\n
\n
\n
\n

group_name

\n
\n

string

\n

Name of the permission group.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the permission.

\n
\n \n
\n
\n
\n
\n
\n

restricted

\n
\n

boolean

\n

Whether or not the permission is restricted.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the permission.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Permissions resource type. \nAllowed enum values: permissions

default: permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Role object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the role.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the role.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time of last role modification.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the role. The name is neither unique nor a stable identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int64

\n

Number of users with that role.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the role object returned by the API.

\n
\n
\n
\n
\n
\n

permissions

\n
\n

object

\n

Relationship to multiple permissions objects.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Relationships to permission objects.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the permission.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Permissions resource type. \nAllowed enum values: permissions

default: permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Object describing meta attributes of response.

\n
\n
\n
\n
\n
\n

page

\n
\n

object

\n

Pagination object.

\n
\n
\n
\n
\n
\n

total_count

\n
\n

int64

\n

Total count.

\n
\n \n
\n
\n
\n
\n
\n

total_filtered_count

\n
\n

int64

\n

Total count of elements matched by the filter.

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

Array of returned users.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of objects related to the users.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Organization object.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the organization.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the organization.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the organization.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether or not the organization is disabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time of last organization modification.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the organization.

\n
\n \n
\n
\n
\n
\n
\n

public_id

\n
\n

string

\n

Public ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

sharing

\n
\n

string

\n

Sharing type of the organization.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL of the site that this organization exists at.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Permission object.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of a permission.

\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Creation time of the permission.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the permission.

\n
\n \n
\n
\n
\n
\n
\n

display_name

\n
\n

string

\n

Displayed name for the permission.

\n
\n \n
\n
\n
\n
\n
\n

display_type

\n
\n

string

\n

Display type.

\n
\n \n
\n
\n
\n
\n
\n

group_name

\n
\n

string

\n

Name of the permission group.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the permission.

\n
\n \n
\n
\n
\n
\n
\n

restricted

\n
\n

boolean

\n

Whether or not the permission is restricted.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the permission.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Permissions resource type. \nAllowed enum values: permissions

default: permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Role object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the role.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the role.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time of last role modification.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the role. The name is neither unique nor a stable identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int64

\n

Number of users with that role.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the role object returned by the API.

\n
\n
\n
\n
\n
\n

permissions

\n
\n

object

\n

Relationship to multiple permissions objects.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Relationships to permission objects.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the permission.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Permissions resource type. \nAllowed enum values: permissions

default: permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Object describing meta attributes of response.

\n
\n
\n
\n
\n
\n

page

\n
\n

object

\n

Pagination object.

\n
\n
\n
\n
\n
\n

total_count

\n
\n

int64

\n

Total count.

\n
\n \n
\n
\n
\n
\n
\n

total_filtered_count

\n
\n

int64

\n

Total count of elements matched by the filter.

\n
\n \n
\n
\n
\n
\n
\n
" }, "403": { "json": { @@ -939,6 +941,7 @@ "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", "mfa_enabled": false, "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", @@ -1006,7 +1009,7 @@ } } }, - "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

Array of returned users.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of objects related to the users.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Organization object.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the organization.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the organization.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the organization.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether or not the organization is disabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time of last organization modification.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the organization.

\n
\n \n
\n
\n
\n
\n
\n

public_id

\n
\n

string

\n

Public ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

sharing

\n
\n

string

\n

Sharing type of the organization.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL of the site that this organization exists at.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Permission object.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of a permission.

\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Creation time of the permission.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the permission.

\n
\n \n
\n
\n
\n
\n
\n

display_name

\n
\n

string

\n

Displayed name for the permission.

\n
\n \n
\n
\n
\n
\n
\n

display_type

\n
\n

string

\n

Display type.

\n
\n \n
\n
\n
\n
\n
\n

group_name

\n
\n

string

\n

Name of the permission group.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the permission.

\n
\n \n
\n
\n
\n
\n
\n

restricted

\n
\n

boolean

\n

Whether or not the permission is restricted.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the permission.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Permissions resource type. \nAllowed enum values: permissions

default: permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Role object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the role.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the role.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time of last role modification.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the role. The name is neither unique nor a stable identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int64

\n

Number of users with that role.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the role object returned by the API.

\n
\n
\n
\n
\n
\n

permissions

\n
\n

object

\n

Relationship to multiple permissions objects.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Relationships to permission objects.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the permission.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Permissions resource type. \nAllowed enum values: permissions

default: permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Object describing meta attributes of response.

\n
\n
\n
\n
\n
\n

page

\n
\n

object

\n

Pagination object.

\n
\n
\n
\n
\n
\n

total_count

\n
\n

int64

\n

Total count.

\n
\n \n
\n
\n
\n
\n
\n

total_filtered_count

\n
\n

int64

\n

Total count of elements matched by the filter.

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

Array of returned users.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of objects related to the users.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Organization object.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the organization.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the organization.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the organization.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether or not the organization is disabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time of last organization modification.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the organization.

\n
\n \n
\n
\n
\n
\n
\n

public_id

\n
\n

string

\n

Public ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

sharing

\n
\n

string

\n

Sharing type of the organization.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL of the site that this organization exists at.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Permission object.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of a permission.

\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Creation time of the permission.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the permission.

\n
\n \n
\n
\n
\n
\n
\n

display_name

\n
\n

string

\n

Displayed name for the permission.

\n
\n \n
\n
\n
\n
\n
\n

display_type

\n
\n

string

\n

Display type.

\n
\n \n
\n
\n
\n
\n
\n

group_name

\n
\n

string

\n

Name of the permission group.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the permission.

\n
\n \n
\n
\n
\n
\n
\n

restricted

\n
\n

boolean

\n

Whether or not the permission is restricted.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the permission.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Permissions resource type. \nAllowed enum values: permissions

default: permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Role object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the role.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the role.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time of last role modification.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the role. The name is neither unique nor a stable identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int64

\n

Number of users with that role.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the role object returned by the API.

\n
\n
\n
\n
\n
\n

permissions

\n
\n

object

\n

Relationship to multiple permissions objects.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Relationships to permission objects.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the permission.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Permissions resource type. \nAllowed enum values: permissions

default: permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Object describing meta attributes of response.

\n
\n
\n
\n
\n
\n

page

\n
\n

object

\n

Pagination object.

\n
\n
\n
\n
\n
\n

total_count

\n
\n

int64

\n

Total count.

\n
\n \n
\n
\n
\n
\n
\n

total_filtered_count

\n
\n

int64

\n

Total count of elements matched by the filter.

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { diff --git a/content/en/api/v2/security-monitoring/examples.json b/content/en/api/v2/security-monitoring/examples.json index 52a6c564baddf..9f9521b910e6e 100644 --- a/content/en/api/v2/security-monitoring/examples.json +++ b/content/en/api/v2/security-monitoring/examples.json @@ -2744,6 +2744,10 @@ "rule_query": "type:log_detection source:cloudtrail", "start_date": 1703187336000, "suppression_query": "env:staging status:low", + "tags": [ + "technique:T1110-brute-force", + "source:cloudtrail" + ], "update_date": "integer", "updater": { "handle": "john.doe@datadoghq.com", @@ -2756,7 +2760,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

A list of suppressions objects.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of the suppression rule.

\n
\n
\n
\n
\n
\n

creation_date

\n
\n

int64

\n

A Unix millisecond timestamp given the creation date of the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

creator

\n
\n

object

\n

A user.

\n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

data_exclusion_query

\n
\n

string

\n

An exclusion query on the input data of the security rules, which could be logs, Agent events, or other types of data based on the security rule. Events matching this query are ignored by any detection rules referenced in the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

A description for the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

editable

\n
\n

boolean

\n

Whether the suppression rule is editable.

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether the suppression rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

expiration_date

\n
\n

int64

\n

A Unix millisecond timestamp giving an expiration date for the suppression rule. After this date, it won't suppress signals anymore.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

rule_query

\n
\n

string

\n

The rule query of the suppression rule, with the same syntax as the search bar for detection rules.

\n
\n \n
\n
\n
\n
\n
\n

start_date

\n
\n

int64

\n

A Unix millisecond timestamp giving the start date for the suppression rule. After this date, it starts suppressing signals.

\n
\n \n
\n
\n
\n
\n
\n

suppression_query

\n
\n

string

\n

The suppression query of the suppression rule. If a signal matches this query, it is suppressed and not triggered. Same syntax as the queries to search signals in the signal explorer.

\n
\n \n
\n
\n
\n
\n
\n

update_date

\n
\n

int64

\n

A Unix millisecond timestamp given the update date of the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

updater

\n
\n

object

\n

A user.

\n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

version

\n
\n

int32

\n

The version of the suppression rule; it starts at 1, and is incremented at each update.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the resource. The value should always be suppressions. \nAllowed enum values: suppressions

default: suppressions

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

A list of suppressions objects.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of the suppression rule.

\n
\n
\n
\n
\n
\n

creation_date

\n
\n

int64

\n

A Unix millisecond timestamp given the creation date of the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

creator

\n
\n

object

\n

A user.

\n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

data_exclusion_query

\n
\n

string

\n

An exclusion query on the input data of the security rules, which could be logs, Agent events, or other types of data based on the security rule. Events matching this query are ignored by any detection rules referenced in the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

A description for the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

editable

\n
\n

boolean

\n

Whether the suppression rule is editable.

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether the suppression rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

expiration_date

\n
\n

int64

\n

A Unix millisecond timestamp giving an expiration date for the suppression rule. After this date, it won't suppress signals anymore.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

rule_query

\n
\n

string

\n

The rule query of the suppression rule, with the same syntax as the search bar for detection rules.

\n
\n \n
\n
\n
\n
\n
\n

start_date

\n
\n

int64

\n

A Unix millisecond timestamp giving the start date for the suppression rule. After this date, it starts suppressing signals.

\n
\n \n
\n
\n
\n
\n
\n

suppression_query

\n
\n

string

\n

The suppression query of the suppression rule. If a signal matches this query, it is suppressed and not triggered. Same syntax as the queries to search signals in the signal explorer.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

List of tags associated with the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

update_date

\n
\n

int64

\n

A Unix millisecond timestamp given the update date of the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

updater

\n
\n

object

\n

A user.

\n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

version

\n
\n

int32

\n

The version of the suppression rule; it starts at 1, and is incremented at each update.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the resource. The value should always be suppressions. \nAllowed enum values: suppressions

default: suppressions

\n
\n \n
\n
\n
\n
" }, "403": { "json": { @@ -2801,6 +2805,10 @@ "rule_query": "type:log_detection source:cloudtrail", "start_date": 1703187336000, "suppression_query": "env:staging status:low", + "tags": [ + "technique:T1110-brute-force", + "source:cloudtrail" + ], "update_date": "integer", "updater": { "handle": "john.doe@datadoghq.com", @@ -2812,7 +2820,7 @@ "type": "suppressions" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The suppression rule's properties.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of the suppression rule.

\n
\n
\n
\n
\n
\n

creation_date

\n
\n

int64

\n

A Unix millisecond timestamp given the creation date of the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

creator

\n
\n

object

\n

A user.

\n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

data_exclusion_query

\n
\n

string

\n

An exclusion query on the input data of the security rules, which could be logs, Agent events, or other types of data based on the security rule. Events matching this query are ignored by any detection rules referenced in the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

A description for the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

editable

\n
\n

boolean

\n

Whether the suppression rule is editable.

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether the suppression rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

expiration_date

\n
\n

int64

\n

A Unix millisecond timestamp giving an expiration date for the suppression rule. After this date, it won't suppress signals anymore.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

rule_query

\n
\n

string

\n

The rule query of the suppression rule, with the same syntax as the search bar for detection rules.

\n
\n \n
\n
\n
\n
\n
\n

start_date

\n
\n

int64

\n

A Unix millisecond timestamp giving the start date for the suppression rule. After this date, it starts suppressing signals.

\n
\n \n
\n
\n
\n
\n
\n

suppression_query

\n
\n

string

\n

The suppression query of the suppression rule. If a signal matches this query, it is suppressed and not triggered. Same syntax as the queries to search signals in the signal explorer.

\n
\n \n
\n
\n
\n
\n
\n

update_date

\n
\n

int64

\n

A Unix millisecond timestamp given the update date of the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

updater

\n
\n

object

\n

A user.

\n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

version

\n
\n

int32

\n

The version of the suppression rule; it starts at 1, and is incremented at each update.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the resource. The value should always be suppressions. \nAllowed enum values: suppressions

default: suppressions

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The suppression rule's properties.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of the suppression rule.

\n
\n
\n
\n
\n
\n

creation_date

\n
\n

int64

\n

A Unix millisecond timestamp given the creation date of the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

creator

\n
\n

object

\n

A user.

\n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

data_exclusion_query

\n
\n

string

\n

An exclusion query on the input data of the security rules, which could be logs, Agent events, or other types of data based on the security rule. Events matching this query are ignored by any detection rules referenced in the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

A description for the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

editable

\n
\n

boolean

\n

Whether the suppression rule is editable.

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether the suppression rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

expiration_date

\n
\n

int64

\n

A Unix millisecond timestamp giving an expiration date for the suppression rule. After this date, it won't suppress signals anymore.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

rule_query

\n
\n

string

\n

The rule query of the suppression rule, with the same syntax as the search bar for detection rules.

\n
\n \n
\n
\n
\n
\n
\n

start_date

\n
\n

int64

\n

A Unix millisecond timestamp giving the start date for the suppression rule. After this date, it starts suppressing signals.

\n
\n \n
\n
\n
\n
\n
\n

suppression_query

\n
\n

string

\n

The suppression query of the suppression rule. If a signal matches this query, it is suppressed and not triggered. Same syntax as the queries to search signals in the signal explorer.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

List of tags associated with the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

update_date

\n
\n

int64

\n

A Unix millisecond timestamp given the update date of the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

updater

\n
\n

object

\n

A user.

\n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

version

\n
\n

int32

\n

The version of the suppression rule; it starts at 1, and is incremented at each update.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the resource. The value should always be suppressions. \nAllowed enum values: suppressions

default: suppressions

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -2868,12 +2876,16 @@ "name": "Custom suppression", "rule_query": "type:log_detection source:cloudtrail", "start_date": 1703187336000, - "suppression_query": "env:staging status:low" + "suppression_query": "env:staging status:low", + "tags": [ + "technique:T1110-brute-force", + "source:cloudtrail" + ] }, "type": "suppressions" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Object for a single suppression rule.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Object containing the attributes of the suppression rule to be created.

\n
\n
\n
\n
\n
\n

data_exclusion_query

\n
\n

string

\n

An exclusion query on the input data of the security rules, which could be logs, Agent events, or other types of data based on the security rule. Events matching this query are ignored by any detection rules referenced in the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

A description for the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

enabled [required]

\n
\n

boolean

\n

Whether the suppression rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

expiration_date

\n
\n

int64

\n

A Unix millisecond timestamp giving an expiration date for the suppression rule. After this date, it won't suppress signals anymore.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

rule_query [required]

\n
\n

string

\n

The rule query of the suppression rule, with the same syntax as the search bar for detection rules.

\n
\n \n
\n
\n
\n
\n
\n

start_date

\n
\n

int64

\n

A Unix millisecond timestamp giving the start date for the suppression rule. After this date, it starts suppressing signals.

\n
\n \n
\n
\n
\n
\n
\n

suppression_query

\n
\n

string

\n

The suppression query of the suppression rule. If a signal matches this query, it is suppressed and is not triggered. It uses the same syntax as the queries to search signals in the Signals Explorer.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of the resource. The value should always be suppressions. \nAllowed enum values: suppressions

default: suppressions

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Object for a single suppression rule.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Object containing the attributes of the suppression rule to be created.

\n
\n
\n
\n
\n
\n

data_exclusion_query

\n
\n

string

\n

An exclusion query on the input data of the security rules, which could be logs, Agent events, or other types of data based on the security rule. Events matching this query are ignored by any detection rules referenced in the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

A description for the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

enabled [required]

\n
\n

boolean

\n

Whether the suppression rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

expiration_date

\n
\n

int64

\n

A Unix millisecond timestamp giving an expiration date for the suppression rule. After this date, it won't suppress signals anymore.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

rule_query [required]

\n
\n

string

\n

The rule query of the suppression rule, with the same syntax as the search bar for detection rules.

\n
\n \n
\n
\n
\n
\n
\n

start_date

\n
\n

int64

\n

A Unix millisecond timestamp giving the start date for the suppression rule. After this date, it starts suppressing signals.

\n
\n \n
\n
\n
\n
\n
\n

suppression_query

\n
\n

string

\n

The suppression query of the suppression rule. If a signal matches this query, it is suppressed and is not triggered. It uses the same syntax as the queries to search signals in the Signals Explorer.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

List of tags associated with the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of the resource. The value should always be suppressions. \nAllowed enum values: suppressions

default: suppressions

\n
\n \n
\n
\n
\n
" } }, "GetSuppressionsAffectingFutureRule": { @@ -2897,6 +2909,10 @@ "rule_query": "type:log_detection source:cloudtrail", "start_date": 1703187336000, "suppression_query": "env:staging status:low", + "tags": [ + "technique:T1110-brute-force", + "source:cloudtrail" + ], "update_date": "integer", "updater": { "handle": "john.doe@datadoghq.com", @@ -2909,7 +2925,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

A list of suppressions objects.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of the suppression rule.

\n
\n
\n
\n
\n
\n

creation_date

\n
\n

int64

\n

A Unix millisecond timestamp given the creation date of the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

creator

\n
\n

object

\n

A user.

\n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

data_exclusion_query

\n
\n

string

\n

An exclusion query on the input data of the security rules, which could be logs, Agent events, or other types of data based on the security rule. Events matching this query are ignored by any detection rules referenced in the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

A description for the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

editable

\n
\n

boolean

\n

Whether the suppression rule is editable.

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether the suppression rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

expiration_date

\n
\n

int64

\n

A Unix millisecond timestamp giving an expiration date for the suppression rule. After this date, it won't suppress signals anymore.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

rule_query

\n
\n

string

\n

The rule query of the suppression rule, with the same syntax as the search bar for detection rules.

\n
\n \n
\n
\n
\n
\n
\n

start_date

\n
\n

int64

\n

A Unix millisecond timestamp giving the start date for the suppression rule. After this date, it starts suppressing signals.

\n
\n \n
\n
\n
\n
\n
\n

suppression_query

\n
\n

string

\n

The suppression query of the suppression rule. If a signal matches this query, it is suppressed and not triggered. Same syntax as the queries to search signals in the signal explorer.

\n
\n \n
\n
\n
\n
\n
\n

update_date

\n
\n

int64

\n

A Unix millisecond timestamp given the update date of the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

updater

\n
\n

object

\n

A user.

\n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

version

\n
\n

int32

\n

The version of the suppression rule; it starts at 1, and is incremented at each update.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the resource. The value should always be suppressions. \nAllowed enum values: suppressions

default: suppressions

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

A list of suppressions objects.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of the suppression rule.

\n
\n
\n
\n
\n
\n

creation_date

\n
\n

int64

\n

A Unix millisecond timestamp given the creation date of the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

creator

\n
\n

object

\n

A user.

\n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

data_exclusion_query

\n
\n

string

\n

An exclusion query on the input data of the security rules, which could be logs, Agent events, or other types of data based on the security rule. Events matching this query are ignored by any detection rules referenced in the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

A description for the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

editable

\n
\n

boolean

\n

Whether the suppression rule is editable.

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether the suppression rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

expiration_date

\n
\n

int64

\n

A Unix millisecond timestamp giving an expiration date for the suppression rule. After this date, it won't suppress signals anymore.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

rule_query

\n
\n

string

\n

The rule query of the suppression rule, with the same syntax as the search bar for detection rules.

\n
\n \n
\n
\n
\n
\n
\n

start_date

\n
\n

int64

\n

A Unix millisecond timestamp giving the start date for the suppression rule. After this date, it starts suppressing signals.

\n
\n \n
\n
\n
\n
\n
\n

suppression_query

\n
\n

string

\n

The suppression query of the suppression rule. If a signal matches this query, it is suppressed and not triggered. Same syntax as the queries to search signals in the signal explorer.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

List of tags associated with the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

update_date

\n
\n

int64

\n

A Unix millisecond timestamp given the update date of the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

updater

\n
\n

object

\n

A user.

\n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

version

\n
\n

int32

\n

The version of the suppression rule; it starts at 1, and is incremented at each update.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the resource. The value should always be suppressions. \nAllowed enum values: suppressions

default: suppressions

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -3127,6 +3143,10 @@ "rule_query": "type:log_detection source:cloudtrail", "start_date": 1703187336000, "suppression_query": "env:staging status:low", + "tags": [ + "technique:T1110-brute-force", + "source:cloudtrail" + ], "update_date": "integer", "updater": { "handle": "john.doe@datadoghq.com", @@ -3139,7 +3159,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

A list of suppressions objects.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of the suppression rule.

\n
\n
\n
\n
\n
\n

creation_date

\n
\n

int64

\n

A Unix millisecond timestamp given the creation date of the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

creator

\n
\n

object

\n

A user.

\n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

data_exclusion_query

\n
\n

string

\n

An exclusion query on the input data of the security rules, which could be logs, Agent events, or other types of data based on the security rule. Events matching this query are ignored by any detection rules referenced in the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

A description for the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

editable

\n
\n

boolean

\n

Whether the suppression rule is editable.

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether the suppression rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

expiration_date

\n
\n

int64

\n

A Unix millisecond timestamp giving an expiration date for the suppression rule. After this date, it won't suppress signals anymore.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

rule_query

\n
\n

string

\n

The rule query of the suppression rule, with the same syntax as the search bar for detection rules.

\n
\n \n
\n
\n
\n
\n
\n

start_date

\n
\n

int64

\n

A Unix millisecond timestamp giving the start date for the suppression rule. After this date, it starts suppressing signals.

\n
\n \n
\n
\n
\n
\n
\n

suppression_query

\n
\n

string

\n

The suppression query of the suppression rule. If a signal matches this query, it is suppressed and not triggered. Same syntax as the queries to search signals in the signal explorer.

\n
\n \n
\n
\n
\n
\n
\n

update_date

\n
\n

int64

\n

A Unix millisecond timestamp given the update date of the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

updater

\n
\n

object

\n

A user.

\n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

version

\n
\n

int32

\n

The version of the suppression rule; it starts at 1, and is incremented at each update.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the resource. The value should always be suppressions. \nAllowed enum values: suppressions

default: suppressions

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

A list of suppressions objects.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of the suppression rule.

\n
\n
\n
\n
\n
\n

creation_date

\n
\n

int64

\n

A Unix millisecond timestamp given the creation date of the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

creator

\n
\n

object

\n

A user.

\n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

data_exclusion_query

\n
\n

string

\n

An exclusion query on the input data of the security rules, which could be logs, Agent events, or other types of data based on the security rule. Events matching this query are ignored by any detection rules referenced in the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

A description for the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

editable

\n
\n

boolean

\n

Whether the suppression rule is editable.

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether the suppression rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

expiration_date

\n
\n

int64

\n

A Unix millisecond timestamp giving an expiration date for the suppression rule. After this date, it won't suppress signals anymore.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

rule_query

\n
\n

string

\n

The rule query of the suppression rule, with the same syntax as the search bar for detection rules.

\n
\n \n
\n
\n
\n
\n
\n

start_date

\n
\n

int64

\n

A Unix millisecond timestamp giving the start date for the suppression rule. After this date, it starts suppressing signals.

\n
\n \n
\n
\n
\n
\n
\n

suppression_query

\n
\n

string

\n

The suppression query of the suppression rule. If a signal matches this query, it is suppressed and not triggered. Same syntax as the queries to search signals in the signal explorer.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

List of tags associated with the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

update_date

\n
\n

int64

\n

A Unix millisecond timestamp given the update date of the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

updater

\n
\n

object

\n

A user.

\n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

version

\n
\n

int32

\n

The version of the suppression rule; it starts at 1, and is incremented at each update.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the resource. The value should always be suppressions. \nAllowed enum values: suppressions

default: suppressions

\n
\n \n
\n
\n
\n
" }, "403": { "json": { @@ -3220,12 +3240,16 @@ "name": "Custom suppression", "rule_query": "type:log_detection source:cloudtrail", "start_date": 1703187336000, - "suppression_query": "env:staging status:low" + "suppression_query": "env:staging status:low", + "tags": [ + "technique:T1110-brute-force", + "source:cloudtrail" + ] }, "type": "suppressions" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Object for a single suppression rule.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Object containing the attributes of the suppression rule to be created.

\n
\n
\n
\n
\n
\n

data_exclusion_query

\n
\n

string

\n

An exclusion query on the input data of the security rules, which could be logs, Agent events, or other types of data based on the security rule. Events matching this query are ignored by any detection rules referenced in the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

A description for the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

enabled [required]

\n
\n

boolean

\n

Whether the suppression rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

expiration_date

\n
\n

int64

\n

A Unix millisecond timestamp giving an expiration date for the suppression rule. After this date, it won't suppress signals anymore.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

rule_query [required]

\n
\n

string

\n

The rule query of the suppression rule, with the same syntax as the search bar for detection rules.

\n
\n \n
\n
\n
\n
\n
\n

start_date

\n
\n

int64

\n

A Unix millisecond timestamp giving the start date for the suppression rule. After this date, it starts suppressing signals.

\n
\n \n
\n
\n
\n
\n
\n

suppression_query

\n
\n

string

\n

The suppression query of the suppression rule. If a signal matches this query, it is suppressed and is not triggered. It uses the same syntax as the queries to search signals in the Signals Explorer.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of the resource. The value should always be suppressions. \nAllowed enum values: suppressions

default: suppressions

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Object for a single suppression rule.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Object containing the attributes of the suppression rule to be created.

\n
\n
\n
\n
\n
\n

data_exclusion_query

\n
\n

string

\n

An exclusion query on the input data of the security rules, which could be logs, Agent events, or other types of data based on the security rule. Events matching this query are ignored by any detection rules referenced in the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

A description for the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

enabled [required]

\n
\n

boolean

\n

Whether the suppression rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

expiration_date

\n
\n

int64

\n

A Unix millisecond timestamp giving an expiration date for the suppression rule. After this date, it won't suppress signals anymore.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

rule_query [required]

\n
\n

string

\n

The rule query of the suppression rule, with the same syntax as the search bar for detection rules.

\n
\n \n
\n
\n
\n
\n
\n

start_date

\n
\n

int64

\n

A Unix millisecond timestamp giving the start date for the suppression rule. After this date, it starts suppressing signals.

\n
\n \n
\n
\n
\n
\n
\n

suppression_query

\n
\n

string

\n

The suppression query of the suppression rule. If a signal matches this query, it is suppressed and is not triggered. It uses the same syntax as the queries to search signals in the Signals Explorer.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

List of tags associated with the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of the resource. The value should always be suppressions. \nAllowed enum values: suppressions

default: suppressions

\n
\n \n
\n
\n
\n
" } }, "DeleteSecurityMonitoringSuppression": { @@ -3281,6 +3305,10 @@ "rule_query": "type:log_detection source:cloudtrail", "start_date": 1703187336000, "suppression_query": "env:staging status:low", + "tags": [ + "technique:T1110-brute-force", + "source:cloudtrail" + ], "update_date": "integer", "updater": { "handle": "john.doe@datadoghq.com", @@ -3292,7 +3320,7 @@ "type": "suppressions" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The suppression rule's properties.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of the suppression rule.

\n
\n
\n
\n
\n
\n

creation_date

\n
\n

int64

\n

A Unix millisecond timestamp given the creation date of the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

creator

\n
\n

object

\n

A user.

\n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

data_exclusion_query

\n
\n

string

\n

An exclusion query on the input data of the security rules, which could be logs, Agent events, or other types of data based on the security rule. Events matching this query are ignored by any detection rules referenced in the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

A description for the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

editable

\n
\n

boolean

\n

Whether the suppression rule is editable.

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether the suppression rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

expiration_date

\n
\n

int64

\n

A Unix millisecond timestamp giving an expiration date for the suppression rule. After this date, it won't suppress signals anymore.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

rule_query

\n
\n

string

\n

The rule query of the suppression rule, with the same syntax as the search bar for detection rules.

\n
\n \n
\n
\n
\n
\n
\n

start_date

\n
\n

int64

\n

A Unix millisecond timestamp giving the start date for the suppression rule. After this date, it starts suppressing signals.

\n
\n \n
\n
\n
\n
\n
\n

suppression_query

\n
\n

string

\n

The suppression query of the suppression rule. If a signal matches this query, it is suppressed and not triggered. Same syntax as the queries to search signals in the signal explorer.

\n
\n \n
\n
\n
\n
\n
\n

update_date

\n
\n

int64

\n

A Unix millisecond timestamp given the update date of the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

updater

\n
\n

object

\n

A user.

\n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

version

\n
\n

int32

\n

The version of the suppression rule; it starts at 1, and is incremented at each update.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the resource. The value should always be suppressions. \nAllowed enum values: suppressions

default: suppressions

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The suppression rule's properties.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of the suppression rule.

\n
\n
\n
\n
\n
\n

creation_date

\n
\n

int64

\n

A Unix millisecond timestamp given the creation date of the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

creator

\n
\n

object

\n

A user.

\n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

data_exclusion_query

\n
\n

string

\n

An exclusion query on the input data of the security rules, which could be logs, Agent events, or other types of data based on the security rule. Events matching this query are ignored by any detection rules referenced in the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

A description for the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

editable

\n
\n

boolean

\n

Whether the suppression rule is editable.

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether the suppression rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

expiration_date

\n
\n

int64

\n

A Unix millisecond timestamp giving an expiration date for the suppression rule. After this date, it won't suppress signals anymore.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

rule_query

\n
\n

string

\n

The rule query of the suppression rule, with the same syntax as the search bar for detection rules.

\n
\n \n
\n
\n
\n
\n
\n

start_date

\n
\n

int64

\n

A Unix millisecond timestamp giving the start date for the suppression rule. After this date, it starts suppressing signals.

\n
\n \n
\n
\n
\n
\n
\n

suppression_query

\n
\n

string

\n

The suppression query of the suppression rule. If a signal matches this query, it is suppressed and not triggered. Same syntax as the queries to search signals in the signal explorer.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

List of tags associated with the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

update_date

\n
\n

int64

\n

A Unix millisecond timestamp given the update date of the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

updater

\n
\n

object

\n

A user.

\n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

version

\n
\n

int32

\n

The version of the suppression rule; it starts at 1, and is incremented at each update.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the resource. The value should always be suppressions. \nAllowed enum values: suppressions

default: suppressions

\n
\n \n
\n
\n
\n
" }, "403": { "json": { @@ -3345,6 +3373,10 @@ "rule_query": "type:log_detection source:cloudtrail", "start_date": 1703187336000, "suppression_query": "env:staging status:low", + "tags": [ + "technique:T1110-brute-force", + "source:cloudtrail" + ], "update_date": "integer", "updater": { "handle": "john.doe@datadoghq.com", @@ -3356,7 +3388,7 @@ "type": "suppressions" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The suppression rule's properties.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of the suppression rule.

\n
\n
\n
\n
\n
\n

creation_date

\n
\n

int64

\n

A Unix millisecond timestamp given the creation date of the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

creator

\n
\n

object

\n

A user.

\n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

data_exclusion_query

\n
\n

string

\n

An exclusion query on the input data of the security rules, which could be logs, Agent events, or other types of data based on the security rule. Events matching this query are ignored by any detection rules referenced in the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

A description for the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

editable

\n
\n

boolean

\n

Whether the suppression rule is editable.

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether the suppression rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

expiration_date

\n
\n

int64

\n

A Unix millisecond timestamp giving an expiration date for the suppression rule. After this date, it won't suppress signals anymore.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

rule_query

\n
\n

string

\n

The rule query of the suppression rule, with the same syntax as the search bar for detection rules.

\n
\n \n
\n
\n
\n
\n
\n

start_date

\n
\n

int64

\n

A Unix millisecond timestamp giving the start date for the suppression rule. After this date, it starts suppressing signals.

\n
\n \n
\n
\n
\n
\n
\n

suppression_query

\n
\n

string

\n

The suppression query of the suppression rule. If a signal matches this query, it is suppressed and not triggered. Same syntax as the queries to search signals in the signal explorer.

\n
\n \n
\n
\n
\n
\n
\n

update_date

\n
\n

int64

\n

A Unix millisecond timestamp given the update date of the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

updater

\n
\n

object

\n

A user.

\n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

version

\n
\n

int32

\n

The version of the suppression rule; it starts at 1, and is incremented at each update.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the resource. The value should always be suppressions. \nAllowed enum values: suppressions

default: suppressions

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The suppression rule's properties.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of the suppression rule.

\n
\n
\n
\n
\n
\n

creation_date

\n
\n

int64

\n

A Unix millisecond timestamp given the creation date of the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

creator

\n
\n

object

\n

A user.

\n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

data_exclusion_query

\n
\n

string

\n

An exclusion query on the input data of the security rules, which could be logs, Agent events, or other types of data based on the security rule. Events matching this query are ignored by any detection rules referenced in the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

A description for the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

editable

\n
\n

boolean

\n

Whether the suppression rule is editable.

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether the suppression rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

expiration_date

\n
\n

int64

\n

A Unix millisecond timestamp giving an expiration date for the suppression rule. After this date, it won't suppress signals anymore.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

rule_query

\n
\n

string

\n

The rule query of the suppression rule, with the same syntax as the search bar for detection rules.

\n
\n \n
\n
\n
\n
\n
\n

start_date

\n
\n

int64

\n

A Unix millisecond timestamp giving the start date for the suppression rule. After this date, it starts suppressing signals.

\n
\n \n
\n
\n
\n
\n
\n

suppression_query

\n
\n

string

\n

The suppression query of the suppression rule. If a signal matches this query, it is suppressed and not triggered. Same syntax as the queries to search signals in the signal explorer.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

List of tags associated with the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

update_date

\n
\n

int64

\n

A Unix millisecond timestamp given the update date of the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

updater

\n
\n

object

\n

A user.

\n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

version

\n
\n

int32

\n

The version of the suppression rule; it starts at 1, and is incremented at each update.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the resource. The value should always be suppressions. \nAllowed enum values: suppressions

default: suppressions

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -3417,12 +3449,16 @@ "rule_query": "type:log_detection source:cloudtrail", "start_date": 1703187336000, "suppression_query": "env:staging status:low", + "tags": [ + "technique:T1110-brute-force", + "source:cloudtrail" + ], "version": "integer" }, "type": "suppressions" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The new suppression properties; partial updates are supported.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The suppression rule properties to be updated.

\n
\n
\n
\n
\n
\n

data_exclusion_query

\n
\n

string

\n

An exclusion query on the input data of the security rules, which could be logs, Agent events, or other types of data based on the security rule. Events matching this query are ignored by any detection rules referenced in the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

A description for the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether the suppression rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

expiration_date

\n
\n

int64

\n

A Unix millisecond timestamp giving an expiration date for the suppression rule. After this date, it won't suppress signals anymore. If unset, the expiration date of the suppression rule is left untouched. If set to null, the expiration date is removed.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

rule_query

\n
\n

string

\n

The rule query of the suppression rule, with the same syntax as the search bar for detection rules.

\n
\n \n
\n
\n
\n
\n
\n

start_date

\n
\n

int64

\n

A Unix millisecond timestamp giving the start date for the suppression rule. After this date, it starts suppressing signals. If unset, the start date of the suppression rule is left untouched. If set to null, the start date is removed.

\n
\n \n
\n
\n
\n
\n
\n

suppression_query

\n
\n

string

\n

The suppression query of the suppression rule. If a signal matches this query, it is suppressed and not triggered. Same syntax as the queries to search signals in the signal explorer.

\n
\n \n
\n
\n
\n
\n
\n

version

\n
\n

int32

\n

The current version of the suppression. This is optional, but it can help prevent concurrent modifications.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of the resource. The value should always be suppressions. \nAllowed enum values: suppressions

default: suppressions

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The new suppression properties; partial updates are supported.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The suppression rule properties to be updated.

\n
\n
\n
\n
\n
\n

data_exclusion_query

\n
\n

string

\n

An exclusion query on the input data of the security rules, which could be logs, Agent events, or other types of data based on the security rule. Events matching this query are ignored by any detection rules referenced in the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

A description for the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether the suppression rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

expiration_date

\n
\n

int64

\n

A Unix millisecond timestamp giving an expiration date for the suppression rule. After this date, it won't suppress signals anymore. If unset, the expiration date of the suppression rule is left untouched. If set to null, the expiration date is removed.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

rule_query

\n
\n

string

\n

The rule query of the suppression rule, with the same syntax as the search bar for detection rules.

\n
\n \n
\n
\n
\n
\n
\n

start_date

\n
\n

int64

\n

A Unix millisecond timestamp giving the start date for the suppression rule. After this date, it starts suppressing signals. If unset, the start date of the suppression rule is left untouched. If set to null, the start date is removed.

\n
\n \n
\n
\n
\n
\n
\n

suppression_query

\n
\n

string

\n

The suppression query of the suppression rule. If a signal matches this query, it is suppressed and not triggered. Same syntax as the queries to search signals in the signal explorer.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

List of tags associated with the suppression rule.

\n
\n \n
\n
\n
\n
\n
\n

version

\n
\n

int32

\n

The current version of the suppression. This is optional, but it can help prevent concurrent modifications.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of the resource. The value should always be suppressions. \nAllowed enum values: suppressions

default: suppressions

\n
\n \n
\n
\n
\n
" } }, "ListSecurityMonitoringRules": { diff --git a/content/en/api/v2/security-monitoring/request.CreateSecurityMonitoringSuppression.json b/content/en/api/v2/security-monitoring/request.CreateSecurityMonitoringSuppression.json index e24b8a1fdd559..442664cfa45c9 100644 --- a/content/en/api/v2/security-monitoring/request.CreateSecurityMonitoringSuppression.json +++ b/content/en/api/v2/security-monitoring/request.CreateSecurityMonitoringSuppression.json @@ -7,7 +7,11 @@ "expiration_date": 1638443471000, "name": "Example-Security-Monitoring", "rule_query": "type:log_detection source:cloudtrail", - "suppression_query": "env:staging status:low" + "suppression_query": "env:staging status:low", + "tags": [ + "technique:T1110-brute-force", + "source:cloudtrail" + ] }, "type": "suppressions" } diff --git a/content/en/api/v2/service-accounts/examples.json b/content/en/api/v2/service-accounts/examples.json index b6caf19333308..d3454444caccd 100644 --- a/content/en/api/v2/service-accounts/examples.json +++ b/content/en/api/v2/service-accounts/examples.json @@ -10,6 +10,7 @@ "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", "mfa_enabled": false, "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", @@ -70,7 +71,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of objects related to the user.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Organization object.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the organization.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the organization.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the organization.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether or not the organization is disabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time of last organization modification.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the organization.

\n
\n \n
\n
\n
\n
\n
\n

public_id

\n
\n

string

\n

Public ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

sharing

\n
\n

string

\n

Sharing type of the organization.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL of the site that this organization exists at.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Permission object.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of a permission.

\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Creation time of the permission.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the permission.

\n
\n \n
\n
\n
\n
\n
\n

display_name

\n
\n

string

\n

Displayed name for the permission.

\n
\n \n
\n
\n
\n
\n
\n

display_type

\n
\n

string

\n

Display type.

\n
\n \n
\n
\n
\n
\n
\n

group_name

\n
\n

string

\n

Name of the permission group.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the permission.

\n
\n \n
\n
\n
\n
\n
\n

restricted

\n
\n

boolean

\n

Whether or not the permission is restricted.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the permission.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Permissions resource type. \nAllowed enum values: permissions

default: permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Role object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the role.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the role.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time of last role modification.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the role. The name is neither unique nor a stable identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int64

\n

Number of users with that role.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the role object returned by the API.

\n
\n
\n
\n
\n
\n

permissions

\n
\n

object

\n

Relationship to multiple permissions objects.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Relationships to permission objects.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the permission.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Permissions resource type. \nAllowed enum values: permissions

default: permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of objects related to the user.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Organization object.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the organization.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the organization.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the organization.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether or not the organization is disabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time of last organization modification.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the organization.

\n
\n \n
\n
\n
\n
\n
\n

public_id

\n
\n

string

\n

Public ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

sharing

\n
\n

string

\n

Sharing type of the organization.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL of the site that this organization exists at.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Permission object.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of a permission.

\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Creation time of the permission.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the permission.

\n
\n \n
\n
\n
\n
\n
\n

display_name

\n
\n

string

\n

Displayed name for the permission.

\n
\n \n
\n
\n
\n
\n
\n

display_type

\n
\n

string

\n

Display type.

\n
\n \n
\n
\n
\n
\n
\n

group_name

\n
\n

string

\n

Name of the permission group.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the permission.

\n
\n \n
\n
\n
\n
\n
\n

restricted

\n
\n

boolean

\n

Whether or not the permission is restricted.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the permission.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Permissions resource type. \nAllowed enum values: permissions

default: permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Role object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the role.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the role.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time of last role modification.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the role. The name is neither unique nor a stable identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int64

\n

Number of users with that role.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the role object returned by the API.

\n
\n
\n
\n
\n
\n

permissions

\n
\n

object

\n

Relationship to multiple permissions objects.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Relationships to permission objects.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the permission.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Permissions resource type. \nAllowed enum values: permissions

default: permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { @@ -168,6 +169,7 @@ "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", "mfa_enabled": false, "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", @@ -219,7 +221,7 @@ } } }, - "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

Array of application keys.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of a partial application key.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

string

\n

Creation date of the application key.

\n
\n \n
\n
\n
\n
\n
\n

last4

\n
\n

string

\n

The last four characters of the application key.

\n
\n \n
\n
\n
\n
\n
\n

last_used_at

\n
\n

string

\n

Last usage timestamp of the application key.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the application key.

\n
\n \n
\n
\n
\n
\n
\n

scopes

\n
\n

[string]

\n

Array of scopes to grant the application key.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the application key.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to the application key.

\n
\n
\n
\n
\n
\n

owned_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Application Keys resource type. \nAllowed enum values: application_keys

default: application_keys

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of objects related to the application key.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Role object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the role.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the role.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time of last role modification.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the role. The name is neither unique nor a stable identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int64

\n

Number of users with that role.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the role object returned by the API.

\n
\n
\n
\n
\n
\n

permissions

\n
\n

object

\n

Relationship to multiple permissions objects.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Relationships to permission objects.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the permission.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Permissions resource type. \nAllowed enum values: permissions

default: permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

The definition of LeakedKey object.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The definition of LeakedKeyAttributes object.

\n
\n
\n
\n
\n
\n

date [required]

\n
\n

date-time

\n

The LeakedKeyAttributes date.

\n
\n \n
\n
\n
\n
\n
\n

leak_source

\n
\n

string

\n

The LeakedKeyAttributes leak_source.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The LeakedKey id.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of LeakedKeyType object. \nAllowed enum values: leaked_keys

default: leaked_keys

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Additional information related to the application key response.

\n
\n
\n
\n
\n
\n

max_allowed_per_user

\n
\n

int64

\n

Max allowed number of application keys per user.

\n
\n \n
\n
\n
\n
\n
\n

page

\n
\n

object

\n

Additional information related to the application key response.

\n
\n
\n
\n
\n
\n

total_filtered_count

\n
\n

int64

\n

Total filtered application key count.

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

Array of application keys.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of a partial application key.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

string

\n

Creation date of the application key.

\n
\n \n
\n
\n
\n
\n
\n

last4

\n
\n

string

\n

The last four characters of the application key.

\n
\n \n
\n
\n
\n
\n
\n

last_used_at

\n
\n

string

\n

Last usage timestamp of the application key.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the application key.

\n
\n \n
\n
\n
\n
\n
\n

scopes

\n
\n

[string]

\n

Array of scopes to grant the application key.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the application key.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to the application key.

\n
\n
\n
\n
\n
\n

owned_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Application Keys resource type. \nAllowed enum values: application_keys

default: application_keys

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of objects related to the application key.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Role object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the role.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the role.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time of last role modification.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the role. The name is neither unique nor a stable identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int64

\n

Number of users with that role.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the role object returned by the API.

\n
\n
\n
\n
\n
\n

permissions

\n
\n

object

\n

Relationship to multiple permissions objects.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Relationships to permission objects.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the permission.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Permissions resource type. \nAllowed enum values: permissions

default: permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

The definition of LeakedKey object.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The definition of LeakedKeyAttributes object.

\n
\n
\n
\n
\n
\n

date [required]

\n
\n

date-time

\n

The LeakedKeyAttributes date.

\n
\n \n
\n
\n
\n
\n
\n

leak_source

\n
\n

string

\n

The LeakedKeyAttributes leak_source.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The LeakedKey id.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of LeakedKeyType object. \nAllowed enum values: leaked_keys

default: leaked_keys

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Additional information related to the application key response.

\n
\n
\n
\n
\n
\n

max_allowed_per_user

\n
\n

int64

\n

Max allowed number of application keys per user.

\n
\n \n
\n
\n
\n
\n
\n

page

\n
\n

object

\n

Additional information related to the application key response.

\n
\n
\n
\n
\n
\n

total_filtered_count

\n
\n

int64

\n

Total filtered application key count.

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { @@ -296,6 +298,7 @@ "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", "mfa_enabled": false, "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", @@ -341,7 +344,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Datadog application key.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of a full application key.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation date of the application key.

\n
\n \n
\n
\n
\n
\n
\n

key

\n
\n

string

\n

The application key.

\n
\n \n
\n
\n
\n
\n
\n

last4

\n
\n

string

\n

The last four characters of the application key.

\n
\n \n
\n
\n
\n
\n
\n

last_used_at

\n
\n

date-time

\n

Last usage timestamp of the application key.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the application key.

\n
\n \n
\n
\n
\n
\n
\n

scopes

\n
\n

[string]

\n

Array of scopes to grant the application key.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the application key.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to the application key.

\n
\n
\n
\n
\n
\n

owned_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Application Keys resource type. \nAllowed enum values: application_keys

default: application_keys

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of objects related to the application key.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Role object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the role.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the role.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time of last role modification.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the role. The name is neither unique nor a stable identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int64

\n

Number of users with that role.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the role object returned by the API.

\n
\n
\n
\n
\n
\n

permissions

\n
\n

object

\n

Relationship to multiple permissions objects.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Relationships to permission objects.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the permission.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Permissions resource type. \nAllowed enum values: permissions

default: permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

The definition of LeakedKey object.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The definition of LeakedKeyAttributes object.

\n
\n
\n
\n
\n
\n

date [required]

\n
\n

date-time

\n

The LeakedKeyAttributes date.

\n
\n \n
\n
\n
\n
\n
\n

leak_source

\n
\n

string

\n

The LeakedKeyAttributes leak_source.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The LeakedKey id.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of LeakedKeyType object. \nAllowed enum values: leaked_keys

default: leaked_keys

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Datadog application key.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of a full application key.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation date of the application key.

\n
\n \n
\n
\n
\n
\n
\n

key

\n
\n

string

\n

The application key.

\n
\n \n
\n
\n
\n
\n
\n

last4

\n
\n

string

\n

The last four characters of the application key.

\n
\n \n
\n
\n
\n
\n
\n

last_used_at

\n
\n

date-time

\n

Last usage timestamp of the application key.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the application key.

\n
\n \n
\n
\n
\n
\n
\n

scopes

\n
\n

[string]

\n

Array of scopes to grant the application key.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the application key.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to the application key.

\n
\n
\n
\n
\n
\n

owned_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Application Keys resource type. \nAllowed enum values: application_keys

default: application_keys

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of objects related to the application key.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Role object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the role.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the role.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time of last role modification.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the role. The name is neither unique nor a stable identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int64

\n

Number of users with that role.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the role object returned by the API.

\n
\n
\n
\n
\n
\n

permissions

\n
\n

object

\n

Relationship to multiple permissions objects.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Relationships to permission objects.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the permission.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Permissions resource type. \nAllowed enum values: permissions

default: permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

The definition of LeakedKey object.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The definition of LeakedKeyAttributes object.

\n
\n
\n
\n
\n
\n

date [required]

\n
\n

date-time

\n

The LeakedKeyAttributes date.

\n
\n \n
\n
\n
\n
\n
\n

leak_source

\n
\n

string

\n

The LeakedKeyAttributes leak_source.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The LeakedKey id.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of LeakedKeyType object. \nAllowed enum values: leaked_keys

default: leaked_keys

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { @@ -461,6 +464,7 @@ "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", "mfa_enabled": false, "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", @@ -506,7 +510,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Partial Datadog application key.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of a partial application key.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

string

\n

Creation date of the application key.

\n
\n \n
\n
\n
\n
\n
\n

last4

\n
\n

string

\n

The last four characters of the application key.

\n
\n \n
\n
\n
\n
\n
\n

last_used_at

\n
\n

string

\n

Last usage timestamp of the application key.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the application key.

\n
\n \n
\n
\n
\n
\n
\n

scopes

\n
\n

[string]

\n

Array of scopes to grant the application key.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the application key.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to the application key.

\n
\n
\n
\n
\n
\n

owned_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Application Keys resource type. \nAllowed enum values: application_keys

default: application_keys

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of objects related to the application key.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Role object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the role.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the role.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time of last role modification.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the role. The name is neither unique nor a stable identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int64

\n

Number of users with that role.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the role object returned by the API.

\n
\n
\n
\n
\n
\n

permissions

\n
\n

object

\n

Relationship to multiple permissions objects.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Relationships to permission objects.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the permission.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Permissions resource type. \nAllowed enum values: permissions

default: permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

The definition of LeakedKey object.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The definition of LeakedKeyAttributes object.

\n
\n
\n
\n
\n
\n

date [required]

\n
\n

date-time

\n

The LeakedKeyAttributes date.

\n
\n \n
\n
\n
\n
\n
\n

leak_source

\n
\n

string

\n

The LeakedKeyAttributes leak_source.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The LeakedKey id.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of LeakedKeyType object. \nAllowed enum values: leaked_keys

default: leaked_keys

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Partial Datadog application key.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of a partial application key.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

string

\n

Creation date of the application key.

\n
\n \n
\n
\n
\n
\n
\n

last4

\n
\n

string

\n

The last four characters of the application key.

\n
\n \n
\n
\n
\n
\n
\n

last_used_at

\n
\n

string

\n

Last usage timestamp of the application key.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the application key.

\n
\n \n
\n
\n
\n
\n
\n

scopes

\n
\n

[string]

\n

Array of scopes to grant the application key.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the application key.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to the application key.

\n
\n
\n
\n
\n
\n

owned_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Application Keys resource type. \nAllowed enum values: application_keys

default: application_keys

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of objects related to the application key.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Role object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the role.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the role.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time of last role modification.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the role. The name is neither unique nor a stable identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int64

\n

Number of users with that role.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the role object returned by the API.

\n
\n
\n
\n
\n
\n

permissions

\n
\n

object

\n

Relationship to multiple permissions objects.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Relationships to permission objects.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the permission.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Permissions resource type. \nAllowed enum values: permissions

default: permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

The definition of LeakedKey object.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The definition of LeakedKeyAttributes object.

\n
\n
\n
\n
\n
\n

date [required]

\n
\n

date-time

\n

The LeakedKeyAttributes date.

\n
\n \n
\n
\n
\n
\n
\n

leak_source

\n
\n

string

\n

The LeakedKeyAttributes leak_source.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The LeakedKey id.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of LeakedKeyType object. \nAllowed enum values: leaked_keys

default: leaked_keys

\n
\n \n
\n
\n
\n
\n
\n
" }, "403": { "json": { @@ -574,6 +578,7 @@ "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", "mfa_enabled": false, "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", @@ -619,7 +624,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Partial Datadog application key.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of a partial application key.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

string

\n

Creation date of the application key.

\n
\n \n
\n
\n
\n
\n
\n

last4

\n
\n

string

\n

The last four characters of the application key.

\n
\n \n
\n
\n
\n
\n
\n

last_used_at

\n
\n

string

\n

Last usage timestamp of the application key.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the application key.

\n
\n \n
\n
\n
\n
\n
\n

scopes

\n
\n

[string]

\n

Array of scopes to grant the application key.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the application key.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to the application key.

\n
\n
\n
\n
\n
\n

owned_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Application Keys resource type. \nAllowed enum values: application_keys

default: application_keys

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of objects related to the application key.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Role object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the role.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the role.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time of last role modification.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the role. The name is neither unique nor a stable identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int64

\n

Number of users with that role.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the role object returned by the API.

\n
\n
\n
\n
\n
\n

permissions

\n
\n

object

\n

Relationship to multiple permissions objects.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Relationships to permission objects.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the permission.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Permissions resource type. \nAllowed enum values: permissions

default: permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

The definition of LeakedKey object.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The definition of LeakedKeyAttributes object.

\n
\n
\n
\n
\n
\n

date [required]

\n
\n

date-time

\n

The LeakedKeyAttributes date.

\n
\n \n
\n
\n
\n
\n
\n

leak_source

\n
\n

string

\n

The LeakedKeyAttributes leak_source.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The LeakedKey id.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of LeakedKeyType object. \nAllowed enum values: leaked_keys

default: leaked_keys

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Partial Datadog application key.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of a partial application key.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

string

\n

Creation date of the application key.

\n
\n \n
\n
\n
\n
\n
\n

last4

\n
\n

string

\n

The last four characters of the application key.

\n
\n \n
\n
\n
\n
\n
\n

last_used_at

\n
\n

string

\n

Last usage timestamp of the application key.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the application key.

\n
\n \n
\n
\n
\n
\n
\n

scopes

\n
\n

[string]

\n

Array of scopes to grant the application key.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the application key.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to the application key.

\n
\n
\n
\n
\n
\n

owned_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Application Keys resource type. \nAllowed enum values: application_keys

default: application_keys

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of objects related to the application key.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Role object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the role.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the role.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time of last role modification.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the role. The name is neither unique nor a stable identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int64

\n

Number of users with that role.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the role object returned by the API.

\n
\n
\n
\n
\n
\n

permissions

\n
\n

object

\n

Relationship to multiple permissions objects.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Relationships to permission objects.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the permission.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Permissions resource type. \nAllowed enum values: permissions

default: permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

The definition of LeakedKey object.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The definition of LeakedKeyAttributes object.

\n
\n
\n
\n
\n
\n

date [required]

\n
\n

date-time

\n

The LeakedKeyAttributes date.

\n
\n \n
\n
\n
\n
\n
\n

leak_source

\n
\n

string

\n

The LeakedKeyAttributes leak_source.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The LeakedKey id.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of LeakedKeyType object. \nAllowed enum values: leaked_keys

default: leaked_keys

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { diff --git a/content/en/api/v2/team-connections/_index.md b/content/en/api/v2/team-connections/_index.md new file mode 100644 index 0000000000000..04673b01a2a29 --- /dev/null +++ b/content/en/api/v2/team-connections/_index.md @@ -0,0 +1,4 @@ +--- +title: Team Connections +headless: true +--- diff --git a/content/en/api/v2/team-connections/examples.json b/content/en/api/v2/team-connections/examples.json new file mode 100644 index 0000000000000..323cf347b66d5 --- /dev/null +++ b/content/en/api/v2/team-connections/examples.json @@ -0,0 +1,257 @@ +{ + "DeleteTeamConnections": { + "responses": { + "400": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "404": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": [ + { + "id": "12345678-1234-5678-9abc-123456789012", + "type": "team_connection" + } + ] + }, + "json": { + "data": [ + { + "id": "12345678-1234-5678-9abc-123456789012", + "type": "team_connection" + } + ] + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Array of team connection IDs to delete.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the team connection to delete.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team connection resource type. \nAllowed enum values: team_connection

default: team_connection

\n
\n \n
\n
\n
\n
" + } + }, + "ListTeamConnections": { + "responses": { + "200": { + "json": { + "data": [ + { + "attributes": { + "managed_by": "github_sync", + "source": "github" + }, + "id": "12345678-1234-5678-9abc-123456789012", + "relationships": { + "connected_team": { + "data": { + "id": "@GitHubOrg/team-handle", + "type": "github_team" + } + }, + "team": { + "data": { + "id": "87654321-4321-8765-dcba-210987654321", + "type": "team" + } + } + }, + "type": "team_connection" + } + ], + "meta": { + "page": { + "first_number": "integer", + "last_number": "integer", + "next_number": "integer", + "number": "integer", + "prev_number": "integer", + "size": "integer", + "total": "integer", + "type": "number_size" + } + } + }, + "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

Array of team connections.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the team connection.

\n
\n
\n
\n
\n
\n

managed_by

\n
\n

string

\n

The entity that manages this team connection.

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

string

\n

The name of the external source.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the team connection.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the team connection.

\n
\n
\n
\n
\n
\n

connected_team

\n
\n

object

\n

Reference to a team from an external system.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Reference to connected external team.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The connected team ID as it is referenced throughout the Datadog ecosystem.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

External team resource type. \nAllowed enum values: github_team

default: github_team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

team

\n
\n

object

\n

Reference to a Datadog team.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Reference to a Datadog team.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The Datadog team ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Datadog team resource type. \nAllowed enum values: team

default: team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team connection resource type. \nAllowed enum values: team_connection

default: team_connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Connections response metadata.

\n
\n
\n
\n
\n
\n

page

\n
\n

object

\n

Page-based pagination metadata.

\n
\n
\n
\n
\n
\n

first_number

\n
\n

int64

\n

The first page number.

\n
\n \n
\n
\n
\n
\n
\n

last_number

\n
\n

int64

\n

The last page number.

\n
\n \n
\n
\n
\n
\n
\n

next_number

\n
\n

int64

\n

The next page number.

\n
\n \n
\n
\n
\n
\n
\n

number

\n
\n

int64

\n

The current page number.

\n
\n \n
\n
\n
\n
\n
\n

prev_number

\n
\n

int64

\n

The previous page number.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

The page size.

\n
\n \n
\n
\n
\n
\n
\n

total

\n
\n

int64

\n

Total connections matching request.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Pagination type.

\n
\n \n
\n
\n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "CreateTeamConnections": { + "responses": { + "201": { + "json": { + "data": [ + { + "attributes": { + "managed_by": "github_sync", + "source": "github" + }, + "id": "12345678-1234-5678-9abc-123456789012", + "relationships": { + "connected_team": { + "data": { + "id": "@GitHubOrg/team-handle", + "type": "github_team" + } + }, + "team": { + "data": { + "id": "87654321-4321-8765-dcba-210987654321", + "type": "team" + } + } + }, + "type": "team_connection" + } + ], + "meta": { + "page": { + "first_number": "integer", + "last_number": "integer", + "next_number": "integer", + "number": "integer", + "prev_number": "integer", + "size": "integer", + "total": "integer", + "type": "number_size" + } + } + }, + "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

Array of team connections.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the team connection.

\n
\n
\n
\n
\n
\n

managed_by

\n
\n

string

\n

The entity that manages this team connection.

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

string

\n

The name of the external source.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the team connection.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the team connection.

\n
\n
\n
\n
\n
\n

connected_team

\n
\n

object

\n

Reference to a team from an external system.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Reference to connected external team.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The connected team ID as it is referenced throughout the Datadog ecosystem.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

External team resource type. \nAllowed enum values: github_team

default: github_team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

team

\n
\n

object

\n

Reference to a Datadog team.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Reference to a Datadog team.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The Datadog team ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Datadog team resource type. \nAllowed enum values: team

default: team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team connection resource type. \nAllowed enum values: team_connection

default: team_connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Connections response metadata.

\n
\n
\n
\n
\n
\n

page

\n
\n

object

\n

Page-based pagination metadata.

\n
\n
\n
\n
\n
\n

first_number

\n
\n

int64

\n

The first page number.

\n
\n \n
\n
\n
\n
\n
\n

last_number

\n
\n

int64

\n

The last page number.

\n
\n \n
\n
\n
\n
\n
\n

next_number

\n
\n

int64

\n

The next page number.

\n
\n \n
\n
\n
\n
\n
\n

number

\n
\n

int64

\n

The current page number.

\n
\n \n
\n
\n
\n
\n
\n

prev_number

\n
\n

int64

\n

The previous page number.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

The page size.

\n
\n \n
\n
\n
\n
\n
\n

total

\n
\n

int64

\n

Total connections matching request.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Pagination type.

\n
\n \n
\n
\n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "409": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": [ + { + "relationships": { + "connected_team": { + "data": { + "id": "@GitHubOrg/team-handle", + "type": "github_team" + } + }, + "team": { + "data": { + "id": "87654321-4321-8765-dcba-210987654321", + "type": "team" + } + } + }, + "type": "team_connection" + } + ] + }, + "json": { + "data": [ + { + "attributes": { + "managed_by": "github_sync", + "source": "github" + }, + "relationships": { + "connected_team": { + "data": { + "id": "@GitHubOrg/team-handle", + "type": "github_team" + } + }, + "team": { + "data": { + "id": "87654321-4321-8765-dcba-210987654321", + "type": "team" + } + } + }, + "type": "team_connection" + } + ] + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Array of team connections to create.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the team connection.

\n
\n
\n
\n
\n
\n

managed_by

\n
\n

string

\n

The entity that manages this team connection.

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

string

\n

The name of the external source.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the team connection.

\n
\n
\n
\n
\n
\n

connected_team

\n
\n

object

\n

Reference to a team from an external system.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Reference to connected external team.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The connected team ID as it is referenced throughout the Datadog ecosystem.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

External team resource type. \nAllowed enum values: github_team

default: github_team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

team

\n
\n

object

\n

Reference to a Datadog team.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Reference to a Datadog team.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The Datadog team ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Datadog team resource type. \nAllowed enum values: team

default: team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team connection resource type. \nAllowed enum values: team_connection

default: team_connection

\n
\n \n
\n
\n
\n
" + } + } +} \ No newline at end of file diff --git a/content/en/api/v2/teams/examples.json b/content/en/api/v2/teams/examples.json index 60653e3f7eac2..abcfa2ed2051c 100644 --- a/content/en/api/v2/teams/examples.json +++ b/content/en/api/v2/teams/examples.json @@ -53,6 +53,7 @@ "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", "mfa_enabled": false, "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", @@ -117,7 +118,7 @@ } } }, - "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

Teams response data

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Team attributes

\n
\n
\n
\n
\n
\n

avatar

\n
\n

string

\n

Unicode representation of the avatar for the team, limited to a single grapheme

\n
\n \n
\n
\n
\n
\n
\n

banner

\n
\n

int64

\n

Banner selection for the team

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation date of the team

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Free-form markdown description/content for the team's homepage

\n
\n \n
\n
\n
\n
\n
\n

handle [required]

\n
\n

string

\n

The team's identifier

\n
\n \n
\n
\n
\n
\n
\n

hidden_modules

\n
\n

[string]

\n

Collection of hidden modules for the team

\n
\n \n
\n
\n
\n
\n
\n

link_count

\n
\n

int32

\n

The number of links belonging to the team

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Modification date of the team

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the team

\n
\n \n
\n
\n
\n
\n
\n

summary

\n
\n

string

\n

A brief summary of the team, derived from the description

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int32

\n

The number of users belonging to the team

\n
\n \n
\n
\n
\n
\n
\n

visible_modules

\n
\n

[string]

\n

Collection of visible modules for the team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team's identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to a team

\n
\n
\n
\n
\n
\n

team_links

\n
\n

object

\n

Relationship between a team and a team link

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Related team links

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team link's identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team link type \nAllowed enum values: team_links

default: team_links

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Links attributes.

\n
\n
\n
\n
\n
\n

related

\n
\n

string

\n

Related link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user_team_permissions

\n
\n

object

\n

Relationship between a user team permission and a team

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Related user team permission data

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the user team permission

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User team permission type \nAllowed enum values: user_team_permissions

default: user_team_permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Links attributes.

\n
\n
\n
\n
\n
\n

related

\n
\n

string

\n

Related link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team type \nAllowed enum values: team

default: team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Resources related to the team

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Team link

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Team link attributes

\n
\n
\n
\n
\n
\n

label [required]

\n
\n

string

\n

The link's label

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int32

\n

The link's position, used to sort links for the team

\n
\n \n
\n
\n
\n
\n
\n

team_id

\n
\n

string

\n

ID of the team the link is associated with

\n
\n \n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

The URL for the link

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team link's identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team link type \nAllowed enum values: team_links

default: team_links

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

A user's permissions for a given team

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

User team permission attributes

\n
\n
\n
\n
\n
\n

permissions

\n
\n

object

\n

Object of team permission actions and boolean values that a logged in user can perform on this team.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The user team permission's identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User team permission type \nAllowed enum values: user_team_permissions

default: user_team_permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Teams response links.

\n
\n
\n
\n
\n
\n

first

\n
\n

string

\n

First link.

\n
\n \n
\n
\n
\n
\n
\n

last

\n
\n

string

\n

Last link.

\n
\n \n
\n
\n
\n
\n
\n

next

\n
\n

string

\n

Next link.

\n
\n \n
\n
\n
\n
\n
\n

prev

\n
\n

string

\n

Previous link.

\n
\n \n
\n
\n
\n
\n
\n

self

\n
\n

string

\n

Current link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Teams response metadata.

\n
\n
\n
\n
\n
\n

pagination

\n
\n

object

\n

Teams response metadata.

\n
\n
\n
\n
\n
\n

first_offset

\n
\n

int64

\n

The first offset.

\n
\n \n
\n
\n
\n
\n
\n

last_offset

\n
\n

int64

\n

The last offset.

\n
\n \n
\n
\n
\n
\n
\n

limit

\n
\n

int64

\n

Pagination limit.

\n
\n \n
\n
\n
\n
\n
\n

next_offset

\n
\n

int64

\n

The next offset.

\n
\n \n
\n
\n
\n
\n
\n

offset

\n
\n

int64

\n

The offset.

\n
\n \n
\n
\n
\n
\n
\n

prev_offset

\n
\n

int64

\n

The previous offset.

\n
\n \n
\n
\n
\n
\n
\n

total

\n
\n

int64

\n

Total results.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Offset type.

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

Teams response data

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Team attributes

\n
\n
\n
\n
\n
\n

avatar

\n
\n

string

\n

Unicode representation of the avatar for the team, limited to a single grapheme

\n
\n \n
\n
\n
\n
\n
\n

banner

\n
\n

int64

\n

Banner selection for the team

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation date of the team

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Free-form markdown description/content for the team's homepage

\n
\n \n
\n
\n
\n
\n
\n

handle [required]

\n
\n

string

\n

The team's identifier

\n
\n \n
\n
\n
\n
\n
\n

hidden_modules

\n
\n

[string]

\n

Collection of hidden modules for the team

\n
\n \n
\n
\n
\n
\n
\n

link_count

\n
\n

int32

\n

The number of links belonging to the team

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Modification date of the team

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the team

\n
\n \n
\n
\n
\n
\n
\n

summary

\n
\n

string

\n

A brief summary of the team, derived from the description

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int32

\n

The number of users belonging to the team

\n
\n \n
\n
\n
\n
\n
\n

visible_modules

\n
\n

[string]

\n

Collection of visible modules for the team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team's identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to a team

\n
\n
\n
\n
\n
\n

team_links

\n
\n

object

\n

Relationship between a team and a team link

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Related team links

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team link's identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team link type \nAllowed enum values: team_links

default: team_links

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Links attributes.

\n
\n
\n
\n
\n
\n

related

\n
\n

string

\n

Related link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user_team_permissions

\n
\n

object

\n

Relationship between a user team permission and a team

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Related user team permission data

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the user team permission

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User team permission type \nAllowed enum values: user_team_permissions

default: user_team_permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Links attributes.

\n
\n
\n
\n
\n
\n

related

\n
\n

string

\n

Related link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team type \nAllowed enum values: team

default: team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Resources related to the team

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Team link

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Team link attributes

\n
\n
\n
\n
\n
\n

label [required]

\n
\n

string

\n

The link's label

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int32

\n

The link's position, used to sort links for the team

\n
\n \n
\n
\n
\n
\n
\n

team_id

\n
\n

string

\n

ID of the team the link is associated with

\n
\n \n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

The URL for the link

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team link's identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team link type \nAllowed enum values: team_links

default: team_links

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

A user's permissions for a given team

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

User team permission attributes

\n
\n
\n
\n
\n
\n

permissions

\n
\n

object

\n

Object of team permission actions and boolean values that a logged in user can perform on this team.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The user team permission's identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User team permission type \nAllowed enum values: user_team_permissions

default: user_team_permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Teams response links.

\n
\n
\n
\n
\n
\n

first

\n
\n

string

\n

First link.

\n
\n \n
\n
\n
\n
\n
\n

last

\n
\n

string

\n

Last link.

\n
\n \n
\n
\n
\n
\n
\n

next

\n
\n

string

\n

Next link.

\n
\n \n
\n
\n
\n
\n
\n

prev

\n
\n

string

\n

Previous link.

\n
\n \n
\n
\n
\n
\n
\n

self

\n
\n

string

\n

Current link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Teams response metadata.

\n
\n
\n
\n
\n
\n

pagination

\n
\n

object

\n

Teams response metadata.

\n
\n
\n
\n
\n
\n

first_offset

\n
\n

int64

\n

The first offset.

\n
\n \n
\n
\n
\n
\n
\n

last_offset

\n
\n

int64

\n

The last offset.

\n
\n \n
\n
\n
\n
\n
\n

limit

\n
\n

int64

\n

Pagination limit.

\n
\n \n
\n
\n
\n
\n
\n

next_offset

\n
\n

int64

\n

The next offset.

\n
\n \n
\n
\n
\n
\n
\n

offset

\n
\n

int64

\n

The offset.

\n
\n \n
\n
\n
\n
\n
\n

prev_offset

\n
\n

int64

\n

The previous offset.

\n
\n \n
\n
\n
\n
\n
\n

total

\n
\n

int64

\n

Total results.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Offset type.

\n
\n \n
\n
\n
\n
\n
\n
" }, "403": { "json": { @@ -364,6 +365,7 @@ "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", "mfa_enabled": false, "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", @@ -428,7 +430,7 @@ } } }, - "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

Teams response data

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Team attributes

\n
\n
\n
\n
\n
\n

avatar

\n
\n

string

\n

Unicode representation of the avatar for the team, limited to a single grapheme

\n
\n \n
\n
\n
\n
\n
\n

banner

\n
\n

int64

\n

Banner selection for the team

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation date of the team

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Free-form markdown description/content for the team's homepage

\n
\n \n
\n
\n
\n
\n
\n

handle [required]

\n
\n

string

\n

The team's identifier

\n
\n \n
\n
\n
\n
\n
\n

hidden_modules

\n
\n

[string]

\n

Collection of hidden modules for the team

\n
\n \n
\n
\n
\n
\n
\n

link_count

\n
\n

int32

\n

The number of links belonging to the team

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Modification date of the team

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the team

\n
\n \n
\n
\n
\n
\n
\n

summary

\n
\n

string

\n

A brief summary of the team, derived from the description

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int32

\n

The number of users belonging to the team

\n
\n \n
\n
\n
\n
\n
\n

visible_modules

\n
\n

[string]

\n

Collection of visible modules for the team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team's identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to a team

\n
\n
\n
\n
\n
\n

team_links

\n
\n

object

\n

Relationship between a team and a team link

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Related team links

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team link's identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team link type \nAllowed enum values: team_links

default: team_links

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Links attributes.

\n
\n
\n
\n
\n
\n

related

\n
\n

string

\n

Related link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user_team_permissions

\n
\n

object

\n

Relationship between a user team permission and a team

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Related user team permission data

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the user team permission

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User team permission type \nAllowed enum values: user_team_permissions

default: user_team_permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Links attributes.

\n
\n
\n
\n
\n
\n

related

\n
\n

string

\n

Related link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team type \nAllowed enum values: team

default: team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Resources related to the team

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Team link

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Team link attributes

\n
\n
\n
\n
\n
\n

label [required]

\n
\n

string

\n

The link's label

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int32

\n

The link's position, used to sort links for the team

\n
\n \n
\n
\n
\n
\n
\n

team_id

\n
\n

string

\n

ID of the team the link is associated with

\n
\n \n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

The URL for the link

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team link's identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team link type \nAllowed enum values: team_links

default: team_links

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

A user's permissions for a given team

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

User team permission attributes

\n
\n
\n
\n
\n
\n

permissions

\n
\n

object

\n

Object of team permission actions and boolean values that a logged in user can perform on this team.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The user team permission's identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User team permission type \nAllowed enum values: user_team_permissions

default: user_team_permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Teams response links.

\n
\n
\n
\n
\n
\n

first

\n
\n

string

\n

First link.

\n
\n \n
\n
\n
\n
\n
\n

last

\n
\n

string

\n

Last link.

\n
\n \n
\n
\n
\n
\n
\n

next

\n
\n

string

\n

Next link.

\n
\n \n
\n
\n
\n
\n
\n

prev

\n
\n

string

\n

Previous link.

\n
\n \n
\n
\n
\n
\n
\n

self

\n
\n

string

\n

Current link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Teams response metadata.

\n
\n
\n
\n
\n
\n

pagination

\n
\n

object

\n

Teams response metadata.

\n
\n
\n
\n
\n
\n

first_offset

\n
\n

int64

\n

The first offset.

\n
\n \n
\n
\n
\n
\n
\n

last_offset

\n
\n

int64

\n

The last offset.

\n
\n \n
\n
\n
\n
\n
\n

limit

\n
\n

int64

\n

Pagination limit.

\n
\n \n
\n
\n
\n
\n
\n

next_offset

\n
\n

int64

\n

The next offset.

\n
\n \n
\n
\n
\n
\n
\n

offset

\n
\n

int64

\n

The offset.

\n
\n \n
\n
\n
\n
\n
\n

prev_offset

\n
\n

int64

\n

The previous offset.

\n
\n \n
\n
\n
\n
\n
\n

total

\n
\n

int64

\n

Total results.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Offset type.

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

Teams response data

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Team attributes

\n
\n
\n
\n
\n
\n

avatar

\n
\n

string

\n

Unicode representation of the avatar for the team, limited to a single grapheme

\n
\n \n
\n
\n
\n
\n
\n

banner

\n
\n

int64

\n

Banner selection for the team

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation date of the team

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Free-form markdown description/content for the team's homepage

\n
\n \n
\n
\n
\n
\n
\n

handle [required]

\n
\n

string

\n

The team's identifier

\n
\n \n
\n
\n
\n
\n
\n

hidden_modules

\n
\n

[string]

\n

Collection of hidden modules for the team

\n
\n \n
\n
\n
\n
\n
\n

link_count

\n
\n

int32

\n

The number of links belonging to the team

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Modification date of the team

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the team

\n
\n \n
\n
\n
\n
\n
\n

summary

\n
\n

string

\n

A brief summary of the team, derived from the description

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int32

\n

The number of users belonging to the team

\n
\n \n
\n
\n
\n
\n
\n

visible_modules

\n
\n

[string]

\n

Collection of visible modules for the team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team's identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to a team

\n
\n
\n
\n
\n
\n

team_links

\n
\n

object

\n

Relationship between a team and a team link

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Related team links

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team link's identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team link type \nAllowed enum values: team_links

default: team_links

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Links attributes.

\n
\n
\n
\n
\n
\n

related

\n
\n

string

\n

Related link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user_team_permissions

\n
\n

object

\n

Relationship between a user team permission and a team

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Related user team permission data

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the user team permission

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User team permission type \nAllowed enum values: user_team_permissions

default: user_team_permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Links attributes.

\n
\n
\n
\n
\n
\n

related

\n
\n

string

\n

Related link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team type \nAllowed enum values: team

default: team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Resources related to the team

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Team link

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Team link attributes

\n
\n
\n
\n
\n
\n

label [required]

\n
\n

string

\n

The link's label

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int32

\n

The link's position, used to sort links for the team

\n
\n \n
\n
\n
\n
\n
\n

team_id

\n
\n

string

\n

ID of the team the link is associated with

\n
\n \n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

The URL for the link

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team link's identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team link type \nAllowed enum values: team_links

default: team_links

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

A user's permissions for a given team

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

User team permission attributes

\n
\n
\n
\n
\n
\n

permissions

\n
\n

object

\n

Object of team permission actions and boolean values that a logged in user can perform on this team.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The user team permission's identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User team permission type \nAllowed enum values: user_team_permissions

default: user_team_permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Teams response links.

\n
\n
\n
\n
\n
\n

first

\n
\n

string

\n

First link.

\n
\n \n
\n
\n
\n
\n
\n

last

\n
\n

string

\n

Last link.

\n
\n \n
\n
\n
\n
\n
\n

next

\n
\n

string

\n

Next link.

\n
\n \n
\n
\n
\n
\n
\n

prev

\n
\n

string

\n

Previous link.

\n
\n \n
\n
\n
\n
\n
\n

self

\n
\n

string

\n

Current link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Teams response metadata.

\n
\n
\n
\n
\n
\n

pagination

\n
\n

object

\n

Teams response metadata.

\n
\n
\n
\n
\n
\n

first_offset

\n
\n

int64

\n

The first offset.

\n
\n \n
\n
\n
\n
\n
\n

last_offset

\n
\n

int64

\n

The last offset.

\n
\n \n
\n
\n
\n
\n
\n

limit

\n
\n

int64

\n

Pagination limit.

\n
\n \n
\n
\n
\n
\n
\n

next_offset

\n
\n

int64

\n

The next offset.

\n
\n \n
\n
\n
\n
\n
\n

offset

\n
\n

int64

\n

The offset.

\n
\n \n
\n
\n
\n
\n
\n

prev_offset

\n
\n

int64

\n

The previous offset.

\n
\n \n
\n
\n
\n
\n
\n

total

\n
\n

int64

\n

Total results.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Offset type.

\n
\n \n
\n
\n
\n
\n
\n
" }, "403": { "json": { @@ -1092,6 +1094,7 @@ "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", "mfa_enabled": false, "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", @@ -1156,7 +1159,7 @@ } } }, - "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

Team memberships response data

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Team membership attributes

\n
\n
\n
\n
\n
\n

provisioned_by

\n
\n

string

\n

The mechanism responsible for provisioning the team relationship.\nPossible values: null for added by a user, "service_account" if added by a service account, and "saml_mapping" if provisioned via SAML mapping.

\n
\n \n
\n
\n
\n
\n
\n

provisioned_by_id

\n
\n

string

\n

UUID of the User or Service Account who provisioned this team membership, or null if provisioned via SAML mapping.

\n
\n \n
\n
\n
\n
\n
\n

role

\n
\n

enum

\n

The user's role within the team \nAllowed enum values: admin

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of a user's relationship with a team

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationship between membership and a user

\n
\n
\n
\n
\n
\n

team

\n
\n

object

\n

Relationship between team membership and team

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The team associated with the membership

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the team associated with the membership

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User team team type \nAllowed enum values: team

default: team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user

\n
\n

object

\n

Relationship between team membership and user

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

A user's relationship with a team

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the user associated with the team

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User team user type \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team membership type \nAllowed enum values: team_memberships

default: team_memberships

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Resources related to the team memberships

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A team

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Team attributes

\n
\n
\n
\n
\n
\n

avatar

\n
\n

string

\n

Unicode representation of the avatar for the team, limited to a single grapheme

\n
\n \n
\n
\n
\n
\n
\n

banner

\n
\n

int64

\n

Banner selection for the team

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation date of the team

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Free-form markdown description/content for the team's homepage

\n
\n \n
\n
\n
\n
\n
\n

handle [required]

\n
\n

string

\n

The team's identifier

\n
\n \n
\n
\n
\n
\n
\n

hidden_modules

\n
\n

[string]

\n

Collection of hidden modules for the team

\n
\n \n
\n
\n
\n
\n
\n

link_count

\n
\n

int32

\n

The number of links belonging to the team

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Modification date of the team

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the team

\n
\n \n
\n
\n
\n
\n
\n

summary

\n
\n

string

\n

A brief summary of the team, derived from the description

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int32

\n

The number of users belonging to the team

\n
\n \n
\n
\n
\n
\n
\n

visible_modules

\n
\n

[string]

\n

Collection of visible modules for the team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team's identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to a team

\n
\n
\n
\n
\n
\n

team_links

\n
\n

object

\n

Relationship between a team and a team link

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Related team links

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team link's identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team link type \nAllowed enum values: team_links

default: team_links

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Links attributes.

\n
\n
\n
\n
\n
\n

related

\n
\n

string

\n

Related link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user_team_permissions

\n
\n

object

\n

Relationship between a user team permission and a team

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Related user team permission data

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the user team permission

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User team permission type \nAllowed enum values: user_team_permissions

default: user_team_permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Links attributes.

\n
\n
\n
\n
\n
\n

related

\n
\n

string

\n

Related link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team type \nAllowed enum values: team

default: team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Teams response links.

\n
\n
\n
\n
\n
\n

first

\n
\n

string

\n

First link.

\n
\n \n
\n
\n
\n
\n
\n

last

\n
\n

string

\n

Last link.

\n
\n \n
\n
\n
\n
\n
\n

next

\n
\n

string

\n

Next link.

\n
\n \n
\n
\n
\n
\n
\n

prev

\n
\n

string

\n

Previous link.

\n
\n \n
\n
\n
\n
\n
\n

self

\n
\n

string

\n

Current link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Teams response metadata.

\n
\n
\n
\n
\n
\n

pagination

\n
\n

object

\n

Teams response metadata.

\n
\n
\n
\n
\n
\n

first_offset

\n
\n

int64

\n

The first offset.

\n
\n \n
\n
\n
\n
\n
\n

last_offset

\n
\n

int64

\n

The last offset.

\n
\n \n
\n
\n
\n
\n
\n

limit

\n
\n

int64

\n

Pagination limit.

\n
\n \n
\n
\n
\n
\n
\n

next_offset

\n
\n

int64

\n

The next offset.

\n
\n \n
\n
\n
\n
\n
\n

offset

\n
\n

int64

\n

The offset.

\n
\n \n
\n
\n
\n
\n
\n

prev_offset

\n
\n

int64

\n

The previous offset.

\n
\n \n
\n
\n
\n
\n
\n

total

\n
\n

int64

\n

Total results.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Offset type.

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

Team memberships response data

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Team membership attributes

\n
\n
\n
\n
\n
\n

provisioned_by

\n
\n

string

\n

The mechanism responsible for provisioning the team relationship.\nPossible values: null for added by a user, "service_account" if added by a service account, and "saml_mapping" if provisioned via SAML mapping.

\n
\n \n
\n
\n
\n
\n
\n

provisioned_by_id

\n
\n

string

\n

UUID of the User or Service Account who provisioned this team membership, or null if provisioned via SAML mapping.

\n
\n \n
\n
\n
\n
\n
\n

role

\n
\n

enum

\n

The user's role within the team \nAllowed enum values: admin

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of a user's relationship with a team

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationship between membership and a user

\n
\n
\n
\n
\n
\n

team

\n
\n

object

\n

Relationship between team membership and team

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The team associated with the membership

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the team associated with the membership

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User team team type \nAllowed enum values: team

default: team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user

\n
\n

object

\n

Relationship between team membership and user

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

A user's relationship with a team

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the user associated with the team

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User team user type \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team membership type \nAllowed enum values: team_memberships

default: team_memberships

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Resources related to the team memberships

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A team

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Team attributes

\n
\n
\n
\n
\n
\n

avatar

\n
\n

string

\n

Unicode representation of the avatar for the team, limited to a single grapheme

\n
\n \n
\n
\n
\n
\n
\n

banner

\n
\n

int64

\n

Banner selection for the team

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation date of the team

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Free-form markdown description/content for the team's homepage

\n
\n \n
\n
\n
\n
\n
\n

handle [required]

\n
\n

string

\n

The team's identifier

\n
\n \n
\n
\n
\n
\n
\n

hidden_modules

\n
\n

[string]

\n

Collection of hidden modules for the team

\n
\n \n
\n
\n
\n
\n
\n

link_count

\n
\n

int32

\n

The number of links belonging to the team

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Modification date of the team

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the team

\n
\n \n
\n
\n
\n
\n
\n

summary

\n
\n

string

\n

A brief summary of the team, derived from the description

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int32

\n

The number of users belonging to the team

\n
\n \n
\n
\n
\n
\n
\n

visible_modules

\n
\n

[string]

\n

Collection of visible modules for the team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team's identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to a team

\n
\n
\n
\n
\n
\n

team_links

\n
\n

object

\n

Relationship between a team and a team link

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Related team links

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team link's identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team link type \nAllowed enum values: team_links

default: team_links

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Links attributes.

\n
\n
\n
\n
\n
\n

related

\n
\n

string

\n

Related link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user_team_permissions

\n
\n

object

\n

Relationship between a user team permission and a team

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Related user team permission data

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the user team permission

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User team permission type \nAllowed enum values: user_team_permissions

default: user_team_permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Links attributes.

\n
\n
\n
\n
\n
\n

related

\n
\n

string

\n

Related link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team type \nAllowed enum values: team

default: team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Teams response links.

\n
\n
\n
\n
\n
\n

first

\n
\n

string

\n

First link.

\n
\n \n
\n
\n
\n
\n
\n

last

\n
\n

string

\n

Last link.

\n
\n \n
\n
\n
\n
\n
\n

next

\n
\n

string

\n

Next link.

\n
\n \n
\n
\n
\n
\n
\n

prev

\n
\n

string

\n

Previous link.

\n
\n \n
\n
\n
\n
\n
\n

self

\n
\n

string

\n

Current link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Teams response metadata.

\n
\n
\n
\n
\n
\n

pagination

\n
\n

object

\n

Teams response metadata.

\n
\n
\n
\n
\n
\n

first_offset

\n
\n

int64

\n

The first offset.

\n
\n \n
\n
\n
\n
\n
\n

last_offset

\n
\n

int64

\n

The last offset.

\n
\n \n
\n
\n
\n
\n
\n

limit

\n
\n

int64

\n

Pagination limit.

\n
\n \n
\n
\n
\n
\n
\n

next_offset

\n
\n

int64

\n

The next offset.

\n
\n \n
\n
\n
\n
\n
\n

offset

\n
\n

int64

\n

The offset.

\n
\n \n
\n
\n
\n
\n
\n

prev_offset

\n
\n

int64

\n

The previous offset.

\n
\n \n
\n
\n
\n
\n
\n

total

\n
\n

int64

\n

Total results.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Offset type.

\n
\n \n
\n
\n
\n
\n
\n
" }, "403": { "json": { @@ -1224,6 +1227,7 @@ "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", "mfa_enabled": false, "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", @@ -1269,7 +1273,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

A user's relationship with a team

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Team membership attributes

\n
\n
\n
\n
\n
\n

provisioned_by

\n
\n

string

\n

The mechanism responsible for provisioning the team relationship.\nPossible values: null for added by a user, "service_account" if added by a service account, and "saml_mapping" if provisioned via SAML mapping.

\n
\n \n
\n
\n
\n
\n
\n

provisioned_by_id

\n
\n

string

\n

UUID of the User or Service Account who provisioned this team membership, or null if provisioned via SAML mapping.

\n
\n \n
\n
\n
\n
\n
\n

role

\n
\n

enum

\n

The user's role within the team \nAllowed enum values: admin

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of a user's relationship with a team

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationship between membership and a user

\n
\n
\n
\n
\n
\n

team

\n
\n

object

\n

Relationship between team membership and team

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The team associated with the membership

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the team associated with the membership

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User team team type \nAllowed enum values: team

default: team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user

\n
\n

object

\n

Relationship between team membership and user

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

A user's relationship with a team

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the user associated with the team

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User team user type \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team membership type \nAllowed enum values: team_memberships

default: team_memberships

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Resources related to the team memberships

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A team

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Team attributes

\n
\n
\n
\n
\n
\n

avatar

\n
\n

string

\n

Unicode representation of the avatar for the team, limited to a single grapheme

\n
\n \n
\n
\n
\n
\n
\n

banner

\n
\n

int64

\n

Banner selection for the team

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation date of the team

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Free-form markdown description/content for the team's homepage

\n
\n \n
\n
\n
\n
\n
\n

handle [required]

\n
\n

string

\n

The team's identifier

\n
\n \n
\n
\n
\n
\n
\n

hidden_modules

\n
\n

[string]

\n

Collection of hidden modules for the team

\n
\n \n
\n
\n
\n
\n
\n

link_count

\n
\n

int32

\n

The number of links belonging to the team

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Modification date of the team

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the team

\n
\n \n
\n
\n
\n
\n
\n

summary

\n
\n

string

\n

A brief summary of the team, derived from the description

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int32

\n

The number of users belonging to the team

\n
\n \n
\n
\n
\n
\n
\n

visible_modules

\n
\n

[string]

\n

Collection of visible modules for the team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team's identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to a team

\n
\n
\n
\n
\n
\n

team_links

\n
\n

object

\n

Relationship between a team and a team link

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Related team links

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team link's identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team link type \nAllowed enum values: team_links

default: team_links

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Links attributes.

\n
\n
\n
\n
\n
\n

related

\n
\n

string

\n

Related link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user_team_permissions

\n
\n

object

\n

Relationship between a user team permission and a team

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Related user team permission data

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the user team permission

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User team permission type \nAllowed enum values: user_team_permissions

default: user_team_permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Links attributes.

\n
\n
\n
\n
\n
\n

related

\n
\n

string

\n

Related link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team type \nAllowed enum values: team

default: team

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

A user's relationship with a team

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Team membership attributes

\n
\n
\n
\n
\n
\n

provisioned_by

\n
\n

string

\n

The mechanism responsible for provisioning the team relationship.\nPossible values: null for added by a user, "service_account" if added by a service account, and "saml_mapping" if provisioned via SAML mapping.

\n
\n \n
\n
\n
\n
\n
\n

provisioned_by_id

\n
\n

string

\n

UUID of the User or Service Account who provisioned this team membership, or null if provisioned via SAML mapping.

\n
\n \n
\n
\n
\n
\n
\n

role

\n
\n

enum

\n

The user's role within the team \nAllowed enum values: admin

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of a user's relationship with a team

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationship between membership and a user

\n
\n
\n
\n
\n
\n

team

\n
\n

object

\n

Relationship between team membership and team

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The team associated with the membership

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the team associated with the membership

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User team team type \nAllowed enum values: team

default: team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user

\n
\n

object

\n

Relationship between team membership and user

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

A user's relationship with a team

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the user associated with the team

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User team user type \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team membership type \nAllowed enum values: team_memberships

default: team_memberships

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Resources related to the team memberships

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A team

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Team attributes

\n
\n
\n
\n
\n
\n

avatar

\n
\n

string

\n

Unicode representation of the avatar for the team, limited to a single grapheme

\n
\n \n
\n
\n
\n
\n
\n

banner

\n
\n

int64

\n

Banner selection for the team

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation date of the team

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Free-form markdown description/content for the team's homepage

\n
\n \n
\n
\n
\n
\n
\n

handle [required]

\n
\n

string

\n

The team's identifier

\n
\n \n
\n
\n
\n
\n
\n

hidden_modules

\n
\n

[string]

\n

Collection of hidden modules for the team

\n
\n \n
\n
\n
\n
\n
\n

link_count

\n
\n

int32

\n

The number of links belonging to the team

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Modification date of the team

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the team

\n
\n \n
\n
\n
\n
\n
\n

summary

\n
\n

string

\n

A brief summary of the team, derived from the description

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int32

\n

The number of users belonging to the team

\n
\n \n
\n
\n
\n
\n
\n

visible_modules

\n
\n

[string]

\n

Collection of visible modules for the team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team's identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to a team

\n
\n
\n
\n
\n
\n

team_links

\n
\n

object

\n

Relationship between a team and a team link

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Related team links

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team link's identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team link type \nAllowed enum values: team_links

default: team_links

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Links attributes.

\n
\n
\n
\n
\n
\n

related

\n
\n

string

\n

Related link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user_team_permissions

\n
\n

object

\n

Relationship between a user team permission and a team

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Related user team permission data

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the user team permission

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User team permission type \nAllowed enum values: user_team_permissions

default: user_team_permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Links attributes.

\n
\n
\n
\n
\n
\n

related

\n
\n

string

\n

Related link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team type \nAllowed enum values: team

default: team

\n
\n \n
\n
\n
\n
\n
\n
" }, "403": { "json": { @@ -1417,6 +1421,7 @@ "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", "mfa_enabled": false, "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", @@ -1462,7 +1467,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

A user's relationship with a team

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Team membership attributes

\n
\n
\n
\n
\n
\n

provisioned_by

\n
\n

string

\n

The mechanism responsible for provisioning the team relationship.\nPossible values: null for added by a user, "service_account" if added by a service account, and "saml_mapping" if provisioned via SAML mapping.

\n
\n \n
\n
\n
\n
\n
\n

provisioned_by_id

\n
\n

string

\n

UUID of the User or Service Account who provisioned this team membership, or null if provisioned via SAML mapping.

\n
\n \n
\n
\n
\n
\n
\n

role

\n
\n

enum

\n

The user's role within the team \nAllowed enum values: admin

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of a user's relationship with a team

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationship between membership and a user

\n
\n
\n
\n
\n
\n

team

\n
\n

object

\n

Relationship between team membership and team

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The team associated with the membership

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the team associated with the membership

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User team team type \nAllowed enum values: team

default: team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user

\n
\n

object

\n

Relationship between team membership and user

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

A user's relationship with a team

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the user associated with the team

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User team user type \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team membership type \nAllowed enum values: team_memberships

default: team_memberships

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Resources related to the team memberships

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A team

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Team attributes

\n
\n
\n
\n
\n
\n

avatar

\n
\n

string

\n

Unicode representation of the avatar for the team, limited to a single grapheme

\n
\n \n
\n
\n
\n
\n
\n

banner

\n
\n

int64

\n

Banner selection for the team

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation date of the team

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Free-form markdown description/content for the team's homepage

\n
\n \n
\n
\n
\n
\n
\n

handle [required]

\n
\n

string

\n

The team's identifier

\n
\n \n
\n
\n
\n
\n
\n

hidden_modules

\n
\n

[string]

\n

Collection of hidden modules for the team

\n
\n \n
\n
\n
\n
\n
\n

link_count

\n
\n

int32

\n

The number of links belonging to the team

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Modification date of the team

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the team

\n
\n \n
\n
\n
\n
\n
\n

summary

\n
\n

string

\n

A brief summary of the team, derived from the description

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int32

\n

The number of users belonging to the team

\n
\n \n
\n
\n
\n
\n
\n

visible_modules

\n
\n

[string]

\n

Collection of visible modules for the team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team's identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to a team

\n
\n
\n
\n
\n
\n

team_links

\n
\n

object

\n

Relationship between a team and a team link

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Related team links

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team link's identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team link type \nAllowed enum values: team_links

default: team_links

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Links attributes.

\n
\n
\n
\n
\n
\n

related

\n
\n

string

\n

Related link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user_team_permissions

\n
\n

object

\n

Relationship between a user team permission and a team

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Related user team permission data

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the user team permission

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User team permission type \nAllowed enum values: user_team_permissions

default: user_team_permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Links attributes.

\n
\n
\n
\n
\n
\n

related

\n
\n

string

\n

Related link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team type \nAllowed enum values: team

default: team

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

A user's relationship with a team

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Team membership attributes

\n
\n
\n
\n
\n
\n

provisioned_by

\n
\n

string

\n

The mechanism responsible for provisioning the team relationship.\nPossible values: null for added by a user, "service_account" if added by a service account, and "saml_mapping" if provisioned via SAML mapping.

\n
\n \n
\n
\n
\n
\n
\n

provisioned_by_id

\n
\n

string

\n

UUID of the User or Service Account who provisioned this team membership, or null if provisioned via SAML mapping.

\n
\n \n
\n
\n
\n
\n
\n

role

\n
\n

enum

\n

The user's role within the team \nAllowed enum values: admin

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of a user's relationship with a team

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationship between membership and a user

\n
\n
\n
\n
\n
\n

team

\n
\n

object

\n

Relationship between team membership and team

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The team associated with the membership

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the team associated with the membership

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User team team type \nAllowed enum values: team

default: team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user

\n
\n

object

\n

Relationship between team membership and user

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

A user's relationship with a team

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the user associated with the team

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User team user type \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team membership type \nAllowed enum values: team_memberships

default: team_memberships

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Resources related to the team memberships

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A team

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Team attributes

\n
\n
\n
\n
\n
\n

avatar

\n
\n

string

\n

Unicode representation of the avatar for the team, limited to a single grapheme

\n
\n \n
\n
\n
\n
\n
\n

banner

\n
\n

int64

\n

Banner selection for the team

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation date of the team

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Free-form markdown description/content for the team's homepage

\n
\n \n
\n
\n
\n
\n
\n

handle [required]

\n
\n

string

\n

The team's identifier

\n
\n \n
\n
\n
\n
\n
\n

hidden_modules

\n
\n

[string]

\n

Collection of hidden modules for the team

\n
\n \n
\n
\n
\n
\n
\n

link_count

\n
\n

int32

\n

The number of links belonging to the team

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Modification date of the team

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the team

\n
\n \n
\n
\n
\n
\n
\n

summary

\n
\n

string

\n

A brief summary of the team, derived from the description

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int32

\n

The number of users belonging to the team

\n
\n \n
\n
\n
\n
\n
\n

visible_modules

\n
\n

[string]

\n

Collection of visible modules for the team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team's identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to a team

\n
\n
\n
\n
\n
\n

team_links

\n
\n

object

\n

Relationship between a team and a team link

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Related team links

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team link's identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team link type \nAllowed enum values: team_links

default: team_links

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Links attributes.

\n
\n
\n
\n
\n
\n

related

\n
\n

string

\n

Related link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user_team_permissions

\n
\n

object

\n

Relationship between a user team permission and a team

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Related user team permission data

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the user team permission

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User team permission type \nAllowed enum values: user_team_permissions

default: user_team_permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Links attributes.

\n
\n
\n
\n
\n
\n

related

\n
\n

string

\n

Related link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team type \nAllowed enum values: team

default: team

\n
\n \n
\n
\n
\n
\n
\n
" }, "403": { "json": { @@ -1654,6 +1659,7 @@ "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", "mfa_enabled": false, "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", @@ -1718,7 +1724,7 @@ } } }, - "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

Team memberships response data

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Team membership attributes

\n
\n
\n
\n
\n
\n

provisioned_by

\n
\n

string

\n

The mechanism responsible for provisioning the team relationship.\nPossible values: null for added by a user, "service_account" if added by a service account, and "saml_mapping" if provisioned via SAML mapping.

\n
\n \n
\n
\n
\n
\n
\n

provisioned_by_id

\n
\n

string

\n

UUID of the User or Service Account who provisioned this team membership, or null if provisioned via SAML mapping.

\n
\n \n
\n
\n
\n
\n
\n

role

\n
\n

enum

\n

The user's role within the team \nAllowed enum values: admin

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of a user's relationship with a team

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationship between membership and a user

\n
\n
\n
\n
\n
\n

team

\n
\n

object

\n

Relationship between team membership and team

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The team associated with the membership

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the team associated with the membership

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User team team type \nAllowed enum values: team

default: team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user

\n
\n

object

\n

Relationship between team membership and user

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

A user's relationship with a team

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the user associated with the team

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User team user type \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team membership type \nAllowed enum values: team_memberships

default: team_memberships

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Resources related to the team memberships

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A team

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Team attributes

\n
\n
\n
\n
\n
\n

avatar

\n
\n

string

\n

Unicode representation of the avatar for the team, limited to a single grapheme

\n
\n \n
\n
\n
\n
\n
\n

banner

\n
\n

int64

\n

Banner selection for the team

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation date of the team

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Free-form markdown description/content for the team's homepage

\n
\n \n
\n
\n
\n
\n
\n

handle [required]

\n
\n

string

\n

The team's identifier

\n
\n \n
\n
\n
\n
\n
\n

hidden_modules

\n
\n

[string]

\n

Collection of hidden modules for the team

\n
\n \n
\n
\n
\n
\n
\n

link_count

\n
\n

int32

\n

The number of links belonging to the team

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Modification date of the team

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the team

\n
\n \n
\n
\n
\n
\n
\n

summary

\n
\n

string

\n

A brief summary of the team, derived from the description

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int32

\n

The number of users belonging to the team

\n
\n \n
\n
\n
\n
\n
\n

visible_modules

\n
\n

[string]

\n

Collection of visible modules for the team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team's identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to a team

\n
\n
\n
\n
\n
\n

team_links

\n
\n

object

\n

Relationship between a team and a team link

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Related team links

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team link's identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team link type \nAllowed enum values: team_links

default: team_links

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Links attributes.

\n
\n
\n
\n
\n
\n

related

\n
\n

string

\n

Related link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user_team_permissions

\n
\n

object

\n

Relationship between a user team permission and a team

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Related user team permission data

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the user team permission

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User team permission type \nAllowed enum values: user_team_permissions

default: user_team_permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Links attributes.

\n
\n
\n
\n
\n
\n

related

\n
\n

string

\n

Related link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team type \nAllowed enum values: team

default: team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Teams response links.

\n
\n
\n
\n
\n
\n

first

\n
\n

string

\n

First link.

\n
\n \n
\n
\n
\n
\n
\n

last

\n
\n

string

\n

Last link.

\n
\n \n
\n
\n
\n
\n
\n

next

\n
\n

string

\n

Next link.

\n
\n \n
\n
\n
\n
\n
\n

prev

\n
\n

string

\n

Previous link.

\n
\n \n
\n
\n
\n
\n
\n

self

\n
\n

string

\n

Current link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Teams response metadata.

\n
\n
\n
\n
\n
\n

pagination

\n
\n

object

\n

Teams response metadata.

\n
\n
\n
\n
\n
\n

first_offset

\n
\n

int64

\n

The first offset.

\n
\n \n
\n
\n
\n
\n
\n

last_offset

\n
\n

int64

\n

The last offset.

\n
\n \n
\n
\n
\n
\n
\n

limit

\n
\n

int64

\n

Pagination limit.

\n
\n \n
\n
\n
\n
\n
\n

next_offset

\n
\n

int64

\n

The next offset.

\n
\n \n
\n
\n
\n
\n
\n

offset

\n
\n

int64

\n

The offset.

\n
\n \n
\n
\n
\n
\n
\n

prev_offset

\n
\n

int64

\n

The previous offset.

\n
\n \n
\n
\n
\n
\n
\n

total

\n
\n

int64

\n

Total results.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Offset type.

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

Team memberships response data

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Team membership attributes

\n
\n
\n
\n
\n
\n

provisioned_by

\n
\n

string

\n

The mechanism responsible for provisioning the team relationship.\nPossible values: null for added by a user, "service_account" if added by a service account, and "saml_mapping" if provisioned via SAML mapping.

\n
\n \n
\n
\n
\n
\n
\n

provisioned_by_id

\n
\n

string

\n

UUID of the User or Service Account who provisioned this team membership, or null if provisioned via SAML mapping.

\n
\n \n
\n
\n
\n
\n
\n

role

\n
\n

enum

\n

The user's role within the team \nAllowed enum values: admin

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of a user's relationship with a team

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationship between membership and a user

\n
\n
\n
\n
\n
\n

team

\n
\n

object

\n

Relationship between team membership and team

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The team associated with the membership

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the team associated with the membership

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User team team type \nAllowed enum values: team

default: team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user

\n
\n

object

\n

Relationship between team membership and user

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

A user's relationship with a team

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the user associated with the team

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User team user type \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team membership type \nAllowed enum values: team_memberships

default: team_memberships

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Resources related to the team memberships

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A team

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Team attributes

\n
\n
\n
\n
\n
\n

avatar

\n
\n

string

\n

Unicode representation of the avatar for the team, limited to a single grapheme

\n
\n \n
\n
\n
\n
\n
\n

banner

\n
\n

int64

\n

Banner selection for the team

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation date of the team

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Free-form markdown description/content for the team's homepage

\n
\n \n
\n
\n
\n
\n
\n

handle [required]

\n
\n

string

\n

The team's identifier

\n
\n \n
\n
\n
\n
\n
\n

hidden_modules

\n
\n

[string]

\n

Collection of hidden modules for the team

\n
\n \n
\n
\n
\n
\n
\n

link_count

\n
\n

int32

\n

The number of links belonging to the team

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Modification date of the team

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the team

\n
\n \n
\n
\n
\n
\n
\n

summary

\n
\n

string

\n

A brief summary of the team, derived from the description

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int32

\n

The number of users belonging to the team

\n
\n \n
\n
\n
\n
\n
\n

visible_modules

\n
\n

[string]

\n

Collection of visible modules for the team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team's identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to a team

\n
\n
\n
\n
\n
\n

team_links

\n
\n

object

\n

Relationship between a team and a team link

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Related team links

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The team link's identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team link type \nAllowed enum values: team_links

default: team_links

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Links attributes.

\n
\n
\n
\n
\n
\n

related

\n
\n

string

\n

Related link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user_team_permissions

\n
\n

object

\n

Relationship between a user team permission and a team

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Related user team permission data

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the user team permission

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User team permission type \nAllowed enum values: user_team_permissions

default: user_team_permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Links attributes.

\n
\n
\n
\n
\n
\n

related

\n
\n

string

\n

Related link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team type \nAllowed enum values: team

default: team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Teams response links.

\n
\n
\n
\n
\n
\n

first

\n
\n

string

\n

First link.

\n
\n \n
\n
\n
\n
\n
\n

last

\n
\n

string

\n

Last link.

\n
\n \n
\n
\n
\n
\n
\n

next

\n
\n

string

\n

Next link.

\n
\n \n
\n
\n
\n
\n
\n

prev

\n
\n

string

\n

Previous link.

\n
\n \n
\n
\n
\n
\n
\n

self

\n
\n

string

\n

Current link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Teams response metadata.

\n
\n
\n
\n
\n
\n

pagination

\n
\n

object

\n

Teams response metadata.

\n
\n
\n
\n
\n
\n

first_offset

\n
\n

int64

\n

The first offset.

\n
\n \n
\n
\n
\n
\n
\n

last_offset

\n
\n

int64

\n

The last offset.

\n
\n \n
\n
\n
\n
\n
\n

limit

\n
\n

int64

\n

Pagination limit.

\n
\n \n
\n
\n
\n
\n
\n

next_offset

\n
\n

int64

\n

The next offset.

\n
\n \n
\n
\n
\n
\n
\n

offset

\n
\n

int64

\n

The offset.

\n
\n \n
\n
\n
\n
\n
\n

prev_offset

\n
\n

int64

\n

The previous offset.

\n
\n \n
\n
\n
\n
\n
\n

total

\n
\n

int64

\n

Total results.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Offset type.

\n
\n \n
\n
\n
\n
\n
\n
" }, "404": { "json": { diff --git a/content/en/api/v2/users/examples.json b/content/en/api/v2/users/examples.json index 83cb51375f905..daea512595e7e 100644 --- a/content/en/api/v2/users/examples.json +++ b/content/en/api/v2/users/examples.json @@ -153,6 +153,7 @@ "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", "mfa_enabled": false, "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", @@ -220,7 +221,7 @@ } } }, - "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

Array of returned users.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of objects related to the users.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Organization object.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the organization.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the organization.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the organization.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether or not the organization is disabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time of last organization modification.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the organization.

\n
\n \n
\n
\n
\n
\n
\n

public_id

\n
\n

string

\n

Public ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

sharing

\n
\n

string

\n

Sharing type of the organization.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL of the site that this organization exists at.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Permission object.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of a permission.

\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Creation time of the permission.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the permission.

\n
\n \n
\n
\n
\n
\n
\n

display_name

\n
\n

string

\n

Displayed name for the permission.

\n
\n \n
\n
\n
\n
\n
\n

display_type

\n
\n

string

\n

Display type.

\n
\n \n
\n
\n
\n
\n
\n

group_name

\n
\n

string

\n

Name of the permission group.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the permission.

\n
\n \n
\n
\n
\n
\n
\n

restricted

\n
\n

boolean

\n

Whether or not the permission is restricted.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the permission.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Permissions resource type. \nAllowed enum values: permissions

default: permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Role object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the role.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the role.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time of last role modification.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the role. The name is neither unique nor a stable identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int64

\n

Number of users with that role.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the role object returned by the API.

\n
\n
\n
\n
\n
\n

permissions

\n
\n

object

\n

Relationship to multiple permissions objects.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Relationships to permission objects.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the permission.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Permissions resource type. \nAllowed enum values: permissions

default: permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Object describing meta attributes of response.

\n
\n
\n
\n
\n
\n

page

\n
\n

object

\n

Pagination object.

\n
\n
\n
\n
\n
\n

total_count

\n
\n

int64

\n

Total count.

\n
\n \n
\n
\n
\n
\n
\n

total_filtered_count

\n
\n

int64

\n

Total count of elements matched by the filter.

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

Array of returned users.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of objects related to the users.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Organization object.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the organization.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the organization.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the organization.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether or not the organization is disabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time of last organization modification.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the organization.

\n
\n \n
\n
\n
\n
\n
\n

public_id

\n
\n

string

\n

Public ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

sharing

\n
\n

string

\n

Sharing type of the organization.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL of the site that this organization exists at.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Permission object.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of a permission.

\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Creation time of the permission.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the permission.

\n
\n \n
\n
\n
\n
\n
\n

display_name

\n
\n

string

\n

Displayed name for the permission.

\n
\n \n
\n
\n
\n
\n
\n

display_type

\n
\n

string

\n

Display type.

\n
\n \n
\n
\n
\n
\n
\n

group_name

\n
\n

string

\n

Name of the permission group.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the permission.

\n
\n \n
\n
\n
\n
\n
\n

restricted

\n
\n

boolean

\n

Whether or not the permission is restricted.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the permission.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Permissions resource type. \nAllowed enum values: permissions

default: permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Role object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the role.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the role.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time of last role modification.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the role. The name is neither unique nor a stable identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int64

\n

Number of users with that role.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the role object returned by the API.

\n
\n
\n
\n
\n
\n

permissions

\n
\n

object

\n

Relationship to multiple permissions objects.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Relationships to permission objects.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the permission.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Permissions resource type. \nAllowed enum values: permissions

default: permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Object describing meta attributes of response.

\n
\n
\n
\n
\n
\n

page

\n
\n

object

\n

Pagination object.

\n
\n
\n
\n
\n
\n

total_count

\n
\n

int64

\n

Total count.

\n
\n \n
\n
\n
\n
\n
\n

total_filtered_count

\n
\n

int64

\n

Total count of elements matched by the filter.

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { @@ -264,6 +265,7 @@ "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", "mfa_enabled": false, "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", @@ -324,7 +326,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of objects related to the user.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Organization object.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the organization.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the organization.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the organization.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether or not the organization is disabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time of last organization modification.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the organization.

\n
\n \n
\n
\n
\n
\n
\n

public_id

\n
\n

string

\n

Public ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

sharing

\n
\n

string

\n

Sharing type of the organization.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL of the site that this organization exists at.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Permission object.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of a permission.

\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Creation time of the permission.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the permission.

\n
\n \n
\n
\n
\n
\n
\n

display_name

\n
\n

string

\n

Displayed name for the permission.

\n
\n \n
\n
\n
\n
\n
\n

display_type

\n
\n

string

\n

Display type.

\n
\n \n
\n
\n
\n
\n
\n

group_name

\n
\n

string

\n

Name of the permission group.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the permission.

\n
\n \n
\n
\n
\n
\n
\n

restricted

\n
\n

boolean

\n

Whether or not the permission is restricted.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the permission.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Permissions resource type. \nAllowed enum values: permissions

default: permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Role object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the role.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the role.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time of last role modification.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the role. The name is neither unique nor a stable identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int64

\n

Number of users with that role.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the role object returned by the API.

\n
\n
\n
\n
\n
\n

permissions

\n
\n

object

\n

Relationship to multiple permissions objects.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Relationships to permission objects.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the permission.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Permissions resource type. \nAllowed enum values: permissions

default: permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of objects related to the user.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Organization object.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the organization.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the organization.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the organization.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether or not the organization is disabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time of last organization modification.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the organization.

\n
\n \n
\n
\n
\n
\n
\n

public_id

\n
\n

string

\n

Public ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

sharing

\n
\n

string

\n

Sharing type of the organization.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL of the site that this organization exists at.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Permission object.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of a permission.

\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Creation time of the permission.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the permission.

\n
\n \n
\n
\n
\n
\n
\n

display_name

\n
\n

string

\n

Displayed name for the permission.

\n
\n \n
\n
\n
\n
\n
\n

display_type

\n
\n

string

\n

Display type.

\n
\n \n
\n
\n
\n
\n
\n

group_name

\n
\n

string

\n

Name of the permission group.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the permission.

\n
\n \n
\n
\n
\n
\n
\n

restricted

\n
\n

boolean

\n

Whether or not the permission is restricted.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the permission.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Permissions resource type. \nAllowed enum values: permissions

default: permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Role object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the role.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the role.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time of last role modification.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the role. The name is neither unique nor a stable identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int64

\n

Number of users with that role.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the role object returned by the API.

\n
\n
\n
\n
\n
\n

permissions

\n
\n

object

\n

Relationship to multiple permissions objects.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Relationships to permission objects.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the permission.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Permissions resource type. \nAllowed enum values: permissions

default: permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { @@ -427,6 +429,7 @@ "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", "mfa_enabled": false, "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", @@ -487,7 +490,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of objects related to the user.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Organization object.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the organization.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the organization.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the organization.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether or not the organization is disabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time of last organization modification.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the organization.

\n
\n \n
\n
\n
\n
\n
\n

public_id

\n
\n

string

\n

Public ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

sharing

\n
\n

string

\n

Sharing type of the organization.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL of the site that this organization exists at.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Permission object.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of a permission.

\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Creation time of the permission.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the permission.

\n
\n \n
\n
\n
\n
\n
\n

display_name

\n
\n

string

\n

Displayed name for the permission.

\n
\n \n
\n
\n
\n
\n
\n

display_type

\n
\n

string

\n

Display type.

\n
\n \n
\n
\n
\n
\n
\n

group_name

\n
\n

string

\n

Name of the permission group.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the permission.

\n
\n \n
\n
\n
\n
\n
\n

restricted

\n
\n

boolean

\n

Whether or not the permission is restricted.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the permission.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Permissions resource type. \nAllowed enum values: permissions

default: permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Role object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the role.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the role.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time of last role modification.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the role. The name is neither unique nor a stable identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int64

\n

Number of users with that role.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the role object returned by the API.

\n
\n
\n
\n
\n
\n

permissions

\n
\n

object

\n

Relationship to multiple permissions objects.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Relationships to permission objects.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the permission.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Permissions resource type. \nAllowed enum values: permissions

default: permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of objects related to the user.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Organization object.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the organization.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the organization.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the organization.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether or not the organization is disabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time of last organization modification.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the organization.

\n
\n \n
\n
\n
\n
\n
\n

public_id

\n
\n

string

\n

Public ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

sharing

\n
\n

string

\n

Sharing type of the organization.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL of the site that this organization exists at.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Permission object.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of a permission.

\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Creation time of the permission.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the permission.

\n
\n \n
\n
\n
\n
\n
\n

display_name

\n
\n

string

\n

Displayed name for the permission.

\n
\n \n
\n
\n
\n
\n
\n

display_type

\n
\n

string

\n

Display type.

\n
\n \n
\n
\n
\n
\n
\n

group_name

\n
\n

string

\n

Name of the permission group.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the permission.

\n
\n \n
\n
\n
\n
\n
\n

restricted

\n
\n

boolean

\n

Whether or not the permission is restricted.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the permission.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Permissions resource type. \nAllowed enum values: permissions

default: permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Role object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the role.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the role.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time of last role modification.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the role. The name is neither unique nor a stable identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int64

\n

Number of users with that role.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the role object returned by the API.

\n
\n
\n
\n
\n
\n

permissions

\n
\n

object

\n

Relationship to multiple permissions objects.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Relationships to permission objects.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the permission.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Permissions resource type. \nAllowed enum values: permissions

default: permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
" }, "403": { "json": { @@ -531,6 +534,7 @@ "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", "mfa_enabled": false, "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", @@ -591,7 +595,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of objects related to the user.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Organization object.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the organization.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the organization.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the organization.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether or not the organization is disabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time of last organization modification.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the organization.

\n
\n \n
\n
\n
\n
\n
\n

public_id

\n
\n

string

\n

Public ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

sharing

\n
\n

string

\n

Sharing type of the organization.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL of the site that this organization exists at.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Permission object.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of a permission.

\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Creation time of the permission.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the permission.

\n
\n \n
\n
\n
\n
\n
\n

display_name

\n
\n

string

\n

Displayed name for the permission.

\n
\n \n
\n
\n
\n
\n
\n

display_type

\n
\n

string

\n

Display type.

\n
\n \n
\n
\n
\n
\n
\n

group_name

\n
\n

string

\n

Name of the permission group.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the permission.

\n
\n \n
\n
\n
\n
\n
\n

restricted

\n
\n

boolean

\n

Whether or not the permission is restricted.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the permission.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Permissions resource type. \nAllowed enum values: permissions

default: permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Role object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the role.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the role.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time of last role modification.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the role. The name is neither unique nor a stable identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int64

\n

Number of users with that role.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the role object returned by the API.

\n
\n
\n
\n
\n
\n

permissions

\n
\n

object

\n

Relationship to multiple permissions objects.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Relationships to permission objects.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the permission.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Permissions resource type. \nAllowed enum values: permissions

default: permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of objects related to the user.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Organization object.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the organization.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the organization.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the organization.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether or not the organization is disabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time of last organization modification.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the organization.

\n
\n \n
\n
\n
\n
\n
\n

public_id

\n
\n

string

\n

Public ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

sharing

\n
\n

string

\n

Sharing type of the organization.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL of the site that this organization exists at.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Permission object.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of a permission.

\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Creation time of the permission.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the permission.

\n
\n \n
\n
\n
\n
\n
\n

display_name

\n
\n

string

\n

Displayed name for the permission.

\n
\n \n
\n
\n
\n
\n
\n

display_type

\n
\n

string

\n

Display type.

\n
\n \n
\n
\n
\n
\n
\n

group_name

\n
\n

string

\n

Name of the permission group.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the permission.

\n
\n \n
\n
\n
\n
\n
\n

restricted

\n
\n

boolean

\n

Whether or not the permission is restricted.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the permission.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Permissions resource type. \nAllowed enum values: permissions

default: permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Role object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the role.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the role.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time of last role modification.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the role. The name is neither unique nor a stable identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int64

\n

Number of users with that role.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the role object returned by the API.

\n
\n
\n
\n
\n
\n

permissions

\n
\n

object

\n

Relationship to multiple permissions objects.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Relationships to permission objects.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the permission.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Permissions resource type. \nAllowed enum values: permissions

default: permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { @@ -667,6 +671,7 @@ "email": "string", "handle": "string", "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", "mfa_enabled": false, "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", @@ -727,7 +732,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of objects related to the user.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Organization object.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the organization.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the organization.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the organization.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether or not the organization is disabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time of last organization modification.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the organization.

\n
\n \n
\n
\n
\n
\n
\n

public_id

\n
\n

string

\n

Public ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

sharing

\n
\n

string

\n

Sharing type of the organization.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL of the site that this organization exists at.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Permission object.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of a permission.

\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Creation time of the permission.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the permission.

\n
\n \n
\n
\n
\n
\n
\n

display_name

\n
\n

string

\n

Displayed name for the permission.

\n
\n \n
\n
\n
\n
\n
\n

display_type

\n
\n

string

\n

Display type.

\n
\n \n
\n
\n
\n
\n
\n

group_name

\n
\n

string

\n

Name of the permission group.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the permission.

\n
\n \n
\n
\n
\n
\n
\n

restricted

\n
\n

boolean

\n

Whether or not the permission is restricted.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the permission.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Permissions resource type. \nAllowed enum values: permissions

default: permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Role object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the role.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the role.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time of last role modification.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the role. The name is neither unique nor a stable identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int64

\n

Number of users with that role.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the role object returned by the API.

\n
\n
\n
\n
\n
\n

permissions

\n
\n

object

\n

Relationship to multiple permissions objects.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Relationships to permission objects.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the permission.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Permissions resource type. \nAllowed enum values: permissions

default: permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

User object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the user.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether the user is disabled.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

URL of the user's icon.

\n
\n \n
\n
\n
\n
\n
\n

last_login_time

\n
\n

date-time

\n

The last time the user logged in.

\n
\n \n
\n
\n
\n
\n
\n

mfa_enabled

\n
\n

boolean

\n

If user has MFA enabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time that the user was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n

service_account

\n
\n

boolean

\n

Whether the user is a service account.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status of the user.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the user.

\n
\n \n
\n
\n
\n
\n
\n

verified

\n
\n

boolean

\n

Whether the user is verified.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

\n
\n
\n
\n
\n
\n

org

\n
\n

object

\n

Relationship to an organization.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to organization object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_orgs

\n
\n

object

\n

Relationship to organizations.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

other_users

\n
\n

object

\n

Relationship to users.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Relationships to user objects.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

roles

\n
\n

object

\n

Relationship to roles.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of objects related to the user.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Organization object.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the organization.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the organization.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the organization.

\n
\n \n
\n
\n
\n
\n
\n

disabled

\n
\n

boolean

\n

Whether or not the organization is disabled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time of last organization modification.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the organization.

\n
\n \n
\n
\n
\n
\n
\n

public_id

\n
\n

string

\n

Public ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

sharing

\n
\n

string

\n

Sharing type of the organization.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL of the site that this organization exists at.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the organization.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Permission object.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of a permission.

\n
\n
\n
\n
\n
\n

created

\n
\n

date-time

\n

Creation time of the permission.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the permission.

\n
\n \n
\n
\n
\n
\n
\n

display_name

\n
\n

string

\n

Displayed name for the permission.

\n
\n \n
\n
\n
\n
\n
\n

display_type

\n
\n

string

\n

Display type.

\n
\n \n
\n
\n
\n
\n
\n

group_name

\n
\n

string

\n

Name of the permission group.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the permission.

\n
\n \n
\n
\n
\n
\n
\n

restricted

\n
\n

boolean

\n

Whether or not the permission is restricted.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the permission.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Permissions resource type. \nAllowed enum values: permissions

default: permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Role object returned by the API.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the role.

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Creation time of the role.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Time of last role modification.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the role. The name is neither unique nor a stable identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

user_count

\n
\n

int64

\n

Number of users with that role.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique identifier of the role.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the role object returned by the API.

\n
\n
\n
\n
\n
\n

permissions

\n
\n

object

\n

Relationship to multiple permissions objects.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Relationships to permission objects.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the permission.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Permissions resource type. \nAllowed enum values: permissions

default: permissions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

\n
\n \n
\n
\n
\n
\n
\n
" }, "403": { "json": { diff --git a/content/en/cloud_cost_management/recommendations/savings.md b/content/en/cloud_cost_management/recommendations/savings.md index 77680396aa381..ea02c108c2392 100644 --- a/content/en/cloud_cost_management/recommendations/savings.md +++ b/content/en/cloud_cost_management/recommendations/savings.md @@ -1,5 +1,6 @@ --- title: Savings +private: true description: Learn how to track net savings to inform your cost savings initiatives. further_reading: - link: "/cloud_cost_management/" diff --git a/content/en/containers/amazon_ecs/_index.md b/content/en/containers/amazon_ecs/_index.md index 8d9b0a959b41d..0ba9f8234a7e2 100644 --- a/content/en/containers/amazon_ecs/_index.md +++ b/content/en/containers/amazon_ecs/_index.md @@ -19,6 +19,9 @@ further_reading: - link: "https://www.datadoghq.com/blog/cloud-cost-management-container-support/" tag: "blog" text: "Understand your Kubernetes and ECS spend with Datadog Cloud Cost Management" +- link: "https://www.datadoghq.com/blog/ecs-default-monitors/" + tag: "Blog" + text: "Catch and remediate ECS issues faster with default monitors and the ECS Explorer" - link: "https://www.datadoghq.com/architecture/using-datadog-with-ecs-fargate/" tag: "Architecture Center" text: "Using Datadog with ECS Fargate" diff --git a/content/en/containers/monitoring/autoscaling.md b/content/en/containers/autoscaling/_index.md similarity index 99% rename from content/en/containers/monitoring/autoscaling.md rename to content/en/containers/autoscaling/_index.md index 0057db04ff54f..911ee7d4bb43a 100644 --- a/content/en/containers/monitoring/autoscaling.md +++ b/content/en/containers/autoscaling/_index.md @@ -1,6 +1,8 @@ --- title: Kubernetes Autoscaling description: Automatically scale Kubernetes workloads using Datadog metrics and intelligent scaling recommendations +aliases: +- /containers/monitoring/autoscaling further_reading: - link: "https://www.datadoghq.com/blog/datadog-kubernetes-autoscaling/" tag: "Blog" diff --git a/content/en/containers/csi_driver/_index.md b/content/en/containers/kubernetes/csi_driver.md similarity index 99% rename from content/en/containers/csi_driver/_index.md rename to content/en/containers/kubernetes/csi_driver.md index 5a012a22c595d..7148eccaaa5fc 100644 --- a/content/en/containers/csi_driver/_index.md +++ b/content/en/containers/kubernetes/csi_driver.md @@ -1,6 +1,8 @@ --- title: Datadog CSI Driver description: High-performance observability for secure Kubernetes environments using the Datadog CSI Driver +aliases: +- /containers/csi_driver further_reading: - link: "https://www.datadoghq.com/blog/datadog-csi-driver/" tag: "Blog" diff --git a/content/en/continuous_integration/pipelines/jenkins.md b/content/en/continuous_integration/pipelines/jenkins.md index ce617195946c1..1dccaea7cd480 100644 --- a/content/en/continuous_integration/pipelines/jenkins.md +++ b/content/en/continuous_integration/pipelines/jenkins.md @@ -78,8 +78,27 @@ There are several ways you can configure the Datadog Jenkins plugin. ### Configure with the Jenkins configuration UI -{{< tabs >}} -{{% tab "Agentless (using an API key)" %}} +#### Report through the Datadog Agent (recommended) + +1. In your Jenkins instance web interface, go to **Manage Jenkins > Configure System**. +2. Go to the `Datadog Plugin` section, scrolling down the configuration screen. +3. Select the mode `Use the Datadog Agent to report to Datadog`. +4. Configure the `Agent` host. +5. Configure CI Visibility: + 1. Configure the `Traces Collection Port` if not using the default port `8126`. + 2. Click the `Test traces connection` button to verify that your configuration is valid. + 3. Enable the `Enable CI Visibility` checkbox. + 4. (Optional) Configure your CI Instance name. +6. (Optional) Configure logs collection: + 1. Configure the `Log Collection` port as configured in the Datadog Agent. + 2. Click the `Test logs connection` button to verify that your configuration is valid. + 3. Enable the `Enable Log Collection` checkbox. +7. (Optional) Enter the name of the host that you use to access Datadog UI (for example, `app.datadoghq.com`) in the `Datadog App hostname` field. +8. Save your configuration. + +{{< img src="ci/ci-jenkins-plugin-config-agentful-app-hostname.png" alt="Datadog Plugin configuration for Jenkins" style="width:100%;">}} + +#### Agentless (using an API key) Use this option to make the Jenkins plugin report directly to Datadog without using the Datadog Agent. It requires an API Key. @@ -100,54 +119,29 @@ Use this option to make the Jenkins plugin report directly to Datadog without us {{< img src="ci/ci-jenkins-plugin-config-agentless-app-hostname.png" alt="Datadog Plugin configuration for Jenkins" style="width:100%;">}} [1]: /getting_started/site/#access-the-datadog-site -{{% /tab %}} -{{% tab "Report through the Datadog Agent (recommended)" %}} - -1. In your Jenkins instance web interface, go to **Manage Jenkins > Configure System**. -2. Go to the `Datadog Plugin` section, scrolling down the configuration screen. -3. Select the mode `Use the Datadog Agent to report to Datadog`. -4. Configure the `Agent` host. -5. Configure CI Visibility: - 1. Configure the `Traces Collection Port` if not using the default port `8126`. - 2. Click the `Test traces connection` button to verify that your configuration is valid. - 3. Enable the `Enable CI Visibility` checkbox. - 4. (Optional) Configure your CI Instance name. -6. (Optional) Configure logs collection: - 1. Configure the `Log Collection` port as configured in the Datadog Agent. - 2. Click the `Test logs connection` button to verify that your configuration is valid. - 3. Enable the `Enable Log Collection` checkbox. -7. (Optional) Enter the name of the host that you use to access Datadog UI (for example, `app.datadoghq.com`) in the `Datadog App hostname` field. -8. Save your configuration. - -{{< img src="ci/ci-jenkins-plugin-config-agentful-app-hostname.png" alt="Datadog Plugin configuration for Jenkins" style="width:100%;">}} -{{% /tab %}} -{{< /tabs >}} ### Use Configuration-as-Code -{{< tabs >}} - -{{% tab "Agentless (using an API key)" %}} +#### Report through the Datadog Agent (recommended) If your Jenkins instance uses the Jenkins [`configuration-as-code`][1] plugin: 1. Create or modify the configuration YAML by adding an entry for `datadogGlobalConfiguration`: - {{% site-region region="us" %}} - {{< code-block lang="yaml" disable_copy="true" collapsible="true" >}} +```yaml unclassified: datadogGlobalConfiguration: datadogClientConfiguration: - # Select the `Agentless` mode (using API key). - datadogApiConfiguration: - intake: - datadogIntakeSite: - # Configure your Datadog site - site: 'US1' - apiKey: - datadogCredentialsApiKey: - # Configure ID of Jenkins credentials that store your API key - credentialsId: 'my-api-key-credentials-id' + # Select the `Datadog Agent` mode + datadogAgentConfiguration: + # Configure Datadog Agent host + agentHost: '' + # Configure Datadog Agent port + agentPort: 8125 + # (Optional) Configure logs collection port as configured in your Datadog Agent + agentLogCollectionPort: 10518 + # Configure traces collection port + agentTraceCollectionPort: 8126 # Enable CI Visibility flag enableCiVisibility: true # (Optional) Configure your CI Instance name @@ -156,146 +150,21 @@ unclassified: datadogAppHostname: 'app.datadoghq.com' # (Optional) Enable logs collection collectBuildLogs: true - {{< /code-block >}} - - {{% /site-region %}} - {{% site-region region="eu" %}} - - {{< code-block lang="yaml" disable_copy="true" collapsible="true" >}} -unclassified: - datadogGlobalConfiguration: - datadogClientConfiguration: - # Select the `Agentless` mode (using API key). - datadogApiConfiguration: - intake: - datadogIntakeSite: - # Configure your Datadog site - site: 'EU1' - apiKey: - datadogCredentialsApiKey: - # Configure ID of Jenkins credentials that store your API key - credentialsId: 'my-api-key-credentials-id' - # Enable CI Visibility flag - enableCiVisibility: true - # (Optional) Configure your CI Instance name - ciInstanceName: 'jenkins' - # (Optional) Configure the name of the host that you use to access Datadog UI - datadogAppHostname: 'app.datadoghq.eu' - # (Optional) Enable logs collection - collectBuildLogs: true - {{< /code-block >}} - - {{% /site-region %}} - {{% site-region region="gov" %}} - - {{< code-block lang="yaml" disable_copy="true" collapsible="true" >}} -unclassified: - datadogGlobalConfiguration: - datadogClientConfiguration: - # Select the `Agentless` mode (using API key). - datadogApiConfiguration: - intake: - datadogIntakeSite: - # Configure your Datadog site - site: 'US1_FED' - apiKey: - datadogCredentialsApiKey: - # Configure ID of Jenkins credentials that store your API key - credentialsId: 'my-api-key-credentials-id' - # Enable CI Visibility flag - enableCiVisibility: true - # (Optional) Configure your CI Instance name - ciInstanceName: 'jenkins' - # (Optional) Configure the name of the host that you use to access Datadog UI - datadogAppHostname: 'app.ddog-gov.com' - # (Optional) Enable logs collection - collectBuildLogs: true - {{< /code-block >}} - - {{% /site-region %}} - {{% site-region region="us3" %}} +``` - {{< code-block lang="yaml" disable_copy="true" collapsible="true" >}} -unclassified: - datadogGlobalConfiguration: - datadogClientConfiguration: - # Select the `Agentless` mode (using API key). - datadogApiConfiguration: - intake: - datadogIntakeSite: - # Configure your Datadog site - site: 'US3' - apiKey: - datadogCredentialsApiKey: - # Configure ID of Jenkins credentials that store your API key - credentialsId: 'my-api-key-credentials-id' - # Enable CI Visibility flag - enableCiVisibility: true - # (Optional) Configure the name of the host that you use to access Datadog UI - ciInstanceName: 'jenkins' - # (Optional) Configure your Datadog app hostname - datadogAppHostname: 'app.us3.datadoghq.com' - # (Optional) Enable logs collection - collectBuildLogs: true - {{< /code-block >}} +2. In your Jenkins instance web interface, go to **Manage Jenkins > Configuration as Code**. +3. Apply or reload the configuration. +4. Check the configuration using the `View Configuration` button. - {{% /site-region %}} - {{% site-region region="us5" %}} +[1]: https://github.com/jenkinsci/configuration-as-code-plugin/blob/master/README.md - {{< code-block lang="yaml" disable_copy="true" collapsible="true" >}} -unclassified: - datadogGlobalConfiguration: - datadogClientConfiguration: - # Select the `Agentless` mode (using API key). - datadogApiConfiguration: - intake: - datadogIntakeSite: - # Configure your Datadog site - site: 'US5' - apiKey: - datadogCredentialsApiKey: - # Configure ID of Jenkins credentials that store your API key - credentialsId: 'my-api-key-credentials-id' - # Enable CI Visibility flag - enableCiVisibility: true - # (Optional) Configure your CI Instance name - ciInstanceName: 'jenkins' - # (Optional) Configure the name of the host that you use to access Datadog UI - datadogAppHostname: 'app.us5.datadoghq.com' - # (Optional) Enable logs collection - collectBuildLogs: true - {{< /code-block >}} +#### Agentless (using an API key) - {{% /site-region %}} - {{% site-region region="ap1" %}} +If your Jenkins instance uses the Jenkins [`configuration-as-code`][1] plugin: - {{< code-block lang="yaml" disable_copy="true" collapsible="true" >}} -unclassified: - datadogGlobalConfiguration: - datadogClientConfiguration: - # Select the `Agentless` mode (using API key). - datadogApiConfiguration: - intake: - datadogIntakeSite: - # Configure your Datadog site - site: 'AP1' - apiKey: - datadogCredentialsApiKey: - # Configure ID of Jenkins credentials that store your API key - credentialsId: 'my-api-key-credentials-id' - # Enable CI Visibility flag - enableCiVisibility: true - # (Optional) Configure your CI Instance name - ciInstanceName: 'jenkins' - # (Optional) Configure the name of the host that you use to access Datadog UI - datadogAppHostname: 'app.ap1.datadoghq.com' - # (Optional) Enable logs collection - collectBuildLogs: true - {{< /code-block >}} - {{% /site-region %}} - {{% site-region region="ap2" %}} +1. Create or modify the configuration YAML by adding an entry for `datadogGlobalConfiguration`: - {{< code-block lang="yaml" disable_copy="true" collapsible="true" >}} +```yaml unclassified: datadogGlobalConfiguration: datadogClientConfiguration: @@ -304,7 +173,7 @@ unclassified: intake: datadogIntakeSite: # Configure your Datadog site - site: 'AP2' + site: '{{< region-param key=jenkins_site_name >}}' apiKey: datadogCredentialsApiKey: # Configure ID of Jenkins credentials that store your API key @@ -314,47 +183,10 @@ unclassified: # (Optional) Configure your CI Instance name ciInstanceName: 'jenkins' # (Optional) Configure the name of the host that you use to access Datadog UI - datadogAppHostname: 'app.ap2.datadoghq.com' + datadogAppHostname: '{{< region-param key=dd_full_site >}}' # (Optional) Enable logs collection collectBuildLogs: true - {{< /code-block >}} - {{% /site-region %}} - -2. In your Jenkins instance web interface, go to **Manage Jenkins > Configuration as Code**. -3. Apply or reload the configuration. -4. Check the configuration using the `View Configuration` button. - -[1]: https://github.com/jenkinsci/configuration-as-code-plugin/blob/master/README.md -{{% /tab %}} -{{% tab "Report through the Datadog Agent (recommended)" %}} - -If your Jenkins instance uses the Jenkins [`configuration-as-code`][1] plugin: - -1. Create or modify the configuration YAML by adding an entry for `datadogGlobalConfiguration`: - - {{< code-block lang="yaml" disable_copy="true" collapsible="true" >}} -unclassified: - datadogGlobalConfiguration: - datadogClientConfiguration: - # Select the `Datadog Agent` mode - datadogAgentConfiguration: - # Configure Datadog Agent host - agentHost: '' - # Configure Datadog Agent port - agentPort: 8125 - # (Optional) Configure logs collection port as configured in your Datadog Agent - agentLogCollectionPort: 10518 - # Configure traces collection port - agentTraceCollectionPort: 8126 - # Enable CI Visibility flag - enableCiVisibility: true - # (Optional) Configure your CI Instance name - ciInstanceName: 'jenkins' - # (Optional) Configure the name of the host that you use to access Datadog UI - datadogAppHostname: 'app.datadoghq.com' - # (Optional) Enable logs collection - collectBuildLogs: true - {{< /code-block >}} +``` 2. In your Jenkins instance web interface, go to **Manage Jenkins > Configuration as Code**. 3. Apply or reload the configuration. @@ -362,33 +194,26 @@ unclassified: [1]: https://github.com/jenkinsci/configuration-as-code-plugin/blob/master/README.md -{{% /tab %}} -{{< /tabs >}} - ### Configure with Groovy -{{< tabs >}} -{{% tab "Agentless (using an API key)" %}} +#### Report through the Datadog Agent (recommended) 1. In your Jenkins instance web interface, go to **Manage Jenkins > Script Console**. 2. Run the configuration script: - {{% site-region region="us" %}} - {{< code-block lang="groovy" disable_copy="true" collapsible="true" >}} -import hudson.util.Secret +```groovy import jenkins.model.Jenkins import org.datadog.jenkins.plugins.datadog.DatadogGlobalConfiguration -import org.datadog.jenkins.plugins.datadog.configuration.DatadogApiConfiguration -import org.datadog.jenkins.plugins.datadog.configuration.api.intake.DatadogIntakeSite -import org.datadog.jenkins.plugins.datadog.configuration.api.intake.DatadogSite -import org.datadog.jenkins.plugins.datadog.configuration.api.key.DatadogTextApiKey +import org.datadog.jenkins.plugins.datadog.configuration.DatadogAgentConfiguration def jenkins = Jenkins.getInstance() def datadog = jenkins.getDescriptorByType(DatadogGlobalConfiguration) -def site = new DatadogIntakeSite(DatadogSite.US1) // Pick your Datadog site -def apiKey = new DatadogTextApiKey(Secret.fromString('')) // or `new DatadogCredentialsApiKey('')` -datadog.datadogClientConfiguration = new DatadogApiConfiguration(site, apiKey) +def agentHost = 'localhost' // Configure your Datadog Agent host +def agentPort = 8125 +def agentLogCollectionPort = 10518 // (Optional) Configure logs collection port as configured in your Datadog Agent +def agentTraceCollectionPort = 8126 // Configure traces collection port +datadog.datadogClientConfiguration = new DatadogAgentConfiguration(agentHost, agentPort, agentLogCollectionPort, agentTraceCollectionPort) datadog.datadogAppHostname = 'app.datadoghq.com' // the name of the host that you use to access Datadog UI datadog.enableCiVisibility = true @@ -398,157 +223,14 @@ datadog.ciInstanceName = 'jenkins' // (Optional) Set your CI Instance name // Save config datadog.save() - {{< /code-block >}} - - {{% /site-region %}} - {{% site-region region="eu" %}} - - {{< code-block lang="groovy" disable_copy="true" collapsible="true" >}} -import hudson.util.Secret -import jenkins.model.Jenkins -import org.datadog.jenkins.plugins.datadog.DatadogGlobalConfiguration -import org.datadog.jenkins.plugins.datadog.configuration.DatadogApiConfiguration -import org.datadog.jenkins.plugins.datadog.configuration.api.intake.DatadogIntakeSite -import org.datadog.jenkins.plugins.datadog.configuration.api.intake.DatadogSite -import org.datadog.jenkins.plugins.datadog.configuration.api.key.DatadogTextApiKey - -def jenkins = Jenkins.getInstance() -def datadog = jenkins.getDescriptorByType(DatadogGlobalConfiguration) - -def site = new DatadogIntakeSite(DatadogSite.EU1) // Pick your Datadog site -def apiKey = new DatadogTextApiKey(Secret.fromString('')) // or `new DatadogCredentialsApiKey('')` -datadog.datadogClientConfiguration = new DatadogApiConfiguration(site, apiKey) - -datadog.datadogAppHostname = 'app.datadoghq.eu' // the name of the host that you use to access Datadog UI -datadog.enableCiVisibility = true -datadog.collectBuildLogs = true // (Optional) Enable logs collection - -datadog.ciInstanceName = 'jenkins' // (Optional) Set your CI Instance name - -// Save config -datadog.save() - {{< /code-block >}} - - {{% /site-region %}} - {{% site-region region="gov" %}} - - {{< code-block lang="groovy" disable_copy="true" collapsible="true" >}} -import hudson.util.Secret -import jenkins.model.Jenkins -import org.datadog.jenkins.plugins.datadog.DatadogGlobalConfiguration -import org.datadog.jenkins.plugins.datadog.configuration.DatadogApiConfiguration -import org.datadog.jenkins.plugins.datadog.configuration.api.intake.DatadogIntakeSite -import org.datadog.jenkins.plugins.datadog.configuration.api.intake.DatadogSite -import org.datadog.jenkins.plugins.datadog.configuration.api.key.DatadogTextApiKey - -def jenkins = Jenkins.getInstance() -def datadog = jenkins.getDescriptorByType(DatadogGlobalConfiguration) - -def site = new DatadogIntakeSite(DatadogSite.US1_FED) // Pick your Datadog site -def apiKey = new DatadogTextApiKey(Secret.fromString('')) // or `new DatadogCredentialsApiKey('')` -datadog.datadogClientConfiguration = new DatadogApiConfiguration(site, apiKey) - -datadog.datadogAppHostname = 'app.ddog-gov.com' // the name of the host that you use to access Datadog UI -datadog.enableCiVisibility = true -datadog.collectBuildLogs = true // (Optional) Enable logs collection - -datadog.ciInstanceName = 'jenkins' // (Optional) Set your CI Instance name - -// Save config -datadog.save() - {{< /code-block >}} - - {{% /site-region %}} - {{% site-region region="us3" %}} - - {{< code-block lang="groovy" disable_copy="true" collapsible="true" >}} -import hudson.util.Secret -import jenkins.model.Jenkins -import org.datadog.jenkins.plugins.datadog.DatadogGlobalConfiguration -import org.datadog.jenkins.plugins.datadog.configuration.DatadogApiConfiguration -import org.datadog.jenkins.plugins.datadog.configuration.api.intake.DatadogIntakeSite -import org.datadog.jenkins.plugins.datadog.configuration.api.intake.DatadogSite -import org.datadog.jenkins.plugins.datadog.configuration.api.key.DatadogTextApiKey - -def jenkins = Jenkins.getInstance() -def datadog = jenkins.getDescriptorByType(DatadogGlobalConfiguration) - -def site = new DatadogIntakeSite(DatadogSite.US3) // Pick your Datadog site -def apiKey = new DatadogTextApiKey(Secret.fromString('')) // or `new DatadogCredentialsApiKey('')` -datadog.datadogClientConfiguration = new DatadogApiConfiguration(site, apiKey) - -datadog.datadogAppHostname = 'app.us3.datadoghq.com' // the name of the host that you use to access Datadog UI -datadog.enableCiVisibility = true -datadog.collectBuildLogs = true // (Optional) Enable logs collection - -datadog.ciInstanceName = 'jenkins' // (Optional) Set your CI Instance name - -// Save config -datadog.save() - {{< /code-block >}} - - {{% /site-region %}} - {{% site-region region="us5" %}} - - {{< code-block lang="groovy" disable_copy="true" collapsible="true" >}} -import hudson.util.Secret -import jenkins.model.Jenkins -import org.datadog.jenkins.plugins.datadog.DatadogGlobalConfiguration -import org.datadog.jenkins.plugins.datadog.configuration.DatadogApiConfiguration -import org.datadog.jenkins.plugins.datadog.configuration.api.intake.DatadogIntakeSite -import org.datadog.jenkins.plugins.datadog.configuration.api.intake.DatadogSite -import org.datadog.jenkins.plugins.datadog.configuration.api.key.DatadogTextApiKey - -def jenkins = Jenkins.getInstance() -def datadog = jenkins.getDescriptorByType(DatadogGlobalConfiguration) - -def site = new DatadogIntakeSite(DatadogSite.US5) // Pick your Datadog site -def apiKey = new DatadogTextApiKey(Secret.fromString('')) // or `new DatadogCredentialsApiKey('')` -datadog.datadogClientConfiguration = new DatadogApiConfiguration(site, apiKey) - -datadog.datadogAppHostname = 'app.us5.datadoghq.com' // the name of the host that you use to access Datadog UI -datadog.enableCiVisibility = true -datadog.collectBuildLogs = true // (Optional) Enable logs collection - -datadog.ciInstanceName = 'jenkins' // (Optional) Set your CI Instance name - -// Save config -datadog.save() - {{< /code-block >}} - - {{% /site-region %}} - {{% site-region region="ap1" %}} - - {{< code-block lang="groovy" disable_copy="true" collapsible="true" >}} -import hudson.util.Secret -import jenkins.model.Jenkins -import org.datadog.jenkins.plugins.datadog.DatadogGlobalConfiguration -import org.datadog.jenkins.plugins.datadog.configuration.DatadogApiConfiguration -import org.datadog.jenkins.plugins.datadog.configuration.api.intake.DatadogIntakeSite -import org.datadog.jenkins.plugins.datadog.configuration.api.intake.DatadogSite -import org.datadog.jenkins.plugins.datadog.configuration.api.key.DatadogTextApiKey - -def jenkins = Jenkins.getInstance() -def datadog = jenkins.getDescriptorByType(DatadogGlobalConfiguration) - -def site = new DatadogIntakeSite(DatadogSite.AP1) // Pick your Datadog site -def apiKey = new DatadogTextApiKey(Secret.fromString('')) // or `new DatadogCredentialsApiKey('')` -datadog.datadogClientConfiguration = new DatadogApiConfiguration(site, apiKey) - -datadog.datadogAppHostname = 'app.ap1.datadoghq.com' // the name of the host that you use to access Datadog UI -datadog.enableCiVisibility = true -datadog.collectBuildLogs = true // (Optional) Enable logs collection - -datadog.ciInstanceName = 'jenkins' // (Optional) Set your CI Instance name +``` -// Save config -datadog.save() - {{< /code-block >}} +#### Agentless (using an API key) - {{% /site-region %}} - {{% site-region region="ap2" %}} +1. In your Jenkins instance web interface, go to **Manage Jenkins > Script Console**. +2. Run the configuration script: - {{< code-block lang="groovy" disable_copy="true" collapsible="true" >}} +```groovy import hudson.util.Secret import jenkins.model.Jenkins import org.datadog.jenkins.plugins.datadog.DatadogGlobalConfiguration @@ -560,11 +242,11 @@ import org.datadog.jenkins.plugins.datadog.configuration.api.key.DatadogTextApiK def jenkins = Jenkins.getInstance() def datadog = jenkins.getDescriptorByType(DatadogGlobalConfiguration) -def site = new DatadogIntakeSite(DatadogSite.AP2) // Pick your Datadog site +def site = new DatadogIntakeSite(DatadogSite.{{< region-param key=jenkins_site_name >}}) // Pick your Datadog site def apiKey = new DatadogTextApiKey(Secret.fromString('')) // or `new DatadogCredentialsApiKey('')` datadog.datadogClientConfiguration = new DatadogApiConfiguration(site, apiKey) -datadog.datadogAppHostname = 'app.ap2.datadoghq.com' // the name of the host that you use to access Datadog UI +datadog.datadogAppHostname = '{{< region-param key=dd_full_site >}}' // the name of the host that you use to access Datadog UI datadog.enableCiVisibility = true datadog.collectBuildLogs = true // (Optional) Enable logs collection @@ -572,268 +254,71 @@ datadog.ciInstanceName = 'jenkins' // (Optional) Set your CI Instance name // Save config datadog.save() - {{< /code-block >}} - - {{% /site-region %}} - -{{% /tab %}} -{{% tab "Report through the Datadog Agent (recommended)" %}} - -1. In your Jenkins instance web interface, go to **Manage Jenkins > Script Console**. -2. Run the configuration script: - - {{< code-block lang="groovy" disable_copy="true" collapsible="true" >}} -import jenkins.model.Jenkins -import org.datadog.jenkins.plugins.datadog.DatadogGlobalConfiguration -import org.datadog.jenkins.plugins.datadog.configuration.DatadogAgentConfiguration - -def jenkins = Jenkins.getInstance() -def datadog = jenkins.getDescriptorByType(DatadogGlobalConfiguration) - -def agentHost = 'localhost' // Configure your Datadog Agent host -def agentPort = 8125 -def agentLogCollectionPort = 10518 // (Optional) Configure logs collection port as configured in your Datadog Agent -def agentTraceCollectionPort = 8126 // Configure traces collection port -datadog.datadogClientConfiguration = new DatadogAgentConfiguration(agentHost, agentPort, agentLogCollectionPort, agentTraceCollectionPort) - -datadog.datadogAppHostname = 'app.datadoghq.com' // the name of the host that you use to access Datadog UI -datadog.enableCiVisibility = true -datadog.collectBuildLogs = true // (Optional) Enable logs collection - -datadog.ciInstanceName = 'jenkins' // (Optional) Set your CI Instance name - -// Save config -datadog.save() - {{< /code-block >}} - -{{% /tab %}} -{{< /tabs >}} +``` ### Use environment variables -{{< tabs >}} -{{% tab "Agentless (using an API key)" %}} +#### Report through the Datadog Agent (recommended) 1. Set the following environment variables on your Jenkins instance machine: - {{% site-region region="us" %}} - {{< code-block lang="bash" disable_copy="true" collapsible="true" >}} - # Select the Datadog Agent mode - DATADOG_JENKINS_PLUGIN_REPORT_WITH=HTTP - - # Configure your Datadog site - DATADOG_JENKINS_PLUGIN_DATADOG_SITE=US1 - - # Configure your API key - DATADOG_JENKINS_PLUGIN_TARGET_API_KEY=your-api-key - - # Enable CI Visibility - DATADOG_JENKINS_PLUGIN_ENABLE_CI_VISIBILITY=true - - # (Optional) Configure your CI Instance name - DATADOG_JENKINS_PLUGIN_CI_VISIBILITY_CI_INSTANCE_NAME=jenkins - - # (Optional) Enable logs collection - DATADOG_JENKINS_PLUGIN_COLLECT_BUILD_LOGS=true - - # (Optional) Configure the name of the host that you use to access Datadog UI - DATADOG_JENKINS_PLUGIN_DATADOG_APP_HOSTNAME=app.datadoghq.com - {{< /code-block >}} - - {{% /site-region %}} - - {{% site-region region="eu" %}} - {{< code-block lang="bash" disable_copy="true" collapsible="true" >}} - # Select the Datadog Agent mode - DATADOG_JENKINS_PLUGIN_REPORT_WITH=HTTP - - # Configure your Datadog site - DATADOG_JENKINS_PLUGIN_DATADOG_SITE=EU1 - - # Configure your API key - DATADOG_JENKINS_PLUGIN_TARGET_API_KEY=your-api-key - - # Enable CI Visibility - DATADOG_JENKINS_PLUGIN_ENABLE_CI_VISIBILITY=true - - # (Optional) Configure your CI Instance name - DATADOG_JENKINS_PLUGIN_CI_VISIBILITY_CI_INSTANCE_NAME=jenkins - - # (Optional) Enable logs collection - DATADOG_JENKINS_PLUGIN_COLLECT_BUILD_LOGS=true - - # (Optional) Configure the name of the host that you use to access Datadog UI - DATADOG_JENKINS_PLUGIN_DATADOG_APP_HOSTNAME=app.datadoghq.eu - {{< /code-block >}} - - {{% /site-region %}} - {{% site-region region="gov" %}} - - {{< code-block lang="bash" disable_copy="true" collapsible="true" >}} - # Select the Datadog Agent mode - DATADOG_JENKINS_PLUGIN_REPORT_WITH=HTTP - - # Configure your Datadog site - DATADOG_JENKINS_PLUGIN_DATADOG_SITE=US1_FED - - # Configure your API key - DATADOG_JENKINS_PLUGIN_TARGET_API_KEY=your-api-key - - # Enable CI Visibility - DATADOG_JENKINS_PLUGIN_ENABLE_CI_VISIBILITY=true - - # (Optional) Configure your CI Instance name - DATADOG_JENKINS_PLUGIN_CI_VISIBILITY_CI_INSTANCE_NAME=jenkins - - # (Optional) Enable logs collection - DATADOG_JENKINS_PLUGIN_COLLECT_BUILD_LOGS=true - - # (Optional) Configure the name of the host that you use to access Datadog UI - DATADOG_JENKINS_PLUGIN_DATADOG_APP_HOSTNAME=app.ddog-gov.com - {{< /code-block >}} - - {{% /site-region %}} - {{% site-region region="us3" %}} - - {{< code-block lang="bash" disable_copy="true" collapsible="true" >}} - # Select the Datadog Agent mode - DATADOG_JENKINS_PLUGIN_REPORT_WITH=HTTP - - # Configure your Datadog site - DATADOG_JENKINS_PLUGIN_DATADOG_SITE=US3 - - # Configure your API key - DATADOG_JENKINS_PLUGIN_TARGET_API_KEY=your-api-key - - # Enable CI Visibility - DATADOG_JENKINS_PLUGIN_ENABLE_CI_VISIBILITY=true - - # (Optional) Configure your CI Instance name - DATADOG_JENKINS_PLUGIN_CI_VISIBILITY_CI_INSTANCE_NAME=jenkins - - # (Optional) Enable logs collection - DATADOG_JENKINS_PLUGIN_COLLECT_BUILD_LOGS=true - - # (Optional) Configure the name of the host that you use to access Datadog UI - DATADOG_JENKINS_PLUGIN_DATADOG_APP_HOSTNAME=app.us3.datadoghq.com - {{< /code-block >}} - - {{% /site-region %}} - {{% site-region region="us5" %}} - - {{< code-block lang="bash" disable_copy="true" collapsible="true" >}} - # Select the Datadog Agent mode - DATADOG_JENKINS_PLUGIN_REPORT_WITH=HTTP - - # Configure your Datadog site - DATADOG_JENKINS_PLUGIN_DATADOG_SITE=US5 - - # Configure your API key - DATADOG_JENKINS_PLUGIN_TARGET_API_KEY=your-api-key - - # Enable CI Visibility - DATADOG_JENKINS_PLUGIN_ENABLE_CI_VISIBILITY=true - - # (Optional) Configure your CI Instance name - DATADOG_JENKINS_PLUGIN_CI_VISIBILITY_CI_INSTANCE_NAME=jenkins - - # (Optional) Enable logs collection - DATADOG_JENKINS_PLUGIN_COLLECT_BUILD_LOGS=true - - # (Optional) Configure the name of the host that you use to access Datadog UI - DATADOG_JENKINS_PLUGIN_DATADOG_APP_HOSTNAME=app.us5.datadoghq.com - {{< /code-block >}} - - {{% /site-region %}} - {{% site-region region="ap1" %}} - - {{< code-block lang="bash" disable_copy="true" collapsible="true" >}} - # Select the Datadog Agent mode - DATADOG_JENKINS_PLUGIN_REPORT_WITH=HTTP - - # Configure your Datadog site - DATADOG_JENKINS_PLUGIN_DATADOG_SITE=AP1 - - # Configure your API key - DATADOG_JENKINS_PLUGIN_TARGET_API_KEY=your-api-key - - # Enable CI Visibility - DATADOG_JENKINS_PLUGIN_ENABLE_CI_VISIBILITY=true - - # (Optional) Configure your CI Instance name - DATADOG_JENKINS_PLUGIN_CI_VISIBILITY_CI_INSTANCE_NAME=jenkins - - # (Optional) Enable logs collection - DATADOG_JENKINS_PLUGIN_COLLECT_BUILD_LOGS=true - - # (Optional) Configure the name of the host that you use to access Datadog UI - DATADOG_JENKINS_PLUGIN_DATADOG_APP_HOSTNAME=app.ap1.datadoghq.com - {{< /code-block >}} - {{% /site-region %}} - - {{% site-region region="ap2" %}} +```bash +# Select the Datadog Agent mode +DATADOG_JENKINS_PLUGIN_REPORT_WITH=DSD - {{< code-block lang="bash" disable_copy="true" collapsible="true" >}} - # Select the Datadog Agent mode - DATADOG_JENKINS_PLUGIN_REPORT_WITH=HTTP +# Configure the Agent host +DATADOG_JENKINS_PLUGIN_TARGET_HOST=your-agent-host - # Configure your Datadog site - DATADOG_JENKINS_PLUGIN_DATADOG_SITE=AP2 +# Configure the Traces Collection port (default 8126) +DATADOG_JENKINS_PLUGIN_TARGET_TRACE_COLLECTION_PORT=8126 - # Configure your API key - DATADOG_JENKINS_PLUGIN_TARGET_API_KEY=your-api-key +# Enable CI Visibility +DATADOG_JENKINS_PLUGIN_ENABLE_CI_VISIBILITY=true - # Enable CI Visibility - DATADOG_JENKINS_PLUGIN_ENABLE_CI_VISIBILITY=true +# (Optional) Configure your CI Instance name +DATADOG_JENKINS_PLUGIN_CI_VISIBILITY_CI_INSTANCE_NAME=jenkins - # (Optional) Configure your CI Instance name - DATADOG_JENKINS_PLUGIN_CI_VISIBILITY_CI_INSTANCE_NAME=jenkins +# (Optional) Configure Log Collection port as configured in your Datadog Agent +DATADOG_JENKINS_PLUGIN_TARGET_LOG_COLLECTION_PORT=10518 - # (Optional) Enable logs collection - DATADOG_JENKINS_PLUGIN_COLLECT_BUILD_LOGS=true +# (Optional) Enable logs collection +DATADOG_JENKINS_PLUGIN_COLLECT_BUILD_LOGS=true - # (Optional) Configure the name of the host that you use to access Datadog UI - DATADOG_JENKINS_PLUGIN_DATADOG_APP_HOSTNAME=app.ap2.datadoghq.com - {{< /code-block >}} - {{% /site-region %}} +# (Optional) Configure the name of the host that you use to access Datadog UI +DATADOG_JENKINS_PLUGIN_DATADOG_APP_HOSTNAME=app.datadoghq.com +``` 2. Restart your Jenkins instance. -{{% /tab %}} -{{% tab "Report through the Datadog Agent (recommended)" %}} + +#### Agentless (using an API key) 1. Set the following environment variables on your Jenkins instance machine: - ```bash - # Select the Datadog Agent mode - DATADOG_JENKINS_PLUGIN_REPORT_WITH=DSD +```bash +# Select the Datadog Agent mode +DATADOG_JENKINS_PLUGIN_REPORT_WITH=HTTP - # Configure the Agent host - DATADOG_JENKINS_PLUGIN_TARGET_HOST=your-agent-host +# Configure your Datadog site +DATADOG_JENKINS_PLUGIN_DATADOG_SITE={{< region-param key=jenkins_site_name >}} - # Configure the Traces Collection port (default 8126) - DATADOG_JENKINS_PLUGIN_TARGET_TRACE_COLLECTION_PORT=8126 +# Configure your API key +DATADOG_JENKINS_PLUGIN_TARGET_API_KEY=your-api-key - # Enable CI Visibility - DATADOG_JENKINS_PLUGIN_ENABLE_CI_VISIBILITY=true +# Enable CI Visibility +DATADOG_JENKINS_PLUGIN_ENABLE_CI_VISIBILITY=true - # (Optional) Configure your CI Instance name - DATADOG_JENKINS_PLUGIN_CI_VISIBILITY_CI_INSTANCE_NAME=jenkins +# (Optional) Configure your CI Instance name +DATADOG_JENKINS_PLUGIN_CI_VISIBILITY_CI_INSTANCE_NAME=jenkins - # (Optional) Configure Log Collection port as configured in your Datadog Agent - DATADOG_JENKINS_PLUGIN_TARGET_LOG_COLLECTION_PORT=10518 +# (Optional) Enable logs collection +DATADOG_JENKINS_PLUGIN_COLLECT_BUILD_LOGS=true - # (Optional) Enable logs collection - DATADOG_JENKINS_PLUGIN_COLLECT_BUILD_LOGS=true - - # (Optional) Configure the name of the host that you use to access Datadog UI - DATADOG_JENKINS_PLUGIN_DATADOG_APP_HOSTNAME=app.datadoghq.com - ``` +# (Optional) Configure the name of the host that you use to access Datadog UI +DATADOG_JENKINS_PLUGIN_DATADOG_APP_HOSTNAME={{< region-param key=dd_full_site >}} +``` 2. Restart your Jenkins instance. -{{% /tab %}} -{{< /tabs >}} - ## Collect job logs Job logs collection can be enabled optionally when configuring the Jenkins plugin (see previous section). @@ -953,12 +438,13 @@ However, depending on the Jenkins version and the pipeline details, there may be In this case you can make the Git information available to the plugin by using the `.each {k,v -> env.setProperty(k, v)}` function after executing the `checkout` or `git` steps. For example: -{{< tabs >}} -{{% tab "Using Declarative Pipelines" %}} +#### Using Declarative Pipelines + If you're using a declarative pipeline to configure your pipeline, propagate Git information using a `script` block as follows: Using the `checkout` step: -{{< code-block lang="groovy" >}} + +```groovy pipeline { stages { stage('Checkout') { @@ -969,10 +455,11 @@ pipeline { ... } } -{{< /code-block >}} +``` Using the `git` step: -{{< code-block lang="groovy" >}} + +```groovy pipeline { stages { stage('Checkout') { @@ -983,34 +470,33 @@ pipeline { ... } } -{{< /code-block >}} +``` + +#### Using Scripted Pipelines -{{% /tab %}} -{{% tab "Using Scripted Pipelines" %}} If you're using a scripted pipeline to configure your pipeline, you can propagate the git information to environment variables directly. Using the `checkout` step: -{{< code-block lang="groovy" >}} + +```groovy node { stage('Checkout') { checkout(...).each {k,v -> env.setProperty(k,v)} } ... } -{{< /code-block >}} +``` Using the `git` step: -{{< code-block lang="groovy" >}} + +```groovy node { stage('Checkout') { git(...).each {k,v -> env.setProperty(k,v)} } ... } -{{< /code-block >}} - -{{% /tab %}} -{{< /tabs >}} +``` ### Set Git information manually diff --git a/content/en/continuous_testing/environments/proxy_firewall_vpn.md b/content/en/continuous_testing/environments/proxy_firewall_vpn.md index 50433a0c18d49..a9fdc6595cd69 100644 --- a/content/en/continuous_testing/environments/proxy_firewall_vpn.md +++ b/content/en/continuous_testing/environments/proxy_firewall_vpn.md @@ -53,56 +53,22 @@ Allow **Outbound connections** for the following Datadog endpoints: | Port | Endpoint | Description | | ---- | ---------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | -| 443 | `tunnel-us1.synthetics.datadoghq.com` | Required to open the WSS connection from the `datadog-ci` client to the tunnel service. | +| 443 | {{< region-param key="synthetics_tunnel_endpoint" code="true" >}} | Required to open the WSS connection from the `datadog-ci` client to the tunnel service. | | 443 | `intake.synthetics.datadoghq.com` | Required to get the presigned URL and to trigger the Synthetic tests. | -| 443 | `api.datadoghq.com` | Required to search for Synthetic tests, get them, and poll their results. | +| 443 | {{< region-param key="api_endpoint" code="true" >}} | Required to search for Synthetic tests, get them, and poll their results. | {{< /site-region >}} - -{{< site-region region="eu" >}} - -| Port | Endpoint | Description | -| ---- | ---------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | -| 443 | `tunnel-eu1.synthetics.datadoghq.com` | Required to open the WSS connection from the `datadog-ci` client to the tunnel service. | -| 443 | `api.datadoghq.eu` | Required to get the presigned URL, search for Synthetic tests, get them, trigger them, and poll their results. | - -**Note**: Although the tunnel service top level domain is `.com` (and not `.eu`), the endpoint is located in EU (Frankfurt AWS). - -{{< /site-region >}} - -{{< site-region region="us3" >}} - -| Port | Endpoint | Description | -| ---- | ---------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | -| 443 | `tunnel-us3.synthetics.datadoghq.com` | Required to open the WSS connection from the `datadog-ci` client to the tunnel service. | -| 443 | `api.us3.datadoghq.com` | Required to get the presigned URL, search for Synthetic tests, get them, trigger them, and poll their results. | - -{{< /site-region >}} - -{{< site-region region="us5" >}} +{{< site-region region="us3,us5,eu,ap1,ap2" >}} | Port | Endpoint | Description | | ---- | ---------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | -| 443 | `tunnel-us5.synthetics.datadoghq.com` | Required to open the WSS connection from the `datadog-ci` client to the tunnel service. | -| 443 | `api.us5.datadoghq.com` | Required to get the presigned URL, search for Synthetic tests, get them, trigger them, and poll their results. | +| 443 | {{< region-param key="synthetics_tunnel_endpoint" code="true" >}} | Required to open the WSS connection from the `datadog-ci` client to the tunnel service. | +| 443 | {{< region-param key="api_endpoint" code="true" >}} | Required to get the presigned URL, search for Synthetic tests, get them, trigger them, and poll their results. | {{< /site-region >}} +{{< site-region region="eu" >}} -{{< site-region region="ap1" >}} - - Port | Endpoint | Description | -| ---- | ---------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | -| 443 | `tunnel-ap1.synthetics.datadoghq.com` | Required to open the WSS connection from the `datadog-ci` client to the tunnel service. | -| 443 | `api.ap1.datadoghq.com` | Required to get the presigned URL, search for Synthetic tests, get them, trigger them, and poll their results. | - -{{< /site-region >}} - -{{< site-region region="ap2" >}} - - Port | Endpoint | Description | -| ---- | ---------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | -| 443 | `tunnel-ap2.synthetics.datadoghq.com` | Required to open the WSS connection from the `datadog-ci` client to the tunnel service. | -| 443 | `api.ap2.datadoghq.com` | Required to get the presigned URL, search for Synthetic tests, get them, trigger them, and poll their results. | +**Note**: Although the tunnel service top level domain is `.com` (and not `.eu`), the endpoint is located in EU (Frankfurt AWS). {{< /site-region >}} @@ -118,7 +84,7 @@ For `resourceUrlSubstitutionRegexes`, specify an array of strings, each containi For example: -``` +```text https://prod.my-app.com/assets/(.*)|http://localhost:3000/assets/$1 ``` diff --git a/content/en/data_jobs/airflow.md b/content/en/data_jobs/airflow.md index 81b6218326603..b71aeb6dfbb85 100644 --- a/content/en/data_jobs/airflow.md +++ b/content/en/data_jobs/airflow.md @@ -46,7 +46,54 @@ To get started, follow the instructions below. openlineage-airflow ``` -2. Configure `openlineage` provider. The simplest option is to set the following environment variables and make them available to pods where you run Airflow schedulers and Airflow workers: +2. Configure `openlineage` provider. Choose one of the following configuration options and set the environment variables, making them available to pods where you run Airflow schedulers and Airflow workers: + + **Option 1: Datadog Transport (Recommended)** + + **Requirements**: Requires `apache-airflow-providers-openlineage` version 2.7.3 or later and `openlineage-python` version 1.37.0 or later. + + ```shell + export DD_API_KEY= + export DD_SITE= + export OPENLINEAGE__TRANSPORT__TYPE=datadog + # OPENLINEAGE_NAMESPACE sets the 'env' tag value in Datadog. You can hardcode this to a different value + export OPENLINEAGE_NAMESPACE=${AIRFLOW_ENV_NAME} + ``` + * Replace `` with your valid [Datadog API key][4]. + * Replace `` with your Datadog site (for example, {{< region-param key="dd_site" code="true" >}}). + + **Option 2: Composite Transport** + + **Requirements**: Requires `apache-airflow-providers-openlineage` version 1.11.0 or later and `openlineage-python` version 1.37.0 or later. + + Use this option if you're already using OpenLineage with another system and want to add Datadog as an additional destination. The composite transport sends events to all configured transports. + + For example, if you're using an HTTP transport to send events to another system: + + ```shell + # Your existing HTTP transport configuration + export OPENLINEAGE__TRANSPORT__TYPE=composite + export OPENLINEAGE__TRANSPORT__TRANSPORTS__EXISTING__TYPE=http + export OPENLINEAGE__TRANSPORT__TRANSPORTS__EXISTING__URL= + export OPENLINEAGE__TRANSPORT__TRANSPORTS__EXISTING__AUTH__TYPE=api_key + export OPENLINEAGE__TRANSPORT__TRANSPORTS__EXISTING__AUTH__API_KEY= + + # Add Datadog as an additional transport + export DD_API_KEY= + export DD_SITE= + export OPENLINEAGE__TRANSPORT__TRANSPORTS__DATADOG__TYPE=datadog + # OPENLINEAGE_NAMESPACE sets the 'env' tag value in Datadog. You can hardcode this to a different value + export OPENLINEAGE_NAMESPACE=${AIRFLOW_ENV_NAME} + ``` + * Replace `` with your valid [Datadog API key][4]. + * Replace `` with your Datadog site (for example, {{< region-param key="dd_site" code="true" >}}). + * Replace `` and `` with your existing OpenLineage transport configuration. + + In this example, OpenLineage events are sent to both your existing system and Datadog. You can configure multiple transports by giving each one a unique name (like `EXISTING` and `DATADOG` in the example above). + + **Option 3: Simple Configuration** + + This option uses the URL-based configuration and works with all versions of the OpenLineage provider: ```shell export OPENLINEAGE_URL= @@ -56,6 +103,7 @@ To get started, follow the instructions below. ``` * Replace `` with `https://data-obs-intake.`{{< region-param key="dd_site" code="true" >}}. * Replace `` with your valid [Datadog API key][4]. + * If you're using **Airflow v2.7 or v2.8**, also add these two environment variables along with the previous ones. This fixes an OpenLinage config issue fixed at `apache-airflow-providers-openlineage` v1.7, while Airflow v2.7 and v2.8 use previous versions. ```shell #!/bin/sh @@ -68,7 +116,7 @@ To get started, follow the instructions below. 3. Trigger an update to your Airflow pods and wait for them to finish. -4. Optionally, set up log collection for correlating task logs to DAG run executions in Data Jobs Monitoring. Correlation requires the logs directory to follow the [default log filename format][6]. +4. Optionally, set up log collection for correlating task logs to DAG run executions in Data Jobs Monitoring. Correlation requires the logs directory to follow the [default log filename format][6]. The `PATH_TO_AIRFLOW_LOGS` value is `$AIRFLOW_HOME/logs` in standard deployments, but may differ if customized. Add the following annotation to your pod: ```yaml @@ -76,13 +124,13 @@ To get started, follow the instructions below. ``` Adding `"source": "airflow"` enables the extraction of the correlation-required attributes by the [Airflow integration][8] logs pipeline. - + These file paths are relative to the Agent container. Mount the directory containing the log file into both the application and Agent containers so the Agent can access it. For details, see [Collect logs from a container local log file][10]. **Note**: Log collection requires the Datadog agent to already be installed on your Kubernetes cluster. If you haven't installed it yet, see the [Kubernetes installation documentation][9]. For more methods to set up log collection on Kubernetes, see the [Kubernetes and Integrations configuration section][7]. - + [1]: https://github.com/apache/airflow/releases/tag/2.5.0 [2]: https://airflow.apache.org/docs/apache-airflow-providers-openlineage/stable/index.html @@ -270,10 +318,10 @@ To get started, follow the instructions below. ```text { - "type": "http", - "url": "", + "type": "http", + "url": "", "auth": { - "type": "api_key", + "type": "api_key", "api_key": "" } } @@ -281,7 +329,7 @@ To get started, follow the instructions below. * Replace `` fully with `https://data-obs-intake.`{{< region-param key="dd_site" code="true" >}}. * Replace `` fully with your valid [Datadog API key][5]. - + Check official [Airflow][4] and [Composer][3] documentation pages for other supported configurations of the `openlineage` provider in Google Cloud Composer. diff --git a/content/en/database_monitoring/guide/parameterized_queries.md b/content/en/database_monitoring/guide/parameterized_queries.md index 181b26ede5bee..065cd6672d735 100644 --- a/content/en/database_monitoring/guide/parameterized_queries.md +++ b/content/en/database_monitoring/guide/parameterized_queries.md @@ -1,6 +1,5 @@ --- title: Capturing SQL Query Parameter Values With Database Monitoring -private: true further_reading: - link: "/database_monitoring/" tag: "Documentation" @@ -13,10 +12,6 @@ further_reading: text: "Troubleshooting Database Monitoring" --- -
-This feature is in preview. To enable collection of raw SQL query text and execution plans with parameter values, please contact your Datadog representative or support. -
- The Database Monitoring integrations collect aggregated query metrics, in-flight query executions, and query explain plans across your database. By default, query SQL texts and explain plans are obfuscated and normalized in the Agent before being sent to Datadog in order to protect sensitive data, which may be exposed in query parameters. However, exposing query statements with actual parameter values provides enhanced observability and debugging capabilities. Database Monitoring currently supports query capture with parameter values on the PostgreSQL and SQL Server integrations. @@ -31,7 +26,7 @@ Having access to query parameters enables: ## Before you begin -
Query statements and execution plans with parameterized values may contain sensitive information (for example, passwords in query parameters) or personally identifiable information. Enabling this option allows Datadog to collect and ingest raw query statements and execution plans that appear in query samples or explain plans. This option is disabled by default.
+
Query statements and execution plans with parameterized values may contain sensitive information (for example, passwords in query parameters) or personally identifiable information. Enabling this option allows Datadog to collect and ingest raw query statements and execution plans that appear in query samples or explain plans. This option is disabled by default.
You must configure Database Monitoring for your [SQL Server][1] instance before continuing with this guide. @@ -41,6 +36,10 @@ Supported databases Supported deployments : All deployment types. +## Permissions + +To view query parameter values in the Database Monitoring UI, users need the **Database Monitoring Parameterized Queries Read** permission. This permission is located under the **Database Monitoring** section in the [Roles page][2]. This permission is enabled by default in the Datadog Admin Role, Datadog Standard Role, and Datadog Read Only Role. If your organization uses custom roles, add this permission to the appropriate role. For more information on managing permissions, see the [RBAC documentation][3]. + ## Setup To capture SQL query text and execution plans with parameter values, update the appropriate integration `conf.yaml` file based on your database type: - For PostgreSQL: edit `postgres.d/conf.yaml` @@ -51,7 +50,8 @@ To capture SQL query text and execution plans with parameter values, update the enabled: true ``` -For SQL Server, capturing parameter values from prepared statements requires enabling query completion capture via Extended Events. See [configure your SQL Server instance and integration to capture query completions][1] in order to complete the database set up. +
+For SQL Server, capturing parameter values from prepared statements requires enabling query completion capture through Extended Events. See configure your SQL Server instance and integration to capture query completions in order to complete the database set up.
```yaml xe_collection: @@ -92,3 +92,5 @@ To capture prepared statements with parameter values in SQL Server, you must [co Support for PostgreSQL prepared statement parameter value capture is not available at this time. [1]: /database_monitoring/guide/sql_extended_events/ +[2]: /account_management/rbac/permissions/ +[3]: /account_management/rbac/ diff --git a/content/en/database_monitoring/setup_postgres/alloydb.md b/content/en/database_monitoring/setup_postgres/alloydb.md index 3147976a02bb8..485d7d6bc9f02 100644 --- a/content/en/database_monitoring/setup_postgres/alloydb.md +++ b/content/en/database_monitoring/setup_postgres/alloydb.md @@ -5,6 +5,9 @@ further_reading: - link: "/integrations/postgres/" tag: "Documentation" text: "Basic Postgres Integration" +- link: "/database_monitoring/guide/parameterized_queries/" + tag: "Documentation" + text: "Capturing SQL Query Parameter Values" --- Database Monitoring provides deep visibility into your Postgres databases by exposing query metrics, query samples, explain plans, database states, failovers, and events. @@ -274,7 +277,7 @@ Using the [Operator instructions in Kubernetes and Integrations][3] as a referen ```shell kubectl apply -f datadog-agent.yaml ``` - + ### Helm Using the [Helm instructions in Kubernetes and Integrations][4] as a reference, follow the steps below to set up the Postgres integration: diff --git a/content/en/database_monitoring/setup_postgres/aurora.md b/content/en/database_monitoring/setup_postgres/aurora.md index e2414d5f20818..d51d84f275583 100644 --- a/content/en/database_monitoring/setup_postgres/aurora.md +++ b/content/en/database_monitoring/setup_postgres/aurora.md @@ -5,6 +5,9 @@ further_reading: - link: "/integrations/postgres/" tag: "Documentation" text: "Basic Postgres Integration" +- link: "/database_monitoring/guide/parameterized_queries/" + tag: "Documentation" + text: "Capturing SQL Query Parameter Values" --- Database Monitoring provides deep visibility into your Postgres databases by exposing query metrics, query samples, explain plans, database states, failovers, and events. diff --git a/content/en/database_monitoring/setup_postgres/azure.md b/content/en/database_monitoring/setup_postgres/azure.md index 95ffd98d51945..85581c8fe4faf 100644 --- a/content/en/database_monitoring/setup_postgres/azure.md +++ b/content/en/database_monitoring/setup_postgres/azure.md @@ -5,6 +5,9 @@ further_reading: - link: "/integrations/postgres/" tag: "Documentation" text: "Basic Postgres Integration" +- link: "/database_monitoring/guide/parameterized_queries/" + tag: "Documentation" + text: "Capturing SQL Query Parameter Values" --- Database Monitoring provides deep visibility into your Postgres databases by exposing query metrics, query samples, explain plans, database states, failovers, and events. diff --git a/content/en/database_monitoring/setup_postgres/gcsql.md b/content/en/database_monitoring/setup_postgres/gcsql.md index 2945856cf9dfd..9a7ee0efbc791 100644 --- a/content/en/database_monitoring/setup_postgres/gcsql.md +++ b/content/en/database_monitoring/setup_postgres/gcsql.md @@ -5,6 +5,9 @@ further_reading: - link: "/integrations/postgres/" tag: "Documentation" text: "Basic Postgres Integration" +- link: "/database_monitoring/guide/parameterized_queries/" + tag: "Documentation" + text: "Capturing SQL Query Parameter Values" --- Database Monitoring provides deep visibility into your Postgres databases by exposing query metrics, query samples, explain plans, database states, failovers, and events. @@ -273,7 +276,7 @@ Using the [Operator instructions in Kubernetes and Integrations][3] as a referen ```shell kubectl apply -f datadog-agent.yaml ``` - + ### Helm Using the [Helm instructions in Kubernetes and Integrations][4] as a reference, follow the steps below to set up the Postgres integration: diff --git a/content/en/database_monitoring/setup_postgres/heroku.md b/content/en/database_monitoring/setup_postgres/heroku.md index 598e398328359..fd16923e2360e 100644 --- a/content/en/database_monitoring/setup_postgres/heroku.md +++ b/content/en/database_monitoring/setup_postgres/heroku.md @@ -7,6 +7,9 @@ further_reading: - link: "/agent/basic_agent_usage/heroku/" tag: "Documentation" text: "Datadog Heroku Buildpack" +- link: "/database_monitoring/guide/parameterized_queries/" + tag: "Documentation" + text: "Capturing SQL Query Parameter Values" --- This guide assumes that you have configured the [Datadog Heroku buildpack][1] in your application dynos. @@ -89,7 +92,7 @@ heroku config:set DD_ENABLE_HEROKU_POSTGRES=true git commit --allow-empty -m "enabled postgres integration" git push heroku main ``` - + To enable both the Postgres integration and Database Monitoring, set `DD_ENABLE_HEROKU_POSTGRES` and `DD_ENABLE_DBM` to true: ``` shell @@ -140,7 +143,7 @@ In the root of the project, create a directory for the Postgres configuration ca mkdir -p datadog/conf.d/postgres.d touch datadog/conf.d/postgres.d/conf.yaml ``` - + Add the following to `conf.yaml`: ``` yaml @@ -217,4 +220,3 @@ The database connection is now configured. To enable additional features, such a [4]: https://devcenter.heroku.com/articles/heroku-postgres-plans [6]: /database_monitoring/schema_explorer [7]: https://github.com/DataDog/integrations-core/blob/master/postgres/datadog_checks/postgres/data/conf.yaml.example - \ No newline at end of file diff --git a/content/en/database_monitoring/setup_postgres/rds/_index.md b/content/en/database_monitoring/setup_postgres/rds/_index.md index a9e4a149270ac..536255b420a9d 100644 --- a/content/en/database_monitoring/setup_postgres/rds/_index.md +++ b/content/en/database_monitoring/setup_postgres/rds/_index.md @@ -8,6 +8,9 @@ further_reading: - link: "/database_monitoring/guide/rds_autodiscovery" tag: "Documenation" text: "Autodiscovery for RDS" +- link: "/database_monitoring/guide/parameterized_queries/" + tag: "Documentation" + text: "Capturing SQL Query Parameter Values" --- Database Monitoring provides deep visibility into your Postgres databases by exposing query metrics, query samples, explain plans, database states, failovers, and events. diff --git a/content/en/database_monitoring/setup_postgres/selfhosted.md b/content/en/database_monitoring/setup_postgres/selfhosted.md index 70005234deec1..a642de76a6f38 100644 --- a/content/en/database_monitoring/setup_postgres/selfhosted.md +++ b/content/en/database_monitoring/setup_postgres/selfhosted.md @@ -5,6 +5,9 @@ further_reading: - link: "/integrations/postgres/" tag: "Documentation" text: "Basic Postgres Integration" +- link: "/database_monitoring/guide/parameterized_queries/" + tag: "Documentation" + text: "Capturing SQL Query Parameter Values" --- Database Monitoring provides deep visibility into your Postgres databases by exposing query metrics, query samples, explain plans, database states, failovers, and events. diff --git a/content/en/database_monitoring/setup_sql_server/azure.md b/content/en/database_monitoring/setup_sql_server/azure.md index d7583b610fe57..ed07c0687eb77 100644 --- a/content/en/database_monitoring/setup_sql_server/azure.md +++ b/content/en/database_monitoring/setup_sql_server/azure.md @@ -14,6 +14,9 @@ further_reading: - link: "/database_monitoring/guide/sql_extended_events/" tag: "Documentation" text: "Configure Query Completion and Query Error Collection" +- link: "/database_monitoring/guide/parameterized_queries/" + tag: "Documentation" + text: "Capturing SQL Query Parameter Values" --- Database Monitoring provides deep visibility into your Microsoft SQL Server databases by exposing query metrics, query samples, explain plans, database states, failovers, and events. diff --git a/content/en/database_monitoring/setup_sql_server/gcsql.md b/content/en/database_monitoring/setup_sql_server/gcsql.md index ee8e481b34f07..65d59e22cebd1 100644 --- a/content/en/database_monitoring/setup_sql_server/gcsql.md +++ b/content/en/database_monitoring/setup_sql_server/gcsql.md @@ -11,6 +11,9 @@ further_reading: - link: "/database_monitoring/guide/sql_extended_events/" tag: "Documentation" text: "Configure Query Completion and Query Error Collection" +- link: "/database_monitoring/guide/parameterized_queries/" + tag: "Documentation" + text: "Capturing SQL Query Parameter Values" --- Database Monitoring provides deep visibility into your Microsoft SQL Server databases by exposing query metrics, query samples, explain plans, database states, failovers, and events. diff --git a/content/en/database_monitoring/setup_sql_server/rds.md b/content/en/database_monitoring/setup_sql_server/rds.md index e7721675263a1..638cc2891415d 100644 --- a/content/en/database_monitoring/setup_sql_server/rds.md +++ b/content/en/database_monitoring/setup_sql_server/rds.md @@ -14,6 +14,9 @@ further_reading: - link: "/database_monitoring/guide/sql_extended_events/" tag: "Documentation" text: "Configure Query Completion and Query Error Collection" +- link: "/database_monitoring/guide/parameterized_queries/" + tag: "Documentation" + text: "Capturing SQL Query Parameter Values" --- Database Monitoring provides deep visibility into your Microsoft SQL Server databases by exposing query metrics, query samples, explain plans, database states, failovers, and events. diff --git a/content/en/database_monitoring/setup_sql_server/selfhosted.md b/content/en/database_monitoring/setup_sql_server/selfhosted.md index 90ba0aebef747..1b2427cfd09e5 100644 --- a/content/en/database_monitoring/setup_sql_server/selfhosted.md +++ b/content/en/database_monitoring/setup_sql_server/selfhosted.md @@ -14,6 +14,9 @@ further_reading: - link: "/database_monitoring/guide/sql_extended_events/" tag: "Documentation" text: "Configure Query Completion and Query Error Collection" +- link: "/database_monitoring/guide/parameterized_queries/" + tag: "Documentation" + text: "Capturing SQL Query Parameter Values" - link: "https://www.datadoghq.com/blog/migrate-sql-workloads-to-azure-with-datadog/" tag: "Blog" text: "Strategize your Azure migration for SQL workloads with Datadog" diff --git a/content/en/datadog_cloudcraft/_index.md b/content/en/datadog_cloudcraft/_index.md index 1230f227a01ac..8ee08b17d2c8e 100644 --- a/content/en/datadog_cloudcraft/_index.md +++ b/content/en/datadog_cloudcraft/_index.md @@ -1,6 +1,6 @@ --- title: Cloudcraft in Datadog -description: "Visualize and analyze AWS cloud infrastructure with live Cloudcraft diagrams in Datadog for troubleshooting, security analysis, and cost optimization." +description: "Visualize and analyze AWS and Azure cloud infrastructure with live Cloudcraft diagrams in Datadog for troubleshooting, security analysis, and cost optimization." further_reading: - link: "https://www.datadoghq.com/blog/cloud-architecture-diagrams-cost-compliance-cloudcraft-datadog/" tag: "Blog" @@ -19,7 +19,7 @@ Cloudcraft offers a powerful, live read-only visualization tool for cloud archit
This documentation applies to the Cloudcraft in Datadog product. For information on the standalone Cloudcraft product, please refer to the Cloudcraft (Standalone) documentation.
-Cloudcraft's core functionality is its ability to generate detailed architecture diagrams. These diagrams visually represent AWS cloud resources, allowing you to explore and analyze your environments. Cloudcraft's diagrams are optimized for clarity and performance, providing an intuitive interface for navigating large-scale deployments. This helps teams to: +Cloudcraft's core functionality is its ability to generate detailed architecture diagrams. These diagrams visually represent AWS and Azure cloud resources, allowing you to explore and analyze your environments. Cloudcraft's diagrams are optimized for clarity and performance, providing an intuitive interface for navigating large-scale deployments. This helps teams to: - Trace incidents back to their root causes through infrastructure dependencies. - Determine if infrastructure is the cause of an incident, such as cross-region traffic causing latency or increased costs. @@ -27,24 +27,65 @@ Cloudcraft's core functionality is its ability to generate detailed architecture - Onboard new team members. - Accelerate incident MTTR and proactive governance tasks by simplifying infrastructure navigation. -{{< img src="datadog_cloudcraft/cloudcraft_with_ccm_2.mp4" alt="Cloudcraft in Datadog video" video=true >}} +{{< img src="datadog_cloudcraft/cloudcraft_with_azure_tab_2.mp4" alt="Video showing a Cloudcraft diagram in the security overlay. A resource is selected, opening a side panel with its details. The Changes option is selected from the left hand side of the side panel. In the Security section of the side panel, several misconfigurations are listed. The Investigate button next to one of the misconfigurations is clicked, opening a new side panel with details of the misconfiguration and a Next Steps section with options for Triage, Remediation, and More Actions" video=true >}} -
Cloudcraft in Datadog is currently only available for AWS accounts.
+
Cloudcraft in Datadog is only available for AWS and Azure accounts.
-### Prerequisites +## Prerequisites + +{{< tabs >}} +{{% tab "AWS" %}} - To access Cloudcraft in Datadog, you need the `cloudcraft_read` [permission](#permissions). - [Resource collection][2] must be enabled for your AWS accounts. - For the best experience, Datadog strongly recommends using the AWS-managed [`SecurityAudit`][5] policy, or the more permissive [`ReadOnlyAccess`][6] policy. + - Viewing content on the [Security overlay][10] requires additional products to be enabled: - To view security misconfigurations and identity risks, [Cloud Security][3] must be enabled. - To view sensitive data, [Sensitive Data Scanner][12] must be enabled. For a user to turn the layer on, they must have the [`data_scanner_read`][13] permission. **Note**: Cloudcraft adapts to restrictive permissions by excluding inaccessible resources. For example, if you don't grant permission to list S3 buckets, the diagram excludes those buckets. If permissions block certain resources, an alert displays in the UI. -
Enabling resource collection can impact your AWS CloudWatch costs. To avoid these charges, disable Usage metrics in the Metric Collection tab of the Datadog AWS Integration.
+
+Enabling resource collection can impact your AWS CloudWatch costs. To avoid these charges, disable Usage metrics in the Metric Collection tab of the Datadog AWS Integration. +
+ +{{< img src="/infrastructure/resource_catalog/aws_usage_toggle.png" alt="The Usage service highlighted in the Metric Collection tab of the AWS integration tile" style="width:100%;" >}} + +[2]: /integrations/amazon_web_services/#resource-collection +[3]: /security/cloud_security_management +[5]: https://docs.aws.amazon.com/aws-managed-policy/latest/reference/SecurityAudit.html +[6]: https://docs.aws.amazon.com/aws-managed-policy/latest/reference/ReadOnlyAccess.html +[10]: /datadog_cloudcraft/overlays#security +[12]: /security/sensitive_data_scanner +[13]: /account_management/rbac/permissions/#compliance + +{{% /tab %}} +{{% tab "Azure" %}} + +- To access Cloudcraft in Datadog, you need the `cloudcraft_read` [permission](#permissions). +- You need the Datadog Admin Role, or any role with the `azure_configurations_manage` permission. See the [Azure setup][16] instructions for more information. -{{< img src="/infrastructure/resource_catalog/aws_usage_toggle.png" alt="AWS Usage toggle in account settings" style="width:100%;" >}}
+- Enable [resource collection][14] for your Azure accounts: + 1. Navigate to [**Integrations > Azure**][15]. + 2. Add your Azure subscription by selecting **+ Add New App Registration** if not already added. + 3. Select the App Registration containing your Azure subscription. + 4. On the Resource Collection tab, ensure the **Enable Resource Collection** toggle is enabled. + +- Viewing content on the [Security overlay][10] requires additional products to be enabled: + - To view security misconfigurations and identity risks, [Cloud Security][3] must be enabled. + - To view sensitive data, [Sensitive Data Scanner][12] must be enabled. For a user to turn the layer on, they must have the [`data_scanner_read`][13] permission. + +[3]: /security/cloud_security_management +[10]: /datadog_cloudcraft/overlays#security +[12]: /security/sensitive_data_scanner +[13]: /account_management/rbac/permissions/#compliance +[14]: /getting_started/integrations/azure/ +[15]: https://app.datadoghq.com/integrations/azure +[16]: /integrations/guide/azure-manual-setup/?tab=azurecli#setup + +{{% /tab %}} +{{< /tabs >}} ## Getting started @@ -52,27 +93,28 @@ To get started using Cloudcraft, use the following steps: 1. Navigate to [**Infrastructure > Resources > Cloudcraft**][7]. 2. A real-time diagram of the resources is displayed in your environment. - **Note**: For environments with more than 10,000 resources, you must filter the diagram by account, region, or tags before it can be displayed. +**Note**: If your environment has more than 10,000 resources, filter the diagram by account, region, or tags to display it. -{{< img src="datadog_cloudcraft/getting_started_3.mp4" alt="Video showing getting started in Cloudcraft by selecting the Account, Region, and Resource" video=true;" >}} +{{< img src="datadog_cloudcraft/getting_started.png" alt="Getting started in Cloudcraft, displaying a list of resources for the selected account and region" style="width:100%;" >}} -**Note**: The account name in the **Account** dropdown originates from your AWS account tags in the AWS integration tile. +
The account name in the Account dropdown comes from your AWS account tags in the AWS integration tile. For Azure, the Subscription name comes from the subscription name in your Azure integration tile's list of managed subscriptions. +
### Group By With Group By, Cloudcraft divides your diagram into distinct sections based on different group types. This feature offers a clear and organized perspective of your resources, making it especially helpful for visualizing complex cloud environments. -Enable the **Show All Controls** toggle to display the available **Group By** options. You can also remove specific groupings by unchecking options like VPC and Region. To view the current nesting structure and add the Network ACL (Network Access Control List) layer, click the **More** dropdown. +Enable the **Show All Controls** toggle to display the available **Group By** options. You can remove specific groupings by unchecking options like VPC and Region. To view the current nesting structure and add the Network ACL (Network Access Control List) layer, click the **+ Tags** menu. -{{< img src="datadog_cloudcraft/cloudcraft_group_by_with_ccm.png" alt="Group by feature in Cloudcraft, highlighting the Group By menu" >}} +{{< img src="datadog_cloudcraft/cloudcraft_group_by_with_network_acl.png" alt="Group by feature in Cloudcraft, highlighting the Group By menu." >}} #### Group by tags -You can group resources by AWS tags, such as app, service, team, or cost center, to organize your view by team or workload. +You can group resources by AWS and Azure tags, such as app, service, team, or cost center, to organize your view by team or workload. When grouping by tags, color-coded labels are displayed on each group. When grouping by the `service` tag, a raised block is displayed to visually indicate the service grouping. -**Note**: Grouping by tags is supported for AWS tags only. Tags from the Datadog Agent (for example ,`env`, or `team` tags from local configuration) are not supported. +**Note**: Grouping by tags is supported for AWS and Azure tags only. Tags from the Datadog Agent (for example, locally configured `env` or `team` tags) are not supported. -{{< img src="datadog_cloudcraft/group_by_tag.mp4" alt="Group by tag feature in Cloudcraft, grouping by Team and Cost Center" video=true >}} +{{< img src="datadog_cloudcraft/cloudcraft_group_by_with_team_tags.png" alt="Cloudcraft landing page with Group by highlighted, and grouping by Team" >}} ### Saved views @@ -89,28 +131,25 @@ To apply a saved view to your diagram: Use the zoom and hover features to pinpoint the most critical resources. As you zoom in, additional resource names become visible. Hovering over a resource displays a panel with basic information, while clicking on a resource opens a side panel with observability, cost, and security data, along with cross-links to other relevant Datadog products. -{{< img src="datadog_cloudcraft/cloudcraft_with_ccm_2.mp4" alt="Video showing the zoom and hover feature in Cloudcraft and clicking on a resource to open the side panel" video=true >}} +{{< img src="datadog_cloudcraft/cloudcraft_with_security_2.mp4" alt="Video showing the zoom and hover feature in Cloudcraft and clicking on a resource to open the side panel" video=true >}} #### Projection toggle Toggle the projection from 3D (default) to 2D to visualize your resources from a top-down view. -{{< img src="datadog_cloudcraft/cloudcraft_2D.png" alt="Cloudcraft landing page with the 2D toggle enabled" >}} - +{{< img src="datadog_cloudcraft/cloudcraft_2D_2.png" alt="Cloudcraft landing page with the 2D toggle enabled" >}} ### Filtering and search Diagrams can be filtered by tags, such as team, application, or service, allowing you to concentrate on relevant resources while maintaining context through connected resources. Additionally, Cloudcraft provides a powerful search and highlight feature, enabling ease of location of specific resources or groups of resources. -Click the **\+Filter** menu to quickly filter your resources by commonly used tags such as service, team, region, and more. Additionally, click the **More Filters** option to filter by AWS tags, custom tags, and terraform tags. The filter option reloads the diagram to display only the infrastructure that matches the filter criteria. - -{{< img src="datadog_cloudcraft/cloudcraft_filter.png" alt="Filter feature in Cloudcraft" >}} +Click the **+ Filter** menu to filter your resources by commonly used tags such as service, team, region, and more. Additionally, click the **More Filters** option to filter by AWS and Azure tags, custom tags, and Terraform tags. The filter option reloads the diagram to display only the infrastructure that matches the filter criteria. ### Search and highlight -Use the search bar to locate resources on the diagram by name, ID, or tag. This feature is highly effective for finding specific resources within your cloud architecture. It highlights the search criteria in the diagram, without creating a new diagram, by greying out the elements that do not match the search criteria. +Use the search bar to locate resources on the diagram by name, ID, or tag. This feature is effective for finding specific resources within your cloud architecture. It highlights the search criteria in the diagram, without creating a new diagram, by greying out the elements that do not match the search criteria. -{{< img src="datadog_cloudcraft/search_highlight_2.mp4" alt="Video showing the search and highlight feature in Cloudcraft" video=true >}} +{{< img src="datadog_cloudcraft/search_highlight_4.mp4" alt="Video showing the search and highlight feature in Cloudcraft" video=true >}} ## Permissions diff --git a/content/en/datadog_cloudcraft/overlays.md b/content/en/datadog_cloudcraft/overlays.md index d4ad3107ea480..43464f5b08f1d 100644 --- a/content/en/datadog_cloudcraft/overlays.md +++ b/content/en/datadog_cloudcraft/overlays.md @@ -29,7 +29,7 @@ The infrastructure view provides a broad overview, grouping resources by Account The infrastructure diagram excludes components like EBS, NAT Gateway, and Transit Gateway to reduce visual clutter and highlight the most important parts of your architecture. -{{< img src="datadog_cloudcraft/overlays/cloudcraft_infra_diagram_with_ccm_2.png" alt="Infrastructure overlay in Cloudcraft" style="width:100%;" >}} +{{< img src="datadog_cloudcraft/infra_overlay_4.png" alt="Infrastructure overlay in Cloudcraft." style="width:100%;" >}} ### Observability @@ -41,7 +41,7 @@ On the Observability overlay, you can take action on individual resources or gro - Click a resource group, such as a subnet or VPC, to open a side panel that allows you to apply bulk updates across all the hosts in that resource group. - To select multiple (but not all) hosts, hold down the Command key on Mac or the Control key on Windows while clicking on each host. -{{< img src="datadog_cloudcraft/overlays/observability_overlay_with_fleet.mp4" alt="Observability overlay in Cloudcraft, showing the bulk update feature and navigating to Fleet Automation." video=true >}} +{{< img src="datadog_cloudcraft/observability_overlay_with_fleet_2.mp4" alt="Observability overlay in Cloudcraft, clicking on a resource group, and opening the side panel to display the bulk update feature." video=true >}} In the bottom left legend, the **View Datadog coverage by** dropdown allows you to inspect the installation status for specific features. Each row shows: @@ -92,19 +92,19 @@ By default, the security overlay shows Critical, High, and Medium severity misco You can click on any resource that has findings to open a side panel with more details, allowing deeper investigation without leaving the diagram. Click **Investigate** to get more context about the finding and learn how to remediate it. -{{< img src="datadog_cloudcraft/overlays/cloudcraft_security_overlay_misconfigurations.png" alt="Security overlay in Cloudcraft with the misconfigurations filter applied, highlighting the collapsible legend in the bottom left of the screen, and the Investigate button on the side panel." style="width:100%;" >}} +{{< img src="datadog_cloudcraft/overlays/cloudcraft_security_overlay_misconfigurations_2.png" alt="Security overlay in Cloudcraft with the misconfigurations filter applied in the collapsible legend in the bottom of the screen, and highlighting the Investigate button" style="width:100%;" >}} #### Investigate sensitive data You can view sensitive data matches for your S3 buckets. Click a resource with matches to learn more about the bucket's sensitive data matches. Then, hover over a filename and click its **Inspect in AWS** button. -{{< img src="datadog_cloudcraft/overlays/cloudcraft_security_overlay_sensitive_data.png" alt="Security overlay in Cloudcraft with the sensitive data filter applied, highlighting the collapsible legend in the bottom left of the screen, and the Inspect in AWS button on the side panel." style="width:100%;" >}} +{{< img src="datadog_cloudcraft/overlays/cloudcraft_security_overlay_sensitive_data_2.png" alt="Security overlay in Cloudcraft with the sensitive data filter applied, highlighting the collapsible legend in the bottom left of the screen, and the Inspect in AWS button on the side panel." style="width:100%;" >}} #### Investigate vulnerabilities View security vulnerability matches associated with your EC2 instances. Click a resource that has a matching vulnerability. This opens a side panel which provides detailed vulnerability data for a selected EC2 instance, including severity, affected packages, and exploit status. For deeper analysis, click **Investigate** to get more context about the vulnerability and learn how to remediate it. -{{< img src="datadog_cloudcraft/overlays/cloudcraft_security_vuln.png" alt="Security overlay in Cloudcraft with the vulnerabilities filter applied, highlighting the collapsible legend in the bottom left of the screen, and the Investigate button on the side panel." style="width:100%;" >}} +{{< img src="datadog_cloudcraft/overlays/cloudcraft_security_vuln_2.png" alt="Security overlay in Cloudcraft with the vulnerabilities filter applied, highlighting the collapsible legend in the bottom left of the screen, and the Investigate button on the side panel." style="width:100%;" >}} ### Cloud Cost Management @@ -123,7 +123,7 @@ Clicking a resource opens a detailed side panel with: This enables faster, in-context cost optimization without switching views. -{{< img src="datadog_cloudcraft/cloudcraft_ccm_overlay_3.png" alt="Cloud Cost Management(CCM) overlay in Cloudcraft, highlighting the collapsible savings legend at the bottom left hand side of the screen." style="width:100%;" >}} +{{< img src="datadog_cloudcraft/overlays/cloudcraft_ccm_overlay_4.png" alt="Cloud Cost Management (CCM) overlay in Cloudcraft, highlighting the recommendations option in the collapsible legend at the bottom left hand side of the screen." style="width:100%;" >}} ## Further reading diff --git a/content/en/ddsql_reference/_index.md b/content/en/ddsql_reference/_index.md index 96cc4e0bedb1a..faa52a16e7f4f 100644 --- a/content/en/ddsql_reference/_index.md +++ b/content/en/ddsql_reference/_index.md @@ -808,9 +808,6 @@ ORDER BY value DESC;{{< /code-block >}} - - - ## Tags DDSQL exposes tags as an `hstore` type, which is inspired by PostgreSQL. You can access the values for specific tag keys using the PostgreSQL arrow operator. For example: @@ -840,6 +837,21 @@ FROM k8s.daemonsets da INNER JOIN k8s.deployments de ON da.tags = de.tags -- for a specific tag: da.tags->'app' = de.tags->'app' ``` +Additionally, you can extract tag keys and values into individual arrays of text: + +```sql +SELECT akeys(tags), avals(tags) +FROM aws.ec2_instance +``` + +### HSTORE functions and operators + +| Name | Return type | Description | +|-----------------------------------------------|---------------|--------------------------------------------------------------------------------------------------- +| tags -> 'text' | Text | Gets the value for a given key. Returns `null` if key is not present. | +| akeys(hstore tags) | Array of text | Gets the keys of an HSTORE as an array | +| avals(hstore tags) | Array of text | Gets the values of an HSTORE as an array | + ## Further reading {{< partial name="whats-next/whats-next.html" >}} diff --git a/content/en/developers/guide/dogwrap.md b/content/en/developers/guide/dogwrap.md index 230b00ab36fb1..c35c22bce5360 100644 --- a/content/en/developers/guide/dogwrap.md +++ b/content/en/developers/guide/dogwrap.md @@ -22,29 +22,9 @@ To install from source: The minimum valid `dogwrap` command has the following layout: -{{< site-region region="us,gov,ap1,ap2" >}} ```bash -dogwrap -n -k "" +dogwrap -n -k {{< region-param key=dogwrap_site_flag >}} "" ``` -{{< /site-region >}} - -{{< site-region region="us3" >}} -```bash -dogwrap -n -k -s us3 "" -``` -{{< /site-region >}} - -{{< site-region region="us5" >}} -```bash -dogwrap -n -k -s us5 "" -``` -{{< /site-region >}} - -{{< site-region region="eu" >}} -```bash -dogwrap -n -k -s eu "" -``` -{{< /site-region >}} **Note**: The `dogwrap` command sends data to the US Datadog site by default. If you need to send data to another site, you must include the `-s` option specifying a target site, such as `eu`, `us3`, `us5`, etc. diff --git a/content/en/feature_flags/feature_flag_mcp_server.md b/content/en/feature_flags/feature_flag_mcp_server.md new file mode 100644 index 0000000000000..9b8ca15b61c4d --- /dev/null +++ b/content/en/feature_flags/feature_flag_mcp_server.md @@ -0,0 +1,115 @@ +--- +title: Feature Flags MCP Server +description: "Learn how to use the Feature Flags toolset in the Datadog MCP Server" +further_reading: +- link: "getting_started/feature_flags" + tag: "Documentation" + text: "Getting Started with Feature Flags" +- link: "bits_ai/mcp_server" + tag: "Documentation" + text: "Datadog MCP Server" +--- + +{{< callout url="http://datadoghq.com/product-preview/feature-flags/" >}} +Feature Flags are in Preview. Complete the form to request access. +{{< /callout >}} + +## Overview + +The Datadog MCP Server uses the Model Context Protocol (MCP) to provide AI agents with access to [Feature Flags][1] management capabilities, including flag creation, configuration, and React/JavaScript integration guidance. + +## Setup + +The following configurations give your AI agent access to the Feature Flags toolset in the Datadog MCP Server. You must restart your agent after performing this setup. + +For all clients, install the MCP Server binary: + +```bash +curl -sSL https://coterm.datadoghq.com/mcp-cli/install.sh | bash +``` + +Then follow the instructions below to add the MCP Server to your specific client. + +### Claude Code + +```bash +claude mcp add datadog -- ~/.local/bin/datadog_mcp_cli --endpoint-path /api/unstable/mcp-server/mcp?toolsets=feature-flags +``` + +### Cursor +Add this to `~/.cursor/mcp.json` (remember to save the file): + +```json +{ + "mcpServers": { + "datadog-ff": { + "type": "stdio", + "command": "~/.local/bin/datadog_mcp_cli --endpoint-path /api/unstable/mcp-server/mcp?toolsets=feature-flags", + "args": [], + "env": {} + } + } +} +``` + +## Use cases + +The MCP Server includes tools to help you manage feature flags in your codebase. The following use cases provide sample prompts for using the tools. + +
+ The MCP Server only supports React applications. +
+ +### Create feature flags + +Use the `create-feature-flag` tool to create feature flags. You do not need to specify the tool name in the prompt, but it can provide more consistent results. +The MCP Server has access to Datadog's documentation and uses it to implement the flag in your codebase. + +If you do not yet have feature flags implemented, mention in the prompt that you want to implement Datadog feature flags. + +Example prompts: +- Use the `create-feature-flag` tool to create a flag to control the title on the main page. +- I want to show a confirmation modal when `` happens. Use a Datadog feature flag to control whether the confirmation modal is shown. + +### Check feature flag implementation + +Use the `check-flag-implementation` tool to check if a feature flag is implemented correctly. + +The tool checks that the flag is being referenced as the correct value type, is passing the correct subject attributes, and is providing the correct default value that agrees with the default in production environments. + +Example prompts: +- Check if the `show-confirmation-modal` flag is implemented correctly. +- Check if all feature flags in `/some/directory` are implemented correctly. + +**Note**: This may not find all issues. Checking flags individually is more reliable. + +This tool can also be used to add feature flags created in the UI to your codebase. For example: + +- Use the `show-confirmation-modal` flag to control whether the confirmation modal is shown when `` happens. + +### List feature flags + +Use the `list-feature-flags` tool to list all feature flags. For example: + +- List all feature flags. + +### List environments + +Use the `list-environments` tool to list all environments. For example: + +- List my flagging environments. + +### Update feature flag environments +Use the `update-feature-flag-environment` tool to update a feature flag environment. This tool can control the default variants, and enable or disable the flag. +It cannot modify flags in production environments. + +Example prompts: + +- I want `show-confirmation-modal` to serve true in development. +- Disable `show-confirmation-modal` in staging. + +## Further reading + +{{< partial name="whats-next/whats-next.html" >}} + +[1]: /feature_flags/ diff --git a/content/en/feature_flags/guide/_index.md b/content/en/feature_flags/guide/_index.md index bd72937bcb550..46436c3fd57f8 100644 --- a/content/en/feature_flags/guide/_index.md +++ b/content/en/feature_flags/guide/_index.md @@ -15,5 +15,6 @@ Feature Flags are in Preview. Complete the form to request access. {{< /callout >}} {{< whatsnext desc="Feature Flags Guides:" >}} + {{< nextlink href="/getting_started/feature_flags" >}}Getting started with Feature Flags{{< /nextlink >}} {{< nextlink href="/feature_flags/guide/migrate_from_statsig" >}}Migrate Your Feature Flags from Statsig{{< /nextlink >}} {{< /whatsnext >}} diff --git a/content/en/gpu_monitoring/setup.md b/content/en/gpu_monitoring/setup.md index 39d738259050d..f297af5995dca 100644 --- a/content/en/gpu_monitoring/setup.md +++ b/content/en/gpu_monitoring/setup.md @@ -12,16 +12,18 @@ To begin using Datadog's GPU Monitoring, your environment must meet the followin #### Minimum version requirements -- **Datadog Agent**: version 7.70.1 +- **Datadog Agent**: version 7.72.2 - [**Datadog Operator**][5]: version 1.18, _or_ [**Datadog Helm chart**][6]: version 3.137.3 - **Operating system**: Linux - (Optional) For advanced eBPF metrics, Linux kernel version 5.8 - **NVIDIA driver**: version 450.51 - **Kubernetes**: 1.22 with PodResources API active -## Set up GPU Monitoring on a uniform cluster +## Set up GPU Monitoring on a uniform cluster or non-Kubernetes environment -In a uniform cluster, all nodes have GPU devices. +The following instructions are the basic steps to set up GPU Monitoring in the following environments: +- In a Kubernetes cluster where **all** the nodes have GPU devices +- In a non-Kubernetes environment, such as Docker or non-containerized Linux. {{< tabs >}} {{% tab "Datadog Operator" %}} @@ -97,6 +99,156 @@ In a uniform cluster, all nodes have GPU devices. [2]: https://github.com/DataDog/datadog-agent/releases {{% /tab %}} + +{{% tab "Docker" %}} + +To enable GPU Monitoring in Docker without advanced eBPF metrics, use the following configuration when starting the container Agent: + +```shell +docker run \ +--pid host \ +--gpus all \ +-e DD_GPU_ENABLED=true \ +-v /var/run/docker.sock:/var/run/docker.sock:ro \ +-v /proc/:/host/proc/:ro \ +-v /sys/fs/cgroup/:/host/sys/fs/cgroup:ro \ +gcr.io/datadoghq/agent:latest +``` + +To enable advanced eBPF metrics, use the following configuration for the required permissions to run eBPF programs: + +```shell +docker run \ +--cgroupns host \ +--pid host \ +--gpus all \ +-e DD_API_KEY="" \ +-e DD_GPU_MONITORING_ENABLED=true \ +-e DD_GPU_ENABLED=true \ +-v /:/host/root:ro \ +-v /var/run/docker.sock:/var/run/docker.sock:ro \ +-v /proc/:/host/proc/:ro \ +-v /sys/fs/cgroup/:/host/sys/fs/cgroup:ro \ +-v /sys/kernel/debug:/sys/kernel/debug \ +-v /lib/modules:/lib/modules:ro \ +-v /usr/src:/usr/src:ro \ +-v /var/tmp/datadog-agent/system-probe/build:/var/tmp/datadog-agent/system-probe/build \ +-v /var/tmp/datadog-agent/system-probe/kernel-headers:/var/tmp/datadog-agent/system-probe/kernel-headers \ +-v /etc/apt:/host/etc/apt:ro \ +-v /etc/yum.repos.d:/host/etc/yum.repos.d:ro \ +-v /etc/zypp:/host/etc/zypp:ro \ +-v /etc/pki:/host/etc/pki:ro \ +-v /etc/yum/vars:/host/etc/yum/vars:ro \ +-v /etc/dnf/vars:/host/etc/dnf/vars:ro \ +-v /etc/rhsm:/host/etc/rhsm:ro \ +-e HOST_ROOT=/host/root \ +--security-opt apparmor:unconfined \ +--cap-add=SYS_ADMIN \ +--cap-add=SYS_RESOURCE \ +--cap-add=SYS_PTRACE \ +--cap-add=IPC_LOCK \ +--cap-add=CHOWN \ +gcr.io/datadoghq/agent:latest +``` + +Replace `` with your [Datadog API key][1]. + +[1]: https://app.datadoghq.com/organization-settings/api-keys + +{{% /tab %}} +{{% tab "Docker Compose" %}} + +If using `docker-compose`, make the following additions to the Datadog Agent service. + +```yaml +version: '3' +services: + datadog: + image: "gcr.io/datadoghq/agent:latest" + environment: + - DD_GPU_ENABLED=true + - DD_API_KEY= + volumes: + - /var/run/docker.sock:/var/run/docker.sock:ro + - /proc/:/host/proc/:ro + - /sys/fs/cgroup/:/host/sys/fs/cgroup:ro + deploy: + resources: + reservations: + devices: + - driver: nvidia + count: all + capabilities: [gpu] +``` + +To enable advanced eBPF metrics, use the following configuration for the required permissions to run eBPF programs: + +```yaml +version: '3' +services: + datadog: + image: "gcr.io/datadoghq/agent:latest" + environment: + - DD_GPU_MONITORING_ENABLED=true # only for advanced eBPF metrics + - DD_GPU_ENABLED=true + - DD_API_KEY= + - HOST_ROOT=/host/root + volumes: + - /var/run/docker.sock:/var/run/docker.sock:ro + - /proc/:/host/proc/:ro + - /sys/fs/cgroup/:/host/sys/fs/cgroup:ro + - /sys/kernel/debug:/sys/kernel/debug + - /:/host/root + cap_add: + - SYS_ADMIN + - SYS_RESOURCE + - SYS_PTRACE + - IPC_LOCK + - CHOWN + security_opt: + - apparmor:unconfined + deploy: + resources: + reservations: + devices: + - driver: nvidia + count: all + capabilities: [gpu] +``` + +{{% /tab %}} +{{% tab "Linux (non-containerized)" %}} + +Modify your `/etc/datadog-agent/datadog.yaml` file to enable GPU monitoring + +```yaml +gpu: + enabled: true +``` + +To enable advanced eBPF metrics, follow these steps: + +1. If `/etc/datadog-agent/system-probe.yaml` does not exist, create it from `system-probe.yaml.example`: + + ```shell + sudo -u dd-agent install -m 0640 /etc/datadog-agent/system-probe.yaml.example /etc/datadog-agent/system-probe.yaml + ``` + +2. Edit `/etc/datadog-agent/system-probe.yaml` and enable GPU monitoring in system-probe: + + ```yaml + gpu_monitoring: + enabled: true + ``` + +3. Restart the Datadog Agent + + ```shell + sudo systemctl restart datadog-agent + ``` + +{{% /tab %}} + {{< /tabs >}} ## Set up GPU Monitoring on a mixed cluster diff --git a/content/en/infrastructure/containers/amazon_elastic_container_explorer.md b/content/en/infrastructure/containers/amazon_elastic_container_explorer.md index 90efd7a00fb21..7463ecfca06be 100644 --- a/content/en/infrastructure/containers/amazon_elastic_container_explorer.md +++ b/content/en/infrastructure/containers/amazon_elastic_container_explorer.md @@ -1,5 +1,9 @@ --- title: Amazon Elastic Container (ECS) Explorer +further_reading: + - link: "https://www.datadoghq.com/blog/ecs-default-monitors/" + tag: "Blog" + text: "Catch and remediate ECS issues faster with default monitors and the ECS Explorer" --- {{< img src="infrastructure/livecontainers/orch_ecs_ex.png" alt="ECS Explorer displaying ECS tasks." style="width:80%;">}} @@ -186,6 +190,10 @@ Some resources have specific tags. The following tags are available in addition * Installing the Datadog Agent in your cluster enables visibility into task lifecycle changes. Without the Datadog Agent, stopped tasks can appear as running for up to two days. * Installing the Datadog Agent in your cluster provides additional, relevant host-level tags, such as `availability_zone`. +## Further reading + +{{< partial name="whats-next/whats-next.html" >}} + [1]: https://app.datadoghq.com/orchestration/explorer/ecsTask [2]: /integrations/amazon_ecs [3]: /integrations/ecs_fargate diff --git a/content/en/infrastructure/containers/configuration.md b/content/en/infrastructure/containers/configuration.md index a4dfa3fa234da..8c96cac151454 100644 --- a/content/en/infrastructure/containers/configuration.md +++ b/content/en/infrastructure/containers/configuration.md @@ -430,6 +430,7 @@ You can use the `kubernetes_state_core` check to collect custom resource metrics crd_type: "eniconfig" labelsFromPath: crd_name: [metadata, name] + metricNamePrefix: "userPrefix" metrics: - name: "eniconfig" help: "ENI Config" @@ -455,8 +456,16 @@ You can use the `kubernetes_state_core` check to collect custom resource metrics path: [metadata, generation] ``` + By default, RBAC and API resource names are derived from the kind in groupVersionKind by converting it to lowercase, and adding an "s" suffix (for example, Kind: ENIConfig → eniconfigs). If the Custom Resource Definition (CRD) uses a different plural form, you can override this behavior by specifying the resource field. In the example above, CNINode overrides the default by setting resource: "cninode-pluralized". + + Metric names are produced using the following rules: + + a. No prefix precified: `kubernetes_state_customresource.` + + b. Prefix precified: `kubernetes_state_customresource._` + For more details, see [Custom Resource State Metrics][5]. - + 2. Update your Helm or Datadog Operator configuration: {{< tabs >}} @@ -483,6 +492,10 @@ You can use the `kubernetes_state_core` check to collect custom resource metrics {{% /tab %}} {{% tab "Datadog Operator" %}} +
+ This functionality requires Agent Operator v1.20+. +
+ 1. Install the Datadog Operator with an option that grants the Datadog Agent permission to collect custom resources: ``` @@ -514,7 +527,7 @@ You can use the `kubernetes_state_core` check to collect custom resource metrics {{% /tab %}} {{< /tabs >}} - + ## Further reading {{< partial name="whats-next/whats-next.html" >}} diff --git a/content/en/infrastructure/resource_catalog/policies/_index.md b/content/en/infrastructure/resource_catalog/policies/_index.md index e99d1f42aa6d7..901b8f4c8103f 100644 --- a/content/en/infrastructure/resource_catalog/policies/_index.md +++ b/content/en/infrastructure/resource_catalog/policies/_index.md @@ -15,7 +15,7 @@ further_reading: text: "Proactively enforce infrastructure best practices with Datadog Resource Policies" --- -{{< site-region region="gov" >}}
Resource Catalog is not available for the selected Datadog site ({{< region-param key="dd_site_name" >}}).
+{{< site-region region="gov" >}}
Resource Catalog Policies is not available for the selected Datadog site ({{< region-param key="dd_site_name" >}}).
{{< /site-region >}} {{< callout url="https://www.datadoghq.com/product-preview/infra-governance-policies/" btn_hidden="false" header="Join the Preview!">}} diff --git a/content/en/integrations/_index.md b/content/en/integrations/_index.md index 4f497b59c75c4..7f8335e09e849 100644 --- a/content/en/integrations/_index.md +++ b/content/en/integrations/_index.md @@ -15,6 +15,8 @@ aliases: - /integrations/perimeterx/ - /integrations/open-policy-agent/ - /integrations/open_policy_agent/ + - /integrations/coreos/ + - /integrations/ubuntu/ description: Gather data from all of your systems, apps, & services algolia: tags: ['integration', 'integration setup'] diff --git a/content/en/integrations/guide/azure-advanced-configuration.md b/content/en/integrations/guide/azure-advanced-configuration.md index 1791f09f5e538..ed177a38c246b 100644 --- a/content/en/integrations/guide/azure-advanced-configuration.md +++ b/content/en/integrations/guide/azure-advanced-configuration.md @@ -299,6 +299,34 @@ Turning on Diagnostics allows ARM deployed VMs to collect logging information wh {{< img src="integrations/guide/azure_troubleshooting/azure_enable_diagnostics.png" alt="azure diagnostics settings overview displayed with No storage account highlighted under Pick a storage account and enable guest level monitoring enabled" style="width:70%">}} +## Discrepancy between your data in Azure and Datadog + +Datadog's Azure integration collects all metrics from [Azure Monitor][14]. Metrics are collected with all available dimensions (which are mapped to tags in Datadog), the highest time granularity, and the primary aggregation type. + +The sections below describe two important distinctions to be aware of, as well as steps to [reconcile the discrepancy](#reconcile-the-discrepancy). + +### 1. Time aggregation + +Datadog displays raw data from Azure in per-second values, regardless of the time frame selected in Azure. That can make Datadog's value appear lower than the value Azure displays. See [Time aggregation][15] in the metric documentation for more information. + +### 2. Space aggregation + +[Space aggregation][20] in Datadog corresponds to the [primary aggregation type][17] of the metric in Azure Monitor. You can find the primary aggregation type from Azure's [Metric Definitions - List][16] API, in the field `primaryAggregationType`. + +### Reconcile the discrepancy + +1. Graph the metric in [Azure Monitor Metrics Explorer][18], or by going to the resource in Azure and clicking **Monitoring** and then **Metrics** in the left panel. +2. Graph the metric in the [Datadog Metrics Explorer][19]. +3. Confirm that the query in Azure is scoped identically to the query in Datadog: + - Any dimensions used in the Azure metric query should match tags used in the Datadog metric query + - The primary aggregation type used in the query should match the Datadog [space aggregator][19] + - The time frame should match the time frame in the Datadog Metric Explorer +4. Hover over a datapoint on the graph to display the timestamp and value. + +{{< img src="integrations/guide/azure_advanced_configuration/azure_metric_explorer.png" alt="The Azure Metrics Explorer with the cursor hovering over a point in the graph, and the metric value and timestamp highlighted" >}} + +5. Find the same point in time in the Datadog graph and compare the values. If the values are equal, the original discrepancy was due to differences in either time or space aggregation between the two graphs. + ## Automated log collection ### Naming conflicts @@ -393,3 +421,10 @@ The `azure.*.count` metric should show in Datadog within 5 - 10 minutes. [11]: /integrations/azure_arc/ [12]: https://learn.microsoft.com/cli/azure/connectedmachine/extension [13]: /logs/guide/azure-event-hub-log-forwarding/ +[14]: https://learn.microsoft.com/azure/azure-monitor/reference/metrics-index +[15]: /metrics/#time-aggregation +[16]: https://learn.microsoft.com/rest/api/monitor/metric-definitions/list?view=rest-monitor-2023-10-01 +[17]: https://learn.microsoft.com/azure/azure-monitor/metrics/metrics-aggregation-explained#aggregation-types +[18]: https://portal.azure.com/#view/Microsoft_Azure_Monitoring/AzureMonitoringBrowseBlade/~/metrics +[19]: https://app.datadoghq.com/metric/explorer +[20]: /metrics/#space-aggregation diff --git a/content/en/llm_observability/evaluations/_index.md b/content/en/llm_observability/evaluations/_index.md index dbff8921a6c04..2961f1ebac0eb 100644 --- a/content/en/llm_observability/evaluations/_index.md +++ b/content/en/llm_observability/evaluations/_index.md @@ -8,7 +8,7 @@ aliases: ## Overview -LLM Observability offers several ways to support evaluations. They can be configured by navigating to [**AI Observability > Settings > Evaluations**][8]. +LLM Observability offers several ways to support evaluations. They can be configured by navigating to [**AI Observability > Evaluations**][8]. ### Custom LLM-as-a-judge evaluations @@ -47,4 +47,4 @@ In addition to evaluating the input and output of LLM requests, agents, workflow [5]: /llm_observability/evaluations/submit_nemo_evaluations [6]: /security/sensitive_data_scanner/ [7]: /account_management/rbac/permissions/#llm-observability -[8]: https://app.datadoghq.com/llm/settings/evaluations +[8]: https://app.datadoghq.com/llm/evaluations diff --git a/content/en/llm_observability/evaluations/custom_llm_as_a_judge_evaluations.md b/content/en/llm_observability/evaluations/custom_llm_as_a_judge_evaluations.md index d68df6960bee8..bb88f9776fca3 100644 --- a/content/en/llm_observability/evaluations/custom_llm_as_a_judge_evaluations.md +++ b/content/en/llm_observability/evaluations/custom_llm_as_a_judge_evaluations.md @@ -30,7 +30,7 @@ Learn more about the [compatibility requirements][6]. ### Configure the prompt 1. In Datadog, navigate to the LLM Observability [Evaluations page][1]. Select **Create Evaluation**, then select **Create your own**. - {{< img src="llm_observability/evaluations/custom_llm_judge_1.png" alt="The LLM Observability Evaluations page with the Create Evaluation side panel opened. The first item, 'Create your own,' is selected. " style="width:100%;" >}} + {{< img src="llm_observability/evaluations/custom_llm_judge_1-2.png" alt="The LLM Observability Evaluations page with the Create Evaluation side panel opened. The first item, 'Create your own,' is selected. " style="width:100%;" >}} 2. Provide a clear, descriptive **evaluation name** (for example, `factuality-check` or `tone-eval`). You can use this name when querying evaluation results. The name must be unique within your application. @@ -234,7 +234,9 @@ Refine your prompt and schema until outputs are consistent and interpretable. ## Viewing and using results -After you save your evaluation, Datadog automatically runs your evaluation on targeted spans. Results are available across LLM Observability in near-real-time. You can find your custom LLM-as-a-judge results for a specific span in the **Evaluations** tab, alongside other evaluations. +After you **Save and Publish** your evaluation, Datadog automatically runs your evaluation on targeted spans. Alternatively, you can **Save as Draft** and edit or enable your evaluation later. + +Results are available across LLM Observability in near-real-time for published evaluations. You can find your custom LLM-as-a-judge results for a specific span in the **Evaluations** tab, alongside other evaluations. {{< img src="llm_observability/evaluations/custom_llm_judge_3-2.png" alt="The Evaluations tab of a trace, displaying custom evaluation results alongside managed evaluations." style="width:100%;" >}} @@ -274,7 +276,7 @@ You can: {{< partial name="whats-next/whats-next.html" >}} -[1]: https://app.datadoghq.com/llm/settings/evaluations +[1]: https://app.datadoghq.com/llm/evaluations [2]: /llm_observability/evaluations/managed_evaluations#connect-your-llm-provider-account [3]: /service_management/events/explorer/facets/ [4]: /monitors/ diff --git a/content/en/llm_observability/evaluations/managed_evaluations/_index.md b/content/en/llm_observability/evaluations/managed_evaluations/_index.md index 8f4ce8dba4bab..87f693a121e56 100644 --- a/content/en/llm_observability/evaluations/managed_evaluations/_index.md +++ b/content/en/llm_observability/evaluations/managed_evaluations/_index.md @@ -17,7 +17,7 @@ aliases: ## Overview -Managed evaluations are built-in tools to assess your LLM application on dimensions like quality, security, and safety. By enabling them, you can assess the effectiveness of your application's responses, including detection of negative sentiment, topic relevancy, toxicity, failure to answer and hallucination. +Managed evaluations are built-in tools to assess your LLM application on dimensions like quality, security, and safety. By creating them, you can assess the effectiveness of your application's responses, including detection of sentiment, topic relevancy, toxicity, failure to answer, and hallucination. LLM Observability associates evaluations with individual spans so you can view the inputs and outputs that led to a specific evaluation. @@ -98,7 +98,7 @@ If your LLM provider restricts IP addresses, you can obtain the required IP rang ## Create new evaluations -1. Navigate to [**AI Observability > Settings > Evaluations**][2]. +1. Navigate to [**AI Observability > Evaluations**][2]. 1. Click on the **Create Evaluation** button on the top right corner. 1. Select a specific managed evaluation. This will open the evalution editor window. 1. Select the LLM application(s) you want to configure your evaluation for. @@ -109,14 +109,12 @@ If your LLM provider restricts IP addresses, you can obtain the required IP rang - (Optional) Select what percentage of spans you would like this evaluation to run on by configuring the **sampling percentage**. This number must be greater than `0` and less than or equal to `100` (sampling all spans). 1. (Optional) Configure evaluation options by selecting what subcategories should be flagged. Only available on some evaluations. -After you click **Save**, LLM Observability uses the LLM account you connected to power the evaluation you enabled. +After you click **Save and Publish**, LLM Observability uses the LLM account you connected to power the evaluation you enabled. Alternatively, you can **Save as Draft** and edit or enable them later. ## Edit existing evaluations -1. Navigate to [**AI Observability > Settings > Evaluations**][2]. -1. Find on the evaluation you want to edit and toggle the **Enabled Applications** button. -1. Select the edit icon to configure the evaluation for an individual LLM application or click on the application name. -1. Evaluations can be disabled by selecting the disable icon for an individual LLM application. +1. Navigate to [**AI Observability > Evaluations**][2]. +1. Hover over the evaluation you want to edit and click the **Edit** button. ### Estimated token usage @@ -335,7 +333,7 @@ This check ensures that sensitive information is handled appropriately and secur {{< partial name="whats-next/whats-next.html" >}} -[2]: https://app.datadoghq.com/llm/settings/evaluations +[2]: https://app.datadoghq.com/llm/evaluations [3]: https://app.datadoghq.com/llm/applications [4]: /security/sensitive_data_scanner/ [5]: https://docs.datadoghq.com/api/latest/ip-ranges/ diff --git a/content/en/llm_observability/instrumentation/api.md b/content/en/llm_observability/instrumentation/api.md index 467e216c2216a..4b04af0725f7a 100644 --- a/content/en/llm_observability/instrumentation/api.md +++ b/content/en/llm_observability/instrumentation/api.md @@ -167,6 +167,8 @@ If the request is successful, the API responds with a 202 network code and an em | id | string | The id of this document. | #### Prompt +{{< tabs >}} +{{% tab "Model" %}} | Field | Type | Description | |----------------------|--------|--------------------------| | id | string | Logical identifier for this prompt template. Should be unique per `ml_app`. | @@ -178,6 +180,30 @@ If the request is successful, the API responds with a 202 network code and an em | context_variable_keys | [string] | Variable keys that contain ground-truth or context content. Used for hallucination detection. | | tags | Dict[key (string), string] | Tags to attach to the prompt run. | +**Note**: LLM Observability registers new versions of templates when the `template` or `chat_template` value is updated. If the input is expected to change between invocations, extract the dynamic parts into a variable. + +{{% /tab %}} +{{% tab "Example" %}} +{{< code-block lang="json" >}} +{ + "id": "translation-prompt", + "chat_template": [ + { + "role": "system", + "content": "You are a translation service. You translate to {{language}}." + }, { + "role": "user", + "content": "{{user_input}}" + } + ], + "variables": { + "language": "french", + "user_input": "" + } +} +{{< /code-block >}} +{{% /tab %}} +{{< /tabs >}} #### Meta | Field | Type | Description | diff --git a/content/en/llm_observability/instrumentation/sdk.md b/content/en/llm_observability/instrumentation/sdk.md index c550b7e712bb8..1029dafec0c99 100644 --- a/content/en/llm_observability/instrumentation/sdk.md +++ b/content/en/llm_observability/instrumentation/sdk.md @@ -1834,9 +1834,7 @@ function ragWorkflow(userQuestion) { {{< /tabs >}} ## Prompt tracking -{{< callout url="#" btn_hidden="true" >}} - Prompt Tracking for LLM Observability is in Preview. For access, contact Datadog Support. -{{< /callout >}} + Attach structured prompt metadata to the LLM span so you can reproduce results, audit changes, and compare prompt performance across versions. When using templates, LLM Observability also provides [version tracking](#version-tracking) based on template content changes. {{< tabs >}} @@ -2081,7 +2079,7 @@ def llm_call(): return completion {{< /code-block >}} -[1]: https://app.datadoghq.com/llm/settings/evaluations +[1]: https://app.datadoghq.com/llm/evaluations {{% /tab %}} diff --git a/content/en/llm_observability/monitoring/prompt_tracking.md b/content/en/llm_observability/monitoring/prompt_tracking.md index c8b6d2f2f8c4c..91b0febc66c3f 100644 --- a/content/en/llm_observability/monitoring/prompt_tracking.md +++ b/content/en/llm_observability/monitoring/prompt_tracking.md @@ -1,13 +1,8 @@ --- title: Prompt Tracking description: Use Prompt Tracking to track your prompt templates and versions. -private: true --- -{{< callout url="#" btn_hidden="true" >}} - Prompt Tracking for LLM Observability is in Preview. For access, contact Datadog Support. -{{< /callout >}} - In Datadog's LLM Observability, the _Prompt Tracking_ feature links prompt templates and versions to LLM calls. Prompt Tracking works alongside LLM Observability's traces, spans, and Playground. Prompt Tracking enables you to: diff --git a/content/en/logs/guide/docker-logs-collection-troubleshooting-guide.md b/content/en/logs/guide/docker-logs-collection-troubleshooting-guide.md index c2ce3943766da..79caf00606368 100644 --- a/content/en/logs/guide/docker-logs-collection-troubleshooting-guide.md +++ b/content/en/logs/guide/docker-logs-collection-troubleshooting-guide.md @@ -134,30 +134,6 @@ If the Logs Agent status looks like the example in [Check the Agent status](#che * The required port (10516) for sending logs to Datadog is being blocked. * Your container is using a different logging driver than the Agent expects. -#### Outbound traffic on port 10516 is blocked - -The Datadog Agent sends its logs to Datadog over TCP using port 10516. If that connection is not available, logs fail to be sent and an error is recorded in the `agent.log` file to that effect. - -You can manually test your connection using OpenSSL, GnuTLS, or another SSL/TLS client. For OpenSSL, run the following command: - -```shell -openssl s_client -connect intake.logs.datadoghq.com:10516 -``` - -For GnuTLS, run the following command: - -```shell -gnutls-cli intake.logs.datadoghq.com:10516 -``` - -And then by sending a log like the following: - -```text - this is a test message -``` - -If opening the port 10516 is not an option, it is possible to configure the Datadog Agent to send logs through HTTPS by setting the `DD_LOGS_CONFIG_FORCE_USE_HTTP` environment variable to `true`: - #### Your containers are not using the JSON logging driver Docker's default is the json-file logging driver so the Container Agent tries to read from this first. If your containers are set to use a different logging driver, the Logs Agent indicates that it is able to successfully find your containers but it isn't able to collect their logs. The Container Agent can also be configured to read from the journald logging driver. diff --git a/content/en/logs/guide/log-collection-troubleshooting-guide.md b/content/en/logs/guide/log-collection-troubleshooting-guide.md index 8f40bcaa06ee0..2962aaf414807 100644 --- a/content/en/logs/guide/log-collection-troubleshooting-guide.md +++ b/content/en/logs/guide/log-collection-troubleshooting-guide.md @@ -23,37 +23,6 @@ There are a number of common issues that can get in the way when [sending new lo Changes in the configuration of the `datadog-agent` won't be taken into account until you have [restarted the Agent][3]. -## Outbound traffic on port 10516 is blocked - -The Datadog Agent sends its logs to Datadog over TCP using port 10516. If that connection is not available, logs fail to be sent and an error is recorded in the `agent.log` file to that effect. - -You can manually test your connection using OpenSSL, GnuTLS, or another SSL/TLS client. For OpenSSL, run the following command: - -```shell -openssl s_client -connect intake.logs.datadoghq.com:10516 -``` - -For GnuTLS, run the following command: - -```shell -gnutls-cli intake.logs.datadoghq.com:10516 -``` - -And then by sending a log like the following: - -```text - this is a test message -``` - -- If opening the port 10516 is not an option, it is possible to configure the Datadog Agent to send logs through HTTPS by adding the following in `datadog.yaml`: - -```yaml -logs_config: - force_use_http: true -``` - -See the [HTTPS log forwarding section][4] for more information. - ## Check the status of the Agent Often, checking the [Agent status command][5] results will help you troubleshoot what is happening. diff --git a/content/en/logs/log_collection/_index.md b/content/en/logs/log_collection/_index.md index 9bb083cb6cf7a..858406c3e6fa7 100644 --- a/content/en/logs/log_collection/_index.md +++ b/content/en/logs/log_collection/_index.md @@ -154,11 +154,6 @@ Use the [site][13] selector dropdown on the right side of the page to see suppor | US | HTTPS | `agent-http-intake.logs.datadoghq.com` | 443 | Used by the Agent to send logs in JSON format over HTTPS. See the [Host Agent Log collection documentation][2]. | | US | HTTPS | `lambda-http-intake.logs.datadoghq.com` | 443 | Used by Lambda functions to send logs in raw, Syslog, or JSON format over HTTPS. | | US | HTTPS | `logs.`{{< region-param key="browser_sdk_endpoint_domain" code="true" >}} | 443 | Used by the Browser SDK to send logs in JSON format over HTTPS. | -| US | TCP | `agent-intake.logs.datadoghq.com` | 10514 | Used by the Agent to send logs without TLS. -| US | TCP and TLS | `agent-intake.logs.datadoghq.com` | 10516 | Used by the Agent to send logs with TLS. -| US | TCP and TLS | `intake.logs.datadoghq.com` | 443 | Used by custom forwarders to send logs in raw, Syslog, or JSON format over an SSL-encrypted TCP connection. | -| US | TCP and TLS | `functions-intake.logs.datadoghq.com` | 443 | Used by Azure functions to send logs in raw, Syslog, or JSON format over an SSL-encrypted TCP connection. **Note**: This endpoint may be useful with other cloud providers. | -| US | TCP and TLS | `lambda-intake.logs.datadoghq.com` | 443 | Used by Lambda functions to send logs in raw, Syslog, or JSON format over an SSL-encrypted TCP connection. | [1]: /api/latest/logs/#send-logs [2]: /agent/logs/#send-logs-over-https @@ -172,9 +167,6 @@ Use the [site][13] selector dropdown on the right side of the page to see suppor | EU | HTTPS | `agent-http-intake.logs.datadoghq.eu` | 443 | Used by the Agent to send logs in JSON format over HTTPS. See the [Host Agent Log collection documentation][2]. | | EU | HTTPS | `lambda-http-intake.logs.datadoghq.eu` | 443 | Used by Lambda functions to send logs in raw, Syslog, or JSON format over HTTPS. | | EU | HTTPS | `logs.`{{< region-param key="browser_sdk_endpoint_domain" code="true" >}} | 443 | Used by the Browser SDK to send logs in JSON format over HTTPS. | -| EU | TCP and TLS | `agent-intake.logs.datadoghq.eu` | 443 | Used by the Agent to send logs in protobuf format over an SSL-encrypted TCP connection. | -| EU | TCP and TLS | `functions-intake.logs.datadoghq.eu` | 443 | Used by Azure functions to send logs in raw, Syslog, or JSON format over an SSL-encrypted TCP connection. **Note**: This endpoint may be useful with other cloud providers. | -| EU | TCP and TLS | `lambda-intake.logs.datadoghq.eu` | 443 | Used by Lambda functions to send logs in raw, Syslog, or JSON format over an SSL-encrypted TCP connection. | [1]: /api/latest/logs/#send-logs [2]: /agent/logs/#send-logs-over-https @@ -252,95 +244,9 @@ Use the [site][13] selector dropdown on the right side of the page to see suppor ### Custom log forwarding -Any custom process or logging library able to forward logs through **TCP** or **HTTP** can be used in conjunction with Datadog Logs. - -{{< tabs >}} -{{% tab "HTTP" %}} - -You can send logs to Datadog platform over HTTP. Refer to the [Datadog Log HTTP API documentation][1] to get started. - -[1]: /api/latest/logs/#send-logs -{{% /tab %}} -{{% tab "TCP" %}} - -{{< site-region region="us" >}} - -You can manually test your connection using OpenSSL, GnuTLS, or another SSL/TLS client. For GnuTLS, run the following command: - -```shell -gnutls-cli intake.logs.datadoghq.com:10516 -``` - -For OpenSSL, run the following command: - -```shell -openssl s_client -connect intake.logs.datadoghq.com:10516 -``` - -You must prefix the log entry with your [Datadog API Key][1] and add a payload. - -``` - Log sent directly using TLS -``` - -Your payload, or `Log sent directly using TLS` as written in the example, can be in raw, Syslog, or JSON format. If your payload is in JSON format, Datadog automatically parses its attributes. - -```text - {"message":"json formatted log", "ddtags":"env:my-env,user:my-user", "ddsource":"my-integration", "hostname":"my-hostname", "service":"my-service"} -``` - -[1]: /account_management/api-app-keys/#api-keys - -{{< /site-region >}} - -{{< site-region region="eu" >}} - -You can manually test your connection using OpenSSL, GnuTLS, or another SSL/TLS client. For GnuTLS, run the following command: - -```shell -gnutls-cli tcp-intake.logs.datadoghq.eu:443 -``` - -For OpenSSL, run the following command: - -```shell -openssl s_client -connect tcp-intake.logs.datadoghq.eu:443 -``` - -You must prefix the log entry with your [Datadog API Key][1] and add a payload. +Any custom process or logging library able to forward logs through **HTTP** can be used in conjunction with Datadog Logs. -``` - Log sent directly using TLS -``` - -Your payload, or `Log sent directly using TLS` as written in the example, can be in raw, Syslog, or JSON format. If your payload is in JSON format, Datadog automatically parses its attributes. - -```text - {"message":"json formatted log", "ddtags":"env:my-env,user:my-user", "ddsource":"my-integration", "hostname":"my-hostname", "service":"my-service"} -``` - -[1]: /account_management/api-app-keys/#api-keys - -{{< /site-region >}} - -{{< site-region region="us3" >}} -The TCP endpoint is not recommended for this site. Contact [support][1] for more information. - -[1]: /help -{{< /site-region >}} - -{{< site-region region="gov,us5,ap1,ap2" >}} - -The TCP endpoint is not supported for this site. - -[1]: /help -{{< /site-region >}} - - -[1]: https://app.datadoghq.com/organization-settings/api-keys -[2]: https://app.datadoghq.com/logs/livetail -{{% /tab %}} -{{< /tabs >}} +You can send logs to Datadog platform over HTTP. Refer to the [Datadog Log HTTP API documentation][15] to get started. **Notes**: @@ -357,6 +263,24 @@ Log events that do not comply with these limits might be transformed or truncate There is an additional truncation in fields that applies only to indexed logs: the value is truncated to 75 KiB for the message field and 25 KiB for non-message fields. Datadog still stores the full text, and it remains visible in regular list queries in the Logs Explorer. However, the truncated version will be displayed when performing a grouped query, such as when grouping logs by that truncated field or performing similar operations that display that specific field. +{{% collapse-content title="TCP" level="h3" expanded=false %}} + +{{% logs-tcp-disclaimer %}} + + +| Site | Type | Endpoint | Port | Description | +|------|-------------|---------------------------------------------------------------------------|--------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| US | TCP | `agent-intake.logs.datadoghq.com` | 10514 | Used by the Agent to send logs without TLS. +| US | TCP and TLS | `agent-intake.logs.datadoghq.com` | 10516 | Used by the Agent to send logs with TLS. +| US | TCP and TLS | `intake.logs.datadoghq.com` | 443 | Used by custom forwarders to send logs in raw, Syslog, or JSON format over an SSL-encrypted TCP connection. | +| US | TCP and TLS | `functions-intake.logs.datadoghq.com` | 443 | Used by Azure functions to send logs in raw, Syslog, or JSON format over an SSL-encrypted TCP connection. **Note**: This endpoint may be useful with other cloud providers. | +| US | TCP and TLS | `lambda-intake.logs.datadoghq.com` | 443 | Used by Lambda functions to send logs in raw, Syslog, or JSON format over an SSL-encrypted TCP connection. | +| EU | TCP and TLS | `agent-intake.logs.datadoghq.eu` | 443 | Used by the Agent to send logs in protobuf format over an SSL-encrypted TCP connection. | +| EU | TCP and TLS | `functions-intake.logs.datadoghq.eu` | 443 | Used by Azure functions to send logs in raw, Syslog, or JSON format over an SSL-encrypted TCP connection. **Note**: This endpoint may be useful with other cloud providers. | +| EU | TCP and TLS | `lambda-intake.logs.datadoghq.eu` | 443 | Used by Lambda functions to send logs in raw, Syslog, or JSON format over an SSL-encrypted TCP connection. | + +{{% /collapse-content %}} + ### Attributes and tags Attributes prescribe [logs facets][9], which are used for filtering and searching in Log Explorer. See the dedicated [attributes and aliasing][10] documentation for a list of reserved and standard attributes and to learn how to support a naming convention with logs attributes and aliasing. @@ -407,3 +331,5 @@ Once logs are collected and ingested, they are available in **Log Explorer**. Lo [12]: /logs/explore/ [13]: /getting_started/site/ [14]: /logs/log_configuration/pipelines/?tab=date#date-attribute +[15]: /api/latest/logs/#send-logs + diff --git a/content/en/logs/log_collection/csharp.md b/content/en/logs/log_collection/csharp.md index 5536bf2481683..784e07797ff68 100644 --- a/content/en/logs/log_collection/csharp.md +++ b/content/en/logs/log_collection/csharp.md @@ -494,58 +494,6 @@ using (var log = new LoggerConfiguration() } ``` -{{< site-region region="us" >}} - -You can also override the default behavior and forward logs in TCP by manually specifying the following required properties: `url`, `port`, `useSSL`, and `useTCP`. Optionally, [specify the `source`, `service`, `host`, and custom tags.][1] - -For instance to forward logs to the Datadog US region in TCP you would use the following sink configuration: - -```csharp -var config = new DatadogConfiguration(url: "intake.logs.datadoghq.com", port: 10516, useSSL: true, useTCP: true); -using (var log = new LoggerConfiguration() - .WriteTo.DatadogLogs( - "", - source: "", - service: "", - host: "", - tags: new string[] {":", ":"}, - configuration: config - ) - .CreateLogger()) -{ - // Some code -} -``` - -[1]: /logs/log_configuration/attributes_naming_convention/#reserved-attributes - -{{< /site-region >}} -{{< site-region region="eu" >}} - -You can also override the default behavior and forward logs in TCP by manually specifying the following required properties: `url`, `port`, `useSSL`, and `useTCP`. Optionally, [specify the `source`, `service`, `host`, and custom tags.][1] - -For instance to forward logs to the Datadog EU region in TCP you would use the following sink configuration: - -```csharp -var config = new DatadogConfiguration(url: "tcp-intake.logs.datadoghq.eu", port: 443, useSSL: true, useTCP: true); -using (var log = new LoggerConfiguration() - .WriteTo.DatadogLogs( - "", - source: "", - service: "", - host: "", - tags: new string[] {":", ":"}, - configuration: config - ) - .CreateLogger()) -{ - // Some code -} -``` -[1]: /logs/log_configuration/attributes_naming_convention/#reserved-attributes - -{{< /site-region >}} - New logs are now directly sent to Datadog. ## Further Reading diff --git a/content/en/logs/log_configuration/parsing.md b/content/en/logs/log_configuration/parsing.md index 85b8bcf98b7be..307fc8905dadc 100644 --- a/content/en/logs/log_configuration/parsing.md +++ b/content/en/logs/log_configuration/parsing.md @@ -399,7 +399,7 @@ The date matcher transforms your timestamp in the EPOCH format (unit of measure The supported format for timezones are: * `GMT`, `UTC`, `UT` or `Z` -* `+h`, `+hh`, `+hh:mm`, `-hh:mm`, `+hhmm`, `-hhmm`, `+hh:mm:ss`, `-hh:mm:ss`, `+hhmmss` or `-hhmmss` . The maximum supported range is from +18:00 to -18:00 inclusive. +* `+hh:mm`, `-hh:mm`, `+hhmm`, `-hhmm`. The maximum supported range is from +18:00 to -18:00 inclusive. * Timezones starting with `UTC+`, `UTC-`, `GMT+`, `GMT-`, `UT+` or `UT-`. The maximum supported range is from +18:00 to -18:00 inclusive. * Timezone IDs pulled from the TZ database. For more information, see [TZ database names][2]. diff --git a/content/en/monitors/_index.md b/content/en/monitors/_index.md index e086759f451d3..bf83898fab966 100644 --- a/content/en/monitors/_index.md +++ b/content/en/monitors/_index.md @@ -23,6 +23,9 @@ further_reading: - link: "https://www.datadoghq.com/blog/monitor-notification-rules/" tag: "Blog" text: "Route your monitor alerts with Datadog monitor notification rules" + - link: "https://www.datadoghq.com/blog/ecs-default-monitors/" + tag: "Blog" + text: "Catch and remediate ECS issues faster with default monitors and the ECS Explorer" cascade: algolia: rank: 70 @@ -72,7 +75,7 @@ Monitors and alerts are essential tools for ensuring the reliability, performanc 1. [Investigate alerts through the status page.][6] 1. [Resolve misconfigured monitors on the Monitor Quality page.][7] -## Further Reading +## Further reading {{< partial name="whats-next/whats-next.html" >}} diff --git a/content/en/network_monitoring/devices/troubleshooting.md b/content/en/network_monitoring/devices/troubleshooting.md index 04e8612d3061c..7e78e540c890d 100644 --- a/content/en/network_monitoring/devices/troubleshooting.md +++ b/content/en/network_monitoring/devices/troubleshooting.md @@ -59,26 +59,54 @@ The output should look similar to the following: - Run an `snmp walk` on the device's admin IP to determine why the Agent cannot connect to your device. - **Note**: Provide your credentials directly in the CLI. If credentials aren't provided, the Agent attempts to locate them in your running Agent configuration files. - - **Linux**:
- SNMP v2: - ``` - sudo -u dd-agent datadog-agent snmp walk -C - ``` - SNMP v3: - ``` - sudo -u dd-agent datadog-agent snmp walk -A -a -X -x - ``` - **Windows**: - ``` - agent snmp walk [:Port] + **Note**: Provide your credentials directly in the CLI. If credentials aren't provided, the Agent attempts to locate them in your running Agent configuration files. + + Refer to your vendor specific documentation for additional information on running these commands. - Example: - agent.exe snmp walk 10.143.50.30 1.3.6 - ``` + {{< tabs >}} + {{% tab "Linux" %}} + + SNMP v2: + + ```shell + sudo -u dd-agent datadog-agent snmp walk -C + ``` - Refer to your vendor specific documentation for additional information on running these commands. + SNMP v3: + + ```shell + sudo -u dd-agent datadog-agent snmp walk -A -a -X -x + ``` + + {{% /tab %}} + {{% tab "Windows" %}} + + Navigate to the Agent installation directory: + + ```shell + cd "c:\Program Files\Datadog\Datadog Agent\bin" + ``` + + Run the SNMP walk command: + + ```shell + agent snmp walk [:Port] + ``` + + Example: + + ```shell + agent.exe snmp walk 10.143.50.30 1.3.6 + ``` + + **Note**: Run this command as administrator from the Agent installation directory to avoid the following error: + + ```shell + Error: unable to read artifact: open C:\ProgramData\Datadog\auth_token: Access is denied. + ``` + + {{% /tab %}} + {{< /tabs >}} ## Troubleshooting SNMP errors @@ -104,7 +132,7 @@ If you see a permission denied error while port binding in agent logs, the port Run `iptables -L OUTPUT` and ensure there is no deny rule: - ``` + ```shell vagrant@agent-dev-ubuntu-22:~$ sudo iptables -L OUTPUT Chain OUTPUT (policy ACCEPT) target prot opt source destination @@ -215,7 +243,7 @@ Check for any rules blocking UDP traffic on your configured ports. For example:` **Solution**: Add a net bind capability to the Agent binary, which allows the Agent to bind to reserved ports: - ``` + ```shell sudo setcap 'cap_net_bind_service=+ep' /opt/datadog-agent/bin/agent/agent ``` diff --git a/content/en/observability_pipelines/destinations/google_pubsub.md b/content/en/observability_pipelines/destinations/google_pubsub.md index f4d2cad1c0f81..c0357b01253be 100644 --- a/content/en/observability_pipelines/destinations/google_pubsub.md +++ b/content/en/observability_pipelines/destinations/google_pubsub.md @@ -114,11 +114,7 @@ Set up the Google Pub/Sub destination and its environment variables when you [se {{< img src="observability_pipelines/destinations/google_pubsub_env_var.png" alt="The install page showing the Google Pub/Sub environment variable field" style="width:70%;" >}} -By default the Worker sends data to the global endpoint: `https://pubsub.googleapis.com`. - -If your Pub/Sub topic is region-specific, configure the Google Pub/Sub alternative endpoint URL with the regional endpoint. See [About Pub/Sub endpoints][5] for more information. - -Stored as the environment variable: `DD_OP_DESTINATION_GCP_PUBSUB_ENDPOINT_URL`. +{{% observability_pipelines/configure_existing_pipelines/destination_env_vars/google_pubsub %}} ## Troubleshooting @@ -163,7 +159,6 @@ A batch of events is flushed when one of these parameters is met. See [event bat [2]: https://cloud.google.com/docs/authentication#auth-flowchart [3]: https://cloud.google.com/pubsub/docs/access-control#roles [4]: https://console.cloud.google.com/iam-admin/serviceaccounts -[5]: https://cloud.google.com/pubsub/docs/reference/service_apis_overview#pubsub_endpoints [6]: /observability_pipelines/destinations/#event-batching [7]:https://cloud.google.com/kubernetes-engine/docs/concepts/workload-identity [8]: /observability_pipelines/monitoring_and_maintenance/pipeline_usage_metrics/ diff --git a/content/en/observability_pipelines/destinations/kafka.md b/content/en/observability_pipelines/destinations/kafka.md index 3109c7f3fe949..25d1392b07a3d 100644 --- a/content/en/observability_pipelines/destinations/kafka.md +++ b/content/en/observability_pipelines/destinations/kafka.md @@ -78,22 +78,7 @@ Click **Advanced** if you want to set any of the following fields: ### Set environment variables -#### Kafka bootstrap servers -- The host and port of the Kafka bootstrap servers. -- This is the bootstrap server that the client uses to connect to the Kafka cluster and discover all the other hosts in the cluster. The host and port must be entered in the format of `host:port`, such as `10.14.22.123:9092`. If there is more than one server, use commas to separate them. -- Stored as the environment variable: `DD_OP_DESTINATION_KAFKA_BOOTSTRAP_SERVERS`. - -#### TLS (when enabled) - -- If TLS is enabled, the Kafka TLS passphrase is needed. -- Stored as the environment variable: `DD_OP_DESTINATION_KAFKA_KEY_PASS`. - -#### SASL (when enabled) - -- Kafka SASL username - - Stored as the environment variable: `DD_OP_DESTINATION_KAFKA_SASL_USERNAME`. -- Kafka SASL password - - Stored as the environment variable: `DD_OP_DESTINATION_KAFKA_SASL_PASSWORD`. +{{% observability_pipelines/configure_existing_pipelines/destination_env_vars/kafka %}} ## librdkafka options diff --git a/content/en/observability_pipelines/guide/environment_variables.md b/content/en/observability_pipelines/guide/environment_variables.md index f81c466ce7552..01e87af347f35 100644 --- a/content/en/observability_pipelines/guide/environment_variables.md +++ b/content/en/observability_pipelines/guide/environment_variables.md @@ -39,6 +39,9 @@ Some Observability Pipelines components require setting up environment variables ### Logstash {{% observability_pipelines/configure_existing_pipelines/source_env_vars/logstash %}} +### OpenTelemetry +{{% observability_pipelines/configure_existing_pipelines/source_env_vars/opentelemetry %}} + ### Socket {{% observability_pipelines/configure_existing_pipelines/source_env_vars/socket %}} @@ -91,6 +94,12 @@ Some Observability Pipelines components require setting up environment variables ### Elasticsearch {{% observability_pipelines/configure_existing_pipelines/destination_env_vars/elasticsearch %}} +### Kafka +{{% observability_pipelines/configure_existing_pipelines/destination_env_vars/kafka %}} + +### Google Pub/Sub +{{% observability_pipelines/configure_existing_pipelines/destination_env_vars/google_pubsub %}} + ### HTTP Client {{% observability_pipelines/configure_existing_pipelines/destination_env_vars/http_client %}} diff --git a/content/en/observability_pipelines/packs/_index.md b/content/en/observability_pipelines/packs/_index.md index 80daf1823149c..cbcada70821a6 100644 --- a/content/en/observability_pipelines/packs/_index.md +++ b/content/en/observability_pipelines/packs/_index.md @@ -9,22 +9,39 @@ cascade: ## Overview -When you set up a pipeline to send logs from a specific source to Observability Pipelines, you might have questions such as: +{{< img src="observability_pipelines/packs/packs.png" alt="The packs section of Observability Pipelines" style="width:100%;" >}} + +When setting up a pipeline to send logs from a specific source to Observability Pipelines, you often need to decide how to process and manage those logs. + +Questions such as the following might come up: - Which logs from this source are important? -- Which logs from this source should be dropped? -- Which logs should be retained? -- Should logs be sampled? -- Should quotas be added? +- Which logs can safely be dropped? +- Should repetitive logs be sampled? +- Which fields should be parsed or formatted for the destination? + +Making these decisions typically requires coordination across multiple teams and detailed knowledge of each log source. + +Observability Pipelines Packs provide predefined configurations to help you make these decisions quickly and consistently. Packs apply Datadog-recommended best practices for specific log sources such as Akamai, AWS CloudTrail, Cloudflare, Fastly, Palo Alto Firewall, and Zscaler. + +### What Packs do + +Each Pack includes source-specific configurations that defines: + +- **Fields that can safely be removed** to reduce payload size +- **Logs that can be dropped**, such as duplicate events or health checks +- **Logs that should be retained or parsed**, such as errors or security detections +- **Formatting and normalization rules** to align logs across different destinations and environments + +By using Packs, you can apply consistent parsing, filtering, and routing logic for each log source without creating configurations manually. -Often, you need to consult with different teams to answer these questions. +### Why use Packs -Use Observability Pipelines Packs to help you set up and optimize Observability Pipelines without extensive manual configuration. Packs contain predefined configurations that are specific to a source and identify: +Packs help teams: -- Log fields that can safely be removed -- Logs that can be dropped, such as duplicated logs -- Logs that need to be parsed -- Logs that need to be formatted for the destination +- **Reduce ingestion volume and costs** by filtering or sampling repetitive, low-value events +- **Maintain consistency** in parsing and field mapping across environments and destinations +- **Accelerate setup** by applying ready-to-use configurations for common sources ## Packs diff --git a/content/en/observability_pipelines/packs/akamai_cdn.md b/content/en/observability_pipelines/packs/akamai_cdn.md index f204ba299e8ad..4e4afd086c967 100644 --- a/content/en/observability_pipelines/packs/akamai_cdn.md +++ b/content/en/observability_pipelines/packs/akamai_cdn.md @@ -5,6 +5,8 @@ description: Learn more about the Akamai CDN pack. ## Overview +{{< img src="observability_pipelines/packs/akamai_cdn.png" alt="The Akamai pack" style="width:25%;" >}} + Akamai logs show client requests and responses at the edge. What this pack does: diff --git a/content/en/observability_pipelines/packs/amazon_cloudfront.md b/content/en/observability_pipelines/packs/amazon_cloudfront.md index 6556aa5f46bfc..e3cfa1fdc8461 100644 --- a/content/en/observability_pipelines/packs/amazon_cloudfront.md +++ b/content/en/observability_pipelines/packs/amazon_cloudfront.md @@ -5,6 +5,8 @@ description: Learn more about the AWS CloudFront pack. ## Overview +{{< img src="observability_pipelines/packs/aws_cloudfront.png" alt="The Amazon CloudFront pack" style="width:25%;" >}} + AWS CloudFront logs show requests, cache use, and edge activity. What this pack does: diff --git a/content/en/observability_pipelines/packs/amazon_vpc_flow_logs.md b/content/en/observability_pipelines/packs/amazon_vpc_flow_logs.md index 3ed6ea95e8bcb..eb48917e810a6 100644 --- a/content/en/observability_pipelines/packs/amazon_vpc_flow_logs.md +++ b/content/en/observability_pipelines/packs/amazon_vpc_flow_logs.md @@ -5,6 +5,8 @@ description: Learn more about the Amazon VPC Flow Logs pack. ## Overview +{{< img src="observability_pipelines/packs/aws_vpc_flow_logs.png" alt="The Amazon VPC Flow Logs pack" style="width:25%;" >}} + Amazon VPC Flow Logs capture network traffic between VPC resources. What this pack does: diff --git a/content/en/observability_pipelines/packs/aws_cloudtrail.md b/content/en/observability_pipelines/packs/aws_cloudtrail.md index 33694f8c4e944..f3011a2a44871 100644 --- a/content/en/observability_pipelines/packs/aws_cloudtrail.md +++ b/content/en/observability_pipelines/packs/aws_cloudtrail.md @@ -5,6 +5,8 @@ description: Learn more about the AWS CloudTrail pack. ## Overview +{{< img src="observability_pipelines/packs/aws_cloudtrail.png" alt="The AWS CloudTrail pack" style="width:25%;" >}} + AWS CloudTrail records API calls and account activity across AWS services. What this pack does: diff --git a/content/en/observability_pipelines/packs/cisco_asa.md b/content/en/observability_pipelines/packs/cisco_asa.md index 5ddb7c602e6a6..c6f7bdae0fd25 100644 --- a/content/en/observability_pipelines/packs/cisco_asa.md +++ b/content/en/observability_pipelines/packs/cisco_asa.md @@ -5,6 +5,8 @@ description: Learn more about the Cisco ASA pack. ## Overview +{{< img src="observability_pipelines/packs/cisco_asa.png" alt="The Cisco ASA pack" style="width:25%;" >}} + Cisco ASA firewall logs capture syslog events for traffic, VPNs, and security alerts. What this pack does: diff --git a/content/en/observability_pipelines/packs/cloudflare.md b/content/en/observability_pipelines/packs/cloudflare.md index b831610aaa0a5..3f0dfa58e1163 100644 --- a/content/en/observability_pipelines/packs/cloudflare.md +++ b/content/en/observability_pipelines/packs/cloudflare.md @@ -5,6 +5,8 @@ description: Learn more about the Cloudflare pack. ## Overview +{{< img src="observability_pipelines/packs/cloudflare.png" alt="The Cloudflare pack" style="width:25%;" >}} + Cloudflare logs show edge traffic, performance, and security. What this pack does: diff --git a/content/en/observability_pipelines/packs/f5.md b/content/en/observability_pipelines/packs/f5.md index b9c621951d4d9..c99ea2e713e7c 100644 --- a/content/en/observability_pipelines/packs/f5.md +++ b/content/en/observability_pipelines/packs/f5.md @@ -5,6 +5,8 @@ description: Learn more about the F5 pack. ## Overview +{{< img src="observability_pipelines/packs/f5.png" alt="The F5 pack" style="width:25%;" >}} + F5 logs capture traffic, security policy, and intrusion events. What this pack does: diff --git a/content/en/observability_pipelines/packs/fastly.md b/content/en/observability_pipelines/packs/fastly.md index dcdaed9a53491..c911a05e7d185 100644 --- a/content/en/observability_pipelines/packs/fastly.md +++ b/content/en/observability_pipelines/packs/fastly.md @@ -5,6 +5,8 @@ description: Learn more about the Fastly pack. ## Overview +{{< img src="observability_pipelines/packs/fastly.png" alt="The Fastly pack" style="width:25%;" >}} + Fastly CDN logs record client requests, cache states, and delivery performance. What this pack does: diff --git a/content/en/observability_pipelines/packs/fortinet_firewall.md b/content/en/observability_pipelines/packs/fortinet_firewall.md index c69279c7fee8c..925b464abb5d4 100644 --- a/content/en/observability_pipelines/packs/fortinet_firewall.md +++ b/content/en/observability_pipelines/packs/fortinet_firewall.md @@ -5,6 +5,8 @@ description: Learn more about the Fortinet Firewall pack. ## Overview +{{< img src="observability_pipelines/packs/fortinet_firewall.png" alt="The Fortinet Firewall pack" style="width:25%;" >}} + Fortinet firewall logs record allowed, denied, and other network traffic. What this pack does: diff --git a/content/en/observability_pipelines/packs/haproxy_ingress.md b/content/en/observability_pipelines/packs/haproxy_ingress.md index acd2c87c6110d..18f4c1c2df42f 100644 --- a/content/en/observability_pipelines/packs/haproxy_ingress.md +++ b/content/en/observability_pipelines/packs/haproxy_ingress.md @@ -5,6 +5,8 @@ description: Learn more about the HAProxy Ingress pack. ## Overview +{{< img src="observability_pipelines/packs/haproxy_ingress.png" alt="The HAProxy Ingress pack" style="width:25%;" >}} + HAProxy Ingress logs record how Kubernetes ingress traffic is routed and served. What this pack does: diff --git a/content/en/observability_pipelines/packs/istio_proxy.md b/content/en/observability_pipelines/packs/istio_proxy.md index 0ebc0945b3232..5fc71e08660f8 100644 --- a/content/en/observability_pipelines/packs/istio_proxy.md +++ b/content/en/observability_pipelines/packs/istio_proxy.md @@ -5,6 +5,8 @@ description: Learn more about the Istio Proxy pack. ## Overview +{{< img src="observability_pipelines/packs/istio_proxy.png" alt="The Istio Proxy pack" style="width:25%;" >}} + Istio Proxy logs capture inbound and outbound traffic handled by Envoy. What this pack does: diff --git a/content/en/observability_pipelines/packs/netskope.md b/content/en/observability_pipelines/packs/netskope.md index 2b8bf99cffc71..c6b54396d504d 100644 --- a/content/en/observability_pipelines/packs/netskope.md +++ b/content/en/observability_pipelines/packs/netskope.md @@ -5,6 +5,8 @@ description: Learn more about the Netskope pack. ## Overview +{{< img src="observability_pipelines/packs/netskope.png" alt="The Netskope pack" style="width:25%;" >}} + Netskope logs capture cloud app use, policies, and security events. What this pack does: diff --git a/content/en/observability_pipelines/packs/nginx.md b/content/en/observability_pipelines/packs/nginx.md index 8a182f62b90a8..565524ba927f3 100644 --- a/content/en/observability_pipelines/packs/nginx.md +++ b/content/en/observability_pipelines/packs/nginx.md @@ -5,6 +5,8 @@ description: Learn more about the NGINX pack. ## Overview +{{< img src="observability_pipelines/packs/nginx.png" alt="The NGINX pack" style="width:25%;" >}} + NGINX logs record client requests, responses, and errors from the web server. What this pack does: diff --git a/content/en/observability_pipelines/packs/okta.md b/content/en/observability_pipelines/packs/okta.md index 800c73f8bffcd..f5f40e3ba3913 100644 --- a/content/en/observability_pipelines/packs/okta.md +++ b/content/en/observability_pipelines/packs/okta.md @@ -5,6 +5,8 @@ description: Learn more about the Okta pack. ## Overview +{{< img src="observability_pipelines/packs/okta.png" alt="The Okta pack" style="width:25%;" >}} + Okta logs show authentication, user activity, and policy events. What this pack does: diff --git a/content/en/observability_pipelines/packs/palo_alto_firewall.md b/content/en/observability_pipelines/packs/palo_alto_firewall.md index 7e5ec3fe3e391..e517412aa6705 100644 --- a/content/en/observability_pipelines/packs/palo_alto_firewall.md +++ b/content/en/observability_pipelines/packs/palo_alto_firewall.md @@ -5,6 +5,8 @@ description: Learn more about the Palo Alto Firewall pack. ## Overview +{{< img src="observability_pipelines/packs/palo_alto_firewall.png" alt="The Palo Alto Firewall pack" style="width:25%;" >}} + Palo Alto firewall logs capture traffic, threat, and system events. What this pack does: diff --git a/content/en/observability_pipelines/packs/windows_xml.md b/content/en/observability_pipelines/packs/windows_xml.md index 2fe40915cf49f..516d72e9c3c8b 100644 --- a/content/en/observability_pipelines/packs/windows_xml.md +++ b/content/en/observability_pipelines/packs/windows_xml.md @@ -5,6 +5,8 @@ description: Learn more about the Windows XML pack. ## Overview +{{< img src="observability_pipelines/packs/windows_xml.png" alt="The Windows XML pack" style="width:25%;" >}} + Windows Event logs capture system, application, and security activity from Windows hosts. What this pack does: diff --git a/content/en/observability_pipelines/packs/zscaler_zia_dns.md b/content/en/observability_pipelines/packs/zscaler_zia_dns.md index 2f9b399d6c847..d1740573eda7f 100644 --- a/content/en/observability_pipelines/packs/zscaler_zia_dns.md +++ b/content/en/observability_pipelines/packs/zscaler_zia_dns.md @@ -5,6 +5,8 @@ description: Learn more about the ZScaler ZIA DNS pack. ## Overview +{{< img src="observability_pipelines/packs/zscaler_dns.png" alt="The ZScaler ZIA DNS pack" style="width:25%;" >}} + ZScaler Internet Access (ZIA) DNS logs capture org-wide DNS activity and policy actions. What this pack does: diff --git a/content/en/observability_pipelines/packs/zscaler_zia_firewall.md b/content/en/observability_pipelines/packs/zscaler_zia_firewall.md index ed3e4ef23a128..cd9bbf21a0121 100644 --- a/content/en/observability_pipelines/packs/zscaler_zia_firewall.md +++ b/content/en/observability_pipelines/packs/zscaler_zia_firewall.md @@ -5,6 +5,8 @@ description: Learn more about the Zscaler ZIA Firewall pack. ## Overview +{{< img src="observability_pipelines/packs/zscaler_firewall.png" alt="The Zscaler ZIA Firewall pack" style="width:25%;" >}} + Zscaler Internet Access (ZIA) Firewall logs show network traffic and security events. What this pack does: diff --git a/content/en/observability_pipelines/packs/zscaler_zia_tunnel.md b/content/en/observability_pipelines/packs/zscaler_zia_tunnel.md index af8b689de3d35..2ce3afdaab13d 100644 --- a/content/en/observability_pipelines/packs/zscaler_zia_tunnel.md +++ b/content/en/observability_pipelines/packs/zscaler_zia_tunnel.md @@ -5,6 +5,8 @@ description: Learn more about the Zscaler ZIA Tunnel pack. ## Overview +{{< img src="observability_pipelines/packs/zscaler_tunnel.png" alt="The Zscaler ZIA Tunnel pack" style="width:25%;" >}} + Zscaler Internet Access (ZIA) Tunnel logs show tunnel health, traffic, and key events. What this pack does: diff --git a/content/en/observability_pipelines/packs/zscaler_zia_web_logs.md b/content/en/observability_pipelines/packs/zscaler_zia_web_logs.md index d26401277e18a..c91b64c553e37 100644 --- a/content/en/observability_pipelines/packs/zscaler_zia_web_logs.md +++ b/content/en/observability_pipelines/packs/zscaler_zia_web_logs.md @@ -5,6 +5,8 @@ description: Learn more about the Zscaler ZIA Web Logs pack. ## Overview +{{< img src="observability_pipelines/packs/zscaler_web_logs.png" alt="The Zscaler ZIA Web Logs pack" style="width:25%;" >}} + Zscaler Internet Access (ZIA) Web Logs capture user web activity and security actions. What this pack does: diff --git a/content/en/observability_pipelines/sources/datadog_agent.md b/content/en/observability_pipelines/sources/datadog_agent.md index d342b16628994..b1b49805d3264 100644 --- a/content/en/observability_pipelines/sources/datadog_agent.md +++ b/content/en/observability_pipelines/sources/datadog_agent.md @@ -5,6 +5,8 @@ disable_toc: false Use Observability Pipelines' Datadog Agent source to receive logs from the Datadog Agent. Select and set up this source when you [set up a pipeline][1]. +**Note**: If you are using the Datadog Distribution of OpenTelemetry (DDOT) Collector, you must [use the OpenTelemetry source to send logs to Observability Pipelines][4]. + ## Prerequisites {{% observability_pipelines/prerequisites/datadog_agent %}} @@ -38,4 +40,5 @@ Use the Agent configuration file or the Agent Helm chart values file to connect [1]: /observability_pipelines/configuration/set_up_pipelines/ [2]: /containers/docker/log/?tab=containerinstallation#linux -[3]: /containers/guide/container-discovery-management/?tab=helm#setting-environment-variables \ No newline at end of file +[3]: /containers/guide/container-discovery-management/?tab=helm#setting-environment-variables +[4]: /observability_pipelines/sources/opentelemetry/#send-logs-from-the-datadog-distribution-of-opentelemetry-collector-to-observability-pipelines \ No newline at end of file diff --git a/content/en/observability_pipelines/sources/opentelemetry.md b/content/en/observability_pipelines/sources/opentelemetry.md index ea4a37ba542b3..037a9b7a1b0d4 100644 --- a/content/en/observability_pipelines/sources/opentelemetry.md +++ b/content/en/observability_pipelines/sources/opentelemetry.md @@ -1,5 +1,5 @@ --- -title: OpenTelemetry +title: OpenTelemetry Source disable_toc: false --- @@ -7,6 +7,10 @@ disable_toc: false Use Observability Pipelines' OpenTelemetry (OTel) source to collect logs from your OTel Collector through HTTP or gRPC. Select and set up this source when you set up a pipeline. The information below is configured in the pipelines UI. +**Notes**: +- If you are using the Datadog Distribution of OpenTelemetry (DDOT) Collector, use the OpenTelemetry source to [send logs to Observability Pipelines](#send-logs-from-the-datadog-distribution-of-opentelemetry-collector-to-observability-pipelines). +- If you are using the Splunk HEC Distribution of the OpenTelemetry Collector, use the [Splunk HEC source][4] to send logs to Observability Pipelines. + ### When to use this source Common scenarios when you might use this source: @@ -32,15 +36,7 @@ Optionally, toggle the switch to enable TLS. If you enable TLS, the following ce {{< img src="observability_pipelines/sources/otel_env_vars.png" alt="The install page showing the OpenTelemetry environment variable field" style="width:75%;" >}} -You must provide both HTTP and gRPC endpoints. Configure your OTLP exporters to point to one of these endpoints. See [Send logs to the Observability Pipelines Worker](#send-logs-to-the-observability-pipelines-worker) for more information. - -- HTTP listener address - - The Observability Pipelines Worker listens to this socket address to receive logs from the OTel collector. - - Stored as the environment variable `DD_OP_SOURCE_OTEL_HTTP_ADDRESS`. - -- gRPC listener address - - The Observability Pipelines Worker listens to this socket address to receive logs from the OTel collector. - - Stored as the environment variable `DD_OP_SOURCE_OTEL_GRPC_ADDRESS`. +{{% observability_pipelines/configure_existing_pipelines/source_env_vars/splunk_hec %}} ## Send logs to the Observability Pipelines Worker @@ -70,9 +66,48 @@ The Worker exposes the gRPC endpoint on port 4318. This is an example of configu Based on these example configurations, these are values you enter for the following environment variables: -- HTTP listener address: `worker:4317` -- gRPC listener address: `worker:4318` +- HTTP listener address: `worker:4318` +- gRPC listener address: `worker:4317` + +## Send logs from the Datadog Distribution of OpenTelemetry Collector to Observability Pipelines + +To send logs from the Datadog Distribution of the OpenTelemetry (DDOT) Collector: +1. Deploy the DDOT Collector using Helm. See [Install the DDOT Collector as a Kubernetes DaemonSet][5] for instructions. +1. [Set up a pipeline][6] on Observability Pipelines using the [OpenTelemetry source](#set-up-the-source-in-the-pipeline-ui). + 1. (Optional) Datadog recommends adding an [Edit Fields processor][7] to the pipeline that appends the field `op_otel_ddot:true`. + 1. When you install the Worker, for the OpenTelemetry source environment variables: + 1. Set your HTTP listener to `0.0.0.0:4318`. + 1. Set your gRPC listener to `0.0.0.0:4317`. + 1. After you install the Worker and deployed the pipeline, update the OpenTelemetry Collector's [`otel-config.yaml`][9] to include an exporter that sends logs to Observability Pipelines. For example: + ``` + exporters: + otlphttp: + endpoint: http://opw-observability-pipelines-worker.default.svc.cluster.local:4318 + ... + service: + pipelines: + logs: + exporters: [otlphttp] + ``` + 1. Redeploy the Datadog Agent with the updated [`otel-config.yaml`][9]. For example, if the Agent is installed in Kubernetes: + ``` + helm upgrade --install datadog-agent datadog/datadog \ + --values ./agent.yaml \ + --set-file datadog.otelCollector.config=./otel-config.yaml + ``` + +**Notes**: +- Because DDOT is sending logs to Observability Pipelines, and not the Datadog Agent, the following settings do not work for sending logs from DDOT to Observability Pipelines: + - `DD_OBSERVABILITY_PIPELINES_WORKER_LOGS_ENABLED` + - `DD_OBSERVABILITY_PIPELINES_WORKER_LOGS_URL` +- Logs sent from DDOT might have nested objects that prevent Datadog from parsing the logs correctly. To resolve this, Datadog recommends using the [Custom Processor][8] to flatten the nested `resource` object. [1]: https://opentelemetry.io/docs/collector/ [2]: /observability_pipelines/sources/ -[3]: /observability_pipelines/configuration/install_the_worker/advanced_worker_configurations/#bootstrap-options \ No newline at end of file +[3]: /observability_pipelines/configuration/install_the_worker/advanced_worker_configurations/#bootstrap-options +[4]: /observability_pipelines/sources/splunk_hec/#send-logs-from-the-splunk-distributor-of-the-opentelemetry-collector-to-observability-pipelines +[5]: /opentelemetry/setup/ddot_collector/install/kubernetes_daemonset/?tab=datadogoperator +[6]: /observability_pipelines/configuration/set_up_pipelines/ +[7]: /observability_pipelines/processors/edit_fields#add-field +[8]: /observability_pipelines/processors/custom_processor +[9]: https://docs.datadoghq.com/opentelemetry/setup/ddot_collector/install/kubernetes_daemonset/?tab=helm#configure-the-opentelemetry-collector \ No newline at end of file diff --git a/content/en/observability_pipelines/sources/socket.md b/content/en/observability_pipelines/sources/socket.md index 6aebc4a4ebb6a..413028dabaf95 100644 --- a/content/en/observability_pipelines/sources/socket.md +++ b/content/en/observability_pipelines/sources/socket.md @@ -15,4 +15,8 @@ Select and set up this source when you [set up a pipeline][1]. The information b {{% observability_pipelines/source_settings/socket %}} +## Set the environment variables + +{{% observability_pipelines/configure_existing_pipelines/source_env_vars/socket %}} + [1]: /observability_pipelines/configuration/set_up_pipelines/ \ No newline at end of file diff --git a/content/en/observability_pipelines/sources/splunk_hec.md b/content/en/observability_pipelines/sources/splunk_hec.md index d14d93da17338..9ef32ba8b937b 100644 --- a/content/en/observability_pipelines/sources/splunk_hec.md +++ b/content/en/observability_pipelines/sources/splunk_hec.md @@ -5,6 +5,8 @@ disable_toc: false Use Observability Pipelines' Splunk HTTP Event Collector (HEC) source to receive logs from your Splunk HEC. Select and set up this source when you [set up a pipeline][1]. +**Note**: Use the Splunk HEC source if you want to [send logs from the Splunk Distribution of the OpenTelemetry Collector to Observability Pipelines](#send-logs-from-the-splunk-distribution-of-the-opentelemetry-collector-to-observability-pipelines). + ## Prerequisites {{% observability_pipelines/prerequisites/splunk_hec %}} @@ -21,4 +23,31 @@ Select and set up this source when you [set up a pipeline][1]. The information b {{% observability_pipelines/log_source_configuration/splunk_hec %}} +## Send logs from the Splunk Distribution of the OpenTelemetry Collector to Observability Pipelines + +To send logs from the Splunk Distribution of the OpenTelemetry Collector: + +1. Install the Splunk OpenTelemetry Collector based on your environment: + - [Kubernetes][2] + - [Linux][3] +1. [Set up a pipeline][4] using the [Splunk HEC source](#set-up-the-source-in-the-pipeline-ui). +1. Configure the Splunk OpenTelemetry Collector: + ```bash + cp /etc/otel/collector/splunk-otel-collector.conf.example etc/otel/collector/splunk-otel-collector.conf + ``` + ```bash + # Splunk HEC endpoint URL, if forwarding to Splunk Observability Cloud + # SPLUNK_HEC_URL=https://ingest.us0.signalfx.com/v1/log + # If you're forwarding to a Splunk Enterprise instance running on example.com, with HEC at port 8088: + SPLUNK_HEC_URL=http://:8088/services/collector + ``` + - `` is the IP or URL of the host (or load balancer) associated with the Observability Pipelines Worker. + - For CloudFormation installs, the `LoadBalancerDNS` CloudFormation output has the correct URL to use. + - For Kubernetes installs, the internal DNS record of the Observability Pipelines Worker service can be used, for example `opw-observability-pipelines-worker.default.svc.cluster.local`. + +**Note**: If you are using a firewall, make sure your firewall allows traffic from the Splunk OpenTelemetry Collector to the Worker. + [1]: /observability_pipelines/configuration/set_up_pipelines/ +[2]: https://help.splunk.com/en/splunk-observability-cloud/manage-data/splunk-distribution-of-the-opentelemetry-collector/get-started-with-the-splunk-distribution-of-the-opentelemetry-collector/collector-for-kubernetes +[3]: https://help.splunk.com/en/splunk-observability-cloud/manage-data/splunk-distribution-of-the-opentelemetry-collector/get-started-with-the-splunk-distribution-of-the-opentelemetry-collector/collector-for-linux +[4]: /observability_pipelines/configuration/set_up_pipelines diff --git a/content/en/opentelemetry/compatibility.md b/content/en/opentelemetry/compatibility.md index 65b4e86b97f6c..d831e20938126 100644 --- a/content/en/opentelemetry/compatibility.md +++ b/content/en/opentelemetry/compatibility.md @@ -33,7 +33,7 @@ The following table shows feature compatibility across different setups: | [Distributed Tracing][27] | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | | [Runtime Metrics][23] | {{< X >}} | {{< X >}}
(Java, .NET, Go only) | {{< X >}}
(Java, .NET, Go only) | {{< X >}}
(Java, .NET, Go only) | | [Span Links][25] | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | -| [Trace Metrics][26] | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}}
({{< tooltip text="Sampled" tooltip="Trace metrics are calculated on the backend based on ingested spans that have passed through sampling, not on 100% of local traces before sampling." >}}) | +| [Trace Metrics][26] | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}}
({{< tooltip text="Sampled" tooltip="Calculated from spans that reach Datadog; reflects any OTel-side sampling you configure." >}}) | | [Database Monitoring][14] (DBM) | {{< X >}} | {{< X >}} | {{< X >}} | | | [Infrastructure Host List][30] | {{< X >}} | {{< X >}} | {{< X >}} | | | [Cloud Network Monitoring][21] (CNM) | {{< X >}} | {{< X >}} | | | @@ -113,4 +113,4 @@ When using Datadog and OpenTelemetry together, Datadog recommends the following [27]: /tracing/trace_collection/ [28]: /opentelemetry/setup/agentless [29]: /opentelemetry/setup/ddot_collector -[30]: /infrastructure/list/ \ No newline at end of file +[30]: /infrastructure/list/ diff --git a/content/en/opentelemetry/setup/ddot_collector/install/kubernetes_daemonset.md b/content/en/opentelemetry/setup/ddot_collector/install/kubernetes_daemonset.md index fbe6313732e0e..72bd1fe8a87f4 100644 --- a/content/en/opentelemetry/setup/ddot_collector/install/kubernetes_daemonset.md +++ b/content/en/opentelemetry/setup/ddot_collector/install/kubernetes_daemonset.md @@ -123,7 +123,7 @@ After deploying the Datadog Operator, create the `DatadogAgent` resource that tr The Datadog Operator automatically binds the OpenTelemetry Collector to ports `4317` (named `otel-grpc`) and `4318` (named `otel-http`) by default. -4. (Optional) Enable additional Datadog features: +3. (Optional) Enable additional Datadog features:
Enabling these features may incur additional charges. Review the pricing page and talk to your Customer Success Manager before proceeding.
diff --git a/content/en/real_user_monitoring/application_monitoring/android/sdk_performance_impact.md b/content/en/real_user_monitoring/application_monitoring/android/sdk_performance_impact.md index 395a2bb9a32aa..f14ce94be5b6b 100644 --- a/content/en/real_user_monitoring/application_monitoring/android/sdk_performance_impact.md +++ b/content/en/real_user_monitoring/application_monitoring/android/sdk_performance_impact.md @@ -18,9 +18,7 @@ When integrating any SDK into your Android application, understanding its perfor ## Performance impact benchmarks -### Android SDK - -To simulate the typical usage of the Datadog SDK, it was integrated into the [Docile-Alligator/Infinity-For-Reddit][5] application and typical user behavior (in other words, scrolling the feed, browsing subreddits) was simulated. +To simulate the typical usage of the Datadog SDK, it was integrated into the [Docile-Alligator/Infinity-For-Reddit][3] application and typical user behavior (in other words, scrolling the feed, browsing subreddits) was simulated. The following SDK modules were added to the application: @@ -44,40 +42,16 @@ Below are the results of the measurements. You can read the following [page][1] for more details about these benchmarks. -### iOS SDK - -To simulate the typical usage of Datadog SDK, it was integrated into the [Beam][6] application and typical user behavior (scrolling the feed, browsing reddits) was simulated. - -The SDK features that were used: -1. Basic RUM instrumentation for tracking views, actions, and resources -2. Logging -3. Tracing - -Below are the results of the measurements. - -| Measurement | with SDK | without SDK | -|-------------------|---------------------------------|-------------| -| Peak CPU Usage | 44% | 40% | -| Peak Memory Usage | 72.4 MB | 67.96 MB | -| App startup time | 0.894 ms | 0.649 ms | -| Bundle size | 23.6 MB | 22.2 MB | -| Network usage | 21.88 KB sent, 1.68 KB received | n/a | - -You can read the following [page][2] for more details about these benchmarks. - ## Continuous benchmarks Datadog has an internal infrastructure of continuous benchmarking. There is an internal set of UI tests that run on a special benchmark application for every change made to the SDK. This way Datadog is able to detect performance regression early to ensure that they are prevented from reaching production releases. -You can find the source code of the benchmark app here: [Android][3], [iOS][4]. +See the [benchmark app source code][2]. ## Further Reading {{< partial name="whats-next/whats-next.html" >}} [1]: https://github.com/DataDog/dd-sdk-android/blob/develop/docs/sdk_performance.md -[2]: https://github.com/DataDog/dd-sdk-ios/blob/develop/docs/sdk_performance.md -[3]: https://github.com/DataDog/dd-sdk-android/tree/develop/sample/benchmark -[4]: https://github.com/DataDog/dd-sdk-ios/tree/develop/BenchmarkTests -[5]: https://github.com/Docile-Alligator/Infinity-For-Reddit -[6]: https://github.com/awkward/beam +[2]: https://github.com/DataDog/dd-sdk-android/tree/develop/sample/benchmark +[3]: https://github.com/Docile-Alligator/Infinity-For-Reddit diff --git a/content/en/real_user_monitoring/application_monitoring/ios/sdk_performance_impact.md b/content/en/real_user_monitoring/application_monitoring/ios/sdk_performance_impact.md new file mode 100644 index 0000000000000..e91f7837f5d0f --- /dev/null +++ b/content/en/real_user_monitoring/application_monitoring/ios/sdk_performance_impact.md @@ -0,0 +1,52 @@ +--- +title: SDK Performance Impact +description: Learn about how the SDK impacts performance of your application. +aliases: + - /real_user_monitoring/mobile_and_tv_monitoring/ios/sdk_performance_impact +further_reading: +- link: https://github.com/DataDog/dd-sdk-ios + tag: "Source Code" + text: dd-sdk-ios Source code +- link: /real_user_monitoring + tag: Documentation + text: Explore Real User Monitoring +--- + +## Overview + +When integrating any SDK into your iOS application, understanding its performance impact is crucial for maintaining a smooth user experience. The Datadog RUM SDK is designed with minimal performance overhead. Use these benchmarks to evaluate whether the SDK fits your app's performance budget and plan your integration accordingly. + +## Performance impact benchmarks + +To simulate the typical usage of Datadog SDK, it was integrated into the [Beam][1] application and typical user behavior (scrolling the feed, browsing subreddits) was simulated. + +The SDK features used: +1. Basic RUM instrumentation for tracking views, actions, and resources +2. Logging +3. Tracing + +Below are the results of the measurements. + +| Measurement | with SDK | without SDK | +|-------------------|---------------------------------|-------------| +| Peak CPU Usage | 44% | 40% | +| Peak Memory Usage | 72.4 MB | 67.96 MB | +| App startup time | 0.894 ms | 0.649 ms | +| Bundle size | 23.6 MB | 22.2 MB | +| Network usage | 21.88 KB sent, 1.68 KB received | n/a | + +See the [SDK performance details on GitHub][2] for more information. + +## Continuous benchmarks + +Datadog has an internal infrastructure of continuous benchmarking. UI tests run automatically on a benchmark application for every SDK change. This enables Datadog to detect performance regressions early to ensure that they are prevented from reaching production releases. + +See the [benchmark app's source code on GitHub][3]. + +## Further Reading + +{{< partial name="whats-next/whats-next.html" >}} + +[1]: https://github.com/awkward/beam +[2]: https://github.com/DataDog/dd-sdk-ios/blob/develop/docs/sdk_performance.md +[3]: https://github.com/DataDog/dd-sdk-ios/tree/develop/BenchmarkTests diff --git a/content/en/real_user_monitoring/application_monitoring/react_native/setup/expo.md b/content/en/real_user_monitoring/application_monitoring/react_native/setup/expo.md index dad76cd0ce6d9..6c8ff733a7026 100644 --- a/content/en/real_user_monitoring/application_monitoring/react_native/setup/expo.md +++ b/content/en/real_user_monitoring/application_monitoring/react_native/setup/expo.md @@ -101,7 +101,7 @@ In this Datadog example project, View Tracking is achieved through `@datadog/mob Add the following code snippet to your initialization file: ```js -import { DdSdkReactNative, DdSdkReactNativeConfiguration } from 'expo-datadog'; +import { DdSdkReactNative, DdSdkReactNativeConfiguration, SdkVerbosity } from 'expo-datadog'; const config = new DdSdkReactNativeConfiguration( '', @@ -319,4 +319,4 @@ config.resourceEventMapper = event => { [8]: https://docs.expo.dev/workflow/customizing/#releasing-apps-with-custom-native-code-to [9]: https://docs.expo.dev/development/getting-started/ [10]: https://www.npmjs.com/package/@datadog/mobile-react-navigation -[11]: https://www.npmjs.com/package/@datadog/mobile-react-native-navigation \ No newline at end of file +[11]: https://www.npmjs.com/package/@datadog/mobile-react-native-navigation diff --git a/content/en/real_user_monitoring/rum_without_limits/retention_filters.md b/content/en/real_user_monitoring/rum_without_limits/retention_filters.md index 87071c3f59ae9..413e3483e8ee7 100644 --- a/content/en/real_user_monitoring/rum_without_limits/retention_filters.md +++ b/content/en/real_user_monitoring/rum_without_limits/retention_filters.md @@ -35,7 +35,7 @@ The logical flow of retention filters is the following: - If an event does not match any filters, or if it matches a filter but the decision is made not to retain the session based on the configured retention rate, future events from the same session will continue to be evaluated. As a result, the session may eventually be retained. - Be cautious when defining filters on event attributes that update over time. For example, a filter retaining sessions with fewer than two errors might mistakenly retain sessions, as error counts update in real-time, and all sessions start at zero. Either use "greater than or equal to" (≥) conditions for fields that update, such as `@session.error.count >= 2`, or ensure the Session and View objects that are mutable are complete before evaluating them against the retention filters, by adding `@session.is_active: false` or `@view.is_active: false`. - Our SDKs batch and compress events before sending them to Datadog, and failed uploads go back at the end of the queue on the device. Therefore, it could happen that event `B` is evaluated before event `A`, but all events are eventually evaluated against the list of retention filters to prevent gaps. - + ## Creating a retention filter @@ -109,6 +109,43 @@ For example, to exclude sessions from South Korea while retaining all other sess **Note**: There is no way to prevent a specific event from being retained. You can use negative queries (for instance, adding `-@error.message:"Script error."` to a retention filter targeting RUM Errors) to minimize the volume of undesired events, but other retention filters may still make a positive retention decision about a session that contains the event you tried to filter out. +## Cross-product retention filters + +When configuring a RUM retention filter, you can enable two cross-product retention filters: one for session replays and one for APM traces. + +- **Session Replay filter**: Retains replays for the specified percentage of sessions retained by the parent RUM retention filter which have an available replay. +- **APM traces filter**: Indexes APM traces for the specified percentage of sessions retained by the parent RUM retention filter which have available traces. + +**Notes**: +- The availability of a session replay or APM traces depends on the initialization parameters `sessionReplaySampleRate` and `traceSampleRate` of the SDK. +- The APM traces filter is only compatible with the following versions of the SDKs: + +- Browser 6.5.0+ +- Android 3.0.0+ +- React Native 3.0.0+ + +### Default 1% retention + +For compatible SDKs (see above), Datadog provides a default RUM retention filter and cross-product retention filter on APM traces that retains 1% of the sessions with available traces and their traces, free of charge. + +This default filter ensures that you always have a baseline of correlated APM data available for your RUM sessions, even before custom cross-product retention filters. + +The cross-product retention filters allow you to optimize the correlation between different products to retain richer telemetry. + +### Example + +Consider a RUM retention filter configured as follows: + +- **RUM retention filter**: 60% - `@type:error` (retention filter retaining 60% of sessions with at least one error) +- **Cross-product retention filter Session Replay**: 50% +- **Cross-product retention filter APM traces**: 25% + +If across the sessions, 30% of them have an available replay and 40% of them have available traces, then the outcome is the following: + +- 60% of sessions with at least one error are retained +- 50% × 30% = 15% of these retained sessions have a replay +- 25% × 40% = 10% of these retained sessions have APM traces + ## Best practices See [Retention Filter Best Practices][4]. diff --git a/content/en/remote_configuration/_index.md b/content/en/remote_configuration/_index.md index e2f3d135de84d..db24df96781e8 100644 --- a/content/en/remote_configuration/_index.md +++ b/content/en/remote_configuration/_index.md @@ -95,6 +95,24 @@ Datadog implements the following safeguards to protect the confidentiality, inte - Only users with the [`api_keys_write`][5] permission are authorized to enable or disable Remote Configuration capability on API keys and use the supported product features. - Your configuration changes submitted through the Datadog UI are signed and validated by the requesting Datadog component, verifying the integrity of the configuration. +### Role-based access + +Enabling Remote Configuration impacts the following products. Each product defines a set of role-based access controls that need to be granted to their users. For general information on access management, see [Access Control][37]. + + Remote Configuration Enabled Product | Role-Based Access Controls | +| --- | --- | +| Fleet Automation | `FLEET_POLICIES_WRITE`
`AGENT_UPGRADE_WRITE`
`FLEET_FLARE`

For more information, see [Fleet Automation][38]. | +| App and API Protection | `APPSEC_ACTIVATION_READ`
`APPSEC_ACTIVATION_WRITE`
`APPSEC_PROTECT_READ`
`APPSEC_PROTECT_WRITE`

For more information, see [Access Control][39]. | +| APM | `APM_SERVICE_INGEST_READ`
`APM_SERVICE_INGEST_WRITE`
`APM_REMOTE_CONFIGURATION_READ`
`APM_REMOTE_CONFIGURATION_WRITE`

For more information, see [Adaptive Sampling][40]. | +| Dynamic Instrumentation | `DEBUGGER_READ`
`DEBUGGER_WRITE`
`DEBUGGER_WRITE_PRE_PROD`
`APM_REMOTE_CONFIGURATION_READ`
`APM_REMOTE_CONFIGURATION_WRITE`

For more information, see [APM][41]. | +| Workload Protection | `SECURITY_MONITORING_CWS_AGENT_RULES_WRITE`
`SECURITY_MONITORING_CWS_AGENT_RULES_READ`
`SECURITY_MONITORING_CWS_AGENT_RULES_ACTIONS`

For more information, see [Security][42]. | +| CSM Side Scanning | `ORG_MANAGEMENT`
`MANAGE_INTEGRATIONS`

For more information, see [Enable Agentless Scanning][43].| +| Observability Pipelines | `OBSERVABILITY_PIPELINES_READ`
`OBSERVABILITY_PIPELINES_WRITE`
`OBSERVABILITY_PIPELINES_DELETE`
`OBSERVABILITY_PIPELINES_DEPLOY`
`OBSERVABILITY_PIPELINES_CAPTURE_WRITE`
`OBSERVABILITY_PIPELINES_CAPTURE_READ`

For more information, see [Observability Pipelines][44]. | +| Private Action Runner | `ON_PREM_RUNNER_WRITE`
`ON_PREM_RUNNER_READ`
`ON_PREM_RUNNER_USE`

For more information, see [App Builder & Workflow Automation][45]. | +| Network Device Monitoring (NDM) | `NDM_DEVICE_PROFILES_VIEW`
`NDM_DEVICE_PROFILES_EDIT` | +| Container Autoscaling | `ORCHESTRATION_AUTOSCALING_MANAGE`
`ORCHESTRATION_WORKLOAD_SCALING_WRITE`
`ORCHESTRATION_WORKLOAD_SCALING_READ` | +| Serverless Lambda Auto-instrumentation | `SERVERLESS_AWS_INSTRUMENTATION_READ`
`SERVERLESS_AWS_INSTRUMENTATION_WRITE`

For more information, see [Serverless][46]. | + ## Enable Remote Configuration In most cases, Remote Configuration is enabled by default for your organization. You can check if Remote Configuration is enabled on your organization from the [Remote Configuration][8] settings page. If you need to enable it: @@ -168,4 +186,14 @@ Instead of disabling Remote Configuration globally, Datadog recommends opting ou [33]: /security/application_security/setup/ [34]: /security/application_security/ [35]: /tracing/trace_pipeline/adaptive_sampling/ -[36]: /tracing/dynamic_instrumentation/#explore-dynamic-instrumentation \ No newline at end of file +[36]: /tracing/dynamic_instrumentation/#explore-dynamic-instrumentation +[37]: /account_management/rbac +[38]: /agent/fleet_automation/#control-access-to-fleet-automation +[39]: /security/access_control/#permissions +[40]: /tracing/trace_pipeline/adaptive_sampling/#permissions +[41]: /account_management/rbac/permissions/#apm +[42]: /account_management/rbac/permissions/#cloud-security-platform +[43]: /security/cloud_security_management/setup/#enable-agentless-scanning +[44]: /account_management/rbac/permissions/#observability-pipelines +[45]: /account_management/rbac/permissions/#app-builder--workflow-automation +[46]: /account_management/rbac/permissions/#serverless \ No newline at end of file diff --git a/content/en/security/code_security/iac_security/_index.md b/content/en/security/code_security/iac_security/_index.md index 123019861c1be..9110822f58955 100644 --- a/content/en/security/code_security/iac_security/_index.md +++ b/content/en/security/code_security/iac_security/_index.md @@ -15,6 +15,9 @@ further_reading: - link: "/security/code_security/iac_security/iac_rules/" tag: "Documentation" text: "IaC Security Rules" + - link: "/pr_gates/" + tag: "Documentation" + text: "PR Gates" --- Datadog Infrastructure as Code (IaC) Security detects misconfigurations in Terraform and Kubernetes configurations before they're deployed. It flags issues such as missing encryption or overly permissive access in files stored in your connected GitHub, GitLab, or Azure DevOps repositories. Supported file types include standalone Terraform files, local modules, and Kubernetes manifests. @@ -31,6 +34,12 @@ IaC Security integrates with your repositories to continuously scan for misconfi When a pull request includes infrastructure-as-code changes, Datadog adds inline comments to flag any violations. Where applicable, it also suggests code fixes that can be applied directly in the pull request. You can also open a new pull request from Datadog to remediate a finding. For more information, see [Pull Request Comments][5]. +### Automatically block risky changes with PR Gates + +Use [PR Gates][11] to enforce security standards on infrastructure-as-code changes before they're merged. Datadog scans the IaC changes in each pull request, identifies any vulnerabilities above your configured severity threshold, and reports a pass or fail status to GitHub or Azure DevOps. + +By default, checks are informational, but you can make them blocking in GitHub or Azure DevOps to prevent merging when critical issues are detected. For setup instructions, see [Set up PR Gate Rules][12]. + ### View and filter findings After setting up IaC Security, each commit to a scanned repository triggers a scan. Findings are summarized on the [Code Security Vulnerabilities][3] page and grouped per repository on the [Code Security Repositories][6] page. @@ -85,4 +94,6 @@ Exclusions are managed through a configuration file or inline comments in your I [7]: /security/code_security/iac_security/exclusions/?tab=yaml [8]: /security/automation_pipelines/mute [9]: https://app.datadoghq.com/integrations/github/ -[10]: /security/automation_pipelines/ \ No newline at end of file +[10]: /security/automation_pipelines/ +[11]: /pr_gates/ +[12]: /pr_gates/setup \ No newline at end of file diff --git a/content/en/security/code_security/secret_scanning/secret_validation.md b/content/en/security/code_security/secret_scanning/secret_validation.md new file mode 100644 index 0000000000000..2e3ebc4913613 --- /dev/null +++ b/content/en/security/code_security/secret_scanning/secret_validation.md @@ -0,0 +1,81 @@ +--- +title: Secret Validation +is_beta: true +algolia: + tags: ['static analysis', 'ci pipeline', 'SAST', 'secret scanning'] +--- +## About validity checks +For certain detections (see the list below), Datadog checks whether a detected secret is valid during scans. For these live validation checks, Datadog makes API requests to provider endpoints to confirm that a credential is active. Datadog only makes requests to endpoints that do not return sensitive data or personally identifiable information (PII), and only to verify if the credential can still access the provider endpoint. + +For secret types with validation available, Datadog displays the validation status in the explorer as "Active" or "Inactive". You can also filter or query detections by their Validation Status. + +For some secret types, Datadog uses static validation methods, such as computing a checksum, to confirm that a detected secret is not a false positive. Static validation results are not displayed and all references to "validation" in the explorer correspond to live validation results. + +## List of supported validators +| Secret type | Static validator available | Live validator available | +|-------------|----------------------------|--------------------------| +|`adobe_access_token`|✓|✓| +|`adobe_refresh_token`|✓|✗| +|`adafruit_io_key`|✗|✓| +|`aiven_personal_token`|✗|✓| +|`anthropic's_claude_api_key`|✗|✓| +|`asana_oauth_token`|✓|✓| +|`asana_personal_access_token`|✗|✓| +|`atlassian_access_token`|✓|✓| +|`atlassian_refresh_token`|✓|✗| +|`aws_access_key_id`|✗|✓| +|`aws_secret_access_key`|✗|✓| +|`azure_container_registry_key`|✓|✗| +|`azure_entra_id_token`|✓|✗| +|`beamer_api_token`|✗|✓| +|`bitbucket_oauth_access_token`|✗|✓| +|`buildkite_access_token`|✗|✓| +|`circleci_personal_access_token`|✗|✓| +|`circleci_project_access_token`|✗|✓| +|`cloudflare_api_token`|✗|✓| +|`cloudflare_origin_ca_key`|✗|✓| +|`contentful_access_token`|✗|✓| +|`datadog_api_key`|✗|✓| +|`datadog_nonce_session_token`|✗|✓| +|`datadog_personal_access_token`|✗|✓| +|`discord_application_oauth_access_token`|✗|✓| +|`discord_application_token`|✗|✓| +|`discord_bot_token`|✗|✓| +|`docker_access_token`|✓|✓| +|`doppler_access_token`|✗|✓| +|`dropbox_access_token`|✗|✓| +|`duffel_test_access_token`|✗|✓| +|`fastly_api_token`|✗|✓| +|`flutterwave_api_secret_key`|✗|✓| +|`frame_io_developer_token`|✗|✓| +|`frame_io_oauth_session_secret`|✗|✓| +|`github_access_token`|✓|✓| +|`github_fine-grained_personal_access_token`|✗|✓| +|`heroku_api_key`|✗|✓| +|`hugging_face_access_token`|✗|✓| +|`intercom_access_token`|✗|✓| +|`launchdarkly_access_token`|✗|✓| +|`lichess_personal_access_token`|✗|✓| +|`non_expired_json_web_token`|✓|✗| +|`notion_integration_token`|✗|✓| +|`npm_access_token`|✓|✓| +|`openai_project_api_key`|✗|✓| +|`openai_user_api_key`|✗|✓| +|`oracle_access_token`|✓|✗| +|`pagerduty_api_token`|✗|✓| +|`perfect_cloud_api_key`|✗|✓| +|`postman_api_key`|✗|✓| +|`pulumi_access_token`|✗|✓| +|`rubygems_api_key`|✗|✓| +|`sendgrid_api_key`|✗|✓| +|`sentry_organization_token`|✗|✓| +|`sentry_personal_token`|✗|✓| +|`shippo_api_key`|✗|✓| +|`shippo_jwt`|✓|✓| +|`slack_access_token`|✗|✓| +|`snowflake_personal_access_token`|✓|✗| +|`square_access_token`|✗|✓| +|`typeform_personal_access_token`|✗|✓| +|`twilio_access_token`|✓|✗| +|`workos_api_key`|✗|✓| +|`xai_(grok)_api_key`|✗|✓| \ No newline at end of file diff --git a/content/en/security/sensitive_data_scanner/setup/telemetry_data.md b/content/en/security/sensitive_data_scanner/setup/telemetry_data.md index 261ba018a1ce0..5375ce4116627 100644 --- a/content/en/security/sensitive_data_scanner/setup/telemetry_data.md +++ b/content/en/security/sensitive_data_scanner/setup/telemetry_data.md @@ -115,6 +115,10 @@ The [recommended keywords][15] are used by default when library rules are added. 1. In the **Type or paste event data to test the rule** section, add event data to evaluate your rule and add keywords to refine match conditions. 1. Click **Update**. +#### Add suppressions + +{{% sds-suppressions %}} + {{% /collapse-content %}} {{% collapse-content title="Add a custom rule" level="p" id="add-custom-rule"%}} You can create custom scanning rules using regex patterns to scan for sensitive data. @@ -123,7 +127,7 @@ You can create custom scanning rules using regex patterns to scan for sensitive 1. Enter a name for the rule. 1. In the **Priority** dropdown menu, select the priority level for the rule based on your business needs. 1. (Optional) Enter a description for the rule. -1. In the **Match conditions** section, specify the regex pattern to use for matching against events in the **Define the regex** field. Enter sample data in the **Add sample data** field to verify that your regex pattern is valid.
+1. In the **Match conditions** section, specify the regex pattern to use for matching against events in the **Regex pattern** field.
Sensitive Data Scanner supports Perl Compatible Regular Expressions (PCRE), but the following patterns are not supported: - Backreferences and capturing sub-expressions (lookarounds) - Arbitrary zero-width assertions @@ -135,14 +139,16 @@ You can create custom scanning rules using regex patterns to scan for sensitive - The `\K` start of match reset directive - Callouts and embedded code - Atomic grouping and possessive quantifiers -1. For **Check for keywords near regex pattern**, add keywords to refine detection accuracy when matching regex conditions. For example, if you are scanning for a sixteen-digit Visa credit card number, you can add keywords like `visa`, `credit`, and `card`. +1. For **Check surrounding match context for keywords to reduce noise**, add keywords to refine detection accuracy when matching regex conditions. For example, if you are scanning for a sixteen-digit Visa credit card number, you can add keywords like `visa`, `credit`, and `card`. - To add keywords, enter a keyword and click the plus icon to add the keyword to the list. - To remove keywords, click the **X** next to the keyword you want to remove. - You can also require that these keywords be within a specified number of characters of a match. By default, keywords must be within 30 characters before a matched value. **Note**: You cannot have more than 20 keywords for a rule. +{{% sds-suppressions %}} 1. In the **Type or paste event data to test the rule** section, add event data to evaluate your rule and add keywords to refine match conditions. {{% sds-scanning-rule %}} 1. Click **Add Rule**. + {{% /collapse-content %}} **Notes**: @@ -257,6 +263,15 @@ The excluded namespaces are: {{% /tab %}} {{% /tabs %}} +#### Suppress specific matches to ignore risk-accepted data + +Use suppressions to ignore sensitive data matches you consider operationally safe (for example: internal email domains or private IP ranges). + +**Notes**: +- Suppressed matches are not redacted, masked, or hashed. +- Suppressed matches are excluded from the Findings page, dashboards, alerts, and other reporting workflows. +- Suppressions are defined per rule within a scanning group. + ### Edit scanning rules To edit scanning rules: diff --git a/content/en/security/workload_protection/_index.md b/content/en/security/workload_protection/_index.md index c7aa9097f2115..b9c13c56c7249 100644 --- a/content/en/security/workload_protection/_index.md +++ b/content/en/security/workload_protection/_index.md @@ -8,6 +8,10 @@ aliases: - /security/threats/security_profiles - /security/threats/runtime_anomaly_detection - /security/threats/ +further_reading: + - link: "https://www.datadoghq.com/blog/workload-protection-investigation/" + tag: "Blog" + text: "Turn fragmented runtime signals into coherent attack stories with Datadog Workload Protection" cascade: - _target: path: /security/workload_protection/agent_expressions @@ -88,6 +92,10 @@ Datadog is introducing a new feature called Active Protection to address the cry {{< nextlink href="/getting_started/cloud_security_management">}}Getting Started with Cloud Security Management{{< /nextlink >}} {{< /whatsnext >}} +## Further reading + +{{< partial name="whats-next/whats-next.html" >}} + [1]: /security/cloud_security_management/setup/ [2]: /agent/ [3]: /security/notifications/ diff --git a/content/en/serverless/azure_app_service/windows_code.md b/content/en/serverless/azure_app_service/windows_code.md index 634643cc24d0f..d1c93538ce13f 100644 --- a/content/en/serverless/azure_app_service/windows_code.md +++ b/content/en/serverless/azure_app_service/windows_code.md @@ -21,7 +21,7 @@ further_reading: ## Overview -The Datadog extension for Azure App Service provides monitoring capabilities in addition to the [Datadog-Azure integration][7], which provides metrics and logs. +The Datadog extension for Azure App Service provides monitoring capabilities in addition to the [Datadog-Azure integration][5], which provides metrics and logs. - Full distributed APM tracing using automatic instrumentation. - Customized APM service and trace views showing relevant Azure App Service metrics and metadata. @@ -48,24 +48,28 @@ The Datadog .NET, Java, and Node.js APM extensions support the following runtime {{< tabs >}} {{% tab ".NET" %}} + Datadog's automatic instrumentation relies on the .NET CLR Profiling API. This API allows only one subscriber (for example, Datadog's .NET Tracer with Profiler enabled). To ensure maximum visibility, run only one APM solution within your application environment. Additionally, if you are using the Azure Native integration, you can use the Datadog resource in Azure to add the extension to your .NET apps. For instructions, see the [App Service extension section][1] of Datadog's [Azure Native integration guide][2]. [1]: /integrations/guide/azure-native-integration/#app-service-extension [2]: /integrations/guide/azure-native-integration/ + {{% /tab %}} {{% tab "Java" %}} Support for Java Web Apps is in Preview for extension v2.4+. There are no billing implications for tracing Java Web Apps during this period. + {{% /tab %}} {{< /tabs >}} ## Installation + Datadog recommends doing regular updates to the latest version of the extension to ensure optimal performance, stability, and availability of features. Note that both the initial install and subsequent updates require your web app to be fully stopped in order to install/update successfully. -If you haven't already, set up the [Datadog-Azure integration][5]. You can verify that your Azure integration is configured correctly by ensuring that you see the `azure.app_services.count` or `azure.functions.count` metrics in Datadog. +If you haven't already, set up the [Datadog-Azure integration][3]. You can verify that your Azure integration is configured correctly by ensuring that you see the `azure.app_services.count` or `azure.functions.count` metrics in Datadog.
This step is critical for metric/trace correlation and functional trace panel views and improves the overall experience of using Datadog with Azure App Services.
@@ -182,7 +186,7 @@ The [Datadog Windows Web App module][2] only deploys the Web App resource and ex {{< img src="infrastructure/serverless/azure_app_services/choose_extension.png" alt="Example of Extensions page in Azure portal, showing .NET Datadog APM extension." style="width:100%;" >}} -6. Accept the legal terms, click **OK**, and wait for the installation to complete. +6. Accept the legal terms, click **OK**, and wait for the installation to complete.
This step requires that your application be in a stopped state.
7. Start the main application, click **Start**: @@ -201,17 +205,17 @@ The [Datadog Windows Web App module][2] only deploys the Web App resource and ex {{% /tab %}} {{< /tabs >}} - ## Custom metrics -The Azure App Service extension includes an instance of [DogStatsD][3], Datadog's metrics aggregation service. This enables you to submit custom metrics, service checks, and events directly to Datadog from Azure Web Apps and Functions with the extension. +The Azure App Service extension includes an instance of [DogStatsD][1], Datadog's metrics aggregation service. This enables you to submit custom metrics, service checks, and events directly to Datadog from Azure Web Apps and Functions with the extension. -Writing custom metrics and checks in Azure App Service is similar to the process for doing so with an application on a host running the Datadog Agent. **Unlike** the [standard DogStatsD config process][3], there is no need to set ports or a server name when initializing the DogStatsD configuration. There are ambient environment variables in Azure App Service that determine how the metrics are sent (requires v6.0.0+ of the DogStatsD client). +Writing custom metrics and checks in Azure App Service is similar to the process for doing so with an application on a host running the Datadog Agent. **Unlike** the [standard DogStatsD config process][1], there is no need to set ports or a server name when initializing the DogStatsD configuration. There are ambient environment variables in Azure App Service that determine how the metrics are sent (requires v6.0.0+ of the DogStatsD client). To submit custom metrics to Datadog from Azure App Service using the extension: {{< tabs >}} {{% tab ".NET" %}} + 1. Add the [DogStatsD NuGet package](https://www.nuget.org/packages/DogStatsD-CSharp-Client) to your Visual Studio project. 2. Initialize DogStatsD and write custom metrics in your application. 3. Deploy your code to Azure App Service. @@ -255,9 +259,10 @@ client.Increment("sample.startup"); {{% /tab %}} {{% tab "Node.js" %}} + 1. [Initialize DogStatsD and write custom metrics][1] in your application. -1. Deploy your code to a supported Azure Web App. -1. If you have not already, install Datadog's Azure App Service Node.js extension. +2. Deploy your code to a supported Azure Web App. +3. If you have not already, install Datadog's Azure App Service Node.js extension.
You do not need to install a Node.js DogStatsD client, as it is included in the Node.js tracer (dd-trace) packaged in the Azure App Service extension.
@@ -282,11 +287,12 @@ tracer.dogstatsd.decrement('example_metric.decrement', 1, { environment: 'dev' } - Set `DD_TRACE_ENABLED` to `false`. - Set `DD_AAS_ENABLE_CUSTOM_METRICS` to `true`. -Learn more about [custom metrics][4]. +Learn more about [custom metrics][2]. ## Logging ### Application logging + {{< tabs >}} {{% tab ".NET" %}} @@ -299,6 +305,7 @@ Both methods allow trace ID injection, making it possible to connect logs and tr [1]: /logs/log_collection/csharp/#agentless-logging-with-apm [2]: /logs/log_collection/csharp/#agentless-logging-with-serilog-sink + {{% /tab %}} {{% tab "Java" %}} @@ -334,6 +341,7 @@ Configure these environment variables in your Azure App Service Application Sett {{< tabs >}} {{% tab ".NET" %}} + **Code Example: Microsoft Native Logging** An example of how to set up logging in a .NET application using Microsoft.Extensions.Logging: @@ -354,12 +362,12 @@ public class WeatherForecastController : ControllerBase public IActionResult Get() { _logger.LogInformation("Processing weather forecast request"); - + // Your business logic here var forecast = GetWeatherForecast(); - + _logger.LogInformation("Weather forecast retrieved for user: {UserId}", userId); - + return Ok(forecast); } } @@ -537,7 +545,7 @@ It is likely that you do not have the Azure integration configured to monitor yo 1. Go to the Azure integration tile. -2. Ensure you have installed the [Azure integration][5] for the Azure subscription where your application is running. +2. Ensure you have installed the [Azure integration][3] for the Azure subscription where your application is running. 3. Ensure that any App Service plan filtering rules you have applied include the App Service plan where the app is running. If an App Service plan is not included, all apps and functions hosted on it are also not included. Tags on the app itself are not used for filtering by Datadog. @@ -551,16 +559,14 @@ It is likely that you do not have the Azure integration configured to monitor yo **Note**: To expedite the process of investigating application errors with the support team, set `DD_TRACE_DEBUG:true` and add the content of the Datadog logs directory (`%AzureAppServiceHomeDirectory%\LogFiles\datadog`) to your email. -Still need help? Contact [Datadog support][6]. +Still need help? Contact [Datadog support][4]. ### Further Reading {{< partial name="whats-next/whats-next.html" >}} [1]: /developers/dogstatsd -[2]: /tracing/setup/dotnet/ -[3]: /developers/dogstatsd -[4]: /metrics/ -[5]: /integrations/azure/ -[6]: /help -[7]: https://app.datadoghq.com/integrations/azure +[2]: /metrics/custom_metrics/ +[3]: /integrations/azure/ +[4]: /help +[5]: https://app.datadoghq.com/integrations/azure diff --git a/content/en/serverless/azure_container_apps/_index.md b/content/en/serverless/azure_container_apps/_index.md index 712093f0dcf88..17e41815a118a 100644 --- a/content/en/serverless/azure_container_apps/_index.md +++ b/content/en/serverless/azure_container_apps/_index.md @@ -44,7 +44,6 @@ To instrument your Azure Container App with Datadog, choose one of two options: | Cost overhead | Less than sidecar (no extra container). | Extra vCPU/memory. Overallocating the sidecar wastes cost; underallocating leads to premature scaling. | | Logging | Direct stdout/stderr access. | Shared volume + log library routing to a log file. Uncaught errors require extra handling, since they are not automatically handled by your logging library. | | Failure isolation | In rare cases, Datadog Agent bugs can affect your app. | Datadog Agent faults are isolated. | -| Observing multiple containers | Not supported | Supported | ## Further reading diff --git a/content/en/serverless/azure_container_apps/in_container/dotnet.md b/content/en/serverless/azure_container_apps/in_container/dotnet.md index 9f78cf50ce793..4c1dbddd13ff1 100644 --- a/content/en/serverless/azure_container_apps/in_container/dotnet.md +++ b/content/en/serverless/azure_container_apps/in_container/dotnet.md @@ -41,7 +41,7 @@ RUN mkdir -p /dd_tracer/dotnet/ && tar -xzvf /tmp/datadog-dotnet-apm.tar.gz -C / 2. **Install serverless-init**. - {{% serverless-init-install cmd="\"dotnet\", \"dotnet.dll\"" %}} + {{% serverless-init-install mode="in-container" cmd="\"dotnet\", \"dotnet.dll\"" %}} 3. **Set up logs**. diff --git a/content/en/serverless/azure_container_apps/in_container/go.md b/content/en/serverless/azure_container_apps/in_container/go.md index 2757929aa48cd..0bb4f0898e307 100644 --- a/content/en/serverless/azure_container_apps/in_container/go.md +++ b/content/en/serverless/azure_container_apps/in_container/go.md @@ -41,7 +41,7 @@ go get github.com/DataDog/dd-trace-go/contrib/net/http/v2 2. **Install serverless-init**. - {{% serverless-init-install cmd="./your-binary" %}} + {{% serverless-init-install mode="in-container" cmd="./your-binary" %}} 3. **Set up logs**. diff --git a/content/en/serverless/azure_container_apps/in_container/java.md b/content/en/serverless/azure_container_apps/in_container/java.md index 72892a3f5ed1d..53101f9fd574f 100644 --- a/content/en/serverless/azure_container_apps/in_container/java.md +++ b/content/en/serverless/azure_container_apps/in_container/java.md @@ -50,7 +50,7 @@ implementation 'com.datadoghq:dd-trace-api:DD_TRACE_JAVA_VERSION_HERE' 2. **Install serverless-init**. - {{% serverless-init-install cmd="\"./mvnw\", \"spring-boot:run\"" %}} + {{% serverless-init-install mode="in-container" cmd="\"./mvnw\", \"spring-boot:run\"" %}} 3. **Set up logs**. diff --git a/content/en/serverless/azure_container_apps/in_container/nodejs.md b/content/en/serverless/azure_container_apps/in_container/nodejs.md index 2b5e1a3a4737b..e66b7aa72783e 100644 --- a/content/en/serverless/azure_container_apps/in_container/nodejs.md +++ b/content/en/serverless/azure_container_apps/in_container/nodejs.md @@ -38,7 +38,7 @@ ENV NODE_OPTIONS="--require dd-trace/init" 2. **Install serverless-init**. - {{% serverless-init-install cmd="\"/nodejs/bin/node\", \"/path/to/your/app.js\"" %}} + {{% serverless-init-install mode="in-container" cmd="\"/nodejs/bin/node\", \"/path/to/your/app.js\"" %}} 3. **Set up logs**. diff --git a/content/en/serverless/azure_container_apps/in_container/php.md b/content/en/serverless/azure_container_apps/in_container/php.md index 684949ed9eb64..a6abea7dfe869 100644 --- a/content/en/serverless/azure_container_apps/in_container/php.md +++ b/content/en/serverless/azure_container_apps/in_container/php.md @@ -33,7 +33,7 @@ apk add libgcc 2. **Install serverless-init**. - {{% serverless-init-install cmd="\"apache2-foreground\"" %}} + {{% serverless-init-install mode="in-container" cmd="\"apache2-foreground\"" %}} 3. **Set up logs**. diff --git a/content/en/serverless/azure_container_apps/in_container/python.md b/content/en/serverless/azure_container_apps/in_container/python.md index 1f42b5555e85e..e7a920cf69175 100644 --- a/content/en/serverless/azure_container_apps/in_container/python.md +++ b/content/en/serverless/azure_container_apps/in_container/python.md @@ -35,7 +35,7 @@ CMD ["ddtrace-run", "python", "app.py"] 2. **Install serverless-init**. - {{% serverless-init-install cmd="\"ddtrace-run\", \"python\", \"path/to/your/python/app.py\"" %}} + {{% serverless-init-install mode="in-container" cmd="\"ddtrace-run\", \"python\", \"path/to/your/python/app.py\"" %}} 3. **Set up logs**. diff --git a/content/en/serverless/azure_container_apps/in_container/ruby.md b/content/en/serverless/azure_container_apps/in_container/ruby.md index f4c15e325f8a8..b1c4d8433ca7a 100644 --- a/content/en/serverless/azure_container_apps/in_container/ruby.md +++ b/content/en/serverless/azure_container_apps/in_container/ruby.md @@ -26,7 +26,7 @@ gem 'datadog' 2. **Install serverless-init**. - {{% serverless-init-install cmd="\"rails\", \"server\", \"-b\", \"0.0.0.0\"" %}} + {{% serverless-init-install mode="in-container" cmd="\"rails\", \"server\", \"-b\", \"0.0.0.0\"" %}} 3. **Set up logs**. diff --git a/content/en/serverless/azure_container_apps/sidecar/dotnet.md b/content/en/serverless/azure_container_apps/sidecar/dotnet.md index a2683190b2a17..d93bf31bb9e08 100644 --- a/content/en/serverless/azure_container_apps/sidecar/dotnet.md +++ b/content/en/serverless/azure_container_apps/sidecar/dotnet.md @@ -42,6 +42,8 @@ RUN mkdir -p /dd_tracer/dotnet/ && tar -xzvf /tmp/datadog-dotnet-apm.tar.gz -C / 2. **Install serverless-init as a sidecar**. + {{% serverless-init-install mode="sidecar" %}} + {{< tabs >}} {{% tab "Terraform" %}} diff --git a/content/en/serverless/azure_container_apps/sidecar/go.md b/content/en/serverless/azure_container_apps/sidecar/go.md index 7f80ded4fc128..a9cdcb98e0eff 100644 --- a/content/en/serverless/azure_container_apps/sidecar/go.md +++ b/content/en/serverless/azure_container_apps/sidecar/go.md @@ -41,6 +41,8 @@ go get github.com/DataDog/dd-trace-go/contrib/net/http/v2 2. **Install serverless-init as a sidecar**. + {{% serverless-init-install mode="sidecar" %}} + {{< tabs >}} {{% tab "Terraform" %}} diff --git a/content/en/serverless/azure_container_apps/sidecar/java.md b/content/en/serverless/azure_container_apps/sidecar/java.md index d61e1adaed06b..c5ced84181bd6 100644 --- a/content/en/serverless/azure_container_apps/sidecar/java.md +++ b/content/en/serverless/azure_container_apps/sidecar/java.md @@ -50,6 +50,8 @@ implementation 'com.datadoghq:dd-trace-api:DD_TRACE_JAVA_VERSION_HERE' 2. **Install serverless-init as a sidecar**. + {{% serverless-init-install mode="sidecar" %}} + {{< tabs >}} {{% tab "Terraform" %}} diff --git a/content/en/serverless/azure_container_apps/sidecar/nodejs.md b/content/en/serverless/azure_container_apps/sidecar/nodejs.md index 4c1d44c81e3eb..f41411a095e15 100644 --- a/content/en/serverless/azure_container_apps/sidecar/nodejs.md +++ b/content/en/serverless/azure_container_apps/sidecar/nodejs.md @@ -38,6 +38,8 @@ ENV NODE_OPTIONS="--require dd-trace/init" 2. **Install serverless-init as a sidecar**. + {{% serverless-init-install mode="sidecar" %}} + {{< tabs >}} {{% tab "Terraform" %}} diff --git a/content/en/serverless/azure_container_apps/sidecar/php.md b/content/en/serverless/azure_container_apps/sidecar/php.md index dbfbcee250766..d8f53d97540b1 100644 --- a/content/en/serverless/azure_container_apps/sidecar/php.md +++ b/content/en/serverless/azure_container_apps/sidecar/php.md @@ -33,6 +33,8 @@ apk add libgcc 2. **Install serverless-init as a sidecar**. + {{% serverless-init-install mode="sidecar" %}} + {{< tabs >}} {{% tab "Terraform" %}} diff --git a/content/en/serverless/azure_container_apps/sidecar/python.md b/content/en/serverless/azure_container_apps/sidecar/python.md index f9d88998a87c7..f8e2b751ce43e 100644 --- a/content/en/serverless/azure_container_apps/sidecar/python.md +++ b/content/en/serverless/azure_container_apps/sidecar/python.md @@ -35,6 +35,8 @@ CMD ["ddtrace-run", "python", "app.py"] 2. **Install serverless-init as a sidecar**. + {{% serverless-init-install mode="sidecar" %}} + {{< tabs >}} {{% tab "Terraform" %}} diff --git a/content/en/serverless/azure_container_apps/sidecar/ruby.md b/content/en/serverless/azure_container_apps/sidecar/ruby.md index 3328dd54f95df..33f26d2dcb274 100644 --- a/content/en/serverless/azure_container_apps/sidecar/ruby.md +++ b/content/en/serverless/azure_container_apps/sidecar/ruby.md @@ -26,6 +26,8 @@ gem 'datadog' 2. **Install serverless-init as a sidecar**. + {{% serverless-init-install mode="sidecar" %}} + {{< tabs >}} {{% tab "Terraform" %}} diff --git a/content/en/serverless/google_cloud_run/containers/_index.md b/content/en/serverless/google_cloud_run/containers/_index.md index 13540995ae6ff..8314b53245089 100644 --- a/content/en/serverless/google_cloud_run/containers/_index.md +++ b/content/en/serverless/google_cloud_run/containers/_index.md @@ -34,7 +34,6 @@ To instrument your Google Cloud Run containers with Datadog, choose one of two o | Cost overhead | Less than sidecar (no extra container). | Extra vCPU/memory. Overallocating the sidecar wastes cost; underallocating leads to premature scaling. | | Logging | Direct stdout/stderr access. | Shared volume + log library routing to a log file. Uncaught errors require extra handling, since they are not automatically handled by your logging library. | | Failure isolation | In rare cases, Datadog Agent bugs can affect your app. | Datadog Agent faults are isolated. | -| Observing multiple containers | Not supported | Supported | ## Further reading diff --git a/content/en/serverless/google_cloud_run/containers/in_container/dotnet.md b/content/en/serverless/google_cloud_run/containers/in_container/dotnet.md index c64ad9cac97cd..bee2c1595eefa 100644 --- a/content/en/serverless/google_cloud_run/containers/in_container/dotnet.md +++ b/content/en/serverless/google_cloud_run/containers/in_container/dotnet.md @@ -45,7 +45,7 @@ RUN mkdir -p /dd_tracer/dotnet/ && tar -xzvf /tmp/datadog-dotnet-apm.tar.gz -C / 2. **Install serverless-init**. - {{% serverless-init-install cmd="\"dotnet\", \"dotnet.dll\"" %}} + {{% serverless-init-install mode="in-container" cmd="\"dotnet\", \"dotnet.dll\"" %}} 3. **Set up logs**. diff --git a/content/en/serverless/google_cloud_run/containers/in_container/go.md b/content/en/serverless/google_cloud_run/containers/in_container/go.md index e7bb3b2d4b49b..eda0a3838b0bc 100644 --- a/content/en/serverless/google_cloud_run/containers/in_container/go.md +++ b/content/en/serverless/google_cloud_run/containers/in_container/go.md @@ -45,7 +45,7 @@ go get github.com/DataDog/dd-trace-go/contrib/net/http/v2 2. **Install serverless-init**. - {{% serverless-init-install cmd="./your-binary" %}} + {{% serverless-init-install mode="in-container" cmd="./your-binary" %}} 3. **Set up logs**. diff --git a/content/en/serverless/google_cloud_run/containers/in_container/java.md b/content/en/serverless/google_cloud_run/containers/in_container/java.md index 023186a79a924..d2f0a01deb419 100644 --- a/content/en/serverless/google_cloud_run/containers/in_container/java.md +++ b/content/en/serverless/google_cloud_run/containers/in_container/java.md @@ -54,7 +54,7 @@ implementation 'com.datadoghq:dd-trace-api:DD_TRACE_JAVA_VERSION_HERE' 2. **Install serverless-init**. - {{% serverless-init-install cmd="\"./mvnw\", \"spring-boot:run\"" %}} + {{% serverless-init-install mode="in-container" cmd="\"./mvnw\", \"spring-boot:run\"" %}} 3. **Set up logs**. diff --git a/content/en/serverless/google_cloud_run/containers/in_container/nodejs.md b/content/en/serverless/google_cloud_run/containers/in_container/nodejs.md index 219e6187174d2..b2533ae36b421 100644 --- a/content/en/serverless/google_cloud_run/containers/in_container/nodejs.md +++ b/content/en/serverless/google_cloud_run/containers/in_container/nodejs.md @@ -42,7 +42,7 @@ ENV NODE_OPTIONS="--require dd-trace/init" 2. **Install serverless-init**. - {{% serverless-init-install cmd="\"/nodejs/bin/node\", \"/path/to/your/app.js\"" %}} + {{% serverless-init-install mode="in-container" cmd="\"/nodejs/bin/node\", \"/path/to/your/app.js\"" %}} 3. **Set up logs**. diff --git a/content/en/serverless/google_cloud_run/containers/in_container/php.md b/content/en/serverless/google_cloud_run/containers/in_container/php.md index 759cb2a9729ce..0fd4a77d85ee2 100644 --- a/content/en/serverless/google_cloud_run/containers/in_container/php.md +++ b/content/en/serverless/google_cloud_run/containers/in_container/php.md @@ -37,7 +37,7 @@ apk add libgcc 2. **Install serverless-init**. - {{% serverless-init-install cmd="\"apache2-foreground\"" %}} + {{% serverless-init-install mode="in-container" cmd="\"apache2-foreground\"" %}} 3. **Set up logs**. diff --git a/content/en/serverless/google_cloud_run/containers/in_container/python.md b/content/en/serverless/google_cloud_run/containers/in_container/python.md index 41ee19ece35c8..4402cd39295eb 100644 --- a/content/en/serverless/google_cloud_run/containers/in_container/python.md +++ b/content/en/serverless/google_cloud_run/containers/in_container/python.md @@ -39,7 +39,7 @@ CMD ["ddtrace-run", "python", "app.py"] 2. **Install serverless-init**. - {{% serverless-init-install cmd="\"ddtrace-run\", \"python\", \"path/to/your/python/app.py\"" %}} + {{% serverless-init-install mode="in-container" cmd="\"ddtrace-run\", \"python\", \"path/to/your/python/app.py\"" %}} 3. **Set up logs**. diff --git a/content/en/serverless/google_cloud_run/containers/in_container/ruby.md b/content/en/serverless/google_cloud_run/containers/in_container/ruby.md index f3332bd0d7823..4ea8fdf27ead1 100644 --- a/content/en/serverless/google_cloud_run/containers/in_container/ruby.md +++ b/content/en/serverless/google_cloud_run/containers/in_container/ruby.md @@ -30,7 +30,7 @@ gem 'datadog' 2. **Install serverless-init**. - {{% serverless-init-install cmd="\"rails\", \"server\", \"-b\", \"0.0.0.0\"" %}} + {{% serverless-init-install mode="in-container" cmd="\"rails\", \"server\", \"-b\", \"0.0.0.0\"" %}} 3. **Set up logs**. diff --git a/content/en/serverless/google_cloud_run/containers/sidecar/dotnet.md b/content/en/serverless/google_cloud_run/containers/sidecar/dotnet.md index c591e0d8c003d..e76cf50e8b86a 100644 --- a/content/en/serverless/google_cloud_run/containers/sidecar/dotnet.md +++ b/content/en/serverless/google_cloud_run/containers/sidecar/dotnet.md @@ -44,6 +44,8 @@ RUN mkdir -p /dd_tracer/dotnet/ && tar -xzvf /tmp/datadog-dotnet-apm.tar.gz -C / 2. **Install serverless-init as a sidecar**. + {{% serverless-init-install mode="sidecar" %}} + {{< tabs >}} {{% tab "Datadog CLI" %}} diff --git a/content/en/serverless/google_cloud_run/containers/sidecar/go.md b/content/en/serverless/google_cloud_run/containers/sidecar/go.md index ec09075925ce3..a426a4277a9e6 100644 --- a/content/en/serverless/google_cloud_run/containers/sidecar/go.md +++ b/content/en/serverless/google_cloud_run/containers/sidecar/go.md @@ -43,6 +43,8 @@ go get github.com/DataDog/dd-trace-go/contrib/net/http/v2 2. **Install serverless-init as a sidecar**. + {{% serverless-init-install mode="sidecar" %}} + {{< tabs >}} {{% tab "Datadog CLI" %}} diff --git a/content/en/serverless/google_cloud_run/containers/sidecar/java.md b/content/en/serverless/google_cloud_run/containers/sidecar/java.md index d9ae285436a94..cf9f1c4d7bca1 100644 --- a/content/en/serverless/google_cloud_run/containers/sidecar/java.md +++ b/content/en/serverless/google_cloud_run/containers/sidecar/java.md @@ -52,6 +52,8 @@ implementation 'com.datadoghq:dd-trace-api:DD_TRACE_JAVA_VERSION_HERE' 2. **Install serverless-init as a sidecar**. + {{% serverless-init-install mode="sidecar" %}} + {{< tabs >}} {{% tab "Datadog CLI" %}} diff --git a/content/en/serverless/google_cloud_run/containers/sidecar/nodejs.md b/content/en/serverless/google_cloud_run/containers/sidecar/nodejs.md index 882729d8aa0e2..310fe4062eefe 100644 --- a/content/en/serverless/google_cloud_run/containers/sidecar/nodejs.md +++ b/content/en/serverless/google_cloud_run/containers/sidecar/nodejs.md @@ -40,6 +40,8 @@ ENV NODE_OPTIONS="--require dd-trace/init" 2. **Install serverless-init as a sidecar**. + {{% serverless-init-install mode="sidecar" %}} + {{< tabs >}} {{% tab "Datadog CLI" %}} diff --git a/content/en/serverless/google_cloud_run/containers/sidecar/php.md b/content/en/serverless/google_cloud_run/containers/sidecar/php.md index cbc7812cdf71d..3bd94a98a8f5a 100644 --- a/content/en/serverless/google_cloud_run/containers/sidecar/php.md +++ b/content/en/serverless/google_cloud_run/containers/sidecar/php.md @@ -35,6 +35,8 @@ apk add libgcc 2. **Install serverless-init as a sidecar**. + {{% serverless-init-install mode="sidecar" %}} + {{< tabs >}} {{% tab "Datadog CLI" %}} diff --git a/content/en/serverless/google_cloud_run/containers/sidecar/python.md b/content/en/serverless/google_cloud_run/containers/sidecar/python.md index 3707a0e77de5e..368880623a5ce 100644 --- a/content/en/serverless/google_cloud_run/containers/sidecar/python.md +++ b/content/en/serverless/google_cloud_run/containers/sidecar/python.md @@ -37,6 +37,8 @@ CMD ["ddtrace-run", "python", "app.py"] 2. **Install serverless-init as a sidecar**. + {{% serverless-init-install mode="sidecar" %}} + {{< tabs >}} {{% tab "Datadog CLI" %}} diff --git a/content/en/serverless/google_cloud_run/containers/sidecar/ruby.md b/content/en/serverless/google_cloud_run/containers/sidecar/ruby.md index dbcc60a349fa5..03da8720bb9e2 100644 --- a/content/en/serverless/google_cloud_run/containers/sidecar/ruby.md +++ b/content/en/serverless/google_cloud_run/containers/sidecar/ruby.md @@ -28,6 +28,8 @@ gem 'datadog' 2. **Install serverless-init as a sidecar**. + {{% serverless-init-install mode="sidecar" %}} + {{< tabs >}} {{% tab "Datadog CLI" %}} diff --git a/content/en/serverless/google_cloud_run/jobs/dotnet.md b/content/en/serverless/google_cloud_run/jobs/dotnet.md index d0a9de2709ef5..324f36d3a83a8 100644 --- a/content/en/serverless/google_cloud_run/jobs/dotnet.md +++ b/content/en/serverless/google_cloud_run/jobs/dotnet.md @@ -50,7 +50,7 @@ RUN mkdir -p /dd_tracer/dotnet/ && tar -xzvf /tmp/datadog-dotnet-apm.tar.gz -C / 2. **Install serverless-init**. - {{% serverless-init-install cmd="\"dotnet\", \"dotnet.dll\"" %}} + {{% serverless-init-install mode="in-container" cmd="\"dotnet\", \"dotnet.dll\"" %}} 3. **Set up logs**. diff --git a/content/en/serverless/google_cloud_run/jobs/go.md b/content/en/serverless/google_cloud_run/jobs/go.md index 0dbf584057a83..437baf994ec81 100644 --- a/content/en/serverless/google_cloud_run/jobs/go.md +++ b/content/en/serverless/google_cloud_run/jobs/go.md @@ -50,7 +50,7 @@ go get github.com/DataDog/dd-trace-go/contrib/net/http/v2 2. **Install serverless-init**. - {{% serverless-init-install cmd="./your-binary" %}} + {{% serverless-init-install mode="in-container" cmd="./your-binary" %}} 3. **Set up logs**. diff --git a/content/en/serverless/google_cloud_run/jobs/java.md b/content/en/serverless/google_cloud_run/jobs/java.md index ed013ac1ed159..3ad6c7c443d86 100644 --- a/content/en/serverless/google_cloud_run/jobs/java.md +++ b/content/en/serverless/google_cloud_run/jobs/java.md @@ -57,7 +57,7 @@ implementation 'com.datadoghq:dd-trace-api:DD_TRACE_JAVA_VERSION_HERE' 2. **Install serverless-init**. - {{% serverless-init-install cmd="\"./mvnw\", \"spring-boot:run\"" %}} + {{% serverless-init-install mode="in-container" cmd="\"./mvnw\", \"spring-boot:run\"" %}} 3. **Set up logs**. diff --git a/content/en/serverless/google_cloud_run/jobs/nodejs.md b/content/en/serverless/google_cloud_run/jobs/nodejs.md index 5a021552d5588..f4418471b4f65 100644 --- a/content/en/serverless/google_cloud_run/jobs/nodejs.md +++ b/content/en/serverless/google_cloud_run/jobs/nodejs.md @@ -47,7 +47,7 @@ ENV NODE_OPTIONS="--require dd-trace/init" 2. **Install serverless-init**. - {{% serverless-init-install cmd="\"/nodejs/bin/node\", \"/path/to/your/app.js\"" %}} + {{% serverless-init-install mode="in-container" cmd="\"/nodejs/bin/node\", \"/path/to/your/app.js\"" %}} 3. **Set up logs**. diff --git a/content/en/serverless/google_cloud_run/jobs/python.md b/content/en/serverless/google_cloud_run/jobs/python.md index 8368922103795..99fb152f184c4 100644 --- a/content/en/serverless/google_cloud_run/jobs/python.md +++ b/content/en/serverless/google_cloud_run/jobs/python.md @@ -44,7 +44,7 @@ CMD ["ddtrace-run", "python", "app.py"] 2. **Install serverless-init**. - {{% serverless-init-install cmd="\"ddtrace-run\", \"python\", \"path/to/your/python/app.py\"" %}} + {{% serverless-init-install mode="in-container" cmd="\"ddtrace-run\", \"python\", \"path/to/your/python/app.py\"" %}} 3. **Set up logs**. diff --git a/content/en/service_management/incident_management/follow-ups.md b/content/en/service_management/incident_management/follow-ups.md new file mode 100644 index 0000000000000..2cdf5691e8aed --- /dev/null +++ b/content/en/service_management/incident_management/follow-ups.md @@ -0,0 +1,77 @@ +--- +title: Incident Follow-ups +description: Manage follow-up tasks defined during your incident response process. +private: true +further_reading: +- link: "/service_management/incident_management/incident_settings" + tag: "Documentation" + text: "Incident Settings" +--- + +## Overview + +Incident follow-ups are tasks to be performed following an incident's resolution. Follow-ups are usually work items intended to improve the reliability of your systems or the effectiveness of your incident response process. + +You can use Datadog Incident Management to define, manage, and track follow-up tasks for your incidents. + +## Create and manage follow-ups + +You can define and modify incident follow-ups at any point during an incident. To manage an incident's follow-ups: + +**From the Web app**: Go to the incident's **Remediation** tab to manage its follow-ups. + +**From Slack**: In the incident channel, run `/datadog followup` to create a follow-up or `/datadog followup list` to manage existing follow-ups. + +## Export follow-ups + +You can use Incident Management to export your follow-ups to either [Case Management][2] or Jira. + +To export follow-ups, you must first go to "Follow-ups" in [Incident Management settings][1] and define an **export template**. An export templates describes one way that Datadog can export and sync a follow-up. + +Two types of export templates are supported: **Case Management** and **Jira**. + +When defining a template of either type, you can configure how Datadog should set the fields on the resulting Datadog case or the Jira issue, using variables provided by the follow-up and its incident. For example: + +* `{{ title }}` represents the incident's title +* `{{ severity }}` represents the incident's severity +* `{{ follow_up_description }}` represents the follow-up's description +* `{{ follow_up_due_date }}` represents the follow-ups due date + +You can also define how status is mapped on each side. Follow-ups have two statuses: **Open** and **Done**. + +After defining an export template, you can configure Incident Management to automatically export all follow-ups using the template. + +### Case Management exports + +When you export your follow-ups to [Case Management][2], you can manage, track, and analyze your follow-ups directly in Datadog. For example, you can: + +* View all of the open follow-up cases assigned to a particular user in Datadog +* Create a Datadog dashboard that shows follow-up cases by team +* Automatically sync these cases to any external application with which Case Management integrates, including Jira and ServiceNow + +When Datadog exports an incident follow-up to Case Management, it creates a case for the follow-up in the project you selected in the export template. + +**Status syncing:** Datadog syncs the status between the follow-up and the case **in both directions**, following the mapping you defined in the export template. + +**Assignee syncing:** Datadog syncs the assignee between the follow-up and the case **in both directions**. Because a case can have only one assignee, only the first assignee of the follow-up is added to it. + + +### Jira exports + +To export follow-ups to Jira, you must first install the Jira integration through the [Jira Integration tile][3]. For more information, see the [Jira integration][4] documentation. + + +When Datadog exports an incident follow-up to Jira, it creates a Jira issue for the follow-up in the project you selected in the export template. + +**Status syncing:** When you close or open a incident follow-up, Datadog automatically syncs the status of connected Jira issue based on the mapping you defined in the export template. **This is a one-way sync.** + +Organizations that need two-way sync should export to a Case Management project that is configured for two-way sync with a Jira project. + +## Further reading + +{{< partial name="whats-next/whats-next.html" >}} + +[1]: /service_management/incident_management/incident_settings +[2]: /service_management/case_management +[3]: https://app.datadoghq.com/integrations/jira +[4]: /integrations/jira/ diff --git a/content/en/synthetics/browser_tests/_index.md b/content/en/synthetics/browser_tests/_index.md index 0239339da4192..bf287562d0680 100644 --- a/content/en/synthetics/browser_tests/_index.md +++ b/content/en/synthetics/browser_tests/_index.md @@ -181,12 +181,18 @@ For more information about using variables in your browser test recording, see [ You can customize alert conditions to define the circumstances under which you want a test to send a notification alert. -{{< img src="synthetics/browser_tests/alerting_rules.png" alt="Browser test alerting rule" style="width:80%" >}} +{{< img src="synthetics/browser_tests/alerting_rules_2.png" alt="Browser test alerting rule" style="width:80%" >}} #### Alerting rule -* An alert is triggered if any assertion fails for `X` minutes from any `n` of `N` locations. This alerting rule allows you to specify for how much time and in how many locations a test needs to fail before triggering the notification. -* Retry `X` times before location is marked as failed. This allows you to define how many consecutive test failures need to happen for a location to be considered as failed. By default, there is a 300ms wait before retrying a test that failed. This interval can be configured with the [API][6]. +An alert is triggered if any assertion fails for `X` minutes from any `n` of `N` locations. This alerting rule allows you to specify for how much time and in how many locations a test needs to fail before triggering the notification. + +An alert is triggered only if these two conditions are true: + +- At least one location was in failure (at least one assertion failed) during the last X minutes; +- At one moment during the last X minutes, at least `N` locations were in failure. + +In case of failure, retry `X` times before location is marked as failed. This allows you to define how many consecutive test failures need to happen for a location to be considered as failed. By default, there is a `300ms` wait before retrying a test that failed. This interval can be configured with the [API][6]. #### Fast retry diff --git a/content/en/tracing/services/renaming_rules.md b/content/en/tracing/services/renaming_rules.md index 07144a267ab0d..a406f9a0cb9e8 100644 --- a/content/en/tracing/services/renaming_rules.md +++ b/content/en/tracing/services/renaming_rules.md @@ -7,9 +7,6 @@ further_reading: text: "Inferred services" --- -{{< callout url="https://www.datadoghq.com/product-preview/renaming-rules-for-inferred-entities" d_target="#signupModal" btn_hidden="false" header="Join the preview for renaming rules for inferred entities!" >}} -{{< /callout >}} - ## Overview In Datadog, you can rename inferred entities, including datastores and queues, to make them easier to identify and manage. Renaming rules let you override the `peer.service` tag on spans with custom names, or generate names dynamically using tags and regular expressions. This functionality applies across all of APM, not only in the [Software Catalog][3]. After a rule is created, the updated names appear consistently in service maps, Trace Explorer, monitors, dashboards, and any other APM view. @@ -27,36 +24,35 @@ You must have the `apm_service_renaming_write` permission to create renaming rul ## Create a renaming rule -### Step 1: Select entities to rename +### Step 1: Select renaming action and entities to target -1. In Datadog, navigate to **APM > Settings > Service Renaming** and click **+ Add Rule**. +1. In Datadog, navigate to **APM > Software Catalog > Manage > Manage Renaming Rules** and click **+ Add Rule**. Alternatively, navigate to **APM > Software Catalog** and click on a service to open the service side panel. From there, click **Service Page > Service Renaming**. {{< img src="tracing/services/renaming_rules/service-side-panel.png" alt="The side panel for a particular service, showing the Service Page dropdown menu with a Service Renaming option" style="width:100%;" >}} +1. Choose a renaming action you want to perform for your new renaming rule. + 1. You can select to split a single entity, rename an entity, merge multiple entites together, or rename several entities. + 1. Use the search bar to select the entities you want to rename. 1. You can select one or more entities, but all must be of the same type (service, datastore, or queue). - 1. As you select entities, a span query is built in the background. To edit the query, select the code icon to the right of the search bar. + 1. As you select entities, a span query is built in the background. To edit the query, select **Build Advanced Query**. - {{< img src="tracing/services/renaming_rules/create-service-rename-rule-search.png" alt="Step 1 in the Create Service Rename Rule UI, prompting the user to filter and select the entities to rename" style="width:100%;" >}} -### Step 2: Choose a rename method +### Step 2: Specify new entity name 1. In the text box, enter a unique name for the selected entity (or entities). Alternatively, use tag values with the `{{tagName}}` syntax to rename based on an entity's tags. 1. If tag values follow a pattern, apply a regular expression to extract only the portion you want in the name. -{{< img src="tracing/services/renaming_rules/create-service-rename-rule-tags.png" alt="Step 2 in the Create Service Rename Rule UI, prompting the user to choose how to rename the selected entities" style="width:100%;" >}} - ### Step 3: Name your rule and review -1. Enter a descriptive name for the renaming rule so you can identify it later. +1. Optionally, enter a descriptive name for the renaming rule so you can identify it later. 1. Review and save your renaming rule. **Note:** Rules are processed at intake and applied to data as it comes in. Changes affect only spans ingested while a rule is active, and past data is not updated retroactively. Deleting or modifying a rule stops it from applying to new data, but does not revert names on previously ingested data. -{{< img src="tracing/services/renaming_rules/create-service-rename-rule-reviewandsave.png" alt="The final step of the Create Service Rename Rule UI, prompting the user to review and save their renaming rule" style="width:100%;" >}} ## Further reading diff --git a/content/en/tracing/trace_pipeline/trace_retention.md b/content/en/tracing/trace_pipeline/trace_retention.md index ac01f1d47a32d..1a744f45b70a5 100644 --- a/content/en/tracing/trace_pipeline/trace_retention.md +++ b/content/en/tracing/trace_pipeline/trace_retention.md @@ -107,7 +107,9 @@ The set of data captured by diversity sampling is not uniformly sampled (that is #### One percent flat sampling -The flat 1% sampling is a **uniform 1% sample** of [ingested spans][12]. It is applied based on the `trace_id`, meaning that all spans belonging to the same trace share the same sampling decision. +The flat 1% sampling captures: +1. All **traces associated with 1% of ingested RUM sessions** providing a baseline of traces for which sessions are all indexed, improving the [correlation between APM and RUM][20]. The sample is applied based on the `session_id`, meaning that all traces linked to the same RUM session will share a consistent indexing decision. +2. A a **uniform 1% sample** of [ingested spans][12]. It is applied based on the `trace_id`, meaning that all spans belonging to the same trace share the same sampling decision. This sampling mechanism is uniform, and it is proportionally representative of the full ingested traffic. As a result, low-traffic services and endpoints might be missing from that dataset if you filter on a short time frame. @@ -161,7 +163,9 @@ The `retained_by` attribute is present on all retained spans. Its value is: - `retained_by:retention_filter` if the span was captured by a [custom retention filter](#create-your-own-retention-filter), including the [default retention filters](#default-retention-filters) and **no trace rate** was configured. These spans are not included in Trace Queries as trace queries require all spans of a trace to be indexed. - `retained_by:trace_retention_filter` if the span is captured by a retention filter for which a trace rate was configured. - `retained_by:diversity_sampling` if the span was captured by [diversity sampling](#diversity-sampling) (part of the [Intelligent retention filter](#datadog-intelligent-retention-filter)). -- `retained_by:flat_sampled` if the span was indexed by the [1% flat sampling](#one-percent-flat-sampling). +- `retained_by:flat_sampled` if the span was indexed by the [1% flat sampling](#one-percent-flat-sampling). + - `@retention_reason:rum` to traces linked to RUM sessions sampled based on the `session_id`. + - `@retention_reason:apm` for traces sampled uniformly based on the `trace_id`. {{< img src="tracing/trace_indexing_and_ingestion/retention_filters/trace_analytics.png" style="width:100%;" alt="Retained By facet" >}} @@ -192,3 +196,4 @@ Spans indexed by the intelligent retention filter are **excluded** from APM trac [17]: /dynamic_instrumentation/ [18]: https://app.datadoghq.com/apm/traces/retention-filters [19]: /monitors/types/apm/?tab=traceanalytics +[20]: /tracing/other_telemetry/rum/ \ No newline at end of file diff --git a/content/es/account_management/scim/_index.md b/content/es/account_management/scim/_index.md index 7dd922fecf46c..b09c8adf81ce6 100644 --- a/content/es/account_management/scim/_index.md +++ b/content/es/account_management/scim/_index.md @@ -22,7 +22,7 @@ SCIM está disponible con los planes Infrastructure Pro e Infrastructure Enterpr ## Información general -El Sistema de administración de identidades entre dominios, o SCIM, es un estándar abierto que permite automatizar el suministro de usuarios. Con el SCIM, puedes suministrar y quitar automáticamente usuarios en tu organización Datadog, de manera sincronizada con el proveedor de identidad (IdP) de tu organización. +El Sistema para la Gestión de Identidades entre Dominios, o [SCIM][9], es un estándar abierto que permite la automatización del aprovisionamiento de usuarios. Con SCIM, puedes aprovisionar y desaprovisionar usuarios automáticamente en tu organización de Datadog de forma sincronizada con el proveedor de identidades (IdP) de tu organización. ### Funciones compatibles @@ -32,7 +32,9 @@ El Sistema de administración de identidades entre dominios, o SCIM, es un está - Inicio de sesión único en Datadog (recomendado) - Teams gestionados: crea Teams de Datadog a partir de grupos del proveedor de identidades y mantén sincronizada la pertenencia a los Teams de Datadog con la pertenencia a grupos en el proveedor de identidades. -Datadog admite el uso de SCIM con los proveedores de identidad Microsoft Entra ID y Okta. Para configurar SCIM, consulta la documentación de tu IdP: +Datadog implementa el protocolo de servidor de SCIM. Datadog admite el uso de SCIM con los proveedores de identidad de Microsoft Entra ID y Okta. Otros proveedores de identidad pueden funcionar, pero no son explícitamente compatibles. + +Para configurar SCIM para los proveedores de identidad compatibles, consulta la documentación de tu IdP: - [Microsoft Entra ID][2] - [Okta][3] @@ -69,4 +71,5 @@ Al crear un nuevo usuario con SCIM, se le envía un correo electrónico. Para ac [5]: /es/account_management/api-app-keys [6]: /es/account_management/org_settings/service_accounts [7]: https://app.datadoghq.com/organization-settings/users -[8]: /es/help/ \ No newline at end of file +[8]: /es/help/ +[9]: https://scim.cloud/ \ No newline at end of file diff --git a/content/es/actions/app_builder/access_and_auth.md b/content/es/actions/app_builder/access_and_auth.md index 367772ce7609a..285f36cb814a0 100644 --- a/content/es/actions/app_builder/access_and_auth.md +++ b/content/es/actions/app_builder/access_and_auth.md @@ -37,7 +37,7 @@ Cuando ejecutas una aplicación, el usuario de la cuenta de servicio resuelve la 1. Haz clic en el icono de engranaje (**Settings** [ajustes]). 1. Selecciona en **Manage app identity** (Gestionar identidad de la aplicación). -1. Haz clic en tu cuenta de servicio junto a **Run As** (Ejecutar como). +1. Haz clic en tu cuenta de servicio junto a *Run As** (Ejecutar como). #### Eliminar una cuenta de servicio asociada a una aplicación @@ -119,8 +119,11 @@ App Builder proporciona los siguientes permisos para cada aplicación: Viewer (Visor) : Ejecuta y visualiza la aplicación +Colaborador +: Editar, ejecutar y ver la aplicación + Editor -: Edita, ejecuta y visualiza la aplicación +: Editar, ejecutar, visualizar, publicar y eliminar la aplicación Para restringir el acceso a la aplicación, realiza los siguientes pasos en el lienzo de la aplicación: 1. Ve a la vista de edición detallada de la aplicación a la cual quieres restringir el acceso. diff --git a/content/es/agent/guide/environment-variables.md b/content/es/agent/guide/environment-variables.md index 9aeec95dc4386..e24eaa0306d40 100644 --- a/content/es/agent/guide/environment-variables.md +++ b/content/es/agent/guide/environment-variables.md @@ -1,4 +1,7 @@ --- +description: Configura los ajustes de Datadog Agent utilizando variables de entorno + como alternativa a datadog.yaml, incluidas las convenciones de nomenclatura y el + uso de systemd. further_reading: - link: /agent/docker/#environment-variables tag: Documentación @@ -16,7 +19,7 @@ title: Variables de entorno del Agent ---
-En el Agent v5, consulta el repositorio GitHub del Docker Agent. +Para Agent v5, consulta el repositorio de GitHub del Docker Agent.
## Información general @@ -105,7 +108,7 @@ A partir del Agent v7.45, el servicio del Agent de Datadog (unidad`datadog-agent ``` GODEBUG=x509ignoreCN=0,x509sha1=1 DD_HOSTNAME=myhost.local - DD_TAGS=env:dev,service:foo + DD_TAGS=env:dev service:foo ``` 3. Reinicia el servicio para que se apliquen los cambios diff --git a/content/es/agent/troubleshooting/send_a_flare.md b/content/es/agent/troubleshooting/send_a_flare.md index f0db06ca74e05..a55a4aa455e51 100644 --- a/content/es/agent/troubleshooting/send_a_flare.md +++ b/content/es/agent/troubleshooting/send_a_flare.md @@ -30,7 +30,7 @@ Cuando te pongas en contacto con el servicio de asistencia de Datadog con la con ## Enviar un flare desde el sitio de Datadog {{< site-region region="gov" >}} -
El envío de un flare del Agent desde Fleet Automation no es compatible con este sitio.
+
El envío de un Flare del Agent desde Fleet Automation no es compatible con este sitio.
{{< /site-region >}} Para enviar un flare desde el sitio de Datadog, asegúrate de haber habilitado la [automatización de flotas][2] y la [configuración remota][3] en el Agent. @@ -157,5 +157,5 @@ kubectl cp datadog-:tmp/datadog-agent-.zip flare.zi [1]: https://github.com/DataDog/datadog-agent/tree/main/pkg/flare [2]: /es/agent/fleet_automation/ -[3]: /es/agent/remote_config#enabling-remote-configuration +[3]: /es/agent/guide/setup_remote_config [4]: /es/tracing/troubleshooting/tracer_debug_logs/?code-lang=dotnet#data-collected \ No newline at end of file diff --git a/content/es/containers/csi_driver/_index.md b/content/es/containers/csi_driver/_index.md deleted file mode 100644 index 26d262f16f29c..0000000000000 --- a/content/es/containers/csi_driver/_index.md +++ /dev/null @@ -1,297 +0,0 @@ ---- -description: Observabilidad de alto rendimiento para entornos Kubernetes seguros mediante - el controlador CSI de Datadog -further_reading: -- link: https://www.datadoghq.com/blog/datadog-csi-driver/ - tag: Blog - text: Llevar la observabilidad de alto rendimiento a entornos Kubernetes seguros - con el controlador CSI de Datadog -title: Controlador CSI de Datadog ---- - -## Información general - -Esta página proporciona información general sobre el controlador CSI de Datadog e instrucciones de instalación en un clúster Kubernetes - -Para obtener más información sobre Kubernetes Container Storage Interface (CSI), consulta la [documentación sobre Kubernetes CSI][4]. - -El controlador CSI de Datadog es [open source][1]. - -
- El controlador CSI de Datadog no es compatible con Windows. -
- -## Cómo funciona - -El controlador CSI de Datadog es un DaemonSet que ejecuta un servidor gRPC implementando las especificaciones CSI en cada nodo de tu clúster Kubernetes. - -La instalación del controlador CSI de Datadog en un clúster Kubernetes permite utilizar volúmenes CSI especificando el nombre del controlador CSI de Datadog. - -El servidor del nodo CSI de Datadog es responsable de gestionar el ciclo de vida de los volúmenes CSI de Datadog. - -## ¿Por qué utilizar el controlador CSI de Datadog? - -El controlador CSI de Datadog permite al Datadog Agent compartir sockets de dominio Unix de Trace Agent y DogStatsD con pods de usuario independientemente de las [normas de seguridad para pods][4] de los espacios de nombres. - -Si no se utilizan volúmenes CSI, los sockets UDS deben compartirse con el pod de usuario a través de volúmenes hostpath. Si el pod de usuario se está ejecutando en un espacio de nombres que tiene normas de seguridad para pods sin privilegios, el pod falla al iniciarse porque los volúmenes hostpath no están permitidos en ese contexto. - -El controlador CSI de Datadog desplaza el volumen hostpath de la aplicación de usuario al servidor del nodo CSI: el DaemonSet CSI se ejecuta en un espacio de nombres privilegiado independiente y permite inyectar sockets UDS en pods de usuario con un volumen CSI de Datadog, lo que permite que los pods de usuario se ejecuten en espacios de nombres con normas de seguridad para pods `baseline` o `restricted`. - -## Instalación y activación - -
-Notas: -
    -
  • Requiere Helm. -
  • El controlador CSI de Datadog debe ejecutarse con un contexto de seguridad privilegiado. Esto es necesario para que el controlador CSI de Datadog pueda montar volúmenes desde el sistema de archivos host a los pods de usuario. -
-
- -{{< tabs >}} - -{{% tab "Helm" %}} - -Para instalar y activar el controlador CSI de Datadog, configura `datadog.csi.enabled` como `true` en el Helm chart del Datadog Agent. - - ```shell - helm repo add datadog https://helm.datadoghq.com - helm repo update - - helm install datadog-agent datadog/datadog --set datadog.csi.enabled=true - ``` - -{{% /tab %}} - -{{% tab "Datadog Operator" %}} - -Si el Datadog Agent se despliega utilizando el Datadog Operator, debes instalar el Helm chart del controlador CSI de Datadog antes de activar Datadog CSI en el Datadog Agent. - -1. **Añade el repositorio Helm de Datadog CSI.** - - Ejecuta: - ```shell - helm repo add datadog-csi-driver https://helm.datadoghq.com - helm repo update - - ``` - -2. **Instala el Helm chart del controlador CSI de Datadog.** - - Ejecuta: - - ```shell - helm install datadog-csi-driver datadog/datadog-csi-driver - ``` - -3. **Activa Datadog CSI en tu recurso `DatadogAgent`.** - - ``` - apiVersion: datadoghq.com/v2alpha1 - kind: DatadogAgent - metadata: - name: datadog - spec: - global: - credentials: - apiSecret: - secretName: datadog-secret - keyName: api-key - csi: - enabled: true - ``` - -{{% /tab %}} - -{{% tab "DaemonSet" %}} - -Si el Datadog Agent se despliega utilizando el DaemonSet, debes instalar el Helm chart del controlador CSI de Datadog antes de activar el controlador CSI de Datadog en el Datadog Agent. - -1. **Añade el repositorio Helm del controlador CSI de Datadog.** - - Ejecuta: - ```shell - helm repo add datadog-csi-driver https://helm.datadoghq.com - helm repo update - - ``` - -2. **Instala el Helm chart del controlador CSI de Datadog.** - - Ejecuta: - - ```shell - helm install datadog-csi-driver datadog/datadog-csi-driver - ``` - -3. **Activa Datadog CSI**. - - Para activar el controlador CSI de Datadog, configura la siguiente variable de entorno en el contenedor del Datadog Cluster Agent: - - ``` - DD_CSI_DRIVER_ENABLED=true - ``` -{{% /tab %}} - -{{< /tabs >}} - -### Compatibilidad con GKE Autopilot - -A partir del Helm chart versión 3.138.0 del Datadog Agent y del Helm chart versión 0.4.2 del controlador CSI de Datadog, el controlador CSI de Datadog puede instalarse en los clústeres de Google Kubernetes Engine (GKE) Autopilot. - -> **Nota:** -> Si el controlador CSI no se instala utilizando el Helm chart, crea el siguiente recurso `AllowlistSynchronizer` para activar la compatibilidad con GKE Autopilot: - -```yaml -apiVersion: auto.gke.io/v1 -kind: AllowlistSynchronizer -metadata: - name: datadog-csi-synchronizer -spec: - allowlistPaths: - - Datadog/datadog-csi-driver/datadog-datadog-csi-driver-daemonset-exemption-v1.0.1.yaml -``` - -## Volúmenes Datadog CSI - -Los volúmenes CSI procesados por el controlador CSI de Datadog deben tener el siguiente formato: - -```yaml -csi: - driver: k8s.csi.datadoghq.com - volumeAttributes: - type: -name: -``` - -Por ejemplo: - -```yaml -apiVersion: v1 -kind: Pod -metadata: - name: pod-name -spec: - containers: - - name: ubuntu - image: ubuntu - command: ["/bin/bash", "-c", "--"] - args: ["while true; do sleep 30; echo hello-ubuntu; done;"] - volumeMounts: - - mountPath: /var/sockets/apm/ - name: dd-csi-volume-apm-dir - - mountPath: /var/sockets/dsd/dsd.sock - name: dd-csi-volume-dsd - volumes: - - name: dd-csi-volume-dsd - csi: - driver: k8s.csi.datadoghq.com - volumeAttributes: - type: DSDSocket - - name: dd-csi-volume-apm-dir - csi: - driver: k8s.csi.datadoghq.com - volumeAttributes: - type: APMSocketDirectory -``` - -Se admiten cuatro tipos de volumen CSI: -* [APMSocket](#apmsocket) -* [APMSocketDirectory](#apmsocketdirectory) -* [DSDSocket](#dsdsocket) -* [DSDSocketDirectory](#dsdsocketdirectory) - -### APMSocket - -Este tipo es útil para montar un archivo de socket UDS en el Trace Agent. - -Por ejemplo: - -```yaml -csi: - driver: k8s.csi.datadoghq.com - volumeAttributes: - type: APMSocket -name: datadog-apm -``` - -Si el socket indicado no existe, la operación de montaje falla y el pod se bloquea en la fase `ContainerCreating`. - -### APMSocketDirectory - -Este tipo es útil para montar el directorio que contiene el socket APM. - -Por ejemplo: - -```yaml -csi: - driver: k8s.csi.datadoghq.com - readOnly: false - volumeAttributes: - type: APMSocketDirectory -name: datadog -``` - -### DSDSocket - -Este tipo es útil para montar un archivo de socket UDS DogStatsD. - -Por ejemplo: - -```yaml -csi: - driver: k8s.csi.datadoghq.com - volumeAttributes: - type: DSDSocket -name: datadog-dsd -``` - -Si el socket indicado no existe, la operación de montaje falla y el pod se bloquea en la fase `ContainerCreating`. - -### DSDSocketDirectory - -Este tipo es útil para montar el directorio que contiene el socket DogStatsD. - -Por ejemplo: - -```yaml -csi: - driver: k8s.csi.datadoghq.com - readOnly: false - volumeAttributes: - type: DSDSocketDirectory -name: datadog -``` - -
-Con el Datadog Agent v7.67 o posterior, el Admission Controller puede montar automáticamente sockets UDS Datadog en pods mutados configurando el modo de configuración de inyección en csi. Para obtener más información, consulta Admission Controller: Configurar el modo de comunicación de APM y DogStatsD . - -Con la configuración predeterminada del Datadog Agent, el Admission Controller inyecta APMSocketDirectory o DSDSocketDirectory. Si los sockets del Trace Agent y DogStatsD están ambos en el mismo directorio en el host, solo se inyecta un volumen, ya que esto proporciona posteriormente acceso a ambos sockets que comparten el mismo directorio en el host. -
- -## Cuestiones de seguridad - -El controlador CSI de Datadog requiere privilegios elevados y acceso específico al host. - -### Contexto de seguridad privilegiado -El controlador CSI de Datadog debe ejecutarse como contenedor privilegiado para realizar operaciones de montaje y acceder al sistema de archivos del host. - -### Acceso a /var/lib/kubelet/pods -El controlador CSI de Datadog necesita acceso de lectura-escritura al directorio `/var/lib/kubelet/pods`, ya que Kubernetes administra volúmenes de pods utilizando este directorio. El controlador CSI de Datadog debe acceder a `/var/lib/kubelet/pods` para inyectar sockets de dominio Unix Datadog en pods de usuario. - -### Propagación bidireccional de montajes -La propagación bidireccional de montajes es necesaria para garantizar que los montajes de volúmenes del servidor del nodo CSI de Datadog sean visibles tanto para el host como para los pods de usuario. Sin la propagación bidireccional de montajes, los sockets compartidos no pueden propagarse correctamente a los pods. - -Al aislar el controlador CSI de Datadog en un espacio de nombres privilegiado, los clústeres Kubernetes pueden compartir de forma segura sockets Datadog con pods de usuario que se ejecutan bajo estrictas normas de seguridad para pods como baseline o restricted, a la vez que se minimizan los riesgos de seguridad. - -
- Limita el acceso al espacio de nombres y la configuración del controlador CSI de Datadog a operadores de confianza. Si los privilegios elevados del controlador CSI de Datadog están mal configurados, estos privilegios pueden ser mal utilizados. -
- -## Referencias adicionales - -{{< partial name="whats-next/whats-next.html" >}} - -[1]: https://github.com/DataDog/datadog-csi-driver -[2]: https://hub.docker.com/r/datadog/csi-driver -[3]: https://kubernetes-csi.github.io/docs/introduction.html -[4]: https://kubernetes.io/docs/concepts/security/pod-security-standards/ \ No newline at end of file diff --git a/content/es/containers/kubernetes/tag.md b/content/es/containers/kubernetes/tag.md index bbf22a5d29939..550f396f3165d 100644 --- a/content/es/containers/kubernetes/tag.md +++ b/content/es/containers/kubernetes/tag.md @@ -2,6 +2,8 @@ aliases: - /es/agent/autodiscovery/tag/ - /es/agent/kubernetes/tag +description: Configurar la extracción automática de etiquetas a partir de las etiquetas + (labels) y anotaciones de pod de Kubernetes para mejorar la monitorización further_reading: - link: /getting_started/tagging/ tag: Documentación @@ -17,53 +19,54 @@ title: Extracción de etiquetas de Kubernetes El Datadog Agent puede asignar automáticamente etiquetas a métricas, trazas y logs emitidos por un pod (o un contenedor individual dentro de un pod) basándose en etiquetas o anotaciones. -## Etiquetas predefinidas +## Etiquetas (tags) predefinidas La lista de etiquetas asignadas automáticamente depende de la [configuración de cardinalidad][1] del Agent. La [cardinalidad de las etiquetas][4] se añade antes de la ingesta y puede afectar a la facturación, ya que las distintas configuraciones de cardinalidad influyen en el número de métricas emitidas.
- | Etiqueta | Cardinalidad | Fuente | Requisito | - |-------------------------------|--------------|------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------| - | `container_id` | Alta | Estado del pod | N/A | - | `display_container_name` | Alta | Estado del pod | N/A | - | `pod_name` | Orquestador | Metadatos del pod | N/A | - | `oshift_deployment` | Orquestador | Anotación del pod `openshift.io/deployment.name` | El entorno de OpenShift y la anotación del pod debe existir | - | `kube_ownerref_name` | Orquestador | Referencia del propietario del pod | El pod debe tener un propietario | - | `kube_job` | Orquestador | Referencia del propietario del pod | El pod debe estar adjunto a un cronjob | - | `kube_job` | Baja | Referencia del propietario del pod | El pod debe estar adjunto a un trabajo | - | `kube_replica_set` | Baja | Referencia del propietario del pod | El pod debe estar adjunto a un conjunto de réplica | - | `kube_service` | Baja | Detección de servicios de Kubernetes | El pod está detrás de un servicio de Kubernetes | - | `kube_daemon_set` | Baja | Referencia del propietario del pod | El pod debe estar adjunto a un DaemonSet | - | `kube_container_name` | Baja | Estado del pod | N/A | - | `kube_namespace` | Baja | Metadatos del pod | N/A | - | `kube_app_name` | Baja | Etiqueta del pod `app.kubernetes.io/name` | La etiqueta del pod debe existir | - | `kube_app_instance` | Baja | Etiqueta del pod `app.kubernetes.io/instance` | La etiqueta del pod debe existir | - | `kube_app_version` | Baja | Etiqueta del pod `app.kubernetes.io/version` | La etiqueta del pod debe existir | - | `kube_app_component` | Baja | Etiqueta del pod `app.kubernetes.io/component` | La etiqueta del pod debe existir | - | `kube_app_part_of` | Baja | Etiqueta del pod `app.kubernetes.io/part-of` | La etiqueta del pod debe existir | - | `kube_app_managed_by` | Baja | Etiqueta del pod `app.kubernetes.io/managed-by` | La etiqueta del pod debe existir | - | `env` | Baja | Etiqueta del pod `tags.datadoghq.com/env` o variable de entorno del contenedor (`DD_ENV` o `OTEL_RESOURCE_ATTRIBUTES`) | [Etiquetado unificado de servicios][2] activado | - | `version` | Baja | Etiqueta del pod `tags.datadoghq.com/version` o variable de entorno del contenedor (`DD_VERSION` o `OTEL_RESOURCE_ATTRIBUTES`) | [Etiquetado unificado de servicios][2] activado | - | `service` | Baja | Etiqueta del pod `tags.datadoghq.com/service` o variable de entorno del contenedor (`DD_SERVICE`, `OTEL_RESOURCE_ATTRIBUTES` o `OTEL_SERVICE_NAME`) | [Etiquetado unificado de servicios][2] activado | - | `pod_phase` | Baja | Estado del pod | N/A | - | `oshift_deployment_config` | Baja | Anotación del pod `openshift.io/deployment-config.name` | El entorno de OpenShift y la anotación del pod debe existir | - | `kube_ownerref_kind` | Baja | Referencia del propietario del pod | El pod debe tener un propietario | - | `kube_deployment` | Baja | Referencia del propietario del pod | El pod debe estar adjunto a un despliegue | - | `kube_replication_controller` | Baja | Referencia del propietario del pod | El pod debe estar adjunto a un controlador de replicación | - | `kube_stateful_set` | Baja | Referencia del propietario del pod | El pod debe estar adjunto a un statefulset | - | `persistentvolumeclaim` | Baja | Especificación del pod | Un PVC debe estar adjunto al pod | - | `kube_cronjob` | Baja | Referencia del propietario del pod | El pod debe estar adjunto a un cronjob | - | `image_name` | Baja | Especificación del pod | N/A | - | `short_image` | Baja | Especificación del pod | N/A | - | `image_tag` | Baja | Especificación del pod | N/A | - | `eks_fargate_node` | Baja | Especificación del pod | Entorno de EKS Fargate | - | `kube_runtime_class` | Baja | Especificación del pod | El pod debe estar adjunto a una clase de tiempo de ejecución | - | `gpu_vendor` | Baja | Especificación del pod | El contenedor debe estar adjunto a un recurso de GPU | - | `image_id` | Baja | ID de imagen del contenedor | N/A | - | `kube_autoscaler_kind` | Baja | Tipo de escalador automático de Kubernetes | Se debe utilizar un escalador automático de Kubernetes | - | `kube_priority_class` | Baja | Clase de prioridad del pod | El pod debe tener un conjunto de clase de prioridad | - | `kube_qos` | Baja | Clase de calidad de servicio del pod | N/A | + | Tag (Etiqueta) | Cardinalidad | Source (Fuente) | Requisito | + |-------------------------------|--------------|-------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------| + | `container_id` | Alto | Estado del pod | N/A | + | `display_container_name` | Alto | Estado del pod | N/A | + | `pod_name` | Orquestador | Metadatos del pod | N/A | + | `oshift_deployment` | Orquestador | Anotación del pod `openshift.io/deployment.name` | El entorno de OpenShift y la anotación del pod deben existir | + | `kube_ownerref_name` | Orquestador | Referencia del propietario del pod | El pod debe tener un propietario | + | `kube_job` | Orquestador | Referencia del propietario del pod | El pod debe estar asociado a un job (generic) programado | + | `kube_job` | Bajo | Referencia del propietario del pod | El pod debe estar asociado a un job (generic) | + | `kube_replica_set` | Bajo | Referencia del propietario del pod | El pod debe estar asociado a un conjunto de réplicas | + | `kube_service` | Bajo | Descubrimiento de servicios de Kubernetes | El pod está detrás de un servicio de Kubernetes | + | `kube_daemon_set` | Bajo | Referencia del propietario del pod | El pod debe estar asociado a un DaemonSet | + | `kube_container_name` | Bajo | Estado del pod | N/A | + | `kube_namespace` | Bajo | Metadatos del pod | N/A | + | `kube_app_name` | Bajo | Etiqueta del pod `app.kubernetes.io/name` | La etiqueta del pod debe existir | + | `kube_app_instance` | Bajo | Etiqueta del pod `app.kubernetes.io/instance` | La etiqueta del pod debe existir | + | `kube_app_version` | Bajo | Etiqueta del pod `app.kubernetes.io/version` | La etiqueta del pod debe existir | + | `kube_app_component` | Bajo | Etiqueta del pod `app.kubernetes.io/component` | La etiqueta del pod debe existir | + | `kube_app_part_of` | Bajo | Etiqueta del pod `app.kubernetes.io/part-of` | La etiqueta del pod debe existir | + | `kube_app_managed_by` | Bajo | Etiqueta del pod `app.kubernetes.io/managed-by` | La etiqueta del pod debe existir | + | `env` | Bajo | Etiqueta del pod `tags.datadoghq.com/env` o variable de entorno del contenedor (`DD_ENV` o `OTEL_RESOURCE_ATTRIBUTES`) | [Etiquetado de servicio unificado][2] activado | + | `version` | Bajo | Etiqueta del pod `tags.datadoghq.com/version` o variable de entorno del contenedor (`DD_VERSION` o `OTEL_RESOURCE_ATTRIBUTES`) | [Etiquetado de servicio unificado][2] activado | + | `service` | Bajo | Etiqueta del pod `tags.datadoghq.com/service` o variable de entorno del contenedor (`DD_SERVICE`, `OTEL_RESOURCE_ATTRIBUTES` o `OTEL_SERVICE_NAME`) | [Etiquetado de servicio unificado][2] activado | + | `pod_phase` | Bajo | Estado del pod | N/A | + | `oshift_deployment_config` | Bajo | Anotación del pod `openshift.io/deployment-config.name` | El entorno de OpenShift y la anotación del pod deben existir | + | `kube_ownerref_kind` | Bajo | Referencia del propietario del pod | El pod debe tener un propietario | + | `kube_deployment` | Bajo | Referencia del propietario del pod | El pod debe estar asociado a un despliegue | + | `kube_argo_rollout` | Bajo | Referencia del propietario del pod | El pod debe estar asociado a un lanzamiento de argo | + | `kube_replication_controller` | Bajo | Referencia del propietario del pod | El pod debe estar asociado a un controlador de replicación | + | `kube_stateful_set` | Bajo | Referencia del propietario del pod | El pod debe estar a un conjunto completo de estados | + | `persistentvolumeclaim` | Bajo | Especificación del pod | Un PVC debe estar asociado al pod | + | `kube_cronjob` | Bajo | Referencia del propietario del pod | El pod debe estar a un job (generic) programado | + | `image_name` | Bajo | Especificación del pod | N/A | + | `short_image` | Bajo | Especificación del pod | N/A | + | `image_tag` | Bajo | Especificación del pod | N/A | + | `eks_fargate_node` | Bajo | Especificación del pod | Entorno de EKS Fargate | + | `kube_runtime_class` | Bajo | Especificación del pod | El pod debe estar asociado a una clase de tiempo de ejecución | + | `gpu_vendor` | Bajo | Especificación del pod | El contenedor de estar asociado a un recurso de GPU | + | `image_id` | Bajo | Identificador de imagen del contenedor | N/A | + | `kube_autoscaler_kind` | Bajo | Tipo de autoescalador de Kubernetes | Se debe utilizar el autoescalador de Kubernetes | + | `kube_priority_class` | Bajo | Clase de prioridad del pod | El pod debe tener un conjunto de clases de prioridad | + | `kube_qos` | Bajo | Clase de calidad del servicio del pod | N/A |
@@ -109,11 +112,13 @@ A partir de Agent v7.17+, Agent puede hacer Autodiscovery de etiquetas a partir com.datadoghq.ad.tags: '[":TAG_VALUE", ":"]' ``` -## Extracción de etiquetas (tags) +## Extracción de etiquetas ### Etiquetas de recursos de Kubernetes como etiquetas -A partir del Agent v7.58+, el Agent puede configurarse para recopilar etiquetas (labels) de cualquier recurso de Kubernetes y utilizarlas como etiquetas (tags) para adjuntarlas a todas las métricas, trazas y logs asociadas a ese recurso. +A partir de Agent v7.58+, el Agent puede configurarse para recopilar etiquetas (labels) de los recursos de Kubernetes y utilizarlas como etiquetas (tags). + +**Nota:** Las etiquetas no se aplican en cascada entre recursos primarios y secundarios. Por ejemplo, las etiquetas (labels) de un despliegue no se aplican automáticamente a los logs de sus pods secundarios. Para etiquetar los logs de pod, configura las etiquetas (labels) directamente en los pods. Esta opción de configuración es más genérica y debería preferirse a las siguientes opciones: - podLabelsAsTags @@ -122,7 +127,7 @@ Esta opción de configuración es más genérica y debería preferirse a las sig {{< tabs >}} -{{% tab "Datadog Operador" %}} +{{% tab "Datadog Operator" %}} Cada tipo de recurso debe especificarse en el formato `resourceType.apiGroup`, donde `resourceType` es el nombre en plural del recurso. @@ -159,7 +164,7 @@ spec: baz: qux ``` -Para Agent v7.24.0+, utiliza la siguiente configuración de variable de entorno para añadir todas las etiquetas (labels) de recurso como etiquetas a tus métricas. En este ejemplo, los nombres de etiquetas llevan el prefijo `_`: +Para el Agent v7.24.0+, utiliza la siguiente configuración de variables de entorno para añadir todas las etiquetas (labels) de recursos como etiquetas a tus métricas, excepto las de KSM (`kubernetes_state.*`). En este ejemplo, los nombres de las etiquetas de pod llevan el prefijo `_`: ```yaml apiVersion: datadoghq.com/v2alpha1 @@ -172,6 +177,7 @@ spec: pods: "*": _%%label%% ``` + {{% /tab %}} {{% tab "Helm" %}} @@ -201,7 +207,7 @@ datadog: baz: qux ``` -Para Agent v7.24.0+, utiliza la siguiente configuración de variable de entorno para añadir todas las etiquetas (labels) de recurso como etiquetas a tus métricas. En este ejemplo, los nombres de etiquetas llevan el prefijo `_`: +Para el Agent v7.24.0+, utiliza la siguiente configuración de variables de entorno para añadir todas las etiquetas (labels) de recursos como etiquetas a tus métricas, excepto las de KSM (`kubernetes_state.*`). En este ejemplo, los nombres de las etiquetas de pod llevan el prefijo `_`: ```yaml datadog: @@ -209,13 +215,14 @@ datadog: pods: "*": _%%label%% ``` + {{% /tab %}} {{% tab "Manual (DaemonSet)" %}} Cada tipo de recurso debe especificarse en el formato `resourceType.apiGroup`, donde `resourceType` es el nombre en plural del recurso. -Si un recurso específico se encuentra en el grupo de API vacío (por ejemplo, `pods` y `nodes`), puede especificarse utilizando `resourceType`. +Si un recurso específico se encuentra en el grupo de API vacío (por ejemplo `pods` y `nodes`), puede especificarse utilizando `resourceType`. Para extraer una determinada etiqueta (label) de nodo `` y transformarla como clave de etiqueta (tag) `` dentro de Datadog, añade la siguiente variable de entorno al Datadog Agent: @@ -229,13 +236,14 @@ Po ejemplo, podrías configurar: DD_KUBERNETES_RESOURCES_LABELS_AS_TAGS='{"nodes":{"kubernetes.io/arch": "arch"},"pods":{"baz":"qux"}}' ``` -Para Agent v7.24.0+, utiliza la siguiente configuración de variable de entorno para añadir todas las etiquetas (labels) de recurso como etiquetas a tus métricas. En este ejemplo, los nombres de etiquetas llevan el prefijo `_`: +Para el Agent v7.24.0+, utiliza la siguiente configuración de variables de entorno para añadir todas las etiquetas (labels) de recursos como etiquetas a tus métricas, excepto las de KSM (`kubernetes_state.*`). En este ejemplo, los nombres de las etiquetas de pod llevan el prefijo `_`: ```bash DD_KUBERNETES_RESOURCES_LABELS_AS_TAGS='{"pods":{"*": "_%%label%%"}}' ``` -{{% /tab%}} -{{< /tabs>}} + +{{% /tab %}} +{{< /tabs >}} **Notas**: Las métricas personalizadas pueden afectar a la facturación. Consulta la página [Facturación de métricas personalizadas][3] para más información. @@ -271,7 +279,9 @@ bar: quuz ### Anotaciones de recursos de Kubernetes como etiquetas -A partir del Agent v7.58+, el Agent puede configurarse para recopilar anotaciones de cualquier recurso de Kubernetes y utilizarlas como etiquetas (tags) para adjuntarlas a todas las métricas, trazas y logs asociadas a ese recurso. +A partir del Agent v7.58+, el Agent puede configurarse para recopilar anotaciones de los recursos de Kubernetes y utilizarlas como etiquetas. + +**Nota:** Las etiquetas no se aplican en cascada entre los recursos primarios y secundarios. Por ejemplo, las anotaciones en un despliegue no se aplican automáticamente a los logs de sus pods secundarios. Para etiquetar los logs de pod, configura las anotaciones directamente en los pods. Esta opción de configuración es más genérica y debería preferirse a las siguientes opciones: - podAnnotationsAsTags @@ -280,7 +290,7 @@ Esta opción de configuración es más genérica y debería preferirse a las sig {{< tabs >}} -{{% tab "Datadog Operador" %}} +{{% tab "Datadog Operator" %}} Cada tipo de recurso debe especificarse en el formato `resourceType.apiGroup`, donde `resourceType` es el nombre en plural del recurso. @@ -317,7 +327,7 @@ spec: baz: qux ``` -Para Agent v7.24.0+, utiliza la siguiente configuración de variable de entorno para añadir todas las anotaciones de recurso como etiquetas a tus métricas. En este ejemplo, los nombres de etiquetas para pods llevan el prefijo `_`: +Para el Agent v7.24.0+, utiliza la siguiente configuración de variables de entorno para añadir todas las anotaciones de recursos como etiquetas a tus métricas, excepto las de KSM (`kubernetes_state.*`). En este ejemplo, los nombres de las etiquetas de pod llevan el prefijo `_`: ```yaml apiVersion: datadoghq.com/v2alpha1 @@ -330,6 +340,7 @@ spec: pods: "*": _%%annotation%% ``` + {{% /tab %}} {{% tab "Helm" %}} @@ -359,7 +370,7 @@ datadog: baz: qux ``` -Para Agent v7.24.0+, utiliza la siguiente configuración de variable de entorno para añadir todas las anotaciones de recurso como etiquetas a tus métricas. En este ejemplo, los nombres de etiquetas para pods llevan el prefijo `_`: +Para el Agent v7.24.0+, utiliza la siguiente configuración de variables de entorno para añadir todas las anotaciones de recursos como etiquetas a tus métricas, excepto las de KSM (`kubernetes_state.*`). En este ejemplo, los nombres de las etiquetas de pod llevan el prefijo `_`: ```yaml datadog: @@ -367,6 +378,7 @@ datadog: pods: "*": _%%annotation%% ``` + {{% /tab %}} {{% tab "Manual (DaemonSet)" %}} @@ -387,13 +399,14 @@ Po ejemplo, podrías configurar: DD_KUBERNETES_RESOURCES_ANNOTATIONS_AS_TAGS='{"nodes":{"kubernetes.io/arch": "arch"},"pods":{"baz":"qux"}}' ``` -Para Agent v7.24.0+, utiliza la siguiente configuración de variable de entorno para añadir todas las anotaciones de recurso como etiquetas a tus métricas. En este ejemplo, los nombres de etiquetas para pods llevan el prefijo `_`: +Para el Agent v7.24.0+, utiliza la siguiente configuración de variables de entorno para añadir todas las anotaciones de recursos como etiquetas a tus métricas, excepto las de KSM (`kubernetes_state.*`). En este ejemplo, los nombres de las etiquetas de pod llevan el prefijo `_`: ```bash DD_KUBERNETES_RESOURCES_ANNOTATIONS_AS_TAGS='{"pods":{"*": "_%%annotation%%"}}' ``` -{{% /tab%}} -{{< /tabs>}} + +{{% /tab %}} +{{< /tabs >}} **Notas**: Las métricas personalizadas pueden afectar a la facturación. Consulta la página [Facturación de métricas personalizadas][3] para más información. @@ -464,7 +477,7 @@ spec: kubernetes.io/arch: arch ``` -Para Agent v7.24.0+, utiliza la siguiente configuración de variable de entorno para añadir todas las labels de nodo como etiquetas a tus métricas. En este ejemplo, los nombres de etiquetas llevan el prefijo `_`: +Para el Agent v7.24.0+, utiliza la siguiente configuración de variables de entorno para añadir todas las etiquetas (labels) de nodo como etiquetas a tus métricas, excepto las de KSM (`kubernetes_state.*`). En este ejemplo, los nombres de las etiquetas de pod llevan el prefijo `_`: ```yaml apiVersion: datadoghq.com/v2alpha1 @@ -474,7 +487,7 @@ metadata: spec: global: nodeLabelsAsTags: - "*": _%%label%% + "*": _%%label%% # Note: wildcards do not work for KSM metrics ``` {{% /tab %}} @@ -494,12 +507,13 @@ datadog: kubernetes.io/arch: arch ``` -Para Agent v7.24.0+, utiliza la siguiente configuración de variable de entorno para añadir todas las labels de nodo como etiquetas a tus métricas. En este ejemplo, los nombres de etiquetas llevan el prefijo `_`: +Para el Agent v7.24.0+, utiliza la siguiente configuración de variables de entorno para añadir todas las etiquetas (labels) de nodo como etiquetas a tus métricas, excepto las de KSM (`kubernetes_state.*`). En este ejemplo, los nombres de las etiquetas llevan el prefijo `_`: + ```yaml datadog: nodeLabelsAsTags: - "*": _%%label%% + "*": _%%label%% # Note: wildcards do not work for KSM metrics ``` {{% /tab %}} @@ -516,13 +530,13 @@ Po ejemplo, podrías configurar: DD_KUBERNETES_NODE_LABELS_AS_TAGS='{"kubernetes.io/arch":"arch"}' ``` -Para Agent v7.24.0+, utiliza la siguiente configuración de variable de entorno para añadir todas las labels de nodo como etiquetas a tus métricas. En este ejemplo, los nombres de etiquetas llevan el prefijo `_`: +Para el Agent v7.24.0+, utiliza la siguiente configuración de variables de entorno para añadir todas las etiquetas (labels) de nodo como etiquetas a tus métricas, excepto las de KSM (`kubernetes_state.*`). En este ejemplo, los nombres de las etiquetas llevan el prefijo `_`: ```bash DD_KUBERNETES_NODE_LABELS_AS_TAGS='{"*":"_%%label%%"}' ``` -{{% /tab%}} -{{< /tabs>}} +{{% /tab %}} +{{< /tabs >}} **Nota**: Las métricas personalizadas pueden modificar la facturación. Consulta la [página de facturación de métricas personalizadas][3] para obtener más información. @@ -563,7 +577,7 @@ spec: app: kube_app ``` -Para Agent v7.24.0+, utiliza la siguiente configuración de variable de entorno para añadir todas las labels de pod como etiquetas a tus métricas. En este ejemplo, los nombres de etiquetas llevan el prefijo `_`: +Para el Agent v7.24.0+, utiliza la siguiente configuración de variables de entorno para añadir todas las etiquetas (labels) de pod como etiquetas a tus métricas, excepto las de KSM (`kubernetes_state.*`). En este ejemplo, los nombres de las etiquetas llevan el prefijo `_`: ```yaml apiVersion: datadoghq.com/v2alpha1 @@ -573,7 +587,7 @@ metadata: spec: global: podLabelsAsTags: - "*": _%%label%% + "*": _%%label%% # Note: wildcards do not work for KSM metrics ``` {{% /tab %}} @@ -593,12 +607,12 @@ datadog: app: kube_app ``` -Para Agent v7.24.0+, utiliza la siguiente configuración de variable de entorno para añadir todas las labels de pod como etiquetas a tus métricas. En este ejemplo, los nombres de etiquetas llevan el prefijo `_`: +Para el Agent v7.24.0+, utiliza la siguiente configuración de variables de entorno para añadir todas las etiquetas (labels) de pod como etiquetas a tus métricas, excepto las de KSM (`kubernetes_state.*`). En este ejemplo, los nombres de las etiquetas llevan el prefijo `_`: ```yaml datadog: podLabelsAsTags: - "*": _%%label%% + "*": _%%label%% # Note: wildcards do not work for KSM metrics ``` {{% /tab %}} @@ -615,13 +629,13 @@ Po ejemplo, podrías configurar: DD_KUBERNETES_POD_LABELS_AS_TAGS='{"app":"kube_app"}' ``` -Para Agent v6.8.0+, utiliza la siguiente configuración de variable de entorno para añadir todas las labels de pod como etiquetas a tus métricas. En este ejemplo, los nombres de etiquetas llevan el prefijo `_`: +Para el Agent v7.24.0+, utiliza la siguiente configuración de variables de entorno para añadir todas las etiquetas (labels) de pod como etiquetas a tus métricas, excepto las de KSM (`kubernetes_state.*`). En este ejemplo, los nombres de las etiquetas llevan el prefijo `_`: ```bash DD_KUBERNETES_POD_LABELS_AS_TAGS='{"*":"_%%label%%"}' ``` -{{% /tab%}} -{{< /tabs>}} +{{% /tab %}} +{{< /tabs >}} **Nota**: Las métricas personalizadas pueden modificar la facturación. Consulta la [página de facturación de métricas personalizadas][3] para obtener más información. @@ -662,7 +676,7 @@ spec: app: kube_app ``` -Para Agent v7.24.0+, utiliza la siguiente configuración de variable de entorno para añadir todas las anotaciones de pod como etiquetas a tus métricas. En este ejemplo, los nombres de etiquetas llevan el prefijo `_`: +Para el Agent v7.24.0+, utiliza la siguiente configuración de variables de entorno para añadir todas las anotaciones de pod como etiquetas a tus métricas, excepto las de KSM (`kubernetes_state.*`). En este ejemplo, los nombres de las etiquetas llevan el prefijo `_`: ```yaml apiVersion: datadoghq.com/v2alpha1 @@ -672,7 +686,7 @@ metadata: spec: global: podAnnotationsAsTags: - "*": _%%label%% + "*": _%%annotation%% # Note: wildcards do not work for KSM metrics ``` {{% /tab %}} @@ -692,12 +706,12 @@ datadog: app: kube_app ``` -Para Agent v7.24.0+, utiliza la siguiente configuración de variable de entorno para añadir todas las anotaciones de pod como etiquetas a tus métricas. En este ejemplo, los nombres de etiquetas llevan el prefijo `_`: +Para el Agent v7.24.0+, utiliza la siguiente configuración de variables de entorno para añadir toda anotación de pod como etiquetas a tus métricas, excepto las de KSM (`kubernetes_state.*`). En este ejemplo, los nombres de las etiquetas llevan el prefijo `_`: ```yaml datadog: podAnnotationsAsTags: - "*": _%%label%% + "*": _%%annotation%% # Note: wildcards do not work for KSM metrics ``` {{% /tab %}} @@ -714,13 +728,13 @@ Po ejemplo, podrías configurar: DD_KUBERNETES_POD_ANNOTATIONS_AS_TAGS='{"app":"kube_app"}' ``` -Para Agent v7.24.0+, utiliza la siguiente configuración de variable de entorno para añadir todas las anotaciones de pod como etiquetas a tus métricas. En este ejemplo, los nombres de etiquetas llevan el prefijo `_`: +Para el Agent v7.24.0+, utiliza la siguiente configuración de variables de entorno para añadir todas las anotaciones de pod como etiquetas a tus métricas, excepto las de KSM (`kubernetes_state.*`). En este ejemplo, los nombres de las etiquetas llevan el prefijo `_`: ```bash DD_KUBERNETES_POD_ANNOTATIONS_AS_TAGS='{"*":"_%%annotation%%"}' ``` -{{% /tab%}} -{{< /tabs>}} +{{% /tab %}} +{{< /tabs >}} **Nota**: Las métricas personalizadas pueden modificar la facturación. Consulta la [página de facturación de métricas personalizadas][3] para obtener más información. @@ -761,7 +775,7 @@ spec: app: kube_app ``` -Para Agent v7.24.0+, utiliza la siguiente configuración de variable de entorno para añadir todas las labels de espacio de nombres como etiquetas a tus métricas. En este ejemplo, los nombres de etiquetas llevan el prefijo `_`: +Para el Agent v7.24.0+, utiliza la siguiente configuración de variables de entorno para añadir todas las etiquetas (labels) de espacio de nombres como etiquetas a tus métricas, excepto las de KSM (`kubernetes_state.*`). En este ejemplo, los nombres de las etiquetas llevan el prefijo `_`: ```yaml apiVersion: datadoghq.com/v2alpha1 @@ -771,7 +785,7 @@ metadata: spec: global: namespaceLabelsAsTags: - "*": _%%label%% + "*": _%%label%% # Note: wildcards do not work for KSM metrics ``` {{% /tab %}} @@ -791,12 +805,12 @@ datadog: app: kube_app ``` -Para Agent v7.24.0+, utiliza la siguiente configuración de variable de entorno para añadir todas las labels de espacio de nombres como etiquetas a tus métricas. En este ejemplo, los nombres de etiquetas llevan el prefijo `_`: +Para el Agent v7.24.0+, utiliza la siguiente configuración de variables de entorno para añadir todas las etiquetas (labels) de espacio de nombres como etiquetas a tus métricas, excepto las de KSM (`kubernetes_state.*`). En este ejemplo, los nombres de las etiquetas llevan el prefijo `_`: ```yaml datadog: namespaceLabelsAsTags: - "*": _%%label%% + "*": _%%label%% # Note: wildcards do not work for KSM metrics ``` {{% /tab %}} @@ -813,13 +827,13 @@ Po ejemplo, podrías configurar: DD_KUBERNETES_NAMESPACE_LABELS_AS_TAGS='{"app":"kube_app"}' ``` -Utiliza la siguiente configuración de variable de entorno para añadir todas las labels de espacio de nombres como etiquetas a tus métricas. En este ejemplo, los nombres de etiqueta llevan el prefijo `_`: +Para el Agent v7.24.0+, utiliza la siguiente configuración de variables de entorno para añadir todas las etiquetas (labels) de espacio de nombres como etiquetas a tus métricas, excepto las de KSM (`kubernetes_state.*`). En este ejemplo, los nombres de las etiquetas llevan el prefijo `_`: ```bash DD_KUBERNETES_NAMESPACE_LABELS_AS_TAGS='{"*":"_%%label%%"}' ``` -{{% /tab%}} -{{< /tabs>}} +{{% /tab %}} +{{< /tabs >}} **Nota**: Las métricas personalizadas pueden modificar la facturación. Consulta la [página de facturación de métricas personalizadas][3] para obtener más información. @@ -894,8 +908,8 @@ Por ejemplo: DD_CONTAINER_ENV_AS_TAGS='{"app":"kube_app"}' ``` -{{% /tab%}} -{{< /tabs>}} +{{% /tab %}} +{{< /tabs >}} **Nota**: Las métricas personalizadas pueden modificar la facturación. Consulta [Facturación de métricas personalizadas][3] para obtener más información. @@ -971,8 +985,8 @@ Por ejemplo: ```bash DD_CONTAINER_LABELS_AS_TAGS='{"app":"kube_app"}' ``` -{{% /tab%}} -{{< /tabs>}} +{{% /tab %}} +{{< /tabs >}} **Nota**: Las métricas personalizadas pueden modificar la facturación. Consulta [Facturación de métricas personalizadas][3] para obtener más información. @@ -980,7 +994,6 @@ DD_CONTAINER_LABELS_AS_TAGS='{"app":"kube_app"}' {{< partial name="whats-next/whats-next.html" >}} - [1]: /es/getting_started/tagging/assigning_tags/?tab=containerizedenvironments#environment-variables [2]: /es/getting_started/tagging/unified_service_tagging [3]: /es/account_management/billing/custom_metrics diff --git a/content/es/containers/monitoring/autoscaling.md b/content/es/containers/monitoring/autoscaling.md deleted file mode 100644 index dbd7f6996b5f1..0000000000000 --- a/content/es/containers/monitoring/autoscaling.md +++ /dev/null @@ -1,248 +0,0 @@ ---- -further_reading: -- link: https://www.datadoghq.com/blog/datadog-kubernetes-autoscaling/ - tag: Blog - text: Redimensionar cargas de trabajo y reducir costes con Datadog Kubernetes Autoscaling -- link: /infrastructure/containers/kubernetes_resource_utilization - tag: Documentación - text: Uso de recursos de Kubernetes -- link: /account_management/rbac/permissions - tag: Documentación - text: Permisos de roles en Datadog -- link: /agent/remote_config/ - tag: Documentación - text: Configuración remota -title: Kubernetes Autoscaling ---- - -Datadog Kubernetes Autoscaling monitoriza de forma continua tus recursos de Kubernetes para proporcionar recomendaciones inmediatas de escalado y escalado automático multidimensional de tus cargas de trabajo de Kubernetes. Puedes desplegar el escalado automático a través de la interfaz web de Datadog o con un recurso `DatadogPodAutoscaler` personalizado. - -## Cómo funciona -Datadog utiliza métricas de uso en tiempo real e históricas y señales de eventos de tus Datadog Agents existentes para hacer recomendaciones. De esta forma, puedes examinar estas recomendaciones y optar por desplegarlas. - -Por defecto, Datadog Kubernetes Autoscaling utiliza valores estimados de coste de CPU y memoria para mostrar oportunidades de ahorro y cálculos del impacto. También puedes utilizar Kubernetes Autoscaling junto con [Cloud Cost Management](#idle-cost-and-savings-estimates) para obtener informes basados en los costes exactos de tu tipo de instancia. - -El escalado automático de cargas de trabajo se realiza mediante un recurso `DatadogPodAutoscaler` personalizado que define el comportamiento del escalado a nivel de carga de trabajo individual. El Datadog Cluster Agent actúa como controlador de este recurso personalizado. - -Cada clúster puede tener un máximo de 1000 cargas de trabajo optimizadas con Datadog Kubernetes Autoscaler. - -### Compatibilidad - -- **Distribuciones**: Esta función es compatible con todas las [distribuciones Kubernetes compatibles][5] de Datadog. -- **Escalado automático de cargas de trabajo**: Esta función es una alternativa a Horizontal Pod Autoscaler (HPA) y a Vertical Pod Autoscaler (VPA). Datadog recomienda que elimines cualquier HPA o VPA de una carga de trabajo antes de utilizar Datadog Kubernetes Autoscaling para optimizarla. Estas cargas de trabajo se identifican en la aplicación en tu nombre. - -### Requisitos - -- La [configuración remota][1] debe estar activada para tu organización. Consulta [Activación de la configuración remota][2]. -- [Helm][3], para actualizar tu Datadog Agent. -- (Para usuarios del Datadog Operator) [CLI `kubectl`][4], para actualizar el Datadog Agent. -- Los siguientes permisos de usuario: - - Gestión de organización (necesario para la configuración remota) - - Escritura de claves de API (necesario para la configuración remota) - - Lectura del escalado de la carga de trabajo - - Escritura del escalado de la carga de trabajo - - Gestión del escalado automático - -## Configuración - -{{< tabs >}} -{{% tab "Datadog Operator" %}} - -1. Asegúrate de que estás utilizando la v1.8.0 o posterior del Datadog Operator. Para actualizar tu Datadog Operator: - -```shell -helm upgrade datadog-operator datadog/datadog-operator -``` - -2. Añade lo siguiente a tu archivo de configuración `datadog-agent.yaml`: - -```yaml -spec: - features: - orchestratorExplorer: - customResources: - - datadoghq.com/v1alpha2/datadogpodautoscalers - autoscaling: - workload: - enabled: true - eventCollection: - unbundleEvents: true - override: - clusterAgent: - image: - tag: 7.66.1 - env: - - name: DD_AUTOSCALING_FAILOVER_ENABLED - value: "true" - nodeAgent: - image: - tag: 7.66.1 # or 7.66.1-jmx - env: - - name: DD_AUTOSCALING_FAILOVER_ENABLED - value: "true" - - name: DD_AUTOSCALING_FAILOVER_METRICS - value: container.memory.usage container.cpu.usage - clusterChecksRunner: - image: - tag: 7.66.1 # or 7.66.1-jmx -``` - -3. El [controlador de admisión][1] está activado por defecto con el Datadog Operator. Si lo desactivaste, vuelve a activarlo añadiendo las siguientes líneas resaltadas a `datadog-agent.yaml`: - -{{< highlight yaml "hl_lines=4-5" >}} -... -spec: - features: - admissionController: - enabled: true -... -{{< /highlight >}} - -4. Aplica la configuración actualizada de `datadog-agent.yaml`: - -```shell -kubectl apply -n $DD_NAMESPACE -f datadog-agent.yaml -``` - -[1]: /es/containers/cluster_agent/admission_controller/ - -{{% /tab %}} -{{% tab "Helm" %}} - -1. Asegúrate de que estás utilizando el Agent y la v7.66.1 o posterior del Cluster Agent. Añade lo siguiente a tu archivo de configuración `datadog-values.yaml`: - -```yaml -datadog: - autoscaling: - workload: - enabled: true - kubernetesEvents: - unbundleEvents: true -``` - -2. El [controlador de admisión][1] está activado por defecto en el Datadog Helm chart. Si lo desactivaste, vuelve a activarlo añadiendo las siguientes líneas resaltadas a `datadog-values.yaml`: -{{< highlight yaml "hl_lines=5-6" >}} -... -clusterAgent: - image: - tag: 7.66.1 - admissionController: - enabled: true -... -{{< /highlight >}} - -3. Update your Helm version: - -```shell -helm repo update -``` - -4. Vuelve a desplegar el Datadog Agent con tu `datadog-values.yaml` actualizado: - -```shell -helm upgrade -f datadog-values.yaml datadog/datadog -``` - -[1]: /es/containers/cluster_agent/admission_controller/ - -{{% /tab %}} -{{< /tabs >}} - -### Estimaciones de costes y ahorros por inactividad - -{{< tabs >}} -{{% tab "With Cloud Cost Management" %}} -Si [Cloud Cost Management][1] está habilitado dentro de una organización, Datadog Kubernetes Autoscaling muestra estimaciones de costes y ahorros por inactividad, basadas en el coste exacto de tu facturación de las instancias subyacentes monitorizadas. - -Consulta las instrucciones de configuración de Cloud Cost para [AWS][2], [Azure][3] o [Google Cloud][4]. - -Los datos de Cloud Cost Management mejoran Kubernetes Autoscaling, pero no son necesarios. Todas las recomendaciones de cargas de trabajo y decisiones de escalado automático de Datadog son válidas y funcionales sin Cloud Cost Management. - -[1]: /es/cloud_cost_management -[2]: /es/cloud_cost_management/aws -[3]: /es/cloud_cost_management/azure -[4]: /es/cloud_cost_management/google_cloud -{{% /tab %}} - -{{% tab "Default" %}} -Si Cloud Cost Management **no** está activado, Datadog Kubernetes Autoscaling muestra estimaciones de costes y ahorros por inactividad utilizando las siguientes fórmulas y valores fijos: - -**Clúster inactivo**: `(max(cpu_usage, cpu_requests, cpu_capacity) - max(cpu_usage, cpu_requests)) *0.0295 + (max(memory_usage, memory_requests, memory_capacity) - max(memory_usage, memory_requests)) * 0.0053` - -**Carga de trabajo inactiva**: `(max(cpu_usage, cpu_requests) - cpu_usage) *0.0295 + (max(memory_usage, memory_requests) - memory_usage) * 0.0053` - -**Valores fijos**: -- 0,0295 $ por hora de núcleo de CPU -- 0,0053 $ por hora de GB de memoria - - -_Los valores de los costes fijos están sujetos a ajustes a lo largo del tiempo._ -{{% /tab %}} -{{< /tabs >}} - -## Utilización - -### Identificar recursos para redimensionar - -La [página de Resumen de Autoscaling][6] proporciona un punto de partida para que los equipos de plataforma comprendan todas las oportunidades de ahorro de recursos Kubernetes en toda una organización y filtren por clústeres y espacios de nombres clave. La [vista de Escalado de clústeres][7] proporciona información de cada clúster sobre la totalidad de CPU inactiva, el total de memoria inactiva y los costes. Haz clic en un clúster para obtener información detallada y una tabla de las cargas de trabajo del clúster. Si eres propietario de una aplicación o servicio individual, también puedes filtrar por el nombre de tu equipo o servicio directamente desde la [vista de la lista de Escalado de cargas de trabajo][8]. - -Haz clic en **Optimize** (Optimizar) en cualquier carga de trabajo para ver su recomendación de escalado. - -### Activar Autoscaling para una carga de trabajo - -Después de identificar una carga de trabajo para optimizar, Datadog recomienda inspeccionar su **recomendación de escalado**. También puedes hacer clic en **Configure Recommendation** (Configurar recomendación) para añadir restricciones o ajustar los niveles de uso objetivo. - -Cuando estés listo para activar Autoscaling para una carga de trabajo, tienes dos opciones de despliegue: - -- Haz clic en **Enable Autoscaling** (Activar Autoscaling). (Requiere permiso de escritura del escalado de cargas de trabajo). - - Datadog instala y configura automáticamente el escalado automático de esta carga de trabajo. - -- Despliega un recurso personalizado `DatadogPodAutoscaler`. - - Utiliza tu proceso de despliegue existente para orientar y configurar Autoscaling para tu carga de trabajo. - - {{% collapse-content title="Example DatadogPodAutoscaler CRD" level="h4" expanded=false id="id-for-anchoring" %}} - ```yaml - apiVersion: datadoghq.com/v1alpha2 - kind: DatadogPodAutoscaler - metadata: - name: - spec: - targetRef: - apiVersion: apps/v1 - kind: Deployment - name: - constraints: - # Adjust constraints as safeguards - maxReplicas: 50 - minReplicas: 1 - owner: Local - applyPolicy: - mode: Apply - objectives: - - type: PodResource - podResource: - name: cpu - value: - type: Utilization - utilization: 75 - ``` - {{% /collapse-content %}} - -### Desplegar recomendaciones manualmente - -Como alternativa al Autoscaling, también puedes desplegar manualmente las recomendaciones de escalado de Datadog. Cuando configures recursos para tus despliegues de Kubernetes, utiliza los valores sugeridos en las recomendaciones de escalado. También puedes hacer clic en **Export Recommendation** (Exportar recomendación) para ver un comando `kubectl patch` generado. - -## Referencias adicionales - -{{< partial name="whats-next/whats-next.html" >}} - -[1]: /es/agent/remote_config -[2]: /es/agent/remote_config/?tab=configurationyamlfile#enabling-remote-configuration -[3]: https://helm.sh/ -[4]: https://kubernetes.io/docs/tasks/tools/install-kubectl/ -[5]: /es/containers/kubernetes/distributions -[6]: https://app.datadoghq.com/orchestration/scaling/summary -[7]: https://app.datadoghq.com/orchestration/scaling/cluster -[8]: https://app.datadoghq.com/orchestration/scaling/workload \ No newline at end of file diff --git a/content/es/dashboards/guide/custom_time_frames.md b/content/es/dashboards/guide/custom_time_frames.md index 8c60ca746f5f3..fbab53e5efe8e 100644 --- a/content/es/dashboards/guide/custom_time_frames.md +++ b/content/es/dashboards/guide/custom_time_frames.md @@ -13,7 +13,7 @@ Muchas de las vistas de Datadog pueden ajustarse a un marco temporal específico Para incrementar por mes, día, año, hora o minuto, resalta una parte del marco temporal y utiliza las teclas `[↑]` y `[↓]`: -{{< img src="dashboards/guide/custom_time_frames/increment_with_arrow_keys.mp4" video="true" alt="Incrementar el tiempo con teclas de flechas" width="500" >}} +{{< img src="dashboards/guide/custom_time_frames/increment_with_arrow_keys.mp4" video="true" alt="Incrementar el tiempo con teclas de flechas"="true" width="500" >}} ## Sintaxis admitidas @@ -41,7 +41,7 @@ Cualquier fecha fija puede introducirse como parte de un intervalo. Por ejemplo: ### Fechas relativas -Las fechas relativas **no** se actualizan con el tiempo; se calculan cuando se introducen. +Las fechas relativas se actualizan con el tiempo; se calculan a partir de la hora actual. {{< img src="dashboards/guide/custom_time_frames/custom_relative_time_frame.mp4" alt="Tipo de marco de tiempo relativo personalizado" video="true" width="500" >}} diff --git a/content/es/dashboards/template_variables.md b/content/es/dashboards/template_variables.md index 40fa85d1729f2..89bb38fb21ec4 100644 --- a/content/es/dashboards/template_variables.md +++ b/content/es/dashboards/template_variables.md @@ -43,7 +43,20 @@ Una variable de plantilla se determina por: * **Default Value** (Valor predeterminado): El valor de la etiqueta o el atributo que aparece automáticamente cuando se carga el dashboard. El valor por defecto es `*`. * **Available Values** (Valores disponibles): Los valores de la etiqueta o el atributo disponibles en el menú desplegable. Por defecto, `(all)`. La lista de valores disponibles siempre incluye `*`, que consulta todos los valores de la etiqueta o el atributo. -**Nota**: Si no ves la etiqueta o el atributo que buscas, puede deberse a que esos datos no se han informado a Datadog recientemente. Para obtener más información, consulta [Datos históricos][4]. +### Valores de las variables de plantilla +Los valores de las variables de plantilla (valores disponibles mediante los menús desplegables de variables de plantilla) se rellenan en función de las sources (fuentes) que utilizan los widgets del dashboard. Por ejemplo, si tu dashboard tiene widgets que consultan registros, solo se muestran los valores de los logs. Si tu dashboard tiene widgets que consultan logs, métricas y RUM, se mostrarán los valores de los logs, las métricas y el RUM. + +Para la mayoría de las sources (fuentes), los valores de las variables de plantilla son relevantes para el marco temporal global de tu dashboard. Por ejemplo: +- Si el intervalo de tiempo de tu dashboard se configura en los últimos 15 minutos, solo se mostrarán los valores de las variables de plantilla de los últimos 15 minutos. +- Si el marco temporal de tu dashboard está configurado para durar el 15 de agosto de 12:00 a 23:59, solo se mostrarán los valores de ese marco temporal. + +| Fuente de datos | Periodo de consulta de datos | +|-------------------------------------- |---------------------| +| Métricas | Ahora - 48 horas | +| Coste de la nube | Ahora - 48 horas | +| Todas las demás sources (fuentes) | Marco temporal del dashboard | + +**Nota**: Si no ves la etiqueta o el atributo que buscas, puede deberse a que esos datos no se hayan comunicado a Datadog recientemente. Además, todos los datos consultados para las variables de plantilla están sujetos a la política de conservación de datos. Para más información, consulta [Datos históricos][4]. ## Añadir una variable de plantilla Si las variables de plantilla ya están definidas, consulta [Editar una variable de plantilla](#edit-a-template-variable). Si tu dashboard no tiene ninguna variable de plantilla, puedes hacer clic en el icono del signo de interrogación para abrir un modal de ayuda sobre cómo utilizar las variables del dashboard. diff --git a/content/es/database_monitoring/connect_dbm_and_apm.md b/content/es/database_monitoring/connect_dbm_and_apm.md index d9ac037b24bf4..4f4913deca615 100644 --- a/content/es/database_monitoring/connect_dbm_and_apm.md +++ b/content/es/database_monitoring/connect_dbm_and_apm.md @@ -26,16 +26,19 @@ Privacidad de los datos Las integraciones del rastreador de APM admiten un *Modo de propagación*, que controla la cantidad de información que pasa de las aplicaciones a la base de datos. - El modo `full` envía información completa sobre la traza a la base de datos, lo que te permite investigar trazas individuales en DBM. Esta es la solución recomendada para la mayoría de las integraciones. -- El modo `service` envía el nombre del servicio, lo que te permite conocer qué servicios contribuyen a la carga de la base de datos. Este es el único modo compatible con las aplicaciones de Oracle. +- `service` envía el nombre del servicio, lo que permite saber qué servicios contribuyen a la carga de la base de datos. - El modo `disabled` deshabilita la propagación y no envía información desde las aplicaciones. -| DD_DBM_PROPAGATION_MODE | Postgres | MySQL | SQL Server | Oracle | MongoDB | -|:------------------------|:---------:|:-----------:|:----------:|:---------:|:----------:| -| `full` | {{< X >}} | {{< X >}} * | {{< X >}} | {{< X >}} | {{< X >}} | -| `service` | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | +| DD_DBM_PROPAGATION_MODE | Postgres | MySQL | SQL Server | Oracle | MongoDB | +|:------------------------|:---------:|:-----------:|:----------:|:------------:|:----------:| +| `full` | {{< X >}} | {{< X >}} * | {{< X >}} | {{< X >}} ** | {{< X >}} | +| `service` | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | \* El modo de propagación completa en Aurora MySQL requiere la versión 3. +\*\* El modo de propagación completa en Oracle solo es compatible con Java. + + **Rastreadores y controladores de aplicaciones compatibles** | Lenguaje | Biblioteca o marco | Postgres | MySQL | SQL Server | Oracle | MongoDB | @@ -112,7 +115,7 @@ Datadog recomienda establecer el modo de enmascaramiento en `obfuscate_and_norma sql_obfuscation_mode: "obfuscate_and_normalize" ``` -
Cambiar el modo de ofuscación puede alterar el texto SQL normalizado. Si tienes monitores basados en texto SQL en trazas de APM, es posible que tengas que actualizarlos.
+
Cambiar el modo de enmascaramiento puede alterar el texto SQL normalizado. Si tienes monitores basados en texto SQL en trazas de APM, puede que necesites actualizarlos.
{{< tabs >}} {{% tab "Go" %}} @@ -225,10 +228,10 @@ Habilita el rastreo de sentencias preparadas para Postgres mediante **uno** de l **Nota**: La instrumentación de sentencias preparadas sobrescribe la propiedad `Application` con el texto `_DD_overwritten_by_tracer`, y provocan un viaje de ida y vuelta adicional a la base de datos. Este viaje de ida y vuelta adicional normalmente tiene un impacto insignificante en el tiempo de ejecución de la sentencia SQL. -
La activación del rastreo de sentencias preparadas puede generar un aumento del pinning de conexión cuando se utiliza Amazon RDS Proxy, lo que reduce la eficacia de la agrupación de conexiones. Para obtener más información, consulta Pinning de conexión en RDS Proxy.
+
La activación del rastreo de sentencias preparadas puede provocar un aumento de la asignación de pines de conexión al utilizar Amazon RDS Proxy, lo que reduce la eficacia de la agrupación de conexión. Para obtener más información, consulta asignación de pines de conexión en RDS Proxy.
**Versiones del rastreador inferiores a 1.44**: -Las sentencias preparadas no son compatibles con el modo `full` para Postgres y MySQL, y todas las llamadas a la API de JDBC que utilizan sentencias preparadas se degradan automáticamente al modo `service`. Dado que la mayoría de las bibliotecas SQL de Java utilizan sentencias preparadas por defecto, esto significa que **la mayoría** de las aplicaciones Java sólo pueden utilizar el modo `service`. +Las sentencias preparadas no son compatibles con el modo `full` para Postgres y MySQL, y todas las llamadas a la API de JDBC que utilizan sentencias preparadas se degradan automáticamente al modo `service`. Dado que la mayoría de las bibliotecas SQL de Java utilizan sentencias preparadas por defecto, esto significa que **la mayoría** de las aplicaciones Java solo pueden utilizar el modo `service`. [1]: /es/tracing/trace_collection/dd_libraries/java/ [2]: /es/tracing/trace_collection/compatibility/java/#data-store-compatibility @@ -349,7 +352,7 @@ for doc in results: {{% tab ".NET" %}}
-Esta función requiere que la instrumentación automática se encuentre habilitada para tu servicio de .NET. +Esta función requiere que la instrumentación automática esté activada para tu servicio .NET.
Sigue las [instrucciones de rastreo de .NET Framework][1] o las [instrucciones de rastreo de .NET Core][2] a fin de instalar el paquete de instrumentación automática y habilitar el rastreo para tu servicio. @@ -369,7 +372,7 @@ Habilita la función de propagación de la monitorización de base de datos al e {{% tab "PHP" %}}
-Esta función requiere que la extensión del rastreador se encuentre habilitada para tu servicio de PHP. +Esta función requiere que la extensión de rastreo esté habilitada para tu servicio PHP.
Sigue las [instrucciones de rastreo de PHP][1] a fin de instalar el paquete de instrumentación automática y habilitar el rastreo para tu servicio. diff --git a/content/es/integrations/_index.md b/content/es/integrations/_index.md index 0d9e11be9fee3..81ed355d201af 100644 --- a/content/es/integrations/_index.md +++ b/content/es/integrations/_index.md @@ -15,12 +15,9 @@ aliases: - /es/integrations/shoreline_software_license/ - /es/integrations/pingdom_v3/ - /es/integrations/perimeterx/ +- /es/integrations/open-policy-agent/ +- /es/integrations/open_policy_agent/ cascade: -- _target: - lang: en - path: /integrations/akamai-datastream-2 - aliases: - - /integrations/akamai_datastream - _target: lang: en path: /integrations/azure @@ -78,99 +75,6 @@ cascade: subcategory: Integraciones tags: - visor de eventos - aliases: - - /integrations/eventviewer/ -- _target: - lang: en - path: /integrations/lambdatest-software-license - aliases: - - /integrations/lambdatest_software_license/ -- _target: - lang: en - path: /integrations/rapdev-validator - aliases: - - /integrations/rapdev_dashboard_widget_pack/ -- _target: - lang: en - path: /integrations/wmi_check - aliases: - - /integrations/wmi/ -- _target: - lang: en - path: /integrations/jfrog-platform - aliases: - - /integrations/jfrog_platform/ -- _target: - lang: en - path: /integrations/komodor_license - aliases: - - /integrations/komodor_komodor/ -- _target: - lang: en - path: /integrations/stormforge_license - aliases: - - /integrations/stormforge_stormforge_license/ -- _target: - lang: en - path: /integrations/feed - aliases: - - /integrations/rss/ -- _target: - lang: en - path: /integrations/java - aliases: - - /agent/faq/jmx_integrations/ - - /agent/faq/docker-jmx/ -- _target: - lang: en - path: /integrations/amazon-elb - aliases: - - /integrations/awselb -- _target: - lang: en - path: /integrations/amazon-es - aliases: - - /integrations/awses -- _target: - lang: en - path: /integrations/amazon-s3 - aliases: - - /integrations/awss3 -- _target: - lang: en - path: /integrations/snowflake-web - aliases: - - /integrations/snowflake/ -- _target: - lang: en - path: /integrations/redpeaks-sap-netweaver - aliases: - - /integrations/agentil_software_sap_netweaver/ -- _target: - lang: en - path: /integrations/redpeaks-sap-businessobjects - aliases: - - /integrations/agentil_software_sap_businessobjects/ -- _target: - lang: en - path: /integrations/redpeaks-services-5-days - aliases: - - /integrations/agentil_software_services_5_days/ -- _target: - lang: en - path: /integrations/redpeaks-sap-hana - aliases: - - /integrations/agentil_software_sap_hana/ -- _target: - lang: en - path: /integrations/azure-virtual-network - aliases: - - /integrations/azure_virtual_networks -- _target: - lang: en - path: /integrations/amazon-event-bridge - aliases: - - /integrations/amazon_event_bridge description: Reúne datos de todos tus sistemas, aplicaciones y servicios disable_sidebar: true title: Integraciones diff --git a/content/es/integrations/guide/aws-manual-setup.md b/content/es/integrations/guide/aws-manual-setup.md index a15ac82d1dd56..9ec1e35b9b1ff 100644 --- a/content/es/integrations/guide/aws-manual-setup.md +++ b/content/es/integrations/guide/aws-manual-setup.md @@ -51,7 +51,7 @@ Para configurar manualmente la integración de AWS, crea una política y un rol {{< site-region region="gov" >}}
- La configuración de archivos de logs de S3 mediante la Delegación de roles tiene una disponibilidad limitada. Ponte en contacto con el servicio de asistencia de Datadog para solicitar esta función en tu cuenta Datadog for Government. + La configuración de S3 Log Archives mediante la delegación de roles tiene disponibilidad limitada. Ponte en contacto con el soporte de Datadog para solicitar esta función en tu cuenta de Datadog para el Gobierno.
{{< /site-region >}} @@ -59,71 +59,71 @@ Para configurar manualmente la integración de AWS, crea una política y un rol ### Generar un ID externo -1. En la [página de configuración de la integración AWS)][1], haz clic en **Add AWS Account(s)** (Añadir cuenta(s) de AWS) y, a continuación, selecciona **Manualmente**. -2. Elige la partición de AWS a la que está delimitada tu cuenta de AWS. La partición puede ser `aws` para regiones comerciales, `aws-cn` para China* o `aws-us-gov` para GovCloud. Para obtener más información, consulta [Particiones][2] en la documentación de AWS. +1. En la [página de configuración de la integración de AWS][1], haz clic en **Add AWS Account(s)** (Añadir cuentas de AWS) y, luego, selecciona **Manually** (Manualmente). +2. Elige a qué partición de AWS limitar tu cuenta de AWS. La partición es `aws` para regiones comerciales, `aws-cn` para China*, o `aws-us-gov` para GovCloud. Consulta [Parciones][2] en la documentación de AWS para obtener más información. {{< site-region region="us,us3,us5,eu,ap1,ap2" >}} -3. Selecciona `Role Delegation` para el tipo de acceso. La delegación de roles sólo es compatible con cuentas AWS delimitadas a regiones comerciales de AWS. +3. Selecciona `Role Delegation` para el tipo de acceso. La delegación de roles solo es compatible con las cuentas de AWS limitadas a regiones compatibles de AWS. {{< /site-region >}} {{< site-region region="gov" >}} -3. Selecciona `Role Delegation` para el tipo de acceso. La delegación de roles sólo es compatible con cuentas de AWS delimitadas a las regiones comerciales de AWS o AWS GovCloud. +3. Selecciona `Role Delegation` para el tipo de acceso. La delegación de roles solo es compatible con las cuentas de AWS limitadas a regiones comerciales de AWS o regiones AWS GovCloud. {{< /site-region >}} -4. Copia el `AWS External ID` Para obtener más información sobre el ID externo, consulta la [guía del usuario de IAM][3]. - **Nota**: El ID externo permanece disponible y no se regenera durante 48 horas, a menos que un usuario lo cambie explícitamente o que se añada otra cuenta de AWS a Datadog durante este periodo. Puedes volver a la página **Añadir cuenta(s) de AWS** dentro de ese periodo de tiempo sin que cambie el ID externo. +4. Copia el `AWS External ID`. Para obtener más información sobre el ID externo, lee la [guía del usuario de IAM][3]. + **Nota**: El ID externo sigue disponible y no se vuelve a generar por 48 horas, a menos que haya sido modificado explícitamente por un usuario u otra cuenta de AWS ha sido agregada a Datadog durante este periodo. Puedes volver a la página **Add AWS Account(s)** (Añadir cuentas de AWS) dentro de este periodo sin que cambie el ID externo. -### Crear un rol IAM para la integración Datadog +### Crear un rol de IAM en la integración de Datadog Datadog asume este rol para recopilar datos en tu nombre. -1. Ve a la [consola de IAM][4] de AWS y haz clic en `Create role` (Crear rol). -2. Selecciona **Cuenta de AWS** para el tipo de entidad de confianza, y **Otra cuenta de AWS**. +1. Ve a la [consola de IAM][4] de AWS y haz clic en `Create role`. +2. Selecciona **AWS account** (Cuenta de AWS) para el tipo de entidad de confianza y **Another AWS account** (Otra cuenta de AWS). {{< site-region region="us,us3,us5,eu" >}} -3. Introduce `464622532012` como `Account ID`. Este es el ID de la cuenta de Datadog y concede a Datadog acceso a tus datos de AWS. +3. Ingresa `464622532012` como el `Account ID`. Este es el ID de cuenta de Datadog y concede acceso a Datadog a tus datos de AWS. {{< /site-region >}} {{< site-region region="ap1" >}} -3. Introduce `417141415827` como `Account ID`. Este es el ID de la cuenta de Datadog y concede a Datadog acceso a tus datos de AWS. +3. Ingresa `417141415827` como el `Account ID`. Este es el ID de cuenta de Datadog y concede acceso a Datadog a tus datos de AWS. {{< /site-region >}} {{< site-region region="ap2" >}} -3. Introduce `412381753143` como `Account ID`. Este es el ID de la cuenta de Datadog y concede a Datadog acceso a tus datos de AWS. +3. Ingresa `412381753143` como el `Account ID`. Este es el ID de cuenta de Datadog y concede acceso a Datadog a tus datos de AWS. {{< /site-region >}} {{< site-region region="gov" >}} -3. Si la cuenta de AWS que quieres integrar es una cuenta GovCloud, introduce `065115117704` como `Account ID`. De lo contrario, introduce `392588925713`. Este es el ID de la cuenta de Datadog y concede a Datadog acceso a tus datos de AWS. +3. Si la cuenta de AWS que deseas integrar es una cuenta de GovCloud, ingresa `065115117704` como el `Account ID`, o sino ingresa `392588925713`. Este es el ID de cuenta de Datadog y concede acceso a Datadog a tus datos de AWS. {{< /site-region >}} -**Nota**: Asegúrate de que el selector de **SITIO DATADOG** de la derecha de esta página de documentación está configurado en tu sitio Datadog, antes de copiar el ID de cuenta anterior. +**Nota**: Asegúrate de que el selector de **DATADOG SITE** en la parte derecha de esta página de documentación esté configurado en tu sitio de Datadog antes de copiar el ID de cuenta anterior. -4. Selecciona **Solicitar ID externo** e introduce el ID externo copiado en la sección anterior. -Deja `Require MFA` desactivado. Para obtener más detalles, consulta la página [Acceder a cuentas de AWS que son propiedad de terceros][3] en la documentación de AWS. +4. Selecciona **Require external ID** (Solicitar ID externo) e ingresa el ID externo copiado en la sección anterior. +Deja `Require MFA` desactivado. Para obtener más detalles, consulta la página [Acceso a cuentas de AWS propiedad de terceros][3] en la documentación de AWS. 5. Haz clic en **Next** (Siguiente). -6. Para habilitar la [recopilación de recursos][5], adjunta la política AWS SecurityAudit al rol. +6. Para activar la [recopilación de recursos][5], adjunta la política de AWS SecurityAudit a el rol. 7. Haz clic en **Next** (Siguiente). -8. Asigna un nombre al rol, por ejemplo `DatadogIntegrationRole`. Opcionalmente, proporciona una descripción y añade etiquetas (tags) al rol. +8. Da un nombre al rol como `DatadogIntegrationRole`. Opcionalmente, brinda una descripción y añade las etiquetas al rol. 9. Haz clic en **Create Role** (Crear rol). -### Crear una política IAM en línea para el rol de la integración Datadog +### Crear un política de IAM en línea para el rol de integración de Datadog -Esta política define los permisos necesarios para que el rol de la integración Datadog recopile datos de cada integración AWS ofrecida por Datadog. Estos permisos pueden cambiar a medida que se añaden nuevos servicios AWS a esta integración. +Esta política define los permisos necesarios para el rol de integración de Datadog para recopilar datos para cada integración de AWS que ofrece Datadog. Estos permisos pueden cambiar a medida que se añaden nuevos servicios de AWS a esta integración. -1. Selecciona el rol de la integración Datadog en la [página de roles IAM)][4]. -2. Haz clic en **Add permissions** (Añadir permisos) y selecciona **Crear política en línea**. +1. Selecciona el rol de integración de Datadog en la [página de roles de IAM][4]. +2. Haz clic en **Add permissions** (Añadir permisos) y selecciona **Create inline policy** (Crear política en línea). 3. Selecciona la pestaña **JSON**. -4. Pega la [política de permisos](#aws-integration-iam-policy) en el cuadro de texto.
- **Nota**: Opcionalmente, puedes añadir elementos de [condición][6] a la política IAM. Por ejemplo, las condiciones se pueden utilizar para [restringir la monitorización a determinadas regiones][7]. +4. Pega las [políticas de permiso](#aws-integration-iam-policy) en el cuadro de texto.
+ **Nota**: Opcionalmente, puedes añadir los elementos de [Condición][6] a la política de IAM. Por ejemplo, las condiciones pueden utilizarse para [restringir la monitorización a ciertas regiones][7]. 5. Haz clic en **Next** (Siguiente). -6. Asigna a la política un nombre como `DatadogIntegrationPolicy`. +6. Nombra la política como `DatadogIntegrationPolicy`. 7. Haz clic en **Create policy** (Crear política). -### Finalizar la configuración en Datadog +### Completa la configuración en Datadog -1. Vuelve a la sección de configuración manual de la [página de configuración de la integración AWS][1]. -2. Haz clic en la casilla de verificación `I confirm that the Datadog IAM Role has been added to the AWS Account`. -3. En la sección **ID de cuenta**, introduce tu ID de cuenta **sin guiones**; por ejemplo, `123456789012`. Puedes encontrar el ID de cuenta en el ARN del rol de la integración Datadog, que sigue el formato `arn:aws:iam:::role/`. -4. En la sección **Nombre del rol AWS**, introduce el nombre del rol de la integración Datadog creado anteriormente. - **Nota**: El nombre del rol distingue entre mayúsculas y minúsculas, y debe coincidir exactamente con el nombre del rol en AWS. +1. Vuelve a la sección de configuración manual de la [página de configuración de la integración de AWS][1]. +2. Haz clic en la casilla `I confirm that the Datadog IAM Role has been added to the AWS Account`. +3. En la sección **Account ID** (ID de cuenta), ingresa tu ID de cuenta **sin guiones**; por ejemplo, `123456789012`. Puedes encontrar el ID de cuenta en el ARN del rol de integración de Datadog, que tiene el siguiente formato: `arn:aws:iam:::role/`. +4. En la sección **AWS Role Name** (Nombre de rol de AWS), ingresa el nombre del rol de integración de Datadog creado anteriormente. + **Nota**: El nombre de rol distingue mayúsculas y minúsculas y debe coincidir exactamente con el nombre de rol en AWS. 5. Haz clic en **Save** (Guardar). -6. Espera hasta 10 minutos para que se empiecen a recopilar datos y, a continuación, consulta el dashboard de información general de AWS para ver las métricas enviadas por tus servicios y tu infraestructura AWS. +6. Espera hasta 10 minutos para que los datos se empiecen a recopilar y, luego, consulta el Dashboard de información general de AWS predefinido para ver las métricas enviadas por tus servicios e infraestructura de AWS. -
Si se produce un error Datadog no tiene autorización para llevar a cabo sts:AssumeRole. Sigue los pasos de resolución de problemas recomendados en la interfaz de usuario o lee la guía de resolución de problemas.
+
Si hay un error Datadog is not authorized to perform sts:AssumeRole, sigue los pasos de solución de problemas recomendados en la interfaz de usuarios o lee la guía de solución de problemas.
-*\* Cualquier uso de los servicios Datadog en China continental (o relacionados con entornos de esta localización) está sujeto a la cláusula de exención de responsabilidad, publicada en la sección [Localizaciones con restricciones de servicio][8] de nuestro sitio web.* +\*{{% mainland-china-disclaimer %}} [1]: https://app.datadoghq.com/integrations/amazon-web-services [2]: https://docs.aws.amazon.com/whitepapers/latest/aws-fault-isolation-boundaries/partitions.html @@ -132,9 +132,8 @@ Esta política define los permisos necesarios para que el rol de la integración [5]: /es/integrations/amazon_web_services/#resource-collection [6]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_condition.html [7]: https://aws.amazon.com/blogs/security/easier-way-to-control-access-to-aws-regions-using-iam-policies/ -[8]: https://www.datadoghq.com/legal/restricted-service-locations/ {{% /tab %}} -{{% tab "Access keys" %}} +{{% tab "Claves de acceso" %}} ## Configuración @@ -146,17 +145,16 @@ Esta política define los permisos necesarios para que el rol de la integración ### Datadog 3. En el [cuadro de integración de AWS][1], haz clic en **Add AWS Account** (Añadir cuenta de AWS) y, a continuación, selecciona **Manually** (Manualmente). -4. Selecciona la pestaña **Claves de acceso**. +4. Selecciona la pestaña **Access Keys** (Claves de acceso). 5. Elige la partición en AWS a la que se delimita tu cuenta AWS. La partición puede ser `aws` para regiones comerciales, `aws-cn` para China* o `aws-us-gov` para GovCloud. Consulta [Particiones][9] en la documentación de AWS para obtener más información. 5. Haz clic en la casilla de verificación **I confirm that the IAM User for the Datadog Integration has been added to the AWS Account** (Confirmo que el usuario de IAM para la integración de Datadog se ha añadido a la cuenta de AWS). 6. Introduce tu `Account ID`, `AWS Access Key` y `AWS Secret Key`. 7. Haz clic en **Save** (Guardar). 8. Espera hasta 10 minutos para que los datos comiencen a recopilarse y, a continuación, consulta el dashboard de resumen de AWS para ver las métricas enviadas por tus servicios e infraestructura de AWS . -*\* Cualquier uso de los servicios Datadog en China continental (o relacionados con entornos de esta localización) está sujeto a la cláusula de exención de responsabilidad, publicada en la sección [Localizaciones con restricciones de servicio][2] de nuestro sitio web.* +\*{{% mainland-china-disclaimer %}} [1]: https://app.datadoghq.com/integrations/amazon-web-services -[2]: https://www.datadoghq.com/legal/restricted-service-locations/ {{% /tab %}} {{< /tabs >}} diff --git a/content/es/integrations/guide/aws-terraform-setup.md b/content/es/integrations/guide/aws-terraform-setup.md index 794062073fe52..0cf7400dcbf26 100644 --- a/content/es/integrations/guide/aws-terraform-setup.md +++ b/content/es/integrations/guide/aws-terraform-setup.md @@ -12,63 +12,98 @@ title: La integración de AWS con Terraform Mediante el uso de [Terraform][1], puedes crear el rol IAM de Datadog, el documento de política y la integración Datadog-AWS con un único comando `terraform apply`. 1. Configura el proveedor de Terraform en Datadog][2] para interactuar con la API de Datadog a través de una configuración de Terraform. - * Si aún no lo ha hecho, configure `api_url` con la URL de la API de su sitio Datadog. + * Si aún no lo has hecho, configura `api_url` con la URL de la API de tu sitio Datadog. * **Nota**: El recurso `datadog_integration_aws_account` sustituyó al recurso `datadog_integration_aws` en la versión `3.50.0` del proveedor de Datadog Terraform. Para actualizar desde el recurso `datadog_integration_aws`, consulta [Actualización desde recursos de datadog_integration_aws][3]. {{< site-region region="us,us3,us5,eu" >}} 2. Configura tu archivo de ajustes de Terraform utilizando el siguiente ejemplo como plantilla base. Asegúrate de actualizar los siguientes parámetros antes de aplicar los cambios: - * `AWS_PERMISSIONS_LIST`: Políticas de IAM que necesitan las integraciones Datadog con AWS. La lista actual está disponible en la documentación [Integración de Datadog con AWS][1]. * `AWS_ACCOUNT_ID`: El ID de tu cuenta de AWS. Consulta el [registro de Terraform][2] para obtener más ejemplos de uso y la lista completa de parámetros opcionales, así como recursos adicionales de Datadog. ```hcl data "aws_iam_policy_document" "datadog_aws_integration_assume_role" { - declaración { - acciones = ["sts:AssumeRole"] - directores { - tipo = "AWS" - identificadores = ["arn:aws:iam::464622532012:root"] + statement { + actions = ["sts:AssumeRole"] + principals { + type = "AWS" + identifiers = ["arn:aws:iam::464622532012:root"] } - condición { + condition { test = "StringEquals" variable = "sts:ExternalId" - valores = [ + values = [ "${datadog_integration_aws_account.datadog_integration.auth_config.aws_auth_config_role.external_id}" ] } } } +data "datadog_integration_aws_iam_permissions" "datadog_permissions" {} + +locals { + all_permissions = data.datadog_integration_aws_iam_permissions.datadog_permissions.iam_permissions + + max_policy_size = 6144 + target_chunk_size = 5900 + + permission_sizes = [ + for perm in local.all_permissions : + length(perm) + 3 + ] + cumulative_sizes = [ + for i in range(length(local.permission_sizes)) : + sum(slice(local.permission_sizes, 0, i + 1)) + ] + + chunk_assignments = [ + for cumulative_size in local.cumulative_sizes : + floor(cumulative_size / local.target_chunk_size) + ] + chunk_numbers = distinct(local.chunk_assignments) + permission_chunks = [ + for chunk_num in local.chunk_numbers : [ + for i, perm in local.all_permissions : + perm if local.chunk_assignments[i] == chunk_num + ] + ] +} + data "aws_iam_policy_document" "datadog_aws_integration" { - declaración { - acciones = [] + count = length(local.permission_chunks) + + statement { + actions = local.permission_chunks[count.index] resources = ["*"] } } -recurso "aws_iam_policy" "datadog_aws_integration" { - name = "DatadogAWS IntegrationPolicy" - policy = data.aws_iam_policy_document.datadog_aws_integration.json +resource "aws_iam_policy" "datadog_aws_integration" { + count = length(local.permission_chunks) + + name = "DatadogAWSIntegrationPolicy-${count.index + 1}" + policy = data.aws_iam_policy_document.datadog_aws_integration[count.index].json } resource "aws_iam_role" "datadog_aws_integration" { - name = "DatadogIntegrationRole" - description = "Rol para Datadog AWS Integración" + name = "DatadogIntegrationRole" + description = "Role for Datadog AWS Integration" assume_role_policy = data.aws_iam_policy_document.datadog_aws_integration_assume_role.json } resource "aws_iam_role_policy_attachment" "datadog_aws_integration" { - rol = aws_iam_role.datadog_aws_integration.name - policy_arn = aws_iam_policy.datadog_aws_integration.arn + count = length(local.permission_chunks) + + role = aws_iam_role.datadog_aws_integration.name + policy_arn = aws_iam_policy.datadog_aws_integration[count.index].arn } resource "aws_iam_role_policy_attachment" "datadog_aws_integration_security_audit" { - rol = aws_iam_role.datadog_aws_integration.name + role = aws_iam_role.datadog_aws_integration.name policy_arn = "arn:aws:iam::aws:policy/SecurityAudit" } resource "datadog_integration_aws_account" "datadog_integration" { - account_tags = [] + account_tags = [] aws_account_id = "" - aws_partition = "aws" + aws_partition = "aws" aws_regions { include_all = true } @@ -77,15 +112,15 @@ resource "datadog_integration_aws_account" "datadog_integration" { role_name = "DatadogIntegrationRole" } } - resources_config { + resources_config { cloud_security_posture_management_collection = false - extended_collection = true + extended_collection = true } traces_config { xray_services { } } - logs_config { + logs_config { lambda_forwarder { } } @@ -96,7 +131,7 @@ resource "datadog_integration_aws_account" "datadog_integration" { } ``` -
Nota: Por defecto, la configuración anterior no incluye Cloud Security. Para habilitar Cloud Security, en resources_config, establezca cloud_security_posture_management_collection = true.
+
Por defecto, la configuración anterior no incluye Cloud Security. Para habilitar Cloud Security, en resources_config, establece cloud_security_posture_management_collection = true.
[1]: /es/integrations/amazon_web_services/?tab=manual#aws-iam-permissions [2]: https://registry.terraform.io/providers/DataDog/datadog/latest/docs/resources/integration_aws_account @@ -104,58 +139,93 @@ resource "datadog_integration_aws_account" "datadog_integration" { {{< site-region region="ap1" >}} 2. Configura tu archivo de ajustes de Terraform utilizando el siguiente ejemplo como plantilla base. Asegúrate de actualizar los siguientes parámetros antes de aplicar los cambios: - * `AWS_PERMISSIONS_LIST`: Políticas de IAM que necesitan las integraciones Datadog con AWS. La lista actual está disponible en la documentación [Integración de Datadog con AWS][1]. * `AWS_ACCOUNT_ID`: El ID de tu cuenta de AWS. Consulta el [registro de Terraform][2] para obtener más ejemplos de uso y la lista completa de parámetros opcionales, así como recursos adicionales de Datadog. ```hcl data "aws_iam_policy_document" "datadog_aws_integration_assume_role" { - declaración { - acciones = ["sts:AssumeRole"] - directores { - tipo = "AWS" - identificadores = ["arn:aws:iam::417141415827:root"] + statement { + actions = ["sts:AssumeRole"] + principals { + type = "AWS" + identifiers = ["arn:aws:iam::417141415827:root"] } - condición { + condition { test = "StringEquals" variable = "sts:ExternalId" - valores = [ + values = [ "${datadog_integration_aws_account.datadog_integration.auth_config.aws_auth_config_role.external_id}" ] } } } +data "datadog_integration_aws_iam_permissions" "datadog_permissions" {} + +locals { + all_permissions = data.datadog_integration_aws_iam_permissions.datadog_permissions.iam_permissions + + max_policy_size = 6144 + target_chunk_size = 5900 + + permission_sizes = [ + for perm in local.all_permissions : + length(perm) + 3 + ] + cumulative_sizes = [ + for i in range(length(local.permission_sizes)) : + sum(slice(local.permission_sizes, 0, i + 1)) + ] + + chunk_assignments = [ + for cumulative_size in local.cumulative_sizes : + floor(cumulative_size / local.target_chunk_size) + ] + chunk_numbers = distinct(local.chunk_assignments) + permission_chunks = [ + for chunk_num in local.chunk_numbers : [ + for i, perm in local.all_permissions : + perm if local.chunk_assignments[i] == chunk_num + ] + ] +} + data "aws_iam_policy_document" "datadog_aws_integration" { - declaración { - acciones = [] + count = length(local.permission_chunks) + + statement { + actions = local.permission_chunks[count.index] resources = ["*"] } } -recurso "aws_iam_policy" "datadog_aws_integration" { - name = "DatadogAWS IntegrationPolicy" - policy = data.aws_iam_policy_document.datadog_aws_integration.json +resource "aws_iam_policy" "datadog_aws_integration" { + count = length(local.permission_chunks) + + name = "DatadogAWSIntegrationPolicy-${count.index + 1}" + policy = data.aws_iam_policy_document.datadog_aws_integration[count.index].json } resource "aws_iam_role" "datadog_aws_integration" { - name = "DatadogIntegrationRole" - description = "Rol para Datadog AWS Integración" + name = "DatadogIntegrationRole" + description = "Role for Datadog AWS Integration" assume_role_policy = data.aws_iam_policy_document.datadog_aws_integration_assume_role.json } resource "aws_iam_role_policy_attachment" "datadog_aws_integration" { - rol = aws_iam_role.datadog_aws_integration.name - policy_arn = aws_iam_policy.datadog_aws_integration.arn + count = length(local.permission_chunks) + + role = aws_iam_role.datadog_aws_integration.name + policy_arn = aws_iam_policy.datadog_aws_integration[count.index].arn } resource "aws_iam_role_policy_attachment" "datadog_aws_integration_security_audit" { - rol = aws_iam_role.datadog_aws_integration.name + role = aws_iam_role.datadog_aws_integration.name policy_arn = "arn:aws:iam::aws:policy/SecurityAudit" } resource "datadog_integration_aws_account" "datadog_integration" { - account_tags = [] + account_tags = [] aws_account_id = "" - aws_partition = "aws" + aws_partition = "aws" aws_regions { include_all = true } @@ -164,18 +234,24 @@ resource "datadog_integration_aws_account" "datadog_integration" { role_name = "DatadogIntegrationRole" } } - resources_config { + resources_config { cloud_security_posture_management_collection = false - extended_collection = true + extended_collection = true } + + # Optionally, specify services to include for X-Ray tracing traces_config { xray_services { } } - logs_config { + + # Optionally, specify the ARN of the Datadog Forwarder Lambda function and sources to enable for automatic log collection + logs_config { lambda_forwarder { } } + + # Optionally, specify namespaces to exclude from metric collection metrics_config { namespace_filters { } @@ -183,7 +259,7 @@ resource "datadog_integration_aws_account" "datadog_integration" { } ``` -
Nota: Por defecto, la configuración anterior no incluye Cloud Security. Para habilitar Cloud Security, en resources_config, establezca cloud_security_posture_management_collection = true.
+
Por defecto, la configuración anterior no incluye Cloud Security. Para habilitar Cloud Security, en resources_config, establece cloud_security_posture_management_collection = true.
[1]: /es/integrations/amazon_web_services/?tab=manual#aws-iam-permissions [2]: https://registry.terraform.io/providers/DataDog/datadog/latest/docs/resources/integration_aws @@ -191,58 +267,93 @@ resource "datadog_integration_aws_account" "datadog_integration" { {{< site-region region="ap2" >}} 2. Configura tu archivo de ajustes de Terraform utilizando el siguiente ejemplo como plantilla base. Asegúrate de actualizar los siguientes parámetros antes de aplicar los cambios: - * `AWS_PERMISSIONS_LIST`: Políticas de IAM que necesitan las integraciones Datadog con AWS. La lista actual está disponible en la documentación [Integración de Datadog con AWS][1]. * `AWS_ACCOUNT_ID`: El ID de tu cuenta de AWS. Consulta el [registro de Terraform][2] para obtener más ejemplos de uso y la lista completa de parámetros opcionales, así como recursos adicionales de Datadog. ```hcl data "aws_iam_policy_document" "datadog_aws_integration_assume_role" { - declaración { - acciones = ["sts:AssumeRole"] - directores { - tipo = "AWS" - identificadores = ["arn:aws:iam::412381753143:root"] + statement { + actions = ["sts:AssumeRole"] + principals { + type = "AWS" + identifiers = ["arn:aws:iam::412381753143:root"] } - condición { + condition { test = "StringEquals" variable = "sts:ExternalId" - valores = [ + values = [ "${datadog_integration_aws_account.datadog_integration.auth_config.aws_auth_config_role.external_id}" ] } } } +data "datadog_integration_aws_iam_permissions" "datadog_permissions" {} + +locals { + all_permissions = data.datadog_integration_aws_iam_permissions.datadog_permissions.iam_permissions + + max_policy_size = 6144 + target_chunk_size = 5900 + + permission_sizes = [ + for perm in local.all_permissions : + length(perm) + 3 + ] + cumulative_sizes = [ + for i in range(length(local.permission_sizes)) : + sum(slice(local.permission_sizes, 0, i + 1)) + ] + + chunk_assignments = [ + for cumulative_size in local.cumulative_sizes : + floor(cumulative_size / local.target_chunk_size) + ] + chunk_numbers = distinct(local.chunk_assignments) + permission_chunks = [ + for chunk_num in local.chunk_numbers : [ + for i, perm in local.all_permissions : + perm if local.chunk_assignments[i] == chunk_num + ] + ] +} + data "aws_iam_policy_document" "datadog_aws_integration" { - declaración { - acciones = [] + count = length(local.permission_chunks) + + statement { + actions = local.permission_chunks[count.index] resources = ["*"] } } -recurso "aws_iam_policy" "datadog_aws_integration" { - name = "DatadogAWS IntegrationPolicy" - policy = data.aws_iam_policy_document.datadog_aws_integration.json +resource "aws_iam_policy" "datadog_aws_integration" { + count = length(local.permission_chunks) + + name = "DatadogAWSIntegrationPolicy-${count.index + 1}" + policy = data.aws_iam_policy_document.datadog_aws_integration[count.index].json } resource "aws_iam_role" "datadog_aws_integration" { - name = "DatadogIntegrationRole" - description = "Rol para Datadog AWS Integración" + name = "DatadogIntegrationRole" + description = "Role for Datadog AWS Integration" assume_role_policy = data.aws_iam_policy_document.datadog_aws_integration_assume_role.json } resource "aws_iam_role_policy_attachment" "datadog_aws_integration" { - rol = aws_iam_role.datadog_aws_integration.name - policy_arn = aws_iam_policy.datadog_aws_integration.arn + count = length(local.permission_chunks) + + role = aws_iam_role.datadog_aws_integration.name + policy_arn = aws_iam_policy.datadog_aws_integration[count.index].arn } resource "aws_iam_role_policy_attachment" "datadog_aws_integration_security_audit" { - rol = aws_iam_role.datadog_aws_integration.name + role = aws_iam_role.datadog_aws_integration.name policy_arn = "arn:aws:iam::aws:policy/SecurityAudit" } resource "datadog_integration_aws_account" "datadog_integration" { - account_tags = [] + account_tags = [] aws_account_id = "" - aws_partition = "aws" + aws_partition = "aws" aws_regions { include_all = true } @@ -251,15 +362,15 @@ resource "datadog_integration_aws_account" "datadog_integration" { role_name = "DatadogIntegrationRole" } } - resources_config { + resources_config { cloud_security_posture_management_collection = false - extended_collection = true + extended_collection = true } traces_config { xray_services { } } - logs_config { + logs_config { lambda_forwarder { } } @@ -270,66 +381,217 @@ resource "datadog_integration_aws_account" "datadog_integration" { } ``` -
Nota: Por defecto, la configuración anterior no incluye Cloud Security. Para habilitar Cloud Security, en resources_config, establezca cloud_security_posture_management_collection = true.
+
Por defecto, la configuración anterior no incluye Cloud Security. Para habilitar Cloud Security, en resources_config, establece cloud_security_posture_management_collection = true.
[1]: /es/integrations/amazon_web_services/?tab=manual#aws-iam-permissions [2]: https://registry.terraform.io/providers/DataDog/datadog/latest/docs/resources/integration_aws {{< /site-region >}} {{< site-region region="gov" >}} -2. Configura tu archivo de ajustes de Terraform utilizando el siguiente ejemplo como plantilla base. Asegúrate de actualizar los siguientes parámetros antes de aplicar los cambios: - * `AWS_PERMISSIONS_LIST`: Políticas de IAM que necesitan las integraciones Datadog con AWS. La lista actual está disponible en la documentación [Integración de Datadog con AWS][1]. +2. Selecciona la pestaña correspondiente a tu tipo de cuenta de AWS y, a continuación, utiliza el ejemplo siguiente como plantilla base para configurar tu archivo de configuración de Terraform. Asegúrate de actualizar los siguientes parámetros antes de aplicar los cambios: * `AWS_ACCOUNT_ID`: El ID de tu cuenta de AWS. -Consulta el [registro de Terraform][2] para obtener más ejemplos de uso y la lista completa de parámetros opcionales, así como recursos adicionales de Datadog. +{{< tabs >}} + +{{% tab "AWS Commercial Cloud" %}} ```hcl data "aws_iam_policy_document" "datadog_aws_integration_assume_role" { - declaración { - acciones = ["sts:AssumeRole"] - directores { - tipo = "AWS" - identificadores = ["arn:aws:iam::065115117704:root"] + statement { + actions = ["sts:AssumeRole"] + principals { + type = "AWS" + identifiers = ["arn:aws:iam::392588925713:root"] } - condición { + condition { test = "StringEquals" variable = "sts:ExternalId" - valores = [ + values = [ "${datadog_integration_aws_account.datadog_integration.auth_config.aws_auth_config_role.external_id}" ] } } } +data "datadog_integration_aws_iam_permissions" "datadog_permissions" {} + +locals { + all_permissions = data.datadog_integration_aws_iam_permissions.datadog_permissions.iam_permissions + + max_policy_size = 6144 + target_chunk_size = 5900 + + permission_sizes = [ + for perm in local.all_permissions : + length(perm) + 3 + ] + cumulative_sizes = [ + for i in range(length(local.permission_sizes)) : + sum(slice(local.permission_sizes, 0, i + 1)) + ] + + chunk_assignments = [ + for cumulative_size in local.cumulative_sizes : + floor(cumulative_size / local.target_chunk_size) + ] + chunk_numbers = distinct(local.chunk_assignments) + permission_chunks = [ + for chunk_num in local.chunk_numbers : [ + for i, perm in local.all_permissions : + perm if local.chunk_assignments[i] == chunk_num + ] + ] +} + data "aws_iam_policy_document" "datadog_aws_integration" { - declaración { - acciones = [] + count = length(local.permission_chunks) + + statement { + actions = local.permission_chunks[count.index] resources = ["*"] } } -recurso "aws_iam_policy" "datadog_aws_integration" { - name = "DatadogAWS IntegrationPolicy" - policy = data.aws_iam_policy_document.datadog_aws_integration.json +resource "aws_iam_policy" "datadog_aws_integration" { + count = length(local.permission_chunks) + + name = "DatadogAWSIntegrationPolicy-${count.index + 1}" + policy = data.aws_iam_policy_document.datadog_aws_integration[count.index].json } resource "aws_iam_role" "datadog_aws_integration" { - name = "DatadogIntegrationRole" - description = "Rol para Datadog AWS Integración" + name = "DatadogIntegrationRole" + description = "Role for Datadog AWS Integration" assume_role_policy = data.aws_iam_policy_document.datadog_aws_integration_assume_role.json } resource "aws_iam_role_policy_attachment" "datadog_aws_integration" { - rol = aws_iam_role.datadog_aws_integration.name - policy_arn = aws_iam_policy.datadog_aws_integration.arn + count = length(local.permission_chunks) + + role = aws_iam_role.datadog_aws_integration.name + policy_arn = aws_iam_policy.datadog_aws_integration[count.index].arn } resource "aws_iam_role_policy_attachment" "datadog_aws_integration_security_audit" { - rol = aws_iam_role.datadog_aws_integration.name + role = aws_iam_role.datadog_aws_integration.name policy_arn = "arn:aws:iam::aws:policy/SecurityAudit" } resource "datadog_integration_aws_account" "datadog_integration" { - account_tags = [] + account_tags = [] + aws_account_id = "" + aws_partition = "aws" + aws_regions { + include_all = true + } + auth_config { + aws_auth_config_role { + role_name = "DatadogIntegrationRole" + } + } + resources_config { + cloud_security_posture_management_collection = false + extended_collection = true + } + traces_config { + xray_services { + } + } + logs_config { + lambda_forwarder { + } + } + metrics_config { + namespace_filters { + } + } +} +``` + +{{% /tab %}} + +{{% tab "AWS GovCloud" %}} + +```hcl +data "aws_iam_policy_document" "datadog_aws_integration_assume_role" { + statement { + actions = ["sts:AssumeRole"] + principals { + type = "AWS" + identifiers = ["arn:aws-us-gov:iam::065115117704:root"] + } + condition { + test = "StringEquals" + variable = "sts:ExternalId" + values = [ + "${datadog_integration_aws_account.datadog_integration.auth_config.aws_auth_config_role.external_id}" + ] + } + } +} + +data "datadog_integration_aws_iam_permissions" "datadog_permissions" {} + +locals { + all_permissions = data.datadog_integration_aws_iam_permissions.datadog_permissions.iam_permissions + + max_policy_size = 6144 + target_chunk_size = 5900 + + permission_sizes = [ + for perm in local.all_permissions : + length(perm) + 3 + ] + cumulative_sizes = [ + for i in range(length(local.permission_sizes)) : + sum(slice(local.permission_sizes, 0, i + 1)) + ] + + chunk_assignments = [ + for cumulative_size in local.cumulative_sizes : + floor(cumulative_size / local.target_chunk_size) + ] + chunk_numbers = distinct(local.chunk_assignments) + permission_chunks = [ + for chunk_num in local.chunk_numbers : [ + for i, perm in local.all_permissions : + perm if local.chunk_assignments[i] == chunk_num + ] + ] +} + +data "aws_iam_policy_document" "datadog_aws_integration" { + count = length(local.permission_chunks) + + statement { + actions = local.permission_chunks[count.index] + resources = ["*"] + } +} + +resource "aws_iam_policy" "datadog_aws_integration" { + count = length(local.permission_chunks) + + name = "DatadogAWSIntegrationPolicy-${count.index + 1}" + policy = data.aws_iam_policy_document.datadog_aws_integration[count.index].json +} +resource "aws_iam_role" "datadog_aws_integration" { + name = "DatadogIntegrationRole" + description = "Role for Datadog AWS Integration" + assume_role_policy = data.aws_iam_policy_document.datadog_aws_integration_assume_role.json +} +resource "aws_iam_role_policy_attachment" "datadog_aws_integration" { + count = length(local.permission_chunks) + + role = aws_iam_role.datadog_aws_integration.name + policy_arn = aws_iam_policy.datadog_aws_integration[count.index].arn +} +resource "aws_iam_role_policy_attachment" "datadog_aws_integration_security_audit" { + role = aws_iam_role.datadog_aws_integration.name + policy_arn = "arn:aws-us-gov:iam::aws:policy/SecurityAudit" +} + +resource "datadog_integration_aws_account" "datadog_integration" { + account_tags = [] aws_account_id = "" - aws_partition = "aws" + aws_partition = "aws-us-gov" aws_regions { include_all = true } @@ -338,15 +600,15 @@ resource "datadog_integration_aws_account" "datadog_integration" { role_name = "DatadogIntegrationRole" } } - resources_config { + resources_config { cloud_security_posture_management_collection = false - extended_collection = true + extended_collection = true } traces_config { xray_services { } } - logs_config { + logs_config { lambda_forwarder { } } @@ -357,7 +619,13 @@ resource "datadog_integration_aws_account" "datadog_integration" { } ``` -
Nota: Por defecto, la configuración anterior no incluye Cloud Security. Para habilitar Cloud Security, en resources_config, establezca cloud_security_posture_management_collection = true.
+{{% /tab %}} + +{{< /tabs >}} + +Consulta el [registro de Terraform][2] para obtener más ejemplos de uso y la lista completa de parámetros opcionales, así como recursos adicionales de Datadog. + +
Por defecto, la configuración anterior no incluye Cloud Security. Para habilitar Cloud Security, en resources_config, establece cloud_security_posture_management_collection = true.
[1]: /es/integrations/amazon_web_services/?tab=manual#aws-iam-permissions [2]: https://registry.terraform.io/providers/DataDog/datadog/latest/docs/resources/integration_aws diff --git a/content/es/integrations/guide/source-code-integration.md b/content/es/integrations/guide/source-code-integration.md index 1139b3bb1d606..3e08cdfb007ff 100644 --- a/content/es/integrations/guide/source-code-integration.md +++ b/content/es/integrations/guide/source-code-integration.md @@ -316,7 +316,7 @@ Si utilizas un host, tienes dos opciones: utilizar Microsoft SourceLink o config Si utilizas contenedores de Docker, tienes varias opciones: utilizar un complemento si tu aplicación está empaquetada, utilizar Docker, o configurar tu aplicación con variables de entorno `DD_GIT_*`. -##### Opción 1: Complemento empaquetador +##### Opción 1: complemento empaquetador {{% sci-dd-tags-bundled-node-js %}} @@ -332,7 +332,7 @@ Si utilizas contenedores de Docker, tienes varias opciones: utilizar un compleme Si estás utilizando Serverless, tienes varias opciones dependiendo de la configuración de tu aplicación serverless. -##### Opción 1: Complemento empaquetador +##### Opción 1: complemento empaquetador {{% sci-dd-tags-bundled-node-js %}} @@ -348,7 +348,7 @@ Si estás utilizando Serverless, tienes varias opciones dependiendo de la config Para entornos basados en host, tienes dos opciones basadas en tu configuración de compilación y despliegue. -##### Opción 1: Complemento empaquetador +##### Opción 1: complemento empaquetador {{% sci-dd-tags-bundled-node-js %}} @@ -429,7 +429,7 @@ Si utilizas un host, configura tu aplicación con variables de entorno `DD_GIT_* {{% /tab %}} {{% tab "PHP" %}} -
Se requiere la biblioteca del cliente PHP versión 1.2.0 o posterior.
+
Se requiere la versión 1.13.0 o posterior de la biblioteca cliente de PHP o 1.2.0 o posterior si solo se utiliza el rastreo sin la creación de perfiles.
#### Contenedores @@ -593,6 +593,16 @@ Para más información, consulta la [documentación de Dynamic Instrumentation][ ### Comentarios en solicitudes pull +
+ Los comentarios PR no son compatibles en solicitudes de incorporación de cambios en repositorios públicos o en solicitudes de incorporación de cambios que se dirijan a una rama de destino en un repositorio diferente de la rama source (fuente) (es decir, repositorios bifurcados que intentan fusionarse en el repositorio principal). +
+ +Los comentarios PR son comentarios automáticos añadidos por las [integraciones de gestión de código de source (fuente)][10] de Datadog para informar a los desarrolladores de los problemas detectados en sus cambios de código y, en ciertos casos, sugerir correcciones. + +Hay un máximo de 31 comentarios únicos por RP en cualquier momento para reducir el ruido y el desorden. Estos comentarios incluyen: +* Siempre se publica un comentario resumen para ofrecer una visión de alto nivel de todos los problemas que Datadog ha detectado en el PR. Este comentario es editado por Datadog a medida que nuevas confirmaciones añadidas al PR cambian los resultados. +* Cuando proceda, se publicarán hasta 30 comentarios en línea sobre las líneas de código específicas que hayan provocado una infracción. Si se introducen más de 30 infracciones en la diferencia del PR, se publican las 30 infracciones de mayor gravedad. + {{< tabs >}} {{% tab "CI Visibility" %}} Los comentarios de solicitud pull están habilitados por defecto cuando se accede por primera vez a CI Visibility si la integración con GitHub o GitLab está instalada correctamente. Estas integraciones publican un comentario resumiendo los trabajos fallidos detectados en tu solicitud pull. @@ -645,4 +655,5 @@ Para desactivar los comentarios en solicitudes pull para Test Optimization, ve a [6]: /es/tracing/ [7]: https://app.datadoghq.com/source-code/setup/apm [8]: /es/tracing/error_tracking/ -[9]: /es/tracing/trace_collection/dd_libraries/ \ No newline at end of file +[9]: /es/tracing/trace_collection/dd_libraries/ +[10]: #source-code-management-providers \ No newline at end of file diff --git a/content/es/logs/explorer/advanced_search.md b/content/es/logs/explorer/advanced_search.md index 3fa2726aa264f..1bd955461dc18 100644 --- a/content/es/logs/explorer/advanced_search.md +++ b/content/es/logs/explorer/advanced_search.md @@ -36,8 +36,8 @@ Esto introduce nuevos elementos en el editor de consultas: 1. Define tu filtro de subconsulta en el campo **from** (de). 1. En el menú desplegable **Select Column** (Seleccionar columna) que precede al filtro de la subconsulta, selecciona el atributo por el que deseas agrupar y ordenar los resultados de la subconsulta. 1. Selecciona si deseas utilizar el operador **IN** o **NOT IN**: - - Los resultados del operador **IN** solo incluyen logs cuando el valor del atributo también se encuentra en los resultados de la subconsulta. Por ejemplo, si solo deseas ver logs generados por `service:a` y está asociado a un usuario que también es uno de los principales usuarios de `service:b`. - - Los resultados del operador **NOT IN** excluyen logs donde se encuentra el valor del atributo en los resultados de la subconsulta. Por ejemplo, si solo deseas ver logs `status:error`, pero también deseas filtrar logs `status:error` donde los usuarios asociados a esos logs acaben finalmente con un log `status:success`. Consulta [Filtrar logs desactualizados o sustituidos](#filter-outdated-or-superseded-logs) para ver un ejemplo detallado. + - Los resultados del operador **IN** solo incluyen los logs en los que el valor del atributo también se encuentra en los resultados de la subconsulta. Por ejemplo, si solo deseas ver los logs generados por `service:a` y asociados a un usuario que también es uno de los principales usuarios de `service:b`. + - Los resultados del operador **NOT IN** excluyen los logs en los que se encuentra el valor del atributo en los resultados de la subconsulta. Por ejemplo, si solo deseas ver logs `status:error`, pero también deseas filtrar logs `status:error` en los que los usuarios asociados a esos logs acaben finalmente con un log `status:success`. Consulta [Filtrar logs obsoletos o sustituidos](#filter-outdated-or-superseded-logs) para ver un ejemplo detallado. 1. Opcionalmente, reduce el número de valores de atributos de subconsulta con los que comparar. El valor por defecto y máximo es `1000`. Elige entre **top** (principal) (valores de mayor frecuencia) o **bottom** (inferior) (valores de menor frecuencia). ### Ejemplos de subconsultas diff --git a/content/es/logs/explorer/facets.md b/content/es/logs/explorer/facets.md index 0b924bae50c1a..5ad3b8e61d2e8 100644 --- a/content/es/logs/explorer/facets.md +++ b/content/es/logs/explorer/facets.md @@ -221,7 +221,7 @@ Esta es la mejor opción si incorporas logs desde nuevas fuentes. En lugar de cr ## Borrar una faceta -
Borrar una faceta que está siendo utilizada en índices, monitores, dashboards, consultas de restricción o por otros equipos puede causar que las configuraciones se rompan.
+
La eliminación de una faceta que está siendo utilizada en índices, monitores, dashboards, consultas de restricción, o por otros equipos puede causar que las configuraciones se rompan.
Para eliminar una faceta, sigue estos pasos: diff --git a/content/es/logs/guide/docker-logs-collection-troubleshooting-guide.md b/content/es/logs/guide/docker-logs-collection-troubleshooting-guide.md index 930fd80cb98a3..b4671dbbc86f8 100644 --- a/content/es/logs/guide/docker-logs-collection-troubleshooting-guide.md +++ b/content/es/logs/guide/docker-logs-collection-troubleshooting-guide.md @@ -84,7 +84,7 @@ Cuando se recopilan logs del contenedor de Docker de archivos, el Agent recurre Status: Error: file /var/lib/docker/containers/ce0bae54880ad75b7bf320c3d6cac1ef3efda21fc6787775605f4ba8b6efc834/ce0bae54880ad75b7bf320c3d6cac1ef3efda21fc6787775605f4ba8b6efc834-json.log does not exist ``` -Este estado significa que el Agent no puede encontrar un archivo de log para un determinado contenedor. Para resolver este problema, comprueba que la carpeta que contiene logs del contenedor de Docker está correctamente expuesta al contenedor del Datadog Agent. En Linux, esto corresponde a `-v /var/lib/Docker/containers:/var/lib/Docker/containers:ro` on the command line starting the Agent container, whereas on Windows it corresponds to `-v c:/programdata/Docker/containers:c:/programdata/Docker/containers:ro`. Note that the directory relative to the underlying host may be different due to specific configuration of the Docker daemon—this is not an issue pending a correct Docker volume mapping. For example, use `-v /data/Docker/containers:/var/lib/Docker/containers:ro` if the Docker data directory has been relocated to `/data/Docker` en el subyacente host. +Este estado significa que el Agent no puede encontrar un archivo de log para un determinado contenedor. Para resolver este problema, comprueba que la carpeta que contiene logs del contenedor de Docker está correctamente expuesta al contenedor del Datadog Agent. En Linux, esto corresponde a `-v /var/lib/docker/containers:/var/lib/docker/containers:ro` on the command line starting the Agent container, whereas on Windows it corresponds to `-v c:/programdata/docker/containers:c:/programdata/docker/containers:ro`. Note that the directory relative to the underlying host may be different due to specific configuration of the Docker daemon—this is not an issue pending a correct Docker volume mapping. For example, use `-v /data/docker/containers:/var/lib/docker/containers:ro` if the Docker data directory has been relocated to `/data/docker` en el subyacente host. Si se recopilan logs pero las líneas individuales parecen estar divididas, comprueba que el daemon Docker utiliza el [controlador de gestión de logs JSON](#your-containers-are-not-using-the-json-logging-driver). @@ -134,30 +134,6 @@ Si el estado del Logs Agent de logs se parece al ejemplo en [Comprobar el estado * El puerto requerido (10516) para enviar logs a Datadog está bloqueado. * Tu contenedor está utilizando un controlador de gestión de logs diferente del que espera el Agent. -#### El tráfico saliente en el puerto 10516 está bloqueado - -El Datadog Agent envía sus logs a Datadog a través de TCP utilizando el puerto 10516. Si esa conexión no está disponible, los logs no se pueden enviar y se registra un error en el archivo `agent.log`. - -Puedes probar manualmente tu conexión utilizando OpenSSL, GnuTLS u otro cliente SSL/TLS. Para OpenSSL, ejecuta el siguiente comando: - -```shell -openssl s_client -connect intake.logs.datadoghq.com:10516 -``` - -Para GnuTLS, ejecuta el siguiente comando: - -```shell -gnutls-cli intake.logs.datadoghq.com:10516 -``` - -Y luego, enviando un log como el siguiente: - -```texto - este es un mensaje de prueba -``` - -Si abrir el puerto 10516 no es una opción, es posible configurar el Datadog Agent para enviar logs a través de HTTPS configurando la variable de entorno `DD_LOGS_CONFIG_FORCE_USE_HTTP` en `true`: - #### Tus contenedores no están utilizando el controlador de gestión de logs JSON El controlador de gestión de logs predeterminado de Docker es el json-file, por lo que es lo primero que el Agent de contenedor intenta leer. Si tus contenedores están configurados para utilizar un controlador de gestión de logs diferente, el Logs Agent indica que puede encontrar tus contenedores sin problemas, pero que no puede recopilar tus logs. El Agent de contenedor también puede configurarse para leer desde el controlador de gestión de logs journald. diff --git a/content/es/logs/guide/forwarder.md b/content/es/logs/guide/forwarder.md index a002be874e060..9f318f232c0f2 100644 --- a/content/es/logs/guide/forwarder.md +++ b/content/es/logs/guide/forwarder.md @@ -117,13 +117,27 @@ Las variables de entorno proporcionadas en Si tienes problemas para actualizar a la última versión, consulta la sección Solucionar problemas. +### Actualizar a v5.0.0+ + +**Antes de actualizar, revisa el [CHANGELOG.md][25] para obtener información detallada sobre los cambios de última hora y los requisitos de migración. + +Principales cambios en la versión 5.0.0: + +- **Se ha modificado el comportamiento de filtrado de logs**: `IncludeAtMatch` y `ExcludeAtMatch` ahora solo coinciden con el mensaje de log, no con toda la estructura JSON. +- **Transporte TCP eliminado**: el parámetro `DD_USE_TCP` ha sido eliminado, todos los logs deben utilizar HTTP/HTTPS +- **Variable de PrivateLink eliminada**: `DD_USE_PRIVATE_LINK` ha sido eliminado (PrivateLink sigue siendo compatible a través de `DdUseVPC`) +- **Nuevo enriquecimiento de etiquetas**: enriquecimiento de etiquetas basado en backend activado por defecto a través de `DdEnrichS3Tags` y `DdEnrichCloudwatchTags`, lo que reduce los costes de reenvío. + ### Actualizar una versión anterior a 4.13.0+ + A partir de la versión 4.13.0+, la función Lambda se ha actualizado para requerir **Python 3.13**. Si actualizas una instalación de forwarder anterior a 4.13.0+, asegúrate de que la función de AWS Lambda está configurada para utilizar Python 3.13. ### Actualizar una versión anterior a 4.3.0+ + A partir de la versión 4.3.0 el Lambda forwarder admitirá una única versión de python. La versión de Python admitida en esta versión es la 3.12. ### Actualizar una versión anterior a v4.0.0 + A partir de la versión 4.0.0, la lógica de identificación de `source`, `service` y `host` se extraerá del código del Forwarder Lambda y se instalará directamente en el backend de Datadog. La primera fuente de logs migrada es `RDS`. Esto no supone un cambio radical en la forma en que `source`, `service` y `host` se configuran del lado del `Log explorer`. Los usuarios deberían seguir teniendo el mismo comportamiento que antes. @@ -162,8 +176,8 @@ A partir de la versión 3.0.0, la función Lambda del Forwarder se gestiona util 4. Asegúrate de que el nuevo Forwarder funciona como se espera, por ejemplo, que se invoca regularmente sin errores. 5. Asegúrate de que los logs de los activadores migrados (fuentes) aparecen en el explorador de logs de Datadog y que su aspecto es correcto. 6. Migra todos los activadores al nuevo Forwarder. - - Si has dejado que Datadog gestione los activadores [automáticamente][6], actualiza el ARN de Lambda del Forwarder en la pestaña **Log Collection** (Recopilación de logs) de la página de integraciones AWS. - - Si has gestionado los activadores [manualmente][7], entonces tienes que migrarlos manualmente (o utilizando un script). + - Si has dejado que Datadog gestione los activadores [automáticamente][6], actualiza el ARN de Lambda del Forwarder en la pestaña **Log Collection** (Recopilación de logs) de la página de integraciones AWS. + - Si has gestionado los activadores [manualmente][7], entonces tienes que migrarlos manualmente (o utilizando un script). 7. Asegúrate de que el recuento de invocaciones de la función Lambda del antiguo Forwarder baja a cero. 8. Elimina la función Lambda del antiguo Forwarder cuando lo creas conveniente. 9. Si tienes instaladas funciones Lambda del antiguo Forwarder en varias cuentas y regiones AWS, repite los pasos anteriores en cada combinación de cuenta y región. @@ -187,7 +201,7 @@ Datadog recomienda ajustar los parámetros de tu Forwarder a través de CloudFor No olvides comprobar si el problema ya se ha solucionado en las últimas [versiones][9]. -### Registro +### Generación de logs Configura la variable de entorno `DD_LOG_LEVEL` como `debug` en la función Lambda del Forwarder para habilitar temporalmente la gestión de logs detallada (no olvides eliminarla). La depuración de logs debería poder mostrarte la carga útil de eventos exacta que recibe la función Lambda y la carga útil de datos (logs, métricas o trazas) que se envían a Datadog. @@ -217,42 +231,42 @@ Nos encantan las solicitudes de extracción. Aquí tienes una guía rápida. 1. Si quieres discutir una función o la corrección de errores antes de la implementación, ponte en contacto con nosotros en el canal `#serverless` de la [Comunidad Slack Datadog][11]. 1. Bifurca, clona y crea una rama: - ```bash - git clone git@github.com:/datadog-serverless-functions.git - git checkout -b - ``` + ```bash + git clone git@github.com:/datadog-serverless-functions.git + git checkout -b + ``` 1. Realiza cambios en el código. 1. Crea utilizando tus cambios locales. - ```bash - cd aws/logs_monitoring - ./tools/build_bundle.sh # any unique version is fine - ``` + ```bash + cd aws/logs_monitoring + ./tools/build_bundle.sh # any unique version is fine + ``` 1. Actualiza tu Forwarder de test con el código modificado y pruébalo: - ```bash - # Upload in the AWS Lambda console if you don't have AWS CLI - aws lambda update-function-code \ - --region \ - --function-name \ - --zip-file fileb://.forwarder/aws-dd-forwarder-.zip - ``` + ```bash + # Upload in the AWS Lambda console if you don't have AWS CLI + aws lambda update-function-code \ + --region \ + --function-name \ + --zip-file fileb://.forwarder/aws-dd-forwarder-.zip + ``` 1. Ejecuta tests unitarios. - ``` - python -m unittest discover . # for code in Python - ./trace_forwarder/scripts/run_tests.sh # for code in Go - ``` + ``` + python -m unittest discover . # for code in Python + ./trace_forwarder/scripts/run_tests.sh # for code in Go + ``` 1. Ejecuta los tests de integraciones. - ```bash - ./tools/integration_tests/integration_tests.sh + ```bash + ./tools/integration_tests/integration_tests.sh - # to update the snapshots if changes are expected - ./tools/integration_tests/integration_tests.sh --update - ``` + # to update the snapshots if changes are expected + ./tools/integration_tests/integration_tests.sh --update + ``` 1. Si los cambios afectan a la plantilla de CloudFormation, ejecuta el test de instalación con tu propia cuenta de AWS. - ```bash - ./tools/installation_test.sh - ``` + ```bash + ./tools/installation_test.sh + ``` 1. Envíalo a tu bifurcación y [envía una solicitud de extracción][12]. ## Avanzado @@ -272,21 +286,9 @@ Puedes ejecutar el Forwarder en una subred privada de VPC y enviar datos a Datad 1. Sigue [estas instrucciones][14] para añadir los endpoints `api` , `http-logs.intake` y `trace.agent` de Datadog a tu VPC. 2. Sigue las [instrucciones][15] para añadir endpoints de AWS Secrets Manager y S3 a tu VPC. 3. Al instalar el Forwarder con la plantilla de CloudFormation: - 1. Configurar `DdUseVPC` como `true`. - 2. Configura `VPCSecurityGroupIds` y `VPCSubnetIds` en función de la configuración de tu VPC. - 3. Establece `DdFetchLambdaTags`, `DdFetchStepFunctionsTags` y `DdFetchS3Tags` en `false`, porque la API de etiquetado de grupos de recursos de AWS no admite PrivateLink. - -#### DdUsePrivateLink está obsoleto - -La opción `DdUsePrivateLink` está obsoleta desde la [v3.41.0][16]. Esta opción se utilizaba anteriormente para indicar al Forwarder que debía utilizar un conjunto especial de endpoints de PrivateLink para recibir datos: `pvtlink.api.{{< region-param key="dd_site" code="true" >}}`, `api-pvtlink.logs.{{< region-param key="dd_site" code="true" >}}` y `trace-pvtlink.agent.{{< region-param key="dd_site" code="true" >}}`. A partir de la versión 3.41.0, el Forwarder puede enviar datos a Datadog, a través de PrivateLink, utilizando los nombres comunes del DNS de los endpoints de entrada: `api.{{< region-param key="dd_site" code="true" >}}`, `http-intake.logs.{{< region-param key="dd_site" code="true" >}}` y `trace.agent.{{< region-param key="dd_site" code="true" >}}`. Por lo tanto, la opción `DdUsePrivateLink` ya no es necesaria. - -Si tienes una implementación antigua del Forwarder con `DdUsePrivateLink` configurado como `true`, puede que encuentres discordancias entre los endpoints de PrivateLink configurados y aquellos [documentados en Datadog][14], lo cual es de esperar. Aunque los endpoints de PrivateLink más antiguos se hayan eliminado de ese documento, siguen funcionando. No se requiere ningún cambio al actualizar el Forwarder. Esto significa que puedes mantener habilitado `DdUsePrivateLink` y seguir utilizando los endpoints más antiguos. - -Pero si te interesa cambiar a los nuevos endpoints, debes seguir las instrucciones actualizadas anteriores para: - -1. Configurar los nuevos endpoints en `api.{{< region-param key="dd_site" code="true" >}}`, `http-intake.logs.{{< region-param key="dd_site" code="true" >}}` y `trace.agent.{{< region-param key="dd_site" code="true" >}}`. -2. Configurar `DdUseVPC` como `true`. -3. Configurar `DdUsePrivateLink` como `false`. + 1. Configurar `DdUseVPC` como `true`. + 2. Configura `VPCSecurityGroupIds` y `VPCSubnetIds` en función de la configuración de tu VPC. + 3. Establece `DdFetchLambdaTags`, `DdFetchStepFunctionsTags` y `DdFetchS3Tags` en `false`, porque la API de etiquetado de grupos de recursos de AWS no admite PrivateLink. ### Compatibilidad de AWS con VPC y proxy @@ -295,7 +297,7 @@ Si necesitas desplegar el Forwarder en una VPC sin acceso público directo a Int 1. A menos que el Forwarder esté desplegado en una subred pública, sigue las [instrucciones][15] para añadir endpoints para Secrets Manager y S3 a la VPC, de modo que el Forwarder pueda acceder a esos servicios. 2. Actualiza tu proxy con las siguientes configuraciones ([HAproxy][17] o [NGINX][18]). Si estás utilizando otro proxy o proxy web, autoriza el dominio Datadog, por ejemplo: `.{{< region-param key="dd_site" code="true" >}}`. 3. Al instalar el Forwarder con la plantilla de CloudFormation, configura `DdUseVPC`, `VPCSecurityGroupIds` y `VPCSubnetIds`. -4. Asegúrate de que las opciones `DdFetchLambdaTags`, `DdFetchStepFunctionsTags` y `DdFetchS3Tags` están desactivadas, ya que AWS VPC aún no ofrece un endpoint para la API de etiquetado de grupos de recursos. +4. Asegúrate de que las opciones `DdFetchLambdaTags`, `DdFetchStepFunctionsTags` y `DdFetchS3Tags` están desactivadas, ya que la AWS VPC aún no ofrece un endpoint para la API de etiquetado de grupos de recursos. 5. Si utilizas HAproxy o NGINX: - Configura `DdApiUrl` como `http://:3834` o `https://:3834`. @@ -355,10 +357,6 @@ Datadog recomienda utilizar al menos 10 de concurrencia reservada, pero este val `DdMultilineLogRegexPattern` : Utiliza la expresión regular proporcionada para detectar una nueva línea de logs para logs de múltiples líneas de S3, como `\d{2}\/\d{2}\/\d{4}` para los logs de múltiples líneas que comienzan con el patrón "11/10/2014". -`DdUseTcp` -: Por defecto, el Forwarder envía logs utilizando HTTPS a través del puerto 443. Para enviar logs a través de una -conexión TCP cifrada SSL, configura este parámetro como true (verdadero). - `DdNoSsl` : Deshabilita SSL al reenviar logs y configúralo como true (verdadero) al reenviar logs a través de un proxy. @@ -402,31 +400,36 @@ conexión TCP cifrada SSL, configura este parámetro como true (verdadero). `IncludeAtMatch` : Sólo envía logs que coinciden con la expresión regular proporcionada, no excluida por `ExcludeAtMatch`. -Las reglas de filtrado se aplican a todo el log con formato JSON, incluidos los metadatos que el Forwarder. añade automáticamente Sin embargo, las transformaciones aplicadas por [pipelines de logs][21], que se producen después del envío de logs a Datadog, no pueden utilizarse para filtrar logs en el Forwarder. El uso de una expresión regular ineficaz, como `.*`, puede ralentizar el Forwarder. +Las reglas de filtrado se aplican al mensaje de log. Sin embargo, las transformaciones aplicadas por [pipelines de log][21], que se producen después de que los logs se envíen a Datadog, no pueden utilizarse para filtrar logs en el Forwarder. El uso de una expresión regular ineficiente, como `.*`, puede ralentizar el Forwarder. Los siguientes son algunos ejemplos de expresiones regulares que pueden utilizarse para el filtrado de logs: -- Incluye (o excluye) logs de la plataforma Lambda: `"(START|END) RequestId:\s`. El precedente `"` es necesario para que coincida con el inicio del mensaje del log, que está en un blob JSON (`{"message": "START RequestId...."}`). Datadog recomienda conservar los logs de `REPORT`, ya que se utilizan para rellenar la lista de invocaciones en las vistas de funciones serverless. +- Incluir (o excluir) los logs de plataforma de Lambda: `(START|END) RequestId:\s`. Datadog recomienda mantener los logs `REPORT`, ya que se utilizan para rellenar la lista de invocaciones en las vistas de funciones sin servidor. - Incluye sólo mensajes de error de CloudTrail: `errorMessage`. - Incluye sólo logs que contienen un código de error HTTP 4XX o 5XX: `\b[4|5][0-9][0-9]\b`. -- Incluye sólo logs de CloudWatch cuando el campo `message` contiene un par clave/valor JSON específico: `\"awsRegion\":\"us-east-1\"`. - - El campo de mensaje de un evento de log de CloudWatch se codifica como una cadena. Por ejemplo,`{"awsRegion": "us-east-1"}` se codifica como `{\"awsRegion\":\"us-east-1\"}`. Por lo tanto, el patrón que proporciones debe incluir `\` caracteres de escape, como en el siguiente ejemplo: `\"awsRegion\":\"us-east-1\"`. +- Incluye solo los logs de CloudWatch cuyo campo `message` contenga un par clave/valor JSON específico: `"awsRegion":"us-east-1"`. Para probar diferentes patrones en tus logs, activa la [limpieza de logs](#troubleshooting). ### Avanzado (opcional) +`DdEnrichS3Tags` +: activado por defecto. Cuando está activado, ordena al backend de Datadog que enriquezca automáticamente los logs procedentes de buckets de S3 con las etiquetas asociadas a dichos buckets. Este enfoque ofrece el mismo enriquecimiento de etiquetas que `DdFetchS3Tags`, pero aplaza la operación después de la ingesta de logs, lo que reduce la sobrecarga del Forwarder. Requiere que la [Recopilación de recursos](https://docs.datadoghq.com/integrations/amazon-web-services/#resource-collection) esté habilitada en tu integración de AWS. + +`DdEnrichCloudwatchTags` +: activado por defecto. Cuando se activa, ordena al backend de Datadog que enriquezca automáticamente logs originados en CloudWatch LogGroups con las etiquetas asociadas a esos grupos de logs. Este enfoque ofrece el mismo enriquecimiento de etiquetas que `DdFetchLogGroupTags`, pero aplaza la operación después de la ingesta de logs, reduciendo la sobrecarga del Forwarder. Requiere que la [Recopilación de recursos](https://docs.datadoghq.com/integrations/amazon-web-services/#resource-collection) esté habilitada en tu integración de AWS. + `DdFetchLambdaTags` : Permite que el Forwarder recupere etiquetas de Lambda mediante llamadas a la API de GetResources y las aplique a logs, métricas y trazas. Si se configura como true (verdadero), el permiso `tag:GetResources` se añadirá automáticamente al rol IAM de ejecución Lambda. `DdFetchLogGroupTags` -: Permite que el Forwarder obtenga etiquetas de grupo de logs mediante ListTagsLogGroup y las aplique a logs, métricas y trazas. Si se define como true, el permiso `logs:ListTagsForResource` se añadirá automáticamente al rol IAM de ejecución de Lambda. +: **OBSOLETO, usa DdEnrichCloudwatchTags]** Permite que el forwarder obtenga etiquetas de grupo de logs mediante ListTagsLogGroup y las aplique a logs, métricas y trazas. Si se establece en true, el permiso `logs:ListTagsForResource` se añadirá automáticamente al rol de IAM de ejecución de Lambda. `DdFetchStepFunctionsTags` : Permite que Forwarder recupere tags de funciones Step mediante llamadas a la API GetResources y las aplique a logs y trazas (si está habilitado el rastreo de funciones Step). Si se configura como true (verdadero), el permiso `tag:GetResources` se añadirá automáticamente al rol IAM de ejecución de Lambda. `DdFetchS3Tags` -: Permite que el forwarder recupere etiquetas de S3 mediante llamadas a la API GetResources y las aplique a logs y trazas. Si se establece en true, el permiso `tag:GetResources` se añadirá automáticamente al rol de IAM de ejecución de Lambda. +: **[OBSOLETO, usa DdEnrichS3Tags]** Permite que el forwarder obtenga etiquetas de S3 mediante llamadas a la API GetResources y las aplique a logs y trazas. Si se establece en true, el permiso `tag:GetResources` se añadirá automáticamente al rol de IAM de ejecución de Lambda. `DdStepFunctionsTraceEnabled` : Establécelo como true para activar el rastreo de todas Step Functions. @@ -437,9 +440,6 @@ Para probar diferentes patrones en tus logs, activa la [limpieza de logs](#troub `PermissionsBoundaryArn` : ARN para la política de límites de permisos. -`DdUsePrivateLink` (OBSOLETO) -: Configurado como true (verdadero) para permitir el envío de logs y métricas a través de AWS PrivateLink. Consulta [Conectarse a Datadog a través de AWS PrivateLink][2]. - `DdHttpproxyURL` : Configura las variables de entorno estándar del proxy web HTTP_PROXY y HTTPS_PROXY. Estos son los endpoints de URL que tu servidor proxy expone. No lo utilices en combinación con AWS Private Link. Asegúrate también de configurar `DdSkipSslValidation` como true (verdadero). @@ -461,11 +461,11 @@ Para probar diferentes patrones en tus logs, activa la [limpieza de logs](#troub `LayerARN` : ARN de la capa que contiene el código del Forwarder. Si está vacío, el script utilizará la versión de la capa con la que se ha publicado el Forwarder. Por defecto está vacío. - [20]: https://app.datadoghq.com/organization-settings/api-keys [13]: https://docs.datadoghq.com/es/getting_started/site/ [21]: https://docs.datadoghq.com/es/logs/processing/pipelines/ [2]: https://docs.datadoghq.com/es/logs/guide/send-aws-services-logs-with-the-datadog-lambda-function/ + {{% /tab %}} {{% tab "Terraform" %}} @@ -483,6 +483,7 @@ Para todas las opciones de configuración y detalles, incluyendo [Despliegue mul [203]: https://docs.datadoghq.com/es/getting_started/site/#access-the-datadog-site [204]: https://app.datadoghq.com/organization-settings/api-keys [205]: https://registry.terraform.io/modules/DataDog/log-lambda-forwarder-datadog/aws/latest#multi-region-deployments + {{% /tab %}} {{% tab "Manual" %}} @@ -525,10 +526,6 @@ Datadog recomienda utilizar al menos 10 de concurrencia reservada, pero este val `DD_MULTILINE_LOG_REGEX_PATTERN` : Utiliza la expresión regular suministrada para detectar una nueva línea de log para logs multilíneas de S3, como `\d{2}\/\d{2}\/\d{4}` para logs multilíneas que comienzan con el patrón "11/10/2014". -`DD_USE_TCP` -: Por defecto, el forwarder envía logs utilizando HTTPS a través del puerto 443. Para enviar logs a través de una -conexión TCP con cifrado SSL, establece este parámetro en true. - `DD_NO_SSL` : Desactivar SSL al reenviar logs, poner en true al reenviar logs a través de un proxy. @@ -572,25 +569,30 @@ conexión TCP con cifrado SSL, establece este parámetro en true. `INCLUDE_AT_MATCH` : Solo envía logs que coincidan con la expresión regular suministrada, y no excluidos por `EXCLUDE_AT_MATCH`. -Las reglas de filtrado se aplican a todo el log con formato JSON, incluidos los metadatos que el Forwarder. añade automáticamente Sin embargo, las transformaciones aplicadas por [pipelines de logs][21], que se producen después del envío de logs a Datadog, no pueden utilizarse para filtrar logs en el Forwarder. El uso de una expresión regular ineficaz, como `.*`, puede ralentizar el Forwarder. +Las reglas de filtrado se aplican al mensaje de log tal y como lo lee el forwarder. El uso de una expresión regular ineficiente, como `.*`, puede ralentizar el forwarder. Los siguientes son algunos ejemplos de expresiones regulares que pueden utilizarse para el filtrado de logs: -- Incluye (o excluye) logs de la plataforma Lambda: `"(START|END) RequestId:\s`. El precedente `"` es necesario para que coincida con el inicio del mensaje del log, que está en un blob JSON (`{"message": "START RequestId...."}`). Datadog recomienda conservar los logs de `REPORT`, ya que se utilizan para rellenar la lista de invocaciones en las vistas de funciones serverless. +- Incluir (o excluir) los logs de plataforma de Lambda: `(START|END) RequestId:\s`. Datadog recomienda mantener los logs `REPORT`, ya que se utilizan para rellenar la lista de invocaciones en las vistas de funciones sin servidor. - Incluye sólo mensajes de error de CloudTrail: `errorMessage`. - Incluye sólo logs que contienen un código de error HTTP 4XX o 5XX: `\b[4|5][0-9][0-9]\b`. -- Incluye sólo logs de CloudWatch cuando el campo `message` contiene un par clave/valor JSON específico: `\"awsRegion\":\"us-east-1\"`. - - El campo de mensaje de un evento de log de CloudWatch se codifica como una cadena. Por ejemplo,`{"awsRegion": "us-east-1"}` se codifica como `{\"awsRegion\":\"us-east-1\"}`. Por lo tanto, el patrón que proporciones debe incluir `\` caracteres de escape, como en el siguiente ejemplo: `\"awsRegion\":\"us-east-1\"`. +- Incluye solo los logs de CloudWatch cuyo campo `message` contenga un par clave/valor JSON específico: `"awsRegion":"us-east-1"`. Para probar diferentes patrones en tus logs, activa la [limpieza de logs](#troubleshooting). ### Avanzado (opcional) +`DD_ENRICH_S3_TAGS` +: activado por defecto. Cuando está activado, ordena al backend de Datadog que enriquezca automáticamente logs procedentes de buckets de S3 con las etiquetas asociadas a dichos buckets. Este enfoque ofrece el mismo enriquecimiento de etiquetas que `DD_FETCH_S3_TAGS`, pero aplaza la operación después de la ingesta de logs, lo que reduce la sobrecarga del forwarder. Requiere que https://docs.datadoghq.com/integrations/amazon-web-services/#resource-collection esté habilitada en tu integración de AWS. + +`DD_ENRICH_CLOUDWATCH_TAGS` +: activado por defecto. Cuando se activa, ordena al backend de Datadog que enriquezca automáticamente los logs originados desde Cloudwatch LogGroup con las etiquetas asociadas a esos grupos de logs. Este enfoque ofrece el mismo enriquecimiento de etiquetas que `DD_FETCH_LOG_GROUP_TAGS` pero aplaza la operación después de la ingesta de logs, reduciendo la sobrecarga del forwarder. Requiere que https://docs.datadoghq.com/integrations/amazon-web-services/#resource-collection esté habilitada en tu integración de AWS. + `DD_FETCH_LAMBDA_TAGS` : Permite que el forwarder obtenga etiquetas Lambda mediante llamadas a la API GetResources y las aplique a logs, métricas y rastros. Si se establece en true, el permiso `tag:GetResources` se añadirá automáticamente al rol de IAM de ejecución de Lambda. `DD_FETCH_LOG_GROUP_TAGS` -: Permite que el forwarder obtenga etiquetas de grupo de log mediante ListTagsLogGroup y las aplique a logs, métricas y trazas. Si se establece en true, el permiso `logs:ListTagsForResource` se añadirá automáticamente al rol de IAM de ejecución de Lambda. +: [OBSOLETO, usa DD_ENRICH_CLOUDWATCH_TAGS] Permite al forwarder obtener etiquetas de grupo de logs mediante ListTagsLogGroup y aplicarlas a logs, métricas y trazas. Si se establece en true, el permiso `logs:ListTagsForResource` se añadirá automáticamente al rol de IAM de ejecución de Lambda. `DD_FETCH_STEP_FUNCTIONS_TAGS` : Permite que el Forwarder recupere etiquetas de Step Functions mediante llamadas a la API GetResources y las aplique a logs y trazas (si está habilitado el rastreo de Step Functions). Si se configura como true (verdadero), el permiso `tag:GetResources` se añadirá automáticamente al rol de IAM de ejecución de Lambda. @@ -604,9 +606,6 @@ Para probar diferentes patrones en tus logs, activa la [limpieza de logs](#troub `PERMISSIONS_BOUNDARY_ARN` : ARN para la política de límites de permisos. -`DD_USE_PRIVATE_LINK` (OBSOLETO) -: Establecer en true para permitir el envío de logs y métricas a través de AWS PrivateLink. Consulta [Conectarte a Datadog a través de AWS PrivateLink][2]. - `DD_HTTP_PROXY_URL` : Establece las variables de entorno estándar del proxy web HTTP_PROXY y HTTPS_PROXY. Estos son los endpoints de URL que expone tu servidor proxy. No utilices esto en combinación con AWS Private Link. Asegúrate también de establecer `DD_SKIP_SSL_VALIDATION` a true. @@ -632,6 +631,7 @@ Para probar diferentes patrones en tus logs, activa la [limpieza de logs](#troub [13]: https://docs.datadoghq.com/es/getting_started/site/ [21]: https://docs.datadoghq.com/es/logs/processing/pipelines/ [2]: https://docs.datadoghq.com/es/logs/guide/send-aws-services-logs-with-the-datadog-lambda-function/ + {{% /tab %}} {{< /tabs >}} @@ -643,33 +643,33 @@ Para desplegar el stack tecnológico de CloudFormation con las opciones predeter ```json { - "Effect": "Allow", - "Action": [ - "cloudformation:*", - "secretsmanager:CreateSecret", - "secretsmanager:TagResource", - "s3:CreateBucket", - "s3:GetObject", - "s3:PutEncryptionConfiguration", - "s3:PutBucketPublicAccessBlock", - "iam:CreateRole", - "iam:GetRole", - "iam:PassRole", - "iam:PutRolePolicy", - "iam:AttachRolePolicy", - "lambda:CreateFunction", - "lambda:GetFunction", - "lambda:GetFunctionConfiguration", - "lambda:GetLayerVersion", - "lambda:InvokeFunction", - "lambda:PutFunctionConcurrency", - "lambda:AddPermission", - "lambda:TagResource", - "logs:CreateLogGroup", - "logs:DescribeLogGroups", - "logs:PutRetentionPolicy" - ], - "Resource": "*" + "Effect": "Allow", + "Action": [ + "cloudformation:*", + "secretsmanager:CreateSecret", + "secretsmanager:TagResource", + "s3:CreateBucket", + "s3:GetObject", + "s3:PutEncryptionConfiguration", + "s3:PutBucketPublicAccessBlock", + "iam:CreateRole", + "iam:GetRole", + "iam:PassRole", + "iam:PutRolePolicy", + "iam:AttachRolePolicy", + "lambda:CreateFunction", + "lambda:GetFunction", + "lambda:GetFunctionConfiguration", + "lambda:GetLayerVersion", + "lambda:InvokeFunction", + "lambda:PutFunctionConcurrency", + "lambda:AddPermission", + "lambda:TagResource", + "logs:CreateLogGroup", + "logs:DescribeLogGroups", + "logs:PutRetentionPolicy" + ], + "Resource": "*" } ``` @@ -686,25 +686,25 @@ El stack tecnológico de CloudFormation crea los siguientes roles IAM: ```json [ - { - "Effect": "Allow", - "Action": [ - "logs:CreateLogGroup", - "logs:CreateLogStream", - "logs:PutLogEvents" - ], - "Resource": "*" - }, - { - "Action": ["s3:GetObject"], - "Resource": "arn:aws:s3:::*", - "Effect": "Allow" - }, - { - "Action": ["secretsmanager:GetSecretValue"], - "Resource": "", - "Effect": "Allow" - } + { + "Effect": "Allow", + "Action": [ + "logs:CreateLogGroup", + "logs:CreateLogStream", + "logs:PutLogEvents" + ], + "Resource": "*" + }, + { + "Action": ["s3:GetObject"], + "Resource": "arn:aws:s3:::*", + "Effect": "Allow" + }, + { + "Action": ["secretsmanager:GetSecretValue"], + "Resource": "", + "Effect": "Allow" + } ] ``` @@ -714,36 +714,33 @@ El stack tecnológico de CloudFormation crea los siguientes roles IAM: ```json [ - { - "Effect": "Allow", - "Action": [ - "logs:CreateLogGroup", - "logs:CreateLogStream", - "logs:PutLogEvents" - ], - "Resource": "*" - }, - { - "Action": [ - "s3:ListBucket", - "s3:PutObject", - "s3:DeleteObject" - ], - "Resource": "", - "Effect": "Allow" - } + { + "Effect": "Allow", + "Action": [ + "logs:CreateLogGroup", + "logs:CreateLogStream", + "logs:PutLogEvents" + ], + "Resource": "*" + }, + { + "Action": ["s3:ListBucket", "s3:PutObject", "s3:DeleteObject"], + "Resource": "", + "Effect": "Allow" + } ] ``` ## Configuración de la etiqueta de servicio + El valor de la etiqueta `service` se determina en función de varias entradas. Estas entradas se ordenan por prioridad de mayor a menor + 1. Etiquetas personalizadas de mensajes de logs: Si el mensaje de log tiene una clave `ddtags` que contiene un valor de etiqueta `service`, se utilizará para anular la etiqueta `service` en el evento de log. 2. Caché de etiquetas Lambda (aplicable sólo a logs de Lambda): La activación de `DdFetchLambdaTags` obtendrá y almacenará todas las etiquetas de las funciones Lambda y anulará la etiqueta `service` si no se configuró previamente o si se configuró con un valor predeterminado, es decir, el valor `source (fuente)`. 3. Caché de etiquetas de grupo de logs de Cloudwatch (aplicable sólo a logs de Cloudwatch): La activación `DdFetchLogGroupTags` obtendrá y almacenará todas las etiquetas de grupos de logs de Cloudwatch que se añadan a la entrada `ddtags` en el evento de log. Si el valor de la etiqueta `service` se configuró en el caché de etiquetas, se utilizará para configurar la etiqueta `service` para el evento de log. 4. Establecer directamente un valor de etiqueta `service` en la variable de entorno `ddtags` del forwarder. 5. Valor por defecto igual a la etiqueta `source (fuente)`. - ## Referencias adicionales Documentación útil adicional, enlaces y artículos: @@ -773,4 +770,5 @@ Documentación útil adicional, enlaces y artículos: [21]: https://docs.datadoghq.com/es/logs/processing/pipelines/ [22]: https://docs.datadoghq.com/es/agent/guide/private-link/ [23]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html -[24]: https://docs.datadoghq.com/es/logs/log_configuration/processors/?tab=ui#log-date-remapper \ No newline at end of file +[24]: https://docs.datadoghq.com/es/logs/log_configuration/processors/?tab=ui#log-date-remapper +[25]: https://github.com/DataDog/datadog-serverless-functions/blob/master/aws/logs_monitoring/CHANGELOG.md \ No newline at end of file diff --git a/content/es/logs/guide/log-collection-troubleshooting-guide.md b/content/es/logs/guide/log-collection-troubleshooting-guide.md index 9da0885419b39..ee2fbb0a2fd10 100644 --- a/content/es/logs/guide/log-collection-troubleshooting-guide.md +++ b/content/es/logs/guide/log-collection-troubleshooting-guide.md @@ -24,37 +24,6 @@ Existen una serie de problemas comunes que pueden surgir al [enviar nuevos logs Los cambios en la configuración del `datadog-agent` no se tendrán en cuenta hasta que [reinicies el Agent][3]. -## El tráfico saliente en el puerto 10516 está bloqueado - -El Datadog Agent envía sus logs a Datadog a través de TCP utilizando el puerto 10516. Si esa conexión no está disponible, los logs no se pueden enviar y se registra un error en el archivo `agent.log`. - -Puedes probar manualmente tu conexión utilizando OpenSSL, GnuTLS u otro cliente SSL/TLS. Para OpenSSL, ejecuta el siguiente comando: - -```shell -openssl s_client -connect intake.logs.datadoghq.com:10516 -``` - -Para GnuTLS, ejecuta el siguiente comando: - -```shell -gnutls-cli intake.logs.datadoghq.com:10516 -``` - -Y luego, enviando un log como el siguiente: - -```texto - este es un mensaje de prueba -``` - -- Si abrir el puerto 10516 no es una opción, es posible configurar el Datadog Agent para enviar logs a través de HTTPS, añadiendo lo siguiente en `datadog.yaml`: - -```yaml -logs_config: - force_use_http: true -``` - -Para obtener más información, consulta la sección sobre el [reenvío HTTPS de logs][4]. - ## Comprobar el estado del Agent A menudo, comprobar los resultados del [comando de estado del Agent][5] te ayudará a solucionar lo que está ocurriendo. diff --git a/content/es/logs/log_collection/csharp.md b/content/es/logs/log_collection/csharp.md index 159dc7c59daf5..afa07e2d29eea 100644 --- a/content/es/logs/log_collection/csharp.md +++ b/content/es/logs/log_collection/csharp.md @@ -494,58 +494,6 @@ using (var log = new LoggerConfiguration() } ``` -{{< site-region region="us" >}} - -También puedes reemplazar el comportamiento predeterminado y enviar los logs en TCP al especificar manualmente las siguientes propiedades necesarias: `url`, `port`, `useSSL` y `useTCP`. De manera opcional, [especifica el `source`, `service`, `host` y las etiquetas personalizadas.][1] - -Por ejemplo, para reenviar logs a la región US de Datadog en TCP deberías usar la siguiente configuración del receptor: - -```csharp -var config = new DatadogConfiguration(url: "intake.logs.datadoghq.com", port: 10516, useSSL: true, useTCP: true); -using (var log = new LoggerConfiguration() - .WriteTo.DatadogLogs( - "", - source: "", - service: "", - host: "", - tags: new string[] {":", ":"}, - configuration: config - ) - .CreateLogger()) -{ - // Some code -} -``` - -[1]: /es/logs/log_configuration/attributes_naming_convention/#reserved-attributes - -{{< /site-region >}} -{{< site-region region="eu" >}} - -También puedes reemplazar el comportamiento predeterminado y enviar los logs en TCP al especificar manualmente las siguientes propiedades necesarias: `url`, `port`, `useSSL` y `useTCP`. De manera opcional, [especifica el `source`, `service`, `host` y las etiquetas personalizadas.][1] - -Por ejemplo, para reenviar logs a la región EU de Datadog en TCP deberías usar la siguiente configuración del receptor: - -```csharp -var config = new DatadogConfiguration(url: "tcp-intake.logs.datadoghq.eu", port: 443, useSSL: true, useTCP: true); -using (var log = new LoggerConfiguration() - .WriteTo.DatadogLogs( - "", - source: "", - service: "", - host: "", - tags: new string[] {":", ":"}, - configuration: config - ) - .CreateLogger()) -{ - // Some code -} -``` -[1]: /es/logs/log_configuration/attributes_naming_convention/#reserved-attributes - -{{< /site-region >}} - Ahora los logs nuevos se envían directamente a Datadog. ## Referencias adicionales diff --git a/content/es/network_monitoring/cloud_network_monitoring/setup.md b/content/es/network_monitoring/cloud_network_monitoring/setup.md index 2e24c1d4d8ed9..d71a09c6cbefc 100644 --- a/content/es/network_monitoring/cloud_network_monitoring/setup.md +++ b/content/es/network_monitoring/cloud_network_monitoring/setup.md @@ -204,7 +204,7 @@ Para habilitar Cloud Network Monitoring para hosts de Windows: ```shell net /y stop datadogagent && net start datadogagent ``` -**Nota**: Cloud Network Monitoring monitoriza los hosts de Windows solamente, y no contenedores de Windows. +**Nota**: Cloud Network Monitoring solo monitoriza hosts de Windows y no contenedores de Windows. [1]: /es/agent/basic_agent_usage/windows/?tab=commandline @@ -212,28 +212,71 @@ Para habilitar Cloud Network Monitoring para hosts de Windows: {{% /tab %}} {{% tab "Helm" %}} -Para habilitar Cloud Network Monitoring con Kubernetes utilizando Helm, añade lo siguiente a tu archivo `values.yaml`.
-**Nota:** Se requiere Helm Chart v2.4.39 o posterior. Para obtener más información, consulta la [documentación de Helm Chart de Datadog][1]. +Para activar Cloud Network Monitoring con Kubernetes utilizando Helm, añade lo siguiente a tu archivo `values.yaml`.
+**Nota:** Se requiere Helm Chart v3.135.3+. Para obtener más información, consulta la [documentación de Helm Chart de Datadog][1]. ```yaml datadog: + ... networkMonitoring: enabled: true ``` -**Nota**: Si recibes un error de permisos al configurar CNM en tu entorno de Kubernetes: `Error: error enabling protocol classifier: permission denied`, añade lo siguiente a tu `values.yaml`. (Consulta esta [sección][5] en el Helm chart): - ```yaml - agents: - podSecurity: - apparmor: - enabled: true - ``` +Es posible que necesites uno de los siguientes pasos adicionales en función de tu entorno: + +{{< collapse-content title="GKE Autopilot de Google" level="h4" >}} + +Si tu clúster está ejecutando GKE Autopilot de Google, añade lo siguiente a tu archivo de valores: + +``` +providers: + gke: + autopilot: true +``` + +{{< /collapse-content >}} + +{{< collapse-content title="Sistema operativo optimizado con contenedor (COS) de Google" level="h4" >}} + +Si tu clúster ejecuta el sistema operativo optimizado con contenedor (COS) de Google, añade lo siguiente a tu archivo de valores: + +``` +providers: + gke: + cos: true +``` + + +{{< /collapse-content >}} + +{{< collapse-content title="Bottlerocket Linux" level="h4" >}} + +Si tu clúster utiliza la distribución Bottlerocket Linux para sus nodos, añade lo siguiente a tu archivo de valores: + +``` +agents: + containers: + systemProbe: + securityContext: + seLinuxOptions: + user: "system_u" + role: "system_r" + type: "spc_t" + level: "s0" +``` + +{{< /collapse-content >}} + +[1]: https://github.com/DataDog/helm-charts/blob/main/charts/datadog/README.md#enabling-npm-collection + +{{% /tab %}} +{{% tab "Kubernetes without Helm" %}} Si no utilizas Helm, puedes habilitar Cloud Network Monitoring con Kubernetes desde cero: -1. Descarga la plantilla [datadog-agent.yaml manifest][2]. -2. Sustituye `` por tu [clave de API Datadog][3]. +1. Descarga la plantilla [manifiesto de datadog-agent.yaml][1]. +2. Sustituye `` por tu [clave de API de Datadog][2]. 3. (Opcional) **Configura tu sitio Datadog**. Si utilizas el sitio Datadog EU, configura la variable de entorno `DD_SITE` como `datadoghq.eu` en el manifiesto `datadog-agent.yaml`. 4. **Despliega el DaemonSet** con el comando: @@ -241,7 +284,7 @@ Si no utilizas Helm, puedes habilitar Cloud Network Monitoring con Kubernetes de kubectl apply -f datadog-agent.yaml ``` -Si el [Agent ya se ejecuta con un manifiesto][4]: +Si ya tienes el [Agent ejecutándose con un manifiesto][3]: 1. Para las versiones de Kubernetes inferiores a `1.30`, añade la anotación `container.apparmor.security.beta.kubernetes.io/system-probe: unconfined` en la plantilla `datadog-agent`: @@ -392,11 +435,9 @@ Si el [Agent ya se ejecuta con un manifiesto][4]: emptyDir: { } ``` -[1]: https://github.com/DataDog/helm-charts/blob/master/charts/datadog/README.md#enabling-system-probe-collection -[2]: /resources/yaml/datadog-agent-npm.yaml -[3]: https://app.datadoghq.com/organization-settings/api-keys -[4]: /es/agent/kubernetes/ -[5]: https://github.com/DataDog/helm-charts/blob/main/charts/datadog/values.yaml#L1774-L1775 +[1]: /resources/yaml/datadog-agent-npm.yaml +[2]: https://app.datadoghq.com/organization-settings/api-keys +[3]: /es/agent/kubernetes/ {{% /tab %}} {{% tab "Operator" %}} diff --git a/content/es/network_monitoring/netflow/_index.md b/content/es/network_monitoring/netflow/_index.md index 435665da8c9ab..f55fa315bb2b2 100644 --- a/content/es/network_monitoring/netflow/_index.md +++ b/content/es/network_monitoring/netflow/_index.md @@ -11,14 +11,28 @@ further_reading: - link: https://www.datadoghq.com/blog/diagnose-network-performance-with-snmp-trap-monitoring/ tag: Blog text: Monitorizar y diagnosticar problemas de rendimiento de red con SNMP Traps -title: Monitorización de NetFlow +title: NetFlow Monitoring --- ## Información general -Utiliza NetFlow Monitoring en Datadog para visualizar y monitorizar tus registros de flujo en tus dispositivos habilitados para NetFlow. +La vista de NetFlow en Network Device Monitoring proporciona visibilidad de los flujos de tráfico de red recopilados de dispositivos que exportan datos de flujo (por ejemplo, enrutadores, cortafuegos o conmutadores). Puedes analizar el volumen de tráfico, identificar a los principales interlocutores y comprender cómo se mueven los datos por la red. -{{< img src="network_device_monitoring/netflow/home.png" alt="Página de NetFlow Monitoring con pestañas de fuentes principales, destinos, protocolos, puertos de origen, puertos de destino y tendencias de dispositivos" style="width:100%;" >}} +La vista de NetFlow muestra las métricas de tráfico agregadas por dispositivo e interfaz. Utilízala para identificar qué dispositivos o interfaces consumen más ancho de banda, generan más paquetes o contribuyen a los picos de tráfico. + +{{< img src="network_device_monitoring/netflow/netflow_home_2.png" alt="La page (página) de NetFlow Monitoring que contiene una leyenda contraíble para el volumen de tráfico, el estado del dispositivo, los flujos, etc." style="width:100%;" >}} + +## Navegación lateral + +Utiliza la navegación de la izquierda para explorar vistas adicionales de NetFlow: + +- **Volumen de tráfico**: Métricas de flujo global por dispositivo e interfaz. +- **Estado de los dispositivos**: Estado y utilización de los dispositivos monitorizados. +- **Flujos**: Registros detallados de flujos individuales. +- **Conversaciones**: Pares agregados de origen-destino. +- **Sistemas autónomos**: Datos de flujo agrupados por Números de sistema autónomo (ASN). +- **IP geográfico**: Datos de flujo agrupados por origen/destino geográfico. +- **Puertos de origen / Puertos de destino / Protocolos / Marcas**: Desglose del tráfico por metadatos de paquetes. ## Instalación @@ -30,7 +44,7 @@ Para utilizar NetFlow Monitoring con Network Device Monitoring, asegúrate de qu Para configurar tus dispositivos para enviar tráfico de NetFlow, jFlow, sFlow o IPFIX al servidor NetFlow del Agent, tus dispositivos deben estar configurados para enviar tráfico a la dirección IP en la que está instalado el Datadog Agent, específicamente `flow_type` y `port`. -Edita tu archivo de configuración del Agent [`datadog.yaml`][3] para activar NetFlow: +1. Edita tu archivo de configuración del Agent [`datadog.yaml`][3] para activar NetFlow: ```yaml network_devices: @@ -49,9 +63,9 @@ network_devices: reverse_dns_enrichment_enabled: false ``` -Luego de guardar los cambios, [reinicia el Agent][4]. +2. Luego de guardar los cambios, [reinicia el Agent][4]. -**Nota**: Asegúrate de que tus [reglas de firewall][9] permiten el tráfico UDP entrante en los puertos configurados. + **Nota**: Asegúrate de que tus [reglas de firewall][9] permiten el tráfico UDP entrante en los puertos configurados. ## Agregación @@ -67,21 +81,19 @@ Si la IP del exportador de NetFlow es una de las direcciones IP del dispositivo, Datadog enriquece las IP con el servicio y la región del proveedor de la nube pública para las direcciones IPv4, de modo que puedas filtrar los registros de flujos de un servicio y una región específicos. -{{< img src="network_device_monitoring/netflow/netflow_cloud_provider_ip_enrichment.png" alt="Direcciones IP de NetFlow enriquecidas con el nombre, la región y el servicio del proveedor de la nube" width="80%" >}} +{{< img src="network_device_monitoring/netflow/netflow_cloud_provider_enrichment_2.png" alt="Menú de Netflow Filter en el cual se muestra el nombre, la región y el servicio del proveedor en la nube" width="100%" >}} ### Enriquecimiento de puertos -Datadog enriquece los puertos en NetFlow con datos de IANA (Internet Assigned Numbers Authority) para resolver asignaciones de puertos bien conocidos (como Postgres en 5432 y HTTPS en 443). Esto puede observarse cuando se buscan nombres de aplicaciones de origen o de destino en NetFlow. - -{{< img src="network_device_monitoring/netflow/netflow_iana_port_mappings.png" alt="Página de NetFlow filtrada por @destination.application_name, que muestra nombres de puertos como HTTPS" width="80%" >}} +Datadog enriquece los puertos en NetFlow con datos de la IANA (Internet Assigned Numbers Authority) para resolver asignaciones de puertos bien conocidos (como Postgres en 5432 y HTTPS en 443). #### Enriquecimiento personalizado de puertos También puedes añadir tus propios enriquecimientos personalizados para asignar puertos y protocolos a aplicaciones específicas (por ejemplo, si un servicio personalizado se ejecuta en un puerto específico). Esto permite a los ingenieros de redes y a tus equipos interpretar y consultar los datos de NetFlow con nombres legibles. -En la pestaña **Configuración** en NetFlow, haz clic en **Add Enrichment** (Añadir enriquecimiento) para cargar el archivo CSV que contiene tus enriquecimientos personalizados. +En la pestaña **Configuration** (Configuración) de NetFlow, haz clic en **+ Add Enrichment** (+ Añadir enriquecimiento) para cargar el archivo CSV que contiene tus enriquecimientos personalizados. -{{< img src="network_device_monitoring/netflow/new_enrichment.png" alt="Modal de Asignación de nuevo enriquecimiento en la pestaña de configuración de NetFlow" width="80%" >}} +{{< img src="network_device_monitoring/netflow/new_enrichment_2.png" alt="El modal de Nueva asignación de enriquecimiento en la pestaña de la configuración de Netflow" width="100%" >}} ### Enriquecimiento de IP privada con DNS inverso @@ -89,19 +101,29 @@ Activa el enriquecimiento de IP privada con DNS inverso para realizar búsquedas Por [defecto][7], el enriquecimiento de IP con DNS inverso en tu archivo `datadog.yaml` está deshabilitado. Para habilitarlo, consulta la sección [Configuración](#configuration) de esta página. -Busca **DNS** en la agrupación de Flujo de la sección de facetas para encontrar los flujos asociados con el enriquecimiento de IP con DNS inverso: +Busca **DNS** en el menú **+ Filter** (+ Filtro) para localizar los flujos asociados al enriquecimiento del IP de DNS inverso: -{{< img src="network_device_monitoring/netflow/dns_ip_enrichment.png" alt="Captura de pantalla del destino DNS inverso y de las facetas de origen" width="100%" >}} +{{< img src="network_device_monitoring/netflow/dns_ip_enrichmen_2.png" alt="Filtrar el menú mejorado para mostrar las facetas de destino y de origen de DNS inverso" width="100%" >}} **Nota**: Las entradas de DNS inverso se almacenan en caché y están sujetas a limitaciones de frecuencia para minimizar las consultas DNS y reducir la carga de los servidores DNS. Para obtener más información sobre las opciones de configuración, incluyendo la modificación del almacenamiento en caché predeterminado y la limitación de frecuencia, consulta el [archivo de configuración completo][8]. -## Visualización +## Datos de IP + +En la vista **Conversations** (Conversaciones), puedes ver la dirección IP pública de la IP de destino. Pasa el ratón sobre la IP para mostrar metadatos enriquecidos sobre la IP y un enlace a **View Related Network Connections** (Ver conexiones de red relacionadas) donde puedes inspeccionar la conectividad con más detalles. + +{{< img src="network_device_monitoring/netflow/NetFlow_IP_pill.png" alt="Pase el ratón sobre la dirección IP para mostrar los datos de la IP y ver conexiones de red relacionadas" width="100%" >}} -Puedes acceder a los datos recopilados por NetFlow Monitoring en la página de [**NetFlow**][5]. Pasa el cursor sobre un flujo de la lista para obtener información adicional sobre hosts, pods y contenedores, y acceder a las conexiones de red relacionadas. +## Diagrama de flujo -{{< img src="network_device_monitoring/netflow/information.png" alt="Pasa el cursor sobre un flujo agregado desde un dispositivo emisor de NetFlow para acceder a las conexiones relacionadas con la red" width="100%" >}} +Puedes visualizar los flujos en NetFlow Monitoring haciendo clic en el menú **Flows** (Flujos) y pasando el ratón por encima de un flujo de la lista para ver información adicional sobre IP de origen, nombre de la interfaz de ingreso, nombre del dispositivo e IP de destino en todas las conexiones de red relacionadas. -Al crear un [monitor de NetFlow][6], debes tener en cuenta los siguientes campos, con respecto a la IP de origen o la IP de destino, desde la perspectiva del dispositivo. Estos campos proporcionan información sobre los patrones de tráfico de red y ayudan a optimizar el rendimiento y la seguridad. +{{< img src="network_device_monitoring/netflow/flows.png" alt="Pasar el ratón sobre un flujo agregado desde un dispositivo que emite netflow para acceder a conexiones de red relacionadas" width="100%" >}} + +## Monitor (noun) de NetFlow + +Haz clic en el icono **Create Monitor** (Crear monitor (noun)) desde cualquiera de las vistas para crear un [Monitor (noun) de NetFlow][6]. Cuando crees el monitor (noun), ten en cuenta los siguientes campos con respecto a la IP de origen o IP de destino desde la perspectiva del dispositivo. Estos campos proporcionan información sobre los patrones de tráfico de la red y ayudan a optimizar el rendimiento y la seguridad. + +{{< img src="network_device_monitoring/netflow/create_monitor.png" alt="Vista de flujos en NetFlow que monitoriza con el vínculo para crear monitores resaltado." width="100%" >}} ### Información sobre la interfaz @@ -206,14 +228,6 @@ Además de los campos, también puedes utilizar facetas predefinidas para empeza | Nombre de la subdivisión de origen | El nombre de la subdivisión (como estado o provincia) asociada a la IP de origen. | | Zona horaria de origen | La zona horaria asociada a la IP de origen. | -Mediante la monitorización de estos campos clave y del uso de facetas para analizar eventos de NetFlow, las organizaciones pueden obtener visibilidad de su infraestructura de red, optimizar el rendimiento y mejorar la postura de seguridad. - -{{< img src="monitors/monitor_types/netflow/monitor.png" alt="Crea un dashboard con datos de NetFlow" width="100%" >}} - -Estos datos también están disponibles en dashboards y notebooks, lo que permite realizar consultas precisas y correlacionarlas con otras fuentes de datos. Al crear un dashboard con datos de NetFlow, selecciona **NetFlow** como fuente en la sección **Grafica tus datos**. - -{{< img src="network_device_monitoring/netflow/dashboard.png" alt="Crea un dashboard con datos de NetFlow" width="100%" >}} - ## Frecuencia de muestreo La frecuencia de muestreo de NetFlow se tiene en cuenta en el cálculo de bytes y paquetes por defecto. Los valores mostrados para los bytes y los paquetes se calculan con la frecuencia de muestreo aplicada. diff --git a/content/es/real_user_monitoring/_index.md b/content/es/real_user_monitoring/_index.md index ff9b39bb0e3c3..1d2ee66792625 100644 --- a/content/es/real_user_monitoring/_index.md +++ b/content/es/real_user_monitoring/_index.md @@ -54,7 +54,7 @@ further_reading: - link: https://www.datadoghq.com/blog/static-web-application-monitoring-best-practices/ tag: Blog text: Prácticas recomendadas para la monitorización de aplicaciones web estáticas -- link: /real_user_monitoring/browser/data_collected/ +- link: /real_user_monitoring/application_monitoring/browser/data_collected/ tag: Documentación text: Datos del navegador de RUM recopilados - link: https://www.datadoghq.com/blog/progressive-web-application-monitoring/ @@ -101,21 +101,21 @@ Selecciona un tipo de aplicación para empezar a recopilar datos de RUM: La siguiente tabla muestra las funcionalidades de RUM compatibles con cada plataforma: -| Función | Navegador | Android | iOS | Flutter | React Native | Roku | Notas | -| ------------------------------------- | --------|---------|---------|---------|--------------|------|-------| -| Enviar logs a Datadog | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | | -| Rastreo distribuido de solicitudes de red | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | El **SDK de Datadog Roku** sólo puede rastrear algunos tipos de solicitudes HTTP. | -| Rastrear vistas y acciones (RUM) | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | - Todas las acciones rastreadas en **Flutter Web** se registran como `custom`
- **Roku** sólo admite el rastreo manual de acciones. | -| Seguimiento de marcadores de funciones y seguimiento de versiones | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | | | -| Seguimiento de errores y asignación de orígenes | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | Sólo parcialmente compatible con **React Native** | -| Seguimiento de fallos, simbolización y desofuscación | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | | -| Detener sesiones (monitorización de quioscos) | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | | | -| Rastrear eventos en vistas web | | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | | | -| Monitorizar indicadores vitales específicos de plataformas | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | | | -| Seguimiento global de contexto/atributo en logs | {{< X >}} | | | | | | | -| Rastreo del lado del cliente | | {{< X >}} | {{< X >}}| | | | | | -| Session Replay | {{< X >}} | {{< X >}} | {{< X >}} | | {{< X >}} | | | -| Señales de frustración | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | Compatible sólo parcialmente con todos los dispositivos **móviles** y **Roku** | +| Función | Navegador | Android | iOS | Flutter | React Native | Roku | KMP | Unidad | Notas | +| ------------------------------------- | --------|---------|---------|---------|--------------|------|-----|-------|--------| +| Enviar logs a Datadog | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | | +| Rastreo distribuido de solicitudes de red | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | - **Roku** solo puede rastrear algunos tipos de solicitudes HTTP.
- **Unity** utiliza una envoltura alrededor de `UnityWebRequest` para realizar el seguimiento de las solicitudes. | +| Rastrear vistas y acciones (RUM) | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | - Todas las acciones seguidas en **Flutter Web** se registran como `custom`.
- **Roku** y **Unity** solo admiten el seguimiento manual de acciones. | +| Seguimiento de marcadores de funciones y seguimiento de versiones | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | | {{< X >}} | {{< X >}} | | +| Seguimiento de errores y asignación de orígenes | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | Solo parcialmente compatible con **React Native**. | +| Seguimiento de fallos, simbolización y desofuscación | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | | +| Detener sesiones (monitorización de quioscos) | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | | {{< X >}} | {{< X >}} | | +| Rastrear eventos en vistas web | | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | | {{< X >}} | | | +| Monitorizar indicadores vitales específicos de plataformas | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | | {{< X >}} | | | +| Seguimiento global de contexto/atributo en logs | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | | {{< X >}} | {{< X >}} | | +| Rastreo del lado del cliente | | {{< X >}} | {{< X >}}| | | | | | | | +| Session Replay | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | | {{< X >}} | | Session Replay de **Flutter** está en vista previa. | +| Señales de frustración | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | | Solo parcialmente compatible con todos los dispositivos **móviles** y **Roku**. | ## Endpoints compatibles para dominios de SDK @@ -126,14 +126,14 @@ El tráfico de todos los SDK de Datadog se transmite a través de SSL (443 por d | US1 | `https://browser-intake-datadoghq.com` | | US3 | `https://browser-intake-us3-datadoghq.com` | | US5 | `https://browser-intake-us5-datadoghq.com` | -| EU1 | `https://browser-intake-datadoghq.eu` | +| UE1 | `https://browser-intake-datadoghq.eu` | | US1-FED | `https://browser-intake-ddog-gov.com` | | AP1 | `https://browser-intake-ap1-datadoghq.com` | | AP2 | `https://browser-intake-ap2-datadoghq.com` | ## Explorar RUM de Datadog -Accede a RUM yendo a [**Experiencia digital > Resumen del rendimiento**][1]. +Accede a RUM yendo a [**Digital Experience > Performance Summary** (Experiencia digital > Resumen del rendimiento)][1]. Selecciona una aplicación en la barra de navegación superior o sigue las instrucciones de configuración de [navegador][15] o [móvil][16] para añadir tu primera aplicación. @@ -235,7 +235,7 @@ Debes tener acceso de edición para restaurar el acceso general a una aplicació [4]: /es/monitors/types/real_user_monitoring/ [5]: /es/real_user_monitoring/correlate_with_other_telemetry/apm/ [6]: /es/real_user_monitoring/error_tracking/ -[7]: /es/real_user_monitoring/browser/monitoring_page_performance/#event-timings-and-core-web-vitals +[7]: /es/real_user_monitoring/application_monitoring/browser/monitoring_page_performance/#event-timings-and-core-web-vitals [8]: /es/real_user_monitoring/ios/mobile_vitals/ [9]: /es/real_user_monitoring/android/mobile_vitals/ [10]: /es/real_user_monitoring/ios/web_view_tracking/ @@ -243,7 +243,7 @@ Debes tener acceso de edición para restaurar el acceso general a una aplicació [12]: /es/real_user_monitoring/session_replay/browser/ [13]: /es/real_user_monitoring/session_replay/browser/privacy_options/ [14]: /es/real_user_monitoring/session_replay/browser/developer_tools/ -[15]: /es/real_user_monitoring/browser/setup/ -[16]: /es/real_user_monitoring/mobile_and_tv_monitoring/ +[15]: /es/real_user_monitoring/application_monitoring/browser/setup/ +[16]: /es/real_user_monitoring/application_monitoring/ [17]: https://app.datadoghq.com/rum/optimization/inspect [18]: /es/account_management/rbac/ \ No newline at end of file diff --git a/content/es/real_user_monitoring/guide/upload-javascript-source-maps.md b/content/es/real_user_monitoring/guide/upload-javascript-source-maps.md index b1e67fcdd5ca8..cb3a346b0b9a0 100644 --- a/content/es/real_user_monitoring/guide/upload-javascript-source-maps.md +++ b/content/es/real_user_monitoring/guide/upload-javascript-source-maps.md @@ -1,4 +1,6 @@ --- +description: Carga mapas fuente de JavaScript para mejorar el rastreo de errores con + stack traces legibles y una mejor depuración del código minificado. further_reading: - link: /real_user_monitoring/error_tracking tag: Documentación @@ -6,7 +8,7 @@ further_reading: - link: /real_user_monitoring/error_tracking/explorer tag: Documentación text: Visualización de tus datos de rastreo de errores en el Explorer -- link: https://github.com/DataDog/datadog-ci/tree/master/packages/datadog-ci/src/commands/sourcemaps +- link: https://github.com/DataDog/datadog-ci/tree/master/packages/datadog-ci/src/commands/sourcemaps#sourcemaps-command tag: Código fuente text: Referencia del comando Sourcemaps title: Carga de mapas de fuente de JavaScript @@ -20,10 +22,10 @@ Si el código fuente de tu frontend JavaScript está minificado, carga tus mapas ## Instrumentar tu código -Configura tu empaquetador de JavaScript para que, al minificar tu código fuente, genere mapas de fuente que incluyan directamente el código fuente relacionado en el atributo `sourcesContent`. +Configura tu empaquetador de JavaScript para que, al minificar el código fuente,, genere mapas fuente que incluyan directamente el código fuente relacionado en el atributo `sourcesContent`.
-Asegúrate de que el tamaño de cada mapa fuente aumentado con el tamaño del archivo minificado relacionado no supere el límite de **500 MB**. +Asegúrate de que el tamaño de cada source map (mapa de fuentes) aumentado con el tamaño del archivo minificado relacionado no supere el límite de **500 MB**.
Consulta las siguientes configuraciones para los empaquetadores más populares de JavaScript. @@ -65,6 +67,27 @@ module.exports = { Parcel genera mapas de fuente por defecto cuando se ejecuta el comando build: `parcel build `. +{{% /tab %}} +{{% tab "Vite" %}} + +Puedes generar source maps (mapas de fuentes) configurando la opción `build.sourcemap` en tu archivo `vite.config.js`. + +Consulta el ejemplo de configuración: + +```javascript +// vite.config.js +import { defineConfig } from 'vite' + +export default defineConfig({ + build: { + sourcemap: true, // generates .js.map files + minify: 'terser', // or 'esbuild' + } +}) +``` + +**Nota**: Si estás utilizando TypeScript, asegúrate de que `compilerOptions.sourceMap` se configure en `true` en tu archivo `tsconfig.json`. + {{% /tab %}} {{< /tabs >}} @@ -82,7 +105,7 @@ Consulta el siguiente ejemplo: ```
-Si la suma del tamaño de los archivos javascript.364758.min.js y javascript.364758.js.map supera el límite de 500 MB, redúcelo configurando el empaquetador para dividir el código fuente en varios fragmentos más pequeños. Para obtener más información, consulta Code Splitting with WebpackJS. +Si la suma del tamaño de los archivos javascript.364758.min.js y javascript.364758.js.map supera el límite de 500 MB, redúcelo configurando el empaquetador para dividir el código source (fuente) en varios fragmentos más pequeños. Para obtener más información, consulta División del código con WebpackJS.
## Cargar tus mapas de fuente @@ -158,6 +181,6 @@ Por otro lado, un stack trace sin minificar te proporciona todo el contexto que {{< partial name="whats-next/whats-next.html" >}} [1]: https://github.com/DataDog/datadog-ci/tree/master/packages/datadog-ci/src/commands/sourcemaps -[2]: https://docs.datadoghq.com/es/real_user_monitoring/browser/setup/#initialization-parameters +[2]: https://docs.datadoghq.com/es/real_user_monitoring/application_monitoring/browser/setup/#initialization-parameters [3]: https://docs.datadoghq.com/es/logs/log_collection/javascript/#initialization-parameters -[4]: https://github.com/DataDog/datadog-ci/tree/master/packages/datadog-ci/src/commands/sourcemaps#link-errors-with-your-source-code +[4]: https://github.com/DataDog/datadog-ci/tree/master/packages/datadog-ci/src/commands/sourcemaps#link-errors-with-your-source-code \ No newline at end of file diff --git a/content/es/real_user_monitoring/session_replay/browser/_index.md b/content/es/real_user_monitoring/session_replay/browser/_index.md index e3161dfd96842..b00322060ef1f 100644 --- a/content/es/real_user_monitoring/session_replay/browser/_index.md +++ b/content/es/real_user_monitoring/session_replay/browser/_index.md @@ -1,7 +1,6 @@ --- aliases: - /es/real_user_monitoring/guide/session-replay-getting-started/ -- /es/real_user_monitoring/session_replay/ description: Aprende a capturar y reproducir visualmente la experiencia de navegación web de tus usuarios con Session Replay. further_reading: @@ -30,11 +29,11 @@ title: Session Replay de navegador Session Replay amplía tu experiencia de monitorización de usuarios, ya que te permite capturar y reproducir visualmente la experiencia de navegación web de tus usuarios. Combinada con los datos de rendimiento de RUM, Session Replay es útil para identificar, reproducir y solucionar errores, y proporciona información sobre los patrones de uso y los fallos de diseño de tu aplicación web. -El SDK del Navegador RUM es de [código abierto][1] y aprovecha el proyecto de código abierto [rrweb][2]. +El SDK del navegador RUM es de [código abierto][1] y aprovecha el proyecto de código abierto [rrweb][2]. ## Cómo funciona el grabador de Session Replay -El grabador de Session Replay forma parte del SDK del Navegador RUM. El grabador toma una snapshot de DOM y CSS del navegador, mientras realiza un seguimiento y graba los eventos de una página web (como modificaciones de DOM, movimientos del cursor, clics y eventos de entradas) junto con estas marcas de tiempo de eventos. +El grabador de Session Replay forma parte del SDK del navegador RUM. El grabador toma una snapshot de DOM y CSS del navegador, mientras realiza un seguimiento y graba los eventos de una página web (como modificaciones de DOM, movimientos del cursor, clics y eventos de entradas) junto con estas marcas de tiempo de eventos. Datadog, a continuación, reconstruye la página web y vuelve a aplicar los eventos registrados en el momento adecuado en la vista de reproducción. @@ -44,84 +43,19 @@ Para reducir el impacto de Session Replay en la red y garantizar que el grabador ## Configuración -Session Replay está disponible en el SDK del Navegador RUM. Para empezar a recopilar datos para Session Replay, configura la [monitorización del Navegador RUM Datadog][4] creando una aplicación RUM, habilitando la generación de token de cliente e inicializando el el SDK del Navegador RUM. Para ver la configuración en entornos móviles, consulta [Session Replay para móviles][5]. +Aprende a [instalar y configurar el navegador de Session Replay][4]. -
Session Replay es compatible con la versión 3.6.0 o posterior del SDK.
+## Opciones de privacidad -## Utilización +Consulta [Opciones de privacidad][5]. -A partir de la versión 5.0.0 del SDK del Navegador RUM, Session Replay comienza a grabar automáticamente al llamar a `init()`. Para iniciar condicionalmente la grabación, utiliza el parámetro de inicialización `startSessionReplayRecordingManually` y llama a `startSessionReplayRecording()`. +## Solucionar problemas -Por ejemplo, para grabar sólo las sesiones de usuarios autenticados: - -```javascript -window.DD_RUM.init({ - applicationId: '', - clientToken: '', - site: '', - // servicio: 'my-web-application', - // entorno: 'production', - // versión: '1.0.0', - sessionSampleRate: 100, - sessionReplaySampleRate: 100, - startSessionReplayRecordingManually: true, - ... -}); - -if (user.isAuthenticated) { - window.DD_RUM.startSessionReplayRecording(); -} -``` - -Para detener la grabación de Session Replay, llama a `stopSessionReplayRecording()`. - -
Cuando se utiliza una versión del SDK del Navegador RUM anterior a v5.0.0, la grabación de Session Replay no comienza automáticamente. Para iniciar la grabación, llama a startSessionReplayRecording().
- -## Forzar Session Replay - -En algunos casos, es posible que desees iniciar la grabación de una sesión después de que haya comenzado, incluso si inicialmente se muestreó fuera de la reproducción. Por ejemplo, es posible que desees forzar Session Replay en una página recién desplegada para una monitorización más detallada, o iniciar la grabación después de detectar un error para garantizar datos de reproducción completos. - -Para forzar la grabación de Session Replay para el resto de la sesión actual, llama a `startSessionReplayRecording({ force: true })` - -Cuando se utiliza la opción de forzar, la sesión se actualiza a una sesión reproducida durante el resto de su duración, independientemente de su decisión de muestreo inicial. - -
La opción forzar sólo convierte una sesión existente en una repetición si ya se está muestreando. En otras palabras, si aún no se ha iniciado el muestreo, el uso de la opción forzar no lo inicia y no se graba ninguna repetición.
- -## Desactivar Session Replay - -Para detener las grabaciones de sesión, establece `sessionReplaySampleRate` en `0`. Esto detiene la recopilación de datos para el [plan de navegador RUM y Session Replay][6]. - -
Si estás utilizando una versión del SDK del navegador RUM anterior a v5.0.0, define replaySampleRate en 0.
- -## Conservación - -Por defecto, los datos de Session Replay se conservan durante 30 días. - -Para ampliar el periodo de conservación a 15 meses, puedes habilitar la conservación ampliada en las repeticiones de sesiones individuales. Estas sesiones no deben estar activas (el usuario ha completado su experiencia). - -La conservación ampliada sólo se aplica a Session Replay y no incluye los eventos asociados. Los 15 meses comienzan cuando se habilita la conservación ampliada, no cuando se recopila la sesión. - -Puedes deshabilitar la conservación ampliada en cualquier momento. Si la reproducción de sesiones todavía está dentro de los 30 días de conservación predeterminados, la reproducción caduca al final de la ventana inicial de 30 días. Si deshabilitas la conservación ampliada en una reproducción de sesión que tiene más de 30 días, la reproducción caduca inmediatamente. - -{{< img src="real_user_monitoring/session_replay/session-replay-extended-retention.png" alt="Habilitar la conservación ampliada" style="width:100%;" >}} - -Consulta el siguiente diagrama para comprender qué datos se conservan con la conservación ampliada. - -{{< img src="real_user_monitoring/session_replay/replay-extended-retention.png" alt="Diagrama de los datos que se conservan mediante la conservación ampliada" style="width:100%;" >}} - -## Historial de reproducción - -Puedes ver quién ha visto la repetición de una sesión determinada haciendo clic en el recuento de **vistos** que aparece en la página del reproductor. Esta función te permite consultar si alguien con quien quieres compartir la grabación ya la ha visto. - -{{< img src="real_user_monitoring/session_replay/session-replay-playback-history.png" alt="Consultar quién ha visto la grabación de una sesión" style="width:100%;" >}} - -El historial sólo incluye las reproducciones que se han realizado en la página del reproductor o en un reproductor integrado, como en un [notebook][8] o panel lateral. Las reproducciones incluidas también generan un evento de [Audit Trail][7]. Las previsualizaciones en miniatura no se incluyen en el historial. - -Para ver tu propio historial de reproducción, consulta la lista de reproducción [Mi historial de vistas][9]. +Aprende a [solucionar problemas del navegador de Session Replay][7]. ## Session Replay para móviles -Más información sobre [Session Replay para móviles][5]. +Más información sobre [Session Replay para móviles][8]. ## Referencias adicionales @@ -130,9 +64,7 @@ Más información sobre [Session Replay para móviles][5]. [1]: https://github.com/DataDog/browser-sdk [2]: https://www.rrweb.io/ [3]: https://github.com/DataDog/browser-sdk/blob/main/packages/rum/BROWSER_SUPPORT.md -[4]: /es/real_user_monitoring/browser/ -[5]: /es/real_user_monitoring/session_replay/mobile/ -[6]: https://www.datadoghq.com/pricing/?product=real-user-monitoring--session-replay#real-user-monitoring--session-replay -[7]: https://docs.datadoghq.com/es/account_management/audit_trail/ -[8]: https://docs.datadoghq.com/es/notebooks/ -[9]: https://app.datadoghq.com/rum/replay/playlists/my-watch-history \ No newline at end of file +[4]: /es/real_user_monitoring/session_replay/browser/setup_and_configuration +[5]: /es/real_user_monitoring/session_replay/browser/privacy_options +[7]: /es/real_user_monitoring/session_replay/browser/troubleshooting +[8]: /es/real_user_monitoring/session_replay/mobile/ \ No newline at end of file diff --git a/content/es/serverless/aws_lambda/configuration.md b/content/es/serverless/aws_lambda/configuration.md index 156db221f6e4d..ec6aec9963414 100644 --- a/content/es/serverless/aws_lambda/configuration.md +++ b/content/es/serverless/aws_lambda/configuration.md @@ -45,6 +45,7 @@ Primero, [instala][1] Datadog Serverless Monitoring para comenzar a recopilar m - [Configuración del enlace automático para PutItem de DynamoDB](#configure-auto-linking-for-dynamodb-putitem) - [Visualización y modelado correcto de los servicios de AWS](#visualize-and-model-aws-services-by-resource-name) - [Envío de logs a Observability Pipelines](#sending-data-to-observability-pipelines) +- [Recargar periódicamente el secreto de la clave de API](#reload-api-key-secret-periodically) - [Solucionar problemas](#troubleshoot) - [Referencias adicionales](#further-reading) @@ -798,6 +799,14 @@ Para activar esta función, establece estas variables de entorno: **Nota**: Tu Observability pipeline debe utilizar `Http Server` como fuente para procesar logs de Lambda Extension. No utilices `Datadog Agent` como fuente. +## Recargar periódicamente el secreto de la clave de API + +Si especificas la clave de API de Datadog utilizando `DD_API_KEY_SECRET_ARN`, también puedes configurar `DD_API_KEY_SECRET_RELOAD_INTERVAL` para que recargue periódicamente el secreto. Por ejemplo, si configuras `DD_API_KEY_SECRET_RELOAD_INTERVAL` en `43200`, el secreto se recarga cuando se necesita la clave de API para enviar datos y han pasado más de 43200 segundos desde la última carga. + +Ejemplo de caso de uso: por seguridad, cada día (86400 segundos), la clave de API se rota y el secreto se actualiza a la nueva clave, y la clave de API antigua se mantiene válida durante otro día como periodo de gracia. En este caso, se puede establecer `DD_API_KEY_SECRET_RELOAD_INTERVAL` en `43200`, por lo que la clave de API se recarga durante el periodo de gracia de la clave antigua. + +Está disponible para la versión 88+ de la extensión de Datadog Lambda. + ## Solucionar problemas Si tienes problemas para configurar tus instalaciones, define la variable de entorno `DD_LOG_LEVEL` como `debug` en los logs de depuración. Para obtener más consejos sobre cómo solucionar problemas, consulta la [guía de solución de problemas de la monitorización serverless][39]. diff --git a/content/es/serverless/guide/datadog_forwarder_node.md b/content/es/serverless/guide/datadog_forwarder_node.md index a940166ff4679..9d4320482c3b7 100644 --- a/content/es/serverless/guide/datadog_forwarder_node.md +++ b/content/es/serverless/guide/datadog_forwarder_node.md @@ -5,7 +5,7 @@ title: Instrumentación de aplicaciones serverless de Node.js mediante el Datado ## Información general
-Si recién empiezas a utilizar Datadog Serverless, sigue las instrucciones para instrumentar tus funciones de Lambda mediante la Datadog Lambda Extension. Si configuraste Datadog Serverless con el Datadog Forwarder antes de que Lambda ofreciera la funcionalidad lista para usar, utiliza esta guía para mantener tu instancia. +Si eres un usuario nuevo de Datadog Serverless, sigue las instrucciones para instrumentar tus funciones de Lambda utilizando la extensión de Datadog Lambda. Si has configurado Datadog Serverless con el Datadog Forwarder antes de que Lambda ofreciera una funcionalidad predefinida, utiliza esta guía para mantener tu instancia.
## Requisitos previos @@ -44,7 +44,7 @@ datadog-ci lambda instrument -f -f -r ` y `` por los nombres de tu función de Lambda. - Reemplaza `` por el nombre de la región de AWS. -- Reemplaza `` por la versión de la librería Lambda de Datadog que quieres utilizar. La última versión es `{{< latest-lambda-layer-version layer="node" >}}`. +- Reemplaza `` por la versión de la biblioteca Lambda de Datadog que quieres utilizar. La última versión es `{{< latest-lambda-layer-version layer="node" >}}`. - Reemplaza `` por el nombre de recurso de Amazon (ARN) del Forwarder (consulta la [documentación del Forwarder][2]). Por ejemplo: @@ -65,7 +65,7 @@ Obtén más información y parámetros adicionales en la [documentación de la C {{% /tab %}} {{% tab "Serverless Framework" %}} -El complemento [Datadog Serverless Plugin][1] añade la librería Lambda de Datadog automáticamente a tus funciones mediante capas y configura las funciones para enviar métricas, trazas y logs a Datadog a través del [Datadog Forwarder][2]. +El complemento [Datadog Serverless Plugin][1] añade la biblioteca Lambda de Datadog automáticamente a tus funciones mediante capas y configura las funciones para enviar métricas, trazas y logs a Datadog a través del [Datadog Forwarder][2]. Si configuraste tu función de Lambda para utilizar la firma de código, debes añadir el ARN del perfil de firma de Datadog (`arn:aws:signer:us-east-1:464622532012:/signing-profiles/DatadogLambdaSigningProfile/9vMI9ZAGLc`) a la [configuración de firma de código][6] de tu función antes de poder instalar el Datadog Serverless Plugin. @@ -98,7 +98,7 @@ Para instalar y configurar el Datadog Serverless Plugin, sigue estos pasos: {{% /tab %}} {{% tab "AWS SAM" %}} -La [macro de CloudFormation de Datadog][1] transforma automáticamente tu plantilla de aplicación de SAM para añadir la librería Lambda de Datadog a tus funciones mediante capas. Además, configura las funciones para enviar métricas, trazas y logs a Datadog a través del [Datadog Forwarder][2]. +La [macro de CloudFormation de Datadog][1] transforma automáticamente tu plantilla de aplicación de SAM para añadir la biblioteca Lambda de Datadog a tus funciones mediante capas. Además, configura las funciones para enviar métricas, trazas y logs a Datadog a través del [Datadog Forwarder][2]. ### Instalar @@ -146,13 +146,13 @@ Obtén más información y parámetros adicionales en la [documentación de la m Las [Construcciones del Datadog CDK][1] configuran automáticamente la ingesta de métricas, trazas y logs de tus aplicaciones serverless mediante las siguientes acciones: -- La instalación y configuración de la librería Lambda de Datadog para tus funciones de Lambda de Python y Node.js. +- La instalación y configuración de la biblioteca Lambda de Datadog para tus funciones de Lambda de Python y Node.js. - La habilitación de la recopilación de trazas y métricas personalizadas de tus funciones de Lambda. - La gestión de las suscripciones del Datadog Forwarder a los grupos de logs de tus funciones de Lambda. ### Instalar -Ejecuta el siguiente comando de Yarn o NPM en tu proyecto del CDK para instalar la librería de Construcciones del Datadog CDK: +Ejecuta el siguiente comando de Yarn o NPM en tu proyecto del CDK para instalar la biblioteca de Construcciones del Datadog CDK: ```sh #Yarn @@ -202,7 +202,7 @@ Obtén más información y parámetros adicionales en la [página de NPM del Dat ### Instalar -Si vas a desplegar tu función de Lambda como una imagen de contenedor, no puedes utilizar la librería Lambda de Datadog como una capa. En su lugar, debes instalar la librería Lambda de Datadog como una dependencia de tu función dentro de la imagen. Si quieres utilizar el rastreo de Datadog, también debes instalar `dd-trace`. +Si vas a desplegar tu función de Lambda como una imagen de contenedor, no puedes utilizar la biblioteca Lambda de Datadog como una capa. En su lugar, debes instalar la biblioteca Lambda de Datadog como una dependencia de tu función dentro de la imagen. Si quieres utilizar el rastreo de Datadog, también debes instalar `dd-trace`. **NPM**: @@ -244,7 +244,7 @@ Suscribe la función de Lambda del Datadog Forwarder a cada uno de los grupos de ### Instalar -La librería Lambda de Datadog puede importarse como una capa o como un paquete de JavaScript. +La biblioteca Lambda de Datadog puede importarse como una capa o como un paquete de JavaScript. La versión secundaria del paquete `datadog-lambda-js` siempre coincide con la versión de la capa. Por ejemplo, la versión 0.5.0 de datadog-lambda-js coincide con el contenido de la versión 5 de la capa. @@ -267,7 +267,7 @@ Las opciones disponibles en `RUNTIME` son {{< latest-lambda-layer-version layer= arn:aws:lambda:us-east-1:464622532012:layer:Datadog-{{< latest-lambda-layer-version layer="node-example-version" >}}:{{< latest-lambda-layer-version layer="node" >}} ``` -Si configuraste tu función de Lambda para utilizar la firma de código, debes añadir el ARN del perfil de firma de Datadog (`arn:aws:signer:us-east-1:464622532012:/signing-profiles/DatadogLambdaSigningProfile/9vMI9ZAGLc`) a la [configuración de firma de código][2] de tu función antes de poder añadir la librería Lambda de Datadog como una capa. +Si configuraste tu función de Lambda para utilizar la firma de código, debes añadir el ARN del perfil de firma de Datadog (`arn:aws:signer:us-east-1:464622532012:/signing-profiles/DatadogLambdaSigningProfile/9vMI9ZAGLc`) a la [configuración de firma de código][2] de tu función antes de poder añadir la biblioteca Lambda de Datadog como una capa. #### Como un paquete @@ -386,4 +386,4 @@ Para obtener más información sobre el envío de métricas personalizadas, cons [2]: /es/getting_started/tagging/unified_service_tagging/#aws-lambda-functions [3]: https://app.datadoghq.com/functions [4]: /es/serverless/custom_metrics?tab=nodejs -[5]: /es/tracing/custom_instrumentation/nodejs/ +[5]: /es/tracing/custom_instrumentation/nodejs/ \ No newline at end of file diff --git a/content/es/service_management/on-call/_index.md b/content/es/service_management/on-call/_index.md index 24c13887bc4cd..9d0638617f457 100644 --- a/content/es/service_management/on-call/_index.md +++ b/content/es/service_management/on-call/_index.md @@ -64,13 +64,13 @@ Para restringir el acceso a un recurso de On-Call: 1. Ve al recurso de On-Call específico (cronograma, política de escalado, reglas de derivación a equipos 1. Haz clic en **Manage** (Gestionar). -1. Selecciona **Permisos** en el menú desplegable. +1. Selecciona **Permissions** (Permisos) en el menú desplegable. 1. Haz clic en **Restrict Access** (Restringir el acceso). 1. Selecciona uno o varios roles, equipos o usuarios en el menú desplegable. 1. Haz clic en **Add** (Añadir). 1. Selecciona el nivel de acceso que quieres asociar a cada uno de ellos en el menú desplegable situado junto a su nombre: - - **Visor**: Acceso de sólo lectura para ver el recurso. - - **Anulación** (sólo cronogramas): Se pueden ver y crear anulaciones de cronogramas. + - **Visor**: Acceso de solo lectura para ver el recurso. + - **Anulación** (solo cronogramas): Se pueden ver y crear anulaciones de cronogramas. - **Editor**: Acceso total para ver y modificar el recurso. 1. Haz clic en **Save** (Guardar). @@ -78,7 +78,7 @@ Para restringir el acceso a un recurso de On-Call: ## Empiece a utilizar Datadog On-Call -
Para conservar el historial de incidentes, Datadog On-Call no admite la eliminación de recursos como localizadores, políticas de escalado o cronogramas. Para probar On-Call sin afectar a tu entorno de producción, crea una organización de prueba como sandbox.
+
Para conservar el historial de incidentes, Datadog On-Call no admite la eliminación de recursos como páginas, políticas de escalado u horarios. Para testear On-Call sin afectar a tu entorno de producción, crea una organización de prueba como un entorno de pruebas.
Para empezar con On-Call [incorpora un equipo de On-Call][1] y asegúrate de que todos los miembros del equipo configuran sus [ajustes del perfil de On-Call][2] para recibir notificaciones. diff --git a/content/es/service_management/on-call/guides/_index.md b/content/es/service_management/on-call/guides/_index.md index ea22992c3c36b..6ddd3f8f7afaf 100644 --- a/content/es/service_management/on-call/guides/_index.md +++ b/content/es/service_management/on-call/guides/_index.md @@ -6,6 +6,7 @@ title: Guías de guardia {{< whatsnext desc="Guías generales:">}} {{< nextlink href="/service_management/on-call/guides/configure-mobile-device-for-on-call" >}}Configurar tu dispositivo móvil para Datadog On-Call{{< /nextlink >}} - {{< nextlink href="/service_management/on-call/guides/migrating-from-your-current-providers" >}}Migrar desde tu actual proveedor de servicios de guardia{{< /nextlink >}} + {{< nextlink href="/service_management/on-call/guides/migrating-from-your-current-providers" >}}Migrar desde tu proveedor de On-Call actual{{< /nextlink >}} {{< nextlink href="/service_management/on-call/guides/migrate-your-pagerduty-resources-to-on-call" >}}Migrar recursos de PagerDuty a Datadog On-Call{{< /nextlink >}} + {{< nextlink href="/service_management/on-call/guides/offboarding-teams-and-users" >}}Salida de equipos y usuarios desde Datadog On-Call{{< /nextlink >}} {{< /whatsnext >}} \ No newline at end of file diff --git a/content/es/service_management/on-call/guides/configure-mobile-device-for-on-call.md b/content/es/service_management/on-call/guides/configure-mobile-device-for-on-call.md index 158cf05c4a92b..19934b5472c20 100644 --- a/content/es/service_management/on-call/guides/configure-mobile-device-for-on-call.md +++ b/content/es/service_management/on-call/guides/configure-mobile-device-for-on-call.md @@ -10,7 +10,7 @@ Estar de guardia requiere notificaciones fiables y puntuales para asegurar que p 1. Instala la [aplicación móvil de Datadog][1]. 2. [Configurar notificaciones push](#set-up-push-notifications): habilita tu dispositivo para recibir notificaciones desde la aplicación móvil de Datadog. -3. [Evitar el modo silencio y No molestar](#circumvent-mute-and-do-not-disturb-mode): recibe notificaciones push, llamadas de voz y SMS mientras tu dispositivo está en modo No molestar. +3. [Circunvenir el modo silencio y No molestar](#circumvent-mute-and-do-not-disturb-mode-for-on-call): recibe notificaciones push, llamadas de voz y SMS mientras tu dispositivo está en modo No molestar. ## Establecer notificaciones push
@@ -47,8 +47,8 @@ Asegúrate de conceder a la aplicación móvil los permisos necesarios. {{% /tab %}} {{< /tabs >}} -### Sonidos personalizados -Tanto en iOS como en Android, tienes la opción de anular los sonidos de notificación predeterminados del sistema. La aplicación de Datadog viene precargada con una selección de sonidos personalizados. +### Sonidos personalizados +Tanto en iOS como en Android, tienes la opción de anular los sonidos de notificación predeterminados del sistema. La aplicación de Datadog viene precargada con una selección de sonidos personalizados. ## El modo Silencio y No molestar para On-Call Puedes anular el volumen de sistema de tu dispositivo y el modo No molestar tanto para las notificaciones push (desde la aplicación móvil de Datadog) como para las notificaciones de telefonía (como llamadas de voz y SMS). @@ -78,28 +78,30 @@ Puedes anular el volumen de sistema de tu dispositivo y el modo No molestar tant {{< img src="service_management/mobile/android_allow_notification_may_2025.png" alt="Anula tu volumen del sistema del dispositivo de Android y el modo No molestar." style="width:100%;" >}} -2. Si faltan permisos de notificación, pulsa **Bypass Do Not Disturb** (Ignorar No Molestar) y activa **Allow notifications** (Permitir notificaciones) en System Settings (Ajustes del sistema). +2. Si faltan permisos de notificación, pulsa **Bypass Do Not Disturb** (Anular No molestar) y activa **Allow notifications** (Permitir notificaciones) en System Settings (Ajustes del sistema). {{< img src="service_management/mobile/android_override_system_may_2025.png" alt="Anula tu volumen del sistema del dispositivo de Android y el modo No molestar." style="width:100%;" >}} 3. A continuación, pulsa **Bypass Do Not Disturb** (Ignorar No Molestar) y activa **Override Do Not Disturb** (Anular No Molestar) en Ajustes del sistema para On-Call de urgencia elevada. +**Para Samsung:** ve a las opciones **Settings** > **Notifications** > **Do Not Disturb** > **App notification** (Configuración > Notificaciones > No molestar > Notificación de la aplicación) del dispositivo. Selecciona Datadog como aplicación que omite No molestar. + {{< img src="service_management/mobile/android_override_system_volume_may_2025.png" alt="Anula tu volumen del sistema del dispositivo de Android y el modo No molestar." style="width:100%;" >}} -5. Para anular el volumen del sistema, toca **Override system volume** (Anular volumen del sistema) y permite **Mode access** (Modo de acceso) en System Settings (Configuración del sistema) para activar **Override system volume** (Anular volumen del sistema). +4. Para anular el volumen del sistema, toca **Override system volume** (Anular volumen del sistema) y permite **Mode access** (Modo de acceso) en System Settings (Configuración del sistema) para activar **Override system volume** (Anular volumen del sistema). -6. En la web, configura las preferencias de notificación para **Notificaciones muy urgentes** o **Notificaciones poco urgentes**. +5. En la web, configura las preferencias de notificación para **Notificaciones muy urgentes** o **Notificaciones poco urgentes**. -7. Prueba la configuración de tu notificación push crítica tocando **Test push notifications** (Probar notificaciones push). +6. Prueba la configuración de tu notificación push crítica tocando **Test push notifications** (Probar notificaciones push).
-En Android, la aplicación móvil de Datadog no puede omitir los ajustes de volumen de sistema o de No molestar cuando se utiliza dentro de un perfil de trabajo. Como solución, instala la aplicación móvil de Datadog en tu perfil personal. +En Android, la aplicación móvil de Datadog no puede omitir los ajustes de volumen del sistema o de No molestar cuando se utiliza dentro de un perfil de trabajo. Como solución, instala la aplicación móvil de Datadog en tu perfil personal.
{{% /tab %}} {{< /tabs >}} -### Sonidos personalizados para notificaciones push críticas -Para las notificaciones muy urgentes, Datadog recomienda encarecidamente personalizar los sonidos del sistema y la configuración del volumen. Esto garantiza que las alertas no sólo sean más claras y reconocibles, sino también más eficaces a la hora de captar la atención. +### Sonidos y volumen personalizados para un push crítico +Para las notificaciones de alta urgencia, Datadog recomienda encarecidamente personalizar los sonidos del sistema y la configuración del volumen. Esto garantiza que las alertas no solo sean más claras y reconocibles, sino también más eficaces a la hora de captar la atención. Testea tus preferencias de notificación para confirmar que se comportan como esperas. ### Canales de telefonía (llamadas de voz y SMS) @@ -117,6 +119,8 @@ Para mayor fiabilidad, Datadog utiliza un conjunto rotatorio de números de tel 3. Una vez creado este contacto, abre los ajustes del sistema iOS y ve a **Focus** > **Do Not Disturb** (Enfoque > No molestar). 4. En **People** (Personas), permite notificaciones desde el contacto de Datadog On-Call. Si has activado las alertas críticas para las aplicaciones push de Datadog, la aplicación móvil de Datadog también aparecerá en **Aplicaciones**. + +5. Para omitir el modo silencioso, desplázate hasta el contacto de Datadog On-Call >> pulsa **Ringtone** (Tono de llamada) >> activa **Emergency Bypass** (Anulación de emergencia). {{% /tab %}} {{% tab "Android" %}} @@ -129,7 +133,7 @@ Para mayor fiabilidad, Datadog utiliza un conjunto rotatorio de números de tel 3. Una vez creado este contacto, márcalo como favorito. -4. Abre los ajustes del sistema Android y ve a **Sound & vibration** > **Do Not Disturb** (Sonido y vibración > No molestar). Crea una excepción para el contacto de Datadog On-Call. +4. Abre la configuración del sistema Android y ve a **Sound & Vibration** > **Do Not Disturb** (Sonido y vibración > No molestar). Crea una excepción para el contacto de Datadog On-Call. {{% /tab %}} {{< /tabs >}} @@ -138,4 +142,70 @@ Para mayor fiabilidad, Datadog utiliza un conjunto rotatorio de números de tel Descarga la versión actual de la tarjeta de contacto de Datadog On-Call. Nota: La tarjeta de contacto está sujeta a cambios en cualquier momento.
-[1]: /es/service_management/mobile/?tab=ios \ No newline at end of file +## Widgets móviles de On-Call +Añade widgets de pantalla de inicio y pantalla de bloqueo de On-Call para acceder fácilmente a tus páginas y turnos. + +### Widget de la pantalla de inicio de On-Call + +Ve tus turnos y las páginas de On-Call en la pantalla de inicio de tu móvil con los widgets de Datadog. + +Puedes personalizar tus widgets de turnos de On-Call filtrando en: + +- Organización +- Periodo de tiempo + +Puedes personalizar tus widgets de página de On-Call filtrando en: + +- Organización +- Equipo +- Pedido + +**Nota**: Puedes añadir filtros adicionales para el widget de páginas de On-Call. + +#### Editar un widget de turno de On-Call + +{{< tabs >}} +{{% tab "iOS" %}} + +{{< img src="service_management/mobile/ios_shifts_widget_may_2025.png" alt="Página de inicio configurada de widgets de turno de On-Call que se muestran en pantallas de iOS" responsive="true" style="width:100%; background:none; border:none; box-shadow:none;">}} + +1. Mantén pulsado el widget durante un rato para configurarlo. +2. Pulsa **Edit Widget** (Editar widget) para acceder a la pantalla de configuración. +3. Selecciona la **Organization** (Organización) y el **Period** (Periodo) para el que deseas ver tus turnos de On-Call. +4. Pulsa en cualquier lugar fuera del widget para validar tus preferencias y salir de la pantalla de configuración. + + +{{% /tab %}} +{{% tab "Android" %}} + +{{< img src="service_management/mobile/android_shifts_widget_may_2025.png" alt="Página de inicio configurada de widgets de turno de On-Call que se muestran en pantallas de Android" responsive="true" style="width:100%; background:none; border:none; box-shadow:none;">}} + +1. Pulsa sobre el widget para configurarlo. +2. Selecciona la **Organization** (Organización) y el **Time Period** (Periodo de tiempo) para el que deseas ver tus turnos de On-Call. +3. Pulsa **✓** para guardar la configuración. +4. Mantén pulsado el widget durante un rato para elegir el tamaño que prefieras. + +{{% /tab %}} +{{< /tabs >}} + +### Widget de pantalla de bloqueo de On-Call + +El widget de pantalla de bloqueo de On-Call muestra tu estado de On-Call. Los widgets de la pantalla de bloqueo solo están disponibles en iOS. + +1. Pulsa prolongadamente en la pantalla de bloqueo. +2. Pulsa **Customize** (Personalizar) y, a continuación, **Lock Screen** (Pantalla de bloqueo). +3. Pulsa en el espacio para widgets de la pantalla de bloqueo para abrir la tarjeta **Add Widgets** (Añadir widgets). +4. Desplázate y pulsa sobre la aplicación **Datadog**. +4. Pulsa el widget de pantalla de bloqueo de On-Call. +5. Toca el widget en la pantalla de bloqueo para abrir el panel de configuración. +6. Selecciona la organización para la que deseas mostrar tu estado de On-Call. + +**Nota**: Debes tener un espacio vacío en tu pantalla de bloqueo para añadir un nuevo widget. Puedes eliminar widgets de la pantalla de bloqueo pulsando el botón **-** en la parte superior izquierda del widget que deseas eliminar. + +## Solucionar problemas +Si necesitas ayuda para solucionar problemas, [ponte en contacto con el servicio de asistencia de Datadog][2]. También puedes enviar un mensaje en el canal [público de Slack de Datadog][3] [#mobile-app][4]. + +[1]: /es/service_management/mobile/?tab=ios +[2]: /es/help/ +[3]: https://chat.datadoghq.com/ +[4]: https://datadoghq.slack.com/archives/C0114D5EHNG \ No newline at end of file diff --git a/content/es/tracing/recommendations/_index.md b/content/es/tracing/recommendations/_index.md index f77c420fb5258..30f848c2e26ce 100644 --- a/content/es/tracing/recommendations/_index.md +++ b/content/es/tracing/recommendations/_index.md @@ -94,6 +94,7 @@ multifiltersearch: - filter_by: true id: recommendation_prerequisite name: Requisito previo de la recomendación +site_support_id: apm_recommendations title: Recomendaciones de APM --- @@ -128,7 +129,7 @@ Al examinar conjuntamente estas fuentes, Datadog encuentra formas de ayudarte a Revisar las recomendaciones que requieren tu atención: -1. Ve a [**APM** > **Recommendations**][1] (APM > Recomendaciones). +1. Ve a [**APM** > **Recommendations** (APM > Recomendaciones)][1]. 2. Revisa las recomendaciones en **For Review** (Para revisión). 3. Selecciona una recomendación de la lista para ver el problema, el impacto y cómo resolverlo. 4. Revisa el problema, su impacto y la recomendación de Datadog para resolverlo. diff --git a/content/fr/logs/guide/docker-logs-collection-troubleshooting-guide.md b/content/fr/logs/guide/docker-logs-collection-troubleshooting-guide.md index 6d6f2a44a8d09..5f576587007e8 100644 --- a/content/fr/logs/guide/docker-logs-collection-troubleshooting-guide.md +++ b/content/fr/logs/guide/docker-logs-collection-troubleshooting-guide.md @@ -134,30 +134,6 @@ Si vos logs ne sont pas transmis à la plate-forme Datadog alors que le statut d * Le port utilisé pour l'envoi de logs à Datadog (10516) est bloqué * Votre conteneur utilise un pilote de logging autre que celui attendu par l'Agent -#### Le trafic sortant du port 10516 est bloqué - -L'Agent Datadog envoie ses logs à Datadog par TCP via le port 10516. Si cette connexion n'est pas disponible, les logs ne sont pas envoyés et une erreur est enregistrée dans le fichier `agent.log`. - -Vous pouvez tester manuellement votre connexion avec OpenSSL, GnuTLS ou un autre client SSL/TLS. Pour OpenSSL, exécutez la commande suivante : - -```shell -openssl s_client -connect intake.logs.datadoghq.com:10516 -``` - -Pour GnuTLS, exécutez la commande suivante : - -```shell -gnutls-cli intake.logs.datadoghq.com:10516 -``` - -Envoyez ensuite un log comme suit : - -```text - Ceci est un message test -``` - -Si vous ne pouvez pas ouvrir le port 10516, vous pouvez configurer l'Agent Datadog de façon à envoyer les logs via HTTPS en définissant la variable d'environnement `DD_LOGS_CONFIG_USE_HTTP` sur `true` : - #### Vos conteneurs n'utilisent pas le pilote de logging JSON Étant donné que Docker utilise le pilote de logging json-file par défaut, l'Agent de conteneur tente d'abord de recueillir les logs à partir de celui-ci. Si vos conteneurs sont configurés de façon à utiliser un autre pilote de logging, l'Agent indique qu'il parvient à trouver vos conteneurs, mais qu'il n'est pas en mesure de recueillir leurs logs. L'Agent de conteneur peut également être configuré de façon à lire les logs à partir du pilote journald. diff --git a/content/ja/logs/guide/docker-logs-collection-troubleshooting-guide.md b/content/ja/logs/guide/docker-logs-collection-troubleshooting-guide.md index ed4fca80465c3..e3c935ce3e177 100644 --- a/content/ja/logs/guide/docker-logs-collection-troubleshooting-guide.md +++ b/content/ja/logs/guide/docker-logs-collection-troubleshooting-guide.md @@ -134,30 +134,6 @@ Docker ソケットへのアクセスを可能にするには、`-v /var/run/doc * Datadog へのログの送信に必要なポート (10516) がブロックされる。 * Agent が予期するものとは異なるロギングドライバーが、コンテナに使用されている。 -#### ポート 10516 のアウトバウンドトラフィックがブロックされる - -Datadog Agent は、ポート 10516 を使って TCP で Datadog にログを送信します。この接続が使用できない場合、ログは送信に失敗し、それを示すエラーが `agent.log` ファイルに記録されます。 - -OpenSSL、GnuTLS、または他の SSL/TLS クライアントを使用して、接続を手動でテストすることができます。OpenSSL の場合は、以下のコマンドを実行します。 - -```shell -openssl s_client -connect intake.logs.datadoghq.com:10516 -``` - -GnuTLS の場合、以下のコマンドを実行します。 - -```shell -gnutls-cli intake.logs.datadoghq.com:10516 -``` - -さらに、次のようなログを送信します。 - -```text - これはテストメッセージです -``` - -ポート 10516 を開くことを選択できない場合は、`DD_LOGS_CONFIG_FORCE_USE_HTTP` 環境変数を `true` に設定して、Datadog Agent が HTTPS 経由でログを送信するよう構成することができます。 - #### コンテナに JSON ロギングドライバーが使用されていない Docker のデフォルトのロギングドライバーは json-file であり、コンテナ Agent はまずこのドライバーから読み取ろうとします。コンテナが別のロギングドライバーを使用するように設定されている場合、ログ Agent はコンテナを見つけることはできますが、ログを収集することができません。コンテナ Agent は、journald ロギングドライバーから読み取るように構成することもできます。 diff --git a/content/ko/logs/guide/docker-logs-collection-troubleshooting-guide.md b/content/ko/logs/guide/docker-logs-collection-troubleshooting-guide.md index fa3f870662780..98521e83aa878 100644 --- a/content/ko/logs/guide/docker-logs-collection-troubleshooting-guide.md +++ b/content/ko/logs/guide/docker-logs-collection-troubleshooting-guide.md @@ -134,30 +134,6 @@ Logs Agent 상태가 [Agent 상태 확인](#check-the-agent-status)의 예와 * Datadog으로 로그를 전송하는 데 필요한 포트(10516)가 차단되었습니다. * 컨테이너가 Agent가 예상하는 것과 다른 로깅 드라이버를 사용하고 있습니다. -#### 포트 10516의 아웃바운드 트래픽이 차단되었습니다. - -Datadog Agent는 포트 10516을 사용하여 TCP를 통해 Datadog에 로그를 보냅니다. 해당 연결을 사용할 수 없는 경우 로그 전송이 실패하고 그에 따른 오류가 `agent.log` 파일에 기록됩니다. - -OpenSSL, GnuTLS 또는 다른 SSL/TLS 클라이언트를 사용하여 연결을 수동으로 테스트할 수 있습니다. OpenSSL의 경우 다음 명령을 실행합니다. - -```shell -openssl s_client -connect intake.logs.datadoghq.com:10516 -``` - -GnuTLS의 경우 다음 명령을 실행합니다. - -```shell -gnutls-cli intake.logs.datadoghq.com:10516 -``` - -그런 다음 다음과 같은 로그를 보냅니다. - -```text - 테스트 메시지입니다 -``` - -포트 10516을 여는 것이 옵션이 아닌 경우 `DD_LOGS_CONFIG_USE_HTTP` 환경 변수를 `true`로 설정하여 HTTPS를 통해 로그를 보내도록 Datadog Agent를 설정할 수 있습니다. - #### 컨테이너가 JSON 로깅 드라이버를 사용하지 않습니다. Docker의 기본값은 json 파일 로깅 드라이버이므로 Container Agent는 먼저 이 드라이버에서 읽기를 시도합니다. 컨테이너가 다른 로깅 드라이버를 사용하도록 설정된 경우 Logs Agent는 컨테이너를 성공적으로 찾을 수 있지만 로그를 수집할 수 없음을 나타냅니다. journald 로깅 드라이버에서 읽도록 Container Agent를 설정할 수도 있습니다. @@ -197,7 +173,7 @@ logs_config: docker_client_read_timeout: 60 ``` -## Host Agent +## 호스트 에이전트 ### Docker 그룹의 Agent 사용자 Host Agent를 사용하는 경우 Docker 소켓에서 읽을 수 있는 권한을 가지려면 `dd-agent` 사용자를 Docker 그룹에 추가해야 합니다. `agent.log` 파일에 다음 오류 로그가 표시되는 경우: diff --git a/data/api/v1/full_spec.yaml b/data/api/v1/full_spec.yaml index 2f5040c1eda18..aca5d805b8ec0 100644 --- a/data/api/v1/full_spec.yaml +++ b/data/api/v1/full_spec.yaml @@ -20936,6 +20936,11 @@ components: hours in the current date for the given org. format: int64 type: integer + apm_enterprise_standalone_hosts_top99p: + description: Shows the 99th percentile of all distinct standalone Enterprise + hosts over all hours in the current date for all organizations. + format: int64 + type: integer apm_fargate_count_avg: description: Shows the average of all APM ECS Fargate tasks over all hours in the current date for all organizations. @@ -20946,6 +20951,11 @@ components: hours in the current date for all organizations. format: int64 type: integer + apm_pro_standalone_hosts_top99p: + description: Shows the 99th percentile of all distinct standalone Pro hosts + over all hours in the current date for all organizations. + format: int64 + type: integer appsec_fargate_count_avg: description: Shows the average of all Application Security Monitoring ECS Fargate tasks over all hours in the current date for all organizations. @@ -22034,6 +22044,11 @@ components: hours in the current date for the given org. format: int64 type: integer + apm_enterprise_standalone_hosts_top99p: + description: Shows the 99th percentile of all distinct standalone Enterprise + hosts over all hours in the current date for the given org. + format: int64 + type: integer apm_fargate_count_avg: description: Shows the average of all APM ECS Fargate tasks over all hours in the current month for the given org. @@ -22044,6 +22059,11 @@ components: hours in the current date for the given org. format: int64 type: integer + apm_pro_standalone_hosts_top99p: + description: Shows the 99th percentile of all distinct standalone Pro hosts + over all hours in the current date for the given org. + format: int64 + type: integer appsec_fargate_count_avg: description: Shows the average of all Application Security Monitoring ECS Fargate tasks over all hours in the current month for the given org. @@ -23136,6 +23156,11 @@ components: hours in the current month for all organizations. format: int64 type: integer + apm_enterprise_standalone_hosts_top99p_sum: + description: Shows the sum of the 99th percentile of all distinct standalone + Enterprise hosts over all hours in the current month for all organizations. + format: int64 + type: integer apm_fargate_count_avg_sum: description: Shows the average of all APM ECS Fargate tasks over all hours in the current month for all organizations. @@ -23146,6 +23171,11 @@ components: hours in the current month for all organizations. format: int64 type: integer + apm_pro_standalone_hosts_top99p_sum: + description: Shows the sum of the 99th percentile of all distinct standalone + Pro hosts over all hours in the current month for all organizations. + format: int64 + type: integer appsec_fargate_count_avg_sum: description: Shows the average of all Application Security Monitoring ECS Fargate tasks over all hours in the current month for all organizations. @@ -26055,7 +26085,9 @@ paths: - api_keys_write /api/v1/application_key: get: - description: Get all application keys available for your Datadog account. + description: 'Get all application keys available for your Datadog account. + + This endpoint is disabled for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode).' operationId: ListApplicationKeys responses: '200': @@ -26082,7 +26114,9 @@ paths: - org_app_keys_read - user_app_keys post: - description: Create an application key with a given name. + description: 'Create an application key with a given name. + + This endpoint is disabled for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode).' operationId: CreateApplicationKey requestBody: content: @@ -26128,7 +26162,9 @@ paths: - user_app_keys /api/v1/application_key/{key}: delete: - description: Delete a given application key. + description: 'Delete a given application key. + + This endpoint is disabled for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode).' operationId: DeleteApplicationKey parameters: - description: The specific APP key you are working with. @@ -26168,7 +26204,9 @@ paths: - org_app_keys_write - user_app_keys get: - description: Get a given application key. + description: 'Get a given application key. + + This endpoint is disabled for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode).' operationId: GetApplicationKey parameters: - description: The specific APP key you are working with. @@ -26208,7 +26246,9 @@ paths: - org_app_keys_read - user_app_keys put: - description: Edit an application key name. + description: 'Edit an application key name. + + This endpoint is disabled for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode).' operationId: UpdateApplicationKey parameters: - description: The specific APP key you are working with. diff --git a/data/api/v1/full_spec_deref.json b/data/api/v1/full_spec_deref.json index d71bdbfcd2da3..4f45e26a1a086 100644 --- a/data/api/v1/full_spec_deref.json +++ b/data/api/v1/full_spec_deref.json @@ -581579,6 +581579,11 @@ "format": "int64", "type": "integer" }, + "apm_enterprise_standalone_hosts_top99p": { + "description": "Shows the 99th percentile of all distinct standalone Enterprise hosts over all hours in the current date for all organizations.", + "format": "int64", + "type": "integer" + }, "apm_fargate_count_avg": { "description": "Shows the average of all APM ECS Fargate tasks over all hours in the current date for all organizations.", "format": "int64", @@ -581589,6 +581594,11 @@ "format": "int64", "type": "integer" }, + "apm_pro_standalone_hosts_top99p": { + "description": "Shows the 99th percentile of all distinct standalone Pro hosts over all hours in the current date for all organizations.", + "format": "int64", + "type": "integer" + }, "appsec_fargate_count_avg": { "description": "Shows the average of all Application Security Monitoring ECS Fargate tasks over all hours in the current date for all organizations.", "format": "int64", @@ -582219,6 +582229,11 @@ "format": "int64", "type": "integer" }, + "apm_enterprise_standalone_hosts_top99p": { + "description": "Shows the 99th percentile of all distinct standalone Enterprise hosts over all hours in the current date for the given org.", + "format": "int64", + "type": "integer" + }, "apm_fargate_count_avg": { "description": "Shows the average of all APM ECS Fargate tasks over all hours in the current month for the given org.", "format": "int64", @@ -582229,6 +582244,11 @@ "format": "int64", "type": "integer" }, + "apm_pro_standalone_hosts_top99p": { + "description": "Shows the 99th percentile of all distinct standalone Pro hosts over all hours in the current date for the given org.", + "format": "int64", + "type": "integer" + }, "appsec_fargate_count_avg": { "description": "Shows the average of all Application Security Monitoring ECS Fargate tasks over all hours in the current month for the given org.", "format": "int64", @@ -583681,6 +583701,11 @@ "format": "int64", "type": "integer" }, + "apm_enterprise_standalone_hosts_top99p": { + "description": "Shows the 99th percentile of all distinct standalone Enterprise hosts over all hours in the current date for the given org.", + "format": "int64", + "type": "integer" + }, "apm_fargate_count_avg": { "description": "Shows the average of all APM ECS Fargate tasks over all hours in the current month for the given org.", "format": "int64", @@ -583691,6 +583716,11 @@ "format": "int64", "type": "integer" }, + "apm_pro_standalone_hosts_top99p": { + "description": "Shows the 99th percentile of all distinct standalone Pro hosts over all hours in the current date for the given org.", + "format": "int64", + "type": "integer" + }, "appsec_fargate_count_avg": { "description": "Shows the average of all Application Security Monitoring ECS Fargate tasks over all hours in the current month for the given org.", "format": "int64", @@ -584733,6 +584763,11 @@ "format": "int64", "type": "integer" }, + "apm_enterprise_standalone_hosts_top99p_sum": { + "description": "Shows the sum of the 99th percentile of all distinct standalone Enterprise hosts over all hours in the current month for all organizations.", + "format": "int64", + "type": "integer" + }, "apm_fargate_count_avg_sum": { "description": "Shows the average of all APM ECS Fargate tasks over all hours in the current month for all organizations.", "format": "int64", @@ -584743,6 +584778,11 @@ "format": "int64", "type": "integer" }, + "apm_pro_standalone_hosts_top99p_sum": { + "description": "Shows the sum of the 99th percentile of all distinct standalone Pro hosts over all hours in the current month for all organizations.", + "format": "int64", + "type": "integer" + }, "appsec_fargate_count_avg_sum": { "description": "Shows the average of all Application Security Monitoring ECS Fargate tasks over all hours in the current month for all organizations.", "format": "int64", @@ -585920,6 +585960,11 @@ "format": "int64", "type": "integer" }, + "apm_enterprise_standalone_hosts_top99p": { + "description": "Shows the 99th percentile of all distinct standalone Enterprise hosts over all hours in the current date for all organizations.", + "format": "int64", + "type": "integer" + }, "apm_fargate_count_avg": { "description": "Shows the average of all APM ECS Fargate tasks over all hours in the current date for all organizations.", "format": "int64", @@ -585930,6 +585975,11 @@ "format": "int64", "type": "integer" }, + "apm_pro_standalone_hosts_top99p": { + "description": "Shows the 99th percentile of all distinct standalone Pro hosts over all hours in the current date for all organizations.", + "format": "int64", + "type": "integer" + }, "appsec_fargate_count_avg": { "description": "Shows the average of all Application Security Monitoring ECS Fargate tasks over all hours in the current date for all organizations.", "format": "int64", @@ -586560,6 +586610,11 @@ "format": "int64", "type": "integer" }, + "apm_enterprise_standalone_hosts_top99p": { + "description": "Shows the 99th percentile of all distinct standalone Enterprise hosts over all hours in the current date for the given org.", + "format": "int64", + "type": "integer" + }, "apm_fargate_count_avg": { "description": "Shows the average of all APM ECS Fargate tasks over all hours in the current month for the given org.", "format": "int64", @@ -586570,6 +586625,11 @@ "format": "int64", "type": "integer" }, + "apm_pro_standalone_hosts_top99p": { + "description": "Shows the 99th percentile of all distinct standalone Pro hosts over all hours in the current date for the given org.", + "format": "int64", + "type": "integer" + }, "appsec_fargate_count_avg": { "description": "Shows the average of all Application Security Monitoring ECS Fargate tasks over all hours in the current month for the given org.", "format": "int64", @@ -705275,7 +705335,7 @@ }, "/api/v1/application_key": { "get": { - "description": "Get all application keys available for your Datadog account.", + "description": "Get all application keys available for your Datadog account.\nThis endpoint is disabled for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode).", "operationId": "ListApplicationKeys", "responses": { "200": { @@ -705400,7 +705460,7 @@ } }, "post": { - "description": "Create an application key with a given name.", + "description": "Create an application key with a given name.\nThis endpoint is disabled for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode).", "operationId": "CreateApplicationKey", "requestBody": { "content": { @@ -705609,7 +705669,7 @@ }, "/api/v1/application_key/{key}": { "delete": { - "description": "Delete a given application key.", + "description": "Delete a given application key.\nThis endpoint is disabled for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode).", "operationId": "DeleteApplicationKey", "parameters": [ { @@ -705767,7 +705827,7 @@ } }, "get": { - "description": "Get a given application key.", + "description": "Get a given application key.\nThis endpoint is disabled for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode).", "operationId": "GetApplicationKey", "parameters": [ { @@ -705925,7 +705985,7 @@ } }, "put": { - "description": "Edit an application key name.", + "description": "Edit an application key name.\nThis endpoint is disabled for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode).", "operationId": "UpdateApplicationKey", "parameters": [ { @@ -1192914,6 +1192974,11 @@ "format": "int64", "type": "integer" }, + "apm_enterprise_standalone_hosts_top99p_sum": { + "description": "Shows the sum of the 99th percentile of all distinct standalone Enterprise hosts over all hours in the current month for all organizations.", + "format": "int64", + "type": "integer" + }, "apm_fargate_count_avg_sum": { "description": "Shows the average of all APM ECS Fargate tasks over all hours in the current month for all organizations.", "format": "int64", @@ -1192924,6 +1192989,11 @@ "format": "int64", "type": "integer" }, + "apm_pro_standalone_hosts_top99p_sum": { + "description": "Shows the sum of the 99th percentile of all distinct standalone Pro hosts over all hours in the current month for all organizations.", + "format": "int64", + "type": "integer" + }, "appsec_fargate_count_avg_sum": { "description": "Shows the average of all Application Security Monitoring ECS Fargate tasks over all hours in the current month for all organizations.", "format": "int64", @@ -1194101,6 +1194171,11 @@ "format": "int64", "type": "integer" }, + "apm_enterprise_standalone_hosts_top99p": { + "description": "Shows the 99th percentile of all distinct standalone Enterprise hosts over all hours in the current date for all organizations.", + "format": "int64", + "type": "integer" + }, "apm_fargate_count_avg": { "description": "Shows the average of all APM ECS Fargate tasks over all hours in the current date for all organizations.", "format": "int64", @@ -1194111,6 +1194186,11 @@ "format": "int64", "type": "integer" }, + "apm_pro_standalone_hosts_top99p": { + "description": "Shows the 99th percentile of all distinct standalone Pro hosts over all hours in the current date for all organizations.", + "format": "int64", + "type": "integer" + }, "appsec_fargate_count_avg": { "description": "Shows the average of all Application Security Monitoring ECS Fargate tasks over all hours in the current date for all organizations.", "format": "int64", @@ -1194741,6 +1194821,11 @@ "format": "int64", "type": "integer" }, + "apm_enterprise_standalone_hosts_top99p": { + "description": "Shows the 99th percentile of all distinct standalone Enterprise hosts over all hours in the current date for the given org.", + "format": "int64", + "type": "integer" + }, "apm_fargate_count_avg": { "description": "Shows the average of all APM ECS Fargate tasks over all hours in the current month for the given org.", "format": "int64", @@ -1194751,6 +1194836,11 @@ "format": "int64", "type": "integer" }, + "apm_pro_standalone_hosts_top99p": { + "description": "Shows the 99th percentile of all distinct standalone Pro hosts over all hours in the current date for the given org.", + "format": "int64", + "type": "integer" + }, "appsec_fargate_count_avg": { "description": "Shows the average of all Application Security Monitoring ECS Fargate tasks over all hours in the current month for the given org.", "format": "int64", diff --git a/data/api/v1/translate_actions.json b/data/api/v1/translate_actions.json index 61d53876190e4..7d8cb8ab74f94 100644 --- a/data/api/v1/translate_actions.json +++ b/data/api/v1/translate_actions.json @@ -28,25 +28,25 @@ "request_schema_description": "Datadog API key." }, "ListApplicationKeys": { - "description": "Get all application keys available for your Datadog account.", + "description": "Get all application keys available for your Datadog account.\nThis endpoint is disabled for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode).", "summary": "Get all application keys" }, "CreateApplicationKey": { - "description": "Create an application key with a given name.", + "description": "Create an application key with a given name.\nThis endpoint is disabled for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode).", "summary": "Create an application key", "request_description": "", "request_schema_description": "An application key with its associated metadata." }, "DeleteApplicationKey": { - "description": "Delete a given application key.", + "description": "Delete a given application key.\nThis endpoint is disabled for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode).", "summary": "Delete an application key" }, "GetApplicationKey": { - "description": "Get a given application key.", + "description": "Get a given application key.\nThis endpoint is disabled for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode).", "summary": "Get an application key" }, "UpdateApplicationKey": { - "description": "Edit an application key name.", + "description": "Edit an application key name.\nThis endpoint is disabled for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode).", "summary": "Edit an application key", "request_description": "", "request_schema_description": "An application key with its associated metadata." diff --git a/data/api/v2/full_spec.yaml b/data/api/v2/full_spec.yaml index d745676458d79..a42a26147bb8a 100644 --- a/data/api/v2/full_spec.yaml +++ b/data/api/v2/full_spec.yaml @@ -449,7 +449,7 @@ components: type: string GetIssueIncludeQueryParameter: description: Comma-separated list of relationship objects that should be included - in the response. + in the response. Possible values are `assignee`, `case`, and `team_owners`. explode: false in: query name: include @@ -1003,7 +1003,8 @@ components: $ref: '#/components/schemas/ServiceDefinitionSchemaVersions' SearchIssuesIncludeQueryParameter: description: Comma-separated list of relationship objects that should be included - in the response. + in the response. Possible values are `issue`, `issue.assignee`, `issue.case`, + and `issue.team_owners`. explode: false in: query name: include @@ -11514,6 +11515,35 @@ components: $ref: '#/components/schemas/ConfluentResourceResponseData' type: array type: object + ConnectedTeamRef: + description: Reference to a team from an external system. + properties: + data: + $ref: '#/components/schemas/ConnectedTeamRefData' + type: object + ConnectedTeamRefData: + description: Reference to connected external team. + properties: + id: + description: The connected team ID as it is referenced throughout the Datadog + ecosystem. + example: '@GitHubOrg/team-handle' + type: string + type: + $ref: '#/components/schemas/ConnectedTeamRefDataType' + required: + - id + - type + type: object + ConnectedTeamRefDataType: + default: github_team + description: External team resource type. + enum: + - github_team + example: github_team + type: string + x-enum-varnames: + - GITHUB_TEAM Connection: description: The definition of `Connection` object. properties: @@ -11578,6 +11608,50 @@ components: - label - tags type: object + ConnectionsPagePagination: + description: Page-based pagination metadata. + properties: + first_number: + description: The first page number. + format: int64 + type: integer + last_number: + description: The last page number. + format: int64 + type: integer + next_number: + description: The next page number. + format: int64 + nullable: true + type: integer + number: + description: The current page number. + format: int64 + type: integer + prev_number: + description: The previous page number. + format: int64 + nullable: true + type: integer + size: + description: The page size. + format: int64 + type: integer + total: + description: Total connections matching request. + format: int64 + type: integer + type: + description: Pagination type. + example: number_size + type: string + type: object + ConnectionsResponseMeta: + description: Connections response metadata. + properties: + page: + $ref: '#/components/schemas/ConnectionsPagePagination' + type: object Container: description: Container object. properties: @@ -47424,6 +47498,14 @@ components: the queries to search signals in the signal explorer. example: env:staging status:low type: string + tags: + description: List of tags associated with the suppression rule. + example: + - technique:T1110-brute-force + - source:cloudtrail + items: + type: string + type: array update_date: description: A Unix millisecond timestamp given the update date of the suppression rule. @@ -47485,6 +47567,14 @@ components: same syntax as the queries to search signals in the Signals Explorer. example: env:staging status:low type: string + tags: + description: List of tags associated with the suppression rule. + example: + - technique:T1110-brute-force + - source:cloudtrail + items: + type: string + type: array required: - name - enabled @@ -47580,6 +47670,14 @@ components: the queries to search signals in the signal explorer. example: env:staging status:low type: string + tags: + description: List of tags associated with the suppression rule. + example: + - technique:T1110-brute-force + - source:cloudtrail + items: + type: string + type: array version: description: The current version of the suppression. This is optional, but it can help prevent concurrent modifications. @@ -51430,6 +51528,7 @@ components: - $ref: '#/components/schemas/TableResultV2DataAttributesFileMetadataCloudStorage' - $ref: '#/components/schemas/TableResultV2DataAttributesFileMetadataLocalFile' TableResultV2DataAttributesFileMetadataCloudStorage: + additionalProperties: false description: File metadata for reference tables created by cloud storage. properties: access_details: @@ -51476,6 +51575,7 @@ components: - OPERATION_ERROR - SYSTEM_ERROR TableResultV2DataAttributesFileMetadataLocalFile: + additionalProperties: false description: File metadata for reference tables created by upload. Note that upload_id is only returned in the immediate create/replace response and is not available in subsequent GET requests. @@ -51776,6 +51876,111 @@ components: - handle - name type: object + TeamConnection: + description: A relationship between a Datadog team and a team from another external + system. + properties: + attributes: + $ref: '#/components/schemas/TeamConnectionAttributes' + id: + description: The unique identifier of the team connection. + example: 12345678-1234-5678-9abc-123456789012 + type: string + relationships: + $ref: '#/components/schemas/TeamConnectionRelationships' + type: + $ref: '#/components/schemas/TeamConnectionType' + required: + - id + - type + type: object + TeamConnectionAttributes: + description: Attributes of the team connection. + properties: + managed_by: + description: The entity that manages this team connection. + example: github_sync + type: string + source: + description: The name of the external source. + example: github + type: string + type: object + TeamConnectionCreateData: + description: Data for creating a team connection. + properties: + attributes: + $ref: '#/components/schemas/TeamConnectionAttributes' + relationships: + $ref: '#/components/schemas/TeamConnectionRelationships' + type: + $ref: '#/components/schemas/TeamConnectionType' + required: + - type + type: object + TeamConnectionCreateRequest: + description: Request for creating team connections. + properties: + data: + description: Array of team connections to create. + items: + $ref: '#/components/schemas/TeamConnectionCreateData' + type: array + required: + - data + type: object + TeamConnectionDeleteRequest: + description: Request for deleting team connections. + properties: + data: + description: Array of team connection IDs to delete. + items: + $ref: '#/components/schemas/TeamConnectionDeleteRequestDataItem' + type: array + required: + - data + type: object + TeamConnectionDeleteRequestDataItem: + description: A collection of connection ids to delete. + properties: + id: + description: The unique identifier of the team connection to delete. + example: 12345678-1234-5678-9abc-123456789012 + type: string + type: + $ref: '#/components/schemas/TeamConnectionType' + required: + - id + - type + type: object + TeamConnectionRelationships: + description: Relationships of the team connection. + properties: + connected_team: + $ref: '#/components/schemas/ConnectedTeamRef' + team: + $ref: '#/components/schemas/TeamRef' + type: object + TeamConnectionType: + default: team_connection + description: Team connection resource type. + enum: + - team_connection + example: team_connection + type: string + x-enum-varnames: + - TEAM_CONNECTION + TeamConnectionsResponse: + description: Response containing information about multiple team connections. + properties: + data: + description: Array of team connections. + items: + $ref: '#/components/schemas/TeamConnection' + type: array + meta: + $ref: '#/components/schemas/ConnectionsResponseMeta' + type: object TeamCreate: description: Team create properties: @@ -52193,6 +52398,34 @@ components: $ref: '#/components/schemas/TeamPermissionSetting' type: array type: object + TeamRef: + description: Reference to a Datadog team. + properties: + data: + $ref: '#/components/schemas/TeamRefData' + type: object + TeamRefData: + description: Reference to a Datadog team. + properties: + id: + description: The Datadog team ID. + example: 87654321-4321-8765-dcba-210987654321 + type: string + type: + $ref: '#/components/schemas/TeamRefDataType' + required: + - id + - type + type: object + TeamRefDataType: + default: team + description: Datadog team resource type. + enum: + - team + example: team + type: string + x-enum-varnames: + - TEAM TeamReference: description: Provides a reference to a team, including ID, type, and basic attributes/relationships. properties: @@ -54437,6 +54670,12 @@ components: icon: description: URL of the user's icon. type: string + last_login_time: + description: The last time the user logged in. + format: date-time + nullable: true + readOnly: true + type: string mfa_enabled: description: If user has MFA enabled. readOnly: true @@ -63567,7 +63806,9 @@ paths: permissions: - user_app_keys get: - description: Get an application key owned by current user + description: 'Get an application key owned by current user. + + The `key` field is not returned for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode).' operationId: GetCurrentUserApplicationKey parameters: - $ref: '#/components/parameters/ApplicationKeyID' @@ -63601,7 +63842,9 @@ paths: permissions: - user_app_keys patch: - description: Edit an application key owned by current user + description: 'Edit an application key owned by current user. + + The `key` field is not returned for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode).' operationId: UpdateCurrentUserApplicationKey parameters: - $ref: '#/components/parameters/ApplicationKeyID' @@ -82638,6 +82881,169 @@ paths: permissions: - teams_read - teams_manage + /api/v2/team/connections: + delete: + description: Delete multiple team connections. + operationId: DeleteTeamConnections + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TeamConnectionDeleteRequest' + required: true + responses: + '204': + description: No Content + '400': + $ref: '#/components/responses/BadRequestResponse' + '403': + $ref: '#/components/responses/ForbiddenResponse' + '404': + $ref: '#/components/responses/NotFoundResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - teams_read + summary: Delete team connections + tags: + - Team Connections + x-menu-order: 3 + x-permission: + operator: OR + permissions: + - teams_read + x-unstable: '**Note**: This endpoint is in Preview. To request access, fill + out this [form](https://www.datadoghq.com/product-preview/github-integration-for-teams/). + + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + get: + description: Returns all team connections. + operationId: ListTeamConnections + parameters: + - $ref: '#/components/parameters/PageSize' + - $ref: '#/components/parameters/PageNumber' + - description: Filter team connections by external source systems. + explode: false + in: query + name: filter[sources] + required: false + schema: + items: + example: github + type: string + type: array + style: form + - description: Filter team connections by Datadog team IDs. + explode: false + in: query + name: filter[team_ids] + required: false + schema: + items: + example: 12345678-1234-5678-9abc-123456789012 + type: string + type: array + style: form + - description: Filter team connections by connected team IDs from external systems. + explode: false + in: query + name: filter[connected_team_ids] + required: false + schema: + items: + example: '@MyGitHubAccount/my-team-name' + type: string + type: array + style: form + - description: Filter team connections by connection IDs. + explode: false + in: query + name: filter[connection_ids] + required: false + schema: + items: + example: 12345678-1234-5678-9abc-123456789012 + type: string + type: array + style: form + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TeamConnectionsResponse' + description: OK + '400': + $ref: '#/components/responses/BadRequestResponse' + '403': + $ref: '#/components/responses/ForbiddenResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - teams_read + summary: List team connections + tags: + - Team Connections + x-menu-order: 1 + x-pagination: + limitParam: page[size] + pageParam: page[number] + resultsPath: data + x-permission: + operator: OR + permissions: + - teams_read + x-unstable: '**Note**: This endpoint is in Preview. To request access, fill + out this [form](https://www.datadoghq.com/product-preview/github-integration-for-teams/). + + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + post: + description: Create multiple team connections. + operationId: CreateTeamConnections + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TeamConnectionCreateRequest' + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/TeamConnectionsResponse' + description: Created + '400': + $ref: '#/components/responses/BadRequestResponse' + '403': + $ref: '#/components/responses/ForbiddenResponse' + '409': + $ref: '#/components/responses/ConflictResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - teams_read + summary: Create team connections + tags: + - Team Connections + x-menu-order: 2 + x-permission: + operator: OR + permissions: + - teams_read + x-unstable: '**Note**: This endpoint is in Preview. To request access, fill + out this [form](https://www.datadoghq.com/product-preview/github-integration-for-teams/). + + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' /api/v2/team/sync: post: description: 'This endpoint attempts to link your existing Datadog teams with @@ -85935,6 +86341,9 @@ tags: use Datadog\u2019s API to\nmanage both test types programmatically.\n\nFor more information about Synthetics, see the [Synthetics overview](https://docs.datadoghq.com/synthetics/)." name: Synthetics +- description: View and manage relationships between Datadog teams and teams from + external sources, such as GitHub. + name: Team Connections - description: View and manage teams within Datadog. See the [Teams page](https://docs.datadoghq.com/account_management/teams/) for more information. name: Teams diff --git a/data/api/v2/full_spec_deref.json b/data/api/v2/full_spec_deref.json index 7e2ea912fc95a..0e1df9b3b83b4 100644 --- a/data/api/v2/full_spec_deref.json +++ b/data/api/v2/full_spec_deref.json @@ -646,7 +646,7 @@ } }, "GetIssueIncludeQueryParameter": { - "description": "Comma-separated list of relationship objects that should be included in the response.", + "description": "Comma-separated list of relationship objects that should be included in the response. Possible values are `assignee`, `case`, and `team_owners`.", "explode": false, "in": "query", "name": "include", @@ -1454,7 +1454,7 @@ } }, "SearchIssuesIncludeQueryParameter": { - "description": "Comma-separated list of relationship objects that should be included in the response.", + "description": "Comma-separated list of relationship objects that should be included in the response. Possible values are `issue`, `issue.assignee`, `issue.case`, and `issue.team_owners`.", "explode": false, "in": "query", "name": "include", @@ -3114,6 +3114,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -3409,6 +3416,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -3988,6 +4002,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -21753,6 +21774,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -22140,6 +22168,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -71370,6 +71405,78 @@ }, "type": "object" }, + "ConnectedTeamRef": { + "description": "Reference to a team from an external system.", + "properties": { + "data": { + "description": "Reference to connected external team.", + "properties": { + "id": { + "description": "The connected team ID as it is referenced throughout the Datadog ecosystem.", + "example": "@GitHubOrg/team-handle", + "type": "string" + }, + "type": { + "default": "github_team", + "description": "External team resource type.", + "enum": [ + "github_team" + ], + "example": "github_team", + "type": "string", + "x-enum-varnames": [ + "GITHUB_TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + }, + "ConnectedTeamRefData": { + "description": "Reference to connected external team.", + "properties": { + "id": { + "description": "The connected team ID as it is referenced throughout the Datadog ecosystem.", + "example": "@GitHubOrg/team-handle", + "type": "string" + }, + "type": { + "default": "github_team", + "description": "External team resource type.", + "enum": [ + "github_team" + ], + "example": "github_team", + "type": "string", + "x-enum-varnames": [ + "GITHUB_TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "ConnectedTeamRefDataType": { + "default": "github_team", + "description": "External team resource type.", + "enum": [ + "github_team" + ], + "example": "github_team", + "type": "string", + "x-enum-varnames": [ + "GITHUB_TEAM" + ] + }, "Connection": { "description": "The definition of `Connection` object.", "properties": { @@ -71511,6 +71618,108 @@ ], "type": "object" }, + "ConnectionsPagePagination": { + "description": "Page-based pagination metadata.", + "properties": { + "first_number": { + "description": "The first page number.", + "format": "int64", + "type": "integer" + }, + "last_number": { + "description": "The last page number.", + "format": "int64", + "type": "integer" + }, + "next_number": { + "description": "The next page number.", + "format": "int64", + "nullable": true, + "type": "integer" + }, + "number": { + "description": "The current page number.", + "format": "int64", + "type": "integer" + }, + "prev_number": { + "description": "The previous page number.", + "format": "int64", + "nullable": true, + "type": "integer" + }, + "size": { + "description": "The page size.", + "format": "int64", + "type": "integer" + }, + "total": { + "description": "Total connections matching request.", + "format": "int64", + "type": "integer" + }, + "type": { + "description": "Pagination type.", + "example": "number_size", + "type": "string" + } + }, + "type": "object" + }, + "ConnectionsResponseMeta": { + "description": "Connections response metadata.", + "properties": { + "page": { + "description": "Page-based pagination metadata.", + "properties": { + "first_number": { + "description": "The first page number.", + "format": "int64", + "type": "integer" + }, + "last_number": { + "description": "The last page number.", + "format": "int64", + "type": "integer" + }, + "next_number": { + "description": "The next page number.", + "format": "int64", + "nullable": true, + "type": "integer" + }, + "number": { + "description": "The current page number.", + "format": "int64", + "type": "integer" + }, + "prev_number": { + "description": "The previous page number.", + "format": "int64", + "nullable": true, + "type": "integer" + }, + "size": { + "description": "The page size.", + "format": "int64", + "type": "integer" + }, + "total": { + "description": "Total connections matching request.", + "format": "int64", + "type": "integer" + }, + "type": { + "description": "Pagination type.", + "example": "number_size", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, "Container": { "description": "Container object.", "properties": { @@ -102102,6 +102311,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -102958,6 +103174,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -148001,6 +148224,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -148487,6 +148717,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -148738,6 +148975,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -151971,6 +152215,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -153117,6 +153368,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -153659,6 +153917,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -154322,6 +154587,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -155319,6 +155591,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -156698,6 +156977,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -158251,6 +158537,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -158954,6 +159247,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -159742,6 +160042,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -168775,6 +169082,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -169231,6 +169545,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -170052,6 +170373,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -170609,6 +170937,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -171061,6 +171396,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -171877,6 +172219,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -173019,6 +173368,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -173852,6 +174208,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -174312,6 +174675,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -187043,6 +187413,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -189399,6 +189776,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -202320,6 +202704,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -221040,577 +221431,591 @@ "description": "URL of the user's icon.", "type": "string" }, - "mfa_enabled": { - "description": "If user has MFA enabled.", - "readOnly": true, - "type": "boolean" - }, - "modified_at": { - "description": "Time that the user was last modified.", + "last_login_time": { + "description": "The last time the user logged in.", "format": "date-time", - "type": "string" - }, - "name": { - "description": "Name of the user.", - "nullable": true, - "type": "string" - }, - "service_account": { - "description": "Whether the user is a service account.", - "type": "boolean" - }, - "status": { - "description": "Status of the user.", - "type": "string" - }, - "title": { - "description": "Title of the user.", "nullable": true, - "type": "string" - }, - "verified": { - "description": "Whether the user is verified.", - "type": "boolean" - } - }, - "type": "object" - }, - "id": { - "description": "ID of the user.", - "type": "string" - }, - "relationships": { - "description": "Relationships of the user object returned by the API.", - "properties": { - "org": { - "description": "Relationship to an organization.", - "properties": { - "data": { - "description": "Relationship to organization object.", - "properties": { - "id": { - "description": "ID of the organization.", - "example": "00000000-0000-beef-0000-000000000000", - "type": "string" - }, - "type": { - "default": "orgs", - "description": "Organizations resource type.", - "enum": [ - "orgs" - ], - "example": "orgs", - "type": "string", - "x-enum-varnames": [ - "ORGS" - ] - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "other_orgs": { - "description": "Relationship to organizations.", - "properties": { - "data": { - "description": "Relationships to organization objects.", - "example": [], - "items": { - "description": "Relationship to organization object.", - "properties": { - "id": { - "description": "ID of the organization.", - "example": "00000000-0000-beef-0000-000000000000", - "type": "string" - }, - "type": { - "default": "orgs", - "description": "Organizations resource type.", - "enum": [ - "orgs" - ], - "example": "orgs", - "type": "string", - "x-enum-varnames": [ - "ORGS" - ] - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "type": "array" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "other_users": { - "description": "Relationship to users.", - "properties": { - "data": { - "description": "Relationships to user objects.", - "example": [], - "items": { - "description": "Relationship to user object.", - "properties": { - "id": { - "description": "A unique identifier that represents the user.", - "example": "00000000-0000-0000-2345-000000000000", - "type": "string" - }, - "type": { - "default": "users", - "description": "Users resource type.", - "enum": [ - "users" - ], - "example": "users", - "type": "string", - "x-enum-varnames": [ - "USERS" - ] - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "type": "array" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "roles": { - "description": "Relationship to roles.", - "properties": { - "data": { - "description": "An array containing type and the unique identifier of a role.", - "items": { - "description": "Relationship to role object.", - "properties": { - "id": { - "description": "The unique identifier of the role.", - "example": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", - "type": "string" - }, - "type": { - "default": "roles", - "description": "Roles type.", - "enum": [ - "roles" - ], - "example": "roles", - "type": "string", - "x-enum-varnames": [ - "ROLES" - ] - } - }, - "type": "object" - }, - "type": "array" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "type": { - "default": "users", - "description": "Users resource type.", - "enum": [ - "users" - ], - "example": "users", - "type": "string", - "x-enum-varnames": [ - "USERS" - ] - } - }, - "type": "object" - } - ] - }, - "type": "array" - } - }, - "type": "object" - }, - "MonitorNotificationRuleName": { - "description": "The name of the monitor notification rule.", - "example": "A notification rule name", - "maxLength": 1000, - "minLength": 1, - "type": "string" - }, - "MonitorNotificationRuleRecipients": { - "description": "A list of recipients to notify. Uses the same format as the monitor `message` field. Must not start with an '@'.", - "example": [ - "slack-test-channel", - "jira-test" - ], - "items": { - "description": "individual recipient.", - "maxLength": 255, - "type": "string" - }, - "maxItems": 20, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "MonitorNotificationRuleRelationships": { - "description": "All relationships associated with monitor notification rule.", - "properties": { - "created_by": { - "description": "The user who created the monitor notification rule.", - "properties": { - "data": { - "description": "Data for the user who created the monitor notification rule.", - "nullable": true, - "properties": { - "id": { - "description": "User ID of the monitor notification rule creator.", - "example": "00000000-0000-1234-0000-000000000000", - "type": "string" - }, - "type": { - "default": "users", - "description": "Users resource type.", - "enum": [ - "users" - ], - "example": "users", - "type": "string", - "x-enum-varnames": [ - "USERS" - ] - } - }, - "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "MonitorNotificationRuleRelationshipsCreatedBy": { - "description": "The user who created the monitor notification rule.", - "properties": { - "data": { - "description": "Data for the user who created the monitor notification rule.", - "nullable": true, - "properties": { - "id": { - "description": "User ID of the monitor notification rule creator.", - "example": "00000000-0000-1234-0000-000000000000", - "type": "string" - }, - "type": { - "default": "users", - "description": "Users resource type.", - "enum": [ - "users" - ], - "example": "users", - "type": "string", - "x-enum-varnames": [ - "USERS" - ] - } - }, - "type": "object" - } - }, - "type": "object" - }, - "MonitorNotificationRuleRelationshipsCreatedByData": { - "description": "Data for the user who created the monitor notification rule.", - "nullable": true, - "properties": { - "id": { - "description": "User ID of the monitor notification rule creator.", - "example": "00000000-0000-1234-0000-000000000000", - "type": "string" - }, - "type": { - "default": "users", - "description": "Users resource type.", - "enum": [ - "users" - ], - "example": "users", - "type": "string", - "x-enum-varnames": [ - "USERS" - ] - } - }, - "type": "object" - }, - "MonitorNotificationRuleResourceType": { - "default": "monitor-notification-rule", - "description": "Monitor notification rule resource type.", - "enum": [ - "monitor-notification-rule" - ], - "example": "monitor-notification-rule", - "type": "string", - "x-enum-varnames": [ - "MONITOR_NOTIFICATION_RULE" - ] - }, - "MonitorNotificationRuleResponse": { - "description": "A monitor notification rule.", - "properties": { - "data": { - "description": "Monitor notification rule data.", - "properties": { - "attributes": { - "additionalProperties": {}, - "description": "Attributes of the monitor notification rule.", - "properties": { - "conditional_recipients": { - "description": "Use conditional recipients to define different recipients for different situations.", - "properties": { - "conditions": { - "description": "Conditions of the notification rule.", - "items": { - "description": "Conditions for `conditional_recipients`.", - "properties": { - "recipients": { - "description": "A list of recipients to notify. Uses the same format as the monitor `message` field. Must not start with an '@'.", - "example": [ - "slack-test-channel", - "jira-test" - ], - "items": { - "description": "individual recipient.", - "maxLength": 255, - "type": "string" - }, - "maxItems": 20, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "scope": { - "description": "The scope to which the monitor applied.", - "example": "transition_type:alert", - "maxLength": 3000, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "scope", - "recipients" - ], - "type": "object" - }, - "maxItems": 10, - "minItems": 1, - "type": "array" - }, - "fallback_recipients": { - "description": "If none of the `conditions` applied, `fallback_recipients` will get notified.", - "example": [ - "slack-test-channel", - "jira-test" - ], - "items": { - "description": "individual recipient.", - "maxLength": 255, - "type": "string" - }, - "maxItems": 20, - "minItems": 1, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "conditions" - ], - "type": "object" - }, - "created": { - "description": "Creation time of the monitor notification rule.", - "example": "2020-01-02T03:04:00.000Z", - "format": "date-time", - "type": "string" - }, - "filter": { - "description": "Filter used to associate the notification rule with monitors.", - "oneOf": [ - { - "additionalProperties": false, - "description": "Filter monitors by tags. Monitors must match all tags.", - "properties": { - "tags": { - "description": "A list of monitor tags.", - "example": [ - "team:product", - "host:abc" - ], - "items": { - "maxLength": 255, - "type": "string" - }, - "maxItems": 20, - "minItems": 1, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "tags" - ], - "type": "object" - } - ] - }, - "modified": { - "description": "Time the monitor notification rule was last modified.", - "example": "2020-01-02T03:04:00.000Z", - "format": "date-time", - "type": "string" - }, - "name": { - "description": "The name of the monitor notification rule.", - "example": "A notification rule name", - "maxLength": 1000, - "minLength": 1, - "type": "string" - }, - "recipients": { - "description": "A list of recipients to notify. Uses the same format as the monitor `message` field. Must not start with an '@'.", - "example": [ - "slack-test-channel", - "jira-test" - ], - "items": { - "description": "individual recipient.", - "maxLength": 255, - "type": "string" - }, - "maxItems": 20, - "minItems": 1, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" - }, - "id": { - "description": "The ID of the monitor notification rule.", - "example": "00000000-0000-1234-0000-000000000000", - "type": "string" - }, - "relationships": { - "description": "All relationships associated with monitor notification rule.", - "properties": { - "created_by": { - "description": "The user who created the monitor notification rule.", - "properties": { - "data": { - "description": "Data for the user who created the monitor notification rule.", - "nullable": true, - "properties": { - "id": { - "description": "User ID of the monitor notification rule creator.", - "example": "00000000-0000-1234-0000-000000000000", - "type": "string" - }, - "type": { - "default": "users", - "description": "Users resource type.", - "enum": [ - "users" - ], - "example": "users", - "type": "string", - "x-enum-varnames": [ - "USERS" - ] - } - }, - "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "type": { - "default": "monitor-notification-rule", - "description": "Monitor notification rule resource type.", - "enum": [ - "monitor-notification-rule" - ], - "example": "monitor-notification-rule", - "type": "string", - "x-enum-varnames": [ - "MONITOR_NOTIFICATION_RULE" - ] - } - }, - "type": "object" - }, - "included": { - "description": "Array of objects related to the monitor notification rule that the user requested.", - "items": { - "description": "An object related to a monitor notification rule.", - "oneOf": [ - { - "description": "User object returned by the API.", - "properties": { - "attributes": { - "description": "Attributes of user object returned by the API.", - "properties": { - "created_at": { - "description": "Creation time of the user.", - "format": "date-time", - "type": "string" - }, - "disabled": { - "description": "Whether the user is disabled.", - "type": "boolean" - }, - "email": { - "description": "Email of the user.", - "type": "string" - }, - "handle": { - "description": "Handle of the user.", - "type": "string" - }, - "icon": { - "description": "URL of the user's icon.", + "readOnly": true, + "type": "string" + }, + "mfa_enabled": { + "description": "If user has MFA enabled.", + "readOnly": true, + "type": "boolean" + }, + "modified_at": { + "description": "Time that the user was last modified.", + "format": "date-time", + "type": "string" + }, + "name": { + "description": "Name of the user.", + "nullable": true, + "type": "string" + }, + "service_account": { + "description": "Whether the user is a service account.", + "type": "boolean" + }, + "status": { + "description": "Status of the user.", + "type": "string" + }, + "title": { + "description": "Title of the user.", + "nullable": true, + "type": "string" + }, + "verified": { + "description": "Whether the user is verified.", + "type": "boolean" + } + }, + "type": "object" + }, + "id": { + "description": "ID of the user.", + "type": "string" + }, + "relationships": { + "description": "Relationships of the user object returned by the API.", + "properties": { + "org": { + "description": "Relationship to an organization.", + "properties": { + "data": { + "description": "Relationship to organization object.", + "properties": { + "id": { + "description": "ID of the organization.", + "example": "00000000-0000-beef-0000-000000000000", + "type": "string" + }, + "type": { + "default": "orgs", + "description": "Organizations resource type.", + "enum": [ + "orgs" + ], + "example": "orgs", + "type": "string", + "x-enum-varnames": [ + "ORGS" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "other_orgs": { + "description": "Relationship to organizations.", + "properties": { + "data": { + "description": "Relationships to organization objects.", + "example": [], + "items": { + "description": "Relationship to organization object.", + "properties": { + "id": { + "description": "ID of the organization.", + "example": "00000000-0000-beef-0000-000000000000", + "type": "string" + }, + "type": { + "default": "orgs", + "description": "Organizations resource type.", + "enum": [ + "orgs" + ], + "example": "orgs", + "type": "string", + "x-enum-varnames": [ + "ORGS" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "other_users": { + "description": "Relationship to users.", + "properties": { + "data": { + "description": "Relationships to user objects.", + "example": [], + "items": { + "description": "Relationship to user object.", + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-2345-000000000000", + "type": "string" + }, + "type": { + "default": "users", + "description": "Users resource type.", + "enum": [ + "users" + ], + "example": "users", + "type": "string", + "x-enum-varnames": [ + "USERS" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "roles": { + "description": "Relationship to roles.", + "properties": { + "data": { + "description": "An array containing type and the unique identifier of a role.", + "items": { + "description": "Relationship to role object.", + "properties": { + "id": { + "description": "The unique identifier of the role.", + "example": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", + "type": "string" + }, + "type": { + "default": "roles", + "description": "Roles type.", + "enum": [ + "roles" + ], + "example": "roles", + "type": "string", + "x-enum-varnames": [ + "ROLES" + ] + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": { + "default": "users", + "description": "Users resource type.", + "enum": [ + "users" + ], + "example": "users", + "type": "string", + "x-enum-varnames": [ + "USERS" + ] + } + }, + "type": "object" + } + ] + }, + "type": "array" + } + }, + "type": "object" + }, + "MonitorNotificationRuleName": { + "description": "The name of the monitor notification rule.", + "example": "A notification rule name", + "maxLength": 1000, + "minLength": 1, + "type": "string" + }, + "MonitorNotificationRuleRecipients": { + "description": "A list of recipients to notify. Uses the same format as the monitor `message` field. Must not start with an '@'.", + "example": [ + "slack-test-channel", + "jira-test" + ], + "items": { + "description": "individual recipient.", + "maxLength": 255, + "type": "string" + }, + "maxItems": 20, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "MonitorNotificationRuleRelationships": { + "description": "All relationships associated with monitor notification rule.", + "properties": { + "created_by": { + "description": "The user who created the monitor notification rule.", + "properties": { + "data": { + "description": "Data for the user who created the monitor notification rule.", + "nullable": true, + "properties": { + "id": { + "description": "User ID of the monitor notification rule creator.", + "example": "00000000-0000-1234-0000-000000000000", + "type": "string" + }, + "type": { + "default": "users", + "description": "Users resource type.", + "enum": [ + "users" + ], + "example": "users", + "type": "string", + "x-enum-varnames": [ + "USERS" + ] + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "MonitorNotificationRuleRelationshipsCreatedBy": { + "description": "The user who created the monitor notification rule.", + "properties": { + "data": { + "description": "Data for the user who created the monitor notification rule.", + "nullable": true, + "properties": { + "id": { + "description": "User ID of the monitor notification rule creator.", + "example": "00000000-0000-1234-0000-000000000000", + "type": "string" + }, + "type": { + "default": "users", + "description": "Users resource type.", + "enum": [ + "users" + ], + "example": "users", + "type": "string", + "x-enum-varnames": [ + "USERS" + ] + } + }, + "type": "object" + } + }, + "type": "object" + }, + "MonitorNotificationRuleRelationshipsCreatedByData": { + "description": "Data for the user who created the monitor notification rule.", + "nullable": true, + "properties": { + "id": { + "description": "User ID of the monitor notification rule creator.", + "example": "00000000-0000-1234-0000-000000000000", + "type": "string" + }, + "type": { + "default": "users", + "description": "Users resource type.", + "enum": [ + "users" + ], + "example": "users", + "type": "string", + "x-enum-varnames": [ + "USERS" + ] + } + }, + "type": "object" + }, + "MonitorNotificationRuleResourceType": { + "default": "monitor-notification-rule", + "description": "Monitor notification rule resource type.", + "enum": [ + "monitor-notification-rule" + ], + "example": "monitor-notification-rule", + "type": "string", + "x-enum-varnames": [ + "MONITOR_NOTIFICATION_RULE" + ] + }, + "MonitorNotificationRuleResponse": { + "description": "A monitor notification rule.", + "properties": { + "data": { + "description": "Monitor notification rule data.", + "properties": { + "attributes": { + "additionalProperties": {}, + "description": "Attributes of the monitor notification rule.", + "properties": { + "conditional_recipients": { + "description": "Use conditional recipients to define different recipients for different situations.", + "properties": { + "conditions": { + "description": "Conditions of the notification rule.", + "items": { + "description": "Conditions for `conditional_recipients`.", + "properties": { + "recipients": { + "description": "A list of recipients to notify. Uses the same format as the monitor `message` field. Must not start with an '@'.", + "example": [ + "slack-test-channel", + "jira-test" + ], + "items": { + "description": "individual recipient.", + "maxLength": 255, + "type": "string" + }, + "maxItems": 20, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "scope": { + "description": "The scope to which the monitor applied.", + "example": "transition_type:alert", + "maxLength": 3000, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "scope", + "recipients" + ], + "type": "object" + }, + "maxItems": 10, + "minItems": 1, + "type": "array" + }, + "fallback_recipients": { + "description": "If none of the `conditions` applied, `fallback_recipients` will get notified.", + "example": [ + "slack-test-channel", + "jira-test" + ], + "items": { + "description": "individual recipient.", + "maxLength": 255, + "type": "string" + }, + "maxItems": 20, + "minItems": 1, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "conditions" + ], + "type": "object" + }, + "created": { + "description": "Creation time of the monitor notification rule.", + "example": "2020-01-02T03:04:00.000Z", + "format": "date-time", + "type": "string" + }, + "filter": { + "description": "Filter used to associate the notification rule with monitors.", + "oneOf": [ + { + "additionalProperties": false, + "description": "Filter monitors by tags. Monitors must match all tags.", + "properties": { + "tags": { + "description": "A list of monitor tags.", + "example": [ + "team:product", + "host:abc" + ], + "items": { + "maxLength": 255, + "type": "string" + }, + "maxItems": 20, + "minItems": 1, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "tags" + ], + "type": "object" + } + ] + }, + "modified": { + "description": "Time the monitor notification rule was last modified.", + "example": "2020-01-02T03:04:00.000Z", + "format": "date-time", + "type": "string" + }, + "name": { + "description": "The name of the monitor notification rule.", + "example": "A notification rule name", + "maxLength": 1000, + "minLength": 1, + "type": "string" + }, + "recipients": { + "description": "A list of recipients to notify. Uses the same format as the monitor `message` field. Must not start with an '@'.", + "example": [ + "slack-test-channel", + "jira-test" + ], + "items": { + "description": "individual recipient.", + "maxLength": 255, + "type": "string" + }, + "maxItems": 20, + "minItems": 1, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "id": { + "description": "The ID of the monitor notification rule.", + "example": "00000000-0000-1234-0000-000000000000", + "type": "string" + }, + "relationships": { + "description": "All relationships associated with monitor notification rule.", + "properties": { + "created_by": { + "description": "The user who created the monitor notification rule.", + "properties": { + "data": { + "description": "Data for the user who created the monitor notification rule.", + "nullable": true, + "properties": { + "id": { + "description": "User ID of the monitor notification rule creator.", + "example": "00000000-0000-1234-0000-000000000000", + "type": "string" + }, + "type": { + "default": "users", + "description": "Users resource type.", + "enum": [ + "users" + ], + "example": "users", + "type": "string", + "x-enum-varnames": [ + "USERS" + ] + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": { + "default": "monitor-notification-rule", + "description": "Monitor notification rule resource type.", + "enum": [ + "monitor-notification-rule" + ], + "example": "monitor-notification-rule", + "type": "string", + "x-enum-varnames": [ + "MONITOR_NOTIFICATION_RULE" + ] + } + }, + "type": "object" + }, + "included": { + "description": "Array of objects related to the monitor notification rule that the user requested.", + "items": { + "description": "An object related to a monitor notification rule.", + "oneOf": [ + { + "description": "User object returned by the API.", + "properties": { + "attributes": { + "description": "Attributes of user object returned by the API.", + "properties": { + "created_at": { + "description": "Creation time of the user.", + "format": "date-time", + "type": "string" + }, + "disabled": { + "description": "Whether the user is disabled.", + "type": "boolean" + }, + "email": { + "description": "Email of the user.", + "type": "string" + }, + "handle": { + "description": "Handle of the user.", + "type": "string" + }, + "icon": { + "description": "URL of the user's icon.", + "type": "string" + }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, "type": "string" }, "mfa_enabled": { @@ -221997,6 +222402,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -273010,6 +273422,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -277136,6 +277555,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -334082,6 +334508,17 @@ "example": "env:staging status:low", "type": "string" }, + "tags": { + "description": "List of tags associated with the suppression rule.", + "example": [ + "technique:T1110-brute-force", + "source:cloudtrail" + ], + "items": { + "type": "string" + }, + "type": "array" + }, "update_date": { "description": "A Unix millisecond timestamp given the update date of the suppression rule.", "format": "int64", @@ -334206,6 +334643,17 @@ "example": "env:staging status:low", "type": "string" }, + "tags": { + "description": "List of tags associated with the suppression rule.", + "example": [ + "technique:T1110-brute-force", + "source:cloudtrail" + ], + "items": { + "type": "string" + }, + "type": "array" + }, "update_date": { "description": "A Unix millisecond timestamp given the update date of the suppression rule.", "format": "int64", @@ -334282,6 +334730,17 @@ "description": "The suppression query of the suppression rule. If a signal matches this query, it is suppressed and is not triggered. It uses the same syntax as the queries to search signals in the Signals Explorer.", "example": "env:staging status:low", "type": "string" + }, + "tags": { + "description": "List of tags associated with the suppression rule.", + "example": [ + "technique:T1110-brute-force", + "source:cloudtrail" + ], + "items": { + "type": "string" + }, + "type": "array" } }, "required": [ @@ -334338,6 +334797,17 @@ "description": "The suppression query of the suppression rule. If a signal matches this query, it is suppressed and is not triggered. It uses the same syntax as the queries to search signals in the Signals Explorer.", "example": "env:staging status:low", "type": "string" + }, + "tags": { + "description": "List of tags associated with the suppression rule.", + "example": [ + "technique:T1110-brute-force", + "source:cloudtrail" + ], + "items": { + "type": "string" + }, + "type": "array" } }, "required": [ @@ -334416,6 +334886,17 @@ "description": "The suppression query of the suppression rule. If a signal matches this query, it is suppressed and is not triggered. It uses the same syntax as the queries to search signals in the Signals Explorer.", "example": "env:staging status:low", "type": "string" + }, + "tags": { + "description": "List of tags associated with the suppression rule.", + "example": [ + "technique:T1110-brute-force", + "source:cloudtrail" + ], + "items": { + "type": "string" + }, + "type": "array" } }, "required": [ @@ -334533,6 +335014,17 @@ "example": "env:staging status:low", "type": "string" }, + "tags": { + "description": "List of tags associated with the suppression rule.", + "example": [ + "technique:T1110-brute-force", + "source:cloudtrail" + ], + "items": { + "type": "string" + }, + "type": "array" + }, "update_date": { "description": "A Unix millisecond timestamp given the update date of the suppression rule.", "format": "int64", @@ -334647,6 +335139,17 @@ "example": "env:staging status:low", "type": "string" }, + "tags": { + "description": "List of tags associated with the suppression rule.", + "example": [ + "technique:T1110-brute-force", + "source:cloudtrail" + ], + "items": { + "type": "string" + }, + "type": "array" + }, "version": { "description": "The current version of the suppression. This is optional, but it can help prevent concurrent modifications.", "format": "int32", @@ -334706,6 +335209,17 @@ "example": "env:staging status:low", "type": "string" }, + "tags": { + "description": "List of tags associated with the suppression rule.", + "example": [ + "technique:T1110-brute-force", + "source:cloudtrail" + ], + "items": { + "type": "string" + }, + "type": "array" + }, "version": { "description": "The current version of the suppression. This is optional, but it can help prevent concurrent modifications.", "format": "int32", @@ -334787,6 +335301,17 @@ "example": "env:staging status:low", "type": "string" }, + "tags": { + "description": "List of tags associated with the suppression rule.", + "example": [ + "technique:T1110-brute-force", + "source:cloudtrail" + ], + "items": { + "type": "string" + }, + "type": "array" + }, "version": { "description": "The current version of the suppression. This is optional, but it can help prevent concurrent modifications.", "format": "int32", @@ -334901,6 +335426,17 @@ "example": "env:staging status:low", "type": "string" }, + "tags": { + "description": "List of tags associated with the suppression rule.", + "example": [ + "technique:T1110-brute-force", + "source:cloudtrail" + ], + "items": { + "type": "string" + }, + "type": "array" + }, "update_date": { "description": "A Unix millisecond timestamp given the update date of the suppression rule.", "format": "int64", @@ -358110,6 +358646,7 @@ "description": "Metadata specifying where and how to access the reference table's data file.", "oneOf": [ { + "additionalProperties": false, "description": "File metadata for reference tables created by cloud storage.", "properties": { "access_details": { @@ -358252,6 +358789,7 @@ "type": "object" }, { + "additionalProperties": false, "description": "File metadata for reference tables created by upload. Note that upload_id is only returned in the immediate create/replace response and is not available in subsequent GET requests.", "properties": { "error_message": { @@ -358526,6 +359064,7 @@ "description": "Metadata specifying where and how to access the reference table's data file.", "oneOf": [ { + "additionalProperties": false, "description": "File metadata for reference tables created by cloud storage.", "properties": { "access_details": { @@ -358668,6 +359207,7 @@ "type": "object" }, { + "additionalProperties": false, "description": "File metadata for reference tables created by upload. Note that upload_id is only returned in the immediate create/replace response and is not available in subsequent GET requests.", "properties": { "error_message": { @@ -358853,6 +359393,7 @@ "description": "Metadata specifying where and how to access the reference table's data file.", "oneOf": [ { + "additionalProperties": false, "description": "File metadata for reference tables created by cloud storage.", "properties": { "access_details": { @@ -358995,6 +359536,7 @@ "type": "object" }, { + "additionalProperties": false, "description": "File metadata for reference tables created by upload. Note that upload_id is only returned in the immediate create/replace response and is not available in subsequent GET requests.", "properties": { "error_message": { @@ -359168,6 +359710,7 @@ "description": "Metadata specifying where and how to access the reference table's data file.", "oneOf": [ { + "additionalProperties": false, "description": "File metadata for reference tables created by cloud storage.", "properties": { "access_details": { @@ -359310,6 +359853,7 @@ "type": "object" }, { + "additionalProperties": false, "description": "File metadata for reference tables created by upload. Note that upload_id is only returned in the immediate create/replace response and is not available in subsequent GET requests.", "properties": { "error_message": { @@ -359448,6 +359992,7 @@ "description": "Metadata specifying where and how to access the reference table's data file.", "oneOf": [ { + "additionalProperties": false, "description": "File metadata for reference tables created by cloud storage.", "properties": { "access_details": { @@ -359590,6 +360135,7 @@ "type": "object" }, { + "additionalProperties": false, "description": "File metadata for reference tables created by upload. Note that upload_id is only returned in the immediate create/replace response and is not available in subsequent GET requests.", "properties": { "error_message": { @@ -359608,6 +360154,7 @@ ] }, "TableResultV2DataAttributesFileMetadataCloudStorage": { + "additionalProperties": false, "description": "File metadata for reference tables created by cloud storage.", "properties": { "access_details": { @@ -359776,6 +360323,7 @@ ] }, "TableResultV2DataAttributesFileMetadataLocalFile": { + "additionalProperties": false, "description": "File metadata for reference tables created by upload. Note that upload_id is only returned in the immediate create/replace response and is not available in subsequent GET requests.", "properties": { "error_message": { @@ -360507,6 +361055,698 @@ ], "type": "object" }, + "TeamConnection": { + "description": "A relationship between a Datadog team and a team from another external system.", + "properties": { + "attributes": { + "description": "Attributes of the team connection.", + "properties": { + "managed_by": { + "description": "The entity that manages this team connection.", + "example": "github_sync", + "type": "string" + }, + "source": { + "description": "The name of the external source.", + "example": "github", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "The unique identifier of the team connection.", + "example": "12345678-1234-5678-9abc-123456789012", + "type": "string" + }, + "relationships": { + "description": "Relationships of the team connection.", + "properties": { + "connected_team": { + "description": "Reference to a team from an external system.", + "properties": { + "data": { + "description": "Reference to connected external team.", + "properties": { + "id": { + "description": "The connected team ID as it is referenced throughout the Datadog ecosystem.", + "example": "@GitHubOrg/team-handle", + "type": "string" + }, + "type": { + "default": "github_team", + "description": "External team resource type.", + "enum": [ + "github_team" + ], + "example": "github_team", + "type": "string", + "x-enum-varnames": [ + "GITHUB_TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + }, + "team": { + "description": "Reference to a Datadog team.", + "properties": { + "data": { + "description": "Reference to a Datadog team.", + "properties": { + "id": { + "description": "The Datadog team ID.", + "example": "87654321-4321-8765-dcba-210987654321", + "type": "string" + }, + "type": { + "default": "team", + "description": "Datadog team resource type.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": { + "default": "team_connection", + "description": "Team connection resource type.", + "enum": [ + "team_connection" + ], + "example": "team_connection", + "type": "string", + "x-enum-varnames": [ + "TEAM_CONNECTION" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "TeamConnectionAttributes": { + "description": "Attributes of the team connection.", + "properties": { + "managed_by": { + "description": "The entity that manages this team connection.", + "example": "github_sync", + "type": "string" + }, + "source": { + "description": "The name of the external source.", + "example": "github", + "type": "string" + } + }, + "type": "object" + }, + "TeamConnectionCreateData": { + "description": "Data for creating a team connection.", + "properties": { + "attributes": { + "description": "Attributes of the team connection.", + "properties": { + "managed_by": { + "description": "The entity that manages this team connection.", + "example": "github_sync", + "type": "string" + }, + "source": { + "description": "The name of the external source.", + "example": "github", + "type": "string" + } + }, + "type": "object" + }, + "relationships": { + "description": "Relationships of the team connection.", + "properties": { + "connected_team": { + "description": "Reference to a team from an external system.", + "properties": { + "data": { + "description": "Reference to connected external team.", + "properties": { + "id": { + "description": "The connected team ID as it is referenced throughout the Datadog ecosystem.", + "example": "@GitHubOrg/team-handle", + "type": "string" + }, + "type": { + "default": "github_team", + "description": "External team resource type.", + "enum": [ + "github_team" + ], + "example": "github_team", + "type": "string", + "x-enum-varnames": [ + "GITHUB_TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + }, + "team": { + "description": "Reference to a Datadog team.", + "properties": { + "data": { + "description": "Reference to a Datadog team.", + "properties": { + "id": { + "description": "The Datadog team ID.", + "example": "87654321-4321-8765-dcba-210987654321", + "type": "string" + }, + "type": { + "default": "team", + "description": "Datadog team resource type.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": { + "default": "team_connection", + "description": "Team connection resource type.", + "enum": [ + "team_connection" + ], + "example": "team_connection", + "type": "string", + "x-enum-varnames": [ + "TEAM_CONNECTION" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "TeamConnectionCreateRequest": { + "description": "Request for creating team connections.", + "properties": { + "data": { + "description": "Array of team connections to create.", + "items": { + "description": "Data for creating a team connection.", + "properties": { + "attributes": { + "description": "Attributes of the team connection.", + "properties": { + "managed_by": { + "description": "The entity that manages this team connection.", + "example": "github_sync", + "type": "string" + }, + "source": { + "description": "The name of the external source.", + "example": "github", + "type": "string" + } + }, + "type": "object" + }, + "relationships": { + "description": "Relationships of the team connection.", + "properties": { + "connected_team": { + "description": "Reference to a team from an external system.", + "properties": { + "data": { + "description": "Reference to connected external team.", + "properties": { + "id": { + "description": "The connected team ID as it is referenced throughout the Datadog ecosystem.", + "example": "@GitHubOrg/team-handle", + "type": "string" + }, + "type": { + "default": "github_team", + "description": "External team resource type.", + "enum": [ + "github_team" + ], + "example": "github_team", + "type": "string", + "x-enum-varnames": [ + "GITHUB_TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + }, + "team": { + "description": "Reference to a Datadog team.", + "properties": { + "data": { + "description": "Reference to a Datadog team.", + "properties": { + "id": { + "description": "The Datadog team ID.", + "example": "87654321-4321-8765-dcba-210987654321", + "type": "string" + }, + "type": { + "default": "team", + "description": "Datadog team resource type.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": { + "default": "team_connection", + "description": "Team connection resource type.", + "enum": [ + "team_connection" + ], + "example": "team_connection", + "type": "string", + "x-enum-varnames": [ + "TEAM_CONNECTION" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "TeamConnectionDeleteRequest": { + "description": "Request for deleting team connections.", + "properties": { + "data": { + "description": "Array of team connection IDs to delete.", + "items": { + "description": "A collection of connection ids to delete.", + "properties": { + "id": { + "description": "The unique identifier of the team connection to delete.", + "example": "12345678-1234-5678-9abc-123456789012", + "type": "string" + }, + "type": { + "default": "team_connection", + "description": "Team connection resource type.", + "enum": [ + "team_connection" + ], + "example": "team_connection", + "type": "string", + "x-enum-varnames": [ + "TEAM_CONNECTION" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "TeamConnectionDeleteRequestDataItem": { + "description": "A collection of connection ids to delete.", + "properties": { + "id": { + "description": "The unique identifier of the team connection to delete.", + "example": "12345678-1234-5678-9abc-123456789012", + "type": "string" + }, + "type": { + "default": "team_connection", + "description": "Team connection resource type.", + "enum": [ + "team_connection" + ], + "example": "team_connection", + "type": "string", + "x-enum-varnames": [ + "TEAM_CONNECTION" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "TeamConnectionRelationships": { + "description": "Relationships of the team connection.", + "properties": { + "connected_team": { + "description": "Reference to a team from an external system.", + "properties": { + "data": { + "description": "Reference to connected external team.", + "properties": { + "id": { + "description": "The connected team ID as it is referenced throughout the Datadog ecosystem.", + "example": "@GitHubOrg/team-handle", + "type": "string" + }, + "type": { + "default": "github_team", + "description": "External team resource type.", + "enum": [ + "github_team" + ], + "example": "github_team", + "type": "string", + "x-enum-varnames": [ + "GITHUB_TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + }, + "team": { + "description": "Reference to a Datadog team.", + "properties": { + "data": { + "description": "Reference to a Datadog team.", + "properties": { + "id": { + "description": "The Datadog team ID.", + "example": "87654321-4321-8765-dcba-210987654321", + "type": "string" + }, + "type": { + "default": "team", + "description": "Datadog team resource type.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "TeamConnectionType": { + "default": "team_connection", + "description": "Team connection resource type.", + "enum": [ + "team_connection" + ], + "example": "team_connection", + "type": "string", + "x-enum-varnames": [ + "TEAM_CONNECTION" + ] + }, + "TeamConnectionsResponse": { + "description": "Response containing information about multiple team connections.", + "properties": { + "data": { + "description": "Array of team connections.", + "items": { + "description": "A relationship between a Datadog team and a team from another external system.", + "properties": { + "attributes": { + "description": "Attributes of the team connection.", + "properties": { + "managed_by": { + "description": "The entity that manages this team connection.", + "example": "github_sync", + "type": "string" + }, + "source": { + "description": "The name of the external source.", + "example": "github", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "The unique identifier of the team connection.", + "example": "12345678-1234-5678-9abc-123456789012", + "type": "string" + }, + "relationships": { + "description": "Relationships of the team connection.", + "properties": { + "connected_team": { + "description": "Reference to a team from an external system.", + "properties": { + "data": { + "description": "Reference to connected external team.", + "properties": { + "id": { + "description": "The connected team ID as it is referenced throughout the Datadog ecosystem.", + "example": "@GitHubOrg/team-handle", + "type": "string" + }, + "type": { + "default": "github_team", + "description": "External team resource type.", + "enum": [ + "github_team" + ], + "example": "github_team", + "type": "string", + "x-enum-varnames": [ + "GITHUB_TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + }, + "team": { + "description": "Reference to a Datadog team.", + "properties": { + "data": { + "description": "Reference to a Datadog team.", + "properties": { + "id": { + "description": "The Datadog team ID.", + "example": "87654321-4321-8765-dcba-210987654321", + "type": "string" + }, + "type": { + "default": "team", + "description": "Datadog team resource type.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": { + "default": "team_connection", + "description": "Team connection resource type.", + "enum": [ + "team_connection" + ], + "example": "team_connection", + "type": "string", + "x-enum-varnames": [ + "TEAM_CONNECTION" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "type": "array" + }, + "meta": { + "description": "Connections response metadata.", + "properties": { + "page": { + "description": "Page-based pagination metadata.", + "properties": { + "first_number": { + "description": "The first page number.", + "format": "int64", + "type": "integer" + }, + "last_number": { + "description": "The last page number.", + "format": "int64", + "type": "integer" + }, + "next_number": { + "description": "The next page number.", + "format": "int64", + "nullable": true, + "type": "integer" + }, + "number": { + "description": "The current page number.", + "format": "int64", + "type": "integer" + }, + "prev_number": { + "description": "The previous page number.", + "format": "int64", + "nullable": true, + "type": "integer" + }, + "size": { + "description": "The page size.", + "format": "int64", + "type": "integer" + }, + "total": { + "description": "Total connections matching request.", + "format": "int64", + "type": "integer" + }, + "type": { + "description": "Pagination type.", + "example": "number_size", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, "TeamCreate": { "description": "Team create", "properties": { @@ -360893,6 +362133,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -361750,6 +362997,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -362415,6 +363669,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -363262,6 +364523,78 @@ }, "type": "object" }, + "TeamRef": { + "description": "Reference to a Datadog team.", + "properties": { + "data": { + "description": "Reference to a Datadog team.", + "properties": { + "id": { + "description": "The Datadog team ID.", + "example": "87654321-4321-8765-dcba-210987654321", + "type": "string" + }, + "type": { + "default": "team", + "description": "Datadog team resource type.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + }, + "TeamRefData": { + "description": "Reference to a Datadog team.", + "properties": { + "id": { + "description": "The Datadog team ID.", + "example": "87654321-4321-8765-dcba-210987654321", + "type": "string" + }, + "type": { + "default": "team", + "description": "Datadog team resource type.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "TeamRefDataType": { + "default": "team", + "description": "Datadog team resource type.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + }, "TeamReference": { "description": "Provides a reference to a team, including ID, type, and basic attributes/relationships.", "properties": { @@ -366304,6 +367637,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -394732,6 +396072,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -394967,6 +396314,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -395839,6 +397193,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -397018,6 +398379,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -397887,6 +399255,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -398645,6 +400020,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -399345,6 +400727,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -430188,6 +431577,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -430834,6 +432230,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -431537,6 +432940,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -432178,6 +433588,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -443245,6 +444662,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -444051,6 +445475,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -444776,6 +446207,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -488687,6 +490125,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -489420,6 +490865,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -489997,7 +491449,7 @@ } }, "get": { - "description": "Get an application key owned by current user", + "description": "Get an application key owned by current user.\nThe `key` field is not returned for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode).", "operationId": "GetCurrentUserApplicationKey", "parameters": [ { @@ -490166,6 +491618,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -490625,7 +492084,7 @@ } }, "patch": { - "description": "Edit an application key owned by current user", + "description": "Edit an application key owned by current user.\nThe `key` field is not returned for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode).", "operationId": "UpdateCurrentUserApplicationKey", "parameters": [ { @@ -490863,6 +492322,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -496602,6 +498068,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -497567,6 +499040,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -498457,6 +499937,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -499468,6 +500955,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -499869,7 +501363,7 @@ "operationId": "SearchIssues", "parameters": [ { - "description": "Comma-separated list of relationship objects that should be included in the response.", + "description": "Comma-separated list of relationship objects that should be included in the response. Possible values are `issue`, `issue.assignee`, `issue.case`, and `issue.team_owners`.", "explode": false, "in": "query", "name": "include", @@ -501132,7 +502626,7 @@ } }, { - "description": "Comma-separated list of relationship objects that should be included in the response.", + "description": "Comma-separated list of relationship objects that should be included in the response. Possible values are `assignee`, `case`, and `team_owners`.", "explode": false, "in": "query", "name": "include", @@ -509825,6 +511319,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -511239,6 +512740,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -512631,6 +514139,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -514046,6 +515561,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -515142,6 +516664,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -516152,6 +517681,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -517250,6 +518786,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -518220,6 +519763,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -525883,6 +527433,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -526715,6 +528272,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -528647,6 +530211,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -529636,6 +531207,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -530569,6 +532147,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -531530,6 +533115,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -532183,6 +533775,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -533008,6 +534607,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -533864,6 +535470,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -534667,6 +536280,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -568756,6 +570376,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -569460,6 +571087,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -570154,6 +571788,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -570903,6 +572544,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -583438,6 +585086,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -589743,6 +591398,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -590838,6 +592500,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -591631,6 +593300,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -592678,6 +594354,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -596968,6 +598651,7 @@ "description": "Metadata specifying where and how to access the reference table's data file.", "oneOf": [ { + "additionalProperties": false, "description": "File metadata for reference tables created by cloud storage.", "properties": { "access_details": { @@ -597110,6 +598794,7 @@ "type": "object" }, { + "additionalProperties": false, "description": "File metadata for reference tables created by upload. Note that upload_id is only returned in the immediate create/replace response and is not available in subsequent GET requests.", "properties": { "error_message": { @@ -597748,6 +599433,7 @@ "description": "Metadata specifying where and how to access the reference table's data file.", "oneOf": [ { + "additionalProperties": false, "description": "File metadata for reference tables created by cloud storage.", "properties": { "access_details": { @@ -597890,6 +599576,7 @@ "type": "object" }, { + "additionalProperties": false, "description": "File metadata for reference tables created by upload. Note that upload_id is only returned in the immediate create/replace response and is not available in subsequent GET requests.", "properties": { "error_message": { @@ -598360,6 +600047,7 @@ "description": "Metadata specifying where and how to access the reference table's data file.", "oneOf": [ { + "additionalProperties": false, "description": "File metadata for reference tables created by cloud storage.", "properties": { "access_details": { @@ -598502,6 +600190,7 @@ "type": "object" }, { + "additionalProperties": false, "description": "File metadata for reference tables created by upload. Note that upload_id is only returned in the immediate create/replace response and is not available in subsequent GET requests.", "properties": { "error_message": { @@ -645171,6 +646860,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -645870,6 +647566,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -646534,6 +648237,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -669915,6 +671625,17 @@ "example": "env:staging status:low", "type": "string" }, + "tags": { + "description": "List of tags associated with the suppression rule.", + "example": [ + "technique:T1110-brute-force", + "source:cloudtrail" + ], + "items": { + "type": "string" + }, + "type": "array" + }, "update_date": { "description": "A Unix millisecond timestamp given the update date of the suppression rule.", "format": "int64", @@ -670106,6 +671827,17 @@ "description": "The suppression query of the suppression rule. If a signal matches this query, it is suppressed and is not triggered. It uses the same syntax as the queries to search signals in the Signals Explorer.", "example": "env:staging status:low", "type": "string" + }, + "tags": { + "description": "List of tags associated with the suppression rule.", + "example": [ + "technique:T1110-brute-force", + "source:cloudtrail" + ], + "items": { + "type": "string" + }, + "type": "array" } }, "required": [ @@ -670227,6 +671959,17 @@ "example": "env:staging status:low", "type": "string" }, + "tags": { + "description": "List of tags associated with the suppression rule.", + "example": [ + "technique:T1110-brute-force", + "source:cloudtrail" + ], + "items": { + "type": "string" + }, + "type": "array" + }, "update_date": { "description": "A Unix millisecond timestamp given the update date of the suppression rule.", "format": "int64", @@ -672295,268 +674038,290 @@ "example": "env:staging status:low", "type": "string" }, - "update_date": { - "description": "A Unix millisecond timestamp given the update date of the suppression rule.", - "format": "int64", - "type": "integer" - }, - "updater": { - "description": "A user.", - "properties": { - "handle": { - "description": "The handle of the user.", - "example": "john.doe@datadoghq.com", - "type": "string" - }, - "name": { - "description": "The name of the user.", - "example": "John Doe", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "version": { - "description": "The version of the suppression rule; it starts at 1, and is incremented at each update.", - "example": 42, - "format": "int32", - "maximum": 2147483647, - "type": "integer" - } - }, - "type": "object" - }, - "id": { - "description": "The ID of the suppression rule.", - "example": "3dd-0uc-h1s", - "type": "string" - }, - "type": { - "default": "suppressions", - "description": "The type of the resource. The value should always be `suppressions`.", - "enum": [ - "suppressions" - ], - "example": "suppressions", - "type": "string", - "x-enum-varnames": [ - "SUPPRESSIONS" - ] - } - }, - "type": "object" - }, - "type": "array" - } - }, - "type": "object" - } - } - }, - "description": "OK" - }, - "400": { - "content": { - "application/json": { - "schema": { - "description": "API error response.", - "properties": { - "errors": { - "description": "A list of errors.", - "example": [ - "Bad Request" - ], - "items": { - "description": "A list of items.", - "example": "Bad Request", - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "errors" - ], - "type": "object" - } - } - }, - "description": "Bad Request" - }, - "403": { - "content": { - "application/json": { - "schema": { - "description": "API error response.", - "properties": { - "errors": { - "description": "A list of errors.", - "example": [ - "Bad Request" - ], - "items": { - "description": "A list of items.", - "example": "Bad Request", - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "errors" - ], - "type": "object" - } - } - }, - "description": "Not Authorized" - }, - "429": { - "content": { - "application/json": { - "schema": { - "description": "API error response.", - "properties": { - "errors": { - "description": "A list of errors.", - "example": [ - "Bad Request" - ], - "items": { - "description": "A list of items.", - "example": "Bad Request", - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "errors" - ], - "type": "object" - } - } - }, - "description": "Too many requests" - } - }, - "security": [ - { - "apiKeyAuth": [], - "appKeyAuth": [] - }, - { - "AuthZ": [ - "security_monitoring_suppressions_read" - ] - } - ], - "summary": "Get suppressions affecting future rule", - "tags": [ - "Security Monitoring" - ], - "x-menu-order": 0 - } - }, - "/api/v2/security_monitoring/configuration/suppressions/rules/{rule_id}": { - "get": { - "description": "Get the list of suppressions that affect a specific existing rule by its ID.", - "operationId": "GetSuppressionsAffectingRule", - "parameters": [ - { - "description": "The ID of the rule.", - "in": "path", - "name": "rule_id", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "description": "Response object containing the available suppression rules.", - "properties": { - "data": { - "description": "A list of suppressions objects.", - "items": { - "description": "The suppression rule's properties.", - "properties": { - "attributes": { - "description": "The attributes of the suppression rule.", - "properties": { - "creation_date": { - "description": "A Unix millisecond timestamp given the creation date of the suppression rule.", - "format": "int64", - "type": "integer" - }, - "creator": { - "description": "A user.", - "properties": { - "handle": { - "description": "The handle of the user.", - "example": "john.doe@datadoghq.com", - "type": "string" - }, - "name": { - "description": "The name of the user.", - "example": "John Doe", - "nullable": true, - "type": "string" - } + "tags": { + "description": "List of tags associated with the suppression rule.", + "example": [ + "technique:T1110-brute-force", + "source:cloudtrail" + ], + "items": { + "type": "string" }, - "type": "object" - }, - "data_exclusion_query": { - "description": "An exclusion query on the input data of the security rules, which could be logs, Agent events, or other types of data based on the security rule. Events matching this query are ignored by any detection rules referenced in the suppression rule.", - "example": "source:cloudtrail account_id:12345", - "type": "string" - }, - "description": { - "description": "A description for the suppression rule.", - "example": "This rule suppresses low-severity signals in staging environments.", - "type": "string" - }, - "editable": { - "description": "Whether the suppression rule is editable.", - "example": true, - "type": "boolean" - }, - "enabled": { - "description": "Whether the suppression rule is enabled.", - "example": true, - "type": "boolean" - }, - "expiration_date": { - "description": "A Unix millisecond timestamp giving an expiration date for the suppression rule. After this date, it won't suppress signals anymore.", - "example": 1703187336000, - "format": "int64", - "type": "integer" - }, - "name": { - "description": "The name of the suppression rule.", - "example": "Custom suppression", - "type": "string" - }, - "rule_query": { - "description": "The rule query of the suppression rule, with the same syntax as the search bar for detection rules.", - "example": "type:log_detection source:cloudtrail", - "type": "string" - }, - "start_date": { - "description": "A Unix millisecond timestamp giving the start date for the suppression rule. After this date, it starts suppressing signals.", - "example": 1703187336000, - "format": "int64", - "type": "integer" - }, - "suppression_query": { - "description": "The suppression query of the suppression rule. If a signal matches this query, it is suppressed and not triggered. Same syntax as the queries to search signals in the signal explorer.", - "example": "env:staging status:low", - "type": "string" + "type": "array" + }, + "update_date": { + "description": "A Unix millisecond timestamp given the update date of the suppression rule.", + "format": "int64", + "type": "integer" + }, + "updater": { + "description": "A user.", + "properties": { + "handle": { + "description": "The handle of the user.", + "example": "john.doe@datadoghq.com", + "type": "string" + }, + "name": { + "description": "The name of the user.", + "example": "John Doe", + "nullable": true, + "type": "string" + } + }, + "type": "object" + }, + "version": { + "description": "The version of the suppression rule; it starts at 1, and is incremented at each update.", + "example": 42, + "format": "int32", + "maximum": 2147483647, + "type": "integer" + } + }, + "type": "object" + }, + "id": { + "description": "The ID of the suppression rule.", + "example": "3dd-0uc-h1s", + "type": "string" + }, + "type": { + "default": "suppressions", + "description": "The type of the resource. The value should always be `suppressions`.", + "enum": [ + "suppressions" + ], + "example": "suppressions", + "type": "string", + "x-enum-varnames": [ + "SUPPRESSIONS" + ] + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + } + } + }, + "description": "OK" + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Bad Request" + }, + "403": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Not Authorized" + }, + "429": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Too many requests" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [ + "security_monitoring_suppressions_read" + ] + } + ], + "summary": "Get suppressions affecting future rule", + "tags": [ + "Security Monitoring" + ], + "x-menu-order": 0 + } + }, + "/api/v2/security_monitoring/configuration/suppressions/rules/{rule_id}": { + "get": { + "description": "Get the list of suppressions that affect a specific existing rule by its ID.", + "operationId": "GetSuppressionsAffectingRule", + "parameters": [ + { + "description": "The ID of the rule.", + "in": "path", + "name": "rule_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "Response object containing the available suppression rules.", + "properties": { + "data": { + "description": "A list of suppressions objects.", + "items": { + "description": "The suppression rule's properties.", + "properties": { + "attributes": { + "description": "The attributes of the suppression rule.", + "properties": { + "creation_date": { + "description": "A Unix millisecond timestamp given the creation date of the suppression rule.", + "format": "int64", + "type": "integer" + }, + "creator": { + "description": "A user.", + "properties": { + "handle": { + "description": "The handle of the user.", + "example": "john.doe@datadoghq.com", + "type": "string" + }, + "name": { + "description": "The name of the user.", + "example": "John Doe", + "nullable": true, + "type": "string" + } + }, + "type": "object" + }, + "data_exclusion_query": { + "description": "An exclusion query on the input data of the security rules, which could be logs, Agent events, or other types of data based on the security rule. Events matching this query are ignored by any detection rules referenced in the suppression rule.", + "example": "source:cloudtrail account_id:12345", + "type": "string" + }, + "description": { + "description": "A description for the suppression rule.", + "example": "This rule suppresses low-severity signals in staging environments.", + "type": "string" + }, + "editable": { + "description": "Whether the suppression rule is editable.", + "example": true, + "type": "boolean" + }, + "enabled": { + "description": "Whether the suppression rule is enabled.", + "example": true, + "type": "boolean" + }, + "expiration_date": { + "description": "A Unix millisecond timestamp giving an expiration date for the suppression rule. After this date, it won't suppress signals anymore.", + "example": 1703187336000, + "format": "int64", + "type": "integer" + }, + "name": { + "description": "The name of the suppression rule.", + "example": "Custom suppression", + "type": "string" + }, + "rule_query": { + "description": "The rule query of the suppression rule, with the same syntax as the search bar for detection rules.", + "example": "type:log_detection source:cloudtrail", + "type": "string" + }, + "start_date": { + "description": "A Unix millisecond timestamp giving the start date for the suppression rule. After this date, it starts suppressing signals.", + "example": 1703187336000, + "format": "int64", + "type": "integer" + }, + "suppression_query": { + "description": "The suppression query of the suppression rule. If a signal matches this query, it is suppressed and not triggered. Same syntax as the queries to search signals in the signal explorer.", + "example": "env:staging status:low", + "type": "string" + }, + "tags": { + "description": "List of tags associated with the suppression rule.", + "example": [ + "technique:T1110-brute-force", + "source:cloudtrail" + ], + "items": { + "type": "string" + }, + "type": "array" }, "update_date": { "description": "A Unix millisecond timestamp given the update date of the suppression rule.", @@ -672779,6 +674544,17 @@ "description": "The suppression query of the suppression rule. If a signal matches this query, it is suppressed and is not triggered. It uses the same syntax as the queries to search signals in the Signals Explorer.", "example": "env:staging status:low", "type": "string" + }, + "tags": { + "description": "List of tags associated with the suppression rule.", + "example": [ + "technique:T1110-brute-force", + "source:cloudtrail" + ], + "items": { + "type": "string" + }, + "type": "array" } }, "required": [ @@ -673148,6 +674924,17 @@ "example": "env:staging status:low", "type": "string" }, + "tags": { + "description": "List of tags associated with the suppression rule.", + "example": [ + "technique:T1110-brute-force", + "source:cloudtrail" + ], + "items": { + "type": "string" + }, + "type": "array" + }, "update_date": { "description": "A Unix millisecond timestamp given the update date of the suppression rule.", "format": "int64", @@ -673379,6 +675166,17 @@ "example": "env:staging status:low", "type": "string" }, + "tags": { + "description": "List of tags associated with the suppression rule.", + "example": [ + "technique:T1110-brute-force", + "source:cloudtrail" + ], + "items": { + "type": "string" + }, + "type": "array" + }, "version": { "description": "The current version of the suppression. This is optional, but it can help prevent concurrent modifications.", "format": "int32", @@ -673500,6 +675298,17 @@ "example": "env:staging status:low", "type": "string" }, + "tags": { + "description": "List of tags associated with the suppression rule.", + "example": [ + "technique:T1110-brute-force", + "source:cloudtrail" + ], + "items": { + "type": "string" + }, + "type": "array" + }, "update_date": { "description": "A Unix millisecond timestamp given the update date of the suppression rule.", "format": "int64", @@ -698352,6 +700161,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -699144,6 +700960,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -699889,6 +701712,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -700648,6 +702478,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -701348,6 +703185,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -702073,6 +703917,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -702798,6 +704649,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -708146,6 +710004,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -708856,6 +710721,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -721141,6 +723013,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -721594,403 +723473,1444 @@ } } }, - "description": "Too many requests" - } - }, - "security": [ - { - "apiKeyAuth": [], - "appKeyAuth": [] - }, - { - "AuthZ": [ - "teams_read" - ] - } - ], - "summary": "Get all teams", - "tags": [ - "Teams" - ], - "x-menu-order": 1, - "x-pagination": { - "limitParam": "page[size]", - "pageParam": "page[number]", - "resultsPath": "data" - }, - "x-permission": { - "operator": "OR", - "permissions": [ - "teams_read" - ] - } - }, - "post": { - "description": "Create a new team.\nUser IDs passed through the `users` relationship field are added to the team.", - "operationId": "CreateTeam", - "requestBody": { - "content": { - "application/json": { - "schema": { - "description": "Request to create a team", - "properties": { - "data": { - "description": "Team create", - "properties": { - "attributes": { - "description": "Team creation attributes", - "properties": { - "avatar": { - "description": "Unicode representation of the avatar for the team, limited to a single grapheme", - "example": "🥑", - "nullable": true, - "type": "string" - }, - "banner": { - "description": "Banner selection for the team", - "format": "int64", - "nullable": true, - "type": "integer" - }, - "description": { - "description": "Free-form markdown description/content for the team's homepage", - "type": "string" - }, - "handle": { - "description": "The team's identifier", - "example": "example-team", - "maxLength": 195, - "type": "string" - }, - "hidden_modules": { - "description": "Collection of hidden modules for the team", - "items": { - "description": "String identifier of the module", - "type": "string" - }, - "type": "array" - }, - "name": { - "description": "The name of the team", - "example": "Example Team", - "maxLength": 200, - "type": "string" - }, - "visible_modules": { - "description": "Collection of visible modules for the team", - "items": { - "description": "String identifier of the module", - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "handle", - "name" - ], - "type": "object" - }, - "relationships": { - "description": "Relationships formed with the team on creation", - "properties": { - "users": { - "description": "Relationship to users.", - "properties": { - "data": { - "description": "Relationships to user objects.", - "example": [], - "items": { - "description": "Relationship to user object.", - "properties": { - "id": { - "description": "A unique identifier that represents the user.", - "example": "00000000-0000-0000-2345-000000000000", - "type": "string" - }, - "type": { - "default": "users", - "description": "Users resource type.", - "enum": [ - "users" - ], - "example": "users", - "type": "string", - "x-enum-varnames": [ - "USERS" - ] - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "type": "array" - } - }, - "required": [ - "data" - ], - "type": "object" - } - }, - "type": "object" - }, - "type": { - "default": "team", - "description": "Team type", - "enum": [ - "team" - ], - "example": "team", - "type": "string", - "x-enum-varnames": [ - "TEAM" - ] - } - }, - "required": [ - "attributes", - "type" - ], - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" - } - } - }, - "required": true - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "description": "Response with a team", - "properties": { - "data": { - "description": "A team", - "properties": { - "attributes": { - "description": "Team attributes", - "properties": { - "avatar": { - "description": "Unicode representation of the avatar for the team, limited to a single grapheme", - "example": "🥑", - "nullable": true, - "type": "string" - }, - "banner": { - "description": "Banner selection for the team", - "format": "int64", - "nullable": true, - "type": "integer" - }, - "created_at": { - "description": "Creation date of the team", - "format": "date-time", - "type": "string" - }, - "description": { - "description": "Free-form markdown description/content for the team's homepage", - "nullable": true, - "type": "string" - }, - "handle": { - "description": "The team's identifier", - "example": "example-team", - "maxLength": 195, - "type": "string" - }, - "hidden_modules": { - "description": "Collection of hidden modules for the team", - "items": { - "description": "String identifier of the module", - "type": "string" - }, - "type": "array" - }, - "link_count": { - "description": "The number of links belonging to the team", - "format": "int32", - "maximum": 2147483647, - "readOnly": true, - "type": "integer" - }, - "modified_at": { - "description": "Modification date of the team", - "format": "date-time", - "type": "string" - }, - "name": { - "description": "The name of the team", - "example": "Example Team", - "maxLength": 200, - "type": "string" - }, - "summary": { - "description": "A brief summary of the team, derived from the `description`", - "maxLength": 120, - "nullable": true, - "type": "string" - }, - "user_count": { - "description": "The number of users belonging to the team", - "format": "int32", - "maximum": 2147483647, - "readOnly": true, - "type": "integer" - }, - "visible_modules": { - "description": "Collection of visible modules for the team", - "items": { - "description": "String identifier of the module", - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "handle", - "name" - ], - "type": "object" - }, - "id": { - "description": "The team's identifier", - "example": "aeadc05e-98a8-11ec-ac2c-da7ad0900001", - "type": "string" - }, - "relationships": { - "description": "Resources related to a team", - "properties": { - "team_links": { - "description": "Relationship between a team and a team link", - "properties": { - "data": { - "description": "Related team links", - "items": { - "description": "Relationship between a link and a team", - "properties": { - "id": { - "description": "The team link's identifier", - "example": "f9bb8444-af7f-11ec-ac2c-da7ad0900001", - "type": "string" - }, - "type": { - "default": "team_links", - "description": "Team link type", - "enum": [ - "team_links" - ], - "example": "team_links", - "type": "string", - "x-enum-varnames": [ - "TEAM_LINKS" - ] - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "type": "array" - }, - "links": { - "description": "Links attributes.", - "properties": { - "related": { - "description": "Related link.", - "example": "/api/v2/team/c75a4a8e-20c7-11ee-a3a5-da7ad0900002/links", - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "user_team_permissions": { - "description": "Relationship between a user team permission and a team", - "properties": { - "data": { - "description": "Related user team permission data", - "properties": { - "id": { - "description": "The ID of the user team permission", - "example": "UserTeamPermissions-aeadc05e-98a8-11ec-ac2c-da7ad0900001-416595", - "type": "string" - }, - "type": { - "default": "user_team_permissions", - "description": "User team permission type", - "enum": [ - "user_team_permissions" - ], - "example": "user_team_permissions", - "type": "string", - "x-enum-varnames": [ - "USER_TEAM_PERMISSIONS" - ] - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "links": { - "description": "Links attributes.", - "properties": { - "related": { - "description": "Related link.", - "example": "/api/v2/team/c75a4a8e-20c7-11ee-a3a5-da7ad0900002/links", - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "type": { - "default": "team", - "description": "Team type", - "enum": [ - "team" - ], - "example": "team", - "type": "string", - "x-enum-varnames": [ - "TEAM" - ] - } - }, - "required": [ - "attributes", - "id", - "type" - ], - "type": "object" - } - }, - "type": "object" - } - } - }, - "description": "CREATED" + "description": "Too many requests" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [ + "teams_read" + ] + } + ], + "summary": "Get all teams", + "tags": [ + "Teams" + ], + "x-menu-order": 1, + "x-pagination": { + "limitParam": "page[size]", + "pageParam": "page[number]", + "resultsPath": "data" + }, + "x-permission": { + "operator": "OR", + "permissions": [ + "teams_read" + ] + } + }, + "post": { + "description": "Create a new team.\nUser IDs passed through the `users` relationship field are added to the team.", + "operationId": "CreateTeam", + "requestBody": { + "content": { + "application/json": { + "schema": { + "description": "Request to create a team", + "properties": { + "data": { + "description": "Team create", + "properties": { + "attributes": { + "description": "Team creation attributes", + "properties": { + "avatar": { + "description": "Unicode representation of the avatar for the team, limited to a single grapheme", + "example": "🥑", + "nullable": true, + "type": "string" + }, + "banner": { + "description": "Banner selection for the team", + "format": "int64", + "nullable": true, + "type": "integer" + }, + "description": { + "description": "Free-form markdown description/content for the team's homepage", + "type": "string" + }, + "handle": { + "description": "The team's identifier", + "example": "example-team", + "maxLength": 195, + "type": "string" + }, + "hidden_modules": { + "description": "Collection of hidden modules for the team", + "items": { + "description": "String identifier of the module", + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "The name of the team", + "example": "Example Team", + "maxLength": 200, + "type": "string" + }, + "visible_modules": { + "description": "Collection of visible modules for the team", + "items": { + "description": "String identifier of the module", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "handle", + "name" + ], + "type": "object" + }, + "relationships": { + "description": "Relationships formed with the team on creation", + "properties": { + "users": { + "description": "Relationship to users.", + "properties": { + "data": { + "description": "Relationships to user objects.", + "example": [], + "items": { + "description": "Relationship to user object.", + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-2345-000000000000", + "type": "string" + }, + "type": { + "default": "users", + "description": "Users resource type.", + "enum": [ + "users" + ], + "example": "users", + "type": "string", + "x-enum-varnames": [ + "USERS" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "default": "team", + "description": "Team type", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "attributes", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "description": "Response with a team", + "properties": { + "data": { + "description": "A team", + "properties": { + "attributes": { + "description": "Team attributes", + "properties": { + "avatar": { + "description": "Unicode representation of the avatar for the team, limited to a single grapheme", + "example": "🥑", + "nullable": true, + "type": "string" + }, + "banner": { + "description": "Banner selection for the team", + "format": "int64", + "nullable": true, + "type": "integer" + }, + "created_at": { + "description": "Creation date of the team", + "format": "date-time", + "type": "string" + }, + "description": { + "description": "Free-form markdown description/content for the team's homepage", + "nullable": true, + "type": "string" + }, + "handle": { + "description": "The team's identifier", + "example": "example-team", + "maxLength": 195, + "type": "string" + }, + "hidden_modules": { + "description": "Collection of hidden modules for the team", + "items": { + "description": "String identifier of the module", + "type": "string" + }, + "type": "array" + }, + "link_count": { + "description": "The number of links belonging to the team", + "format": "int32", + "maximum": 2147483647, + "readOnly": true, + "type": "integer" + }, + "modified_at": { + "description": "Modification date of the team", + "format": "date-time", + "type": "string" + }, + "name": { + "description": "The name of the team", + "example": "Example Team", + "maxLength": 200, + "type": "string" + }, + "summary": { + "description": "A brief summary of the team, derived from the `description`", + "maxLength": 120, + "nullable": true, + "type": "string" + }, + "user_count": { + "description": "The number of users belonging to the team", + "format": "int32", + "maximum": 2147483647, + "readOnly": true, + "type": "integer" + }, + "visible_modules": { + "description": "Collection of visible modules for the team", + "items": { + "description": "String identifier of the module", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "handle", + "name" + ], + "type": "object" + }, + "id": { + "description": "The team's identifier", + "example": "aeadc05e-98a8-11ec-ac2c-da7ad0900001", + "type": "string" + }, + "relationships": { + "description": "Resources related to a team", + "properties": { + "team_links": { + "description": "Relationship between a team and a team link", + "properties": { + "data": { + "description": "Related team links", + "items": { + "description": "Relationship between a link and a team", + "properties": { + "id": { + "description": "The team link's identifier", + "example": "f9bb8444-af7f-11ec-ac2c-da7ad0900001", + "type": "string" + }, + "type": { + "default": "team_links", + "description": "Team link type", + "enum": [ + "team_links" + ], + "example": "team_links", + "type": "string", + "x-enum-varnames": [ + "TEAM_LINKS" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "type": "array" + }, + "links": { + "description": "Links attributes.", + "properties": { + "related": { + "description": "Related link.", + "example": "/api/v2/team/c75a4a8e-20c7-11ee-a3a5-da7ad0900002/links", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "user_team_permissions": { + "description": "Relationship between a user team permission and a team", + "properties": { + "data": { + "description": "Related user team permission data", + "properties": { + "id": { + "description": "The ID of the user team permission", + "example": "UserTeamPermissions-aeadc05e-98a8-11ec-ac2c-da7ad0900001-416595", + "type": "string" + }, + "type": { + "default": "user_team_permissions", + "description": "User team permission type", + "enum": [ + "user_team_permissions" + ], + "example": "user_team_permissions", + "type": "string", + "x-enum-varnames": [ + "USER_TEAM_PERMISSIONS" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "links": { + "description": "Links attributes.", + "properties": { + "related": { + "description": "Related link.", + "example": "/api/v2/team/c75a4a8e-20c7-11ee-a3a5-da7ad0900002/links", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": { + "default": "team", + "description": "Team type", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "CREATED" + }, + "403": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Forbidden" + }, + "409": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "API error response." + }, + "429": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Too many requests" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [ + "teams_read", + "teams_manage" + ] + } + ], + "summary": "Create a team", + "tags": [ + "Teams" + ], + "x-codegen-request-body-name": "body", + "x-menu-order": 2, + "x-permission": { + "operator": "AND", + "permissions": [ + "teams_read", + "teams_manage" + ] + } + } + }, + "/api/v2/team/connections": { + "delete": { + "description": "Delete multiple team connections.", + "operationId": "DeleteTeamConnections", + "requestBody": { + "content": { + "application/json": { + "schema": { + "description": "Request for deleting team connections.", + "properties": { + "data": { + "description": "Array of team connection IDs to delete.", + "items": { + "description": "A collection of connection ids to delete.", + "properties": { + "id": { + "description": "The unique identifier of the team connection to delete.", + "example": "12345678-1234-5678-9abc-123456789012", + "type": "string" + }, + "type": { + "default": "team_connection", + "description": "Team connection resource type.", + "enum": [ + "team_connection" + ], + "example": "team_connection", + "type": "string", + "x-enum-varnames": [ + "TEAM_CONNECTION" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "No Content" + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Bad Request" + }, + "403": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Not Found" + }, + "429": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Too many requests" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [ + "teams_read" + ] + } + ], + "summary": "Delete team connections", + "tags": [ + "Team Connections" + ], + "x-menu-order": 3, + "x-permission": { + "operator": "OR", + "permissions": [ + "teams_read" + ] + }, + "x-unstable": "**Note**: This endpoint is in Preview. To request access, fill out this [form](https://www.datadoghq.com/product-preview/github-integration-for-teams/).\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." + }, + "get": { + "description": "Returns all team connections.", + "operationId": "ListTeamConnections", + "parameters": [ + { + "description": "Size for a given page. The maximum allowed value is 100.", + "in": "query", + "name": "page[size]", + "required": false, + "schema": { + "default": 10, + "example": 10, + "format": "int64", + "type": "integer" + } + }, + { + "description": "Specific page number to return.", + "in": "query", + "name": "page[number]", + "required": false, + "schema": { + "default": 0, + "example": 0, + "format": "int64", + "type": "integer" + } + }, + { + "description": "Filter team connections by external source systems.", + "explode": false, + "in": "query", + "name": "filter[sources]", + "required": false, + "schema": { + "items": { + "example": "github", + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "description": "Filter team connections by Datadog team IDs.", + "explode": false, + "in": "query", + "name": "filter[team_ids]", + "required": false, + "schema": { + "items": { + "example": "12345678-1234-5678-9abc-123456789012", + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "description": "Filter team connections by connected team IDs from external systems.", + "explode": false, + "in": "query", + "name": "filter[connected_team_ids]", + "required": false, + "schema": { + "items": { + "example": "@MyGitHubAccount/my-team-name", + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "description": "Filter team connections by connection IDs.", + "explode": false, + "in": "query", + "name": "filter[connection_ids]", + "required": false, + "schema": { + "items": { + "example": "12345678-1234-5678-9abc-123456789012", + "type": "string" + }, + "type": "array" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "Response containing information about multiple team connections.", + "properties": { + "data": { + "description": "Array of team connections.", + "items": { + "description": "A relationship between a Datadog team and a team from another external system.", + "properties": { + "attributes": { + "description": "Attributes of the team connection.", + "properties": { + "managed_by": { + "description": "The entity that manages this team connection.", + "example": "github_sync", + "type": "string" + }, + "source": { + "description": "The name of the external source.", + "example": "github", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "The unique identifier of the team connection.", + "example": "12345678-1234-5678-9abc-123456789012", + "type": "string" + }, + "relationships": { + "description": "Relationships of the team connection.", + "properties": { + "connected_team": { + "description": "Reference to a team from an external system.", + "properties": { + "data": { + "description": "Reference to connected external team.", + "properties": { + "id": { + "description": "The connected team ID as it is referenced throughout the Datadog ecosystem.", + "example": "@GitHubOrg/team-handle", + "type": "string" + }, + "type": { + "default": "github_team", + "description": "External team resource type.", + "enum": [ + "github_team" + ], + "example": "github_team", + "type": "string", + "x-enum-varnames": [ + "GITHUB_TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + }, + "team": { + "description": "Reference to a Datadog team.", + "properties": { + "data": { + "description": "Reference to a Datadog team.", + "properties": { + "id": { + "description": "The Datadog team ID.", + "example": "87654321-4321-8765-dcba-210987654321", + "type": "string" + }, + "type": { + "default": "team", + "description": "Datadog team resource type.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": { + "default": "team_connection", + "description": "Team connection resource type.", + "enum": [ + "team_connection" + ], + "example": "team_connection", + "type": "string", + "x-enum-varnames": [ + "TEAM_CONNECTION" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "type": "array" + }, + "meta": { + "description": "Connections response metadata.", + "properties": { + "page": { + "description": "Page-based pagination metadata.", + "properties": { + "first_number": { + "description": "The first page number.", + "format": "int64", + "type": "integer" + }, + "last_number": { + "description": "The last page number.", + "format": "int64", + "type": "integer" + }, + "next_number": { + "description": "The next page number.", + "format": "int64", + "nullable": true, + "type": "integer" + }, + "number": { + "description": "The current page number.", + "format": "int64", + "type": "integer" + }, + "prev_number": { + "description": "The previous page number.", + "format": "int64", + "nullable": true, + "type": "integer" + }, + "size": { + "description": "The page size.", + "format": "int64", + "type": "integer" + }, + "total": { + "description": "Total connections matching request.", + "format": "int64", + "type": "integer" + }, + "type": { + "description": "Pagination type.", + "example": "number_size", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Bad Request" + }, + "403": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Forbidden" + }, + "429": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Too many requests" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [ + "teams_read" + ] + } + ], + "summary": "List team connections", + "tags": [ + "Team Connections" + ], + "x-menu-order": 1, + "x-pagination": { + "limitParam": "page[size]", + "pageParam": "page[number]", + "resultsPath": "data" + }, + "x-permission": { + "operator": "OR", + "permissions": [ + "teams_read" + ] + }, + "x-unstable": "**Note**: This endpoint is in Preview. To request access, fill out this [form](https://www.datadoghq.com/product-preview/github-integration-for-teams/).\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." + }, + "post": { + "description": "Create multiple team connections.", + "operationId": "CreateTeamConnections", + "requestBody": { + "content": { + "application/json": { + "schema": { + "description": "Request for creating team connections.", + "properties": { + "data": { + "description": "Array of team connections to create.", + "items": { + "description": "Data for creating a team connection.", + "properties": { + "attributes": { + "description": "Attributes of the team connection.", + "properties": { + "managed_by": { + "description": "The entity that manages this team connection.", + "example": "github_sync", + "type": "string" + }, + "source": { + "description": "The name of the external source.", + "example": "github", + "type": "string" + } + }, + "type": "object" + }, + "relationships": { + "description": "Relationships of the team connection.", + "properties": { + "connected_team": { + "description": "Reference to a team from an external system.", + "properties": { + "data": { + "description": "Reference to connected external team.", + "properties": { + "id": { + "description": "The connected team ID as it is referenced throughout the Datadog ecosystem.", + "example": "@GitHubOrg/team-handle", + "type": "string" + }, + "type": { + "default": "github_team", + "description": "External team resource type.", + "enum": [ + "github_team" + ], + "example": "github_team", + "type": "string", + "x-enum-varnames": [ + "GITHUB_TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + }, + "team": { + "description": "Reference to a Datadog team.", + "properties": { + "data": { + "description": "Reference to a Datadog team.", + "properties": { + "id": { + "description": "The Datadog team ID.", + "example": "87654321-4321-8765-dcba-210987654321", + "type": "string" + }, + "type": { + "default": "team", + "description": "Datadog team resource type.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": { + "default": "team_connection", + "description": "Team connection resource type.", + "enum": [ + "team_connection" + ], + "example": "team_connection", + "type": "string", + "x-enum-varnames": [ + "TEAM_CONNECTION" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "description": "Response containing information about multiple team connections.", + "properties": { + "data": { + "description": "Array of team connections.", + "items": { + "description": "A relationship between a Datadog team and a team from another external system.", + "properties": { + "attributes": { + "description": "Attributes of the team connection.", + "properties": { + "managed_by": { + "description": "The entity that manages this team connection.", + "example": "github_sync", + "type": "string" + }, + "source": { + "description": "The name of the external source.", + "example": "github", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "The unique identifier of the team connection.", + "example": "12345678-1234-5678-9abc-123456789012", + "type": "string" + }, + "relationships": { + "description": "Relationships of the team connection.", + "properties": { + "connected_team": { + "description": "Reference to a team from an external system.", + "properties": { + "data": { + "description": "Reference to connected external team.", + "properties": { + "id": { + "description": "The connected team ID as it is referenced throughout the Datadog ecosystem.", + "example": "@GitHubOrg/team-handle", + "type": "string" + }, + "type": { + "default": "github_team", + "description": "External team resource type.", + "enum": [ + "github_team" + ], + "example": "github_team", + "type": "string", + "x-enum-varnames": [ + "GITHUB_TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + }, + "team": { + "description": "Reference to a Datadog team.", + "properties": { + "data": { + "description": "Reference to a Datadog team.", + "properties": { + "id": { + "description": "The Datadog team ID.", + "example": "87654321-4321-8765-dcba-210987654321", + "type": "string" + }, + "type": { + "default": "team", + "description": "Datadog team resource type.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": { + "default": "team_connection", + "description": "Team connection resource type.", + "enum": [ + "team_connection" + ], + "example": "team_connection", + "type": "string", + "x-enum-varnames": [ + "TEAM_CONNECTION" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "type": "array" + }, + "meta": { + "description": "Connections response metadata.", + "properties": { + "page": { + "description": "Page-based pagination metadata.", + "properties": { + "first_number": { + "description": "The first page number.", + "format": "int64", + "type": "integer" + }, + "last_number": { + "description": "The last page number.", + "format": "int64", + "type": "integer" + }, + "next_number": { + "description": "The next page number.", + "format": "int64", + "nullable": true, + "type": "integer" + }, + "number": { + "description": "The current page number.", + "format": "int64", + "type": "integer" + }, + "prev_number": { + "description": "The previous page number.", + "format": "int64", + "nullable": true, + "type": "integer" + }, + "size": { + "description": "The page size.", + "format": "int64", + "type": "integer" + }, + "total": { + "description": "Total connections matching request.", + "format": "int64", + "type": "integer" + }, + "type": { + "description": "Pagination type.", + "example": "number_size", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "Created" + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Bad Request" }, "403": { "content": { @@ -722046,7 +724966,7 @@ } } }, - "description": "API error response." + "description": "Conflict" }, "429": { "content": { @@ -722084,24 +725004,22 @@ }, { "AuthZ": [ - "teams_read", - "teams_manage" + "teams_read" ] } ], - "summary": "Create a team", + "summary": "Create team connections", "tags": [ - "Teams" + "Team Connections" ], - "x-codegen-request-body-name": "body", "x-menu-order": 2, "x-permission": { - "operator": "AND", + "operator": "OR", "permissions": [ - "teams_read", - "teams_manage" + "teams_read" ] - } + }, + "x-unstable": "**Note**: This endpoint is in Preview. To request access, fill out this [form](https://www.datadoghq.com/product-preview/github-integration-for-teams/).\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." } }, "/api/v2/team/sync": { @@ -722642,6 +725560,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -725861,6 +728786,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -726817,6 +729749,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -727786,6 +730725,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -729110,6 +732056,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -729831,6 +732784,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -730606,6 +733566,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -731312,6 +734279,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -735087,6 +738061,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -735806,6 +738787,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -736539,6 +739527,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -737203,6 +740198,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -737864,6 +740866,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -738810,6 +741819,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -748146,6 +751162,10 @@ "description": "Datadog Synthetics uses simulated user requests and browser rendering to help you ensure uptime,\nidentify regional issues, and track your application performance. Datadog Synthetics tests come in\ntwo different flavors, [API tests](https://docs.datadoghq.com/synthetics/api_tests/)\nand [browser tests](https://docs.datadoghq.com/synthetics/browser_tests). You can use Datadog’s API to\nmanage both test types programmatically.\n\nFor more information about Synthetics, see the [Synthetics overview](https://docs.datadoghq.com/synthetics/).", "name": "Synthetics" }, + { + "description": "View and manage relationships between Datadog teams and teams from external sources, such as GitHub.", + "name": "Team Connections" + }, { "description": "View and manage teams within Datadog. See the [Teams page](https://docs.datadoghq.com/account_management/teams/) for more information.", "name": "Teams" diff --git a/data/api/v2/translate_actions.json b/data/api/v2/translate_actions.json index 931dfa2de5124..b37909b3f0601 100644 --- a/data/api/v2/translate_actions.json +++ b/data/api/v2/translate_actions.json @@ -851,11 +851,11 @@ "summary": "Delete an application key owned by current user" }, "GetCurrentUserApplicationKey": { - "description": "Get an application key owned by current user", + "description": "Get an application key owned by current user.\nThe `key` field is not returned for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode).", "summary": "Get one application key owned by current user" }, "UpdateCurrentUserApplicationKey": { - "description": "Edit an application key owned by current user", + "description": "Edit an application key owned by current user.\nThe `key` field is not returned for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode).", "summary": "Edit an application key owned by current user", "request_description": "", "request_schema_description": "Request used to update an application key." @@ -3068,6 +3068,22 @@ "request_description": "", "request_schema_description": "Request to create a team" }, + "DeleteTeamConnections": { + "description": "Delete multiple team connections.", + "summary": "Delete team connections", + "request_description": "", + "request_schema_description": "Request for deleting team connections." + }, + "ListTeamConnections": { + "description": "Returns all team connections.", + "summary": "List team connections" + }, + "CreateTeamConnections": { + "description": "Create multiple team connections.", + "summary": "Create team connections", + "request_description": "", + "request_schema_description": "Request for creating team connections." + }, "SyncTeams": { "description": "This endpoint attempts to link your existing Datadog teams with GitHub teams by matching their names.\nIt evaluates all current Datadog teams and compares them against teams in the GitHub organization\nconnected to your Datadog account, based on Datadog Team handle and GitHub Team slug\n(lowercased and kebab-cased).\n\nThis operation is read-only on the GitHub side, no teams will be modified or created.\n\n[A GitHub organization must be connected to your Datadog account](https://docs.datadoghq.com/integrations/github/),\nand the GitHub App integrated with Datadog must have the `Members Read` permission. Matching is performed by comparing the Datadog team handle to the GitHub team slug\nusing a normalized exact match; case is ignored and spaces are removed. No modifications are made\nto teams in GitHub. This will not create new Teams in Datadog.", "summary": "Link Teams with GitHub Teams", diff --git a/data/api/v2/translate_tags.json b/data/api/v2/translate_tags.json index da67e0f029d78..6724035ad11d8 100644 --- a/data/api/v2/translate_tags.json +++ b/data/api/v2/translate_tags.json @@ -311,6 +311,10 @@ "name": "Synthetics", "description": "Datadog Synthetics uses simulated user requests and browser rendering to help you ensure uptime,\nidentify regional issues, and track your application performance. Datadog Synthetics tests come in\ntwo different flavors, [API tests](https://docs.datadoghq.com/synthetics/api_tests/)\nand [browser tests](https://docs.datadoghq.com/synthetics/browser_tests). You can use Datadog’s API to\nmanage both test types programmatically.\n\nFor more information about Synthetics, see the [Synthetics overview](https://docs.datadoghq.com/synthetics/)." }, + "team-connections": { + "name": "Team Connections", + "description": "View and manage relationships between Datadog teams and teams from external sources, such as GitHub." + }, "teams": { "name": "Teams", "description": "View and manage teams within Datadog. See the [Teams page](https://docs.datadoghq.com/account_management/teams/) for more information." diff --git a/go.mod b/go.mod index 68d163ce87916..333c61dadb572 100644 --- a/go.mod +++ b/go.mod @@ -2,6 +2,6 @@ module documentation go 1.24.4 -require github.com/DataDog/websites-modules v1.4.262 // indirect +require github.com/DataDog/websites-modules v1.4.269 // indirect // replace github.com/DataDog/websites-modules => /Users/lisiane.turlure/guac/websites-modules diff --git a/go.sum b/go.sum index c6b670c774746..3af28eed418ea 100644 --- a/go.sum +++ b/go.sum @@ -1,2 +1,2 @@ -github.com/DataDog/websites-modules v1.4.262 h1:5jXY+BRjQ8p+jUj7oI207B5+AijYxUEHUzE/2E9wRZo= -github.com/DataDog/websites-modules v1.4.262/go.mod h1:0pAe0O1KehxRBoWbXv2H3tHgMpd1kZylyQhFADlLpd0= +github.com/DataDog/websites-modules v1.4.269 h1:QdAW7knjx3hR1+RuwijTLHQocKd21+YcWoHV8ygzIIQ= +github.com/DataDog/websites-modules v1.4.269/go.mod h1:0pAe0O1KehxRBoWbXv2H3tHgMpd1kZylyQhFADlLpd0= diff --git a/i18n/es.json b/i18n/es.json index 7064b3dd8f066..0a7f7677addcc 100644 --- a/i18n/es.json +++ b/i18n/es.json @@ -292,6 +292,12 @@ "available_for": { "other": "Disponible para" }, + "join_now": { + "other": "Únete ahora" + }, + "datadog_partner_network": { + "other": "Documentación sobre redes de socios de Datadog" + }, "alert_note": { "other": "NOTA" }, diff --git a/layouts/shortcodes/aca-install-sidecar-manual.md b/layouts/shortcodes/aca-install-sidecar-manual.md index 3aa743328edc3..d91a1130ecf7f 100644 --- a/layouts/shortcodes/aca-install-sidecar-manual.md +++ b/layouts/shortcodes/aca-install-sidecar-manual.md @@ -15,7 +15,7 @@ Because Azure Container Apps is built on Kubernetes, you cannot share environmen - **Image source**: Docker Hub or other registries - **Image type**: `Public` - **Registry login server**: `docker.io` - - **Image and tag**: `datadog/serverless-init:latest` + - **Image and tag**: `datadog/serverless-init:` - Define your container resource allocation based on your usage. 4. Add a volume mount using [replica-scoped storage][1001]. Use type "Ephemeral storage" when creating your volume. Ensure that the name and mount path matches the mount you configured in the application container. 5. Set the environment variables in the following table: diff --git a/layouts/shortcodes/gcr-install-sidecar-other.md b/layouts/shortcodes/gcr-install-sidecar-other.md index 0055b5c2eec84..37eb53fddb2e8 100644 --- a/layouts/shortcodes/gcr-install-sidecar-other.md +++ b/layouts/shortcodes/gcr-install-sidecar-other.md @@ -1,7 +1,7 @@ After deploying your Cloud Run app, you can manually modify your app's settings to enable Datadog monitoring. 1. Create a **Volume** with `In-Memory` volume type. -2. Add a **new container** with image URL: `gcr.io/datadoghq/serverless-init:latest`. See the [latest releases on Docker Hub][1001] to pin a specific version. +2. Add a **new container** with image URL: `gcr.io/datadoghq/serverless-init:`. See the [latest releases on Docker Hub][1001] to pin a specific version. 3. Add the volume mount to every container in your application. Choose a path such as `/shared-volume`, and remember it for the next step. 4. Add the following environment variables to your `serverless-init` sidecar container:
    diff --git a/layouts/shortcodes/gcr-install-sidecar-yaml.md b/layouts/shortcodes/gcr-install-sidecar-yaml.md index ba0f2c216f84c..8074bfaafdb01 100644 --- a/layouts/shortcodes/gcr-install-sidecar-yaml.md +++ b/layouts/shortcodes/gcr-install-sidecar-yaml.md @@ -65,7 +65,7 @@ spec: value: '{{ .Get "language" }}' - name: DD_HEALTH_PORT value: '12345' - image: gcr.io/datadoghq/serverless-init:latest + image: gcr.io/datadoghq/serverless-init: name: serverless-init-1 resources: limits: diff --git a/layouts/shortcodes/latest-lambda-layer-version.html b/layouts/shortcodes/latest-lambda-layer-version.html index caf9cc513c068..8b21cc61e0976 100644 --- a/layouts/shortcodes/latest-lambda-layer-version.html +++ b/layouts/shortcodes/latest-lambda-layer-version.html @@ -6,7 +6,7 @@ {{- if eq (.Get "layer") "python" -}} - 114 + 117 {{- end -}} diff --git a/layouts/shortcodes/logs-tcp-disclaimer.en.md b/layouts/shortcodes/logs-tcp-disclaimer.en.md new file mode 100644 index 0000000000000..8007b2075f918 --- /dev/null +++ b/layouts/shortcodes/logs-tcp-disclaimer.en.md @@ -0,0 +1,2 @@ +
    TCP log collection is not supported. Datadog provides no delivery or reliability guarantees when using TCP, and log data may be lost without notice. +For reliable ingestion, use the HTTP intake endpoint, an official Datadog Agent, or forwarder integration instead. For more information, see Log Collection.
    \ No newline at end of file diff --git a/layouts/shortcodes/observability_pipelines/configure_existing_pipelines/destination_env_vars/google_pubsub.en.md b/layouts/shortcodes/observability_pipelines/configure_existing_pipelines/destination_env_vars/google_pubsub.en.md new file mode 100644 index 0000000000000..32846608c0f3f --- /dev/null +++ b/layouts/shortcodes/observability_pipelines/configure_existing_pipelines/destination_env_vars/google_pubsub.en.md @@ -0,0 +1,7 @@ +By default the Worker sends data to the global endpoint: `https://pubsub.googleapis.com`. + +If your Pub/Sub topic is region-specific, configure the Google Pub/Sub alternative endpoint URL with the regional endpoint. See [About Pub/Sub endpoints][10240] for more information. + +Stored as the environment variable: `DD_OP_DESTINATION_GCP_PUBSUB_ENDPOINT_URL`. + +[10240]: https://cloud.google.com/pubsub/docs/reference/service_apis_overview#pubsub_endpoints \ No newline at end of file diff --git a/layouts/shortcodes/observability_pipelines/configure_existing_pipelines/destination_env_vars/kafka.en.md b/layouts/shortcodes/observability_pipelines/configure_existing_pipelines/destination_env_vars/kafka.en.md new file mode 100644 index 0000000000000..87a230544299b --- /dev/null +++ b/layouts/shortcodes/observability_pipelines/configure_existing_pipelines/destination_env_vars/kafka.en.md @@ -0,0 +1,16 @@ +#### Kafka bootstrap servers +- The host and port of the Kafka bootstrap servers. +- This is the bootstrap server that the client uses to connect to the Kafka cluster and discover all the other hosts in the cluster. The host and port must be entered in the format of `host:port`, such as `10.14.22.123:9092`. If there is more than one server, use commas to separate them. +- Stored as the environment variable: `DD_OP_DESTINATION_KAFKA_BOOTSTRAP_SERVERS`. + +#### TLS (when enabled) + +- If TLS is enabled, the Kafka TLS passphrase is needed. +- Stored as the environment variable: `DD_OP_DESTINATION_KAFKA_KEY_PASS`. + +#### SASL (when enabled) + +- Kafka SASL username + - Stored as the environment variable: `DD_OP_DESTINATION_KAFKA_SASL_USERNAME`. +- Kafka SASL password + - Stored as the environment variable: `DD_OP_DESTINATION_KAFKA_SASL_PASSWORD`. \ No newline at end of file diff --git a/layouts/shortcodes/observability_pipelines/configure_existing_pipelines/source_env_vars/opentelemetry.en.md b/layouts/shortcodes/observability_pipelines/configure_existing_pipelines/source_env_vars/opentelemetry.en.md new file mode 100644 index 0000000000000..0b96350e53e4b --- /dev/null +++ b/layouts/shortcodes/observability_pipelines/configure_existing_pipelines/source_env_vars/opentelemetry.en.md @@ -0,0 +1,11 @@ +You must provide both HTTP and gRPC endpoints. Configure your OTLP exporters to point to one of these endpoints. See [Send logs to the Observability Pipelines Worker][10230] for more information. + +- HTTP listener address + - The Observability Pipelines Worker listens to this socket address to receive logs from the OTel collector. + - Stored as the environment variable `DD_OP_SOURCE_OTEL_HTTP_ADDRESS`. + +- gRPC listener address + - The Observability Pipelines Worker listens to this socket address to receive logs from the OTel collector. + - Stored as the environment variable `DD_OP_SOURCE_OTEL_GRPC_ADDRESS`. + + [10230]: /observability_pipelines/sources/opentelemetry/#send-logs-to-the-observability-pipelines-worker \ No newline at end of file diff --git a/layouts/shortcodes/observability_pipelines/configure_existing_pipelines/source_env_vars/socket.md b/layouts/shortcodes/observability_pipelines/configure_existing_pipelines/source_env_vars/socket.md index 5b6869c1d01d7..e4f5137c1e63a 100644 --- a/layouts/shortcodes/observability_pipelines/configure_existing_pipelines/source_env_vars/socket.md +++ b/layouts/shortcodes/observability_pipelines/configure_existing_pipelines/source_env_vars/socket.md @@ -1,7 +1,6 @@ - Socket address: - The address and port where the Observability Pipelines Worker listens for incoming logs. - - Stored as the environment variable `DD_OP_SOURCE_SOCKET_ADDRESS` + - Stored as the environment variable `DD_OP_SOURCE_SOCKET_ADDRESS`. -- TLS passphrase: - - Used if TLS is enabled. +- TLS passphrase (when enabled) - Stored as the environment variable `DD_OP_SOURCE_SOCKET_KEY_PASS`. diff --git a/layouts/shortcodes/sds-suppressions.en.md b/layouts/shortcodes/sds-suppressions.en.md new file mode 100644 index 0000000000000..b1aa00ec0ee49 --- /dev/null +++ b/layouts/shortcodes/sds-suppressions.en.md @@ -0,0 +1,8 @@ +1. (Optional) In the **Suppress specific match types to ignore risk-accepted data** section, you can add conditions to ignore certain matches. See [Suppress specific matches to ignore risk-accepted data](#suppress-specific-matches-to-ignore-risk-accepted-data) for more information
    To add a suppression: + 1. Click **Add New Suppression** and choose a condition: + - **Match exactly**: For precise values such as, `info@company.org`. + - **Start with**: For prefixes or ranges. For example: `10.0.0` for all IP ranges under `10.0.0.X`. + - **End with**: For domains such as `@company.org`. + 1. Enter a value (for example: `@company.org`) and click the plus sign (**+**) to add it. + 1. (Optional) Enter additional suppression terms. + 1. Click **Add New Suppression** to add more suppression conditions to the same rule. \ No newline at end of file diff --git a/layouts/shortcodes/serverless-init-install.html b/layouts/shortcodes/serverless-init-install.html index de4dbba31f29d..22748faca666e 100644 --- a/layouts/shortcodes/serverless-init-install.html +++ b/layouts/shortcodes/serverless-init-install.html @@ -10,10 +10,10 @@ - `1.x.x`, `1.x.x-alpine`: use these to pin to a precise version of the library - `latest`, `latest-alpine`: use these to follow the latest version release, which may include breaking changes -Add the following instructions and arguments to your Dockerfile. +{{ if eq (.Get "mode") "in-container" }}Add the following instructions and arguments to your Dockerfile. ```dockerfile -COPY --from=datadog/serverless-init:1 /datadog-init /app/datadog-init +COPY --from=datadog/serverless-init: /datadog-init /app/datadog-init ENTRYPOINT ["/app/datadog-init"] CMD [{{ .Get "cmd" | safeHTML }}] ``` @@ -54,3 +54,4 @@

    Alternative configuration


    +{{ end }} diff --git a/local/bin/py/build/configurations/pull_config.yaml b/local/bin/py/build/configurations/pull_config.yaml index 649d2466a90f7..d0e2572536437 100644 --- a/local/bin/py/build/configurations/pull_config.yaml +++ b/local/bin/py/build/configurations/pull_config.yaml @@ -413,7 +413,7 @@ file_name: 'agent_config.yaml' output_content: false - action: pull-and-push-folder - branch: 7.71.x + branch: 7.72.x globs: - 'docs/cloud-workload-security/agent_expressions.md' - 'docs/cloud-workload-security/backend_linux.md' diff --git a/local/bin/py/build/configurations/pull_config_preview.yaml b/local/bin/py/build/configurations/pull_config_preview.yaml index 38f340d7827fd..0f226eafee4a0 100644 --- a/local/bin/py/build/configurations/pull_config_preview.yaml +++ b/local/bin/py/build/configurations/pull_config_preview.yaml @@ -414,7 +414,7 @@ file_name: 'agent_config.yaml' output_content: false - action: pull-and-push-folder - branch: 7.71.x + branch: 7.72.x globs: - 'docs/cloud-workload-security/agent_expressions.md' - 'docs/cloud-workload-security/backend_linux.md' diff --git a/static/images/account_management/saml/saml_configure.png b/static/images/account_management/saml/saml_configure.png new file mode 100644 index 0000000000000..96db2e1173ec1 Binary files /dev/null and b/static/images/account_management/saml/saml_configure.png differ diff --git a/static/images/account_management/saml/saml_enable.png b/static/images/account_management/saml/saml_enable.png deleted file mode 100644 index a1ebf21d757a8..0000000000000 Binary files a/static/images/account_management/saml/saml_enable.png and /dev/null differ diff --git a/static/images/account_management/saml/saml_enable_cropped.png b/static/images/account_management/saml/saml_enable_cropped.png deleted file mode 100644 index 4c8974499b376..0000000000000 Binary files a/static/images/account_management/saml/saml_enable_cropped.png and /dev/null differ diff --git a/static/images/account_management/saml/saml_enabled.png b/static/images/account_management/saml/saml_enabled.png deleted file mode 100644 index 88c4513507c26..0000000000000 Binary files a/static/images/account_management/saml/saml_enabled.png and /dev/null differ diff --git a/static/images/actions/agents/agent-dashboard.png b/static/images/actions/agents/agent-dashboard.png new file mode 100644 index 0000000000000..862df24e9e8f2 Binary files /dev/null and b/static/images/actions/agents/agent-dashboard.png differ diff --git a/static/images/actions/agents/blank-new-agent.png b/static/images/actions/agents/blank-new-agent.png new file mode 100644 index 0000000000000..f8b0060392967 Binary files /dev/null and b/static/images/actions/agents/blank-new-agent.png differ diff --git a/static/images/datadog_cloudcraft/cloudcraft_2D_2.png b/static/images/datadog_cloudcraft/cloudcraft_2D_2.png new file mode 100644 index 0000000000000..c04b074654372 Binary files /dev/null and b/static/images/datadog_cloudcraft/cloudcraft_2D_2.png differ diff --git a/static/images/datadog_cloudcraft/cloudcraft_group_by_with_network_acl.png b/static/images/datadog_cloudcraft/cloudcraft_group_by_with_network_acl.png new file mode 100644 index 0000000000000..dcc8a84683765 Binary files /dev/null and b/static/images/datadog_cloudcraft/cloudcraft_group_by_with_network_acl.png differ diff --git a/static/images/datadog_cloudcraft/cloudcraft_group_by_with_team_tags.png b/static/images/datadog_cloudcraft/cloudcraft_group_by_with_team_tags.png new file mode 100644 index 0000000000000..1f307ff8ccf4d Binary files /dev/null and b/static/images/datadog_cloudcraft/cloudcraft_group_by_with_team_tags.png differ diff --git a/static/images/datadog_cloudcraft/cloudcraft_with_azure_tab_2.mp4 b/static/images/datadog_cloudcraft/cloudcraft_with_azure_tab_2.mp4 new file mode 100644 index 0000000000000..8f268b84e6c71 Binary files /dev/null and b/static/images/datadog_cloudcraft/cloudcraft_with_azure_tab_2.mp4 differ diff --git a/static/images/datadog_cloudcraft/cloudcraft_with_security_2.mp4 b/static/images/datadog_cloudcraft/cloudcraft_with_security_2.mp4 new file mode 100644 index 0000000000000..d21ff31d92d09 Binary files /dev/null and b/static/images/datadog_cloudcraft/cloudcraft_with_security_2.mp4 differ diff --git a/static/images/datadog_cloudcraft/getting_started.png b/static/images/datadog_cloudcraft/getting_started.png new file mode 100644 index 0000000000000..6ab0e8740bcdc Binary files /dev/null and b/static/images/datadog_cloudcraft/getting_started.png differ diff --git a/static/images/datadog_cloudcraft/getting_started_4.png b/static/images/datadog_cloudcraft/getting_started_4.png new file mode 100644 index 0000000000000..b39fe7cd0e3c6 Binary files /dev/null and b/static/images/datadog_cloudcraft/getting_started_4.png differ diff --git a/static/images/datadog_cloudcraft/infra_overlay_4.png b/static/images/datadog_cloudcraft/infra_overlay_4.png new file mode 100644 index 0000000000000..942483b4f2dad Binary files /dev/null and b/static/images/datadog_cloudcraft/infra_overlay_4.png differ diff --git a/static/images/datadog_cloudcraft/misconfigurations.png b/static/images/datadog_cloudcraft/misconfigurations.png new file mode 100644 index 0000000000000..2bd44e0b74656 Binary files /dev/null and b/static/images/datadog_cloudcraft/misconfigurations.png differ diff --git a/static/images/datadog_cloudcraft/observability_overlay_with_fleet_2.mp4 b/static/images/datadog_cloudcraft/observability_overlay_with_fleet_2.mp4 new file mode 100644 index 0000000000000..12ec6c1629853 Binary files /dev/null and b/static/images/datadog_cloudcraft/observability_overlay_with_fleet_2.mp4 differ diff --git a/static/images/datadog_cloudcraft/overlays/cloudcraft_ccm_overlay_4.png b/static/images/datadog_cloudcraft/overlays/cloudcraft_ccm_overlay_4.png new file mode 100644 index 0000000000000..88c19dc9b9ea2 Binary files /dev/null and b/static/images/datadog_cloudcraft/overlays/cloudcraft_ccm_overlay_4.png differ diff --git a/static/images/datadog_cloudcraft/overlays/cloudcraft_security_overlay_misconfigurations_2.png b/static/images/datadog_cloudcraft/overlays/cloudcraft_security_overlay_misconfigurations_2.png new file mode 100644 index 0000000000000..52cad2a82cf6a Binary files /dev/null and b/static/images/datadog_cloudcraft/overlays/cloudcraft_security_overlay_misconfigurations_2.png differ diff --git a/static/images/datadog_cloudcraft/overlays/cloudcraft_security_overlay_sensitive_data_2.png b/static/images/datadog_cloudcraft/overlays/cloudcraft_security_overlay_sensitive_data_2.png new file mode 100644 index 0000000000000..da325766073fe Binary files /dev/null and b/static/images/datadog_cloudcraft/overlays/cloudcraft_security_overlay_sensitive_data_2.png differ diff --git a/static/images/datadog_cloudcraft/overlays/cloudcraft_security_vuln_2.png b/static/images/datadog_cloudcraft/overlays/cloudcraft_security_vuln_2.png new file mode 100644 index 0000000000000..9a1942e7d9aa3 Binary files /dev/null and b/static/images/datadog_cloudcraft/overlays/cloudcraft_security_vuln_2.png differ diff --git a/static/images/datadog_cloudcraft/search_highlight_4.mp4 b/static/images/datadog_cloudcraft/search_highlight_4.mp4 new file mode 100644 index 0000000000000..91df9ef0fafb4 Binary files /dev/null and b/static/images/datadog_cloudcraft/search_highlight_4.mp4 differ diff --git a/static/images/integrations/google_cloud_platform/limit_metric_collection_2025-11-11.png b/static/images/integrations/google_cloud_platform/limit_metric_collection_2025-11-11.png new file mode 100644 index 0000000000000..5927f0ec6acd2 Binary files /dev/null and b/static/images/integrations/google_cloud_platform/limit_metric_collection_2025-11-11.png differ diff --git a/static/images/integrations/guide/azure_advanced_configuration/azure_metric_explorer.png b/static/images/integrations/guide/azure_advanced_configuration/azure_metric_explorer.png new file mode 100644 index 0000000000000..363b3636549a3 Binary files /dev/null and b/static/images/integrations/guide/azure_advanced_configuration/azure_metric_explorer.png differ diff --git a/static/images/llm_observability/evaluations/custom_llm_judge_1-2.png b/static/images/llm_observability/evaluations/custom_llm_judge_1-2.png new file mode 100644 index 0000000000000..b02b4aafce5f2 Binary files /dev/null and b/static/images/llm_observability/evaluations/custom_llm_judge_1-2.png differ diff --git a/static/images/observability_pipelines/packs/akamai_cdn.png b/static/images/observability_pipelines/packs/akamai_cdn.png new file mode 100644 index 0000000000000..a7bb8b685f537 Binary files /dev/null and b/static/images/observability_pipelines/packs/akamai_cdn.png differ diff --git a/static/images/observability_pipelines/packs/aws_cloudfront.png b/static/images/observability_pipelines/packs/aws_cloudfront.png new file mode 100644 index 0000000000000..a77f543161e7f Binary files /dev/null and b/static/images/observability_pipelines/packs/aws_cloudfront.png differ diff --git a/static/images/observability_pipelines/packs/aws_cloudtrail.png b/static/images/observability_pipelines/packs/aws_cloudtrail.png new file mode 100644 index 0000000000000..56e4929ea70ad Binary files /dev/null and b/static/images/observability_pipelines/packs/aws_cloudtrail.png differ diff --git a/static/images/observability_pipelines/packs/aws_vpc_flow_logs.png b/static/images/observability_pipelines/packs/aws_vpc_flow_logs.png new file mode 100644 index 0000000000000..3cc12879b6d74 Binary files /dev/null and b/static/images/observability_pipelines/packs/aws_vpc_flow_logs.png differ diff --git a/static/images/observability_pipelines/packs/cisco_asa.png b/static/images/observability_pipelines/packs/cisco_asa.png new file mode 100644 index 0000000000000..988ca3525bbcc Binary files /dev/null and b/static/images/observability_pipelines/packs/cisco_asa.png differ diff --git a/static/images/observability_pipelines/packs/cloudflare.png b/static/images/observability_pipelines/packs/cloudflare.png new file mode 100644 index 0000000000000..4867f7bd6f3cd Binary files /dev/null and b/static/images/observability_pipelines/packs/cloudflare.png differ diff --git a/static/images/observability_pipelines/packs/f5.png b/static/images/observability_pipelines/packs/f5.png new file mode 100644 index 0000000000000..48c76ddbfab97 Binary files /dev/null and b/static/images/observability_pipelines/packs/f5.png differ diff --git a/static/images/observability_pipelines/packs/fastly.png b/static/images/observability_pipelines/packs/fastly.png new file mode 100644 index 0000000000000..c02bfc5de9c88 Binary files /dev/null and b/static/images/observability_pipelines/packs/fastly.png differ diff --git a/static/images/observability_pipelines/packs/fortinet_firewall.png b/static/images/observability_pipelines/packs/fortinet_firewall.png new file mode 100644 index 0000000000000..1f1bf1c1f1c09 Binary files /dev/null and b/static/images/observability_pipelines/packs/fortinet_firewall.png differ diff --git a/static/images/observability_pipelines/packs/haproxy_ingress.png b/static/images/observability_pipelines/packs/haproxy_ingress.png new file mode 100644 index 0000000000000..35816d55ae21d Binary files /dev/null and b/static/images/observability_pipelines/packs/haproxy_ingress.png differ diff --git a/static/images/observability_pipelines/packs/istio_proxy.png b/static/images/observability_pipelines/packs/istio_proxy.png new file mode 100644 index 0000000000000..259fb185d12a2 Binary files /dev/null and b/static/images/observability_pipelines/packs/istio_proxy.png differ diff --git a/static/images/observability_pipelines/packs/netskope.png b/static/images/observability_pipelines/packs/netskope.png new file mode 100644 index 0000000000000..45177d98af045 Binary files /dev/null and b/static/images/observability_pipelines/packs/netskope.png differ diff --git a/static/images/observability_pipelines/packs/nginx.png b/static/images/observability_pipelines/packs/nginx.png new file mode 100644 index 0000000000000..b7741594813d5 Binary files /dev/null and b/static/images/observability_pipelines/packs/nginx.png differ diff --git a/static/images/observability_pipelines/packs/okta.png b/static/images/observability_pipelines/packs/okta.png new file mode 100644 index 0000000000000..9ca8c8794d4ba Binary files /dev/null and b/static/images/observability_pipelines/packs/okta.png differ diff --git a/static/images/observability_pipelines/packs/packs.png b/static/images/observability_pipelines/packs/packs.png new file mode 100644 index 0000000000000..be02642354361 Binary files /dev/null and b/static/images/observability_pipelines/packs/packs.png differ diff --git a/static/images/observability_pipelines/packs/palo_alto_firewall.png b/static/images/observability_pipelines/packs/palo_alto_firewall.png new file mode 100644 index 0000000000000..165990d223c8b Binary files /dev/null and b/static/images/observability_pipelines/packs/palo_alto_firewall.png differ diff --git a/static/images/observability_pipelines/packs/windows_xml.png b/static/images/observability_pipelines/packs/windows_xml.png new file mode 100644 index 0000000000000..69ea771dfe8a1 Binary files /dev/null and b/static/images/observability_pipelines/packs/windows_xml.png differ diff --git a/static/images/observability_pipelines/packs/zscaler_dns.png b/static/images/observability_pipelines/packs/zscaler_dns.png new file mode 100644 index 0000000000000..f233e0f53de2a Binary files /dev/null and b/static/images/observability_pipelines/packs/zscaler_dns.png differ diff --git a/static/images/observability_pipelines/packs/zscaler_firewall.png b/static/images/observability_pipelines/packs/zscaler_firewall.png new file mode 100644 index 0000000000000..c011add28ea7f Binary files /dev/null and b/static/images/observability_pipelines/packs/zscaler_firewall.png differ diff --git a/static/images/observability_pipelines/packs/zscaler_tunnel.png b/static/images/observability_pipelines/packs/zscaler_tunnel.png new file mode 100644 index 0000000000000..5892cecab3cb2 Binary files /dev/null and b/static/images/observability_pipelines/packs/zscaler_tunnel.png differ diff --git a/static/images/observability_pipelines/packs/zscaler_web_logs.png b/static/images/observability_pipelines/packs/zscaler_web_logs.png new file mode 100644 index 0000000000000..4c1453f21969f Binary files /dev/null and b/static/images/observability_pipelines/packs/zscaler_web_logs.png differ diff --git a/static/images/synthetics/browser_tests/alerting_rules_2.png b/static/images/synthetics/browser_tests/alerting_rules_2.png new file mode 100644 index 0000000000000..2e00a82f7e8b6 Binary files /dev/null and b/static/images/synthetics/browser_tests/alerting_rules_2.png differ diff --git a/static/resources/json/full_spec_v1.json b/static/resources/json/full_spec_v1.json index d71bdbfcd2da3..4f45e26a1a086 100644 --- a/static/resources/json/full_spec_v1.json +++ b/static/resources/json/full_spec_v1.json @@ -581579,6 +581579,11 @@ "format": "int64", "type": "integer" }, + "apm_enterprise_standalone_hosts_top99p": { + "description": "Shows the 99th percentile of all distinct standalone Enterprise hosts over all hours in the current date for all organizations.", + "format": "int64", + "type": "integer" + }, "apm_fargate_count_avg": { "description": "Shows the average of all APM ECS Fargate tasks over all hours in the current date for all organizations.", "format": "int64", @@ -581589,6 +581594,11 @@ "format": "int64", "type": "integer" }, + "apm_pro_standalone_hosts_top99p": { + "description": "Shows the 99th percentile of all distinct standalone Pro hosts over all hours in the current date for all organizations.", + "format": "int64", + "type": "integer" + }, "appsec_fargate_count_avg": { "description": "Shows the average of all Application Security Monitoring ECS Fargate tasks over all hours in the current date for all organizations.", "format": "int64", @@ -582219,6 +582229,11 @@ "format": "int64", "type": "integer" }, + "apm_enterprise_standalone_hosts_top99p": { + "description": "Shows the 99th percentile of all distinct standalone Enterprise hosts over all hours in the current date for the given org.", + "format": "int64", + "type": "integer" + }, "apm_fargate_count_avg": { "description": "Shows the average of all APM ECS Fargate tasks over all hours in the current month for the given org.", "format": "int64", @@ -582229,6 +582244,11 @@ "format": "int64", "type": "integer" }, + "apm_pro_standalone_hosts_top99p": { + "description": "Shows the 99th percentile of all distinct standalone Pro hosts over all hours in the current date for the given org.", + "format": "int64", + "type": "integer" + }, "appsec_fargate_count_avg": { "description": "Shows the average of all Application Security Monitoring ECS Fargate tasks over all hours in the current month for the given org.", "format": "int64", @@ -583681,6 +583701,11 @@ "format": "int64", "type": "integer" }, + "apm_enterprise_standalone_hosts_top99p": { + "description": "Shows the 99th percentile of all distinct standalone Enterprise hosts over all hours in the current date for the given org.", + "format": "int64", + "type": "integer" + }, "apm_fargate_count_avg": { "description": "Shows the average of all APM ECS Fargate tasks over all hours in the current month for the given org.", "format": "int64", @@ -583691,6 +583716,11 @@ "format": "int64", "type": "integer" }, + "apm_pro_standalone_hosts_top99p": { + "description": "Shows the 99th percentile of all distinct standalone Pro hosts over all hours in the current date for the given org.", + "format": "int64", + "type": "integer" + }, "appsec_fargate_count_avg": { "description": "Shows the average of all Application Security Monitoring ECS Fargate tasks over all hours in the current month for the given org.", "format": "int64", @@ -584733,6 +584763,11 @@ "format": "int64", "type": "integer" }, + "apm_enterprise_standalone_hosts_top99p_sum": { + "description": "Shows the sum of the 99th percentile of all distinct standalone Enterprise hosts over all hours in the current month for all organizations.", + "format": "int64", + "type": "integer" + }, "apm_fargate_count_avg_sum": { "description": "Shows the average of all APM ECS Fargate tasks over all hours in the current month for all organizations.", "format": "int64", @@ -584743,6 +584778,11 @@ "format": "int64", "type": "integer" }, + "apm_pro_standalone_hosts_top99p_sum": { + "description": "Shows the sum of the 99th percentile of all distinct standalone Pro hosts over all hours in the current month for all organizations.", + "format": "int64", + "type": "integer" + }, "appsec_fargate_count_avg_sum": { "description": "Shows the average of all Application Security Monitoring ECS Fargate tasks over all hours in the current month for all organizations.", "format": "int64", @@ -585920,6 +585960,11 @@ "format": "int64", "type": "integer" }, + "apm_enterprise_standalone_hosts_top99p": { + "description": "Shows the 99th percentile of all distinct standalone Enterprise hosts over all hours in the current date for all organizations.", + "format": "int64", + "type": "integer" + }, "apm_fargate_count_avg": { "description": "Shows the average of all APM ECS Fargate tasks over all hours in the current date for all organizations.", "format": "int64", @@ -585930,6 +585975,11 @@ "format": "int64", "type": "integer" }, + "apm_pro_standalone_hosts_top99p": { + "description": "Shows the 99th percentile of all distinct standalone Pro hosts over all hours in the current date for all organizations.", + "format": "int64", + "type": "integer" + }, "appsec_fargate_count_avg": { "description": "Shows the average of all Application Security Monitoring ECS Fargate tasks over all hours in the current date for all organizations.", "format": "int64", @@ -586560,6 +586610,11 @@ "format": "int64", "type": "integer" }, + "apm_enterprise_standalone_hosts_top99p": { + "description": "Shows the 99th percentile of all distinct standalone Enterprise hosts over all hours in the current date for the given org.", + "format": "int64", + "type": "integer" + }, "apm_fargate_count_avg": { "description": "Shows the average of all APM ECS Fargate tasks over all hours in the current month for the given org.", "format": "int64", @@ -586570,6 +586625,11 @@ "format": "int64", "type": "integer" }, + "apm_pro_standalone_hosts_top99p": { + "description": "Shows the 99th percentile of all distinct standalone Pro hosts over all hours in the current date for the given org.", + "format": "int64", + "type": "integer" + }, "appsec_fargate_count_avg": { "description": "Shows the average of all Application Security Monitoring ECS Fargate tasks over all hours in the current month for the given org.", "format": "int64", @@ -705275,7 +705335,7 @@ }, "/api/v1/application_key": { "get": { - "description": "Get all application keys available for your Datadog account.", + "description": "Get all application keys available for your Datadog account.\nThis endpoint is disabled for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode).", "operationId": "ListApplicationKeys", "responses": { "200": { @@ -705400,7 +705460,7 @@ } }, "post": { - "description": "Create an application key with a given name.", + "description": "Create an application key with a given name.\nThis endpoint is disabled for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode).", "operationId": "CreateApplicationKey", "requestBody": { "content": { @@ -705609,7 +705669,7 @@ }, "/api/v1/application_key/{key}": { "delete": { - "description": "Delete a given application key.", + "description": "Delete a given application key.\nThis endpoint is disabled for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode).", "operationId": "DeleteApplicationKey", "parameters": [ { @@ -705767,7 +705827,7 @@ } }, "get": { - "description": "Get a given application key.", + "description": "Get a given application key.\nThis endpoint is disabled for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode).", "operationId": "GetApplicationKey", "parameters": [ { @@ -705925,7 +705985,7 @@ } }, "put": { - "description": "Edit an application key name.", + "description": "Edit an application key name.\nThis endpoint is disabled for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode).", "operationId": "UpdateApplicationKey", "parameters": [ { @@ -1192914,6 +1192974,11 @@ "format": "int64", "type": "integer" }, + "apm_enterprise_standalone_hosts_top99p_sum": { + "description": "Shows the sum of the 99th percentile of all distinct standalone Enterprise hosts over all hours in the current month for all organizations.", + "format": "int64", + "type": "integer" + }, "apm_fargate_count_avg_sum": { "description": "Shows the average of all APM ECS Fargate tasks over all hours in the current month for all organizations.", "format": "int64", @@ -1192924,6 +1192989,11 @@ "format": "int64", "type": "integer" }, + "apm_pro_standalone_hosts_top99p_sum": { + "description": "Shows the sum of the 99th percentile of all distinct standalone Pro hosts over all hours in the current month for all organizations.", + "format": "int64", + "type": "integer" + }, "appsec_fargate_count_avg_sum": { "description": "Shows the average of all Application Security Monitoring ECS Fargate tasks over all hours in the current month for all organizations.", "format": "int64", @@ -1194101,6 +1194171,11 @@ "format": "int64", "type": "integer" }, + "apm_enterprise_standalone_hosts_top99p": { + "description": "Shows the 99th percentile of all distinct standalone Enterprise hosts over all hours in the current date for all organizations.", + "format": "int64", + "type": "integer" + }, "apm_fargate_count_avg": { "description": "Shows the average of all APM ECS Fargate tasks over all hours in the current date for all organizations.", "format": "int64", @@ -1194111,6 +1194186,11 @@ "format": "int64", "type": "integer" }, + "apm_pro_standalone_hosts_top99p": { + "description": "Shows the 99th percentile of all distinct standalone Pro hosts over all hours in the current date for all organizations.", + "format": "int64", + "type": "integer" + }, "appsec_fargate_count_avg": { "description": "Shows the average of all Application Security Monitoring ECS Fargate tasks over all hours in the current date for all organizations.", "format": "int64", @@ -1194741,6 +1194821,11 @@ "format": "int64", "type": "integer" }, + "apm_enterprise_standalone_hosts_top99p": { + "description": "Shows the 99th percentile of all distinct standalone Enterprise hosts over all hours in the current date for the given org.", + "format": "int64", + "type": "integer" + }, "apm_fargate_count_avg": { "description": "Shows the average of all APM ECS Fargate tasks over all hours in the current month for the given org.", "format": "int64", @@ -1194751,6 +1194836,11 @@ "format": "int64", "type": "integer" }, + "apm_pro_standalone_hosts_top99p": { + "description": "Shows the 99th percentile of all distinct standalone Pro hosts over all hours in the current date for the given org.", + "format": "int64", + "type": "integer" + }, "appsec_fargate_count_avg": { "description": "Shows the average of all Application Security Monitoring ECS Fargate tasks over all hours in the current month for the given org.", "format": "int64", diff --git a/static/resources/json/full_spec_v2.json b/static/resources/json/full_spec_v2.json index 7e2ea912fc95a..0e1df9b3b83b4 100644 --- a/static/resources/json/full_spec_v2.json +++ b/static/resources/json/full_spec_v2.json @@ -646,7 +646,7 @@ } }, "GetIssueIncludeQueryParameter": { - "description": "Comma-separated list of relationship objects that should be included in the response.", + "description": "Comma-separated list of relationship objects that should be included in the response. Possible values are `assignee`, `case`, and `team_owners`.", "explode": false, "in": "query", "name": "include", @@ -1454,7 +1454,7 @@ } }, "SearchIssuesIncludeQueryParameter": { - "description": "Comma-separated list of relationship objects that should be included in the response.", + "description": "Comma-separated list of relationship objects that should be included in the response. Possible values are `issue`, `issue.assignee`, `issue.case`, and `issue.team_owners`.", "explode": false, "in": "query", "name": "include", @@ -3114,6 +3114,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -3409,6 +3416,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -3988,6 +4002,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -21753,6 +21774,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -22140,6 +22168,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -71370,6 +71405,78 @@ }, "type": "object" }, + "ConnectedTeamRef": { + "description": "Reference to a team from an external system.", + "properties": { + "data": { + "description": "Reference to connected external team.", + "properties": { + "id": { + "description": "The connected team ID as it is referenced throughout the Datadog ecosystem.", + "example": "@GitHubOrg/team-handle", + "type": "string" + }, + "type": { + "default": "github_team", + "description": "External team resource type.", + "enum": [ + "github_team" + ], + "example": "github_team", + "type": "string", + "x-enum-varnames": [ + "GITHUB_TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + }, + "ConnectedTeamRefData": { + "description": "Reference to connected external team.", + "properties": { + "id": { + "description": "The connected team ID as it is referenced throughout the Datadog ecosystem.", + "example": "@GitHubOrg/team-handle", + "type": "string" + }, + "type": { + "default": "github_team", + "description": "External team resource type.", + "enum": [ + "github_team" + ], + "example": "github_team", + "type": "string", + "x-enum-varnames": [ + "GITHUB_TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "ConnectedTeamRefDataType": { + "default": "github_team", + "description": "External team resource type.", + "enum": [ + "github_team" + ], + "example": "github_team", + "type": "string", + "x-enum-varnames": [ + "GITHUB_TEAM" + ] + }, "Connection": { "description": "The definition of `Connection` object.", "properties": { @@ -71511,6 +71618,108 @@ ], "type": "object" }, + "ConnectionsPagePagination": { + "description": "Page-based pagination metadata.", + "properties": { + "first_number": { + "description": "The first page number.", + "format": "int64", + "type": "integer" + }, + "last_number": { + "description": "The last page number.", + "format": "int64", + "type": "integer" + }, + "next_number": { + "description": "The next page number.", + "format": "int64", + "nullable": true, + "type": "integer" + }, + "number": { + "description": "The current page number.", + "format": "int64", + "type": "integer" + }, + "prev_number": { + "description": "The previous page number.", + "format": "int64", + "nullable": true, + "type": "integer" + }, + "size": { + "description": "The page size.", + "format": "int64", + "type": "integer" + }, + "total": { + "description": "Total connections matching request.", + "format": "int64", + "type": "integer" + }, + "type": { + "description": "Pagination type.", + "example": "number_size", + "type": "string" + } + }, + "type": "object" + }, + "ConnectionsResponseMeta": { + "description": "Connections response metadata.", + "properties": { + "page": { + "description": "Page-based pagination metadata.", + "properties": { + "first_number": { + "description": "The first page number.", + "format": "int64", + "type": "integer" + }, + "last_number": { + "description": "The last page number.", + "format": "int64", + "type": "integer" + }, + "next_number": { + "description": "The next page number.", + "format": "int64", + "nullable": true, + "type": "integer" + }, + "number": { + "description": "The current page number.", + "format": "int64", + "type": "integer" + }, + "prev_number": { + "description": "The previous page number.", + "format": "int64", + "nullable": true, + "type": "integer" + }, + "size": { + "description": "The page size.", + "format": "int64", + "type": "integer" + }, + "total": { + "description": "Total connections matching request.", + "format": "int64", + "type": "integer" + }, + "type": { + "description": "Pagination type.", + "example": "number_size", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, "Container": { "description": "Container object.", "properties": { @@ -102102,6 +102311,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -102958,6 +103174,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -148001,6 +148224,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -148487,6 +148717,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -148738,6 +148975,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -151971,6 +152215,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -153117,6 +153368,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -153659,6 +153917,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -154322,6 +154587,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -155319,6 +155591,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -156698,6 +156977,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -158251,6 +158537,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -158954,6 +159247,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -159742,6 +160042,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -168775,6 +169082,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -169231,6 +169545,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -170052,6 +170373,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -170609,6 +170937,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -171061,6 +171396,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -171877,6 +172219,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -173019,6 +173368,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -173852,6 +174208,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -174312,6 +174675,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -187043,6 +187413,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -189399,6 +189776,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -202320,6 +202704,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -221040,577 +221431,591 @@ "description": "URL of the user's icon.", "type": "string" }, - "mfa_enabled": { - "description": "If user has MFA enabled.", - "readOnly": true, - "type": "boolean" - }, - "modified_at": { - "description": "Time that the user was last modified.", + "last_login_time": { + "description": "The last time the user logged in.", "format": "date-time", - "type": "string" - }, - "name": { - "description": "Name of the user.", - "nullable": true, - "type": "string" - }, - "service_account": { - "description": "Whether the user is a service account.", - "type": "boolean" - }, - "status": { - "description": "Status of the user.", - "type": "string" - }, - "title": { - "description": "Title of the user.", "nullable": true, - "type": "string" - }, - "verified": { - "description": "Whether the user is verified.", - "type": "boolean" - } - }, - "type": "object" - }, - "id": { - "description": "ID of the user.", - "type": "string" - }, - "relationships": { - "description": "Relationships of the user object returned by the API.", - "properties": { - "org": { - "description": "Relationship to an organization.", - "properties": { - "data": { - "description": "Relationship to organization object.", - "properties": { - "id": { - "description": "ID of the organization.", - "example": "00000000-0000-beef-0000-000000000000", - "type": "string" - }, - "type": { - "default": "orgs", - "description": "Organizations resource type.", - "enum": [ - "orgs" - ], - "example": "orgs", - "type": "string", - "x-enum-varnames": [ - "ORGS" - ] - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "other_orgs": { - "description": "Relationship to organizations.", - "properties": { - "data": { - "description": "Relationships to organization objects.", - "example": [], - "items": { - "description": "Relationship to organization object.", - "properties": { - "id": { - "description": "ID of the organization.", - "example": "00000000-0000-beef-0000-000000000000", - "type": "string" - }, - "type": { - "default": "orgs", - "description": "Organizations resource type.", - "enum": [ - "orgs" - ], - "example": "orgs", - "type": "string", - "x-enum-varnames": [ - "ORGS" - ] - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "type": "array" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "other_users": { - "description": "Relationship to users.", - "properties": { - "data": { - "description": "Relationships to user objects.", - "example": [], - "items": { - "description": "Relationship to user object.", - "properties": { - "id": { - "description": "A unique identifier that represents the user.", - "example": "00000000-0000-0000-2345-000000000000", - "type": "string" - }, - "type": { - "default": "users", - "description": "Users resource type.", - "enum": [ - "users" - ], - "example": "users", - "type": "string", - "x-enum-varnames": [ - "USERS" - ] - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "type": "array" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "roles": { - "description": "Relationship to roles.", - "properties": { - "data": { - "description": "An array containing type and the unique identifier of a role.", - "items": { - "description": "Relationship to role object.", - "properties": { - "id": { - "description": "The unique identifier of the role.", - "example": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", - "type": "string" - }, - "type": { - "default": "roles", - "description": "Roles type.", - "enum": [ - "roles" - ], - "example": "roles", - "type": "string", - "x-enum-varnames": [ - "ROLES" - ] - } - }, - "type": "object" - }, - "type": "array" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "type": { - "default": "users", - "description": "Users resource type.", - "enum": [ - "users" - ], - "example": "users", - "type": "string", - "x-enum-varnames": [ - "USERS" - ] - } - }, - "type": "object" - } - ] - }, - "type": "array" - } - }, - "type": "object" - }, - "MonitorNotificationRuleName": { - "description": "The name of the monitor notification rule.", - "example": "A notification rule name", - "maxLength": 1000, - "minLength": 1, - "type": "string" - }, - "MonitorNotificationRuleRecipients": { - "description": "A list of recipients to notify. Uses the same format as the monitor `message` field. Must not start with an '@'.", - "example": [ - "slack-test-channel", - "jira-test" - ], - "items": { - "description": "individual recipient.", - "maxLength": 255, - "type": "string" - }, - "maxItems": 20, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "MonitorNotificationRuleRelationships": { - "description": "All relationships associated with monitor notification rule.", - "properties": { - "created_by": { - "description": "The user who created the monitor notification rule.", - "properties": { - "data": { - "description": "Data for the user who created the monitor notification rule.", - "nullable": true, - "properties": { - "id": { - "description": "User ID of the monitor notification rule creator.", - "example": "00000000-0000-1234-0000-000000000000", - "type": "string" - }, - "type": { - "default": "users", - "description": "Users resource type.", - "enum": [ - "users" - ], - "example": "users", - "type": "string", - "x-enum-varnames": [ - "USERS" - ] - } - }, - "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "MonitorNotificationRuleRelationshipsCreatedBy": { - "description": "The user who created the monitor notification rule.", - "properties": { - "data": { - "description": "Data for the user who created the monitor notification rule.", - "nullable": true, - "properties": { - "id": { - "description": "User ID of the monitor notification rule creator.", - "example": "00000000-0000-1234-0000-000000000000", - "type": "string" - }, - "type": { - "default": "users", - "description": "Users resource type.", - "enum": [ - "users" - ], - "example": "users", - "type": "string", - "x-enum-varnames": [ - "USERS" - ] - } - }, - "type": "object" - } - }, - "type": "object" - }, - "MonitorNotificationRuleRelationshipsCreatedByData": { - "description": "Data for the user who created the monitor notification rule.", - "nullable": true, - "properties": { - "id": { - "description": "User ID of the monitor notification rule creator.", - "example": "00000000-0000-1234-0000-000000000000", - "type": "string" - }, - "type": { - "default": "users", - "description": "Users resource type.", - "enum": [ - "users" - ], - "example": "users", - "type": "string", - "x-enum-varnames": [ - "USERS" - ] - } - }, - "type": "object" - }, - "MonitorNotificationRuleResourceType": { - "default": "monitor-notification-rule", - "description": "Monitor notification rule resource type.", - "enum": [ - "monitor-notification-rule" - ], - "example": "monitor-notification-rule", - "type": "string", - "x-enum-varnames": [ - "MONITOR_NOTIFICATION_RULE" - ] - }, - "MonitorNotificationRuleResponse": { - "description": "A monitor notification rule.", - "properties": { - "data": { - "description": "Monitor notification rule data.", - "properties": { - "attributes": { - "additionalProperties": {}, - "description": "Attributes of the monitor notification rule.", - "properties": { - "conditional_recipients": { - "description": "Use conditional recipients to define different recipients for different situations.", - "properties": { - "conditions": { - "description": "Conditions of the notification rule.", - "items": { - "description": "Conditions for `conditional_recipients`.", - "properties": { - "recipients": { - "description": "A list of recipients to notify. Uses the same format as the monitor `message` field. Must not start with an '@'.", - "example": [ - "slack-test-channel", - "jira-test" - ], - "items": { - "description": "individual recipient.", - "maxLength": 255, - "type": "string" - }, - "maxItems": 20, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "scope": { - "description": "The scope to which the monitor applied.", - "example": "transition_type:alert", - "maxLength": 3000, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "scope", - "recipients" - ], - "type": "object" - }, - "maxItems": 10, - "minItems": 1, - "type": "array" - }, - "fallback_recipients": { - "description": "If none of the `conditions` applied, `fallback_recipients` will get notified.", - "example": [ - "slack-test-channel", - "jira-test" - ], - "items": { - "description": "individual recipient.", - "maxLength": 255, - "type": "string" - }, - "maxItems": 20, - "minItems": 1, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "conditions" - ], - "type": "object" - }, - "created": { - "description": "Creation time of the monitor notification rule.", - "example": "2020-01-02T03:04:00.000Z", - "format": "date-time", - "type": "string" - }, - "filter": { - "description": "Filter used to associate the notification rule with monitors.", - "oneOf": [ - { - "additionalProperties": false, - "description": "Filter monitors by tags. Monitors must match all tags.", - "properties": { - "tags": { - "description": "A list of monitor tags.", - "example": [ - "team:product", - "host:abc" - ], - "items": { - "maxLength": 255, - "type": "string" - }, - "maxItems": 20, - "minItems": 1, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "tags" - ], - "type": "object" - } - ] - }, - "modified": { - "description": "Time the monitor notification rule was last modified.", - "example": "2020-01-02T03:04:00.000Z", - "format": "date-time", - "type": "string" - }, - "name": { - "description": "The name of the monitor notification rule.", - "example": "A notification rule name", - "maxLength": 1000, - "minLength": 1, - "type": "string" - }, - "recipients": { - "description": "A list of recipients to notify. Uses the same format as the monitor `message` field. Must not start with an '@'.", - "example": [ - "slack-test-channel", - "jira-test" - ], - "items": { - "description": "individual recipient.", - "maxLength": 255, - "type": "string" - }, - "maxItems": 20, - "minItems": 1, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" - }, - "id": { - "description": "The ID of the monitor notification rule.", - "example": "00000000-0000-1234-0000-000000000000", - "type": "string" - }, - "relationships": { - "description": "All relationships associated with monitor notification rule.", - "properties": { - "created_by": { - "description": "The user who created the monitor notification rule.", - "properties": { - "data": { - "description": "Data for the user who created the monitor notification rule.", - "nullable": true, - "properties": { - "id": { - "description": "User ID of the monitor notification rule creator.", - "example": "00000000-0000-1234-0000-000000000000", - "type": "string" - }, - "type": { - "default": "users", - "description": "Users resource type.", - "enum": [ - "users" - ], - "example": "users", - "type": "string", - "x-enum-varnames": [ - "USERS" - ] - } - }, - "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "type": { - "default": "monitor-notification-rule", - "description": "Monitor notification rule resource type.", - "enum": [ - "monitor-notification-rule" - ], - "example": "monitor-notification-rule", - "type": "string", - "x-enum-varnames": [ - "MONITOR_NOTIFICATION_RULE" - ] - } - }, - "type": "object" - }, - "included": { - "description": "Array of objects related to the monitor notification rule that the user requested.", - "items": { - "description": "An object related to a monitor notification rule.", - "oneOf": [ - { - "description": "User object returned by the API.", - "properties": { - "attributes": { - "description": "Attributes of user object returned by the API.", - "properties": { - "created_at": { - "description": "Creation time of the user.", - "format": "date-time", - "type": "string" - }, - "disabled": { - "description": "Whether the user is disabled.", - "type": "boolean" - }, - "email": { - "description": "Email of the user.", - "type": "string" - }, - "handle": { - "description": "Handle of the user.", - "type": "string" - }, - "icon": { - "description": "URL of the user's icon.", + "readOnly": true, + "type": "string" + }, + "mfa_enabled": { + "description": "If user has MFA enabled.", + "readOnly": true, + "type": "boolean" + }, + "modified_at": { + "description": "Time that the user was last modified.", + "format": "date-time", + "type": "string" + }, + "name": { + "description": "Name of the user.", + "nullable": true, + "type": "string" + }, + "service_account": { + "description": "Whether the user is a service account.", + "type": "boolean" + }, + "status": { + "description": "Status of the user.", + "type": "string" + }, + "title": { + "description": "Title of the user.", + "nullable": true, + "type": "string" + }, + "verified": { + "description": "Whether the user is verified.", + "type": "boolean" + } + }, + "type": "object" + }, + "id": { + "description": "ID of the user.", + "type": "string" + }, + "relationships": { + "description": "Relationships of the user object returned by the API.", + "properties": { + "org": { + "description": "Relationship to an organization.", + "properties": { + "data": { + "description": "Relationship to organization object.", + "properties": { + "id": { + "description": "ID of the organization.", + "example": "00000000-0000-beef-0000-000000000000", + "type": "string" + }, + "type": { + "default": "orgs", + "description": "Organizations resource type.", + "enum": [ + "orgs" + ], + "example": "orgs", + "type": "string", + "x-enum-varnames": [ + "ORGS" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "other_orgs": { + "description": "Relationship to organizations.", + "properties": { + "data": { + "description": "Relationships to organization objects.", + "example": [], + "items": { + "description": "Relationship to organization object.", + "properties": { + "id": { + "description": "ID of the organization.", + "example": "00000000-0000-beef-0000-000000000000", + "type": "string" + }, + "type": { + "default": "orgs", + "description": "Organizations resource type.", + "enum": [ + "orgs" + ], + "example": "orgs", + "type": "string", + "x-enum-varnames": [ + "ORGS" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "other_users": { + "description": "Relationship to users.", + "properties": { + "data": { + "description": "Relationships to user objects.", + "example": [], + "items": { + "description": "Relationship to user object.", + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-2345-000000000000", + "type": "string" + }, + "type": { + "default": "users", + "description": "Users resource type.", + "enum": [ + "users" + ], + "example": "users", + "type": "string", + "x-enum-varnames": [ + "USERS" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "roles": { + "description": "Relationship to roles.", + "properties": { + "data": { + "description": "An array containing type and the unique identifier of a role.", + "items": { + "description": "Relationship to role object.", + "properties": { + "id": { + "description": "The unique identifier of the role.", + "example": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", + "type": "string" + }, + "type": { + "default": "roles", + "description": "Roles type.", + "enum": [ + "roles" + ], + "example": "roles", + "type": "string", + "x-enum-varnames": [ + "ROLES" + ] + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": { + "default": "users", + "description": "Users resource type.", + "enum": [ + "users" + ], + "example": "users", + "type": "string", + "x-enum-varnames": [ + "USERS" + ] + } + }, + "type": "object" + } + ] + }, + "type": "array" + } + }, + "type": "object" + }, + "MonitorNotificationRuleName": { + "description": "The name of the monitor notification rule.", + "example": "A notification rule name", + "maxLength": 1000, + "minLength": 1, + "type": "string" + }, + "MonitorNotificationRuleRecipients": { + "description": "A list of recipients to notify. Uses the same format as the monitor `message` field. Must not start with an '@'.", + "example": [ + "slack-test-channel", + "jira-test" + ], + "items": { + "description": "individual recipient.", + "maxLength": 255, + "type": "string" + }, + "maxItems": 20, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "MonitorNotificationRuleRelationships": { + "description": "All relationships associated with monitor notification rule.", + "properties": { + "created_by": { + "description": "The user who created the monitor notification rule.", + "properties": { + "data": { + "description": "Data for the user who created the monitor notification rule.", + "nullable": true, + "properties": { + "id": { + "description": "User ID of the monitor notification rule creator.", + "example": "00000000-0000-1234-0000-000000000000", + "type": "string" + }, + "type": { + "default": "users", + "description": "Users resource type.", + "enum": [ + "users" + ], + "example": "users", + "type": "string", + "x-enum-varnames": [ + "USERS" + ] + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "MonitorNotificationRuleRelationshipsCreatedBy": { + "description": "The user who created the monitor notification rule.", + "properties": { + "data": { + "description": "Data for the user who created the monitor notification rule.", + "nullable": true, + "properties": { + "id": { + "description": "User ID of the monitor notification rule creator.", + "example": "00000000-0000-1234-0000-000000000000", + "type": "string" + }, + "type": { + "default": "users", + "description": "Users resource type.", + "enum": [ + "users" + ], + "example": "users", + "type": "string", + "x-enum-varnames": [ + "USERS" + ] + } + }, + "type": "object" + } + }, + "type": "object" + }, + "MonitorNotificationRuleRelationshipsCreatedByData": { + "description": "Data for the user who created the monitor notification rule.", + "nullable": true, + "properties": { + "id": { + "description": "User ID of the monitor notification rule creator.", + "example": "00000000-0000-1234-0000-000000000000", + "type": "string" + }, + "type": { + "default": "users", + "description": "Users resource type.", + "enum": [ + "users" + ], + "example": "users", + "type": "string", + "x-enum-varnames": [ + "USERS" + ] + } + }, + "type": "object" + }, + "MonitorNotificationRuleResourceType": { + "default": "monitor-notification-rule", + "description": "Monitor notification rule resource type.", + "enum": [ + "monitor-notification-rule" + ], + "example": "monitor-notification-rule", + "type": "string", + "x-enum-varnames": [ + "MONITOR_NOTIFICATION_RULE" + ] + }, + "MonitorNotificationRuleResponse": { + "description": "A monitor notification rule.", + "properties": { + "data": { + "description": "Monitor notification rule data.", + "properties": { + "attributes": { + "additionalProperties": {}, + "description": "Attributes of the monitor notification rule.", + "properties": { + "conditional_recipients": { + "description": "Use conditional recipients to define different recipients for different situations.", + "properties": { + "conditions": { + "description": "Conditions of the notification rule.", + "items": { + "description": "Conditions for `conditional_recipients`.", + "properties": { + "recipients": { + "description": "A list of recipients to notify. Uses the same format as the monitor `message` field. Must not start with an '@'.", + "example": [ + "slack-test-channel", + "jira-test" + ], + "items": { + "description": "individual recipient.", + "maxLength": 255, + "type": "string" + }, + "maxItems": 20, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "scope": { + "description": "The scope to which the monitor applied.", + "example": "transition_type:alert", + "maxLength": 3000, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "scope", + "recipients" + ], + "type": "object" + }, + "maxItems": 10, + "minItems": 1, + "type": "array" + }, + "fallback_recipients": { + "description": "If none of the `conditions` applied, `fallback_recipients` will get notified.", + "example": [ + "slack-test-channel", + "jira-test" + ], + "items": { + "description": "individual recipient.", + "maxLength": 255, + "type": "string" + }, + "maxItems": 20, + "minItems": 1, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "conditions" + ], + "type": "object" + }, + "created": { + "description": "Creation time of the monitor notification rule.", + "example": "2020-01-02T03:04:00.000Z", + "format": "date-time", + "type": "string" + }, + "filter": { + "description": "Filter used to associate the notification rule with monitors.", + "oneOf": [ + { + "additionalProperties": false, + "description": "Filter monitors by tags. Monitors must match all tags.", + "properties": { + "tags": { + "description": "A list of monitor tags.", + "example": [ + "team:product", + "host:abc" + ], + "items": { + "maxLength": 255, + "type": "string" + }, + "maxItems": 20, + "minItems": 1, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "tags" + ], + "type": "object" + } + ] + }, + "modified": { + "description": "Time the monitor notification rule was last modified.", + "example": "2020-01-02T03:04:00.000Z", + "format": "date-time", + "type": "string" + }, + "name": { + "description": "The name of the monitor notification rule.", + "example": "A notification rule name", + "maxLength": 1000, + "minLength": 1, + "type": "string" + }, + "recipients": { + "description": "A list of recipients to notify. Uses the same format as the monitor `message` field. Must not start with an '@'.", + "example": [ + "slack-test-channel", + "jira-test" + ], + "items": { + "description": "individual recipient.", + "maxLength": 255, + "type": "string" + }, + "maxItems": 20, + "minItems": 1, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "id": { + "description": "The ID of the monitor notification rule.", + "example": "00000000-0000-1234-0000-000000000000", + "type": "string" + }, + "relationships": { + "description": "All relationships associated with monitor notification rule.", + "properties": { + "created_by": { + "description": "The user who created the monitor notification rule.", + "properties": { + "data": { + "description": "Data for the user who created the monitor notification rule.", + "nullable": true, + "properties": { + "id": { + "description": "User ID of the monitor notification rule creator.", + "example": "00000000-0000-1234-0000-000000000000", + "type": "string" + }, + "type": { + "default": "users", + "description": "Users resource type.", + "enum": [ + "users" + ], + "example": "users", + "type": "string", + "x-enum-varnames": [ + "USERS" + ] + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": { + "default": "monitor-notification-rule", + "description": "Monitor notification rule resource type.", + "enum": [ + "monitor-notification-rule" + ], + "example": "monitor-notification-rule", + "type": "string", + "x-enum-varnames": [ + "MONITOR_NOTIFICATION_RULE" + ] + } + }, + "type": "object" + }, + "included": { + "description": "Array of objects related to the monitor notification rule that the user requested.", + "items": { + "description": "An object related to a monitor notification rule.", + "oneOf": [ + { + "description": "User object returned by the API.", + "properties": { + "attributes": { + "description": "Attributes of user object returned by the API.", + "properties": { + "created_at": { + "description": "Creation time of the user.", + "format": "date-time", + "type": "string" + }, + "disabled": { + "description": "Whether the user is disabled.", + "type": "boolean" + }, + "email": { + "description": "Email of the user.", + "type": "string" + }, + "handle": { + "description": "Handle of the user.", + "type": "string" + }, + "icon": { + "description": "URL of the user's icon.", + "type": "string" + }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, "type": "string" }, "mfa_enabled": { @@ -221997,6 +222402,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -273010,6 +273422,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -277136,6 +277555,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -334082,6 +334508,17 @@ "example": "env:staging status:low", "type": "string" }, + "tags": { + "description": "List of tags associated with the suppression rule.", + "example": [ + "technique:T1110-brute-force", + "source:cloudtrail" + ], + "items": { + "type": "string" + }, + "type": "array" + }, "update_date": { "description": "A Unix millisecond timestamp given the update date of the suppression rule.", "format": "int64", @@ -334206,6 +334643,17 @@ "example": "env:staging status:low", "type": "string" }, + "tags": { + "description": "List of tags associated with the suppression rule.", + "example": [ + "technique:T1110-brute-force", + "source:cloudtrail" + ], + "items": { + "type": "string" + }, + "type": "array" + }, "update_date": { "description": "A Unix millisecond timestamp given the update date of the suppression rule.", "format": "int64", @@ -334282,6 +334730,17 @@ "description": "The suppression query of the suppression rule. If a signal matches this query, it is suppressed and is not triggered. It uses the same syntax as the queries to search signals in the Signals Explorer.", "example": "env:staging status:low", "type": "string" + }, + "tags": { + "description": "List of tags associated with the suppression rule.", + "example": [ + "technique:T1110-brute-force", + "source:cloudtrail" + ], + "items": { + "type": "string" + }, + "type": "array" } }, "required": [ @@ -334338,6 +334797,17 @@ "description": "The suppression query of the suppression rule. If a signal matches this query, it is suppressed and is not triggered. It uses the same syntax as the queries to search signals in the Signals Explorer.", "example": "env:staging status:low", "type": "string" + }, + "tags": { + "description": "List of tags associated with the suppression rule.", + "example": [ + "technique:T1110-brute-force", + "source:cloudtrail" + ], + "items": { + "type": "string" + }, + "type": "array" } }, "required": [ @@ -334416,6 +334886,17 @@ "description": "The suppression query of the suppression rule. If a signal matches this query, it is suppressed and is not triggered. It uses the same syntax as the queries to search signals in the Signals Explorer.", "example": "env:staging status:low", "type": "string" + }, + "tags": { + "description": "List of tags associated with the suppression rule.", + "example": [ + "technique:T1110-brute-force", + "source:cloudtrail" + ], + "items": { + "type": "string" + }, + "type": "array" } }, "required": [ @@ -334533,6 +335014,17 @@ "example": "env:staging status:low", "type": "string" }, + "tags": { + "description": "List of tags associated with the suppression rule.", + "example": [ + "technique:T1110-brute-force", + "source:cloudtrail" + ], + "items": { + "type": "string" + }, + "type": "array" + }, "update_date": { "description": "A Unix millisecond timestamp given the update date of the suppression rule.", "format": "int64", @@ -334647,6 +335139,17 @@ "example": "env:staging status:low", "type": "string" }, + "tags": { + "description": "List of tags associated with the suppression rule.", + "example": [ + "technique:T1110-brute-force", + "source:cloudtrail" + ], + "items": { + "type": "string" + }, + "type": "array" + }, "version": { "description": "The current version of the suppression. This is optional, but it can help prevent concurrent modifications.", "format": "int32", @@ -334706,6 +335209,17 @@ "example": "env:staging status:low", "type": "string" }, + "tags": { + "description": "List of tags associated with the suppression rule.", + "example": [ + "technique:T1110-brute-force", + "source:cloudtrail" + ], + "items": { + "type": "string" + }, + "type": "array" + }, "version": { "description": "The current version of the suppression. This is optional, but it can help prevent concurrent modifications.", "format": "int32", @@ -334787,6 +335301,17 @@ "example": "env:staging status:low", "type": "string" }, + "tags": { + "description": "List of tags associated with the suppression rule.", + "example": [ + "technique:T1110-brute-force", + "source:cloudtrail" + ], + "items": { + "type": "string" + }, + "type": "array" + }, "version": { "description": "The current version of the suppression. This is optional, but it can help prevent concurrent modifications.", "format": "int32", @@ -334901,6 +335426,17 @@ "example": "env:staging status:low", "type": "string" }, + "tags": { + "description": "List of tags associated with the suppression rule.", + "example": [ + "technique:T1110-brute-force", + "source:cloudtrail" + ], + "items": { + "type": "string" + }, + "type": "array" + }, "update_date": { "description": "A Unix millisecond timestamp given the update date of the suppression rule.", "format": "int64", @@ -358110,6 +358646,7 @@ "description": "Metadata specifying where and how to access the reference table's data file.", "oneOf": [ { + "additionalProperties": false, "description": "File metadata for reference tables created by cloud storage.", "properties": { "access_details": { @@ -358252,6 +358789,7 @@ "type": "object" }, { + "additionalProperties": false, "description": "File metadata for reference tables created by upload. Note that upload_id is only returned in the immediate create/replace response and is not available in subsequent GET requests.", "properties": { "error_message": { @@ -358526,6 +359064,7 @@ "description": "Metadata specifying where and how to access the reference table's data file.", "oneOf": [ { + "additionalProperties": false, "description": "File metadata for reference tables created by cloud storage.", "properties": { "access_details": { @@ -358668,6 +359207,7 @@ "type": "object" }, { + "additionalProperties": false, "description": "File metadata for reference tables created by upload. Note that upload_id is only returned in the immediate create/replace response and is not available in subsequent GET requests.", "properties": { "error_message": { @@ -358853,6 +359393,7 @@ "description": "Metadata specifying where and how to access the reference table's data file.", "oneOf": [ { + "additionalProperties": false, "description": "File metadata for reference tables created by cloud storage.", "properties": { "access_details": { @@ -358995,6 +359536,7 @@ "type": "object" }, { + "additionalProperties": false, "description": "File metadata for reference tables created by upload. Note that upload_id is only returned in the immediate create/replace response and is not available in subsequent GET requests.", "properties": { "error_message": { @@ -359168,6 +359710,7 @@ "description": "Metadata specifying where and how to access the reference table's data file.", "oneOf": [ { + "additionalProperties": false, "description": "File metadata for reference tables created by cloud storage.", "properties": { "access_details": { @@ -359310,6 +359853,7 @@ "type": "object" }, { + "additionalProperties": false, "description": "File metadata for reference tables created by upload. Note that upload_id is only returned in the immediate create/replace response and is not available in subsequent GET requests.", "properties": { "error_message": { @@ -359448,6 +359992,7 @@ "description": "Metadata specifying where and how to access the reference table's data file.", "oneOf": [ { + "additionalProperties": false, "description": "File metadata for reference tables created by cloud storage.", "properties": { "access_details": { @@ -359590,6 +360135,7 @@ "type": "object" }, { + "additionalProperties": false, "description": "File metadata for reference tables created by upload. Note that upload_id is only returned in the immediate create/replace response and is not available in subsequent GET requests.", "properties": { "error_message": { @@ -359608,6 +360154,7 @@ ] }, "TableResultV2DataAttributesFileMetadataCloudStorage": { + "additionalProperties": false, "description": "File metadata for reference tables created by cloud storage.", "properties": { "access_details": { @@ -359776,6 +360323,7 @@ ] }, "TableResultV2DataAttributesFileMetadataLocalFile": { + "additionalProperties": false, "description": "File metadata for reference tables created by upload. Note that upload_id is only returned in the immediate create/replace response and is not available in subsequent GET requests.", "properties": { "error_message": { @@ -360507,6 +361055,698 @@ ], "type": "object" }, + "TeamConnection": { + "description": "A relationship between a Datadog team and a team from another external system.", + "properties": { + "attributes": { + "description": "Attributes of the team connection.", + "properties": { + "managed_by": { + "description": "The entity that manages this team connection.", + "example": "github_sync", + "type": "string" + }, + "source": { + "description": "The name of the external source.", + "example": "github", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "The unique identifier of the team connection.", + "example": "12345678-1234-5678-9abc-123456789012", + "type": "string" + }, + "relationships": { + "description": "Relationships of the team connection.", + "properties": { + "connected_team": { + "description": "Reference to a team from an external system.", + "properties": { + "data": { + "description": "Reference to connected external team.", + "properties": { + "id": { + "description": "The connected team ID as it is referenced throughout the Datadog ecosystem.", + "example": "@GitHubOrg/team-handle", + "type": "string" + }, + "type": { + "default": "github_team", + "description": "External team resource type.", + "enum": [ + "github_team" + ], + "example": "github_team", + "type": "string", + "x-enum-varnames": [ + "GITHUB_TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + }, + "team": { + "description": "Reference to a Datadog team.", + "properties": { + "data": { + "description": "Reference to a Datadog team.", + "properties": { + "id": { + "description": "The Datadog team ID.", + "example": "87654321-4321-8765-dcba-210987654321", + "type": "string" + }, + "type": { + "default": "team", + "description": "Datadog team resource type.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": { + "default": "team_connection", + "description": "Team connection resource type.", + "enum": [ + "team_connection" + ], + "example": "team_connection", + "type": "string", + "x-enum-varnames": [ + "TEAM_CONNECTION" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "TeamConnectionAttributes": { + "description": "Attributes of the team connection.", + "properties": { + "managed_by": { + "description": "The entity that manages this team connection.", + "example": "github_sync", + "type": "string" + }, + "source": { + "description": "The name of the external source.", + "example": "github", + "type": "string" + } + }, + "type": "object" + }, + "TeamConnectionCreateData": { + "description": "Data for creating a team connection.", + "properties": { + "attributes": { + "description": "Attributes of the team connection.", + "properties": { + "managed_by": { + "description": "The entity that manages this team connection.", + "example": "github_sync", + "type": "string" + }, + "source": { + "description": "The name of the external source.", + "example": "github", + "type": "string" + } + }, + "type": "object" + }, + "relationships": { + "description": "Relationships of the team connection.", + "properties": { + "connected_team": { + "description": "Reference to a team from an external system.", + "properties": { + "data": { + "description": "Reference to connected external team.", + "properties": { + "id": { + "description": "The connected team ID as it is referenced throughout the Datadog ecosystem.", + "example": "@GitHubOrg/team-handle", + "type": "string" + }, + "type": { + "default": "github_team", + "description": "External team resource type.", + "enum": [ + "github_team" + ], + "example": "github_team", + "type": "string", + "x-enum-varnames": [ + "GITHUB_TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + }, + "team": { + "description": "Reference to a Datadog team.", + "properties": { + "data": { + "description": "Reference to a Datadog team.", + "properties": { + "id": { + "description": "The Datadog team ID.", + "example": "87654321-4321-8765-dcba-210987654321", + "type": "string" + }, + "type": { + "default": "team", + "description": "Datadog team resource type.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": { + "default": "team_connection", + "description": "Team connection resource type.", + "enum": [ + "team_connection" + ], + "example": "team_connection", + "type": "string", + "x-enum-varnames": [ + "TEAM_CONNECTION" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "TeamConnectionCreateRequest": { + "description": "Request for creating team connections.", + "properties": { + "data": { + "description": "Array of team connections to create.", + "items": { + "description": "Data for creating a team connection.", + "properties": { + "attributes": { + "description": "Attributes of the team connection.", + "properties": { + "managed_by": { + "description": "The entity that manages this team connection.", + "example": "github_sync", + "type": "string" + }, + "source": { + "description": "The name of the external source.", + "example": "github", + "type": "string" + } + }, + "type": "object" + }, + "relationships": { + "description": "Relationships of the team connection.", + "properties": { + "connected_team": { + "description": "Reference to a team from an external system.", + "properties": { + "data": { + "description": "Reference to connected external team.", + "properties": { + "id": { + "description": "The connected team ID as it is referenced throughout the Datadog ecosystem.", + "example": "@GitHubOrg/team-handle", + "type": "string" + }, + "type": { + "default": "github_team", + "description": "External team resource type.", + "enum": [ + "github_team" + ], + "example": "github_team", + "type": "string", + "x-enum-varnames": [ + "GITHUB_TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + }, + "team": { + "description": "Reference to a Datadog team.", + "properties": { + "data": { + "description": "Reference to a Datadog team.", + "properties": { + "id": { + "description": "The Datadog team ID.", + "example": "87654321-4321-8765-dcba-210987654321", + "type": "string" + }, + "type": { + "default": "team", + "description": "Datadog team resource type.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": { + "default": "team_connection", + "description": "Team connection resource type.", + "enum": [ + "team_connection" + ], + "example": "team_connection", + "type": "string", + "x-enum-varnames": [ + "TEAM_CONNECTION" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "TeamConnectionDeleteRequest": { + "description": "Request for deleting team connections.", + "properties": { + "data": { + "description": "Array of team connection IDs to delete.", + "items": { + "description": "A collection of connection ids to delete.", + "properties": { + "id": { + "description": "The unique identifier of the team connection to delete.", + "example": "12345678-1234-5678-9abc-123456789012", + "type": "string" + }, + "type": { + "default": "team_connection", + "description": "Team connection resource type.", + "enum": [ + "team_connection" + ], + "example": "team_connection", + "type": "string", + "x-enum-varnames": [ + "TEAM_CONNECTION" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "TeamConnectionDeleteRequestDataItem": { + "description": "A collection of connection ids to delete.", + "properties": { + "id": { + "description": "The unique identifier of the team connection to delete.", + "example": "12345678-1234-5678-9abc-123456789012", + "type": "string" + }, + "type": { + "default": "team_connection", + "description": "Team connection resource type.", + "enum": [ + "team_connection" + ], + "example": "team_connection", + "type": "string", + "x-enum-varnames": [ + "TEAM_CONNECTION" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "TeamConnectionRelationships": { + "description": "Relationships of the team connection.", + "properties": { + "connected_team": { + "description": "Reference to a team from an external system.", + "properties": { + "data": { + "description": "Reference to connected external team.", + "properties": { + "id": { + "description": "The connected team ID as it is referenced throughout the Datadog ecosystem.", + "example": "@GitHubOrg/team-handle", + "type": "string" + }, + "type": { + "default": "github_team", + "description": "External team resource type.", + "enum": [ + "github_team" + ], + "example": "github_team", + "type": "string", + "x-enum-varnames": [ + "GITHUB_TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + }, + "team": { + "description": "Reference to a Datadog team.", + "properties": { + "data": { + "description": "Reference to a Datadog team.", + "properties": { + "id": { + "description": "The Datadog team ID.", + "example": "87654321-4321-8765-dcba-210987654321", + "type": "string" + }, + "type": { + "default": "team", + "description": "Datadog team resource type.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "TeamConnectionType": { + "default": "team_connection", + "description": "Team connection resource type.", + "enum": [ + "team_connection" + ], + "example": "team_connection", + "type": "string", + "x-enum-varnames": [ + "TEAM_CONNECTION" + ] + }, + "TeamConnectionsResponse": { + "description": "Response containing information about multiple team connections.", + "properties": { + "data": { + "description": "Array of team connections.", + "items": { + "description": "A relationship between a Datadog team and a team from another external system.", + "properties": { + "attributes": { + "description": "Attributes of the team connection.", + "properties": { + "managed_by": { + "description": "The entity that manages this team connection.", + "example": "github_sync", + "type": "string" + }, + "source": { + "description": "The name of the external source.", + "example": "github", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "The unique identifier of the team connection.", + "example": "12345678-1234-5678-9abc-123456789012", + "type": "string" + }, + "relationships": { + "description": "Relationships of the team connection.", + "properties": { + "connected_team": { + "description": "Reference to a team from an external system.", + "properties": { + "data": { + "description": "Reference to connected external team.", + "properties": { + "id": { + "description": "The connected team ID as it is referenced throughout the Datadog ecosystem.", + "example": "@GitHubOrg/team-handle", + "type": "string" + }, + "type": { + "default": "github_team", + "description": "External team resource type.", + "enum": [ + "github_team" + ], + "example": "github_team", + "type": "string", + "x-enum-varnames": [ + "GITHUB_TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + }, + "team": { + "description": "Reference to a Datadog team.", + "properties": { + "data": { + "description": "Reference to a Datadog team.", + "properties": { + "id": { + "description": "The Datadog team ID.", + "example": "87654321-4321-8765-dcba-210987654321", + "type": "string" + }, + "type": { + "default": "team", + "description": "Datadog team resource type.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": { + "default": "team_connection", + "description": "Team connection resource type.", + "enum": [ + "team_connection" + ], + "example": "team_connection", + "type": "string", + "x-enum-varnames": [ + "TEAM_CONNECTION" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "type": "array" + }, + "meta": { + "description": "Connections response metadata.", + "properties": { + "page": { + "description": "Page-based pagination metadata.", + "properties": { + "first_number": { + "description": "The first page number.", + "format": "int64", + "type": "integer" + }, + "last_number": { + "description": "The last page number.", + "format": "int64", + "type": "integer" + }, + "next_number": { + "description": "The next page number.", + "format": "int64", + "nullable": true, + "type": "integer" + }, + "number": { + "description": "The current page number.", + "format": "int64", + "type": "integer" + }, + "prev_number": { + "description": "The previous page number.", + "format": "int64", + "nullable": true, + "type": "integer" + }, + "size": { + "description": "The page size.", + "format": "int64", + "type": "integer" + }, + "total": { + "description": "Total connections matching request.", + "format": "int64", + "type": "integer" + }, + "type": { + "description": "Pagination type.", + "example": "number_size", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, "TeamCreate": { "description": "Team create", "properties": { @@ -360893,6 +362133,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -361750,6 +362997,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -362415,6 +363669,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -363262,6 +364523,78 @@ }, "type": "object" }, + "TeamRef": { + "description": "Reference to a Datadog team.", + "properties": { + "data": { + "description": "Reference to a Datadog team.", + "properties": { + "id": { + "description": "The Datadog team ID.", + "example": "87654321-4321-8765-dcba-210987654321", + "type": "string" + }, + "type": { + "default": "team", + "description": "Datadog team resource type.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + }, + "TeamRefData": { + "description": "Reference to a Datadog team.", + "properties": { + "id": { + "description": "The Datadog team ID.", + "example": "87654321-4321-8765-dcba-210987654321", + "type": "string" + }, + "type": { + "default": "team", + "description": "Datadog team resource type.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "TeamRefDataType": { + "default": "team", + "description": "Datadog team resource type.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + }, "TeamReference": { "description": "Provides a reference to a team, including ID, type, and basic attributes/relationships.", "properties": { @@ -366304,6 +367637,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -394732,6 +396072,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -394967,6 +396314,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -395839,6 +397193,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -397018,6 +398379,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -397887,6 +399255,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -398645,6 +400020,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -399345,6 +400727,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -430188,6 +431577,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -430834,6 +432230,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -431537,6 +432940,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -432178,6 +433588,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -443245,6 +444662,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -444051,6 +445475,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -444776,6 +446207,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -488687,6 +490125,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -489420,6 +490865,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -489997,7 +491449,7 @@ } }, "get": { - "description": "Get an application key owned by current user", + "description": "Get an application key owned by current user.\nThe `key` field is not returned for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode).", "operationId": "GetCurrentUserApplicationKey", "parameters": [ { @@ -490166,6 +491618,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -490625,7 +492084,7 @@ } }, "patch": { - "description": "Edit an application key owned by current user", + "description": "Edit an application key owned by current user.\nThe `key` field is not returned for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode).", "operationId": "UpdateCurrentUserApplicationKey", "parameters": [ { @@ -490863,6 +492322,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -496602,6 +498068,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -497567,6 +499040,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -498457,6 +499937,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -499468,6 +500955,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -499869,7 +501363,7 @@ "operationId": "SearchIssues", "parameters": [ { - "description": "Comma-separated list of relationship objects that should be included in the response.", + "description": "Comma-separated list of relationship objects that should be included in the response. Possible values are `issue`, `issue.assignee`, `issue.case`, and `issue.team_owners`.", "explode": false, "in": "query", "name": "include", @@ -501132,7 +502626,7 @@ } }, { - "description": "Comma-separated list of relationship objects that should be included in the response.", + "description": "Comma-separated list of relationship objects that should be included in the response. Possible values are `assignee`, `case`, and `team_owners`.", "explode": false, "in": "query", "name": "include", @@ -509825,6 +511319,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -511239,6 +512740,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -512631,6 +514139,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -514046,6 +515561,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -515142,6 +516664,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -516152,6 +517681,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -517250,6 +518786,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -518220,6 +519763,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -525883,6 +527433,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -526715,6 +528272,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -528647,6 +530211,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -529636,6 +531207,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -530569,6 +532147,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -531530,6 +533115,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -532183,6 +533775,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -533008,6 +534607,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -533864,6 +535470,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -534667,6 +536280,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -568756,6 +570376,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -569460,6 +571087,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -570154,6 +571788,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -570903,6 +572544,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -583438,6 +585086,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -589743,6 +591398,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -590838,6 +592500,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -591631,6 +593300,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -592678,6 +594354,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -596968,6 +598651,7 @@ "description": "Metadata specifying where and how to access the reference table's data file.", "oneOf": [ { + "additionalProperties": false, "description": "File metadata for reference tables created by cloud storage.", "properties": { "access_details": { @@ -597110,6 +598794,7 @@ "type": "object" }, { + "additionalProperties": false, "description": "File metadata for reference tables created by upload. Note that upload_id is only returned in the immediate create/replace response and is not available in subsequent GET requests.", "properties": { "error_message": { @@ -597748,6 +599433,7 @@ "description": "Metadata specifying where and how to access the reference table's data file.", "oneOf": [ { + "additionalProperties": false, "description": "File metadata for reference tables created by cloud storage.", "properties": { "access_details": { @@ -597890,6 +599576,7 @@ "type": "object" }, { + "additionalProperties": false, "description": "File metadata for reference tables created by upload. Note that upload_id is only returned in the immediate create/replace response and is not available in subsequent GET requests.", "properties": { "error_message": { @@ -598360,6 +600047,7 @@ "description": "Metadata specifying where and how to access the reference table's data file.", "oneOf": [ { + "additionalProperties": false, "description": "File metadata for reference tables created by cloud storage.", "properties": { "access_details": { @@ -598502,6 +600190,7 @@ "type": "object" }, { + "additionalProperties": false, "description": "File metadata for reference tables created by upload. Note that upload_id is only returned in the immediate create/replace response and is not available in subsequent GET requests.", "properties": { "error_message": { @@ -645171,6 +646860,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -645870,6 +647566,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -646534,6 +648237,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -669915,6 +671625,17 @@ "example": "env:staging status:low", "type": "string" }, + "tags": { + "description": "List of tags associated with the suppression rule.", + "example": [ + "technique:T1110-brute-force", + "source:cloudtrail" + ], + "items": { + "type": "string" + }, + "type": "array" + }, "update_date": { "description": "A Unix millisecond timestamp given the update date of the suppression rule.", "format": "int64", @@ -670106,6 +671827,17 @@ "description": "The suppression query of the suppression rule. If a signal matches this query, it is suppressed and is not triggered. It uses the same syntax as the queries to search signals in the Signals Explorer.", "example": "env:staging status:low", "type": "string" + }, + "tags": { + "description": "List of tags associated with the suppression rule.", + "example": [ + "technique:T1110-brute-force", + "source:cloudtrail" + ], + "items": { + "type": "string" + }, + "type": "array" } }, "required": [ @@ -670227,6 +671959,17 @@ "example": "env:staging status:low", "type": "string" }, + "tags": { + "description": "List of tags associated with the suppression rule.", + "example": [ + "technique:T1110-brute-force", + "source:cloudtrail" + ], + "items": { + "type": "string" + }, + "type": "array" + }, "update_date": { "description": "A Unix millisecond timestamp given the update date of the suppression rule.", "format": "int64", @@ -672295,268 +674038,290 @@ "example": "env:staging status:low", "type": "string" }, - "update_date": { - "description": "A Unix millisecond timestamp given the update date of the suppression rule.", - "format": "int64", - "type": "integer" - }, - "updater": { - "description": "A user.", - "properties": { - "handle": { - "description": "The handle of the user.", - "example": "john.doe@datadoghq.com", - "type": "string" - }, - "name": { - "description": "The name of the user.", - "example": "John Doe", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "version": { - "description": "The version of the suppression rule; it starts at 1, and is incremented at each update.", - "example": 42, - "format": "int32", - "maximum": 2147483647, - "type": "integer" - } - }, - "type": "object" - }, - "id": { - "description": "The ID of the suppression rule.", - "example": "3dd-0uc-h1s", - "type": "string" - }, - "type": { - "default": "suppressions", - "description": "The type of the resource. The value should always be `suppressions`.", - "enum": [ - "suppressions" - ], - "example": "suppressions", - "type": "string", - "x-enum-varnames": [ - "SUPPRESSIONS" - ] - } - }, - "type": "object" - }, - "type": "array" - } - }, - "type": "object" - } - } - }, - "description": "OK" - }, - "400": { - "content": { - "application/json": { - "schema": { - "description": "API error response.", - "properties": { - "errors": { - "description": "A list of errors.", - "example": [ - "Bad Request" - ], - "items": { - "description": "A list of items.", - "example": "Bad Request", - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "errors" - ], - "type": "object" - } - } - }, - "description": "Bad Request" - }, - "403": { - "content": { - "application/json": { - "schema": { - "description": "API error response.", - "properties": { - "errors": { - "description": "A list of errors.", - "example": [ - "Bad Request" - ], - "items": { - "description": "A list of items.", - "example": "Bad Request", - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "errors" - ], - "type": "object" - } - } - }, - "description": "Not Authorized" - }, - "429": { - "content": { - "application/json": { - "schema": { - "description": "API error response.", - "properties": { - "errors": { - "description": "A list of errors.", - "example": [ - "Bad Request" - ], - "items": { - "description": "A list of items.", - "example": "Bad Request", - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "errors" - ], - "type": "object" - } - } - }, - "description": "Too many requests" - } - }, - "security": [ - { - "apiKeyAuth": [], - "appKeyAuth": [] - }, - { - "AuthZ": [ - "security_monitoring_suppressions_read" - ] - } - ], - "summary": "Get suppressions affecting future rule", - "tags": [ - "Security Monitoring" - ], - "x-menu-order": 0 - } - }, - "/api/v2/security_monitoring/configuration/suppressions/rules/{rule_id}": { - "get": { - "description": "Get the list of suppressions that affect a specific existing rule by its ID.", - "operationId": "GetSuppressionsAffectingRule", - "parameters": [ - { - "description": "The ID of the rule.", - "in": "path", - "name": "rule_id", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "description": "Response object containing the available suppression rules.", - "properties": { - "data": { - "description": "A list of suppressions objects.", - "items": { - "description": "The suppression rule's properties.", - "properties": { - "attributes": { - "description": "The attributes of the suppression rule.", - "properties": { - "creation_date": { - "description": "A Unix millisecond timestamp given the creation date of the suppression rule.", - "format": "int64", - "type": "integer" - }, - "creator": { - "description": "A user.", - "properties": { - "handle": { - "description": "The handle of the user.", - "example": "john.doe@datadoghq.com", - "type": "string" - }, - "name": { - "description": "The name of the user.", - "example": "John Doe", - "nullable": true, - "type": "string" - } + "tags": { + "description": "List of tags associated with the suppression rule.", + "example": [ + "technique:T1110-brute-force", + "source:cloudtrail" + ], + "items": { + "type": "string" }, - "type": "object" - }, - "data_exclusion_query": { - "description": "An exclusion query on the input data of the security rules, which could be logs, Agent events, or other types of data based on the security rule. Events matching this query are ignored by any detection rules referenced in the suppression rule.", - "example": "source:cloudtrail account_id:12345", - "type": "string" - }, - "description": { - "description": "A description for the suppression rule.", - "example": "This rule suppresses low-severity signals in staging environments.", - "type": "string" - }, - "editable": { - "description": "Whether the suppression rule is editable.", - "example": true, - "type": "boolean" - }, - "enabled": { - "description": "Whether the suppression rule is enabled.", - "example": true, - "type": "boolean" - }, - "expiration_date": { - "description": "A Unix millisecond timestamp giving an expiration date for the suppression rule. After this date, it won't suppress signals anymore.", - "example": 1703187336000, - "format": "int64", - "type": "integer" - }, - "name": { - "description": "The name of the suppression rule.", - "example": "Custom suppression", - "type": "string" - }, - "rule_query": { - "description": "The rule query of the suppression rule, with the same syntax as the search bar for detection rules.", - "example": "type:log_detection source:cloudtrail", - "type": "string" - }, - "start_date": { - "description": "A Unix millisecond timestamp giving the start date for the suppression rule. After this date, it starts suppressing signals.", - "example": 1703187336000, - "format": "int64", - "type": "integer" - }, - "suppression_query": { - "description": "The suppression query of the suppression rule. If a signal matches this query, it is suppressed and not triggered. Same syntax as the queries to search signals in the signal explorer.", - "example": "env:staging status:low", - "type": "string" + "type": "array" + }, + "update_date": { + "description": "A Unix millisecond timestamp given the update date of the suppression rule.", + "format": "int64", + "type": "integer" + }, + "updater": { + "description": "A user.", + "properties": { + "handle": { + "description": "The handle of the user.", + "example": "john.doe@datadoghq.com", + "type": "string" + }, + "name": { + "description": "The name of the user.", + "example": "John Doe", + "nullable": true, + "type": "string" + } + }, + "type": "object" + }, + "version": { + "description": "The version of the suppression rule; it starts at 1, and is incremented at each update.", + "example": 42, + "format": "int32", + "maximum": 2147483647, + "type": "integer" + } + }, + "type": "object" + }, + "id": { + "description": "The ID of the suppression rule.", + "example": "3dd-0uc-h1s", + "type": "string" + }, + "type": { + "default": "suppressions", + "description": "The type of the resource. The value should always be `suppressions`.", + "enum": [ + "suppressions" + ], + "example": "suppressions", + "type": "string", + "x-enum-varnames": [ + "SUPPRESSIONS" + ] + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + } + } + }, + "description": "OK" + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Bad Request" + }, + "403": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Not Authorized" + }, + "429": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Too many requests" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [ + "security_monitoring_suppressions_read" + ] + } + ], + "summary": "Get suppressions affecting future rule", + "tags": [ + "Security Monitoring" + ], + "x-menu-order": 0 + } + }, + "/api/v2/security_monitoring/configuration/suppressions/rules/{rule_id}": { + "get": { + "description": "Get the list of suppressions that affect a specific existing rule by its ID.", + "operationId": "GetSuppressionsAffectingRule", + "parameters": [ + { + "description": "The ID of the rule.", + "in": "path", + "name": "rule_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "Response object containing the available suppression rules.", + "properties": { + "data": { + "description": "A list of suppressions objects.", + "items": { + "description": "The suppression rule's properties.", + "properties": { + "attributes": { + "description": "The attributes of the suppression rule.", + "properties": { + "creation_date": { + "description": "A Unix millisecond timestamp given the creation date of the suppression rule.", + "format": "int64", + "type": "integer" + }, + "creator": { + "description": "A user.", + "properties": { + "handle": { + "description": "The handle of the user.", + "example": "john.doe@datadoghq.com", + "type": "string" + }, + "name": { + "description": "The name of the user.", + "example": "John Doe", + "nullable": true, + "type": "string" + } + }, + "type": "object" + }, + "data_exclusion_query": { + "description": "An exclusion query on the input data of the security rules, which could be logs, Agent events, or other types of data based on the security rule. Events matching this query are ignored by any detection rules referenced in the suppression rule.", + "example": "source:cloudtrail account_id:12345", + "type": "string" + }, + "description": { + "description": "A description for the suppression rule.", + "example": "This rule suppresses low-severity signals in staging environments.", + "type": "string" + }, + "editable": { + "description": "Whether the suppression rule is editable.", + "example": true, + "type": "boolean" + }, + "enabled": { + "description": "Whether the suppression rule is enabled.", + "example": true, + "type": "boolean" + }, + "expiration_date": { + "description": "A Unix millisecond timestamp giving an expiration date for the suppression rule. After this date, it won't suppress signals anymore.", + "example": 1703187336000, + "format": "int64", + "type": "integer" + }, + "name": { + "description": "The name of the suppression rule.", + "example": "Custom suppression", + "type": "string" + }, + "rule_query": { + "description": "The rule query of the suppression rule, with the same syntax as the search bar for detection rules.", + "example": "type:log_detection source:cloudtrail", + "type": "string" + }, + "start_date": { + "description": "A Unix millisecond timestamp giving the start date for the suppression rule. After this date, it starts suppressing signals.", + "example": 1703187336000, + "format": "int64", + "type": "integer" + }, + "suppression_query": { + "description": "The suppression query of the suppression rule. If a signal matches this query, it is suppressed and not triggered. Same syntax as the queries to search signals in the signal explorer.", + "example": "env:staging status:low", + "type": "string" + }, + "tags": { + "description": "List of tags associated with the suppression rule.", + "example": [ + "technique:T1110-brute-force", + "source:cloudtrail" + ], + "items": { + "type": "string" + }, + "type": "array" }, "update_date": { "description": "A Unix millisecond timestamp given the update date of the suppression rule.", @@ -672779,6 +674544,17 @@ "description": "The suppression query of the suppression rule. If a signal matches this query, it is suppressed and is not triggered. It uses the same syntax as the queries to search signals in the Signals Explorer.", "example": "env:staging status:low", "type": "string" + }, + "tags": { + "description": "List of tags associated with the suppression rule.", + "example": [ + "technique:T1110-brute-force", + "source:cloudtrail" + ], + "items": { + "type": "string" + }, + "type": "array" } }, "required": [ @@ -673148,6 +674924,17 @@ "example": "env:staging status:low", "type": "string" }, + "tags": { + "description": "List of tags associated with the suppression rule.", + "example": [ + "technique:T1110-brute-force", + "source:cloudtrail" + ], + "items": { + "type": "string" + }, + "type": "array" + }, "update_date": { "description": "A Unix millisecond timestamp given the update date of the suppression rule.", "format": "int64", @@ -673379,6 +675166,17 @@ "example": "env:staging status:low", "type": "string" }, + "tags": { + "description": "List of tags associated with the suppression rule.", + "example": [ + "technique:T1110-brute-force", + "source:cloudtrail" + ], + "items": { + "type": "string" + }, + "type": "array" + }, "version": { "description": "The current version of the suppression. This is optional, but it can help prevent concurrent modifications.", "format": "int32", @@ -673500,6 +675298,17 @@ "example": "env:staging status:low", "type": "string" }, + "tags": { + "description": "List of tags associated with the suppression rule.", + "example": [ + "technique:T1110-brute-force", + "source:cloudtrail" + ], + "items": { + "type": "string" + }, + "type": "array" + }, "update_date": { "description": "A Unix millisecond timestamp given the update date of the suppression rule.", "format": "int64", @@ -698352,6 +700161,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -699144,6 +700960,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -699889,6 +701712,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -700648,6 +702478,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -701348,6 +703185,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -702073,6 +703917,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -702798,6 +704649,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -708146,6 +710004,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -708856,6 +710721,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -721141,6 +723013,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -721594,403 +723473,1444 @@ } } }, - "description": "Too many requests" - } - }, - "security": [ - { - "apiKeyAuth": [], - "appKeyAuth": [] - }, - { - "AuthZ": [ - "teams_read" - ] - } - ], - "summary": "Get all teams", - "tags": [ - "Teams" - ], - "x-menu-order": 1, - "x-pagination": { - "limitParam": "page[size]", - "pageParam": "page[number]", - "resultsPath": "data" - }, - "x-permission": { - "operator": "OR", - "permissions": [ - "teams_read" - ] - } - }, - "post": { - "description": "Create a new team.\nUser IDs passed through the `users` relationship field are added to the team.", - "operationId": "CreateTeam", - "requestBody": { - "content": { - "application/json": { - "schema": { - "description": "Request to create a team", - "properties": { - "data": { - "description": "Team create", - "properties": { - "attributes": { - "description": "Team creation attributes", - "properties": { - "avatar": { - "description": "Unicode representation of the avatar for the team, limited to a single grapheme", - "example": "🥑", - "nullable": true, - "type": "string" - }, - "banner": { - "description": "Banner selection for the team", - "format": "int64", - "nullable": true, - "type": "integer" - }, - "description": { - "description": "Free-form markdown description/content for the team's homepage", - "type": "string" - }, - "handle": { - "description": "The team's identifier", - "example": "example-team", - "maxLength": 195, - "type": "string" - }, - "hidden_modules": { - "description": "Collection of hidden modules for the team", - "items": { - "description": "String identifier of the module", - "type": "string" - }, - "type": "array" - }, - "name": { - "description": "The name of the team", - "example": "Example Team", - "maxLength": 200, - "type": "string" - }, - "visible_modules": { - "description": "Collection of visible modules for the team", - "items": { - "description": "String identifier of the module", - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "handle", - "name" - ], - "type": "object" - }, - "relationships": { - "description": "Relationships formed with the team on creation", - "properties": { - "users": { - "description": "Relationship to users.", - "properties": { - "data": { - "description": "Relationships to user objects.", - "example": [], - "items": { - "description": "Relationship to user object.", - "properties": { - "id": { - "description": "A unique identifier that represents the user.", - "example": "00000000-0000-0000-2345-000000000000", - "type": "string" - }, - "type": { - "default": "users", - "description": "Users resource type.", - "enum": [ - "users" - ], - "example": "users", - "type": "string", - "x-enum-varnames": [ - "USERS" - ] - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "type": "array" - } - }, - "required": [ - "data" - ], - "type": "object" - } - }, - "type": "object" - }, - "type": { - "default": "team", - "description": "Team type", - "enum": [ - "team" - ], - "example": "team", - "type": "string", - "x-enum-varnames": [ - "TEAM" - ] - } - }, - "required": [ - "attributes", - "type" - ], - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" - } - } - }, - "required": true - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "description": "Response with a team", - "properties": { - "data": { - "description": "A team", - "properties": { - "attributes": { - "description": "Team attributes", - "properties": { - "avatar": { - "description": "Unicode representation of the avatar for the team, limited to a single grapheme", - "example": "🥑", - "nullable": true, - "type": "string" - }, - "banner": { - "description": "Banner selection for the team", - "format": "int64", - "nullable": true, - "type": "integer" - }, - "created_at": { - "description": "Creation date of the team", - "format": "date-time", - "type": "string" - }, - "description": { - "description": "Free-form markdown description/content for the team's homepage", - "nullable": true, - "type": "string" - }, - "handle": { - "description": "The team's identifier", - "example": "example-team", - "maxLength": 195, - "type": "string" - }, - "hidden_modules": { - "description": "Collection of hidden modules for the team", - "items": { - "description": "String identifier of the module", - "type": "string" - }, - "type": "array" - }, - "link_count": { - "description": "The number of links belonging to the team", - "format": "int32", - "maximum": 2147483647, - "readOnly": true, - "type": "integer" - }, - "modified_at": { - "description": "Modification date of the team", - "format": "date-time", - "type": "string" - }, - "name": { - "description": "The name of the team", - "example": "Example Team", - "maxLength": 200, - "type": "string" - }, - "summary": { - "description": "A brief summary of the team, derived from the `description`", - "maxLength": 120, - "nullable": true, - "type": "string" - }, - "user_count": { - "description": "The number of users belonging to the team", - "format": "int32", - "maximum": 2147483647, - "readOnly": true, - "type": "integer" - }, - "visible_modules": { - "description": "Collection of visible modules for the team", - "items": { - "description": "String identifier of the module", - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "handle", - "name" - ], - "type": "object" - }, - "id": { - "description": "The team's identifier", - "example": "aeadc05e-98a8-11ec-ac2c-da7ad0900001", - "type": "string" - }, - "relationships": { - "description": "Resources related to a team", - "properties": { - "team_links": { - "description": "Relationship between a team and a team link", - "properties": { - "data": { - "description": "Related team links", - "items": { - "description": "Relationship between a link and a team", - "properties": { - "id": { - "description": "The team link's identifier", - "example": "f9bb8444-af7f-11ec-ac2c-da7ad0900001", - "type": "string" - }, - "type": { - "default": "team_links", - "description": "Team link type", - "enum": [ - "team_links" - ], - "example": "team_links", - "type": "string", - "x-enum-varnames": [ - "TEAM_LINKS" - ] - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "type": "array" - }, - "links": { - "description": "Links attributes.", - "properties": { - "related": { - "description": "Related link.", - "example": "/api/v2/team/c75a4a8e-20c7-11ee-a3a5-da7ad0900002/links", - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "user_team_permissions": { - "description": "Relationship between a user team permission and a team", - "properties": { - "data": { - "description": "Related user team permission data", - "properties": { - "id": { - "description": "The ID of the user team permission", - "example": "UserTeamPermissions-aeadc05e-98a8-11ec-ac2c-da7ad0900001-416595", - "type": "string" - }, - "type": { - "default": "user_team_permissions", - "description": "User team permission type", - "enum": [ - "user_team_permissions" - ], - "example": "user_team_permissions", - "type": "string", - "x-enum-varnames": [ - "USER_TEAM_PERMISSIONS" - ] - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "links": { - "description": "Links attributes.", - "properties": { - "related": { - "description": "Related link.", - "example": "/api/v2/team/c75a4a8e-20c7-11ee-a3a5-da7ad0900002/links", - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "type": { - "default": "team", - "description": "Team type", - "enum": [ - "team" - ], - "example": "team", - "type": "string", - "x-enum-varnames": [ - "TEAM" - ] - } - }, - "required": [ - "attributes", - "id", - "type" - ], - "type": "object" - } - }, - "type": "object" - } - } - }, - "description": "CREATED" + "description": "Too many requests" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [ + "teams_read" + ] + } + ], + "summary": "Get all teams", + "tags": [ + "Teams" + ], + "x-menu-order": 1, + "x-pagination": { + "limitParam": "page[size]", + "pageParam": "page[number]", + "resultsPath": "data" + }, + "x-permission": { + "operator": "OR", + "permissions": [ + "teams_read" + ] + } + }, + "post": { + "description": "Create a new team.\nUser IDs passed through the `users` relationship field are added to the team.", + "operationId": "CreateTeam", + "requestBody": { + "content": { + "application/json": { + "schema": { + "description": "Request to create a team", + "properties": { + "data": { + "description": "Team create", + "properties": { + "attributes": { + "description": "Team creation attributes", + "properties": { + "avatar": { + "description": "Unicode representation of the avatar for the team, limited to a single grapheme", + "example": "🥑", + "nullable": true, + "type": "string" + }, + "banner": { + "description": "Banner selection for the team", + "format": "int64", + "nullable": true, + "type": "integer" + }, + "description": { + "description": "Free-form markdown description/content for the team's homepage", + "type": "string" + }, + "handle": { + "description": "The team's identifier", + "example": "example-team", + "maxLength": 195, + "type": "string" + }, + "hidden_modules": { + "description": "Collection of hidden modules for the team", + "items": { + "description": "String identifier of the module", + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "The name of the team", + "example": "Example Team", + "maxLength": 200, + "type": "string" + }, + "visible_modules": { + "description": "Collection of visible modules for the team", + "items": { + "description": "String identifier of the module", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "handle", + "name" + ], + "type": "object" + }, + "relationships": { + "description": "Relationships formed with the team on creation", + "properties": { + "users": { + "description": "Relationship to users.", + "properties": { + "data": { + "description": "Relationships to user objects.", + "example": [], + "items": { + "description": "Relationship to user object.", + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-2345-000000000000", + "type": "string" + }, + "type": { + "default": "users", + "description": "Users resource type.", + "enum": [ + "users" + ], + "example": "users", + "type": "string", + "x-enum-varnames": [ + "USERS" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "default": "team", + "description": "Team type", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "attributes", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "description": "Response with a team", + "properties": { + "data": { + "description": "A team", + "properties": { + "attributes": { + "description": "Team attributes", + "properties": { + "avatar": { + "description": "Unicode representation of the avatar for the team, limited to a single grapheme", + "example": "🥑", + "nullable": true, + "type": "string" + }, + "banner": { + "description": "Banner selection for the team", + "format": "int64", + "nullable": true, + "type": "integer" + }, + "created_at": { + "description": "Creation date of the team", + "format": "date-time", + "type": "string" + }, + "description": { + "description": "Free-form markdown description/content for the team's homepage", + "nullable": true, + "type": "string" + }, + "handle": { + "description": "The team's identifier", + "example": "example-team", + "maxLength": 195, + "type": "string" + }, + "hidden_modules": { + "description": "Collection of hidden modules for the team", + "items": { + "description": "String identifier of the module", + "type": "string" + }, + "type": "array" + }, + "link_count": { + "description": "The number of links belonging to the team", + "format": "int32", + "maximum": 2147483647, + "readOnly": true, + "type": "integer" + }, + "modified_at": { + "description": "Modification date of the team", + "format": "date-time", + "type": "string" + }, + "name": { + "description": "The name of the team", + "example": "Example Team", + "maxLength": 200, + "type": "string" + }, + "summary": { + "description": "A brief summary of the team, derived from the `description`", + "maxLength": 120, + "nullable": true, + "type": "string" + }, + "user_count": { + "description": "The number of users belonging to the team", + "format": "int32", + "maximum": 2147483647, + "readOnly": true, + "type": "integer" + }, + "visible_modules": { + "description": "Collection of visible modules for the team", + "items": { + "description": "String identifier of the module", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "handle", + "name" + ], + "type": "object" + }, + "id": { + "description": "The team's identifier", + "example": "aeadc05e-98a8-11ec-ac2c-da7ad0900001", + "type": "string" + }, + "relationships": { + "description": "Resources related to a team", + "properties": { + "team_links": { + "description": "Relationship between a team and a team link", + "properties": { + "data": { + "description": "Related team links", + "items": { + "description": "Relationship between a link and a team", + "properties": { + "id": { + "description": "The team link's identifier", + "example": "f9bb8444-af7f-11ec-ac2c-da7ad0900001", + "type": "string" + }, + "type": { + "default": "team_links", + "description": "Team link type", + "enum": [ + "team_links" + ], + "example": "team_links", + "type": "string", + "x-enum-varnames": [ + "TEAM_LINKS" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "type": "array" + }, + "links": { + "description": "Links attributes.", + "properties": { + "related": { + "description": "Related link.", + "example": "/api/v2/team/c75a4a8e-20c7-11ee-a3a5-da7ad0900002/links", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "user_team_permissions": { + "description": "Relationship between a user team permission and a team", + "properties": { + "data": { + "description": "Related user team permission data", + "properties": { + "id": { + "description": "The ID of the user team permission", + "example": "UserTeamPermissions-aeadc05e-98a8-11ec-ac2c-da7ad0900001-416595", + "type": "string" + }, + "type": { + "default": "user_team_permissions", + "description": "User team permission type", + "enum": [ + "user_team_permissions" + ], + "example": "user_team_permissions", + "type": "string", + "x-enum-varnames": [ + "USER_TEAM_PERMISSIONS" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "links": { + "description": "Links attributes.", + "properties": { + "related": { + "description": "Related link.", + "example": "/api/v2/team/c75a4a8e-20c7-11ee-a3a5-da7ad0900002/links", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": { + "default": "team", + "description": "Team type", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "CREATED" + }, + "403": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Forbidden" + }, + "409": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "API error response." + }, + "429": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Too many requests" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [ + "teams_read", + "teams_manage" + ] + } + ], + "summary": "Create a team", + "tags": [ + "Teams" + ], + "x-codegen-request-body-name": "body", + "x-menu-order": 2, + "x-permission": { + "operator": "AND", + "permissions": [ + "teams_read", + "teams_manage" + ] + } + } + }, + "/api/v2/team/connections": { + "delete": { + "description": "Delete multiple team connections.", + "operationId": "DeleteTeamConnections", + "requestBody": { + "content": { + "application/json": { + "schema": { + "description": "Request for deleting team connections.", + "properties": { + "data": { + "description": "Array of team connection IDs to delete.", + "items": { + "description": "A collection of connection ids to delete.", + "properties": { + "id": { + "description": "The unique identifier of the team connection to delete.", + "example": "12345678-1234-5678-9abc-123456789012", + "type": "string" + }, + "type": { + "default": "team_connection", + "description": "Team connection resource type.", + "enum": [ + "team_connection" + ], + "example": "team_connection", + "type": "string", + "x-enum-varnames": [ + "TEAM_CONNECTION" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "No Content" + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Bad Request" + }, + "403": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Not Found" + }, + "429": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Too many requests" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [ + "teams_read" + ] + } + ], + "summary": "Delete team connections", + "tags": [ + "Team Connections" + ], + "x-menu-order": 3, + "x-permission": { + "operator": "OR", + "permissions": [ + "teams_read" + ] + }, + "x-unstable": "**Note**: This endpoint is in Preview. To request access, fill out this [form](https://www.datadoghq.com/product-preview/github-integration-for-teams/).\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." + }, + "get": { + "description": "Returns all team connections.", + "operationId": "ListTeamConnections", + "parameters": [ + { + "description": "Size for a given page. The maximum allowed value is 100.", + "in": "query", + "name": "page[size]", + "required": false, + "schema": { + "default": 10, + "example": 10, + "format": "int64", + "type": "integer" + } + }, + { + "description": "Specific page number to return.", + "in": "query", + "name": "page[number]", + "required": false, + "schema": { + "default": 0, + "example": 0, + "format": "int64", + "type": "integer" + } + }, + { + "description": "Filter team connections by external source systems.", + "explode": false, + "in": "query", + "name": "filter[sources]", + "required": false, + "schema": { + "items": { + "example": "github", + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "description": "Filter team connections by Datadog team IDs.", + "explode": false, + "in": "query", + "name": "filter[team_ids]", + "required": false, + "schema": { + "items": { + "example": "12345678-1234-5678-9abc-123456789012", + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "description": "Filter team connections by connected team IDs from external systems.", + "explode": false, + "in": "query", + "name": "filter[connected_team_ids]", + "required": false, + "schema": { + "items": { + "example": "@MyGitHubAccount/my-team-name", + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "description": "Filter team connections by connection IDs.", + "explode": false, + "in": "query", + "name": "filter[connection_ids]", + "required": false, + "schema": { + "items": { + "example": "12345678-1234-5678-9abc-123456789012", + "type": "string" + }, + "type": "array" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "Response containing information about multiple team connections.", + "properties": { + "data": { + "description": "Array of team connections.", + "items": { + "description": "A relationship between a Datadog team and a team from another external system.", + "properties": { + "attributes": { + "description": "Attributes of the team connection.", + "properties": { + "managed_by": { + "description": "The entity that manages this team connection.", + "example": "github_sync", + "type": "string" + }, + "source": { + "description": "The name of the external source.", + "example": "github", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "The unique identifier of the team connection.", + "example": "12345678-1234-5678-9abc-123456789012", + "type": "string" + }, + "relationships": { + "description": "Relationships of the team connection.", + "properties": { + "connected_team": { + "description": "Reference to a team from an external system.", + "properties": { + "data": { + "description": "Reference to connected external team.", + "properties": { + "id": { + "description": "The connected team ID as it is referenced throughout the Datadog ecosystem.", + "example": "@GitHubOrg/team-handle", + "type": "string" + }, + "type": { + "default": "github_team", + "description": "External team resource type.", + "enum": [ + "github_team" + ], + "example": "github_team", + "type": "string", + "x-enum-varnames": [ + "GITHUB_TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + }, + "team": { + "description": "Reference to a Datadog team.", + "properties": { + "data": { + "description": "Reference to a Datadog team.", + "properties": { + "id": { + "description": "The Datadog team ID.", + "example": "87654321-4321-8765-dcba-210987654321", + "type": "string" + }, + "type": { + "default": "team", + "description": "Datadog team resource type.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": { + "default": "team_connection", + "description": "Team connection resource type.", + "enum": [ + "team_connection" + ], + "example": "team_connection", + "type": "string", + "x-enum-varnames": [ + "TEAM_CONNECTION" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "type": "array" + }, + "meta": { + "description": "Connections response metadata.", + "properties": { + "page": { + "description": "Page-based pagination metadata.", + "properties": { + "first_number": { + "description": "The first page number.", + "format": "int64", + "type": "integer" + }, + "last_number": { + "description": "The last page number.", + "format": "int64", + "type": "integer" + }, + "next_number": { + "description": "The next page number.", + "format": "int64", + "nullable": true, + "type": "integer" + }, + "number": { + "description": "The current page number.", + "format": "int64", + "type": "integer" + }, + "prev_number": { + "description": "The previous page number.", + "format": "int64", + "nullable": true, + "type": "integer" + }, + "size": { + "description": "The page size.", + "format": "int64", + "type": "integer" + }, + "total": { + "description": "Total connections matching request.", + "format": "int64", + "type": "integer" + }, + "type": { + "description": "Pagination type.", + "example": "number_size", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Bad Request" + }, + "403": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Forbidden" + }, + "429": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Too many requests" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [ + "teams_read" + ] + } + ], + "summary": "List team connections", + "tags": [ + "Team Connections" + ], + "x-menu-order": 1, + "x-pagination": { + "limitParam": "page[size]", + "pageParam": "page[number]", + "resultsPath": "data" + }, + "x-permission": { + "operator": "OR", + "permissions": [ + "teams_read" + ] + }, + "x-unstable": "**Note**: This endpoint is in Preview. To request access, fill out this [form](https://www.datadoghq.com/product-preview/github-integration-for-teams/).\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." + }, + "post": { + "description": "Create multiple team connections.", + "operationId": "CreateTeamConnections", + "requestBody": { + "content": { + "application/json": { + "schema": { + "description": "Request for creating team connections.", + "properties": { + "data": { + "description": "Array of team connections to create.", + "items": { + "description": "Data for creating a team connection.", + "properties": { + "attributes": { + "description": "Attributes of the team connection.", + "properties": { + "managed_by": { + "description": "The entity that manages this team connection.", + "example": "github_sync", + "type": "string" + }, + "source": { + "description": "The name of the external source.", + "example": "github", + "type": "string" + } + }, + "type": "object" + }, + "relationships": { + "description": "Relationships of the team connection.", + "properties": { + "connected_team": { + "description": "Reference to a team from an external system.", + "properties": { + "data": { + "description": "Reference to connected external team.", + "properties": { + "id": { + "description": "The connected team ID as it is referenced throughout the Datadog ecosystem.", + "example": "@GitHubOrg/team-handle", + "type": "string" + }, + "type": { + "default": "github_team", + "description": "External team resource type.", + "enum": [ + "github_team" + ], + "example": "github_team", + "type": "string", + "x-enum-varnames": [ + "GITHUB_TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + }, + "team": { + "description": "Reference to a Datadog team.", + "properties": { + "data": { + "description": "Reference to a Datadog team.", + "properties": { + "id": { + "description": "The Datadog team ID.", + "example": "87654321-4321-8765-dcba-210987654321", + "type": "string" + }, + "type": { + "default": "team", + "description": "Datadog team resource type.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": { + "default": "team_connection", + "description": "Team connection resource type.", + "enum": [ + "team_connection" + ], + "example": "team_connection", + "type": "string", + "x-enum-varnames": [ + "TEAM_CONNECTION" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "description": "Response containing information about multiple team connections.", + "properties": { + "data": { + "description": "Array of team connections.", + "items": { + "description": "A relationship between a Datadog team and a team from another external system.", + "properties": { + "attributes": { + "description": "Attributes of the team connection.", + "properties": { + "managed_by": { + "description": "The entity that manages this team connection.", + "example": "github_sync", + "type": "string" + }, + "source": { + "description": "The name of the external source.", + "example": "github", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "The unique identifier of the team connection.", + "example": "12345678-1234-5678-9abc-123456789012", + "type": "string" + }, + "relationships": { + "description": "Relationships of the team connection.", + "properties": { + "connected_team": { + "description": "Reference to a team from an external system.", + "properties": { + "data": { + "description": "Reference to connected external team.", + "properties": { + "id": { + "description": "The connected team ID as it is referenced throughout the Datadog ecosystem.", + "example": "@GitHubOrg/team-handle", + "type": "string" + }, + "type": { + "default": "github_team", + "description": "External team resource type.", + "enum": [ + "github_team" + ], + "example": "github_team", + "type": "string", + "x-enum-varnames": [ + "GITHUB_TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + }, + "team": { + "description": "Reference to a Datadog team.", + "properties": { + "data": { + "description": "Reference to a Datadog team.", + "properties": { + "id": { + "description": "The Datadog team ID.", + "example": "87654321-4321-8765-dcba-210987654321", + "type": "string" + }, + "type": { + "default": "team", + "description": "Datadog team resource type.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": { + "default": "team_connection", + "description": "Team connection resource type.", + "enum": [ + "team_connection" + ], + "example": "team_connection", + "type": "string", + "x-enum-varnames": [ + "TEAM_CONNECTION" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "type": "array" + }, + "meta": { + "description": "Connections response metadata.", + "properties": { + "page": { + "description": "Page-based pagination metadata.", + "properties": { + "first_number": { + "description": "The first page number.", + "format": "int64", + "type": "integer" + }, + "last_number": { + "description": "The last page number.", + "format": "int64", + "type": "integer" + }, + "next_number": { + "description": "The next page number.", + "format": "int64", + "nullable": true, + "type": "integer" + }, + "number": { + "description": "The current page number.", + "format": "int64", + "type": "integer" + }, + "prev_number": { + "description": "The previous page number.", + "format": "int64", + "nullable": true, + "type": "integer" + }, + "size": { + "description": "The page size.", + "format": "int64", + "type": "integer" + }, + "total": { + "description": "Total connections matching request.", + "format": "int64", + "type": "integer" + }, + "type": { + "description": "Pagination type.", + "example": "number_size", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "Created" + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Bad Request" }, "403": { "content": { @@ -722046,7 +724966,7 @@ } } }, - "description": "API error response." + "description": "Conflict" }, "429": { "content": { @@ -722084,24 +725004,22 @@ }, { "AuthZ": [ - "teams_read", - "teams_manage" + "teams_read" ] } ], - "summary": "Create a team", + "summary": "Create team connections", "tags": [ - "Teams" + "Team Connections" ], - "x-codegen-request-body-name": "body", "x-menu-order": 2, "x-permission": { - "operator": "AND", + "operator": "OR", "permissions": [ - "teams_read", - "teams_manage" + "teams_read" ] - } + }, + "x-unstable": "**Note**: This endpoint is in Preview. To request access, fill out this [form](https://www.datadoghq.com/product-preview/github-integration-for-teams/).\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." } }, "/api/v2/team/sync": { @@ -722642,6 +725560,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -725861,6 +728786,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -726817,6 +729749,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -727786,6 +730725,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -729110,6 +732056,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -729831,6 +732784,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -730606,6 +733566,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -731312,6 +734279,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -735087,6 +738061,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -735806,6 +738787,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -736539,6 +739527,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -737203,6 +740198,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -737864,6 +740866,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -738810,6 +741819,13 @@ "description": "URL of the user's icon.", "type": "string" }, + "last_login_time": { + "description": "The last time the user logged in.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, "mfa_enabled": { "description": "If user has MFA enabled.", "readOnly": true, @@ -748146,6 +751162,10 @@ "description": "Datadog Synthetics uses simulated user requests and browser rendering to help you ensure uptime,\nidentify regional issues, and track your application performance. Datadog Synthetics tests come in\ntwo different flavors, [API tests](https://docs.datadoghq.com/synthetics/api_tests/)\nand [browser tests](https://docs.datadoghq.com/synthetics/browser_tests). You can use Datadog’s API to\nmanage both test types programmatically.\n\nFor more information about Synthetics, see the [Synthetics overview](https://docs.datadoghq.com/synthetics/).", "name": "Synthetics" }, + { + "description": "View and manage relationships between Datadog teams and teams from external sources, such as GitHub.", + "name": "Team Connections" + }, { "description": "View and manage teams within Datadog. See the [Teams page](https://docs.datadoghq.com/account_management/teams/) for more information.", "name": "Teams"