Datadog API
Tools that enable LLMs to interact directly with the Datadog API.
2.0.0The Arcade toolkit for DatadogApi empowers developers to interact seamlessly with the Datadog API to manage monitoring, analytics, and incident responses. This toolkit enhances the ability to automate workflows, streamline operations, and effectively manage cloud resources.
Capabilities:
- Efficiently manage Datadog integrations, monitor resources, and handle alerts.
- Automate operational workflows, including on-call management and incident response.
- Support configuration management for AWS, Azure, and GCP services.
- Streamline security monitoring and logging capabilities.
- Facilitate role and permissions management across teams.
Secrets:
- Configuration includes various secrets like
DATADOG_API_KEY,DATADOG_APPLICATION_KEY, and others essential for API access.
Available tools(588)
| Tool name | Description | Secrets | |
|---|---|---|---|
Acknowledge an On-Call Page alert in Datadog.
Use this tool to acknowledge an On-Call Page alert for a specified page in Datadog. This can be used to indicate that an alert is being addressed. | 2 | ||
Activate Agentless scan options for an AWS account. | 2 | ||
Activate Agentless scan options for Azure subscriptions.
Use this tool to activate Agentless scan options for a specified Azure subscription. This is useful for enabling security scans without deploying agents. | 3 | ||
Activate Agentless scan options for a GCP project.
Use this tool to enable Agentless scanning for a Google Cloud Platform project. This is useful for setting up security scans without deploying agents. | 3 | ||
Add a comment to a specific case in Datadog.
Use this tool to post a comment to a particular case within the Datadog system by providing the case ID. | 3 | ||
Add dashboards to an existing list in Datadog.
Use this tool to append dashboards to a specified existing dashboard list in Datadog. Ideal for organizing and managing dashboards effectively.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| 3 | ||
Add a member team to a super team.
Use this tool to add a specified team as a member of an existing super team by providing the super team's ID. | 2 | ||
Assigns a specific permission to a given role.
Use this tool to add a permission to a specific role within Datadog. It should be called when you need to assign new permissions to a role to adjust user access and capabilities. | 2 | ||
Adds a read role to a specified archive.
Use this tool to grant read access to a specific archive by adding a read role. Ideal for managing permissions and ensuring the right users or groups have access to log data archives. | 2 | ||
Adds a role to a restriction query for logs configuration.
This tool is used to add a specific role to an existing restriction query in Datadog's logs configuration. Call this tool when you need to update restriction queries by including additional roles. | 3 | ||
Add a new link to a Datadog team.
Use this tool to add a new link to a specific team's page in Datadog. Suitable for enhancing team resources or documentation by linking additional references. | 2 | ||
Adds a user to a specific role in Datadog.
Use this tool to add a user to a specific role in Datadog's system. It is called when you need to assign user permissions via roles. | 3 | ||
Add a user to a team in Datadog.
Use this tool to add a specified user to an existing team within Datadog by providing the team ID. | 3 | ||
Aggregate logs to compute metrics and timeseries.
This tool aggregates log events into buckets to compute relevant metrics and timeseries. It's useful for analyzing large volumes of log data to extract meaningful insights.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | 3 | ||
Aggregate CI pipeline event metrics and timeseries.
This tool aggregates CI Visibility pipeline events into buckets of computed metrics and timeseries. Use it when you need to analyze CI pipeline performances and trends.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | 3 | ||
Aggregate RUM events into computed metrics and timeseries.
This tool aggregates Real User Monitoring (RUM) events into buckets of computed metrics and timeseries. It is used when there is a need to analyze and visualize RUM data effectively.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | 3 | ||
Aggregate spans to compute metrics and timeseries.
Use this tool to aggregate spans into buckets and compute metrics and timeseries data. This is useful for analyzing performance and trends in systems. Note: Limited to 300 requests per hour.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | 3 | ||
Aggregate CI Visibility test events into metrics and timeseries.
Use this tool to aggregate CI test events into buckets for computed metrics and timeseries insights.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | 3 | ||
Archive an Azure Cloud Cost Management account in Datadog.
Use this tool to archive a Cloud Cost Management account associated with Azure in Datadog. This action is irreversible and should be performed when you need to remove cost management configurations for a specific Azure account. | 2 | ||
Archive a specific case in Datadog.
This tool is used to archive a case in Datadog by specifying the case ID. Call this tool when you need to move a case to the archive for record-keeping or compliance. | 2 | ||
Archive a Cloud Cost Management Account.
Use this tool to archive a Cloud Cost Management Account in Datadog, specifically for AWS CUR configurations. Useful for managing or removing outdated or unnecessary cost configurations. | 2 | ||
Archive a Cloud Cost Management account.
Use this tool to archive a Google Cloud Platform (GCP) cost management account in Datadog. | 3 | ||
Assign a case to a specific user.
Use this tool to assign a case to a specific user by providing the case ID. It should be called when you need to allocate a case to an appropriate team member or user. | 2 | ||
Delete multiple items from a datastore at once.
Use this tool to delete multiple items from a specified datastore by their keys in a single operation. It's ideal for efficiently removing batches of entries when managing datastore contents. | 3 | ||
Perform bulk creation or replacement of datastore items.
Use this tool to create or replace multiple items in a Datadog datastore in a single operation by specifying their keys.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| 2 |
Selected tools
No tools selected.
Click "Show all tools" to add tools.
Requirements
Select tools to see requirements
DatadogApi.AcknowledgeOnCallPage
Acknowledge an On-Call Page alert in Datadog. Use this tool to acknowledge an On-Call Page alert for a specified page in Datadog. This can be used to indicate that an alert is being addressed.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
on_call_page_id | string | Required | The unique identifier for the On-Call Page to acknowledge. |
Requirements
Output
json— Response from the API endpoint 'AcknowledgeOnCallPage'.DatadogApi.ActivateAwsScanOptions
Activate Agentless scan options for an AWS account.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
aws_account_id | string | Required | The ID of the AWS account for which to activate scan options. |
enable_container_vulnerability_scanning | boolean | Required | Enable scanning for vulnerabilities in containers when set to true. |
enable_lambda_function_scanning | boolean | Required | Enable scanning of Lambda functions. Set to true to enable, false to disable. |
enable_sensitive_data_scanning | boolean | Required | Indicates if scanning for sensitive data is enabled for the AWS account. |
enable_vulnerability_scan_host_os | boolean | Required | Indicates if scanning for vulnerabilities in host operating systems is enabled. |
resource_type | string | Optional | Specifies the resource type to activate. Must be 'aws_scan_options'. |
Requirements
Output
json— Response from the API endpoint 'CreateAwsScanOptions'.DatadogApi.ActivateAzureScanOptions
Activate Agentless scan options for Azure subscriptions. Use this tool to activate Agentless scan options for a specified Azure subscription. This is useful for enabling security scans without deploying agents.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
azure_subscription_id | string | Optional | The Azure subscription ID for which to activate the scan options. |
enable_container_vulnerability_scan | boolean | Optional | Set to true to activate scanning for vulnerabilities in containers. |
enable_vulnerability_scan_hosts | boolean | Optional | Indicate if scanning for vulnerabilities in Azure hosts is enabled. Set to true to activate. |
resource_type | string | Optional | Specifies the resource type. Always use 'azure_scan_options'. |
Requirements
Output
json— Response from the API endpoint 'CreateAzureScanOptions'.DatadogApi.ActivateGcpScanOptions
Activate Agentless scan options for a GCP project. Use this tool to enable Agentless scanning for a Google Cloud Platform project. This is useful for setting up security scans without deploying agents.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
enable_container_vulnerability_scanning | boolean | Optional | Set to true to enable scanning for vulnerabilities in containers. |
enable_vulnerability_host_scanning | boolean | Optional | Set to true to enable scanning for vulnerabilities in hosts in the GCP project. |
gcp_project_id | string | Optional | The Google Cloud Platform project ID for which to activate the scan options. |
gcp_scan_resource_type | string | Optional | The type of GCP scan options resource. This is typically 'gcp_scan_options'. |
Requirements
Output
json— Response from the API endpoint 'CreateGcpScanOptions'.DatadogApi.AddCommentToCase
Add a comment to a specific case in Datadog. Use this tool to post a comment to a particular case within the Datadog system by providing the case ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
case_identifier | string | Required | The unique identifier (UUID or key) for the case to which the comment will be added. |
comment_message | string | Required | The message content to be added as a comment on the case. |
case_resource_type | string | Optional | Specify the type of resource, always set to 'case'. |
Requirements
Output
json— Response from the API endpoint 'CommentCase'.DatadogApi.AddDashboardsToList
Add dashboards to an existing list in Datadog. Use this tool to append dashboards to a specified existing dashboard list in Datadog. Ideal for organizing and managing dashboards effectively. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
dashboard_list_identifier | integer | Optional | Specify the integer ID of the dashboard list where dashboards will be added. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'CreateDashboardListItems'.DatadogApi.AddMemberTeamToSuperTeam
Add a member team to a super team. Use this tool to add a specified team as a member of an existing super team by providing the super team's ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
member_team_identifier | string | Required | The unique identifier of the member team to be added to the super team. |
super_team_identifier | string | Required | The ID of the super team to which the member team will be added. It is a string value. |
member_team_type | string | Optional | Specifies the type of member team to be added. Must be 'member_teams'. |
Requirements
Output
json— Response from the API endpoint 'AddMemberTeam'.DatadogApi.AddPermissionToRole
Assigns a specific permission to a given role. Use this tool to add a permission to a specific role within Datadog. It should be called when you need to assign new permissions to a role to adjust user access and capabilities.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
role_identifier | string | Required | The unique identifier of the role to which the permission will be added. |
permission_id | string | Optional | ID of the permission to be added to the role. |
permissions_resource_type | string | Optional | The resource type for the permission, should be 'permissions'. |
Requirements
Output
json— Response from the API endpoint 'AddPermissionToRole'.DatadogApi.AddReadRoleToArchive
Adds a read role to a specified archive. Use this tool to grant read access to a specific archive by adding a read role. Ideal for managing permissions and ensuring the right users or groups have access to log data archives.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
archive_id | string | Required | The unique identifier for the archive to which a read role will be added. This is required to specify the target archive for access management. |
role_type | string | Optional | The type of role to be added. Must be 'roles'. |
role_unique_identifier | string | Optional | The unique identifier for the role to be added to the archive. |
Requirements
Output
json— Response from the API endpoint 'AddReadRoleToArchive'.DatadogApi.AddRoleToRestrictionQuery
Adds a role to a restriction query for logs configuration. This tool is used to add a specific role to an existing restriction query in Datadog's logs configuration. Call this tool when you need to update restriction queries by including additional roles.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
restriction_query_id | string | Required | The ID of the restriction query to which a role will be added. |
role_type | string | Optional | The type of the role, expected to be 'roles'. |
role_unique_identifier | string | Optional | The unique identifier of the role to be added to the restriction query. |
Requirements
Output
json— Response from the API endpoint 'AddRoleToRestrictionQuery'.DatadogApi.AddTeamLink
Add a new link to a Datadog team. Use this tool to add a new link to a specific team's page in Datadog. Suitable for enhancing team resources or documentation by linking additional references.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
link_label | string | Required | The label for the link to be added to the team. This should be a descriptive text for the link. |
link_url | string | Required | The URL to be added as a link for the team. This should be a valid web address. |
target_team_id | string | Required | The unique identifier for the team to which the link will be added. |
link_position | integer | Optional | The position of the link in the team's list, used for sorting links. |
team_id_for_link | string | Optional | ID of the team the link is associated with. This should be a unique identifier for the specific team to which you want to add the link. |
team_link_type | string | Optional | Specify the type of team link. Must be 'team_links'. |
Requirements
Output
json— Response from the API endpoint 'CreateTeamLink'.DatadogApi.AddUserToRole
Adds a user to a specific role in Datadog. Use this tool to add a user to a specific role in Datadog's system. It is called when you need to assign user permissions via roles.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
role_unique_identifier | string | Required | The unique identifier for the role you want to assign the user to. |
user_unique_identifier | string | Required | A unique identifier representing the user to be added to the role. |
users_resource_type | string | Optional | Specifies the type of resource as 'users'. Always use 'users'. |
Requirements
Output
json— Response from the API endpoint 'AddUserToRole'.DatadogApi.AddUserToTeam
Add a user to a team in Datadog. Use this tool to add a specified user to an existing team within Datadog by providing the team ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
team_id | string | Required | The ID of the team to which the user will be added. This is required to specify the target team. |
provisioned_user_or_service_account_id | string | Optional | UUID of the User or Service Account who provisioned the team membership, or null if done via SAML mapping. |
provisioning_mechanism | string | Optional | Mechanism responsible for provisioning the team relationship. Possible values: null for user-added, "service_account" for service account, "saml_mapping" for SAML mapping. |
team_identifier | string | Optional | The unique ID of the team to which the user will be added. |
team_membership_type | string | Optional | Specify the type of team membership. Use 'team_memberships'. |
user_id | string | Optional | The ID of the user to be added to the team in Datadog. |
user_role_in_team | string | Optional | Specifies the user's role within the team. Currently, only 'admin' is supported as a role. |
user_team_type | string | Optional | Specifies the type for the team relationship, fixed as 'team'. |
user_team_user_type | string | Optional | Set to 'users' as the type for the user in the team. |
Requirements
Output
json— Response from the API endpoint 'CreateTeamMembership'.DatadogApi.AggregateLogs
Aggregate logs to compute metrics and timeseries. This tool aggregates log events into buckets to compute relevant metrics and timeseries. It's useful for analyzing large volumes of log data to extract meaningful insights. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'AggregateLogs'.DatadogApi.AggregatePipelineEvents
Aggregate CI pipeline event metrics and timeseries. This tool aggregates CI Visibility pipeline events into buckets of computed metrics and timeseries. Use it when you need to analyze CI pipeline performances and trends. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'AggregateCIAppPipelineEvents'.DatadogApi.AggregateRumEvents
Aggregate RUM events into computed metrics and timeseries. This tool aggregates Real User Monitoring (RUM) events into buckets of computed metrics and timeseries. It is used when there is a need to analyze and visualize RUM data effectively. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'AggregateRUMEvents'.DatadogApi.AggregateSpansMetrics
Aggregate spans to compute metrics and timeseries. Use this tool to aggregate spans into buckets and compute metrics and timeseries data. This is useful for analyzing performance and trends in systems. Note: Limited to 300 requests per hour. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'AggregateSpans'.DatadogApi.AggregateTestMetrics
Aggregate CI Visibility test events into metrics and timeseries. Use this tool to aggregate CI test events into buckets for computed metrics and timeseries insights. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'AggregateCIAppTestEvents'.DatadogApi.ArchiveAzureCostAccount
Archive an Azure Cloud Cost Management account in Datadog. Use this tool to archive a Cloud Cost Management account associated with Azure in Datadog. This action is irreversible and should be performed when you need to remove cost management configurations for a specific Azure account.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
azure_cloud_account_id | integer | Required | The ID of the Azure Cloud Cost Management account to archive. This is necessary to identify which account's configurations will be removed. |
Requirements
Output
json— Response from the API endpoint 'DeleteCostAzureUCConfig'.DatadogApi.ArchiveCase
Archive a specific case in Datadog. This tool is used to archive a case in Datadog by specifying the case ID. Call this tool when you need to move a case to the archive for record-keeping or compliance.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
case_unique_id | string | Required | The unique identifier or key of the case to be archived in Datadog. |
case_resource_type | string | Optional | Specify 'case' as the resource type to identify the case resource. |
Requirements
Output
json— Response from the API endpoint 'ArchiveCase'.DatadogApi.ArchiveCloudCostAccount
Archive a Cloud Cost Management Account. Use this tool to archive a Cloud Cost Management Account in Datadog, specifically for AWS CUR configurations. Useful for managing or removing outdated or unnecessary cost configurations.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
cloud_account_id | integer | Required | The unique identifier for the Cloud Account to be archived in Datadog. |
Requirements
Output
json— Response from the API endpoint 'DeleteCostAWSCURConfig'.DatadogApi.ArchiveGcpCostManagementAccount
Archive a Cloud Cost Management account. Use this tool to archive a Google Cloud Platform (GCP) cost management account in Datadog.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
cloud_account_identifier | integer | Required | The unique identifier for the GCP cloud account to be archived. |
Requirements
Output
json— Response from the API endpoint 'DeleteCostGCPUsageCostConfig'.DatadogApi.AssignCaseToUser
Assign a case to a specific user. Use this tool to assign a case to a specific user by providing the case ID. It should be called when you need to allocate a case to an appropriate team member or user.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
assignee_user_id | string | Required | The UUID of the user to whom the case will be assigned. |
case_id | string | Required | The unique identifier (UUID or key) of the case to be assigned. |
case_resource_type | string | Optional | Specify the resource type. Must be set to 'case'. |
Requirements
Output
json— Response from the API endpoint 'AssignCase'.DatadogApi.BulkDeleteDatastoreItems
Delete multiple items from a datastore at once. Use this tool to delete multiple items from a specified datastore by their keys in a single operation. It's ideal for efficiently removing batches of entries when managing datastore contents.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
datastore_identifier | string | Required | The unique ID of the datastore from which items will be deleted. |
datastore_items_id | string | Optional | ID for the datastore of items you want to delete. |
item_keys_to_delete | array<string> | Optional | List of up to 100 primary keys identifying items to delete from the datastore. |
items_resource_type | string | Optional | Specifies the resource type of the items. Must be 'items'. |
Requirements
Output
json— Response from the API endpoint 'BulkDeleteDatastoreItems'.DatadogApi.BulkUpdateDatastoreItems
Perform bulk creation or replacement of datastore items. Use this tool to create or replace multiple items in a Datadog datastore in a single operation by specifying their keys. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
datastore_identifier | string | Optional | The unique identifier for the datastore where items will be updated or replaced. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'BulkWriteDatastoreItems'.DatadogApi.CancelDowntime
Cancel an active downtime in Datadog. Use this tool to cancel an active downtime in Datadog. The downtime remains visible for about two days in search results until it is permanently removed.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
downtime_id | string | Required | Provide the ID of the downtime you wish to cancel. |
Requirements
Output
json— Response from the API endpoint 'CancelDowntime'.DatadogApi.CancelHistoricalJob
Cancel a historical job in Datadog. Use this tool to cancel an ongoing historical job in Datadog, identified by its job ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
job_id | string | Required | The unique identifier of the historical job to be canceled in Datadog. |
Requirements
Output
json— Response from the API endpoint 'CancelHistoricalJob'.DatadogApi.CancelWorkflowInstance
Cancel a specific execution of a workflow. Use this tool to cancel a specific execution of a given workflow in Datadog. Ensure you have the necessary application key or permissions configured to perform this action.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
workflow_id | string | Required | The unique ID of the workflow to cancel. It must be a valid string as per the API specifications. |
workflow_instance_id | string | Required | The unique identifier of the workflow instance to be canceled. |
Requirements
Output
json— Response from the API endpoint 'CancelWorkflowInstance'.DatadogApi.ChangeSignalState
Change the triage state of a security signal. This tool is used to modify the triage state of a specific security signal in Datadog's security monitoring system. It is useful for managing signal priorities and responses.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
new_triage_state | string | Required | The new triage state of the signal. Valid options are 'open', 'archived', or 'under_review'. |
signal_id | string | Required | The unique identifier of the security signal to be updated. |
archive_comment | string | Optional | Optional comment to display on archived signals. Useful for context or documentation. |
archive_reason | string | Optional | Reason for archiving the signal. Options include 'none', 'false_positive', 'testing_or_maintenance', 'investigated_case_opened', or 'other'. |
event_type | string | Optional | The type of event, must be 'signal_metadata'. |
security_signal_unique_id | string | Optional | The unique identifier for the security signal to be modified. |
updated_signal_version | integer | Optional | The version number of the signal to update. The update is rejected if the server's version is higher. |
Requirements
Output
json— Response from the API endpoint 'EditSecurityMonitoringSignalState'.DatadogApi.CloneExistingRole
Clone an existing role based on role ID. This tool allows cloning of an existing role by using its unique role ID. It should be called when you need to create a duplicate of an existing role with identical permissions.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
new_role_name | string | Required | Name of the new role that is cloned from an existing role. |
role_unique_identifier | string | Required | The unique identifier of the role to be cloned. |
role_type | string | Optional | Specifies the type of role for the clone operation. Must be 'roles'. |
Requirements
Output
json— Response from the API endpoint 'CloneRole'.DatadogApi.ConfigureBulkTagsForMetrics
Configure bulk tags for specified metrics in Datadog. Use this tool to create and define queryable tag keys for existing count, gauge, rate, and distribution metrics in Datadog by specifying a metric name prefix. It manages tags configurations and sends results to account email addresses. Suitable for users with 'Manage Tags for Metrics' permission.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
metric_name_prefix | string | Required | A text prefix used to match against metric names for bulk tags configuration. |
actively_queried_tags_window_seconds | number | Optional | Time window in seconds for configuring actively queried tags for matching metrics. Minimum is 1 second, maximum is 7,776,000 seconds (90 days). |
exclude_configured_tags | boolean | Optional | Set to true to exclude configured tags and include all other tags. Defaults to false. |
metric_bulk_configure_tags_resource | string | Optional | The resource identifier for configuring bulk tags for metrics. Must be set to 'metric_bulk_configure_tags'. |
notification_emails | array<string> | Optional | A list of account emails to notify when the configuration is applied. |
override_existing_configurations | boolean | Optional | Set to true to override any existing configurations for the metric with the new tags. Defaults to true. |
tags_to_apply | array<string> | Optional | A list of tag names to apply to the metric configuration in Datadog. |
Requirements
Output
json— Response from the API endpoint 'CreateBulkTagsMetricsConfiguration'.DatadogApi.ConvertJobResultToSignal
Convert a job result to a signal for detection purposes. Use this tool to transform a job result into a signal, useful for detection and monitoring in Datadog.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
job_result_ids | array<string> | Optional | Array of job result IDs to convert into signals. |
notifications_sent | array<string> | Optional | List of notification types sent related to the signal. |
payload_type | string | Optional | Type of payload, must be 'historicalDetectionsJobResultSignalConversion'. |
request_id | string | Optional | A unique identifier for the request that is used to convert the job result to a signal. |
signal_message | string | Optional | Message content of the generated signals to be converted. |
signal_severity | string | Optional | Severity level of the security signal. Accepts values: info, low, medium, high, critical. |
Requirements
Output
json— Response from the API endpoint 'ConvertJobResultToSignal'.DatadogApi.ConvertRuleJsonToTerraform
Converts Datadog security rules from JSON to Terraform format. Use this tool to convert a Datadog security monitoring rule from JSON format to Terraform format. It is helpful when you need to transform security rules for infrastructure as code purposes. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'ConvertSecurityMonitoringRuleFromJSONToTerraform'.DatadogApi.ConvertSecurityRuleToTerraform
Convert existing security rule from JSON to Terraform. This tool converts an existing Datadog security monitoring rule from its JSON format to a Terraform configuration. Use it to facilitate the integration and management of your rules using Terraform.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
rule_id | string | Required | The ID of the Datadog security monitoring rule to convert. |
Requirements
Output
json— Response from the API endpoint 'ConvertExistingSecurityMonitoringRule'.DatadogApi.CreateActionConnection
Create a new action connection in Datadog. Use this tool to create a new action connection in Datadog. Ensure you have a registered application key before using this tool. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'CreateActionConnection'.DatadogApi.CreateApmRetentionFilter
Create a retention filter for indexing spans in Datadog. Use this tool to create a retention filter in Datadog that indexes spans within your organization. Note that default filters of types spans-errors-sampling-processor and spans-appsec-sampling-processor cannot be created. This tool returns the definition of the newly created retention filter.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
enable_retention_filter | boolean | Required | Set to true to enable the retention filter or false to disable it. |
retention_filter_name | string | Required | The name for the retention filter to be created. |
search_query | string | Required | The search query using span search syntax to define criteria for retention. |
span_sample_rate | number | Required | Sample rate for spans matching the query. A value of 1.0 processes all matching spans. |
resource_type | string | Optional | Specify the type of the resource, always use 'apm_retention_filter'. |
retention_filter_type | string | Optional | Set the type of retention filter. Must be 'spans-sampling-processor'. |
trace_sample_rate | number | Optional | Sample rate for traces with spans going through the filter. Use 1.0 to keep all matching traces. |
Requirements
Output
json— Response from the API endpoint 'CreateApmRetentionFilter'.DatadogApi.CreateAuthnMapping
Creates a new AuthN Mapping in Datadog. This tool calls the Datadog API to create a new AuthN Mapping. It should be used when you need to set up or configure authentication mappings in Datadog. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'CreateAuthNMapping'.DatadogApi.CreateAwsAccountIntegration
Create a new AWS Account Integration Config in Datadog. This tool should be called when you need to integrate an AWS account with Datadog. It will set up a new AWS account configuration for monitoring and managing AWS services through Datadog. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'CreateAWSAccount'.DatadogApi.CreateAwsCurConfig
Create an AWS CUR config for Cloud Cost Management. Use this tool to create a Cloud Cost Management account for an AWS Cost and Usage Report (CUR) configuration.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
aws_account_id | string | Optional | The AWS account ID for which the CUR config is created. This is required to specify which AWS account the configuration applies to. |
aws_bucket_name_for_cur | string | Optional | The AWS bucket name used to store the Cost and Usage Report. |
aws_cur_config_type | string | Optional | Type of AWS CUR config post request. Choose from available options: 'aws_cur_config_post_request'. |
bucket_region | string | Optional | The AWS region where the bucket is located. |
excluded_aws_account_ids | array<string> | Optional | List of AWS account IDs to exclude from the billing dataset. Used when `include_new_accounts` is `true`. |
include_new_member_accounts | boolean | Optional | Set to true to automatically include new member accounts by default in your billing dataset. |
included_aws_account_ids | array<string> | Optional | List of AWS account IDs to be included in the billing dataset, used when `include_new_accounts` is `false`. |
report_month | integer | Optional | Specify the month for the AWS Cost and Usage Report. Use an integer (1-12) to represent the month. |
report_name | string | Optional | The name of the Cost and Usage Report to create for AWS CUR configuration. |
report_prefix | string | Optional | The prefix for the Cost and Usage Report (CUR). |
Requirements
Output
json— Response from the API endpoint 'CreateCostAWSCURConfig'.DatadogApi.CreateAzureCostManagementAccount
Create a Cloud Cost Management account for Azure. Use this tool to set up a Cloud Cost Management account for an Azure configuration using Datadog. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'CreateCostAzureUCConfigs'.DatadogApi.CreateCaseTypeInDatadog
Initiate the creation of a new case type in Datadog. Use this tool to create a new case type in Datadog, enabling structured classification and management of cases within the platform.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
case_type_name | string | Required | Specify the name of the case type to be created in Datadog. |
case_type_deleted_timestamp | string | Optional | Timestamp indicating when the case type was deleted. Format should be a valid ISO 8601 string. |
case_type_description | string | Optional | A brief textual description of the case type to be created in Datadog. |
case_type_emoji | string | Optional | Emoji representing the case type. Use a short, descriptive Unicode emoji. |
case_type_resource_type | string | Optional | Specify the resource type for the case. Must be 'case_type'. |
Requirements
Output
json— Response from the API endpoint 'CreateCaseType'.DatadogApi.CreateCloudflareAccount
Create a Cloudflare account through Datadog integration. This tool is used to create a Cloudflare account using Datadog's integration API. It should be called when you wish to initiate a new Cloudflare account while leveraging Datadog services.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
cloudflare_account_name | string | Required | The name for the Cloudflare account to be created. |
cloudflare_api_key | string | Required | The API key or token for the Cloudflare account required to authenticate and connect with the Cloudflare service. |
cloudflare_account_email | string | Optional | The email associated with the Cloudflare account. Required if using an API key instead of a token. |
json_api_type | string | Optional | Specifies the JSON:API type, must be 'cloudflare-accounts'. |
resources_allowlist | array<string> | Optional | List of resources such as 'web', 'dns', 'lb', or 'worker' to restrict metric pulling. |
zone_allowlist | array<string> | Optional | A list of zones for restricting metric data collection. |
Requirements
Output
json— Response from the API endpoint 'CreateCloudflareAccount'.DatadogApi.CreateCloudWorkloadSecurityAgentRule
Create a new cloud workload security agent rule. This tool creates a new security agent rule for cloud workload monitoring. It should be called when there is a need to set up or update security rules specifically for the Government (US1-FED) site. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'CreateCloudWorkloadSecurityAgentRule'.DatadogApi.CreateConfluentAccount
Create a Confluent account on Datadog. Use this tool to create a new Confluent account within the Datadog platform. Ideal for setting up new Confluent integrations. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'CreateConfluentAccount'.DatadogApi.CreateConfluentResource
Create a Confluent resource for a specified account. Use this tool to create a Confluent resource within a specific account using its ID. It's useful for managing Confluent resources in Datadog integrations.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
confluent_account_id | string | Required | The ID of the Confluent account for which to create the resource. |
confluent_resource_id | string | Required | The unique ID for the Confluent resource to be created or managed. |
resource_type | string | Required | The type of Confluent resource to create: `kafka`, `connector`, `ksql`, or `schema_registry`. |
enable_custom_metrics | boolean | Optional | Set to true to enable the `custom.consumer_lag_offset` metric with extra tags, false to disable. |
json_api_request_type | string | Optional | The JSON:API type for this request. Must be 'confluent-cloud-resources'. |
resource_tags | array<string> | Optional | A list of tag strings for the Confluent resource. Use key-value pairs separated by colons or single keys. |
Requirements
Output
json— Response from the API endpoint 'CreateConfluentResource'.DatadogApi.CreateCustomAllocationRule
Create a custom allocation rule in Datadog. Use this tool to create a custom allocation rule in Datadog with specified filters and allocation strategies. Useful for managing cost allocations with strategies like proportional, even, timeseries, or fixed percentage methods. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'CreateCustomAllocationRule'.DatadogApi.CreateCustomAttributeConfig
Create a custom attribute configuration for a specific case type. Use this tool to create a custom attribute configuration in Datadog for a specified case type, enhancing data categorization and organization.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
allow_multiple_values | boolean | Required | Indicates if multiple values can be set for the custom attribute. |
case_type_uuid | string | Required | UUID of the case type for which the custom attribute config is to be created. |
custom_attribute_display_name | string | Required | The display name for the custom attribute. |
custom_attribute_key | string | Required | A string key used to search for the custom attribute. This is the identifier for the attribute. |
custom_attribute_type | string | Required | Type of the custom attribute. Options: 'URL', 'TEXT', or 'NUMBER'. |
custom_attribute_description | string | Optional | Detailed description for the custom attribute. This helps define the attribute's purpose and use. |
custom_attributes_config_type | string | Optional | Specifies the JSON:API resource type for the custom attributes configuration. Must be 'custom_attribute'. |
Requirements
Output
json— Response from the API endpoint 'CreateCustomAttributeConfig'.DatadogApi.CreateCustomLogDestination
Create a custom log destination in Datadog. This tool creates a custom destination for logs in your Datadog organization. Use it to configure where your logs should be sent. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'CreateLogsCustomDestination'.DatadogApi.CreateCustomSecurityFramework
Create a custom security framework in Datadog. This tool is used to create a custom security framework in Datadog's cloud security management system. Call this tool when you need to define or customize security protocols and structures. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'CreateCustomFramework'.DatadogApi.CreateDatadogApiKey
Creates a new API key in Datadog. Use this tool to generate a new API key in Datadog. Ideal for managing authentication and access to Datadog services.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
api_key_name | string | Required | Name of the API key to be created in Datadog. This should be a descriptive and unique string identifier. |
api_keys_resource_type | string | Optional | Specify the resource type as 'api_keys'. |
apikey_category | string | Optional | Specifies the category for the API key. This categorizes the key for organizational purposes. |
remote_config_read_enabled | boolean | Optional | Indicates whether to enable read access to remote config for the new API key. Expects a boolean value. |
Requirements
Output
json— Response from the API endpoint 'CreateAPIKey'.DatadogApi.CreateDatadogGcpPrincipal
Create a Datadog GCP principal for integration. Use this tool to create a GCP principal in Datadog, enabling integration with Google Cloud Platform.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'MakeGCPSTSDelegate'.DatadogApi.CreateDatadogRestrictionQuery
Create a new restriction query in Datadog. This tool creates a restriction query for your organization in Datadog. Use it to manage log access and configurations.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
restriction_query | string | Optional | A string representing the restriction query to manage log access and configurations. |
restriction_query_resource_type | string | Optional | Specifies the type of restriction query resource. Must be 'logs_restriction_queries'. |
Requirements
Output
json— Response from the API endpoint 'CreateRestrictionQuery'.DatadogApi.CreateDatadogWorkflow
Creates a new workflow in Datadog and returns its ID. This tool is used to create a new workflow in Datadog, returning the workflow ID. It requires having a registered application key or configured permissions in the UI. This can be useful for automating processes and managing workflows effectively within the Datadog platform. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'CreateWorkflow'.DatadogApi.CreateDataset
Create a dataset with specified configurations. Use this tool to create a new dataset on Datadog with the desired configurations provided in the request. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'CreateDataset'.DatadogApi.CreateFastlyAccount
Create a new Fastly account through Datadog integration. Use this tool to create a new Fastly account using Datadog's integration service. Ideal for setting up Fastly accounts quickly and efficiently. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'CreateFastlyAccount'.DatadogApi.CreateFastlyService
Create a Fastly service for a specific account in Datadog. Use this tool to create a Fastly service associated with a given account within Datadog. Ideal when setting up or expanding Fastly integrations.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
fastly_account_id | string | Required | Provide the Fastly Account ID to create the service under. |
fastly_service_id | string | Required | The ID of the Fastly service to create. Provide a valid Fastly service ID. |
fastly_service_tags | array<string> | Optional | A list of tags for the Fastly service to help categorize and organize the service. |
jsonapi_type_for_fastly_service | string | Optional | The JSON:API type, always set to 'fastly-services', for creating a Fastly service. |
Requirements
Output
json— Response from the API endpoint 'CreateFastlyService'.DatadogApi.CreateGcpCostManagementAccount
Create a cost management account for Google Cloud usage. This tool creates a Cloud Cost Management account specifically for Google Cloud Usage Cost configurations. It should be called when a user wants to set up or initiate tracking and managing costs related to their Google Cloud resources.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
gcp_bucket_name | string | Optional | The name of the Google Cloud bucket where the Usage Cost exports are stored. |
gcp_usage_cost_export_dataset_name | string | Optional | The dataset name used for exporting the Google Cloud Usage Cost report. |
gcp_usage_cost_report_name | string | Optional | The name of the Google Cloud Usage Cost report to be used for cost management. |
google_cloud_billing_account_id | string | Optional | The Google Cloud account ID for cost management. |
google_cloud_export_prefix | string | Optional | The export prefix for the Google Cloud Usage Cost report. |
google_cloud_service_account_email | string | Optional | The unique Google Cloud service account email required for the cost management setup. |
usage_cost_config_type | string | Optional | Specifies the type of Google Cloud Usage Cost configuration post request. Use "gcp_uc_config_post_request" to indicate this type. |
Requirements
Output
json— Response from the API endpoint 'CreateCostGCPUsageCostConfig'.DatadogApi.CreateGcpStsAccount
Create a new GCP STS account entry in Datadog. Use this tool to create a new entry within Datadog for your STS-enabled Google Cloud Platform service account. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'CreateGCPSTSAccount'.DatadogApi.CreateIncident
Create a new incident in Datadog. This tool is used to create a new incident within Datadog's incident management system. Trigger this tool when there is a need to report or manage an incident requiring attention. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'CreateIncident'.DatadogApi.CreateIncidentImpact
Create an impact for a specific incident. This tool is used to create an impact for a specified incident. It should be called when there is a need to log or document the impact details of an ongoing or past incident. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
incident_uuid | string | Optional | The unique identifier (UUID) for the incident. This is required to log impact details for the specified incident. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
included_resources | array<string> | Optional | List of related resources to include in the response, such as 'users' or 'details'. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'CreateIncidentImpact'.DatadogApi.CreateIncidentIntegration
Create incident integration metadata for an incident. Use this tool to create integration metadata related to a specific incident in Datadog. It facilitates linking external integrations to an incident for enhanced tracking and management. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
incident_uuid | string | Optional | The unique identifier (UUID) of the incident to create integration metadata for. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'CreateIncidentIntegration'.DatadogApi.CreateIncidentNotificationRule
Creates a new incident notification rule in Datadog. Use this tool to create and manage notification rules for incidents in Datadog. It should be called when there is a need to set up a new notification rule for monitoring incident alerts. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'CreateIncidentNotificationRule'.DatadogApi.CreateIncidentNotificationTemplate
Creates a new incident notification template. Use this tool to create a new notification template for incidents. It should be called when there is a need to set up or customize notifications related to incident management.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
notification_content_body | string | Required | The body content for the notification template, describing the detailed message of the notification. |
notification_subject | string | Required | The subject line for the notification template. This sets the subject of the template being created. |
notification_template_category | string | Required | The category of the notification template. |
notification_template_name | string | Required | The name for the notification template to be created. |
resource_type_notification_template | string | Required | Specify the resource type for notification templates, which should be 'notification_templates'. |
incident_type_id | string | Optional | The ID of the incident type to associate with the notification template. |
incident_type_resource_type | string | Optional | The resource type for the incident, which should be 'incident_types'. |
Requirements
Output
json— Response from the API endpoint 'CreateIncidentNotificationTemplate'.DatadogApi.CreateIncidentTodo
Create a task within an incident in Datadog. This tool is used to add a to-do item to an incident in Datadog, helping manage and track tasks related to incident resolution. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
incident_uuid | string | Optional | The UUID of the incident for which the to-do is being created. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'CreateIncidentTodo'.DatadogApi.CreateIncidentType
Create a new incident type in Datadog. This tool is used to create a new incident type in Datadog, allowing users to define categories for managing incidents effectively.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
incident_type_name | string | Required | The name of the incident type to be created in Datadog. |
creator_user_id | string | Optional | A unique ID representing the user who created the incident type. |
incident_creation_timestamp | string | Optional | Timestamp indicating when the incident type was created. Format should be ISO 8601. |
incident_title_prefix | string | Optional | The string prepended to the incident title throughout the Datadog app. |
incident_type_description | string | Optional | Text that describes the incident type. Provide a clear, concise explanation to aid in management and identification. |
incident_type_resource_type | string | Optional | Specifies the incident type resource type. Must be 'incident_types'. |
last_modified_timestamp | string | Optional | Timestamp indicating when the incident type was last modified. Use ISO 8601 format, e.g., '2023-10-01T14:30:00Z'. |
last_modified_user_id | string | Optional | Unique identifier for the user who last modified the incident type. |
set_as_default_incident_type | boolean | Optional | Set to true to make this the default incident type if no type is specified during incident creation. |
Requirements
Output
json— Response from the API endpoint 'CreateIncidentType'.DatadogApi.CreateLogBasedMetric
Create a metric from your ingested logs. Use this tool to create a metric based on the logs ingested in your Datadog organization. It returns the log-based metric object when the request is successful. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'CreateLogsMetric'.DatadogApi.CreateLogsArchive
Create an archive of logs in your organization. Use this tool to create a new archive for logs within your organization through Datadog. This is useful for organizing and storing logs for compliance or analysis purposes. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'CreateLogsArchive'.DatadogApi.CreateMetricTagConfiguration
Create queryable tag configurations for metrics. This tool is used to create and define a list of queryable tag keys for an existing metric in Datadog, such as count, gauge, rate, or distribution metrics. It allows for optional percentile aggregations on distribution metrics. By setting the 'exclude_tags_mode' to true, users can switch from an allow-list to a deny-list mode, where defined tags are not queryable. This tool requires the `Manage Tags for Metrics` permission. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
metric_name | string | Optional | The name of the existing metric for which the tag configuration is to be created. This is required to identify the specific metric in Datadog. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'CreateTagConfiguration'.DatadogApi.CreateMonitorConfigPolicy
Create a new monitor configuration policy in Datadog. Use this tool to create monitor configuration policies within Datadog, specifying the desired configurations and parameters. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'CreateMonitorConfigPolicy'.DatadogApi.CreateMonitorNotificationRule
Creates a monitor notification rule in Datadog. Use this tool to set up a notification rule for a specific monitor in Datadog. This allows for alerting based on monitor condition changes. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'CreateMonitorNotificationRule'.DatadogApi.CreateMonitorUserTemplate
Create a new monitor user template in Datadog. This tool should be called to create a new user template for monitoring within Datadog. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'CreateMonitorUserTemplate'.DatadogApi.CreateNewApp
Create a new app and return its ID using Datadog. Use this tool to create a new app in Datadog. Ensure you have a registered application key or configured permissions in the UI before calling this tool. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'CreateApp'.DatadogApi.CreateNewDatastore
Creates a new datastore in Datadog. Use this tool to create a new datastore within the Datadog platform. It should be called when a new storage resource needs to be initialized or added to the Datadog system.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
datastore_description | string | Optional | A human-readable description about the datastore. |
datastore_display_name | string | Optional | The display name for the new datastore. This should be a human-readable and descriptive name. |
datastore_id | string | Optional | Optional ID for the new datastore. If not provided, a default one will be generated automatically. |
datastore_resource_type | string | Optional | Specifies the resource type for the datastore. Valid value is 'datastores'. |
organization_access_level | string | Optional | The access level for the datastore within the organization. Options: 'contributor', 'viewer', or 'manager'. |
primary_key_column_name | string | Optional | The name of the primary key column for this datastore. Must follow PostgreSQL naming conventions and not exceed 63 characters. |
primary_key_generation_strategy | string | Optional | Set to `uuid` for automatic primary key generation when new items are added. Default is `none`, requiring manual key assignment. |
Requirements
Output
json— Response from the API endpoint 'CreateDatastore'.DatadogApi.CreateNewTeam
Create a new team and add specified members. This tool creates a new team and adds specified user IDs to it. Use it when you need to establish a team and assign users to it in Datadog. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'CreateTeam'.DatadogApi.CreateOktaAccount
Create an Okta account via Datadog integration. Use this tool to create a new Okta account through Datadog's API integration. This is useful when setting up user accounts for Okta within the Datadog platform.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
okta_account_domain | string | Required | The domain of the Okta account to be created. |
okta_account_name | string | Required | The name of the Okta account to be created via Datadog API integration. |
okta_auth_method | string | Required | Specify the authorization method for the Okta account. |
client_secret | string | Optional | The client secret associated with the Okta app integration. This is required for authentication. |
okta_account_id | string | Optional | The ID of the Okta account, which is a UUID hash of the account name. |
okta_account_type | string | Optional | Specifies the type of account for the Okta account. The value should be 'okta-accounts'. |
okta_api_key | string | Optional | The API key for the Okta account integration. This key is used for authenticating the account with Datadog. |
okta_client_id | string | Optional | The Client ID for the Okta app integration, necessary for the account setup. |
Requirements
Output
json— Response from the API endpoint 'CreateOktaAccount'.DatadogApi.CreateOnCallEscalationPolicy
Create a new On-Call escalation policy in Datadog. This tool is used to create a new On-Call escalation policy in Datadog. Call this tool when you need to set up or adjust escalation protocols within your team for handling alerts. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
include_relationships | string | Optional | Comma-separated list of included relationships to return. Allowed values: teams, steps, steps.targets. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'CreateOnCallEscalationPolicy'.DatadogApi.CreateOnCallSchedule
Create a new on-call schedule in Datadog. This tool is used to create a new on-call schedule in Datadog. It should be called when there is a need to set up a schedule for on-call duties, allowing teams to manage availability and response times. The tool returns a confirmation of the schedule created along with its details. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
include_relationships | string | Optional | Comma-separated list of relationships to return with the schedule. Options: `teams`, `layers`, `layers.members`, `layers.members.user`. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'CreateOnCallSchedule'.DatadogApi.CreateOpsgenieService
Create a new Opsgenie service in Datadog integration. This tool is used to create a new service object within the Opsgenie integration on Datadog. It should be called when you need to set up or add a new Opsgenie service to monitor and manage incidents or alerts.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
opsgenie_api_key | string | Required | The API key required to authenticate your Opsgenie service within Datadog. This key must be a valid string associated with your Opsgenie account. |
opsgenie_service_name | string | Required | The name for the Opsgenie service to be created in the Datadog integration. |
opsgenie_service_region | string | Required | The region for the Opsgenie service. Choose from 'us', 'eu', or 'custom'. |
custom_region_url | string | Optional | The custom URL for a specific Opsgenie region. Used to connect to a custom region. |
opsgenie_service_resource_type | string | Optional | Specify the Opsgenie service resource type, which must be 'opsgenie-service'. |
Requirements
Output
json— Response from the API endpoint 'CreateOpsgenieService'.DatadogApi.CreateOrganizationUser
Create a user for your organization in Datadog. This tool allows you to create a new user for your organization in Datadog. Use it when you need to add a team member to your Datadog account. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'CreateUser'.DatadogApi.CreateOrgConnection
Creates a new organization connection in Datadog. Use this tool to create a connection between the current organization and a target organization within Datadog. Ideal for linking organizational resources and sharing data across teams.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
connection_types | array<string> | Required | List of connection types to establish between the organizations. |
organization_connection_type | string | Required | Specify the type of the organization connection. Must be 'org_connection'. |
organization_relationship_type | string | Optional | Specifies the type of the organization relationship. Must be 'orgs'. |
target_org_name | string | Optional | The name of the target organization to connect with. |
target_org_uuid | string | Optional | The UUID of the target organization to connect to. |
Requirements
Output
json— Response from the API endpoint 'CreateOrgConnections'.DatadogApi.CreateOrUpdateServiceDefinitions
Create or update service definitions in Datadog. Use this tool to create a new service definition or update an existing one in the Datadog Service Catalog. Call this when needing to manage service details within Datadog. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'CreateOrUpdateServiceDefinitions'.DatadogApi.CreatePipeline
Create a new pipeline in Datadog's system. Use this tool to create a new pipeline within the Datadog service. It should be called when a user needs to set up or initialize a new data pipeline in their Datadog environment. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'CreatePipeline'.DatadogApi.CreatePowerpack
Creates a new powerpack in Datadog. Use this tool to initiate a powerpack creation in Datadog when managing monitoring configurations is required. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'CreatePowerpack'.DatadogApi.CreateProject
Create a new project in the system. Use this tool to initiate and create a new project effectively. It communicates with the Datadog service to set up the project environment.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
project_key | string | Required | The unique key for the project. Cannot use the value 'CASE'. |
project_name | string | Required | Specify the name of the project to be created. It should be a descriptive string. |
project_resource_type | string | Optional | Specifies the project resource type, which must be 'project'. |
Requirements
Output
json— Response from the API endpoint 'CreateProject'.DatadogApi.CreateReferenceTable
Create a new reference table in Datadog. This tool creates a new reference table in Datadog. It can be called by either uploading CSV data to get an upload ID or by providing cloud storage access details. Use this when you need to set up a reference table with data from CSV files. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'CreateReferenceTable'.DatadogApi.CreateReferenceTableUpload
Create a reference table upload for bulk data ingestion. Use this tool to initiate the creation of a reference table upload in Datadog, facilitating bulk data ingestion for analytics or monitoring purposes.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
file_upload_headers | array<string> | Optional | An array of strings representing the headers of the file to upload for the reference table. |
part_size_bytes | integer | Optional | The size of each part in the upload in bytes. For multipart uploads (part_count > 1), all parts except the last one must be at least 5,000,000 bytes. For single-part uploads, any size is allowed. |
reference_table_name | string | Optional | The name of the reference table for the upload. |
upload_id | string | Optional | The unique ID for the upload process in Datadog. |
upload_part_count | integer | Optional | Specify the number of parts in the upload. Used for multipart uploads. |
upload_resource_type | string | Optional | Specifies the resource type for the upload. Must be set to 'upload'. |
Requirements
Output
json— Response from the API endpoint 'CreateReferenceTableUpload'.DatadogApi.CreateRole
Create a new role for your organization in Datadog. This tool should be called when you need to create a new organizational role within the Datadog system. It returns details about the newly created role, helping to manage access and permissions for users. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'CreateRole'.DatadogApi.CreateRumApplication
Create a new RUM application within your organization. This tool is used to create a new RUM (Real User Monitoring) application in your organization using Datadog's API.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
rum_application_name | string | Required | The name of the RUM application to be created. |
product_analytics_retention_state | string | Optional | Set the retention policy for Product Analytics data from RUM events. Options are 'MAX' or 'NONE'. |
rum_application_creation_type | string | Optional | Specifies the type for creating a RUM application. Use `rum_application_create`. |
rum_application_type | string | Optional | Specifies the type of the RUM application. Expected values: `browser`, `ios`, `android`, `react-native`, `flutter`, `roku`, `electron`, `unity`, `kotlin-multiplatform`. |
rum_event_processing_state | string | Optional | Configures which RUM events are processed and stored for the application. Accepted values are 'ALL', 'ERROR_FOCUSED_MODE', or 'NONE'. |
Requirements
Output
json— Response from the API endpoint 'CreateRUMApplication'.DatadogApi.CreateRumMetric
Create a metric based on RUM data. Use this tool to create a metric using your organization's RUM data via Datadog. It returns the metric object if successful. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'CreateRumMetric'.DatadogApi.CreateRumRetentionFilter
Create a RUM retention filter for a RUM application. Use this tool to create a data retention filter for an RUM application, which controls the retention rules of your application's RUM data.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
rum_application_id | string | Required | RUM application ID for which the retention filter is to be created. |
rum_event_type_filter | string | Required | Specify the type of RUM events to filter. Options include: session, view, action, error, resource, long_task, vital. |
rum_retention_filter_name | string | Required | The name assigned to the RUM retention filter, used for identification. |
rum_retention_filter_sample_rate | integer | Required | The sample rate for a RUM retention filter, an integer between 0 and 100. |
enable_retention_filter | boolean | Optional | Set true to enable the retention filter, false to disable it. |
resource_type_for_retention | string | Optional | Specifies the resource type as 'retention_filters'. This value should always be 'retention_filters'. |
rum_retention_filter_query | string | Optional | The query string that defines the filtering criteria for the RUM retention filter. |
Requirements
Output
json— Response from the API endpoint 'CreateRetentionFilter'.DatadogApi.CreateScanningGroup
Create a new scanning group in Datadog. This tool creates a new scanning group in the Datadog sensitive data scanner. It allows for the configuration relationship to be included but does not support creating rules simultaneously. The new group is added last in the configuration order. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'CreateScanningGroup'.DatadogApi.CreateScanningRule
Create a scanning rule in a sensitive data group. Use this tool to create a new scanning rule within a sensitive data scanner group. The rule requires a group relationship and either a standard pattern or a regex attribute, but not both. If no attributes are specified, it will scan all except excluded ones. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'CreateScanningRule'.DatadogApi.CreateScorecardRule
Create a new scorecard rule in Datadog. Use this tool to create a new scorecard rule in Datadog when you need to automate monitoring tasks or enforce policies. Ideal for setting up performance metrics or compliance checks. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'CreateScorecardRule'.DatadogApi.CreateSecurityFilter
Create a security filter using Datadog's API. Use this tool to create a security filter for monitoring purposes in Datadog. Ideal for setting up security monitoring based on predefined conditions. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'CreateSecurityFilter'.DatadogApi.CreateSecurityMonitoringRule
Create a detection rule for monitoring security events. This tool is used to create a new detection rule for monitoring security events through Datadog. It involves setting up criteria and policies to trigger alerts for specific security-related incidents. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'CreateSecurityMonitoringRule'.DatadogApi.CreateServiceAccount
Create a service account for your organization. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'CreateServiceAccount'.DatadogApi.CreateServiceAccountAppKey
Create an application key for a service account. Use this tool to create a new application key for a specified service account on Datadog. It should be called when an application key is needed for service account integration or access.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
application_key_name | string | Required | The name for the application key to be created for the service account. |
service_account_identifier | string | Required | The unique identifier of the service account for which the application key will be created. |
application_key_scopes | array<string> | Optional | List of scopes to assign to the application key for specific permissions. |
application_keys_resource_type | string | Optional | Specify the resource type for the application key. This should always be 'application_keys'. |
Requirements
Output
json— Response from the API endpoint 'CreateServiceAccountApplicationKey'.DatadogApi.CreateSloReportJob
Initiate the generation of an SLO report in Datadog. Use this tool to start an SLO report job in Datadog. Once created, the job processes asynchronously, and a CSV report becomes available for download. Utilize the returned `report_id` to check status and access the report.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
from_timestamp_epoch_seconds | integer | Required | The starting timestamp for the SLO report in epoch seconds. Specifies when the report should begin. |
report_to_timestamp | integer | Required | The epoch timestamp representing the end time for the SLO report. |
slo_query_filter | string | Required | The query string to filter SLO results, e.g., 'service:<service-name>' or 'slo-name'. |
report_generation_frequency | string | Optional | The frequency for generating report data. Options: daily, weekly, monthly. |
report_timezone | string | Optional | The timezone to determine the start and end of each interval for the SLO report. It affects how intervals such as weekly start at 12am on Sunday in the specified timezone. |
Requirements
Output
json— Response from the API endpoint 'CreateSLOReportJob'.DatadogApi.CreateSpanMetric
Create a metric based on ingested spans in your organization. Use this tool to create a metric using your ingested spans. It will return the created span-based metric object if successful. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'CreateSpansMetric'.DatadogApi.CreateSupportCase
Create a new support case in Datadog. Use this tool to create a new support case in Datadog. Useful for reporting issues or requesting assistance.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
case_title | string | Required | The title of the support case to be created. It should clearly summarize the issue or request. |
case_type_uuid | string | Required | UUID representing the case type. Provide a valid UUID to specify the type of case being created. |
assignee_resource_type | string | Optional | The type of resource for the assignee, usually 'user'. |
assignee_user_id | string | Optional | A unique identifier for the user assigned to the case. Typically a UUID string. |
case_description | string | Optional | A detailed description of the support case. Include all relevant information about the issue or request. |
case_priority | string | Optional | The priority of the support case. Valid values are NOT_DEFINED, P1, P2, P3, P4, P5. |
case_resource_type | string | Optional | Specifies the type of resource being created. Always use "case" for this argument. |
project_id | string | Optional | Provide the unique identifier of the project related to the support case. |
project_resource_type | string | Optional | Specifies the project resource type. Must be 'project'. |
Requirements
Output
json— Response from the API endpoint 'CreateCase'.DatadogApi.CreateSuppressionRule
Create a new security monitoring suppression rule. Use this tool to create a new suppression rule in Datadog's security monitoring. It should be called when you need to suppress specific security alerts.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
enable_suppression_rule | boolean | Required | Enable the suppression rule. Use true to enable, false to disable. |
rule_query | string | Required | The rule criteria for the suppression rule using detection rules syntax. |
suppression_rule_name | string | Required | The name of the suppression rule to be created. |
data_exclusion_query | string | Optional | An exclusion query for input data to ignore events in suppression rules, applicable to logs, Agent events, etc. |
expiration_date_unix_ms | integer | Optional | A Unix millisecond timestamp for rule expiration. After this date, the rule will not suppress signals. |
resource_type | string | Optional | The type of the resource, which should always be `suppressions`. |
start_date_timestamp | integer | Optional | A Unix millisecond timestamp indicating when the suppression rule begins to suppress signals. |
suppression_query | string | Optional | The query used to suppress signals in the security rule. Matches are not triggered. |
suppression_rule_description | string | Optional | A description for the suppression rule. Provide a clear and concise explanation of the rule's purpose. |
Requirements
Output
json— Response from the API endpoint 'CreateSecurityMonitoringSuppression'.DatadogApi.CreateTagPipelineRuleset
Create a tag pipeline ruleset with specified rules. This tool creates a new tag pipeline ruleset using the specified rules and configurations in Datadog. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'CreateTagPipelinesRuleset'.DatadogApi.CreateTenantBasedHandle
Create a tenant-based handle in Datadog for Teams. Use this tool to create a new tenant-based handle for the Microsoft Teams integration within Datadog. It should be called when you need to configure or add a handle specific to a tenant in Datadog's Microsoft Teams integration.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
channel_id | string | Required | ID of the Microsoft Teams channel to associate with the tenant-based handle. |
handle_name | string | Required | The name for the tenant-based handle you wish to create in the Datadog Microsoft Teams integration. |
team_id | string | Required | The ID of the Microsoft Teams team to associate with the Datadog handle. |
tenant_id | string | Required | The unique identifier for the tenant in the Datadog Microsoft Teams integration. |
resource_type | string | Optional | Specifies the resource type as 'tenant-based-handle'. |
Requirements
Output
json— Response from the API endpoint 'CreateTenantBasedHandle'.DatadogApi.CreateUserApplicationKey
Create an application key for the current user in Datadog. Use this tool to generate a new application key for the current Datadog user. This is useful for accessing Datadog APIs that require authentication with user-specific credentials.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
application_key_name | string | Required | The name of the application key to be created for the current user. |
application_key_resource_type | string | Optional | Specifies the resource type, should always be 'application_keys'. |
application_key_scopes | array<string> | Optional | List of scopes to grant the application key for accessing specific resources. |
Requirements
Output
json— Response from the API endpoint 'CreateCurrentUserApplicationKey'.DatadogApi.CreateWafCustomRule
Create a new web application firewall custom rule. Use this tool to define a new custom rule for the web application firewall, enhancing security configurations. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'CreateApplicationSecurityWafCustomRule'.DatadogApi.CreateWafExclusionFilter
Create a new WAF exclusion filter in Datadog. Use this tool to create a new Web Application Firewall (WAF) exclusion filter in Datadog. Exclusion filters help in preventing certain requests from being processed by the WAF, acting as passlist entries. Ideal for managing application security settings. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'CreateApplicationSecurityWafExclusionFilter'.DatadogApi.CreateWorkflowWebhookHandle
Create a webhook handle for Datadog Microsoft Teams integration. Use this tool to create a Workflows webhook handle within the Datadog Microsoft Teams integration. It is useful when setting up or managing integrations between Datadog workflows and Microsoft Teams for real-time alerts and notifications.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
webhook_handle_name | string | Required | Name of the Workflows Webhook handle for Datadog Microsoft Teams integration. |
webhook_url | string | Required | The URL for the Workflows Webhook in the Datadog Microsoft Teams integration. |
webhook_handle_resource_type | string | Optional | Specifies the resource type for the Workflows webhook handle. Must be 'workflows-webhook-handle'. |
Requirements
Output
json— Response from the API endpoint 'CreateWorkflowsWebhookHandle'.DatadogApi.CreateWorkloadProtectionRule
Create a new Workload Protection agent rule. Use this tool to create a new Workload Protection agent rule with specified parameters. Note that this endpoint is not available for the Government (US1-FED) site. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'CreateCSMThreatsAgentRule'.DatadogApi.DeleteActionConnection
Delete an existing action connection in Datadog. Use this tool to delete a specific action connection in Datadog. Appropriate permissions via a registered application key are required to perform this action.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
action_connection_id | string | Required | The unique identifier for the action connection to be deleted. |
Requirements
Output
json— Response from the API endpoint 'DeleteActionConnection'.DatadogApi.DeleteApmRetentionFilter
Delete a specific APM retention filter from your organization. Use this tool to delete a specific retention filter in Datadog's APM configuration. Note that default filters with types spans-errors-sampling-processor and spans-appsec-sampling-processor cannot be deleted.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
retention_filter_id | string | Required | The ID of the retention filter to delete. Default filters cannot be deleted. |
Requirements
Output
json— Response from the API endpoint 'DeleteApmRetentionFilter'.DatadogApi.DeleteApp
Delete a specific app in Datadog. Use this tool to delete a specific app in Datadog. Ensure you have the necessary application key registered or permissions configured in the UI before attempting to delete.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
app_id | string | Required | The ID of the app to delete in Datadog. Ensure this ID is accurate to avoid unintentional deletions. |
Requirements
Output
json— Response from the API endpoint 'DeleteApp'.DatadogApi.DeleteAuthnMapping
Delete an AuthN Mapping using its UUID. Use this tool to delete a specific AuthN Mapping by providing its unique identifier (UUID).
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
authn_mapping_uuid | string | Required | The unique identifier (UUID) of the AuthN Mapping to be deleted. |
Requirements
Output
json— Response from the API endpoint 'DeleteAuthNMapping'.DatadogApi.DeleteAwsAccountConfig
Delete an AWS account integration by config ID. Use this tool to delete an AWS account integration configuration in Datadog by specifying the config ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
aws_account_configuration_id | string | Required | Unique Datadog ID for the AWS Account Integration Config. Obtain this ID via the 'List all AWS integrations' Datadog endpoint. |
Requirements
Output
json— Response from the API endpoint 'DeleteAWSAccount'.DatadogApi.DeleteAwsScanOptions
Delete Agentless scan options for an AWS account. Use this tool to delete Agentless scan options configured for a specific AWS account. Ideal for managing AWS account security settings through Datadog.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
aws_account_id | string | Required | The unique identifier for the AWS account whose scan options you want to delete. |
Requirements
Output
json— Response from the API endpoint 'DeleteAwsScanOptions'.DatadogApi.DeleteAzureSubscriptionScanOptions
Delete scan options for an Azure subscription. Use this tool to delete agentless scan options for a specified Azure subscription. It should be called when there is a need to remove scan settings associated with Azure resources.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
azure_subscription_id | string | Required | The unique identifier for the Azure subscription whose scan options you want to delete. |
Requirements
Output
json— Response from the API endpoint 'DeleteAzureScanOptions'.DatadogApi.DeleteBudget
Delete a specified budget. Use this tool to delete a budget by its ID. It should be called when you want to remove an existing budget from the system.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
budget_id | string | Required | The unique identifier for the budget to be deleted. This ID is required to specify which budget to remove from the system. |
Requirements
Output
json— Response from the API endpoint 'DeleteBudget'.DatadogApi.DeleteBulkTagsMetrics
Delete custom lists of queryable tag keys for metrics. This tool deletes all custom queryable tag keys for a given set of metrics identified by a name prefix. It is used with application keys that have 'Manage Tags for Metrics' permission and can notify specified account emails on completion.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
metric_name_prefix | string | Required | A text prefix to match against metric names for tag deletion. |
metric_bulk_configure_tags_resource | string | Optional | The identifier for the metric bulk configure tags resource, which should be 'metric_bulk_configure_tags'. |
notification_emails | array<string> | Optional | A list of account emails to notify when the configuration is applied. |
Requirements
Output
json— Response from the API endpoint 'DeleteBulkTagsMetricsConfiguration'.DatadogApi.DeleteCaseComment
Deletes a specific comment from a case. Use this tool to delete a comment from a specified case by providing the case and comment identifiers. It is useful for managing and maintaining relevant information within cases by removing unnecessary or outdated comments.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
case_identifier | string | Required | The unique identifier or key of the case for which the comment will be deleted. |
timeline_cell_uuid | string | Required | The UUID of the timeline cell containing the comment to be deleted. Required for specifying the exact comment. |
Requirements
Output
json— Response from the API endpoint 'DeleteCaseComment'.DatadogApi.DeleteCaseCustomAttribute
Removes a custom attribute from a specified case. This tool is used to delete a custom attribute from a specific case in Datadog. It should be called when you need to remove a particular custom attribute key from a case.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
case_custom_attribute_key | string | Required | The key of the custom attribute to be removed from a case. |
case_identifier | string | Required | The unique identifier or key of the case from which the custom attribute is to be deleted. |
Requirements
Output
json— Response from the API endpoint 'DeleteCaseCustomAttribute'.DatadogApi.DeleteCaseType
Delete a specific case type in Datadog. Use this tool to delete a specific case type by providing the case type ID. This is useful for managing and organizing case types within Datadog.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
case_type_uuid | string | Required | The unique identifier (UUID) of the case type to be deleted. |
Requirements
Output
json— Response from the API endpoint 'DeleteCaseType'.DatadogApi.DeleteCatalogEntity
Delete a single entity from the Software Catalog. This tool deletes a specified entity in the Software Catalog using its entity ID. Call this tool when you need to remove an entity from the Datadog Software Catalog.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
catalog_entity_identifier | string | Required | The UUID or Entity Reference for the entity to be deleted from the Software Catalog. |
Requirements
Output
json— Response from the API endpoint 'DeleteCatalogEntity'.DatadogApi.DeleteCatalogKind
Delete a kind from the Software Catalog. Use this tool to delete a specific kind from the Software Catalog using its identifier. This is useful for managing and organizing the catalog contents by removing obsolete or incorrect entries.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
catalog_kind_identifier | string | Required | The unique identifier for the kind to delete from the Software Catalog. |
Requirements
Output
json— Response from the API endpoint 'DeleteCatalogKind'.DatadogApi.DeleteCloudflareAccount
Delete a Cloudflare account via Datadog integration. Use this tool to delete a specified Cloudflare account from Datadog's integrations. Call this tool when you need to remove an account linked to Cloudflare within the Datadog platform.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
cloudflare_account_id | string | Required | The ID of the Cloudflare account to delete from Datadog. This should be a string matching the account ID format. |
Requirements
Output
json— Response from the API endpoint 'DeleteCloudflareAccount'.DatadogApi.DeleteCloudWorkloadSecurityAgentRule
Delete a specific cloud workload security agent rule. This tool deletes a specific cloud workload security agent rule in the Datadog system, applicable only for the Government (US1-FED) site.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
agent_rule_identifier | string | Required | The unique identifier for the specific agent rule to delete. |
Requirements
Output
json— Response from the API endpoint 'DeleteCloudWorkloadSecurityAgentRule'.DatadogApi.DeleteConfluentAccount
Delete a Confluent account using the account ID. This tool deletes a specified Confluent account by account ID in Datadog's system. It should be used when a user wants to remove a Confluent Cloud integration account.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
confluent_account_id | string | Required | The unique identifier for the Confluent Account to be deleted. |
Requirements
Output
json— Response from the API endpoint 'DeleteConfluentAccount'.DatadogApi.DeleteConfluentResource
Deletes a specified Confluent resource in a Datadog account. Use this tool to delete a Confluent resource associated with a specific account in Datadog by providing the account ID and resource ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
confluent_account_id | string | Required | The unique identifier for the Confluent account linked to the resource to be deleted. |
confluent_resource_id | string | Required | A string representing the unique ID of the Confluent resource to be deleted. |
Requirements
Output
json— Response from the API endpoint 'DeleteConfluentResource'.DatadogApi.DeleteCustomAllocationRule
Delete an existing custom allocation rule by ID. Call this tool to delete an existing custom allocation rule using its ID in Datadog's cost management API.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
custom_allocation_rule_id | integer | Required | The unique identifier of the custom allocation rule to be deleted. |
Requirements
Output
json— Response from the API endpoint 'DeleteCustomAllocationRule'.DatadogApi.DeleteCustomAttributeConfig
Deletes a custom attribute configuration for a case type. Use this tool to delete a specified custom attribute configuration from a case type in Datadog. It should be called when you need to remove an attribute configuration identified by a specific `case_type_id` and `custom_attribute_id`. Returns a confirmation of the deletion.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
case_type_uuid | string | Required | The UUID of the case type for which the custom attribute configuration should be deleted. |
custom_attribute_uuid | string | Required | The UUID of the case custom attribute to be deleted. |
Requirements
Output
json— Response from the API endpoint 'DeleteCustomAttributeConfig'.DatadogApi.DeleteCustomCostFile
Delete a specified custom costs file in Datadog. Use this tool to delete a specific custom costs file by providing its file ID. It can be called when a user needs to manage their cost files by removing outdated or unnecessary custom cost entries in Datadog.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
custom_cost_file_id | string | Required | The unique identifier of the custom costs file to be deleted. |
Requirements
Output
json— Response from the API endpoint 'DeleteCustomCostsFile'.DatadogApi.DeleteCustomFramework
Delete a custom framework from Datadog. This tool deletes a specified custom framework in Datadog's cloud security management system. Use it when you need to remove an existing custom security framework by its handle and version.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
framework_handle | string | Required | The unique identifier for the custom framework to be deleted. |
framework_version | string | Required | Specify the version of the custom framework to delete. |
Requirements
Output
json— Response from the API endpoint 'DeleteCustomFramework'.DatadogApi.DeleteCustomLogDestination
Delete a specific custom log destination. Call this tool to delete a specific custom log destination within your organization on Datadog.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
custom_destination_id | string | Required | The unique identifier for the custom log destination to be deleted. |
Requirements
Output
json— Response from the API endpoint 'DeleteLogsCustomDestination'.DatadogApi.DeleteDashboardFromList
Remove dashboards from a specified list in Datadog. Use this tool to delete one or more dashboards from an existing dashboard list in Datadog by specifying the list ID. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
dashboard_list_identifier | integer | Optional | The unique integer ID of the dashboard list from which dashboards will be deleted. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'DeleteDashboardListItems'.DatadogApi.DeleteDatadogApiKey
Delete an API key from Datadog. Use this tool to delete an existing API key in Datadog by providing the API key ID. Call this tool when you need to manage and remove unnecessary or compromised keys from your Datadog account.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
api_key_id | string | Required | The unique identifier of the API key to delete in Datadog. |
Requirements
Output
json— Response from the API endpoint 'DeleteAPIKey'.DatadogApi.DeleteDatadogAppKey
Deletes an application key in Datadog. Use this tool to delete an existing application key in Datadog when it is no longer needed or if security requires its removal.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
application_key_id | string | Required | The unique ID of the Datadog application key to delete. |
Requirements
Output
json— Response from the API endpoint 'DeleteApplicationKey'.DatadogApi.DeleteDatadogDatastore
Delete a Datadog datastore using its unique ID. Use this tool to delete a specific datastore in Datadog by providing its unique identifier. Call this tool when a datastore is no longer needed and requires removal.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
datastore_unique_id | string | Required | The unique identifier of the datastore to delete in Datadog. |
Requirements
Output
json— Response from the API endpoint 'DeleteDatastore'.DatadogApi.DeleteDataPipeline
Deletes a data pipeline from the Datadog configuration. Use this tool to remove a specific data pipeline by its ID from the Datadog configuration. Useful for managing and maintaining pipeline configurations.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
pipeline_identifier | string | Required | The unique ID of the pipeline that you want to delete from Datadog. |
Requirements
Output
json— Response from the API endpoint 'DeletePipeline'.DatadogApi.DeleteDataset
Deletes a dataset using its ID. Use this tool to delete a dataset by providing its ID. It should be called when you need to remove an existing dataset from the system.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
dataset_identifier | string | Required | The unique ID of the dataset to be deleted. Required for deletion. |
Requirements
Output
json— Response from the API endpoint 'DeleteDataset'.DatadogApi.DeleteDatastoreItem
Delete an item from a datastore by its key. Use this tool to delete a specific item from a datastore when you have the key and datastore ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
datastore_id | string | Required | A string representing the unique identifier of the datastore from which the item will be deleted. |
item_primary_key | string | Optional | The primary key value identifying the item to delete. Max length is 256 characters. |
item_unique_identifier | string | Optional | Optional unique identifier of the item to delete. Use if available for more precise deletion. |
resource_type_for_datastore_items | string | Optional | The resource type for datastore items. Must be 'items'. |
Requirements
Output
json— Response from the API endpoint 'DeleteDatastoreItem'.DatadogApi.DeleteEscalationPolicy
Delete an On-Call escalation policy. Use this tool to delete an existing On-Call escalation policy by providing its policy ID. This is useful for managing or updating your escalation policies within the Datadog platform.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
escalation_policy_id | string | Required | The unique ID of the escalation policy to be deleted. |
Requirements
Output
json— Response from the API endpoint 'DeleteOnCallEscalationPolicy'.DatadogApi.DeleteFastlyAccount
Deletes a specified Fastly account integration. Use this tool to delete a Fastly account integration from Datadog. Ideal when an integration is no longer needed or requires removal.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
fastly_account_id | string | Required | The unique identifier of the Fastly account to delete. Required for the deletion process. |
Requirements
Output
json— Response from the API endpoint 'DeleteFastlyAccount'.DatadogApi.DeleteFastlyService
Delete a Fastly service for an account. Use this tool to delete a specific Fastly service associated with an account in Datadog. Call this tool when you need to remove an existing service configured through the Fastly integration.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
fastly_account_id | string | Required | The ID of the Fastly account associated with the service to be deleted. |
fastly_service_id | string | Required | The unique identifier for the Fastly service to delete. Required to specify the exact service. |
Requirements
Output
json— Response from the API endpoint 'DeleteFastlyService'.DatadogApi.DeleteGcpScanOptions
Delete Agentless scan options for a GCP project. Use this tool to remove the agentless scanning configuration for a specified GCP project. Ideal for managing and updating project scan settings.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
gcp_project_id | string | Required | The unique identifier for the Google Cloud Platform (GCP) project whose scan options you wish to delete. |
Requirements
Output
json— Response from the API endpoint 'DeleteGcpScanOptions'.DatadogApi.DeleteGcpStsAccount
Delete an STS-enabled GCP account in Datadog. Use this tool to remove a specified STS-enabled Google Cloud Platform account from Datadog.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
gcp_sts_account_id | string | Required | The unique ID of the GCP STS-enabled service account to delete from Datadog. |
Requirements
Output
json— Response from the API endpoint 'DeleteGCPSTSAccount'.DatadogApi.DeleteHistoricalDetectionJob
Delete an existing historical detection job in Datadog. Use this tool to delete a specific historical detection job in Datadog's SIEM. This is helpful when you need to manage or clean up old detection jobs by specifying the job ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
job_id | string | Required | The unique identifier for the historical job to be deleted. |
Requirements
Output
json— Response from the API endpoint 'DeleteHistoricalJob'.DatadogApi.DeleteIncident
Deletes an existing incident from the organization. Use this tool to remove an incident from your organization's records in Datadog.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
incident_uuid | string | Required | The unique identifier (UUID) of the incident to delete. |
Requirements
Output
json— Response from the API endpoint 'DeleteIncident'.DatadogApi.DeleteIncidentImpact
Delete a specific incident impact by ID. Use this tool to delete an impact associated with a specific incident using the incident and impact IDs. Suitable for managing and cleaning up incident data in Datadog.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
incident_id | string | Required | The UUID of the incident to be deleted. Required for identifying the specific incident. |
incident_impact_uuid | string | Required | The UUID of the incident impact to be deleted. This is required to identify which specific impact to remove. |
Requirements
Output
json— Response from the API endpoint 'DeleteIncidentImpact'.DatadogApi.DeleteIncidentIntegrationMetadata
Remove an incident integration metadata entry. Use this tool to delete metadata associated with an incident integration. Call it when you need to remove specific integration details from an incident.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
incident_integration_metadata_uuid | string | Required | The UUID of the incident integration metadata to be deleted. |
incident_uuid | string | Required | The UUID of the incident you want to delete integration metadata for. |
Requirements
Output
json— Response from the API endpoint 'DeleteIncidentIntegration'.DatadogApi.DeleteIncidentNotificationRule
Delete an incident notification rule by its ID. Use this tool to delete a specific incident notification rule in Datadog by providing its ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
notification_rule_id | string | Required | The unique identifier of the notification rule to be deleted. |
include_resources | string | Optional | Comma-separated list of resources to include, such as `created_by_user`, `last_modified_by_user`, `incident_type`, `notification_template`. |
Requirements
Output
json— Response from the API endpoint 'DeleteIncidentNotificationRule'.DatadogApi.DeleteIncidentNotificationTemplate
Deletes a notification template by its ID. Use this tool to delete a specific incident notification template by providing its ID. It should be called when a notification template is no longer needed or requires removal.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
notification_template_id | string | Required | The unique ID of the incident notification template to be deleted. |
relationships_to_include | string | Optional | Comma-separated list of relationships to include. Options: `created_by_user`, `last_modified_by_user`, `incident_type`. |
Requirements
Output
json— Response from the API endpoint 'DeleteIncidentNotificationTemplate'.DatadogApi.DeleteIncidentTodo
Delete a specified incident todo in Datadog. Use this tool to delete a specific todo item associated with an incident in Datadog. This is helpful for managing and updating incident tasks as needed.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
incident_todo_uuid | string | Required | The unique UUID for the incident todo to be deleted. |
incident_uuid | string | Required | The unique identifier (UUID) of the incident to which the todo belongs. This is necessary to specify the incident context. |
Requirements
Output
json— Response from the API endpoint 'DeleteIncidentTodo'.DatadogApi.DeleteIncidentType
Deletes a specified incident type from Datadog configuration. Use this tool to remove an incident type from your Datadog configuration. It should be called when there is a need to delete a specific incident type identified by its ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
incident_type_uuid | string | Required | The unique identifier (UUID) of the incident type to be deleted in Datadog. |
Requirements
Output
json— Response from the API endpoint 'DeleteIncidentType'.DatadogApi.DeleteLogMetric
Delete a specific log-based metric from your organization. Call this tool to remove a specific log-based metric from your Datadog organization by specifying the metric ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
log_metric_name | string | Required | The name of the log-based metric you want to delete. |
Requirements
Output
json— Response from the API endpoint 'DeleteLogsMetric'.DatadogApi.DeleteLogsArchive
Delete a specific logs archive from your organization. Use this tool to permanently delete a specified logs archive in your Datadog organization. The tool should be called when you need to remove an unnecessary or outdated archive.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
archive_id | string | Required | The unique identifier for the archive to be deleted from Datadog. |
Requirements
Output
json— Response from the API endpoint 'DeleteLogsArchive'.DatadogApi.DeleteMetricTagConfiguration
Delete a metric's tag configuration. Use this tool to delete the tag configuration for a specific metric in Datadog. Ensure the application key has 'Manage Tags for Metrics' permission.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
metric_name | string | Required | The name of the metric whose tag configuration is to be deleted. Ensure the application key has the necessary permissions. |
Requirements
Output
json— Response from the API endpoint 'DeleteTagConfiguration'.DatadogApi.DeleteMonitorNotificationRule
Delete a monitor notification rule by ID. Use this tool to delete a specific monitor notification rule in Datadog by providing the rule ID. Useful for managing and cleaning up notification rules that are no longer needed.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
monitor_notification_rule_id | string | Required | The unique identifier for the monitor notification rule to delete in Datadog. |
Requirements
Output
json— Response from the API endpoint 'DeleteMonitorNotificationRule'.DatadogApi.DeleteMonitorPolicy
Deletes a specific monitor configuration policy.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
monitor_policy_id | string | Required | ID of the monitor configuration policy to be deleted. |
Requirements
Output
json— Response from the API endpoint 'DeleteMonitorConfigPolicy'.DatadogApi.DeleteMonitorUserTemplate
Deletes a monitor user template by its ID on Datadog. Use this tool to delete an existing monitor user template in Datadog by specifying the template's ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
monitor_user_template_id | string | Required | ID of the monitor user template to be deleted in Datadog. |
Requirements
Output
json— Response from the API endpoint 'DeleteMonitorUserTemplate'.DatadogApi.DeleteMsTeamsTenantHandle
Delete a tenant-based handle from Datadog's Microsoft Teams integration. Use this tool to remove a specific tenant-based handle from the Microsoft Teams integration in Datadog. This is useful for managing or updating integration settings.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
tenant_handle_id | string | Required | The unique identifier for the tenant-based handle to be deleted from the Microsoft Teams integration. |
Requirements
Output
json— Response from the API endpoint 'DeleteTenantBasedHandle'.DatadogApi.DeleteMultipleDatadogApps
Delete multiple apps in Datadog using app IDs. This tool deletes multiple applications from Datadog in a single request using a list of app IDs. It requires a registered application key or configured UI permissions. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'DeleteApps'.DatadogApi.DeleteOktaAccount
Delete an Okta account from Datadog integration. Use this tool to delete an Okta account integrated with Datadog. Call this tool when an Okta account needs to be removed from Datadog's integration platform.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
okta_account_id | string | Required | A string representing the ID of the Okta account to be deleted. |
Requirements
Output
json— Response from the API endpoint 'DeleteOktaAccount'.DatadogApi.DeleteOnCallSchedule
Delete an On-Call schedule in Datadog. Use this tool to delete a specific on-call schedule identified by its schedule ID in Datadog when managing schedules.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
schedule_id | string | Required | The unique identifier for the on-call schedule you wish to delete in Datadog. This is a required field. |
Requirements
Output
json— Response from the API endpoint 'DeleteOnCallSchedule'.DatadogApi.DeleteOpsgenieService
Delete a service in Datadog's Opsgenie integration. Use this tool to remove a specific service from the Datadog Opsgenie integration. Call this when you need to delete an Opsgenie service using its integration service ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
service_uuid | string | Required | The UUID of the service to be deleted in the Datadog Opsgenie integration. |
Requirements
Output
json— Response from the API endpoint 'DeleteOpsgenieService'.DatadogApi.DeleteOrgConnection
Delete an existing organization connection. Call this tool to delete a specified organization connection. Use it when you need to remove a link between organizations.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
connection_id | string | Required | The unique identifier of the organization connection to be deleted. |
Requirements
Output
json— Response from the API endpoint 'DeleteOrgConnections'.DatadogApi.DeletePowerpack
Delete a specified powerpack from Datadog. This tool deletes a powerpack in Datadog using the specified powerpack ID. Call this tool when you need to remove a powerpack from your Datadog account.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
powerpack_id | string | Required | The unique identifier for the powerpack to be deleted. |
Requirements
Output
json— Response from the API endpoint 'DeletePowerpack'.DatadogApi.DeleteReferenceTable
Delete a reference table by ID. Use this tool to delete a specific reference table by providing its ID. Useful for managing and cleaning up reference data in your Datadog environment.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
reference_table_id | string | Required | The unique identifier of the reference table to be deleted. |
Requirements
Output
json— Response from the API endpoint 'DeleteTable'.DatadogApi.DeleteRestrictionPolicy
Delete a restriction policy for a specified resource. Use this tool to delete the restriction policy associated with a specific resource by providing its ID. It should be called when a policy needs to be removed.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
resource_identifier | string | Required | Identifier formatted as `type:id` for the resource. Supported types: `dashboard`, `integration-service`, `integration-webhook`, `notebook`, and more. |
Requirements
Output
json— Response from the API endpoint 'DeleteRestrictionPolicy'.DatadogApi.DeleteRestrictionQuery
Deletes a restriction query from Datadog logs configuration. Use this tool to delete a specific restriction query within Datadog's logs configuration. It should be called when you need to remove a restriction query by its unique ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
restriction_query_id | string | Required | The unique ID of the restriction query to be deleted from Datadog. |
Requirements
Output
json— Response from the API endpoint 'DeleteRestrictionQuery'.DatadogApi.DeleteRumApplication
Deletes an existing RUM application in your organization. Use this tool to delete an existing Real User Monitoring (RUM) application. Called when you need to remove a RUM application from your Datadog organization.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
rum_application_id | string | Required | The unique identifier for the RUM application you wish to delete. |
Requirements
Output
json— Response from the API endpoint 'DeleteRUMApplication'.DatadogApi.DeleteRumMetric
Delete a specific RUM-based metric from your organization. Call this tool to remove a specific RUM-based metric using its ID from your Datadog organization.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
rum_metric_id | string | Required | The ID of the RUM-based metric to be deleted from your Datadog organization. |
Requirements
Output
json— Response from the API endpoint 'DeleteRumMetric'.DatadogApi.DeleteRumRetentionFilter
Deletes a RUM retention filter for a specific application. This tool deletes a specified RUM retention filter for a given application in Datadog. It should be called when you need to remove a retention filter from a RUM application to stop retaining specific types of data.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
retention_filter_id | string | Required | The ID of the retention filter to delete from the RUM application. |
rum_application_id | string | Required | The ID of the RUM application from which to delete the retention filter. |
Requirements
Output
json— Response from the API endpoint 'DeleteRetentionFilter'.DatadogApi.DeleteScanningGroup
Delete a specified scanning group in Datadog. Use this tool to delete a specified scanning group in Datadog's sensitive data scanner configuration. It should be called when you need to remove an existing group by its ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
group_id | string | Required | The ID of the scanning group to be deleted. |
api_version | integer | Optional | Optional version number of the API to use for the request. |
Requirements
Output
json— Response from the API endpoint 'DeleteScanningGroup'.DatadogApi.DeleteScanningRule
Delete a specific scanning rule by ID. Use this tool to remove a sensitive data scanning rule in Datadog by providing the rule's ID. It should be called when a specific scanning rule needs to be deleted.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
rule_id | string | Required | The unique identifier for the scanning rule to be deleted. |
api_version | integer | Optional | Specify the API version to use for the request (optional). |
Requirements
Output
json— Response from the API endpoint 'DeleteScanningRule'.DatadogApi.DeleteScorecardRule
Deletes a scorecard rule by its ID. Use this tool to delete a specific rule in a scorecard by providing its ID. This is useful for managing and updating scorecard configurations by removing obsolete or incorrect rules.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
rule_id | string | Required | The ID of the scorecard rule to be deleted. |
Requirements
Output
json— Response from the API endpoint 'DeleteScorecardRule'.DatadogApi.DeleteSecurityFilter
Delete a specific security filter in Datadog. Use this tool to delete a specified security filter by its ID in Datadog's security monitoring configuration.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
security_filter_id | string | Required | The ID of the security filter to delete in Datadog. |
Requirements
Output
json— Response from the API endpoint 'DeleteSecurityFilter'.DatadogApi.DeleteSecurityMonitoringRule
Delete an existing security monitoring rule. Use this tool to delete a specified security monitoring rule in Datadog. Note that default rules cannot be deleted.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
security_rule_id | string | Required | The unique identifier of the security rule to be deleted. Default rules cannot be deleted. |
Requirements
Output
json— Response from the API endpoint 'DeleteSecurityMonitoringRule'.DatadogApi.DeleteServiceAccountAppKey
Delete an application key from a service account. Call this tool to remove an application key associated with a specific service account in Datadog. This tool is useful for managing access and maintaining security by ensuring unused or compromised keys are deleted.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
application_key_id | string | Required | The unique identifier for the application key to be deleted. |
service_account_id | string | Required | The unique identifier for the service account from which the application key will be deleted. |
Requirements
Output
json— Response from the API endpoint 'DeleteServiceAccountApplicationKey'.DatadogApi.DeleteServiceDefinition
Deletes a service definition from Datadog. Use this tool to remove a specific service definition from the Datadog Service Catalog. Ideal for cleaning up or managing services that are no longer needed.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
service_name | string | Required | The name of the service to delete from the Datadog Service Catalog. |
Requirements
Output
json— Response from the API endpoint 'DeleteServiceDefinition'.DatadogApi.DeleteSpanMetric
Delete a specific span-based metric from your organization. Use this tool to delete a span-based metric by specifying its metric ID. It helps manage and maintain the span metrics within your organization by removing unnecessary or obsolete data.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
metric_id | string | Required | The unique identifier for the span-based metric to be deleted. |
Requirements
Output
json— Response from the API endpoint 'DeleteSpansMetric'.DatadogApi.DeleteSuppressionRule
Delete a specific suppression rule in Datadog. Use this tool to delete a specific suppression rule from Datadog's security monitoring configuration. Call it when you need to remove an existing suppression rule using its ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
suppression_rule_id | string | Required | The unique identifier of the suppression rule to be deleted in Datadog. |
Requirements
Output
json— Response from the API endpoint 'DeleteSecurityMonitoringSuppression'.DatadogApi.DeleteTagPipelineRuleset
Delete an existing tag pipeline ruleset by ID. Use this tool to delete a specific tag pipeline ruleset in Datadog by providing its ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
ruleset_id | string | Required | The unique identifier for the tag pipeline ruleset to be deleted. |
Requirements
Output
json— Response from the API endpoint 'DeleteTagPipelinesRuleset'.DatadogApi.DeleteTeam
Remove a team using its ID in Datadog. This tool should be called to permanently delete a team in Datadog by specifying the team's unique ID. Use this when a team is no longer needed and should be removed from the system.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
team_identifier | string | Required | The unique identifier for the team to be deleted in Datadog. |
Requirements
Output
json— Response from the API endpoint 'DeleteTeam'.DatadogApi.DeleteUserApplicationKey
Delete an application key owned by the current user. This tool deletes an application key associated with the current user in Datadog. It should be called when the user needs to remove access or invalidate an application key.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
application_key_id | string | Required | The ID of the application key to be deleted. Required to identify which key to remove. |
Requirements
Output
json— Response from the API endpoint 'DeleteCurrentUserApplicationKey'.DatadogApi.DeleteWafCustomRule
Delete a specific WAF custom rule by ID. Use this tool to delete a WAF custom rule using its unique identifier. Applicable when managing application security or modifying WAF configurations.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
custom_rule_id | string | Required | The unique identifier for the WAF custom rule to be deleted. Required for identifying the specific rule. |
Requirements
Output
json— Response from the API endpoint 'DeleteApplicationSecurityWafCustomRule'.DatadogApi.DeleteWafExclusionFilter
Delete a WAF exclusion filter using its ID. Use this tool to delete a specific Web Application Firewall (WAF) exclusion filter by providing its identifier. Call this tool when you need to remove an unnecessary or outdated exclusion filter from the configuration.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
waf_exclusion_filter_id | string | Required | The unique identifier of the WAF exclusion filter to be deleted. Use this ID to specify which filter to remove. |
Requirements
Output
json— Response from the API endpoint 'DeleteApplicationSecurityWafExclusionFilter'.DatadogApi.DeleteWorkflow
Delete a specified workflow by its ID. Use this tool to delete an existing workflow by providing the workflow ID. Ensure you have the necessary permissions or a registered application key from Datadog before calling this tool.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
workflow_id | string | Required | The ID of the workflow to be deleted. Ensure it is a valid and existing workflow ID in Datadog. |
Requirements
Output
json— Response from the API endpoint 'DeleteWorkflow'.DatadogApi.DeleteWorkflowWebhookHandle
Delete a Workflows webhook handle in Datadog. Use this tool to delete a specific Workflows webhook handle from the Datadog Microsoft Teams integration. This should be called when you need to remove an existing webhook handle.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
webhook_handle_id | string | Required | The unique identifier of the Workflows webhook handle to delete. |
Requirements
Output
json— Response from the API endpoint 'DeleteWorkflowsWebhookHandle'.DatadogApi.DeleteWorkloadProtectionAgentRule
Delete a specific Workload Protection agent rule. This tool deletes a specified Workload Protection agent rule in Datadog, excluding the Government (US1-FED) site. Use this when needing to remove an existing agent rule by its unique identifier.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
agent_rule_identifier | string | Required | The unique identifier for the Agent rule to be deleted. |
agent_policy_id | string | Optional | The unique identifier of the Workload Protection agent policy to delete. |
Requirements
Output
json— Response from the API endpoint 'DeleteCSMThreatsAgentRule'.DatadogApi.DeleteWorkloadProtectionPolicy
Delete a specific Workload Protection policy. Use this tool to remove a specified Workload Protection policy from Datadog. Note: Not available for the Government (US1-FED) site.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
agent_policy_id | string | Required | The unique ID of the agent policy to be deleted. |
Requirements
Output
json— Response from the API endpoint 'DeleteCSMThreatsAgentPolicy'.DatadogApi.DisableRole
Disables a specified role within Datadog. Call this tool to disable a specific role in Datadog by providing its role ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
role_identifier | string | Required | The unique identifier for the role to be disabled in Datadog. |
Requirements
Output
json— Response from the API endpoint 'DeleteRole'.DatadogApi.DisableUser
Disable a specific user in the system. This tool disables a user account and should be used by administrator users to manage user access. It indicates whether the operation was successful or not.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
user_identifier | string | Required | The unique identifier of the user to be disabled. |
Requirements
Output
json— Response from the API endpoint 'DisableUser'.DatadogApi.DownloadCloudWorkloadPolicy
Downloads a Workload Protection policy file for agents. Generates and downloads a Workload Protection policy file from active agent rules, specifically for the US1-FED site. This file is used to update the policy on your agents.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'DownloadCloudWorkloadPolicyFile'.DatadogApi.DownloadCsmThreatsPolicy
Generate and download Workload Protection policy file. This tool generates a Workload Protection policy file based on active agent rules and downloads it as a `.policy` file. It is used to update the policy running in your environment. Note that this is not available for US1-FED site.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'DownloadCSMThreatsPolicy'.DatadogApi.DownloadSloReport
Download a completed SLO report from Datadog. Use this tool to download an SLO report from Datadog after the report job has completed. It is recommended to download the report as soon as it becomes available, as reports may not be stored indefinitely.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
report_id | string | Required | The unique identifier for the SLO report job to download. |
Requirements
Output
json— Response from the API endpoint 'GetSLOReport'.DatadogApi.EditAuthnMapping
Edit an AuthN Mapping in Datadog. This tool allows editing an authentication mapping in Datadog. It should be called when modifications to an existing AuthN Mapping are needed. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
authn_mapping_uuid | string | Optional | The UUID of the AuthN Mapping to edit. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'UpdateAuthNMapping'.DatadogApi.EditDataset
Edit the dataset using the specified ID. Call this tool to edit the details of a dataset in Datadog using its ID. It updates the dataset's configuration or metadata. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
dataset_id | string | Optional | The unique ID of the dataset to be edited in Datadog. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'UpdateDataset'.DatadogApi.EditMonitorConfigPolicy
Edit an existing monitor configuration policy in Datadog. This tool allows you to update the configuration of an existing monitor policy in Datadog by specifying the policy ID. Use it when changes to monitor policies are required. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
monitor_policy_id | string | Optional | The ID of the monitor configuration policy to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'UpdateMonitorConfigPolicy'.DatadogApi.EditRestrictionQuery
Edit an existing restriction query in Datadog. Use this tool to modify restriction queries in Datadog's log configuration. Call this when you need to update specific restriction parameters for log queries.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
restriction_query_id | string | Required | The ID of the restriction query to be edited. |
restriction_query_resource_type | string | Optional | The type of restriction query resource. Must be 'logs_restriction_queries'. |
restriction_query_string | string | Optional | The restriction query string to update for the restriction query in Datadog. |
Requirements
Output
json— Response from the API endpoint 'UpdateRestrictionQuery'.DatadogApi.EditRole
Edit a role with administrator application keys. Use this tool to edit an existing role in Datadog. It's designed for administrators using application keys to make updates to specified roles. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
role_identifier | string | Optional | The unique identifier for the role to be edited. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'UpdateRole'.DatadogApi.EditSecuritySignalIncidents
Modify incidents linked to a security signal. This tool allows for updating the incidents related to a specific security monitoring signal. Use it when you need to change how a security signal is associated with incidents.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
incident_ids | array<integer> | Required | An array of incident IDs to associate with the security signal. |
signal_id | string | Required | The unique identifier for the security signal to modify. |
signal_version | integer | Optional | Version of the updated signal. Ensure the client-side version is not lower than the server-side version to avoid rejection. |
Requirements
Output
json— Response from the API endpoint 'EditSecurityMonitoringSignalIncidents'.DatadogApi.EditServiceAccountKey
Edit an application key for a service account. Use this tool to modify the details of an existing application key owned by a specific service account. This can help in updating permissions or other key parameters as needed.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
app_key_identifier | string | Required | The unique identifier of the application key to be edited. |
application_key_id | string | Required | The unique identifier for the application key to be edited. |
service_account_id | string | Required | The unique identifier for the service account. |
application_key_name | string | Optional | Name of the application key to be updated. |
application_key_resource_type | string | Optional | Specify the type of resource for the application key. Must be 'application_keys'. |
application_key_scopes | array<string> | Optional | Array of scopes to grant the application key. Each scope is a string representing a permission or capability. |
Requirements
Output
json— Response from the API endpoint 'UpdateServiceAccountApplicationKey'.DatadogApi.EditSignalAssignee
Modify the triage assignee of a security signal. Use this tool to change the person assigned to handle a security monitoring signal in Datadog. This is helpful when reassigning tasks to different team members for better workload distribution or expertise alignment.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
assignee_uuid | string | Required | UUID assigned by Datadog to identify the user account for the signal's assignee. |
signal_id | string | Required | The unique identifier for the security signal to modify its assignee. |
assignee_gravatar_icon | string | Optional | URL for the Gravatar icon associated with the user account. |
assignee_name | string | Optional | The name for the user account to be assigned the security signal. |
signal_version_number | integer | Optional | Integer representing the version of the updated signal. If the server-side version is higher, the update will be rejected. |
user_account_handle | string | Optional | The handle for the user account to be assigned the security signal. |
user_account_numerical_id | integer | Optional | Numerical ID assigned by Datadog to the user account. Required for identifying the assignee. |
Requirements
Output
json— Response from the API endpoint 'EditSecurityMonitoringSignalAssignee'.DatadogApi.EditUserAppKey
Edit an application key owned by the current user. Use this tool to modify an existing application key for the current user. This is useful when you need to update permissions or other details associated with your application keys.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
app_key_identifier | string | Required | ID of the application key to be edited. |
application_key_id | string | Required | The ID of the application key to be edited. Must be a valid string ID. |
application_key_name | string | Optional | New name for the application key. |
application_key_resource_type | string | Optional | Specifies the resource type for the application key. Use the value 'application_keys'. |
application_key_scopes | array<string> | Optional | List of scopes to grant the application key. Each scope is a string defining permissions. |
Requirements
Output
json— Response from the API endpoint 'UpdateCurrentUserApplicationKey'.DatadogApi.EscalateOnCallPage
Escalate an on-call page to notify the responsible team. Use this tool to escalate an on-call page when immediate attention is needed from the responsible team.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
on_call_page_id | string | Required | The unique identifier for the on-call page to be escalated. |
Requirements
Output
json— Response from the API endpoint 'EscalateOnCallPage'.DatadogApi.EstimateMetricsOutput
Estimate cardinality of a metric with specific settings. Use this tool to get the estimated cardinality for a metric based on a specific tag, percentile, and number of aggregations configuration. This is useful for analyzing metric data within Datadog using Metrics without Limits™.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
metric_name | string | Required | Specifies the name of the metric for which to estimate cardinality. |
filtered_tag_keys | string | Optional | Filtered tag keys that the metric is configured to query with, specified as a string. |
ignore_num_aggregations | integer | Optional | This argument is deprecated and has no impact on volume estimation. It is ignored in the current tool implementation. |
include_percentile_aggregators | boolean | Optional | Boolean to estimate cardinality if distribution metrics have additional percentile aggregators. |
lookback_hours | integer | Optional | Specify the number of hours to look back from the current time to estimate cardinality. Defaults to 0 if not provided. |
lookback_timespan_hours | integer | Optional | A window, in hours, from the lookback to estimate cardinality. Minimum is 1 hour. |
Requirements
Output
json— Response from the API endpoint 'EstimateMetricsOutputSeries'.DatadogApi.ExecuteWorkflow
Execute a specified workflow in Datadog. Initiates the execution of a workflow in Datadog using the provided workflow ID. Ensure that a registered application key or appropriate UI configuration is used for authentication. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
workflow_identifier | string | Optional | The unique ID of the Datadog workflow to be executed. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'CreateWorkflowInstance'.DatadogApi.FetchAllScorecardOutcomes
Retrieve all rule outcomes from scorecards. Use this tool to fetch all outcomes from scorecards in Datadog. It's useful for obtaining detailed results of applied rules.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
filter_by_rule_id | string | Optional | Filter outcomes based on specific rule ID. |
filter_by_rule_name | string | Optional | Filter outcomes based on a specific rule name. |
filter_outcomes_by_service_name | string | Optional | Filter outcomes based on a specific service name. Provide the service name as a string. |
filter_rule_enabled | boolean | Optional | Filter outcomes based on whether a rule is enabled (true) or disabled (false). |
include_rule_details | string | Optional | Specify if related rule details should be included in the response. |
outcome_state_filter | string | Optional | Filter the scorecard outcomes by a specific state. Accepts a state value as a string. |
page_offset | integer | Optional | Specific offset to use as the beginning of the returned page, represented as an integer. |
page_size | integer | Optional | The number of results per page, with a maximum of 100. |
rule_fields_to_return | string | Optional | Specify which fields to return in the included rule details. |
specified_outcome_values | string | Optional | Comma-separated list of specific outcome attributes to return. Limits the response to these attributes. |
Requirements
Output
json— Response from the API endpoint 'ListScorecardOutcomes'.DatadogApi.FetchAwsIntegrationPermissions
Retrieve AWS IAM permissions for Datadog integration. Call this tool to obtain the list of AWS IAM permissions required for integrating AWS with Datadog.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'GetAWSIntegrationIAMPermissions'.DatadogApi.FetchAwsScanSettings
Fetches Agentless scan options for AWS accounts. Use this tool to retrieve the configuration of Agentless scan options for a specified AWS account.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
aws_account_id | string | Required | The unique ID of an AWS account for fetching scan options. |
Requirements
Output
json— Response from the API endpoint 'GetAwsScanOptions'.DatadogApi.FetchAzureScanOptions
Fetches the scan options for Azure accounts from Datadog. Call this tool to retrieve the current scan options configured for Azure accounts in Datadog. It provides details about the configuration settings used in agentless scanning for these accounts.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'ListAzureScanOptions'.DatadogApi.FetchConfluentResource
Retrieve a Confluent resource using account and resource IDs. Use this tool to obtain information about a specific Confluent resource linked to a particular account by providing the account and resource IDs.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
confluent_account_id | string | Required | The ID of the Confluent account to retrieve the resource for. This should be a string value representing the account identifier. |
confluent_resource_id | string | Required | The ID of the Confluent resource associated with the specified account. Provide this to retrieve the resource details. |
Requirements
Output
json— Response from the API endpoint 'GetConfluentResource'.DatadogApi.FetchCustomCostsFile
Fetch a specified Custom Costs file by file ID from Datadog. Use this tool to retrieve a specific Custom Costs file from Datadog by providing the file ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
file_identifier | string | Required | A unique identifier for the Custom Costs file to be retrieved from Datadog. |
Requirements
Output
json— Response from the API endpoint 'GetCustomCostsFile'.DatadogApi.FetchDashboardListItems
Fetch details of dashboards in a list. Use this tool to retrieve the details of dashboards contained in a specific dashboard list by providing the list ID. It returns the dashboard definitions for that list.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
dashboard_list_id | integer | Required | The unique integer ID of the dashboard list from which to retrieve dashboard definitions. |
Requirements
Output
json— Response from the API endpoint 'GetDashboardListItems'.DatadogApi.FetchGcpScanOptions
Fetch GCP project scan options. This tool retrieves the scan options configured for all Google Cloud Platform (GCP) projects, facilitating the assessment of agentless scanning configurations.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'ListGcpScanOptions'.DatadogApi.FetchMonthlyCostAttribution
Retrieve monthly cost attribution data by tag. Fetch detailed monthly cost attribution by tag for both multi-org and single root-org accounts. Use this to track and report cost allocations within an organization after the 19th of each month. Ensure to handle pagination if necessary to acquire all records.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
cost_types_fields | string | Required | Comma-separated list specifying cost types and proportions. Use `*` to retrieve all fields. Example: `infra_host_on_demand_cost,infra_host_percentage_in_account`. |
start_month | string | Required | Datetime in ISO-8601 format, UTC, precise to month `[YYYY-MM]`. Represents the start of the costing period. |
end_month | string | Optional | The final month for cost calculation. Use ISO-8601 format `[YYYY-MM]` to specify the month. |
include_child_organization_costs | boolean | Optional | Include child organization costs in the response. Defaults to true. |
pagination_next_record_id | string | Optional | Identifier for fetching the next set of results in a paginated response. Use the 'next_record_id' from the previous response. |
sort_by_billing_dimension | string | Optional | Billing dimension to sort by. Defaults to sorting by total cost. Example: 'infra_host'. |
sort_by_direction | string | Optional | Specifies the direction to sort cost attribution data. Use 'desc' for descending or 'asc' for ascending order. |
tag_keys_for_cost_grouping | string | Optional | Comma-separated list of tag keys used to group costs. If empty, costs won't be grouped by tag. Check `tag_config_source` in the API response for available tags. |
Requirements
Output
json— Response from the API endpoint 'GetMonthlyCostAttribution'.DatadogApi.FetchRecentAwsOnDemandTasks
Retrieve the latest AWS on demand tasks. Fetches the most recent 1000 AWS on demand tasks. Useful for monitoring or analyzing recent AWS activities managed by Datadog.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'ListAwsOnDemandTasks'.DatadogApi.FetchScorecardRules
Fetch all scorecard rules from Datadog. Use this tool to retrieve a list of all scorecard rules from Datadog's API. This is useful for managing and reviewing rules related to scorecards.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
filter_custom_rules_only | boolean | Optional | Set to true to include only custom rules in the results. |
filter_for_enabled_rules | boolean | Optional | Set to true to filter for enabled rules only. |
filter_rule_by_id | string | Optional | Filter the rules based on a specific rule ID. |
filter_rule_description | string | Optional | Filter rules based on their description. Provide a string to match against the rule descriptions. |
filter_rules_by_name | string | Optional | Specify a rule name to filter the scorecard rules. |
include_scorecard_details | string | Optional | Specify related scorecard details to include in the response. |
page_offset | integer | Optional | Specific offset to use as the beginning of the returned page for fetching scorecard rules. |
page_size | integer | Optional | Number of rules to return per page. Maximum value is 100. |
specific_rule_fields | string | Optional | Specify which rule fields to include in the response. Provide a comma-separated list of field names. |
specific_scorecard_fields | string | Optional | Specify which fields to include in the response for scorecard attributes. Use comma-separated values. |
Requirements
Output
json— Response from the API endpoint 'ListScorecardRules'.DatadogApi.FindSecurityAlerts
Retrieve historical security monitoring signals from Datadog. This tool is used to search and retrieve historical security monitoring signals in Datadog. Ideal for extracting past security incident data and analysis.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
max_security_signals | integer | Optional | Specify the maximum number of security signals to retrieve in the response. |
maximum_timestamp_for_signals | string | Optional | The maximum timestamp for requested security signals, formatted as a string. |
minimum_timestamp | string | Optional | The start timestamp for filtering requested security signals. Use ISO 8601 format. |
pagination_cursor | string | Optional | String used to fetch the next set of results based on a previous query's cursor. |
search_query_for_security_signals | string | Optional | Search query to filter and list specific security signals. Use keywords and operators to refine results. |
sort_order | string | Optional | The criteria for sorting security signals, either 'timestamp' or '-timestamp'. |
Requirements
Output
json— Response from the API endpoint 'SearchSecurityMonitoringHistsignals'.DatadogApi.GenerateAwsExternalId
Generate a new external ID for AWS authentication. This tool is used to generate a new external ID for AWS role-based authentication through Datadog.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'CreateNewAWSExternalID'.DatadogApi.GetActionConnection
Retrieve an existing Action Connection from Datadog. Use this tool to get details about an existing Action Connection in Datadog. This requires a registered application key.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
action_connection_id | string | Required | The ID of the action connection to retrieve. Required for fetching details of a specific connection. |
Requirements
Output
json— Response from the API endpoint 'GetActionConnection'.DatadogApi.GetActiveBillingDimensions
Retrieve active billing dimensions for cost attribution. Call this tool to get active billing dimensions used for attributing costs. Useful for understanding cost distribution across different dimensions. The data is available by the 19th of the following month.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'GetActiveBillingDimensions'.DatadogApi.GetAgentlessScanOptions
Fetch Azure Agentless scan options for a subscription. Use this tool to retrieve the Agentless scan options for an activated Azure subscription. This is useful for understanding the scanning configurations applied to the subscription.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
azure_subscription_id | string | Required | The Azure subscription ID to retrieve the Agentless scan options for. |
Requirements
Output
json— Response from the API endpoint 'GetAzureScanOptions'.DatadogApi.GetAggregatedConnections
Retrieve all aggregated network connections from Datadog. This tool is used to get a comprehensive view of all aggregated network connections. It's ideal for monitoring and analyzing network activity.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
connection_limit | integer | Optional | Set the number of connections to be returned, maximum 7500, default 100. |
end_query_window | integer | Optional | Unix timestamp for the end of the query window. Defaults to current time if not provided. |
filter_by_tags | string | Optional | Comma-separated list of tags to filter connections by for more targeted querying. |
group_by_fields | string | Optional | Comma-separated list of fields to group connections by, with a maximum of 10 fields. |
start_time_unix_timestamp | integer | Optional | Unix timestamp for the start of the query window. Defaults to 15 minutes before `end_time_unix_timestamp` if not provided. |
Requirements
Output
json— Response from the API endpoint 'GetAggregatedConnections'.DatadogApi.GetAggregatedDnsTraffic
Retrieve all aggregated DNS traffic data. This tool fetches all the aggregated DNS traffic data using Datadog's API. It should be called when you need information about DNS traffic patterns or metrics.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
end_timestamp | integer | Optional | Unix timestamp (seconds since epoch) for the end of the query window. Defaults to current time if not provided. |
filter_dns_traffic_by_tags | string | Optional | Comma-separated list of tags to filter the DNS traffic data within the query. |
group_dns_traffic_by_fields | string | Optional | Comma-separated list of fields to group DNS traffic by. Defaults to `network.dns_query` if unspecified. Use `server_ungrouped` to avoid grouping. Maximum of 10 fields. |
max_dns_entries | integer | Optional | Number of aggregated DNS entries to return, up to a maximum of 7500. Default is 100. |
start_query_timestamp | integer | Optional | Unix timestamp for the query window start. Defaults to 15 min before `to` timestamp if not specified. |
Requirements
Output
json— Response from the API endpoint 'GetAggregatedDns'.DatadogApi.GetAllCustomAttributes
Retrieve all custom attributes for cases in Datadog. Use this tool to fetch all the custom attributes associated with cases in Datadog. This can be useful for understanding the different custom data fields available for case management.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'GetAllCustomAttributes'.DatadogApi.GetAllDatasets
Retrieve all datasets configured for your organization. Call this tool to obtain a list of all datasets that have been configured for an organization, using the Datadog API.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'GetAllDatasets'.DatadogApi.GetAllMonitorUserTemplates
Retrieve all monitor user templates from Datadog. Use this tool to get a list of all monitor user templates available in Datadog. It can help in managing and reviewing template configurations.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'ListMonitorUserTemplates'.DatadogApi.GetAllProjects
Retrieve a list of all projects from Datadog.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'GetProjects'.DatadogApi.GetAllTeamLinks
Retrieve all links for a specific team. Use this tool to obtain all the links associated with a given team in Datadog. It is helpful when you need to gather all relevant links for team collaboration or resource management.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
team_identifier | string | Required | The unique identifier for the team whose links are to be retrieved. |
Requirements
Output
json— Response from the API endpoint 'GetTeamLinks'.DatadogApi.GetApiKeyDetails
Retrieves details of a specific Datadog API key. Use this tool to obtain information about a specific API key from Datadog by providing the API key ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
api_key_id | string | Required | The unique identifier for the Datadog API key to be retrieved. |
include_related_resources | string | Optional | Comma-separated list of resource paths (`created_by`, `modified_by`) to include in the response. |
Requirements
Output
json— Response from the API endpoint 'GetAPIKey'.DatadogApi.GetApmRetentionFilter
Retrieve details of a specific APM retention filter. Use this tool to get detailed information about an APM retention filter by specifying the filter ID. It helps in managing and understanding APM data retention configurations.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
retention_filter_id | string | Required | The unique identifier for the specific APM retention filter to retrieve. |
Requirements
Output
json— Response from the API endpoint 'GetApmRetentionFilter'.DatadogApi.GetApmRetentionFilters
Retrieve the list of APM retention filters from Datadog. This tool is used to obtain a list of APM retention filters in Datadog. It should be called when there's a need to review or analyze the current retention filter settings in APM configurations.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'ListApmRetentionFilters'.DatadogApi.GetAppDetails
Retrieve comprehensive details of a Datadog app. This tool fetches the full definition of a specified app from Datadog. It's useful when you need detailed information about an app for monitoring or management purposes. Ensure you have a registered application key or configured permissions as required by Datadog.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
application_id | string | Required | The unique ID of the Datadog app to retrieve details for. Required for fetching app information. |
app_version | string | Optional | Specify the app version to retrieve. Use a version number starting from 1, or special values `latest` and `deployed` for the latest or published version, respectively. |
Requirements
Output
json— Response from the API endpoint 'GetApp'.DatadogApi.GetAppKeyRegistration
Retrieve details of an existing App Key Registration. This tool retrieves information about a specific App Key Registration by its ID. Use it to obtain details of an app key currently registered in the Datadog system via its unique identifier.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
app_key_id | string | Required | The unique ID of the app key to fetch its registration details. |
Requirements
Output
json— Response from the API endpoint 'GetAppKeyRegistration'.DatadogApi.GetApplicationKey
Retrieve an application key for your organization from Datadog. Use this tool to obtain information about a specific application key in your Datadog account. This can be useful for managing and auditing access keys.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
application_key_id | string | Required | The unique identifier for the application key to retrieve details from Datadog. |
include_related_resource | string | Optional | Resource path for related resources to include in the response. Currently, only `owned_by` is supported. |
Requirements
Output
json— Response from the API endpoint 'GetApplicationKey'.DatadogApi.GetArchiveReadRoles
Retrieve roles with read access to a specific archive. Use this tool to obtain a list of all roles that have read access to a specified archive in Datadog. It helps manage and review access control for archive data.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
archive_identifier | string | Required | The unique identifier for the archive to retrieve read access roles from. |
Requirements
Output
json— Response from the API endpoint 'ListArchiveReadRoles'.DatadogApi.GetAuditLogs
Retrieve events matching an Audit Logs search query. This tool calls the Datadog API to retrieve audit log events that match a specified search query. It provides the latest events with pagination support.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
audit_logs_search_query | string | Optional | Search query using Audit Logs syntax to filter events. |
cursor_for_following_results | string | Optional | Cursor to fetch subsequent pages of results. Use the cursor from the previous query's response. |
max_event_timestamp | string | Optional | Specify the maximum timestamp for requested events in ISO 8601 format. |
max_events_per_response | integer | Optional | Specifies the maximum number of events to return in the response. |
sort_order_of_events | string | Optional | Specify the order of events in the results. Use 'timestamp' for ascending and '-timestamp' for descending order. |
start_time_filter | string | Optional | Specify the minimum timestamp for requested events in the format YYYY-MM-DDTHH:MM:SSZ. |
Requirements
Output
json— Response from the API endpoint 'ListAuditLogs'.DatadogApi.GetAuthnMapping
Retrieve an AuthN Mapping by its UUID. Use this tool to obtain details of a specific AuthN Mapping in Datadog by providing its UUID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
authn_mapping_uuid | string | Required | The UUID of the AuthN Mapping to retrieve. |
Requirements
Output
json— Response from the API endpoint 'GetAuthNMapping'.DatadogApi.GetAwsAccountIntegrationConfig
Retrieve AWS Account Integration Config by ID. Use this tool to obtain detailed information about a specific AWS account integration configuration, identified by its config ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
aws_account_integration_config_id | string | Required | Unique Datadog ID of the AWS Account Integration Config. Obtain it using the List all AWS integrations endpoint. |
Requirements
Output
json— Response from the API endpoint 'GetAWSAccount'.DatadogApi.GetAwsCloudwatchNamespaces
Retrieve available AWS CloudWatch namespaces for Datadog integration. This tool fetches a list of AWS CloudWatch namespaces that can send metrics to Datadog. It should be called when needing to understand which AWS services can integrate with Datadog for monitoring and analysis purposes.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'ListAWSNamespaces'.DatadogApi.GetAwsCurConfig
Retrieve a specific AWS CUR configuration. This tool is used to fetch the AWS Cost and Usage Report (CUR) configuration for a specific cloud account ID. It is ideal for users who need to check or audit AWS usage configurations.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
cloud_account_id | integer | Required | The unique integer identifier of the AWS cloud account for which to fetch the CUR configuration. |
Requirements
Output
json— Response from the API endpoint 'GetCostAWSCURConfig'.DatadogApi.GetAwsIamPermissions
Get required AWS IAM permissions for resource collection. This tool retrieves all necessary AWS IAM permissions for integrating with AWS. Use it to ensure that the integration has the required permissions.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'GetAWSIntegrationIAMPermissionsResourceCollection'.DatadogApi.GetAwsIntegrationIamPermissions
Fetch standard AWS IAM permissions for integration. Retrieve all standard AWS IAM permissions needed for setting up AWS integration.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'GetAWSIntegrationIAMPermissionsStandard'.DatadogApi.GetAwsOnDemandTaskData
Fetch data of a specific AWS on-demand task in Datadog. Use this tool to retrieve information about a specific AWS on-demand task from Datadog's agentless scanning service. It should be called when detailed information about a task is needed, identified by its task ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
aws_task_uuid | string | Required | The UUID of the AWS on-demand task to fetch data for. This is a unique identifier for the task. |
Requirements
Output
json— Response from the API endpoint 'GetAwsOnDemandTask'.DatadogApi.GetAwsScanOptions
Fetch AWS scan options for configured accounts. Use this tool to retrieve the scan options that have been set up for AWS accounts in Datadog.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'ListAwsScanOptions'.DatadogApi.GetAzureConfig
Retrieve details of a specific Azure configuration. This tool is used to get detailed information about a specific Azure configuration using the cloud account ID. It should be called when you need to access the configuration details for Azure within the Datadog service.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
azure_cloud_account_id | integer | Required | The unique identifier for the Azure cloud account to retrieve the configuration. |
Requirements
Output
json— Response from the API endpoint 'GetCostAzureUCConfig'.DatadogApi.GetBillingDimensionMapping
Retrieve the mapping of billing dimensions to API keys. Use this tool to obtain the mapping of billing dimensions to corresponding keys for usage metering API endpoints. This information is updated monthly and accessible only to parent-level organizations.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
billing_dimension_view | string | Optional | Specify 'active' for current contract mappings or 'all' for all mappings. Defaults to 'active'. |
billing_month | string | Optional | Date in ISO-8601 format (UTC) for the starting month of mappings. Defaults to the current month. |
Requirements
Output
json— Response from the API endpoint 'GetBillingDimensionMapping'.DatadogApi.GetBudgetDetails
Retrieve detailed information about a specific budget. Use this tool to get detailed information about a budget by providing the budget ID. Ideal for tracking budget allocations and spending.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
budget_identifier | string | Required | The unique identifier for the budget to retrieve details for. |
Requirements
Output
json— Response from the API endpoint 'GetBudget'.DatadogApi.GetCaseDetails
Retrieve detailed information for a specific case. This tool retrieves the details of a case using its unique identifier, `case_id`. It should be called when specific information about a case is needed, such as for review, analysis, or reporting.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
case_identifier | string | Required | The unique identifier for the case, either a UUID or a specific key, required to retrieve case details. |
Requirements
Output
json— Response from the API endpoint 'GetCase'.DatadogApi.GetCloudAccountsCoverageAnalysis
Retrieve CSM coverage analysis of your cloud accounts. Retrieve the CSM Coverage Analysis for cloud accounts to see how many are scanned for security issues.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'GetCSMCloudAccountsCoverageAnalysis'.DatadogApi.GetCloudflareAccount
Retrieve details of a Cloudflare account via Datadog. Call this tool to get information about a specific Cloudflare account linked to Datadog. Use it when you need to access account details for management or monitoring purposes.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
cloudflare_account_id | string | Required | The unique identifier for the Cloudflare account to retrieve details from. This is required to access account-specific information. |
Requirements
Output
json— Response from the API endpoint 'GetCloudflareAccount'.DatadogApi.GetCloudWorkloadSecurityAgentRuleDetails
Retrieve details of a cloud workload security agent rule. Use this tool to get information about a specific security agent rule in a cloud workload. It's specifically for the Datadog Government (US1-FED) site.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
agent_rule_identifier | string | Required | Unique identifier for the cloud workload security agent rule to retrieve details. |
Requirements
Output
json— Response from the API endpoint 'GetCloudWorkloadSecurityAgentRule'.DatadogApi.GetConfluentAccountInfo
Retrieve Confluent account information by account ID. Use this tool to obtain details for a Confluent account using its account ID. Useful for accessing specific account configurations or status within Datadog's Confluent integrations.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
confluent_account_id | string | Required | The unique identifier for the Confluent account to retrieve details from. |
Requirements
Output
json— Response from the API endpoint 'GetConfluentAccount'.DatadogApi.GetConfluentResource
Retrieve Confluent resource details for a specific account ID. Use this tool to get information about a Confluent resource linked to a specific account using the account ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
confluent_account_id | string | Required | Enter the Confluent Account ID to retrieve the resource details linked to this account. |
Requirements
Output
json— Response from the API endpoint 'ListConfluentResource'.DatadogApi.GetCsmCoverageAnalysis
Retrieve CSM coverage analysis for hosts and containers. Use this tool to obtain the CSM Coverage Analysis for your hosts and containers based on active agents with CSM features enabled.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'GetCSMHostsAndContainersCoverageAnalysis'.DatadogApi.GetCurrentArchiveOrder
Retrieve the current order of logs archives. This tool retrieves the current order of your logs archives from Datadog. Use this tool when you need to understand how archives are currently organized.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'GetLogsArchiveOrder'.DatadogApi.GetCustomAllocationRule
Retrieve a custom allocation rule by its ID. Call this tool to get detailed information about a specific custom allocation rule using its unique ID. Useful for examining allocation settings in Datadog.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
custom_allocation_rule_id | integer | Required | The unique identifier for retrieving a specific custom allocation rule in Datadog. |
Requirements
Output
json— Response from the API endpoint 'GetCustomAllocationRule'.DatadogApi.GetCustomAttributeConfigs
Retrieve all custom attribute configurations for a case type. Use this tool to fetch all custom attribute configurations associated with a specific case type. Ideal for understanding or managing attributes for various case types.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
case_type_uuid | string | Required | UUID for the case type to retrieve its custom attribute configurations. |
Requirements
Output
json— Response from the API endpoint 'GetAllCustomAttributeConfigsByCaseType'.DatadogApi.GetCustomDestination
Retrieve details of a specific custom log destination. Use this tool to get information about a specific custom destination for logs in your organization. Useful for managing and configuring log destinations effectively.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
custom_destination_id | string | Required | The ID of the custom destination to retrieve details from your organization. |
Requirements
Output
json— Response from the API endpoint 'GetLogsCustomDestination'.DatadogApi.GetCustomFramework
Retrieve a specific custom framework by handle and version. Use this tool to get details of a specific custom framework in Datadog by providing its handle and version. This is useful for accessing specific configurations or settings within cloud security management frameworks.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
framework_handle | string | Required | The unique identifier for the custom framework to retrieve. |
framework_version | string | Required | Specify the version of the framework to retrieve. Use the exact version number or identifier. |
Requirements
Output
json— Response from the API endpoint 'GetCustomFramework'.DatadogApi.GetDatadogChannelInfo
Retrieve channel ID details for Datadog MS Teams integration. Use this tool to obtain the tenant, team, and channel ID for a specific channel in the Datadog Microsoft Teams integration. Call this tool when you need to look up channel configuration details within a Datadog integration.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
datadog_channel_name | string | Required | The name of the channel in the Datadog Microsoft Teams integration. Required to retrieve channel details. |
team_name | string | Required | Specify the name of the team for which you want to retrieve channel ID details in the Datadog Microsoft Teams integration. |
tenant_name | string | Required | The name of the tenant for which you want to get the channel information in Datadog's Microsoft Teams integration. |
Requirements
Output
json— Response from the API endpoint 'GetChannelByName'.DatadogApi.GetDatadogServiceAccountAppKey
Retrieve a specific application key for a Datadog service account. Use this tool to obtain details of an application key owned by a specific Datadog service account, identified by its service account ID and application key ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
application_key_id | string | Required | The ID of the application key for the Datadog service account. |
service_account_id | string | Required | The unique identifier for the Datadog service account to retrieve the application key from. |
Requirements
Output
json— Response from the API endpoint 'GetServiceAccountApplicationKey'.DatadogApi.GetDeviceDetails
Retrieve specific device details. Call this tool to obtain detailed information about a specified device using its device ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
device_id | string | Required | The unique identifier of the device to retrieve details for. |
Requirements
Output
json— Response from the API endpoint 'GetDevice'.DatadogApi.GetDeviceInterfaces
Fetches the list of interfaces for a given device. Use this tool to obtain the list of interfaces associated with a particular device from Datadog.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
device_identifier | string | Required | The unique ID of the device to retrieve interfaces for. Expected to be a string. |
include_ip_addresses | boolean | Optional | Specify true to include IP addresses of the interfaces, or false to exclude them. |
Requirements
Output
json— Response from the API endpoint 'GetInterfaces'.DatadogApi.GetDeviceList
Retrieve a list of devices from Datadog. Use this tool to get a comprehensive list of all devices managed by the Datadog service. It retrieves data from the specified API endpoint and provides an overview of available devices.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
filter_by_tag | string | Optional | Filter devices by a specified tag. |
page_number | integer | Optional | Specific page number to return when fetching the devices list. |
page_size | integer | Optional | Specify the size for a given page, with a maximum allowed value of 100. |
sort_devices_by | string | Optional | Specify the field by which to sort the devices list. |
Requirements
Output
json— Response from the API endpoint 'ListDevices'.DatadogApi.GetDeviceUserTags
Retrieve the list of tags for a specific device. This tool calls the Datadog API to fetch user tags for a given device, identified by its ID. Use this when you need to understand or manage tags associated with a device for tracking or organizational purposes.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
device_identifier | string | Required | The unique identifier of the device to fetch tags for from Datadog. |
Requirements
Output
json— Response from the API endpoint 'ListDeviceUserTags'.DatadogApi.GetDomainAllowlist
Retrieve the domain allowlist for an organization. Use this tool to get the list of domains that are allowed within your organization's settings. It helps ensure authorized access and manage security policies.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'GetDomainAllowlist'.DatadogApi.GetDowntimeDetails
Retrieve details of a specific downtime by ID. Use this tool to get detailed information about a specific downtime in Datadog using a downtime ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
downtime_id | string | Required | The unique identifier for the downtime period to retrieve details for. |
include_related_resources | string | Optional | Comma-separated list of resource paths to include in the response. Options: `created_by`, `monitor`. |
Requirements
Output
json— Response from the API endpoint 'GetDowntime'.DatadogApi.GetErrorTrackingIssueDetails
Retrieve full details of a specific error tracking issue. Use this tool to obtain comprehensive details about an error tracking issue from Datadog, including its attributes and relationships. Ideal for understanding specific issues and investigating errors.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
issue_identifier | string | Required | The unique identifier of the error tracking issue to retrieve details for. |
include_relationship_objects | array<string> | Optional | A list of relationship objects to include in the response. Provide as an array of strings. |
Requirements
Output
json— Response from the API endpoint 'GetIssue'.DatadogApi.GetEstimatedCostDatadog
Retrieve estimated cost data for multi-org Datadog accounts. This tool retrieves the estimated cost for the current and previous month across multi-org and single root-org Datadog accounts. The data is only available for parent-level organizations and is delayed by up to 72 hours.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
cost_end_month | string | Optional | Specify the ending month for the estimated cost in ISO-8601 format, UTC (`[YYYY-MM]`). |
cost_view_level | string | Optional | Specify if cost is broken down at the parent-org level (summary) or sub-org level (sub-org). Defaults to summary. |
end_date | string | Optional | Specify the end date for cost estimation in ISO-8601 format (YYYY-MM-DD). It marks the last day of the period for which you need cost data. |
include_connected_accounts | boolean | Optional | Include accounts connected as partner customers in Datadog's partner network program. Defaults to `false`. |
initial_cost_month | string | Optional | ISO-8601 month format `[YYYY-MM]`, specifying the start month for cost data. Cannot be older than two months. Provide `end_month` for month-over-month cost. |
start_date_for_cost | string | Optional | Datetime in ISO-8601 format, UTC, precise to day: `[YYYY-MM-DD]` for cost beginning this day. Either specify `start_date_for_cost` or `start_month_for_cost`, but not both. The date cannot be more than two months in the past. Use with `end_date_for_cost` for cumulative day-over-day cost. |
Requirements
Output
json— Response from the API endpoint 'GetEstimatedCostByOrg'.DatadogApi.GetEventDetails
Retrieve detailed information about a specific event. Use this tool to get detailed information about an event by providing its unique event ID. It is useful for obtaining specifics about incidents or activities tracked in Datadog.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
event_unique_id | string | Required | The unique identifier of the event to retrieve details for. This should be a string representing the event's UID. |
Requirements
Output
json— Response from the API endpoint 'GetEvent'.DatadogApi.GetFastlyAccountInfo
Retrieves detailed information for a specific Fastly account. Use this tool to obtain details about a specific Fastly account integrated with Datadog.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
fastly_account_id | string | Required | The unique identifier for the Fastly account to retrieve information about. |
Requirements
Output
json— Response from the API endpoint 'GetFastlyAccount'.DatadogApi.GetFastlyServiceInfo
Retrieve Fastly service details for a specific account. Call this tool to get information about a Fastly service linked to a Datadog account using the account ID and the service ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
fastly_account_id | string | Required | The unique ID of the Fastly account for which to retrieve service details. |
fastly_service_id | string | Required | The ID of the Fastly service to retrieve details for, linked to the specified account. |
Requirements
Output
json— Response from the API endpoint 'GetFastlyService'.DatadogApi.GetFutureRuleSuppressions
Retrieve suppressions affecting a future security rule. Use this tool to get a list of suppressions that would impact a specified security monitoring rule in the future. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'GetSuppressionsAffectingFutureRule'.DatadogApi.GetGcpStsDelegate
Retrieve the Datadog-GCP STS delegate account configuration. Use this tool to list the configured GCP STS delegate account in your Datadog account. It provides information about the integration between Datadog and Google Cloud Platform for security token service (STS) delegation.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'GetGCPSTSDelegate'.DatadogApi.GetGcpUsageCostConfig
Retrieve specific Google Cloud Usage Cost configuration details. The tool retrieves a specific Google Cloud Usage Cost configuration using the provided cloud account ID. It is useful for obtaining cost configurations related to Google Cloud usage in Datadog.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
cloud_account_identifier | integer | Required | The unique identifier of the Google Cloud account for which to retrieve the usage cost configuration. |
Requirements
Output
json— Response from the API endpoint 'GetCostGCPUsageCostConfig'.DatadogApi.GetHistoricalCostByOrg
Retrieve historical cost data across different organizations. This tool retrieves historical cost data for multi-org and single root-org accounts from Datadog. The cost data for a given month becomes available by the 16th of the following month. Accessible only for parent-level organizations.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
start_month_utc | string | Required | ISO-8601 date format `[YYYY-MM]`, UTC timezone, to specify the start month for cost calculation. |
cost_view_level | string | Optional | Specify cost breakdown level: 'summary' for parent-org or 'sub-org' for sub-org level. Defaults to 'summary'. |
end_month | string | Optional | Datetime in ISO-8601 format, UTC, precise to month `[YYYY-MM]` indicating the ending month for cost data. |
include_connected_accounts | boolean | Optional | Include accounts connected as partner customers in Datadog's network. Defaults to false. |
Requirements
Output
json— Response from the API endpoint 'GetHistoricalCostByOrg'.DatadogApi.GetHistoricalJobDetails
Retrieve details of a specific historical job from Datadog. Use this tool to get the details of a specific historical job from Datadog's SIEM historical detections by providing the job ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
job_id | string | Required | The unique identifier for the job whose details you want to retrieve. |
Requirements
Output
json— Response from the API endpoint 'GetHistoricalJob'.DatadogApi.GetHistoricalSecuritySignals
Retrieve historical security signals by job ID. Use this tool to obtain historical security signals associated with a specific job ID in the Datadog system.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
job_identifier | string | Required | The unique identifier for the job whose historical security signals you want to retrieve. |
max_security_signals | integer | Optional | The maximum number of security signals to retrieve in the response. |
max_timestamp_for_signals | string | Optional | The latest timestamp for the requested security signals. |
minimum_timestamp | string | Optional | The earliest timestamp for retrieving security signals. Format should be ISO 8601 (e.g., '2023-10-01T00:00:00Z'). |
pagination_cursor | string | Optional | Use the cursor from the previous query to paginate results. |
security_signal_search_query | string | Optional | The search query to filter security signals. |
signal_sort_order | string | Optional | Specify the sort order of the security signals, either 'timestamp' for ascending or '-timestamp' for descending. |
Requirements
Output
json— Response from the API endpoint 'GetSecurityMonitoringHistsignalsByJobId'.DatadogApi.GetHistSignalDetails
Retrieve details of a specific hist signal. This tool fetches detailed information about a specified hist signal from Datadog's SIEM (Security Information and Event Management) service. It should be used when you need to access detailed data on a particular historical signal for security monitoring purposes.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
historical_signal_id | string | Required | The ID of the historical signal to retrieve details for. |
Requirements
Output
json— Response from the API endpoint 'GetSecurityMonitoringHistsignal'.DatadogApi.GetHourlyUsageByProductFamily
Fetch hourly usage data by product family from Datadog. Use this tool to retrieve detailed hourly usage metrics categorized by product family from Datadog. Ideal for monitoring and analysis applications that require precise usage insights.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
product_families_to_retrieve | string | Required | Comma-separated list of product families to retrieve usage data for. Available options include all, analyzed_logs, application_security, etc. Note: audit_logs is deprecated. |
start_timestamp | string | Required | Datetime in ISO-8601 format, UTC, precise to hour. Specify the start of usage collection, e.g., '2023-10-05T14'. |
end_timestamp | string | Optional | Datetime in ISO-8601 format (UTC) for usage ending before this hour. Format: [YYYY-MM-DDThh]. |
include_connected_accounts | boolean | Optional | Include accounts connected as partner customers in the response. Defaults to false. |
include_descendants_usage | boolean | Optional | Include child organization usage in the response. Set to true to include, false to exclude. |
include_usage_breakdown | boolean | Optional | Boolean to include breakdown of usage by subcategories for product family logs. Defaults to false. |
maximum_results_limit | integer | Optional | Set the maximum number of results to return per page, between 1 and 500. Defaults to 500. |
next_record_id | string | Optional | ID to continue listing results from the last query. Use the ID from previous queries to paginate through results. |
product_family_versions | string | Optional | Comma-separated list of product family versions in the format `product_family:version`. Defaults to latest if not specified. |
Requirements
Output
json— Response from the API endpoint 'GetHourlyUsage'.DatadogApi.GetIncidentAttachments
Retrieve all attachments for a specified incident. This tool retrieves all files and documents attached to a particular incident. It should be called when details about the attachments associated with an incident are needed.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
incident_uuid | string | Required | The unique identifier (UUID) of the incident whose attachments are to be retrieved. |
attachment_types_to_include | array<string> | Optional | List the types of attachments to include in the response. Each type should be a string. |
include_related_objects | array<string> | Optional | A list of related object types to include in the response, such as 'user', 'tags'. |
Requirements
Output
json— Response from the API endpoint 'ListIncidentAttachments'.DatadogApi.GetIncidentDetails
Retrieve details of a specific incident using its ID. Use this tool to obtain detailed information about a specific incident by providing the incident ID. It retrieves all the necessary details from the Datadog service.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
incident_uuid | string | Required | The UUID of the incident to retrieve its details. |
include_related_objects | array<string> | Optional | Specify related object types to include in the response, such as users, logs, etc. |
Requirements
Output
json— Response from the API endpoint 'GetIncident'.DatadogApi.GetIncidentImpacts
Retrieve all impacts for a specified incident. Use this tool to fetch all impact details associated with a particular incident, providing insight into the effects and scope of the incident.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
incident_uuid | string | Required | The unique UUID of the incident to retrieve impacts for. |
include_related_resources | array<string> | Optional | Specify which related resources to include in the response as an array of strings. |
Requirements
Output
json— Response from the API endpoint 'ListIncidentImpacts'.DatadogApi.GetIncidentIntegrationDetails
Fetches details of incident integration metadata. Use this tool to obtain detailed metadata about a specific incident integration within Datadog, using the incident ID and integration metadata ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
incident_integration_metadata_uuid | string | Required | The UUID of the incident integration metadata required to fetch its details. |
incident_uuid | string | Required | The UUID of the incident in Datadog for which to obtain integration metadata. |
Requirements
Output
json— Response from the API endpoint 'GetIncidentIntegration'.DatadogApi.GetIncidentIntegrations
Retrieve integration metadata for a specific incident. Use this tool to get all the integration metadata associated with a particular incident. It helps in understanding how different integrations are linked to an incident.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
incident_uuid | string | Required | The unique UUID of the incident to retrieve integration metadata. |
Requirements
Output
json— Response from the API endpoint 'ListIncidentIntegrations'.DatadogApi.GetIncidentNotificationRule
Retrieve details of a specific incident notification rule. This tool retrieves a specific incident notification rule from Datadog by its ID. It should be called when there is a need to obtain detailed information about a particular notification rule used in incident management.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
notification_rule_id | string | Required | The unique identifier for the notification rule to retrieve details. |
include_resources | string | Optional | Comma-separated list of resources to include in the response. Options: `created_by_user`, `last_modified_by_user`, `incident_type`, `notification_template`. |
Requirements
Output
json— Response from the API endpoint 'GetIncidentNotificationRule'.DatadogApi.GetIncidentNotificationTemplate
Retrieve a specific incident notification template by ID. Use this tool to get details of a specific incident notification template from Datadog by providing its ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
template_id | string | Required | The ID of the notification template to retrieve from Datadog. |
include_relationships | string | Optional | Comma-separated list of relationships to include. Supported values: `created_by_user`, `last_modified_by_user`, `incident_type`. |
Requirements
Output
json— Response from the API endpoint 'GetIncidentNotificationTemplate'.DatadogApi.GetIncidentTodoDetails
Retrieve details of an incident todo item from Datadog. Use this tool to obtain specific details about a todo item related to an incident in Datadog. It should be called when detailed information about an incident's todo component is needed.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
incident_todo_uuid | string | Required | The UUID of the incident todo to fetch details for. This is essential for identifying the specific todo item linked to an incident. |
incident_uuid | string | Required | The UUID of the incident to get the todo details for. |
Requirements
Output
json— Response from the API endpoint 'GetIncidentTodo'.DatadogApi.GetIncidentTypeDetails
Retrieve details of a specific incident type. Use this tool to obtain detailed information about a specific incident type from Datadog.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
incident_type_uuid | string | Required | The UUID of the specific incident type to retrieve details for. |
Requirements
Output
json— Response from the API endpoint 'GetIncidentType'.DatadogApi.GetIncidentTypes
Retrieve all incident types from Datadog. This tool calls the Datadog API to list all available incident types. Use it to get information about the types of incidents configured in the system.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
include_deleted | boolean | Optional | Include deleted incident types in the response when set to true. |
Requirements
Output
json— Response from the API endpoint 'ListIncidentTypes'.DatadogApi.GetIpAllowlist
Retrieve the IP allowlist and its status. Use this tool to obtain the current IP allowlist and check whether it is enabled or disabled.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'GetIPAllowlist'.DatadogApi.GetLogBasedMetric
Retrieve a specific log-based metric from Datadog. Use this tool to access detailed information about a specific log-based metric from your Datadog account. This is useful for monitoring and analyzing your organization's log metrics.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
log_based_metric_name | string | Required | The name of the log-based metric to retrieve from Datadog. |
Requirements
Output
json— Response from the API endpoint 'GetLogsMetric'.DatadogApi.GetLogsMetricsList
Retrieve a list of log-based metrics and their definitions. Use this tool to obtain the list of configured log-based metrics from Datadog, along with their definitions. This can be helpful for monitoring and analyzing log data.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'ListLogsMetrics'.DatadogApi.GetMetricTagCardinality
Retrieve cardinality details of tags for a specific metric. This tool is used to get the cardinality details of tags associated with a specific metric in Datadog. It's useful for understanding the distribution and uniqueness of tags related to the specified metric.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
metric_name | string | Required | The name of the metric for which cardinality details of tags are to be retrieved. |
Requirements
Output
json— Response from the API endpoint 'GetMetricTagCardinalityDetails'.DatadogApi.GetMetricTagConfiguration
Retrieve the tag configuration for a specific metric. Use this tool to fetch the tag configuration associated with a specific metric name in Datadog. This is helpful for accessing detailed tagging information for metrics.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
metric_name | string | Required | The name of the metric for which to retrieve the tag configuration in Datadog. |
Requirements
Output
json— Response from the API endpoint 'ListTagConfigurationByName'.DatadogApi.GetMonitorConfigurationPolicy
Retrieve a monitor's configuration policy using its ID. This tool fetches detailed information about a specific monitor configuration policy from Datadog using the policy ID. It should be called when you need to access the configuration details of a monitor policy.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
monitor_policy_id | string | Required | ID of the monitor configuration policy to retrieve details for. |
Requirements
Output
json— Response from the API endpoint 'GetMonitorConfigPolicy'.DatadogApi.GetMonitorNotificationRule
Retrieve a monitor notification rule by its ID. Use this tool to fetch details of a specific monitor notification rule in Datadog by providing the rule ID. It can be useful for checking the configuration of alerting and notification rules.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
monitor_rule_id | string | Required | ID of the monitor notification rule to fetch. This is required to retrieve specific rule details. |
include_related_resources | string | Optional | Comma-separated list of related resource paths to include in the response, such as `created_by`. |
Requirements
Output
json— Response from the API endpoint 'GetMonitorNotificationRule'.DatadogApi.GetMonitorNotificationRules
Retrieve all monitor notification rules from Datadog. Call this tool to get a comprehensive list of all monitor notification rules configured in Datadog.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
filter_criteria | string | Optional | JSON string to filter rules by text, tags, or recipients. Use keys: `text`, `tags`, `recipients`. |
include_related_resources | string | Optional | Specify related resources to include in the response, such as `created_by`. Use a comma-separated list. |
number_of_rules_per_page | integer | Optional | The number of rules to return per page. Defaults to 100 if not specified. |
sort_order | string | Optional | String for sort order. Example: `name:asc`. Directions: `asc`, `desc`. Fields: `name`, `created_at`. |
starting_page_number | integer | Optional | The page number to begin pagination. Defaults to the first page if not specified. |
Requirements
Output
json— Response from the API endpoint 'GetMonitorNotificationRules'.DatadogApi.GetMonitorUserTemplate
Retrieve a monitor user template by ID from Datadog. Use this tool to get detailed information about a specific monitor user template in Datadog by providing the template ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
template_id | string | Required | The unique identifier for the specific monitor user template to retrieve. |
include_all_versions | boolean | Optional | Include all versions of the template in the response if true. |
Requirements
Output
json— Response from the API endpoint 'GetMonitorUserTemplate'.DatadogApi.GetMsTeamsWorkflowWebhookName
Retrieve the name of a MS Teams workflow webhook handle. Use this tool to get the name of a Microsoft Teams Workflows webhook handle using the Datadog integration. Useful for managing or verifying webhook configurations.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
workflow_webhook_handle_id | string | Required | The ID of the Workflows webhook handle to retrieve the name for. This is specific to the Datadog Microsoft Teams integration. |
Requirements
Output
json— Response from the API endpoint 'GetWorkflowsWebhookHandle'.DatadogApi.GetOktaAccountInfo
Retrieve detailed information about a specific Okta account. This tool fetches details of an Okta account using the given account ID. It should be called when detailed information about an Okta account is required.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
okta_account_id | string | Required | The unique identifier for the Okta account to retrieve information for. |
Requirements
Output
json— Response from the API endpoint 'GetOktaAccount'.DatadogApi.GetOnCallEscalationPolicy
Retrieve details of an On-Call escalation policy. This tool is used to retrieve information about a specific on-call escalation policy from Datadog. It should be called when there's a need to understand the configuration or details of an on-call policy by providing the policy ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
escalation_policy_id | string | Required | The unique identifier for the on-call escalation policy to retrieve. |
include_relationships | string | Optional | A comma-separated list of relationships to include in the response. Allowed values: `teams`, `steps`, `steps.targets`. |
Requirements
Output
json— Response from the API endpoint 'GetOnCallEscalationPolicy'.DatadogApi.GetOnCallSchedule
Retrieve an On-Call schedule from Datadog. Use this tool to access detailed information regarding a specific On-Call schedule in Datadog by providing the schedule ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
schedule_id | string | Required | The unique ID of the on-call schedule to be retrieved. |
include_relationships | string | Optional | Comma-separated list of relationships to include in the response. Options: `teams`, `layers`, `layers.members`, `layers.members.user`. |
Requirements
Output
json— Response from the API endpoint 'GetOnCallSchedule'.DatadogApi.GetOnCallUser
Retrieve the current on-call user for a specific schedule. Use this tool to find out which user is currently on-call for a given schedule. It is helpful for monitoring and response teams to know who is available at any given moment.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
schedule_id | string | Required | The unique ID of the schedule to retrieve the on-call user from. |
include_related_resources | string | Optional | Specifies related resources to include in the response. Use 'user' to include user details. |
timestamp_for_on_call_user | string | Optional | Retrieves the on-call user at the specified timestamp (ISO-8601). Defaults to current time if omitted. |
Requirements
Output
json— Response from the API endpoint 'GetScheduleOnCallUser'.DatadogApi.GetOnDemandConcurrencyCap
Retrieve the on-demand concurrency cap value from Datadog. Use this tool to get the current on-demand concurrency cap configured in Datadog's synthetics settings. This information can help monitor and manage concurrency limits effectively.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'GetOnDemandConcurrencyCap'.DatadogApi.GetOpsgenieService
Retrieve a single Opsgenie service from Datadog. This tool retrieves details about a specific service integrated with Datadog's Opsgenie. Use it to access information about service configurations or to manage operational alerts.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
service_uuid | string | Required | The UUID of the Datadog Opsgenie service to retrieve. |
Requirements
Output
json— Response from the API endpoint 'GetOpsgenieService'.DatadogApi.GetOrganizationConfigDetails
Retrieve organization configuration details by name. Fetches the name, description, and value of a specific organization configuration from Datadog, identified by its name.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_config_name | string | Required | The name of the organization configuration to retrieve details for. |
Requirements
Output
json— Response from the API endpoint 'GetOrgConfig'.DatadogApi.GetOrganizationRole
Retrieve details of a role using its role ID in the organization. This tool gets details of a specific role within an organization by using the role's unique ID. It is useful for obtaining role-specific information needed for organizational management or role auditing.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
role_id | string | Required | The unique identifier of the role in the organization. |
Requirements
Output
json— Response from the API endpoint 'GetRole'.DatadogApi.GetPowerpack
Retrieve details of a specific powerpack. This tool should be called to obtain detailed information about a specific powerpack by providing its ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
powerpack_identifier | string | Required | The unique identifier for the desired powerpack, used to retrieve its details. |
Requirements
Output
json— Response from the API endpoint 'GetPowerpack'.DatadogApi.GetProjectDetails
Retrieve details of a specific project using project ID. Use this tool to obtain comprehensive details about a particular project by providing the project's ID, utilizing the Datadog API.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
project_uuid | string | Required | The unique identifier (UUID) of the project for which details are required. |
Requirements
Output
json— Response from the API endpoint 'GetProject'.DatadogApi.GetProjectedCost
Retrieve projected cost for multi-org and single root-org accounts. This tool fetches projected cost data, available for the current month, for multi-org and single root-org accounts, becoming accessible around the 12th of the month. It's used for parent-level organizations.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
cost_view_level | string | Optional | Specify cost breakdown level: `summary` for parent-org or `sub-org` for sub-org level. Defaults to `summary`. |
include_connected_accounts | boolean | Optional | Include accounts connected as partner customers in the Datadog partner network. Defaults to `false`. |
Requirements
Output
json— Response from the API endpoint 'GetProjectedCost'.DatadogApi.GetReferenceTable
Retrieve details of a reference table by its ID. Use this tool to fetch information about a specific reference table in Datadog using its unique ID. This is helpful for accessing configuration or metadata details related to the table.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
reference_table_id | string | Required | The unique ID of the reference table to retrieve details from Datadog. |
Requirements
Output
json— Response from the API endpoint 'GetTable'.DatadogApi.GetRestrictionQuery
Retrieve a restriction query by its ID within Datadog. Use this tool to access the details of a specific restriction query in your Datadog organization by providing the `restriction_query_id`.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
restriction_query_id | string | Required | The unique identifier for the restriction query to retrieve its details. |
Requirements
Output
json— Response from the API endpoint 'GetRestrictionQuery'.DatadogApi.GetRestrictionQueryRoles
Retrieve roles associated with a specific restriction query. This tool fetches all roles that are linked to a specified restriction query within Datadog. Use this when you need to identify which roles have permissions based on a specific restriction query.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
restriction_query_id | string | Required | The unique identifier of the restriction query to fetch associated roles. |
page_number | integer | Optional | The specific page number to return in the response. Use this to navigate through paginated results. |
page_size | integer | Optional | Specify the number of results per page. The maximum allowed value is 100. |
Requirements
Output
json— Response from the API endpoint 'ListRestrictionQueryRoles'.DatadogApi.GetRoleRestrictionQuery
Retrieve the restriction query for a specific role. Use this tool to get the restriction query details associated with a specific role in Datadog. The tool fetches information relevant to access restrictions for the role identified.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
role_id | string | Required | The unique identifier for the role whose restriction query you want to retrieve. |
Requirements
Output
json— Response from the API endpoint 'GetRoleRestrictionQuery'.DatadogApi.GetRuleVersionHistory
Retrieve a rule's version history. Use this tool to obtain the version history of a specific security monitoring rule by its ID in Datadog.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
rule_id | string | Required | The unique identifier for the rule. Required to fetch its version history in Datadog. |
page_number | integer | Optional | The specific page number to return in the results. |
page_size | integer | Optional | Size for a given page, maximum value is 100. |
Requirements
Output
json— Response from the API endpoint 'GetRuleVersionHistory'.DatadogApi.GetRumApplicationById
Retrieve RUM application details by ID. Use this tool to obtain details about a RUM application within your organization by specifying its ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
rum_application_id | string | Required | The ID of the RUM application to retrieve details for. This is a required string value. |
Requirements
Output
json— Response from the API endpoint 'GetRUMApplication'.DatadogApi.GetRumMetric
Retrieve a specific RUM-based metric for your organization. Call this tool to get detailed data about a specific Real User Monitoring (RUM) metric identified by its metric ID from your organization on Datadog.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
metric_identifier | string | Required | The unique identifier for the RUM-based metric you want to retrieve from your organization. |
Requirements
Output
json— Response from the API endpoint 'GetRumMetric'.DatadogApi.GetRumRetentionFilter
Retrieve a RUM retention filter for a RUM application. Fetches details of a specific RUM retention filter for a given RUM application based on its ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
retention_filter_id | string | Required | The ID of the retention filter to retrieve for a RUM application. |
rum_application_id | string | Required | The unique identifier for the RUM application. Required to fetch the retention filter. |
Requirements
Output
json— Response from the API endpoint 'GetRetentionFilter'.DatadogApi.GetRumRetentionFilters
Retrieve RUM retention filters for a specific application. Use this tool to obtain the list of RUM retention filters for a given RUM application by specifying its application ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
rum_application_id | string | Required | The unique identifier for the RUM application to retrieve retention filters. |
Requirements
Output
json— Response from the API endpoint 'ListRetentionFilters'.DatadogApi.GetSecurityFilterDetails
Retrieve the details of a specific security filter. Use this tool to get detailed information about a security filter in Datadog's security monitoring configuration. Ideal for understanding specific filter configurations and settings.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
security_filter_id | string | Required | The unique identifier for the security filter to retrieve details for. |
Requirements
Output
json— Response from the API endpoint 'GetSecurityFilter'.DatadogApi.GetSecurityFinding
Retrieve details of a specific security finding for analysis. This tool retrieves the message and resource configuration details of a specified security finding, helping in security analysis and incident response.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
finding_id | string | Required | The unique ID of the security finding to retrieve details for. |
snapshot_unix_timestamp | integer | Optional | Return the finding for a specific snapshot in time, given in Unix milliseconds. |
Requirements
Output
json— Response from the API endpoint 'GetFinding'.DatadogApi.GetSecurityMonitoringRuleDetails
Retrieve detailed information about a specific security rule. Use this tool to get comprehensive details about a security monitoring rule by specifying its ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
security_rule_id | string | Required | The unique identifier for the security monitoring rule you want to retrieve details for. |
Requirements
Output
json— Response from the API endpoint 'GetSecurityMonitoringRule'.DatadogApi.GetSecuritySignalDetails
Retrieve details of a security monitoring signal. This tool is used to obtain detailed information about a specific security monitoring signal in Datadog. It should be called when you need to understand the context or specifics of a particular signal identified by its unique signal ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
signal_id | string | Required | The unique identifier for the security monitoring signal to retrieve details for. This ID is used to specify which signal's details to fetch. |
Requirements
Output
json— Response from the API endpoint 'GetSecurityMonitoringSignal'.DatadogApi.GetServerlessCoverageAnalysis
Retrieve CSM serverless coverage analysis data from Datadog. This tool fetches the CSM Coverage Analysis for serverless resources in Datadog, determined by the number of agents with CSM features enabled.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'GetCSMServerlessCoverageAnalysis'.DatadogApi.GetServiceDefinition
Retrieve a service definition from Datadog's Service Catalog. Call this tool to obtain specific details about a service defined in the Datadog Service Catalog. Useful for monitoring and managing services.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
service_name | string | Required | The exact name of the service to retrieve from Datadog's Service Catalog. |
desired_schema_version | string | Optional | Specify the schema version for the response. Options: 'v1', 'v2', 'v2.1', 'v2.2'. |
Requirements
Output
json— Response from the API endpoint 'GetServiceDefinition'.DatadogApi.GetServiceDefinitions
Retrieve all service definitions from the Datadog Service Catalog. Use this tool to get a comprehensive list of service definitions from Datadog's Service Catalog. Ideal for scenarios where service information retrieval is required.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
page_number | integer | Optional | The specific page number to retrieve from the service definitions list. |
page_size | integer | Optional | Specify the number of items per page. The maximum allowed value is 100. |
response_schema_version | string | Optional | Specifies the version of the schema to be returned in the response. Acceptable values are 'v1', 'v2', 'v2.1', or 'v2.2'. |
Requirements
Output
json— Response from the API endpoint 'ListServiceDefinitions'.DatadogApi.GetSingleTeamInfo
Retrieve details of a team using its ID. Use this tool to obtain details about a specific team by providing the team's ID. Ideal for applications needing team-specific information.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
team_id | string | Required | The unique identifier for the team. Provide this to retrieve specific team details. |
Requirements
Output
json— Response from the API endpoint 'GetTeam'.DatadogApi.GetSloReportStatus
Retrieve the status of a specific SLO report job. Use this tool to check the current status of a Service Level Objective (SLO) report job by providing the report ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
slo_report_id | string | Required | The unique identifier of the SLO report job to check its current status. |
Requirements
Output
json— Response from the API endpoint 'GetSLOReportJobStatus'.DatadogApi.GetSpanMetric
Retrieve a specific span-based metric from Datadog. Use this tool to get detailed information on a particular span-based metric from your Datadog organization. Ideal for accessing span metrics data by specifying the metric ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
metric_name | string | Required | The name of the span-based metric to be retrieved from Datadog. |
Requirements
Output
json— Response from the API endpoint 'GetSpansMetric'.DatadogApi.GetSparkJobRecommendations
Retrieve resource recommendations for a Spark job. Use this tool to obtain structured recommendations for Spark job driver and executor resources, based on specified service name and shard identifier.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
spark_job_service_name | string | Required | The service name for the Spark job to retrieve recommendations. |
spark_job_shard_identifier | string | Required | The shard identifier for a Spark job, differentiating jobs within the same service with distinct resource requirements. |
Requirements
Output
json— Response from the API endpoint 'GetSPARecommendations'.DatadogApi.GetSpecificLogsArchive
Retrieve a specific logs archive from Datadog. Use this tool to get a specific archive of logs from your Datadog organization by providing the archive ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
archive_id | string | Required | The unique identifier for the logs archive to retrieve from Datadog. |
Requirements
Output
json— Response from the API endpoint 'GetLogsArchive'.DatadogApi.GetSpecificPipelineById
Retrieve specific pipeline details by ID. Use this tool to get details of a specific pipeline by providing its ID. It fetches the configuration and status of the pipeline from Datadog.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
pipeline_id | string | Required | The unique ID of the pipeline to retrieve from Datadog. |
Requirements
Output
json— Response from the API endpoint 'GetPipeline'.DatadogApi.GetSuppressionRuleDetails
Get details of a specific security suppression rule. Fetch the details of a suppression rule by providing the suppression ID. Useful for understanding the configuration and parameters of a specific rule in the security monitoring system.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
suppression_rule_id | string | Required | The unique ID of the suppression rule you wish to retrieve details for. |
Requirements
Output
json— Response from the API endpoint 'GetSecurityMonitoringSuppression'.DatadogApi.GetSuppressionsForRule
Retrieve suppressions affecting a specific rule by ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
rule_id | string | Required | The unique identifier of the specific rule for which to retrieve suppressions. |
Requirements
Output
json— Response from the API endpoint 'GetSuppressionsAffectingRule'.DatadogApi.GetTableRowsById
Retrieve reference table rows using primary key values. Call this tool to access rows from a Datadog reference table by specifying their primary key values. It's useful for obtaining specific entries in the table.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
reference_table_id | string | Required | The unique ID of the reference table to retrieve rows from. |
row_ids_to_retrieve | array<string> | Required | List of primary key values to specify which rows to retrieve from the reference table. |
Requirements
Output
json— Response from the API endpoint 'GetRowsByID'.DatadogApi.GetTagPipelineRuleset
Retrieve a specific tag pipeline ruleset by its ID. Use this tool to get detailed information about a specific tag pipeline ruleset within Datadog by providing its ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
ruleset_identifier | string | Required | The unique identifier for the tag pipeline ruleset to retrieve. |
Requirements
Output
json— Response from the API endpoint 'GetTagPipelinesRuleset'.DatadogApi.GetTeamLink
Retrieve a specific link for a team. Use this tool to get detailed information about a specific link associated with a team in Datadog.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
link_id | string | Required | The unique identifier for the specific link you want to retrieve for a team in Datadog. |
team_id | string | Required | The unique identifier for the team whose link you want to retrieve. |
Requirements
Output
json— Response from the API endpoint 'GetTeamLink'.DatadogApi.GetTeamMembers
Retrieve a list of team members. Retrieve a paginated list of members for a specified team using their team ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
team_id | string | Required | The unique identifier for the team whose members are to be retrieved. |
page_number | integer | Optional | The specific page number to retrieve from the list of team members. |
page_size | integer | Optional | Specify the number of team members to return per page. Maximum is 100. |
search_query | string | Optional | Search query for filtering members by user email or name. |
sort_order | string | Optional | Specify the order of returned team memberships. Options include 'manager_name', '-manager_name', 'name', '-name', 'handle', '-handle', 'email', '-email'. |
Requirements
Output
json— Response from the API endpoint 'GetTeamMemberships'.DatadogApi.GetTeamOnCallRoutingRules
Retrieve a team's on-call routing rules from Datadog. Use this tool to obtain the on-call routing rules for a specific team in Datadog by providing the team ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
team_identifier | string | Required | The unique identifier for the team whose on-call routing rules are to be retrieved. |
include_relationships | string | Optional | Comma-separated list of relationships to return, such as `rules` or `rules.policy`. |
Requirements
Output
json— Response from the API endpoint 'GetOnCallTeamRoutingRules'.DatadogApi.GetTeamOnCallUsers
Retrieve on-call users for a specific team. Fetch the list of users who are on-call for a specified team at a given time using Datadog's API.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
team_id | string | Required | The unique identifier for the team whose on-call users are being retrieved. |
include_relationships | string | Optional | Comma-separated list of relationships to include in the response: `responders`, `escalations`, `escalations.responders`. |
Requirements
Output
json— Response from the API endpoint 'GetTeamOnCallUsers'.DatadogApi.GetTeamPermissionSettings
Retrieve permission settings for a specific team. Call this tool to obtain all permission settings associated with a specific team in Datadog. Ideal for checking or managing team permissions.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
team_identifier | string | Required | The unique identifier for the team whose permission settings are to be retrieved. |
Requirements
Output
json— Response from the API endpoint 'GetTeamPermissionSettings'.DatadogApi.GetTeamsIntegrationInfo
Retrieve tenant, team, and channel info for a handle. This tool gets the tenant, team, and channel information for a specified tenant-based handle from the Datadog Microsoft Teams integration. It should be called to obtain detailed configuration data related to a specific integration handle.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
tenant_handle_id | string | Required | The tenant-based handle ID for the Microsoft Teams integration used to retrieve tenant, team, and channel information. |
Requirements
Output
json— Response from the API endpoint 'GetTenantBasedHandle'.DatadogApi.GetThreatProtectionAgentRule
Retrieve details of a specific Workload Protection agent rule. Use this tool to get information about a particular Workload Protection agent rule in Datadog. Note: This functionality is unavailable for the US1-FED site.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
agent_rule_id | string | Required | The unique identifier for the specific Agent rule to retrieve details for. |
agent_policy_id | string | Optional | The ID of the agent policy to retrieve the specific rule for. |
Requirements
Output
json— Response from the API endpoint 'GetCSMThreatsAgentRule'.DatadogApi.GetUserApplicationKey
Retrieve an application key owned by the current user. Use this tool to obtain details about a specific application key that belongs to the currently authenticated Datadog user.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
application_key_id | string | Required | The ID of the application key to retrieve, owned by the current user. |
Requirements
Output
json— Response from the API endpoint 'GetCurrentUserApplicationKey'.DatadogApi.GetUserDetails
Retrieve details of a specific user by their user ID. Use this tool to access detailed information about a user in your organization by specifying their unique user ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
user_id | string | Required | The unique identifier for the user whose details are being retrieved. |
Requirements
Output
json— Response from the API endpoint 'GetUser'.DatadogApi.GetUserInvitation
Retrieve a user invitation using its UUID. Use this tool to obtain details of a specific user invitation from Datadog by providing the unique identifier (UUID).
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
user_invitation_uuid | string | Required | The unique UUID of the user invitation required to retrieve its details. |
Requirements
Output
json— Response from the API endpoint 'GetInvitation'.DatadogApi.GetUserMemberships
Retrieve a user's memberships from Datadog. This tool fetches a list of group memberships for a specified user using their UUID in Datadog's system.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
user_uuid | string | Required | The unique identifier for the user whose memberships are to be retrieved. |
Requirements
Output
json— Response from the API endpoint 'GetUserMemberships'.DatadogApi.GetUserOrganizations
Retrieve a user's organizations and information. Use this tool to get information about a specific user and list all the organizations they have joined. Useful for understanding user affiliations within Datadog.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
user_identifier | string | Required | The unique ID of the user whose organizations and information are to be retrieved. |
Requirements
Output
json— Response from the API endpoint 'ListUserOrganizations'.DatadogApi.GetUserPermissions
Retrieve a user's permissions from Datadog. This tool fetches the permissions assigned to a user based on their roles in Datadog. It should be called when you need to know the specific access rights a user has.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
user_identifier | string | Required | The unique identifier for the Datadog user whose permissions you want to retrieve. |
Requirements
Output
json— Response from the API endpoint 'ListUserPermissions'.DatadogApi.GetUserRestrictionQueries
Retrieve restriction queries for a specific user. Use this tool to get all restriction queries associated with a specified user in Datadog.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
user_identifier | string | Required | The unique ID of the user for retrieving restriction queries. |
Requirements
Output
json— Response from the API endpoint 'ListUserRestrictionQueries'.DatadogApi.GetWafCustomRuleById
Retrieve a WAF custom rule by ID from Datadog. Use this tool to obtain details of a specific Web Application Firewall (WAF) custom rule from Datadog by providing the rule's ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
custom_rule_id | string | Required | The unique identifier for the WAF custom rule to retrieve from Datadog. |
Requirements
Output
json— Response from the API endpoint 'GetApplicationSecurityWafCustomRule'.DatadogApi.GetWafExclusionFilter
Retrieve a specific WAF exclusion filter by ID. Use this tool to obtain details about a specific Web Application Firewall (WAF) exclusion filter by providing its unique identifier.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
waf_exclusion_filter_id | string | Required | The unique identifier of the WAF exclusion filter to retrieve. |
Requirements
Output
json— Response from the API endpoint 'GetApplicationSecurityWafExclusionFilter'.DatadogApi.GetWorkflowById
Retrieve workflow details using a unique ID. Use this tool to get detailed information about a specific workflow by providing its unique ID. This is useful for tracking and managing workflows within Datadog.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
workflow_identifier | string | Required | The unique ID of the workflow to retrieve details for within Datadog. |
Requirements
Output
json— Response from the API endpoint 'GetWorkflow'.DatadogApi.GetWorkflowInstance
Retrieve a specific workflow execution instance. Fetches details of a specific execution for a given Datadog workflow. Requires proper application key registration or permissions setup.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
workflow_id | string | Required | The unique identifier of the workflow to retrieve its specific execution details. |
workflow_instance_id | string | Required | The ID of the specific workflow instance to retrieve. |
Requirements
Output
json— Response from the API endpoint 'GetWorkflowInstance'.DatadogApi.GetWorkloadProtectionPolicyDetails
Get details of a specific Workload Protection policy. Fetches information about a specific Workload Protection policy from Datadog. Note that this endpoint is not available for the Government (US1-FED) site.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
agent_policy_id | string | Required | The unique ID of the Workload Protection Agent policy to retrieve details for. |
Requirements
Output
json— Response from the API endpoint 'GetCSMThreatsAgentPolicy'.DatadogApi.ListActiveMetricConfigurations
Retrieve active metric tags and aggregations for a given metric name. Use this tool to get the currently active tags and aggregations for dashboards, monitors, and APIs associated with a specified metric name. It helps to understand how metrics are being actively used across various platforms.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
metric_name | string | Required | Specify the name of the metric to retrieve active tags and aggregations for. |
lookback_seconds | integer | Optional | Number of seconds to look back from the current time. Defaults to 604800 seconds (1 week). Minimum is 7200 seconds (2 hours), and maximum is 2630000 seconds (1 month). |
Requirements
Output
json— Response from the API endpoint 'ListActiveMetricConfigurations'.DatadogApi.ListAllContainers
Retrieve all containers within your organization. Use this tool to get a comprehensive list of all containers managed by your organization in Datadog.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
container_sort_attribute | string | Optional | Specify the attribute to sort containers by. Common values include 'name', 'creation_date', etc. |
filter_by_tags | string | Optional | Comma-separated list of tags to filter containers by, narrowing down the results based on specified tags. |
group_containers_by_tags | string | Optional | Comma-separated list of tags to group containers by. |
maximum_results_returned | integer | Optional | Maximum number of container results to return per page. |
pagination_cursor | string | Optional | A string to query the next page of container results, using the `meta.pagination.next_cursor` from the API response. |
Requirements
Output
json— Response from the API endpoint 'ListContainers'.DatadogApi.ListAllCsmAgents
Retrieve all CSM Agents running on your infrastructure. Use this tool to get a comprehensive list of all Customer Service Management (CSM) Agents currently operational on your hosts and containers. This can be useful for monitoring and managing your service agents.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
filter_query | string | Optional | A search query string to filter results, e.g., `hostname:COMP-T2H4J27423`. |
page_size | integer | Optional | Specify the number of items to include in a single page for pagination. |
pagination_page_index | integer | Optional | The zero-based index of the page to retrieve for pagination. |
results_sort_direction | string | Optional | Sets sort order for results. Use 'asc' for ascending or 'desc' for descending. |
Requirements
Output
json— Response from the API endpoint 'ListAllCSMAgents'.DatadogApi.ListAllMemberTeams
Retrieve all member teams for a super team. Use this tool to get a comprehensive list of all member teams associated with a specific super team in Datadog. Call this tool when you need information on team memberships within a specified structure.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
super_team_identifier | string | Required | The unique identifier for the super team whose member teams you want to retrieve. |
fields_to_fetch | array<string> | Optional | A list of field names to be fetched for each team. Specify the fields you need details on. |
page_number | integer | Optional | Specific page number to return in the list of teams. |
page_size | integer | Optional | Size for a given page. Must be an integer up to 100. |
Requirements
Output
json— Response from the API endpoint 'ListMemberTeams'.DatadogApi.ListAllOrganizationProcesses
Retrieve all processes for your organization from Datadog. This tool is used to fetch a list of all processes associated with your organization in Datadog. It should be called when you need detailed information about the processes running across your organization's systems.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
filter_by_tags | string | Optional | A comma-separated list of tags to filter the processes by. Use specific tags relevant to your organization's processes for targeted results. |
max_results_per_page | integer | Optional | Maximum number of process results to return in one page. |
pagination_cursor | string | Optional | String token to retrieve the next page of process results. Use the value from `meta.page.after` provided in the previous API response. |
query_window_end_timestamp | integer | Optional | Unix timestamp (seconds since epoch) marking the end of the query window. Defaults to 15 minutes after 'from' if not provided. If 'from' and 'to' are omitted, defaults to 15 minutes from current time. |
query_window_start_timestamp | integer | Optional | Unix timestamp marking the start of the query window. Defaults to 15 minutes before the end of the window if not provided. |
search_string_for_processes | string | Optional | String used to search and filter processes by specific criteria. |
Requirements
Output
json— Response from the API endpoint 'ListProcesses'.DatadogApi.ListAllOrganizationUsers
Retrieve all users in the organization including inactive ones. Use this tool to get a complete list of users within the organization, covering active, deactivated, and unverified accounts.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
order_users_by | string | Optional | Specify the user attribute to order results by. Options include `name`, `modified_at`, and `user_count`. Use a negative sign for descending order, e.g., `-name`. |
page_number | integer | Optional | The specific page number of users to return. Use for pagination. |
page_size | integer | Optional | Specifies the number of users to be returned in a single page. The maximum value allowed is 100. |
sort_direction | string | Optional | Direction of sort for user listing. Options: 'asc' for ascending, 'desc' for descending. |
user_filter_string | string | Optional | String to filter users by. Defaults to no filtering if blank or omitted. |
user_status_filter | string | Optional | Filter users by status. Comma separated values: `Active`, `Pending`, `Disabled`. Defaults to no filtering. |
Requirements
Output
json— Response from the API endpoint 'ListUsers'.DatadogApi.ListApiKeys
Retrieve all API keys for your Datadog account. Use this tool to fetch a list of all API keys associated with your Datadog account. It is useful for managing or auditing your API key usage.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
api_key_filter | string | Optional | String to filter API keys by specified criteria. Use it to narrow down the list based on specific string matches. |
created_after_date_filter | string | Optional | Include API keys created on or after this date. Expected format: YYYY-MM-DD. |
filter_api_keys_by_category | string | Optional | Filter API keys by the specified category. |
filter_by_remote_config_read_enabled | boolean | Optional | Set to true to filter API keys with remote config read enabled; false otherwise. |
filter_created_before_date | string | Optional | Include only API keys created on or before this date in the format YYYY-MM-DD. |
include_related_resources | string | Optional | Comma-separated list of resource paths (`created_by`, `modified_by`) to include related data in the response. |
modified_after_date_filter | string | Optional | Specify a date to include API keys modified on or after this date. Use YYYY-MM-DD format. |
modified_before_date | string | Optional | Include API keys modified on or before this specified date. Format should be YYYY-MM-DD. |
page_size | integer | Optional | Specifies the number of API keys returned in a single page; maximum value is 100. |
sort_by_attribute | string | Optional | Attribute to sort API keys by. Use a minus sign for descending order. |
specific_page_number_to_return | integer | Optional | The specific page number to return from the paginated list of API keys. |
Requirements
Output
json— Response from the API endpoint 'ListAPIKeys'.DatadogApi.ListAppKeyRegistrations
Retrieve a list of app key registrations from Datadog. Use this tool to get a detailed list of all app key registrations available in your Datadog account. Ideal for managing and auditing app key usage.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
page_number | integer | Optional | The page number to return for paginating through app key registrations. |
results_per_page | integer | Optional | The number of App Key Registrations to return per page. |
Requirements
Output
json— Response from the API endpoint 'ListAppKeyRegistrations'.DatadogApi.ListApplicationKeys
Retrieve all application keys for your organization. This tool calls the Datadog API to list all application keys available for your organization, allowing you to view and manage your organization's credentials.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
created_after_date | string | Optional | Include application keys created on or after this date (YYYY-MM-DD). |
created_before_date | string | Optional | Filters application keys created on or before this date. Expected format is YYYY-MM-DD. |
filter_application_keys | string | Optional | Filter the application keys based on a specified string to narrow down the results. |
include_related_resource | string | Optional | Specify 'owned_by' to include related resource information in the response. |
page_number | integer | Optional | Specify the page number to return in the results. |
page_size | integer | Optional | Specify the number of application keys to return per page. Maximum is 100. |
sort_keys_by_attribute | string | Optional | Sort application keys by attribute such as 'created_at', 'name', or 'last4'. Use a minus sign for descending order, e.g., '-name'. |
Requirements
Output
json— Response from the API endpoint 'ListApplicationKeys'.DatadogApi.ListApps
Retrieve a list of all apps with optional filters and sorting. This tool calls the Datadog API to list all registered apps. It supports filtering and sorting options and provides basic information such as app ID, name, and description. Useful for managing and viewing app information through automation.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
filter_by_app_name | string | Optional | Filter the list of apps by specifying the app name. |
filter_by_creator_email | string | Optional | Filter apps by the creator's email address. This is used to narrow down apps created by a specific user. |
filter_by_creator_uuid | string | Optional | Filter apps by the app creator's UUID. Provide the UUID of the user who created the app to narrow down the results. |
filter_by_query | string | Optional | Filter apps by the app name or the app creator's name. |
filter_by_tags | string | Optional | Filter apps by specifying tags. Separate multiple tags with commas. |
filter_self_service_enabled | boolean | Optional | Filter apps by self-service enablement. True for enabled, false otherwise. |
include_published_apps | boolean | Optional | Set to true to include only published apps, false to exclude them. |
page_number | integer | Optional | The page number to return for paginated results. |
page_size | integer | Optional | The number of apps to return per page. |
show_only_favorite_apps | boolean | Optional | Set to true to filter and show only apps that you have marked as favorites. |
sort_fields_and_directions | array<string> | Optional | An array specifying the fields and directions (e.g., 'name:asc', 'created_at:desc') to sort apps by. |
Requirements
Output
json— Response from the API endpoint 'ListApps'.DatadogApi.ListAuthnMappings
Retrieve all AuthN Mappings in the organization. Use this tool to obtain a comprehensive list of all authentication mappings within your organization using Datadog.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
filter_authn_mappings | string | Optional | Filter all authentication mappings using a specific string to refine the results. |
filter_by_resource_type | string | Optional | Filter results by mapping resource type. Can be 'role' or 'team'. Defaults to 'role'. |
page_number | integer | Optional | The specific page number to return from the list of AuthN Mappings. |
page_size | integer | Optional | Number of results per page, with a maximum value of 100. |
sort_authn_mappings_by | string | Optional | Sort AuthN Mappings by the specified field. Options include fields like created_at, role_id, saml_assertion_attribute_id, etc. Prefix with '-' for descending order. |
Requirements
Output
json— Response from the API endpoint 'ListAuthNMappings'.DatadogApi.ListAwsAccounts
Retrieve AWS account integration configurations. Get a comprehensive list of AWS account integration configurations from Datadog. Useful for managing and reviewing AWS account integrations.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
filter_by_aws_account_id | string | Optional | Optional parameter to filter AWS accounts by their ID. Provide a specific AWS Account ID to get its integration config. If omitted, configurations for all accounts are returned. |
Requirements
Output
json— Response from the API endpoint 'ListAWSAccounts'.DatadogApi.ListAwsCurConfigs
Retrieve AWS CUR configuration list from Datadog. Call this tool to get a list of AWS Cost and Usage Report (CUR) configurations in Datadog when you need to examine or manage AWS cost data integrations.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'ListCostAWSCURConfigs'.DatadogApi.ListAwsLogsServices
Retrieve AWS services for logging to Datadog. Use this tool to obtain a list of AWS services that have the capability to send log data to Datadog. This can help in configuring and troubleshooting integrations.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'ListAWSLogsServices'.DatadogApi.ListAzureConfigs
Retrieve Azure configuration list from Datadog. Use this tool to obtain a list of Azure configs from Datadog. Useful for viewing or managing current Azure configurations.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'ListCostAzureUCConfigs'.DatadogApi.ListBudgets
Fetch a list of budgets from Datadog. Use this tool to retrieve the list of budgets set up in Datadog, including their details and configurations.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'ListBudgets'.DatadogApi.ListCatalogEntityRelations
Retrieve entity relations from the software catalog. This tool retrieves a list of entity relations from the Datadog Software Catalog. It's useful for understanding connections and dependencies between different software entities.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
filter_by_first_entity_reference | string | Optional | Filter relations by the reference of the first entity in the relation. |
filter_relations_by_second_entity_reference | string | Optional | Filter relations by the reference of the second entity in the relation. |
include_relationship_data | string | Optional | Specify which relationship data to include: 'entity' or 'schema'. |
maximum_relations_per_page | integer | Optional | Maximum number of relations to include in the response. |
page_offset | integer | Optional | The starting offset for the returned page of results. |
relation_type_filter | string | Optional | Filter relations by type using predefined relation types such as 'RelationTypeOwns', 'RelationTypeDependsOn', etc. |
Requirements
Output
json— Response from the API endpoint 'ListCatalogRelation'.DatadogApi.ListCatalogKinds
Retrieve entity kinds from the Software Catalog. This tool calls the Datadog API to retrieve a list of entity kinds from the Software Catalog. It should be used when you need information about the types of entities available in the catalog.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
filter_entity_name | string | Optional | Filter entities in the Software Catalog by their name using a string value. |
filter_uuid | string | Optional | Filter entities by their UUID in the catalog. |
max_kinds_in_response | integer | Optional | Specify the maximum number of entity kinds to be returned in the response. |
page_offset | integer | Optional | Specific offset to use as the beginning of the returned page. It determines where the data will start from in the list. |
Requirements
Output
json— Response from the API endpoint 'ListCatalogKind'.DatadogApi.ListCiPipelineEvents
Retrieve CI pipeline events based on a search query. Use this tool to get a list of continuous integration pipeline events from Datadog that match a specified search query. Results are paginated and similar to how logs are handled, providing insight into your latest pipeline activities.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
cursor_for_next_page | string | Optional | Cursor to paginate through results. Use the cursor from the previous query. |
event_order | string | Optional | Specifies the order of CI pipeline events in the results. Use 'timestamp' for ascending and '-timestamp' for descending order. |
max_events_response | integer | Optional | Specify the maximum number of events to include in the response. Accepts an integer value. |
maximum_timestamp | string | Optional | Specify the maximum timestamp for the requested events. Format as an ISO 8601 string (e.g., 2023-10-01T00:00:00Z). |
min_timestamp | string | Optional | Specify the earliest time for the events you want to retrieve. Use a timestamp string. |
search_query | string | Optional | A search query using Datadog's log syntax to filter CI pipeline events. Specify criteria to refine results. |
Requirements
Output
json— Response from the API endpoint 'ListCIAppPipelineEvents'.DatadogApi.ListCiTestEvents
Retrieve CI test events based on a search query. Use this tool to obtain CI Visibility test events from Datadog that match a specified search query. The results are paginated in a manner similar to logs. This can help in reviewing and analyzing the latest test events.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
max_events_in_response | integer | Optional | Specify the maximum number of CI test events to return in the response. |
max_timestamp | string | Optional | Specify the maximum timestamp for the requested events. |
minimum_timestamp | string | Optional | The minimum timestamp to filter requested events. Format is typically ISO 8601. |
pagination_cursor | string | Optional | Cursor for fetching the next set of paginated results, provided by the previous query. |
search_query | string | Optional | Search query using log syntax to filter CI Visibility test events. |
sort_order | string | Optional | Specify the order of events by using 'timestamp' for ascending or '-timestamp' for descending. |
Requirements
Output
json— Response from the API endpoint 'ListCIAppTestEvents'.DatadogApi.ListCloudflareAccounts
Retrieve a list of Cloudflare accounts from Datadog.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'ListCloudflareAccounts'.DatadogApi.ListCloudWorkloadSecurityAgentRules
Retrieve the list of cloud workload security agent rules. Use this tool to get a list of agent rules specifically for the Government (US1-FED) site.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'ListCloudWorkloadSecurityAgentRules'.DatadogApi.ListConfluentAccounts
Retrieve a list of Confluent accounts. Use this tool to get a list of Confluent accounts that are integrated with Datadog. It helps in managing and monitoring Confluent Cloud integrations efficiently.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'ListConfluentAccount'.DatadogApi.ListContainerImages
Retrieve all container images for your organization. Use this tool to get a list of all container images associated with your organization. This is useful for monitoring and managing your containerized applications within Datadog.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
filter_tags | string | Optional | Comma-separated list of tags to filter container images by. |
group_container_images_by_tags | string | Optional | Comma-separated list of tags to group container images by. Helps in organizing images based on specified criteria. |
max_results_per_page | integer | Optional | The maximum number of container image results to return per page. |
next_page_cursor | string | Optional | String to query the next page of container image results. Obtain this from the `meta.pagination.next_cursor` in the API response. |
sort_container_images_by | string | Optional | Attribute to sort Container Images by, such as 'name' or 'date'. |
Requirements
Output
json— Response from the API endpoint 'ListContainerImages'.DatadogApi.ListCustomAllocationRules
Retrieve all custom allocation rules for the organization. Use this tool to obtain a list of all custom allocation rules defined in the organization. It provides details about how costs are allocated according to custom rules in Datadog.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'ListCustomAllocationRules'.DatadogApi.ListCustomCostsFiles
Retrieve a list of custom costs files from Datadog. Use this tool to access and list custom costs files stored in Datadog. It is useful when you need to audit or analyze custom cost data.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
filter_by_file_status | string | Optional | Filter the custom costs files by their status. Accepts a string value representing the status to filter by, such as 'active', 'inactive', or 'pending'. |
page_number | integer | Optional | The page number to retrieve for pagination in the list of custom costs files. |
pagination_page_size | integer | Optional | The number of custom cost files to return per page for pagination. |
sort_key | string | Optional | Specify the key for sorting the list, with an optional '-' prefix for descending order. |
Requirements
Output
json— Response from the API endpoint 'ListCustomCostsFiles'.DatadogApi.ListCustomLogDestinations
Retrieve configured custom log destinations from Datadog. Use this tool to get a list of custom log destinations configured in your Datadog organization, including their definitions.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'ListLogsCustomDestinations'.DatadogApi.ListDatadogDatastores
Retrieve a list of all Datadog datastores. Use this tool to obtain a complete list of datastores within your organization on Datadog. Ideal for inventory management and audit purposes.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'ListDatastores'.DatadogApi.ListDatadogEvents
Retrieve events from Datadog based on a search query. Use this tool to list events from Datadog that match a specific search query. The results are paginated, similar to logs, and this tool is ideal for accessing the latest events.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
event_search_query | string | Optional | Search query following Datadog's events syntax to filter events. |
max_timestamp_milliseconds | string | Optional | Specify the maximum timestamp for requested events in milliseconds. Use this to limit the latest time of events retrieved. |
maximum_events_per_page | integer | Optional | Sets the maximum number of events to return in the response. |
minimum_timestamp_millis | string | Optional | The minimum timestamp in milliseconds for filtering requested events. |
pagination_cursor | string | Optional | Cursor for paginating through results, provided in the previous query response. |
sort_order | string | Optional | Specify the order of events: 'timestamp' for ascending, '-timestamp' for descending. |
Requirements
Output
json— Response from the API endpoint 'ListEvents'.DatadogApi.ListDatastoreItems
Retrieve items from a specified datastore. Use this tool to list items from a datastore. You can filter the results by using either an item key or a filter query parameter, but not both simultaneously. Supports server-side pagination for managing large datasets.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
datastore_identifier | string | Required | The unique identifier for the datastore from which to fetch items. |
item_limit_per_page | integer | Optional | Limit the number of items to return per page for pagination. Maximum of 100 items per page. |
pagination_offset | integer | Optional | Specifies the number of items to skip from the beginning of the result set for pagination. |
primary_item_key | string | Optional | Primary key to retrieve a specific item. Cannot be used with the filter parameter. |
search_filter | string | Optional | Query filter to search datastore items using the logs search syntax. Cannot be used with item_key. |
sort_order | string | Optional | Sort results by a specific field. Use '-' prefix for descending order (e.g., '-created_at'). |
Requirements
Output
json— Response from the API endpoint 'ListDatastoreItems'.DatadogApi.ListFastlyAccounts
Retrieve a list of Fastly accounts integrated with Datadog. Call this tool to obtain a list of Fastly accounts that are currently integrated with your Datadog instance. This can help in managing, auditing, or configuring integrations between Datadog and Fastly.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'ListFastlyAccounts'.DatadogApi.ListFastlyServices
Retrieve Fastly services for a specific account. Use this tool to get a list of all Fastly services associated with a particular account in Datadog. Ideal for checking service configurations or integrations linked to your Fastly account.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
fastly_account_id | string | Required | The unique identifier for a Fastly account to retrieve its services. |
Requirements
Output
json— Response from the API endpoint 'ListFastlyServices'.DatadogApi.ListFindings
Retrieve a list of security findings from Datadog. Use this tool to obtain a list of security findings, including misconfigurations and identity risks from Datadog. You can apply filters to customize the search results and include additional details by specifying parameters. The response includes summary details of each finding along with pagination metadata.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
filter_by_evaluation_change_date | string | Optional | Specify a date (Unix ms) or date range (using comparison operators) to find results altered from pass to fail or vice versa. |
filter_by_resource_id | string | Optional | Return only findings for the specified resource ID. |
filter_by_resource_type | string | Optional | Return findings only for the specified resource type. Use to narrow down results to specific resource types, such as 'aws', 'gcp', etc. |
filter_by_rule_id | string | Optional | Provide a specific rule ID to filter findings related to that rule. |
filter_by_rule_name | string | Optional | Specify the rule name to return findings associated with it. This filters findings based on the provided rule name. |
filter_by_tags | string | Optional | Specify tags to filter findings. Use the format `tag_key:tag_value`. Supports multiple tags separated by commas. |
filter_discovery_timestamp | string | Optional | Return findings discovered at a specific time (Unix ms) or within a date range using comparison operators (e.g., `>`, `<=`). |
filter_evaluation_status | string | Optional | Specify to return only findings that are either 'pass' or 'fail'. |
include_detailed_findings | boolean | Optional | Set to true to retrieve additional fields like external ID, description, and IP addresses for some findings. |
max_findings_limit | integer | Optional | Set the maximum number of findings to return, up to a limit of 1000. |
next_page_cursor | string | Optional | Use this to return the next page of findings starting from this cursor's position. |
return_muted_findings | boolean | Optional | Set to `true` to return muted findings. Set to `false` to exclude them. |
snapshot_timestamp | integer | Optional | Specify the Unix timestamp (in milliseconds) to get findings for a specific snapshot of time. |
status_filter | string | Optional | Specify the status of findings to return: critical, high, medium, low, or info. |
vulnerability_type_filters | array<string> | Optional | A list of strings to filter findings by matching vulnerability types. Repeatable for multiple types. |
Requirements
Output
json— Response from the API endpoint 'ListFindings'.DatadogApi.ListGcpStsAccounts
Retrieve all GCP STS-enabled service accounts from Datadog. Use this tool to list all Google Cloud Platform (GCP) STS-enabled service accounts configured in your Datadog account. It should be called when you need to view or manage the integration of GCP accounts within Datadog.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'ListGCPSTSAccounts'.DatadogApi.ListGcpUsageCostConfigs
Retrieve Google Cloud Usage Cost configurations from Datadog. Call this tool to obtain a list of Google Cloud Usage Cost configurations in your Datadog account. Useful for monitoring and managing GCP cost settings.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'ListCostGCPUsageCostConfigs'.DatadogApi.ListHistoricalJobs
Retrieve a list of historical SIEM detection jobs from Datadog. Use this tool to get a list of historical jobs related to SIEM detections in Datadog. This is useful for analyzing past job executions and reviewing detection history.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
filter_query | string | Optional | A query string to filter items in the list of historical jobs. Use to specify criteria for narrowing down the results. |
page_number | integer | Optional | The specific page number to return from the results. |
page_size | integer | Optional | Specifies the number of results per page, with a maximum of 100. |
sort_order | string | Optional | Specifies the order in which jobs are returned, such as ascending or descending. |
Requirements
Output
json— Response from the API endpoint 'ListHistoricalJobs'.DatadogApi.ListIncidentNotificationRules
Retrieve all incident notification rules for the organization. Fetches a list of notification rules for incidents within your organization, with optional filtering by incident type.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
resources_to_include | string | Optional | Comma-separated list of resources to include. Supported values: `created_by_user`, `last_modified_by_user`, `incident_type`, `notification_template`. |
Requirements
Output
json— Response from the API endpoint 'ListIncidentNotificationRules'.DatadogApi.ListIncidentNotificationTemplates
Retrieve all incident notification templates. This tool lists all the notification templates available for incidents in Datadog. It can optionally filter the templates by incident type.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
incident_type_id_filter | string | Optional | Optional ID to filter notification templates by incident type. |
include_relationships | string | Optional | Comma-separated list of relationships to include in the response. Supported values are `created_by_user`, `last_modified_by_user`, `incident_type`. |
Requirements
Output
json— Response from the API endpoint 'ListIncidentNotificationTemplates'.DatadogApi.ListIncidentTodos
Retrieve all todos for a specified incident. Use this tool to gather a list of todos associated with a specific incident in Datadog. It is useful for tracking tasks that need to be addressed within an incident context.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
incident_uuid | string | Required | The unique identifier (UUID) of the incident for which to retrieve todos. |
Requirements
Output
json— Response from the API endpoint 'ListIncidentTodos'.DatadogApi.ListLatestSpans
Retrieve the latest spans based on a search query. This tool retrieves spans from Datadog that match a specified search query. Use this to see your latest spans. Note that results are paginated, and the endpoint is rate limited to 300 requests per hour.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
max_spans_limit | integer | Optional | The maximum number of spans to return in the response. Specify an integer value to limit the results. |
max_timestamp_for_spans | string | Optional | Maximum timestamp for requested spans. Use ISO8601, date math, or millisecond timestamps. |
minimum_timestamp | string | Optional | Minimum timestamp for requested spans. Accepts ISO8601, date math, or timestamps in milliseconds. |
pagination_cursor | string | Optional | Cursor for paginating results, provided by the previous query execution. |
sort_order_of_spans | string | Optional | Specify the order of spans in the results. Use 'timestamp' for ascending and '-timestamp' for descending order. |
span_search_query | string | Optional | A search query following the spans syntax to filter the spans you want to retrieve. |
Requirements
Output
json— Response from the API endpoint 'ListSpansGet'.DatadogApi.ListLogs
Retrieve logs based on a search query with pagination. Use this tool to search and filter logs according to specified criteria. Note that results are paginated. Consider Datadog's archive capabilities for organizational log archiving needs.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
indexes_to_search | array<string> | Optional | Specify the indexes to search. Defaults to ['*'] for all indexes. |
max_log_time | string | Optional | The maximum time for the requested logs. Supports date math and regular timestamps (milliseconds). |
maximum_logs_in_response | integer | Optional | Specifies the maximum number of logs to return in the response, allowing control over pagination size. |
minimum_time | string | Optional | The minimum time for the requested logs, supports date math and regular timestamps (milliseconds). |
pagination_cursor | string | Optional | Cursor for retrieving the next set of paginated log results from a previous query. |
query_timezone | string | Optional | Specify the timezone as GMT, UTC, an offset (e.g., UTC+1), or a Timezone Database ID (e.g., America/New_York). |
search_query | string | Optional | The search query following Datadog's log search syntax to filter logs. |
sort_order | string | Optional | Defines how logs are sorted: 'timestamp' for ascending order and '-timestamp' for descending order. |
storage_type | string | Optional | Specify the storage type: "indexes", "online-archives", or "flex". |
time_offset_seconds | integer | Optional | The time offset in seconds to apply to the log search query. |
Requirements
Output
json— Response from the API endpoint 'ListLogs'.DatadogApi.ListLogsArchives
Get the list of configured logs archives. Retrieve the definitions of all logs archives configured in Datadog.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'ListLogsArchives'.DatadogApi.ListLogsMatchingQuery
Retrieve logs that match a search query with pagination. Use this tool to search and filter logs in Datadog based on a specified query. It's ideal for retrieving specific log data for analysis or monitoring purposes. For extensive archiving, consider Datadog's archive features instead.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
max_timestamp_for_logs | string | Optional | Specify the maximum timestamp for the requested logs. This represents the latest time point for log retrieval. |
maximum_logs_in_response | integer | Optional | Maximum number of logs to include in the response. Specify an integer value. |
minimum_timestamp_for_logs | string | Optional | Specify the earliest timestamp for the logs to be retrieved. Use ISO 8601 format for the timestamp. |
pagination_cursor | string | Optional | Cursor for pagination to retrieve the next set of log results. Use the cursor from the previous query to continue fetching results. |
search_indexes | array<string> | Optional | Specify the indexes to search. Defaults to '*' for all indexes. |
search_query | string | Optional | Search query using logs syntax to filter specific logs from Datadog. |
sort_order | string | Optional | Specify the order of logs in results: 'timestamp' for ascending or '-timestamp' for descending. |
storage_type | string | Optional | Specifies the storage type. Options are 'indexes', 'online-archives', or 'flex'. |
Requirements
Output
json— Response from the API endpoint 'ListLogsGet'.DatadogApi.ListMetricAssets
Retrieve assets associated with a specific metric. This tool returns a list of dashboards, monitors, notebooks, and SLOs where a specific metric is used. Useful for tracking where a metric appears across Datadog's tools, updated every 24 hours.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
metric_name | string | Required | The specific name of the metric to retrieve associated assets for. This is essential for querying the correct data. |
Requirements
Output
json— Response from the API endpoint 'ListMetricAssets'.DatadogApi.ListMetricTagConfigurations
Retrieve all metrics configurable in Datadog's Metrics Summary. Use this tool to get a list of all metrics that can be configured on the Metrics Summary page or with Metrics without Limits™. It supports pagination through cursor-based navigation.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
filter_by_query_status | boolean | Optional | Filter custom metrics that have or have not been queried within the specified time window. |
filter_metrics_by_tags | string | Optional | Filter metrics by tags using boolean/wildcard expressions; combine with queried filter only. |
filter_metrics_used_in_assets | boolean | Optional | Boolean to filter metrics used in dashboards, monitors, notebooks, and SLOs. |
filter_tag_configurations | string | Optional | Filter tag configurations by specified configured tags. Use string values representing specific criteria for filtering. |
include_metrics_with_configured_tags | boolean | Optional | Set to true to filter and include only custom metrics with configured tags. |
include_percentile_aggregations | boolean | Optional | Set to true to include distributions with additional percentile aggregations enabled. Set to false to exclude them. |
look_back_seconds | integer | Optional | The number of seconds to look back for applying a filter on tags or queried metrics. Defaults to 3600 seconds (1 hour) with a max of 2,592,000 seconds (30 days). |
max_results_per_page | integer | Optional | Maximum number of metric configurations to return per page. |
metric_type_filter | string | Optional | Filter metrics by type. Options are 'non_distribution' or 'distribution'. |
pagination_cursor | string | Optional | String to query the next page of metric results. Use 'next_cursor' from the previous response. Null when all pages are retrieved. |
Requirements
Output
json— Response from the API endpoint 'ListTagConfigurations'.DatadogApi.ListMetricTags
Retrieve indexed tags for a metric over the last hour. Use this tool to get the indexed tag key-value pairs for a specific metric name within the past hour. Useful for analyzing and viewing metric-related tag data from Datadog.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
metric_name | string | Required | The name of the metric to retrieve indexed tag key-value pairs from over the past hour. |
Requirements
Output
json— Response from the API endpoint 'ListTagsByMetricName'.DatadogApi.ListMetricVolumes
Retrieve distinct metric volumes by name. Use this tool to view distinct volumes for a specified metric name. Note that custom metrics generated in-app may return `null` for ingested volumes.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
metric_name | string | Required | The name of the metric to retrieve volumes for. |
Requirements
Output
json— Response from the API endpoint 'ListVolumesByMetricName'.DatadogApi.ListMonitorConfigPolicies
Retrieve all monitor configuration policies. Use this tool to get a comprehensive list of monitor configuration policies from Datadog. This can be useful for managing and understanding monitoring setups.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'ListMonitorConfigPolicies'.DatadogApi.ListMonitorDowntimes
Retrieve active downtimes for a specified monitor. Use this tool to get all active downtimes associated with a specific monitor ID in Datadog. It should be called when you need to check the downtime status of a monitor.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
monitor_id | integer | Required | The ID of the monitor for which to retrieve active downtimes. This should be provided as an integer. |
maximum_downtime_count | integer | Optional | Specifies the maximum number of downtime entries to return in the response. |
pagination_offset | integer | Optional | Specify the offset for the beginning of the returned page, to manage pagination. |
Requirements
Output
json— Response from the API endpoint 'ListMonitorDowntimes'.DatadogApi.ListMsTeamsWorkflowWebhooks
Retrieve all Microsoft Teams workflow webhook handles from Datadog. Use this tool to obtain a list of all workflow webhook handles associated with the Datadog Microsoft Teams integration. It helps in managing and monitoring webhook configurations efficiently.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
webhook_handle_name | string | Optional | Specifies the name of your Workflows webhook handle to filter the list. |
Requirements
Output
json— Response from the API endpoint 'ListWorkflowsWebhookHandles'.DatadogApi.ListOktaAccounts
Retrieve a list of Okta accounts linked to Datadog. Use this tool to obtain information about Okta accounts that are integrated with Datadog, allowing for management and analysis of these linked accounts.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'ListOktaAccounts'.DatadogApi.ListOpsgenieServices
Retrieve all services from Datadog Opsgenie integration. Call this tool to get a comprehensive list of services integrated with Datadog's Opsgenie. Useful for managing or reviewing service integrations.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'ListOpsgenieServices'.DatadogApi.ListOrganizationIncidents
Retrieve all incidents for your organization. Call this tool to get a comprehensive list of all incidents associated with the user's organization in Datadog.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
include_related_objects | array<string> | Optional | List of related object types to include in the response. Specify as an array of strings. |
page_offset | integer | Optional | Specific offset to start the returned page of incidents. Use this to paginate results. |
page_size | integer | Optional | Integer specifying the number of incidents per page, up to a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'ListIncidents'.DatadogApi.ListOrgConfigs
Retrieve all organization configurations. Call this tool to get a list of all organization configurations, providing details like name, description, and value.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'ListOrgConfigs'.DatadogApi.ListOrgConnections
Retrieve a list of organization connections from Datadog. Use this tool to get a comprehensive list of all organization connections within Datadog. This can be useful for managing and analyzing connected organizations.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
entry_limit | integer | Optional | Specifies the maximum number of entries to return. Default is 1000. |
pagination_offset | integer | Optional | The pagination offset to start querying from, with a default of 0. Use this for paginated results. |
sink_organization_id | string | Optional | The organization ID of the sink org. It identifies the destination organization in the connections list. |
source_organization_id | string | Optional | The ID of the source organization to query connections from. |
Requirements
Output
json— Response from the API endpoint 'ListOrgConnections'.DatadogApi.ListPermissions
Retrieve all permissions from Datadog. Use this tool to get a comprehensive list of all available permissions, including their names, descriptions, and IDs, from Datadog's system.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'ListPermissions'.DatadogApi.ListPipelines
Retrieve a list of pipelines from Datadog. Use this tool to get a list of all pipelines available in the Datadog system. It should be called whenever you need information on existing pipelines.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
page_number | integer | Optional | Specify the page number of pipelines to retrieve. Use this to navigate through the pages of results returned by the API. |
page_size | integer | Optional | Number of pipelines to return per page, up to a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'ListPipelines'.DatadogApi.ListPowerpacks
Retrieve a list of all powerpacks from Datadog. Use this tool to get the complete list of powerpacks available in Datadog. It should be called when you need to access or display all the powerpacks.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
max_powerpacks_limit | integer | Optional | Maximum number of powerpacks to include in the response. |
page_offset | integer | Optional | The specific offset to start returning powerpacks from, allowing for pagination. |
Requirements
Output
json— Response from the API endpoint 'ListPowerpacks'.DatadogApi.ListReferenceTables
Retrieve all reference tables in the organization. Use this tool to fetch a list of all reference tables available in the current organization. It provides an overview of the reference tables configured in Datadog.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
exact_table_name_filter | string | Optional | Filter by an exact table name match to retrieve specific reference tables. |
filter_by_table_status | string | Optional | Filter tables by their status. Accepts status as a string, such as 'active', 'inactive', etc. |
filter_table_name_contains | string | Optional | Filter tables by name containing this substring. |
number_of_tables_to_return | integer | Optional | Specify the number of tables to return in the response. Use an integer value. |
pagination_offset | integer | Optional | Number of tables to skip for pagination. |
sort_field_and_direction | string | Optional | Specify the field to sort by and the direction. Use a field name for ascending, prefix with "-" for descending. Options include: updated_at, table_name, status, and their descending counterparts. |
Requirements
Output
json— Response from the API endpoint 'ListTables'.DatadogApi.ListResourceFilters
Retrieve Datadog resource evaluation filters. Call this tool to obtain a list of resource evaluation filters for cloud security management in Datadog.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
cloud_provider_account_id | string | Optional | Filter resource filters by the cloud provider's account ID. This is valid only when a provider is specified. |
cloud_provider_filter | string | Optional | Specifies the cloud provider to filter resource filters, such as aws, gcp, or azure. |
skip_cache_for_resource_filters | boolean | Optional | Set to true to skip the cache when fetching resource filters. Useful when the latest resource data is needed. |
Requirements
Output
json— Response from the API endpoint 'GetResourceEvaluationFilters'.DatadogApi.ListRestrictionQueries
Retrieve all restriction queries with their details. This tool retrieves all restriction queries from Datadog, including their names and IDs. Use it when you need to review or manage restriction queries within your Datadog configuration.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
page_number | integer | Optional | The specific page number of results to return. Useful for paginating through result sets. |
page_size | integer | Optional | The number of results to return per page. Maximum value is 100. |
Requirements
Output
json— Response from the API endpoint 'ListRestrictionQueries'.DatadogApi.ListRolePermissions
Retrieve all permissions for a specific role. Call this tool to get a list of all permissions associated with a particular role in Datadog.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
role_identifier | string | Required | The unique identifier for the role whose permissions need to be retrieved. |
Requirements
Output
json— Response from the API endpoint 'ListRolePermissions'.DatadogApi.ListRoleTemplates
Retrieve all role templates from Datadog. This tool retrieves a list of all role templates from Datadog. It should be called when you need to access or review the role templates defined within Datadog's system.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'ListRoleTemplates'.DatadogApi.ListRoleUsers
Retrieve all users belonging to a specific role. Call this tool to obtain a list of users assigned to a particular role in Datadog.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
role_identifier | string | Required | The unique identifier of the role to list its associated users. |
page_number | integer | Optional | The specific page number to return in the list of users. |
page_size | integer | Optional | Size for a given page, with a maximum value of 100. |
user_filter_string | string | Optional | Filter users by a specific string. Defaults to no filtering. |
user_sort_order | string | Optional | Attribute to sort users by. Prefix with '-' for descending. Options: 'name', 'email', 'status'. |
Requirements
Output
json— Response from the API endpoint 'ListRoleUsers'.DatadogApi.ListRumApplications
Retrieve all RUM applications within your organization from Datadog. This tool is used to list all the Real User Monitoring (RUM) applications configured in your organization to help monitor and analyze user interactions.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'GetRUMApplications'.DatadogApi.ListRumEvents
Retrieve RUM events matching a search query. This tool is used to list RUM (Real User Monitoring) events that match a specific search query. It's useful for retrieving your latest RUM events, and results are paginated to handle large datasets.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
event_sort_order | string | Optional | Specify the order of events: 'timestamp' for ascending or '-timestamp' for descending. |
maximum_event_count | integer | Optional | Specify the maximum number of events to retrieve in a single response. |
maximum_timestamp | string | Optional | Maximum timestamp for requested events in ISO 8601 format. |
minimum_timestamp | string | Optional | The starting timestamp for the requested RUM events. Use a string format compatible with the API. |
pagination_cursor | string | Optional | Cursor for fetching the next set of paginated results in the queried RUM events. |
rum_search_query | string | Optional | Search query following RUM syntax for filtering events. |
Requirements
Output
json— Response from the API endpoint 'ListRUMEvents'.DatadogApi.ListRumMetrics
Retrieve configured RUM-based metrics and their definitions. Use this tool to obtain a detailed list of metrics related to real user monitoring (RUM), including their configurations and definitions.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'ListRumMetrics'.DatadogApi.ListScanningGroups
Retrieve all scanning groups in your organization with Datadog's API.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'ListScanningGroups'.DatadogApi.ListScheduledDowntimes
Retrieve all scheduled downtimes from Datadog. Use this tool to get a list of all downtimes that are currently scheduled in Datadog. It should be called when you need information about planned downtime periods.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
include_resources_in_response | string | Optional | Comma-separated list of resource paths to include in the response, such as `created_by` and `monitor`. |
max_downtimes_in_response | integer | Optional | Maximum number of downtimes to include in the response. |
page_offset | integer | Optional | The starting point for the list of returned scheduled downtimes, used for pagination. |
return_current_downtimes_only | boolean | Optional | Set to true to return only downtimes active at the time of the request. |
Requirements
Output
json— Response from the API endpoint 'ListDowntimes'.DatadogApi.ListSecurityFilters
Retrieve configured security filters from Datadog. Use this tool to get a list of all configured security filters along with their definitions. It is useful for monitoring and managing security configurations.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'ListSecurityFilters'.DatadogApi.ListSecurityMonitoringRules
Retrieve a list of security monitoring rules. Use this tool to get a list of security monitoring rules from Datadog. Call it when you need to view or manage security monitoring rules.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
page_number | integer | Optional | The specific page number to return when listing the security monitoring rules. |
page_size | integer | Optional | Size for a given page. The maximum allowed value is 100. Use an integer value. |
Requirements
Output
json— Response from the API endpoint 'ListSecurityMonitoringRules'.DatadogApi.ListSecurityMonitoringSignals
Retrieve a list of security monitoring hist signals. This tool calls the Datadog API to list historical security monitoring signals, providing insights into detected security events over time.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
max_security_signals | integer | Optional | The maximum number of security signals to return in the response. Specify an integer value. |
maximum_timestamp_for_signals | string | Optional | The latest timestamp to fetch security signals up to, formatted as a string. |
minimum_timestamp | string | Optional | The minimum timestamp for requested security signals in ISO 8601 format. |
results_page_cursor | string | Optional | Cursor for paginated results, using the cursor from the previous query. |
search_query | string | Optional | The search query to filter security signals. Use this to specify criteria for filtering the results. |
sort_order | string | Optional | Determine the order of security signals: 'timestamp' for ascending, '-timestamp' for descending. |
Requirements
Output
json— Response from the API endpoint 'ListSecurityMonitoringHistsignals'.DatadogApi.ListSecuritySignals
Retrieve security signals that match a search query. This tool retrieves a list of security signals from Datadog based on a search query, using the GET method for the security monitoring signals endpoint.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
cursor_based_pagination | string | Optional | Cursor for pagination to continue retrieving results from a previous query. |
max_security_signals_response | integer | Optional | Specify the maximum number of security signals to return in the response. |
max_timestamp_for_security_signals | string | Optional | Specify the maximum timestamp for retrieving security signals. |
minimum_timestamp | string | Optional | The minimum timestamp to filter security signals. Format: ISO 8601 string. |
result_sort_order | string | Optional | Specify the sort order for the security signals. Use 'timestamp' for ascending order, '-timestamp' for descending order. |
search_query_for_security_signals | string | Optional | The search query string used to filter security signals from Datadog. |
Requirements
Output
json— Response from the API endpoint 'ListSecurityMonitoringSignals'.DatadogApi.ListServerlessAgents
Retrieve all running CSM Serverless Agents. Use this tool to get a list of all CSM Serverless Agents currently running on your hosts and containers. It's ideal for monitoring and managing your serverless agent deployments.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
filter_query | string | Optional | A search string to filter serverless agents, such as `hostname:COMP-T2H4J27423`. |
items_per_page | integer | Optional | The number of items to include in a single page of results. |
page_index | integer | Optional | The zero-based page index for pagination when retrieving serverless agents. |
sort_direction | string | Optional | The direction to sort results: 'asc' for ascending or 'desc' for descending order. |
Requirements
Output
json— Response from the API endpoint 'ListAllCSMServerlessAgents'.DatadogApi.ListServiceAccountAppKeys
Retrieve all app keys for a specific service account. Use this tool to list all application keys available for a specified service account in Datadog. It is useful when you need to manage or audit the application keys associated with a service account.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
service_account_id | string | Required | The unique identifier for the service account whose application keys are to be retrieved. |
created_at_start_filter | string | Optional | Include application keys created on or after this date. Use format YYYY-MM-DD. |
created_before_date | string | Optional | Include application keys created on or before this date. |
filter_string_for_application_keys | string | Optional | Specify a string to filter the application keys by. Only keys containing the string will be shown. |
page_number | integer | Optional | Specify the page number to be returned. |
page_size | integer | Optional | Number of application keys to retrieve per page. The maximum allowed value is 100. |
sort_order_attribute | string | Optional | Attribute to sort application keys. Prefix with '-' for descending order. Options: created_at, last4, name. |
Requirements
Output
json— Response from the API endpoint 'ListServiceAccountApplicationKeys'.DatadogApi.ListSoftwareCatalogEntities
Retrieve entities from the software catalog. Use this tool to get a list of entities from the software catalog, ideal for managing or integrating software components.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
exclude_snapshotted_entities | string | Optional | Set to `true` to exclude entities that are snapshotted. |
filter_by_kind | string | Optional | Filter entities by specifying the kind of entity, provided as a string. |
filter_by_name | string | Optional | Filter entities by specifying their name. |
filter_by_owner | string | Optional | Filter the entities by their owner using a specific owner name or ID. |
filter_by_reference | string | Optional | Filter entities by their specific reference string. |
filter_by_relation_type | string | Optional | Specify the relation type to filter entities. Options include: 'RelationTypeOwns', 'RelationTypeOwnedBy', 'RelationTypeDependsOn', 'RelationTypeDependencyOf', 'RelationTypePartsOf', 'RelationTypeHasPart', 'RelationTypeOtherOwns', 'RelationTypeOtherOwnedBy', 'RelationTypeImplementedBy', 'RelationTypeImplements'. |
filter_by_uuid | string | Optional | Filter entities by their UUID. Provide the UUID as a string to retrieve specific entities. |
include_relationship_data | string | Optional | Specify which relationship data to include, such as 'schema', 'raw_schema', 'oncall', 'incident', or 'relation'. |
max_entities_per_page | integer | Optional | Specifies the maximum number of entities to return per page in the response. |
pagination_offset | integer | Optional | The starting point for pagination of the returned list of entities. |
Requirements
Output
json— Response from the API endpoint 'ListCatalogEntity'.DatadogApi.ListSpanMetrics
Retrieve configured span-based metrics from Datadog. Get the list of configured span-based metrics along with their definitions from Datadog's APM configuration.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'ListSpansMetrics'.DatadogApi.ListSpans
Fetch spans based on a search query with pagination. This tool retrieves spans from Datadog that match a specified search query. Use it to filter and search spans for analysis or monitoring. Note that the endpoint supports paginated results and is subject to rate limits of 300 requests per hour.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
end_time_filter | string | Optional | The maximum time for requested spans. Supports ISO8601, date math, or timestamps in milliseconds. |
max_number_of_spans | integer | Optional | Maximum number of spans to return in the response. Integer value expected. |
minimum_time_filter | string | Optional | The minimum time for the requested spans. Supports ISO8601, date math, and timestamps (milliseconds). |
pagination_cursor | string | Optional | A string cursor to fetch the next set of results from the previous query. |
resource_type | string | Optional | The type of resource; must be set to 'search_request' for the query. |
sort_order_for_spans | string | Optional | Set the sort order for querying spans. Use 'timestamp' for ascending or '-timestamp' for descending. |
span_search_query | string | Optional | The search query string following the span search syntax to filter spans. |
time_offset_seconds | integer | Optional | The time offset in seconds to apply to the query for adjusting the time frame. |
timezone_option | string | Optional | Specify the timezone using GMT, UTC, an offset (e.g., UTC+1), or a Timezone Database ID (e.g., America/New_York). |
Requirements
Output
json— Response from the API endpoint 'ListSpans'.DatadogApi.ListStandardPatterns
Retrieve all standard patterns for sensitive data scanning. This tool is used to fetch a list of all standard patterns available for sensitive data scanning with Datadog. Call this tool when you need access to predefined patterns used for identifying sensitive data.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'ListStandardPatterns'.DatadogApi.ListSuppressionRules
Retrieve the list of security monitoring suppression rules. This tool retrieves all the suppression rules configured in Datadog's security monitoring system. Use this tool to view the current set of rules that suppress certain alerts.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
suppression_query_string | string | Optional | A query string to filter suppression rules. Use to specify search criteria. |
Requirements
Output
json— Response from the API endpoint 'ListSecurityMonitoringSuppressions'.DatadogApi.ListTagPipelineRulesets
Retrieve all tag pipeline rulesets for the organization. This tool retrieves a comprehensive list of all tag pipeline rulesets associated with the organization. It should be called when you need to examine or manage these rulesets.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'ListTagPipelinesRulesets'.DatadogApi.ListTeams
Retrieve all teams with optional filters. Fetches a list of all teams, allowing optional filters by keyword or user.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
fields_to_fetch | array<string> | Optional | List of fields to retrieve for each team. |
include_only_user_teams | boolean | Optional | When true, only teams the current user belongs to are returned. |
include_related_resources | array<string> | Optional | Specify related resources to include. Options: `team_links`, `user_team_permissions`. |
page_number | integer | Optional | The specific page number to return for the list of teams. |
page_size | integer | Optional | Specify the number of teams to return per page, up to a maximum of 100. |
search_query_for_teams | string | Optional | Search for teams by name, handle, or team member email. |
sort_order | string | Optional | Determines the order of the returned teams. Options: 'name', '-name', 'user_count', '-user_count'. |
Requirements
Output
json— Response from the API endpoint 'ListTeams'.DatadogApi.ListTenantBasedHandles
Retrieve Datadog's tenant-based handles for MS Teams integration. Call this tool to obtain a list of all tenant-based handles configured in the Datadog Microsoft Teams integration.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
tenant_handle_name | string | Optional | The name of your tenant-based handle in the Datadog Microsoft Teams integration. |
tenant_identifier | string | Optional | The ID of your tenant in Datadog to retrieve handles for MS Teams integration. |
Requirements
Output
json— Response from the API endpoint 'ListTenantBasedHandles'.DatadogApi.ListUserAppKeys
Retrieve all application keys for the current user. This tool retrieves a list of all application keys associated with the current user in Datadog. It should be called when there's a need to view or manage these application keys.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
created_after_date | string | Optional | Include application keys created on or after this date in the results. |
filter_by_string | string | Optional | Filter application keys by the specified string to narrow down the results. |
filter_created_at_end_date | string | Optional | Include only application keys created on or before this date. Format: YYYY-MM-DD. |
include_related_resources | string | Optional | Specify 'owned_by' to include related resources in the response. |
page_number | integer | Optional | Specify the page number to retrieve application keys from. |
page_size | integer | Optional | Specify the number of application keys per page. Maximum value is 100. |
sort_application_keys | string | Optional | Specify the attribute to sort the application keys. Use a minus sign for descending order. |
Requirements
Output
json— Response from the API endpoint 'ListCurrentUserApplicationKeys'.DatadogApi.ListUserRoles
Retrieve all roles from Datadog. This tool fetches all roles from Datadog, providing their names and unique identifiers. It should be called when there's a need to view or manage role information.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
page_number | integer | Optional | Specific page number to return. |
page_size | integer | Optional | The number of roles to return per page, with a maximum of 100. |
role_filter_string | string | Optional | Filter roles using a specific string to match their details. |
role_id_filter | string | Optional | List of role IDs to filter roles by, supporting comma-separated values. |
sort_roles_by | string | Optional | Sort roles based on a specified field. Use prefixes to set ascending or descending order, e.g., '-name' for descending by name. |
Requirements
Output
json— Response from the API endpoint 'ListRoles'.DatadogApi.ListWafCustomRules
Retrieve a list of WAF custom rules. Use this tool to get a list of custom rules for the Web Application Firewall (WAF) in Datadog. It's useful for monitoring and managing security configurations.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'ListApplicationSecurityWAFCustomRules'.DatadogApi.ListWafExclusionFilters
Retrieve a list of WAF exclusion filters.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'ListApplicationSecurityWafExclusionFilters'.DatadogApi.ListWorkflowInstances
Retrieve all instances of a specific workflow from Datadog. Use this tool to get a list of all instances for a specified workflow within Datadog. Ensure you have a registered application key or the necessary permissions configured in the UI.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
workflow_id | string | Required | The ID of the workflow to retrieve instances for. |
page_number | integer | Optional | The specific page number to return when listing workflow instances. |
page_size | integer | Optional | Size for a given page. Must be an integer with a maximum value of 100. |
Requirements
Output
json— Response from the API endpoint 'ListWorkflowInstances'.DatadogApi.ListWorkloadProtectionAgentRules
Retrieve the list of Workload Protection agent rules. Use this tool to get the current list of agent rules for workload protection from Datadog. This is not available for the Government (US1-FED) site.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
agent_policy_id | string | Optional | The ID of the Agent policy to retrieve the list of workload protection agent rules. |
Requirements
Output
json— Response from the API endpoint 'ListCSMThreatsAgentRules'.DatadogApi.ListWorkloadProtectionPolicies
Retrieve a list of Workload Protection policies from Datadog. This tool calls the Datadog API to retrieve a list of Workload Protection policies. It is used to obtain information about the configurations for workload security. Note: This endpoint is not available for the US1-FED site.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'ListCSMThreatsAgentPolicies'.DatadogApi.ManageBudget
Create or update a budget in Datadog. This tool allows you to create a new budget or update an existing budget using the Datadog API. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'UpsertBudget'.DatadogApi.ManageIncidentAttachments
Manage attachments for a specific incident in bulk. Use this tool to create, update, or delete multiple attachments related to a specific incident. It is called when adjustments to the attachments of an incident are needed. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
incident_uuid | string | Optional | The UUID of the incident to manage its attachments. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
related_objects_inclusion | array<string> | Optional | List of related object types to include in the response (e.g., comments, attachments). Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'UpdateIncidentAttachments'.DatadogApi.ManageSoftwareCatalogEntity
Create or update entities in the Software Catalog. Use this tool to either create a new entity or update an existing one within the Software Catalog in Datadog. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'UpsertCatalogEntity'.DatadogApi.OrderRumRetentionFilters
Order RUM retention filters for a RUM application. Use this tool to reorder the RUM retention filters for a specified RUM application. It returns the updated RUM retention filter objects without attributes when successful. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
rum_application_id | string | Optional | The ID of the RUM application for which to order retention filters. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'OrderRetentionFilters'.DatadogApi.PublishAppOnDatadog
Publish an app for user access on Datadog. Use this tool to publish an app for use by other users on Datadog. Ensure a restriction policy is set for correct user access. A registered application key is required for this operation.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
app_id_of_app_to_publish | string | Required | The unique identifier of the app you want to publish on Datadog. |
Requirements
Output
json— Response from the API endpoint 'PublishApp'.DatadogApi.QueryScalarData
Query scalar values from diverse data sources. Use this tool to query scalar values from various data sources, with options to apply formulas and functions, ideal for insights in widgets like Query Value, Table, and Toplist. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'QueryScalarData'.DatadogApi.QueryTimeseriesData
Query and process timeseries data from multiple sources. This tool queries timeseries data across various data sources and processes it by applying specified formulas and functions. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'QueryTimeseriesData'.DatadogApi.RegisterDatadogAppKey
Register a new app key in Datadog. Use this tool to register a new application key with Datadog, enabling API access and integrations.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
app_key_id | string | Required | The unique identifier for the app key to be registered with Datadog. It must be a valid string. |
Requirements
Output
json— Response from the API endpoint 'RegisterAppKey'.DatadogApi.RemovePermissionFromRole
Removes a permission from a specified role in Datadog. Use this tool to remove a specific permission from a role in Datadog's system. Ideal for managing role permissions and access control.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
role_identifier | string | Required | The unique identifier for the role from which a permission will be removed. |
permission_id | string | Optional | ID of the permission to be removed from the specified role. |
permission_resource_type | string | Optional | This should be set to 'permissions' to specify the permissions resource type. |
Requirements
Output
json— Response from the API endpoint 'RemovePermissionFromRole'.DatadogApi.RemoveProject
Remove a project using its ID. Use this tool to remove a project by providing the project's ID to ensure it is no longer available in the system.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
project_id | string | Required | The unique identifier (UUID) of the project to be removed. |
Requirements
Output
json— Response from the API endpoint 'DeleteProject'.DatadogApi.RemoveRoleFromArchive
Removes a role from a specified archive in Datadog. This tool should be called to remove a user role from a specific archive in Datadog. It helps revoke access permissions associated with that role for the archive.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
archive_id | string | Required | The ID of the archive from which the role will be removed. |
role_type | string | Optional | The type of role to be removed, typically set to 'roles'. |
role_unique_identifier | string | Optional | The unique identifier of the role to be removed from the archive. |
Requirements
Output
json— Response from the API endpoint 'RemoveRoleFromArchive'.DatadogApi.RemoveRoleFromRestrictionQuery
Removes a role from a Datadog restriction query. Use this tool to delete a specific role from a restriction query in Datadog. Appropriate for situations where you need to manage access by modifying restriction queries.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
restriction_query_id | string | Required | The ID of the restriction query to remove the role from. |
role_type | string | Optional | The type of the role, must be 'roles'. |
role_unique_identifier | string | Optional | The unique identifier of the role to be removed from the restriction query. |
Requirements
Output
json— Response from the API endpoint 'RemoveRoleFromRestrictionQuery'.DatadogApi.RemoveTeamLink
Remove a link from a team. Use this tool to remove a specific link from a team by providing the team and link identifiers. Useful for managing team associations and cleaning up unnecessary links.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
link_identifier | string | Required | The unique identifier of the link to be removed from the team. |
team_id | string | Required | The unique identifier of the team from which the link will be removed. Required for identifying the specific team. |
Requirements
Output
json— Response from the API endpoint 'DeleteTeamLink'.DatadogApi.RemoveTeamMember
Removes a member team from a super team. Use this tool to remove a specific member team from a super team based on the provided member team ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
member_team_identifier | string | Required | The unique ID of the member team to be removed from the super team. |
super_team_id | string | Required | The unique identifier for the super team from which a member team will be removed. |
Requirements
Output
json— Response from the API endpoint 'RemoveMemberTeam'.DatadogApi.RemoveUserFromRole
Remove a user from a specified role in Datadog. Use this tool to remove a specified user from a role in Datadog when updating user permissions or cleaning up role assignments.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
role_identifier | string | Required | The unique identifier of the role to remove the user from. |
user_identifier | string | Required | The unique identifier representing the user to be removed from the role. |
user_resource_type | string | Optional | Specifies the resource type, which should be set as 'users'. |
Requirements
Output
json— Response from the API endpoint 'RemoveUserFromRole'.DatadogApi.RemoveUserFromTeam
Remove a user from a specified team. Use this tool when you need to remove a user's membership from a specific team in Datadog.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
team_identifier | string | Required | A string representing the unique identifier of the team from which the user will be removed. |
user_identifier_for_removal | string | Required | The unique identifier of the user to be removed from the team. |
Requirements
Output
json— Response from the API endpoint 'DeleteTeamMembership'.DatadogApi.ReorderApmRetentionFilters
Reorder execution order of APM retention filters. Use this tool to change the sequence in which APM retention filters are executed. This is useful for prioritizing certain filters over others in your Datadog configuration. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'ReorderApmRetentionFilters'.DatadogApi.ReorderCustomAllocationRules
Change execution order of custom allocation rules in Datadog. Use this tool to reorder custom allocation rules by specifying the complete list of rule IDs in the desired sequence. Lower indices are executed first, so arrange them according to priority. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'ReorderCustomAllocationRules'.DatadogApi.ReorderScanningGroups
Reorder the list of scanning groups. This tool is used to change the order of sensitive data scanning groups in Datadog. Call this tool when you need to reorder the existing groups. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'ReorderScanningGroups'.DatadogApi.ReorderTagPipelineRulesets
Change the execution order of tag pipeline rulesets. Use this tool to modify the order in which tag pipeline rulesets are executed in Datadog. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'ReorderTagPipelinesRulesets'.DatadogApi.ResolveOnCallPage
Resolves an On-Call Page in Datadog. This tool resolves an open on-call page in Datadog, which is useful for indicating that an incident or issue has been addressed. Use it when you need to confirm the resolution of a specific on-call incident.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
on_call_page_id | string | Required | The unique identifier of the on-call page to resolve in Datadog. |
Requirements
Output
json— Response from the API endpoint 'ResolveOnCallPage'.DatadogApi.RetrieveDatasetInfo
Retrieve detailed information about a specific dataset from Datadog. Use this tool to get information about a dataset using its unique ID. It retrieves comprehensive details related to the specified dataset from Datadog.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
dataset_identifier | string | Required | The unique identifier of the dataset to retrieve from Datadog. |
Requirements
Output
json— Response from the API endpoint 'GetDataset'.DatadogApi.RetrieveDatastore
Retrieve datastore information by ID. Use this tool to access details of a specific datastore by providing its ID. It retrieves information from Datadog's datastore endpoint.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
datastore_identifier | string | Required | The unique ID of the datastore to be retrieved from Datadog. |
Requirements
Output
json— Response from the API endpoint 'GetDatastore'.DatadogApi.RetrieveGcpScanSettings
Retrieve GCP project agentless scan options. This tool fetches the agentless scanning options for a specified activated GCP project from Datadog, helping to determine scan configurations and settings.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
gcp_project_id | string | Required | The unique ID of the GCP project to retrieve scan options for. |
Requirements
Output
json— Response from the API endpoint 'GetGcpScanOptions'.DatadogApi.RetrieveResourceRestrictionPolicy
Retrieve restriction policy for a specific resource. This tool is used to obtain the restriction policy linked to a particular resource by providing the resource ID. It should be called when you need to understand access restrictions or permissions associated with the resource.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
resource_identifier | string | Required | The ID of the resource, formatted as `type:id`. Supported types: `dashboard`, `integration-service`, `integration-webhook`, `notebook`, `reference-table`, `security-rule`, `slo`, `workflow`, `app-builder-app`, `connection`, `connection-group`, `rum-application`, `cross-org-connection`, `spreadsheet`, `on-call-schedule`, `on-call-escalation-policy`, `on-call-team-routing-rules`. |
Requirements
Output
json— Response from the API endpoint 'GetRestrictionPolicy'.DatadogApi.RetrieveSupportCaseTypes
Retrieves all available support case types from Datadog. This tool should be called to get a complete list of support case types available in Datadog. Useful for understanding the types of support cases that can be submitted.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'GetAllCaseTypes'.DatadogApi.RunHistoricalDetectionJob
Initiate a historical detection job in Datadog. Use this tool to start a historical detection job via Datadog's SIEM API. It is called when there's a need to analyze past data using historical detections. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'RunHistoricalJob'.DatadogApi.ScheduleDowntime
Schedule downtime for services or systems through Datadog. Use this tool to schedule a downtime for services or systems using Datadog's API. It is useful for planning maintenance or handling expected outages by suppressing alerts during the specified period. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'CreateDowntime'.DatadogApi.SearchAuditLogs
Retrieve audit logs events based on a search query. Use this tool to filter and search through Datadog audit logs events using complex queries. Results are paginated.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
audit_logs_search_query | string | Optional | A string representing the search query following the Audit Logs search syntax to filter the logs. |
max_events_limit | integer | Optional | Specify the maximum number of events to include in the response, enabling efficient pagination. |
maximum_time_for_requested_events | string | Optional | Maximum time for the requested events. Supports date, math, and regular timestamps (in milliseconds). |
minimum_time | string | Optional | Minimum time for the requested events. Accepts date, math, or timestamps in milliseconds. |
pagination_cursor | string | Optional | Cursor for retrieving subsequent pages of audit log results. |
sort_parameter | string | Optional | Sort events by timestamp. Use 'timestamp' for ascending, '-timestamp' for descending. |
time_offset_seconds | integer | Optional | Time offset in seconds to apply to the query, adjusting the timeframe of the log search. |
timezone | string | Optional | Specify the timezone for the query, using GMT, UTC, an offset like UTC+1, or a Timezone Database identifier like America/New_York. |
Requirements
Output
json— Response from the API endpoint 'SearchAuditLogs'.DatadogApi.SearchCases
Search and retrieve support cases from Datadog. Use this tool to search and retrieve support case information from Datadog. It is useful for accessing case details and statuses.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
order_ascending | boolean | Optional | Set to true for ascending order; false for descending. |
page_number | integer | Optional | The specific page number to return in the search results. |
page_size | integer | Optional | The number of results per page, with a maximum value of 100. |
search_query | string | Optional | The search query to filter cases. Use keywords or phrases to specify your search criteria. |
sort_by_field | string | Optional | Specify the field to sort by. Options are 'created_at', 'priority', or 'status'. |
Requirements
Output
json— Response from the API endpoint 'SearchCases'.DatadogApi.SearchCiPipelineEvents
Retrieve CI pipeline events matching a search query. Use this tool to obtain CI Visibility pipeline events that fit a specific search query. It's useful for filtering and searching through pipeline events using complex queries. The results are paginated.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
filter_to_time | string | Optional | The maximum time for requested events; supports date, math, and timestamps (in milliseconds). |
max_events_per_page | integer | Optional | Specify the maximum number of events to retrieve in a single response. This limits the number of events returned in one page of results. |
min_time_for_events | string | Optional | Specify the minimum time for the requested events. Supports date, math expressions, and timestamps in milliseconds. |
pagination_cursor | string | Optional | Use this to fetch the next set of results by providing the cursor value from the previous query response. |
query_time_offset_seconds | integer | Optional | The time offset in seconds to apply to the query for event retrieval. |
search_query | string | Optional | The search query using CI Visibility Explorer search syntax to filter pipeline events. |
sort_events_by | string | Optional | Defines the order of CI pipeline events by timestamp. Use 'timestamp' for ascending order and '-timestamp' for descending order. |
timezone | string | Optional | Specify the timezone as GMT, UTC, a UTC offset (like UTC+1), or a Timezone Database identifier (e.g., America/New_York). |
Requirements
Output
json— Response from the API endpoint 'SearchCIAppPipelineEvents'.DatadogApi.SearchCiTestEvents
Retrieve CI Visibility test events with advanced search capabilities. Use this tool to obtain CI Visibility test events that match specific search criteria. Ideal for building complex event filtering and searching within Datadog's CI data.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
maximum_event_time | string | Optional | The maximum time for the requested events. Supports date strings, math expressions, or timestamps (in milliseconds). |
maximum_events_in_response | integer | Optional | Specify the maximum number of events to be returned in the response. This limits the size of the result set. |
pagination_cursor | string | Optional | Cursor for retrieving the next set of paginated results based on previous queries. |
search_query | string | Optional | The search query using CI Visibility Explorer syntax for filtering test events. |
sort_order | string | Optional | Specify the sorting order for events. Use 'timestamp' for ascending or '-timestamp' for descending order. |
start_time_filter | string | Optional | The minimum time for requested events; can be a date, mathematical expression, or timestamp in milliseconds. |
time_offset_seconds | integer | Optional | The time offset, in seconds, to apply to the query for adjusting the search time range. |
timezone | string | Optional | Specify the timezone as GMT, UTC, a UTC offset (e.g., UTC+1), or a Timezone Database identifier (e.g., America/New_York). |
Requirements
Output
json— Response from the API endpoint 'SearchCIAppTestEvents'.DatadogApi.SearchDatadogEvents
Search and filter events in Datadog. Use this tool to find and filter events in Datadog using complex search queries. It returns a paginated list of events that match the specified criteria.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
event_search_query | string | Optional | The search query using Datadog's event search syntax to filter events. |
max_event_time | string | Optional | Specify the maximum time for the events. Supports date math and timestamps in milliseconds. |
maximum_events_per_page | integer | Optional | Specify the maximum number of events returned per page in the response. This controls the pagination size. |
paging_cursor | string | Optional | The cursor for pagination to retrieve the next set of results. |
sort_order | string | Optional | Specify event sorting order: 'timestamp' for ascending, '-timestamp' for descending. |
start_time | string | Optional | The earliest time for requested events, using date math or timestamps in milliseconds. |
time_offset_seconds | integer | Optional | The time offset to apply to the query in seconds. Use an integer to specify the shift in time for the search results. |
timezone | string | Optional | Specify the timezone for the query. It can be GMT, UTC, an offset (like UTC+1), or a Timezone Database identifier (like America/New_York). |
Requirements
Output
json— Response from the API endpoint 'SearchEvents'.DatadogApi.SearchDatadogIncidents
Search for incidents in Datadog by query. Use this tool to find incidents in Datadog that match a specific query. It helps in quickly retrieving relevant incident information based on search criteria.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
incident_query | string | Required | Query to determine which incidents to return. Use facets joined by `AND` and multiple values by `OR`, e.g., `state:active AND severity:(SEV-2 OR SEV-1)`. |
include_related_objects | string | Optional | Specifies which types of related objects ('users', 'attachments') should be included in the response. |
page_offset | integer | Optional | The starting position offset for returning incidents. Use an integer value. |
page_size | integer | Optional | Specify the number of incidents to return per page. The maximum allowed value is 100. |
sort_order | string | Optional | Defines the order of returned incidents. Use 'created' for ascending and '-created' for descending. |
Requirements
Output
json— Response from the API endpoint 'SearchIncidents'.DatadogApi.SearchDatadogIssues
Search and retrieve issues from Datadog using a query. Use this tool to programmatically search for issues in your organization via Datadog. It returns a list of issues that match a specified search query, up to 100 per request.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
end_date | integer | Required | End date (exclusive) for the query in milliseconds since the Unix epoch. Determines up to when the issues are retrieved. |
object_type | string | Required | Specify the type of the object. The value must be 'search_request'. |
search_event_query | string | Required | Search query using the event search syntax to find relevant issues. |
start_date_millis | integer | Required | Start date (inclusive) of the query in milliseconds since the Unix epoch. |
event_track_to_query | string | Optional | Specify the track of events to query: 'trace', 'logs', or 'rum'. Either track or persona must be provided. |
include_relationship_objects | array<string> | Optional | List of relationship objects to include in the response, specified as an array of strings. |
search_persona | string | Optional | Persona for the search. Choose from ALL, BROWSER, MOBILE, or BACKEND. Either track(s) or persona(s) must be specified. |
sort_results_by | string | Optional | Attribute to sort the search results. Options: TOTAL_COUNT, FIRST_SEEN, IMPACTED_SESSIONS, PRIORITY. |
Requirements
Output
json— Response from the API endpoint 'SearchIssues'.DatadogApi.SearchFlakyTests
Retrieve a list of flaky tests with pagination support. Use this tool to fetch information about flaky tests from the Flaky Test Management system. Useful for identifying tests that frequently fail or are unreliable.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
filter_query | string | Optional | Search query for filtering flaky tests using log syntax. Keys include 'flaky_test_state', 'flaky_test_category', '@test.name', '@test.suite', '@test.module', '@test.service', '@git.repository.id_v2', '@git.branch', '@test.codeowners', 'env'. |
maximum_flaky_tests_limit | integer | Optional | Specify the maximum number of flaky tests to include in the response. |
pagination_cursor | string | Optional | A cursor from the previous request to fetch the following results. |
request_data_type | string | Optional | Defines the data structure type for the Flaky Tests Search request. Use 'search_flaky_tests_request'. |
sort_flaky_tests | string | Optional | Sort flaky test results by specified criteria: FQN, first or last flaked, failure rate, etc. Use prefixed '-' for descending order. |
Requirements
Output
json— Response from the API endpoint 'SearchFlakyTests'.DatadogApi.SearchRumEvents
Search and filter RUM events based on a query. This tool retrieves RUM events that match a specified search query. It's useful for building complex filtering and search operations on RUM events. Results are paginated for easy navigation.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
filter_max_time | string | Optional | Specify the maximum event time in ISO 8601 format, mathematical expressions, or milliseconds. |
maximum_events_in_response | integer | Optional | Specifies the maximum number of RUM events to return in the response. |
minimum_event_time | string | Optional | The minimum time for events in ISO 8601 format, math expressions, or milliseconds. |
pagination_cursor | string | Optional | Provide the cursor to fetch the next set of results from a previous query. |
rum_search_query | string | Optional | The search query following the RUM search syntax to filter events. |
sort_order | string | Optional | Specify the sort order for events by timestamp. Use 'timestamp' for ascending order and '-timestamp' for descending order. |
time_offset_seconds | integer | Optional | The time offset in seconds to apply to the query. |
timezone | string | Optional | Specify the timezone as GMT, UTC, an offset (like UTC+1), or a Timezone Database identifier (like America/New_York). |
Requirements
Output
json— Response from the API endpoint 'SearchRUMEvents'.DatadogApi.SearchSecuritySignals
Retrieve security signals based on a search query. Use this tool to find security signals that match specific search criteria. Ideal for monitoring security alerts and potential threats.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
maximum_signals_per_response | integer | Optional | The maximum number of security signals to return in the response. |
maximum_timestamp_for_signals | string | Optional | The latest date and time for security signals to be included in the search results, formatted as a string. |
minimum_timestamp | string | Optional | The minimum timestamp for requested security signals. Use ISO 8601 format, e.g., '2023-10-05T14:48:00Z'. |
pagination_cursor | string | Optional | The cursor to continue listing results from the previous query. Use it for paginating results. |
search_query | string | Optional | A string used to search and filter the security signals based on specific criteria. |
sort_order | string | Optional | Specify how to sort the security signals. Use 'timestamp' for ascending and '-timestamp' for descending order. |
Requirements
Output
json— Response from the API endpoint 'SearchSecurityMonitoringSignals'.DatadogApi.SendInvitations
Invite users to join the organization via email. This tool sends invitation emails to specified users, asking them to join the organization. It should be used when you need to extend an invite to new members through email. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'SendInvitations'.DatadogApi.SetOnCallTeamRoutingRules
Set or update a team's On-Call routing rules in Datadog. Use this tool to configure or modify the On-Call routing rules for a specific team in Datadog. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
team_identifier | string | Optional | The unique identifier for the team whose routing rules are being set. It should be a string. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
include_relationships | string | Optional | Comma-separated list of relationships to include in the response. Allowed: `rules`, `rules.policy`. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'SetOnCallTeamRoutingRules'.DatadogApi.SetOnDemandConcurrencyCap
Update the on-demand concurrency cap setting in Datadog. Use this tool to save a new value for the on-demand concurrency cap in the Datadog Synthetics settings. This updates the maximum number of on-demand tests that can run concurrently.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
on_demand_concurrency_cap_value | number | Optional | Specify the new value for the on-demand concurrency cap in Datadog. |
Requirements
Output
json— Response from the API endpoint 'SetOnDemandConcurrencyCap'.DatadogApi.SetServiceRuleOutcomesBatch
Batch set multiple service-rule outcomes. This tool is used to set multiple service-rule outcomes in a single batched request to Datadog, making it efficient for updating multiple outcomes simultaneously. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'CreateScorecardOutcomesBatch'.DatadogApi.SyncDatadogTeamsWithGithub
Link existing Datadog teams with GitHub teams by name matching. Synchronizes Datadog teams with GitHub teams by name, evaluating all current teams without making modifications. Requires a connected GitHub organization and appropriate permissions.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
source_platform | string | Required | Specify the external source platform for team synchronization. Only "github" is supported. |
synchronization_type | string | Required | Type of synchronization operation. Only "link" is supported to match existing teams by name. |
team_sync_bulk_type | string | Required | Specifies the type for bulk team synchronization. Use 'team_sync_bulk'. |
Requirements
Output
json— Response from the API endpoint 'SyncTeams'.DatadogApi.TestSecurityMonitoringRule
Test an existing security monitoring rule in Datadog. Use this tool to test an existing security monitoring rule in Datadog by specifying the rule ID. It will return the results of the test, helping to ensure the rule is functioning as expected. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
security_monitoring_rule_id | string | Optional | The ID of the existing security monitoring rule to test in Datadog. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'TestExistingSecurityMonitoringRule'.DatadogApi.TestSecurityRule
Test a security monitoring rule. Use this tool to test a security monitoring rule within Datadog's system. It should be called when you need to verify the effectiveness or functionality of a specific rule. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'TestSecurityMonitoringRule'.DatadogApi.TriggerAwsResourceScan
Trigger a high-priority scan of an AWS resource. Use this tool to initiate a high-priority scan of a specific AWS resource. Ensure agentless scanning is activated for the AWS account containing the resource you wish to scan.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
aws_resource_arn | string | Required | The ARN of the AWS resource to scan, such as EC2, Lambda, AMI, ECR, RDS, or S3. |
task_type | string | Optional | The type of the on-demand task. This must always be set to 'aws_resource'. |
Requirements
Output
json— Response from the API endpoint 'CreateAwsOnDemandTask'.DatadogApi.TriggerOnCallPage
Triggers a new On-Call Page in Datadog. Use this tool to trigger a new On-Call Page in Datadog whenever immediate attention is required. Ideal for alerting on-call team members.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
issue_summary | string | Optional | A short summary of the issue or context for the On-Call Page. |
on_call_page_urgency_level | string | Optional | Specifies the urgency level of the On-Call Page. Accepts 'low' or 'high'. |
page_title | string | Optional | The title of the On-Call Page. Provide a concise and clear title to identify the issue or alert. |
resource_type_for_on_call | string | Optional | Specify the type of resource for creating an On-Call Page. Use `pages`. |
tags_for_categorization | array<string> | Optional | An array of tags for categorizing or filtering the On-Call page. |
target_identifier | string | Optional | Identifier for the target, such as a team handle or user ID, used to specify the intended recipient of the On-Call Page. |
target_type | string | Optional | Specify the kind of target: 'team_id', 'team_handle', or 'user_id'. |
Requirements
Output
json— Response from the API endpoint 'CreateOnCallPage'.DatadogApi.UnarchiveCase
Unarchive a specific support case in Datadog. Use this tool to restore a previously archived support case based on its ID. This is helpful when you need to reactivate or view the details of a case that was archived.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
case_identifier | string | Required | The unique identifier (UUID or key) of the case to be unarchived. |
case_resource_type | string | Optional | The resource type of the case, must be 'case'. |
Requirements
Output
json— Response from the API endpoint 'UnarchiveCase'.DatadogApi.UnassignCase
Unassigns a case from its current assignee. Use this tool to unassign a specific case from its current assignee within Datadog. This is helpful when you want to reassign or close a support case.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
case_identifier | string | Required | The unique UUID or key representing the case to be unassigned in Datadog. |
case_resource_type | string | Optional | Specifies the resource type of the case. Must be set to 'case'. |
Requirements
Output
json— Response from the API endpoint 'UnassignCase'.DatadogApi.UnpublishApp
Unpublish an app to remove its live version. Use this tool to unpublish an app and remove its live version. The app can still be updated and republished in the future. Requires a registered application key.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
app_identifier | string | Required | The ID of the app you want to unpublish, removing its live version. |
Requirements
Output
json— Response from the API endpoint 'UnpublishApp'.DatadogApi.UnregisterAppKey
Unregister an application key to revoke its access. Use this tool to revoke access by unregistering a specific application key from Datadog.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
app_key_id | string | Required | The unique identifier of the application key to be unregistered. |
Requirements
Output
json— Response from the API endpoint 'UnregisterAppKey'.DatadogApi.UpdateActionConnection
Update an existing action connection in Datadog. This tool updates an action connection in Datadog using the provided connection ID. Ensure you have a registered application key before calling this tool. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
action_connection_id | string | Optional | The unique identifier for the action connection to be updated in Datadog. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'UpdateActionConnection'.DatadogApi.UpdateApmRetentionFilter
Update an APM retention filter in your organization. Use this tool to update a retention filter for APM in your Datadog organization. Default filters cannot be renamed or removed.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
enable_retention_filter | boolean | Required | Set to true to enable or false to disable the retention filter. |
filter_id | string | Required | The unique identifier for the retention filter that you want to update. |
filter_query | string | Required | The search query for the retention filter, following the span search syntax. |
retention_filter_id | string | Required | The unique ID of the retention filter to be updated. |
retention_filter_name | string | Required | Specify the name of the retention filter to update. |
span_sample_rate | number | Required | Sample rate to apply to spans going through this retention filter. A value of 1.0 keeps all spans matching the query. Expected to be a number between 0 and 1. |
resource_type | string | Optional | Specifies the type of the APM retention filter resource, should be 'apm_retention_filter'. |
retention_filter_type | string | Optional | Specify the type of retention filter. Valid options are: 'spans-sampling-processor', 'spans-errors-sampling-processor', 'spans-appsec-sampling-processor'. |
trace_sample_rate | number | Optional | Sample rate for traces containing spans that pass through the retention filter. A value of 1.0 keeps all matching traces. |
Requirements
Output
json— Response from the API endpoint 'UpdateApmRetentionFilter'.DatadogApi.UpdateAppVersion
Update an app by creating a new version. Use this tool to update an existing app by creating a new version through Datadog's API. Ensure you have the necessary registered application key or have configured permissions in the UI before making this call. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
application_id | string | Optional | The unique ID of the app to update. Required for creating a new version. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'UpdateApp'.DatadogApi.UpdateArchiveConfiguration
Replace an existing archive configuration in Datadog. Use this tool to update an archive configuration by replacing the current settings with new ones for a specified archive in your Datadog organization. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
archive_identifier | string | Optional | The unique identifier for the archive you wish to update in Datadog. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'UpdateLogsArchive'.DatadogApi.UpdateAwsAccountIntegration
Update an AWS Account Integration configuration. Use this tool to update the configuration of an AWS Account Integration by specifying the configuration ID. Ideal for modifying existing AWS integration settings. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
aws_account_integration_config_id | string | Optional | Unique Datadog ID for the AWS Account Integration Config. Retrieve using the List all AWS integrations endpoint and query by AWS Account ID. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'UpdateAWSAccount'.DatadogApi.UpdateAwsCurConfigStatus
Updates status or configuration of an AWS CUR config. Use this tool to update the active/archived status or account filtering settings of an AWS Cost and Usage Report (CUR) configuration in Datadog for a specified cloud account.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
cloud_account_id | integer | Required | The ID of the AWS cloud account to configure in Datadog. |
automatic_inclusion_of_new_accounts | boolean | Optional | Set to true to automatically include new member accounts by default in your billing dataset. |
aws_cur_config_request_type | string | Optional | Specify the type of AWS CUR config Patch Request, usually 'aws_cur_config_patch_request'. |
excluded_aws_account_ids | array<string> | Optional | List of AWS account IDs to exclude from the billing dataset when "include_new_accounts" is true. |
included_aws_accounts | array<string> | Optional | List of AWS account IDs to be included in the billing dataset when `include_new_accounts` is `false`. |
is_cost_management_enabled | boolean | Optional | Indicates whether the Cloud Cost Management account is enabled. Accepts a boolean value. |
Requirements
Output
json— Response from the API endpoint 'UpdateCostAWSCURConfig'.DatadogApi.UpdateAwsScanOptions
Update Agentless scan options for an AWS account. This tool updates the Agentless scan settings for a specified AWS account. It should be called when modifications to scan options are needed for security or compliance purposes.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
account_identifier | string | Required | The ID of the AWS account that needs scan options updated. |
aws_account_id | string | Required | The ID of the AWS account for which to update scan options. |
enable_lambda_scanning | boolean | Optional | Set to true to enable scanning of AWS Lambda functions. |
enable_sensitive_data_scanning | boolean | Optional | Enable scanning for sensitive data in the AWS account. Set to true to enable. |
enable_vulnerability_scanning_for_containers | boolean | Optional | Set to true to enable scanning for container vulnerabilities. |
enable_vulnerability_scanning_in_hosts | boolean | Optional | Enable scanning for vulnerabilities in hosts. Set to true to enable, false to disable. |
resource_type | string | Optional | Specifies the resource type. Must be set to `aws_scan_options`. |
Requirements
Output
json— Response from the API endpoint 'UpdateAwsScanOptions'.DatadogApi.UpdateAzureConfigStatus
Update status of Azure config to active or archived. This tool updates the status of a specified Azure configuration to either active or archived. It should be called when there is a need to change the operational state of an Azure config.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
cloud_account_id | integer | Required | The identifier for the Azure Cloud account whose configuration status is being updated. |
azure_config_patch_request_type | string | Optional | Specify the type of Azure config Patch Request, typically 'azure_uc_config_patch_request'. |
enable_cloud_cost_management | boolean | Optional | Set to true to enable the Cloud Cost Management account, false to disable it. |
Requirements
Output
json— Response from the API endpoint 'UpdateCostAzureUCConfigs'.DatadogApi.UpdateAzureScanOptions
Update Agentless scan options for an Azure subscription. Use this tool to update the Agentless scanning preferences for a specified Azure subscription in Datadog.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
azure_subscription_id | string | Required | The unique identifier for the Azure subscription to update scan options. |
azure_scan_options_resource_type | string | Optional | Specifies the resource type for Azure scan options, must be 'azure_scan_options'. |
azure_subscription_identifier | string | Optional | The Azure subscription ID for which to update scan options. |
enable_container_vulnerability_scanning | boolean | Optional | Enable or disable container vulnerability scanning. Set to true to enable, false to disable. |
enable_scanning_for_host_vulnerabilities | boolean | Optional | Enable or disable scanning for vulnerabilities in host operating systems. |
Requirements
Output
json— Response from the API endpoint 'UpdateAzureScanOptions'.DatadogApi.UpdateCaseAttributes
Update attributes of a specific case. Use this tool to update the attributes of a specific case in Datadog by providing the case ID and new attribute values. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
case_identifier | string | Optional | The unique identifier or key for the case to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'UpdateAttributes'.DatadogApi.UpdateCaseCustomAttribute
Update a custom attribute for a specific case in Datadog. Use this tool to update the custom attribute of a specific case by providing the case ID and the custom attribute key in Datadog. It should be called when you need to modify the properties of an existing case. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
case_identifier | string | Optional | The UUID or key of the case to be updated. This identifies the specific case in Datadog. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
custom_attribute_key | string | Optional | The key for the custom attribute of the case to be updated. Provide the exact key name to ensure accurate updates. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'UpdateCaseCustomAttribute'.DatadogApi.UpdateCaseDescription
Update the description of a case in Datadog. Use this tool to modify the description of a specific case in Datadog by providing the case ID and new description details.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
case_uuid_or_key | string | Required | The unique identifier (UUID or key) for the specific case you want to update in Datadog. |
new_case_description | string | Required | Provide the new description text for the case you wish to update. This replaces the current case description. |
case_resource_type | string | Optional | Specify the type of resource for the case. It must be 'case'. |
Requirements
Output
json— Response from the API endpoint 'UpdateCaseDescription'.DatadogApi.UpdateCasePriority
Update the priority of a specific case. This tool updates the priority level of a given case in the system. It should be called when a change in priority is required for case management.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
case_identifier | string | Required | The unique identifier for the case, either UUID or key. |
case_priority | string | Optional | Specify the priority level of the case. Valid options are: 'NOT_DEFINED', 'P1', 'P2', 'P3', 'P4', 'P5'. |
case_resource_type | string | Optional | Specifies the type of resource, should be set to 'case'. |
Requirements
Output
json— Response from the API endpoint 'UpdatePriority'.DatadogApi.UpdateCaseStatus
Update the status of a specific case in Datadog. Use this tool to change the status of an existing case in Datadog. It should be called when you need to update a case's progress or condition to a new state.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
case_status | string | Required | Specify the status of the case. Valid values are 'OPEN', 'IN_PROGRESS', 'CLOSED'. |
case_uuid_or_key | string | Required | The unique identifier or key for the case to update its status in Datadog. |
case_resource_type | string | Optional | Specifies the resource type of the case. Must be 'case'. |
Requirements
Output
json— Response from the API endpoint 'UpdateStatus'.DatadogApi.UpdateCaseTitle
Update the title of a specific case by ID. Use this tool to change the title of a case in Datadog by providing the specific case ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
case_identifier | string | Required | The unique identifier (UUID or key) of the case whose title you want to update. |
new_case_title | string | Required | The new title for the case to be updated. |
case_resource_type | string | Optional | Specify the type of the case resource, which should be 'case'. |
Requirements
Output
json— Response from the API endpoint 'UpdateCaseTitle'.DatadogApi.UpdateCloudflareAccount
Update details of a Cloudflare account. Use this tool to update the information of an existing Cloudflare account linked with Datadog. It should be called whenever modifications to a Cloudflare account are required.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
cloudflare_account_id | string | Required | The unique identifier for the Cloudflare account to be updated. |
allowed_resource_types_for_metrics | array<string> | Optional | An array of resource types ('web', 'dns', 'lb', 'worker') to allow for metrics collection. |
cloudflare_account_email | string | Optional | The email associated with the Cloudflare account. Required if using an API key instead of a token. |
cloudflare_account_name | string | Optional | The name of the Cloudflare account to be updated. |
cloudflare_api_key | string | Optional | The API key for the Cloudflare account, required for authentication. |
json_api_type | string | Optional | The JSON:API type for this API. Always use `cloudflare-accounts`. |
zone_allowlist | array<string> | Optional | A list of zone identifiers to restrict which metrics can be pulled for Cloudflare. |
Requirements
Output
json— Response from the API endpoint 'UpdateCloudflareAccount'.DatadogApi.UpdateCloudWorkloadSecurityAgentRule
Update a specific cloud workload security agent rule. Use this tool to update a particular security agent rule for cloud workloads. This should only be used for the Government (US1-FED) site and returns the updated agent rule object upon success. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
agent_rule_identifier | string | Optional | The unique identifier for the agent rule to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'UpdateCloudWorkloadSecurityAgentRule'.DatadogApi.UpdateConfluentAccount
Updates the Confluent account details. Use this tool to update the details of a Confluent account by providing the account ID. It ensures the account information is current and accurately reflects any required changes.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
confluent_account_id | string | Required | The unique ID of the Confluent account to be updated. |
confluent_api_key | string | Required | Provide the API key associated with your Confluent account. |
confluent_api_secret | string | Required | The API secret for the Confluent account. Required to authenticate and update the account details. |
api_type | string | Optional | Set this to `confluent-cloud-accounts` to specify the JSON:API type for the update request. |
tags_list | array<string> | Optional | A list of tag strings for the account. Use single keys or key-value pairs separated by a colon. |
Requirements
Output
json— Response from the API endpoint 'UpdateConfluentAccount'.DatadogApi.UpdateConfluentResource
Update a Confluent resource linked to a specified account. Use this tool to update a Confluent resource associated with a given account by specifying the resource and account IDs.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
confluent_account_id | string | Required | The ID of the Confluent account associated with the resource to be updated. |
confluent_resource_id | string | Required | The unique identifier for the Confluent resource to be updated. |
resource_id | string | Required | The ID of the Confluent account resource to update. |
resource_type | string | Required | Specifies the resource type of the Confluent resource. Valid values are 'kafka', 'connector', 'ksql', or 'schema_registry'. |
enable_custom_metrics | boolean | Optional | Set to true to enable the `custom.consumer_lag_offset` metric which includes extra metric tags. |
resource_data_type | string | Optional | The JSON:API type for this request. Must be 'confluent-cloud-resources'. |
tags_list | array<string> | Optional | A list of tags for the resource. Each tag can be a single key or a key-value pair separated by a colon. |
Requirements
Output
json— Response from the API endpoint 'UpdateConfluentResource'.DatadogApi.UpdateCustomAllocationRule
Update custom allocation rules with new filters and strategies. This tool updates an existing custom allocation rule in Datadog by modifying filters and allocation strategies. It supports various allocation strategies like PROPORTIONAL, EVEN, TIMESERIES, PERCENT, and USAGE_METRIC. Users should specify strategy methods and filter conditions to redefine the allocation. Appropriate strategy fields and filter operators must be used according to the needs. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
custom_allocation_rule_id | integer | Optional | The unique identifier for the custom allocation rule to update. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'UpdateCustomAllocationRule'.DatadogApi.UpdateCustomFramework
Update an existing custom security management framework. Use this tool to make changes to an existing custom framework within Datadog's cloud security management. Invoke this when you need to update framework details identified by a specific handle and version. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
framework_handle | string | Optional | The unique identifier for the framework to update. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
framework_version | string | Optional | Specifies the version of the framework to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'UpdateCustomFramework'.DatadogApi.UpdateDashboardListItems
Update dashboards in an existing dashboard list. Use this tool to update the dashboards contained in a specific dashboard list within Datadog. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
dashboard_list_identifier | integer | Optional | ID of the dashboard list to update with new items. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'UpdateDashboardListItems'.DatadogApi.UpdateDatadogApiKey
Update an API key in Datadog. This tool updates an existing API key in Datadog. It should be called when you need to modify the details of an API key for access permissions or other configurations within the Datadog platform.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
api_key_id | string | Required | The unique identifier for the API key to be updated in Datadog. |
api_key_name | string | Required | The new name for the API key to be updated. |
key_id | string | Required | ID of the API key to be updated in Datadog. |
api_key_category | string | Optional | The category of the API key for the update operation. |
api_keys_resource_type | string | Optional | Specifies the resource type for API keys. Must be 'api_keys'. |
enable_remote_config_read | boolean | Optional | Enable remote config read for the API key. Use true to enable, false to disable. |
Requirements
Output
json— Response from the API endpoint 'UpdateAPIKey'.DatadogApi.UpdateDatadogAppKey
Edit a Datadog application key by ID. Use this tool to update details of a specific Datadog application key by providing its ID. Useful for modifying configurations or permissions of the application key.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
app_key_id | string | Required | The unique ID of the Datadog application key to be edited. |
application_key_id | string | Required | The unique identifier for the Datadog application key that needs to be updated. |
application_key_name | string | Optional | Name of the application key to be updated. |
application_key_scopes | array<string> | Optional | Array of scopes to grant the application key. Each scope is a string specifying a permission level. |
application_keys_resource_type | string | Optional | Fixed value for the resource type, which should always be 'application_keys'. |
Requirements
Output
json— Response from the API endpoint 'UpdateApplicationKey'.DatadogApi.UpdateDatadogUser
Update a user's information in Datadog. Use this tool to edit the details of a user in Datadog. It requires an admin user's application key. Ideal for managing user access or updating user profiles as needed.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
user_id | string | Required | The unique identifier for the user to be updated in Datadog. |
user_identifier | string | Required | The unique ID of the user to be updated in Datadog. |
disable_user | boolean | Optional | Boolean value to set if the user is disabled (true) or enabled (false). |
user_email | string | Optional | The email address of the user to be updated in Datadog. |
user_name | string | Optional | The name of the user to be updated in Datadog. |
user_resource_type | string | Optional | Specifies the resource type for the user. Must be set to 'users'. |
Requirements
Output
json— Response from the API endpoint 'UpdateUser'.DatadogApi.UpdateDatastoreAttributes
Update attributes of an existing datastore in Datadog. Use this tool to update details of an existing datastore in Datadog by specifying its ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
datastore_unique_identifier | string | Required | The unique identifier of the datastore to update in Datadog. |
datastore_description | string | Optional | A human-readable description for the datastore. Use this to provide additional information or context about the datastore. |
datastore_display_name | string | Optional | The display name of the datastore to be updated. Provide a concise, human-readable name. |
datastore_update_id | string | Optional | The unique identifier for the datastore that needs to be updated. |
resource_type_for_datastores | string | Optional | Specifies the resource type for datastores. Must be 'datastores'. |
Requirements
Output
json— Response from the API endpoint 'UpdateDatastore'.DatadogApi.UpdateDatastoreItem
Partially update an item in a datastore by its key. Use this tool to modify an existing item in a datastore by specifying its key. It's ideal for making incremental changes without altering the entire record, leveraging Datadog's API. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
datastore_identifier | string | Optional | The unique identifier for the datastore that contains the item to update. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'UpdateDatastoreItem'.DatadogApi.UpdateDeviceTags
Update the tags for a specified device. Use this tool to modify the tags associated with a device in Datadog. It's called when there's a need to update or change the tags for device management. The tool confirms the modifications made to the device tags.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
device_identifier | string | Required | The ID of the device for which tags are being updated. |
device_id_for_tags | string | Optional | The ID of the device for which the tags will be updated. |
device_tags | array<string> | Optional | A list of tags to update for the device. Each tag should be a string. |
resource_type | string | Optional | The type of resource, always set to 'tags'. |
Requirements
Output
json— Response from the API endpoint 'UpdateDeviceUserTags'.DatadogApi.UpdateDomainAllowlist
Update the organization's domain allowlist to control domain access.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
allowed_domains_list | array<string> | Optional | A list of domains to include in the organization's email domain allowlist. |
email_domain_allowlist_type | string | Optional | Type of email domain allowlist. Valid value: 'domain_allowlist'. |
enable_email_domain_allowlist | boolean | Optional | Set to true to enable the email domain allowlist for the organization. |
organization_identifier | string | Optional | The unique identifier for the organization to update the domain allowlist. |
Requirements
Output
json— Response from the API endpoint 'PatchDomainAllowlist'.DatadogApi.UpdateDowntime
Update downtime by its ID in Datadog. Use this tool to modify an existing downtime configuration in Datadog by providing the downtime ID. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
downtime_id | string | Optional | The unique identifier of the downtime to be updated in Datadog. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'UpdateDowntime'.DatadogApi.UpdateFastlyAccount
Updates a Fastly account via Datadog integration. Call this tool to update details of a Fastly account through the Datadog API. Useful for managing Fastly integration settings.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
fastly_account_id | string | Required | The unique identifier for the Fastly account to update. |
fastly_account_name | string | Optional | The name of the Fastly account to update. |
fastly_api_key | string | Optional | The API key for the Fastly account to be updated. |
json_api_type | string | Optional | Specifies the type for the Fastly account API. Must be 'fastly-accounts'. |
Requirements
Output
json— Response from the API endpoint 'UpdateFastlyAccount'.DatadogApi.UpdateFastlyService
Update a Fastly service for an account in Datadog. Use this tool to update specific details of a Fastly service associated with an account in Datadog. Useful for modifying service configurations.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
fastly_account_id | string | Required | The unique ID of the Fastly account to be updated. |
fastly_service_id | string | Required | Provide the Fastly Service ID to specify which service to update. |
fastly_service_identifier | string | Required | The ID of the Fastly service to be updated. |
fastly_service_json_api_type | string | Optional | The JSON:API type for this API, which should always be `fastly-services`. |
fastly_service_tags | array<string> | Optional | A list of tags to update the Fastly service with. Each tag should be a string. |
Requirements
Output
json— Response from the API endpoint 'UpdateFastlyService'.DatadogApi.UpdateGcpScanOptions
Update scan options for a GCP project in Datadog. Use this tool to update the agentless scanning options for an activated Google Cloud Platform project in Datadog. It should be called when changes to the existing scan configuration are needed.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
gcp_project_id | string | Required | The Google Cloud Platform project ID to update scan options for. |
enable_container_vulnerability_scanning | boolean | Optional | Enable (True) or disable (False) scanning for vulnerabilities in containers. |
enable_host_vulnerability_scanning | boolean | Optional | Indicate if scanning for vulnerabilities in host operating systems is enabled. |
gcp_scan_options_resource_type | string | Optional | Specifies the GCP scan options resource type, typically set to 'gcp_scan_options'. |
google_cloud_project_id | string | Optional | The ID of the GCP project to update scan options for, used as an identifier. |
Requirements
Output
json— Response from the API endpoint 'UpdateGcpScanOptions'.DatadogApi.UpdateGcpStsAccount
Update an STS-enabled GCP service account configuration. Call this tool to modify the configuration of an existing STS-enabled Google Cloud Platform service account in Datadog. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
service_account_id | string | Optional | Unique ID of your GCP STS-enabled service account to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'UpdateGCPSTSAccount'.DatadogApi.UpdateGcpUsageCostStatus
Update the status of a GCP Usage Cost config. This tool updates the status of a Google Cloud Platform Usage Cost configuration in Datadog, setting it as active or archived. It should be called when you need to change the operational status of a specific GCP cost configuration based on the cloud account ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
cloud_account_id | integer | Required | The ID of the Google Cloud account for which the cost configuration status needs to be updated. |
cloud_cost_management_enabled | boolean | Required | Set to 'true' to enable the Cloud Cost Management account or 'false' to disable it. |
gcp_usage_cost_config_request_type | string | Optional | Type of Google Cloud Usage Cost configuration patch request. Use 'gcp_uc_config_patch_request'. |
Requirements
Output
json— Response from the API endpoint 'UpdateCostGCPUsageCostConfig'.DatadogApi.UpdateIncident
Partially update an incident's details. Use this tool to update specific attributes of an existing incident in Datadog. Only the provided attributes will be modified. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
incident_uuid | string | Optional | The unique identifier (UUID) for the incident to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
include_related_objects | array<string> | Optional | List of related object types to include in the response, such as 'users', 'comments', etc. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'UpdateIncident'.DatadogApi.UpdateIncidentIntegration
Update incident integration metadata in Datadog. Call this tool to update the metadata of an existing incident integration in Datadog. Useful for modifying integration details after an incident is created. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
incident_uuid | string | Optional | The UUID of the incident. This is a unique identifier used to specify which incident to update the integration metadata for. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
integration_metadata_uuid | string | Optional | The UUID of the incident integration metadata to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'UpdateIncidentIntegration'.DatadogApi.UpdateIncidentNotificationRule
Update an incident notification rule in Datadog. This tool updates an existing incident notification rule in Datadog with a complete replacement. Use it when you need to modify the settings or parameters of an incident alert rule. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
notification_rule_id | string | Optional | The unique identifier for the notification rule to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
include_resources | string | Optional | Comma-separated list of resources to include: `created_by_user`, `last_modified_by_user`, `incident_type`, `notification_template`. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'UpdateIncidentNotificationRule'.DatadogApi.UpdateIncidentTodo
Update a specific incident todo in Datadog. Use this tool to update details of a specific todo associated with an incident in Datadog. This is useful when you need to modify tasks related to incident management. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
incident_uuid | string | Optional | The unique identifier (UUID) of the incident to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
incident_todo_uuid | string | Optional | The unique identifier (UUID) of the incident todo to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'UpdateIncidentTodo'.DatadogApi.UpdateIncidentType
Update the type of a specific incident in Datadog. Use this tool to modify an existing incident type in Datadog by specifying the incident type ID. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
incident_type_uuid | string | Optional | The UUID representing the incident type to be updated in Datadog. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'UpdateIncidentType'.DatadogApi.UpdateIpAllowlist
Edit and toggle the IP allowlist settings in Datadog. This tool updates the entries in the Datadog IP allowlist, enabling or disabling it as needed. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'UpdateIPAllowlist'.DatadogApi.UpdateIssueAssignee
Update the assignee of an issue in Datadog. Use this tool to change the assignee of a specific issue in Datadog by providing the issue ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
issue_identifier | string | Required | The unique identifier for the issue to update the assignee. |
object_type | string | Required | Specifies the type of object being updated. For issue assignee, use 'assignee'. |
user_identifier | string | Required | The identifier of the user to assign the issue to. |
Requirements
Output
json— Response from the API endpoint 'UpdateIssueAssignee'.DatadogApi.UpdateIssueState
Update the state of an issue in Datadog. This tool updates the state of an issue identified by `issue_id` in Datadog, allowing transitions between states such as `OPEN`, `RESOLVED`, or `IGNORED`. It should be called when you need to change an issue's status.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
issue_id_value | string | Required | The identifier for the issue to update the state of in Datadog. |
issue_identifier | string | Required | The unique identifier for the issue to update its state in Datadog. |
issue_object_type | string | Required | Specifies the type of the object. Accepted value is 'error_tracking_issue'. |
issue_state | string | Required | State of the issue, valid values are 'OPEN', 'ACKNOWLEDGED', 'RESOLVED', 'IGNORED', 'EXCLUDED'. |
Requirements
Output
json— Response from the API endpoint 'UpdateIssueState'.DatadogApi.UpdateLogBasedMetric
Update a specific log-based metric in your organization. Call this tool to update a particular log-based metric within your organization using Datadog's API. Ideal for modifying metrics configurations to refine log analysis and monitoring. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
log_metric_name | string | Optional | The name of the log-based metric to be updated. It specifies which metric to modify in your organization. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'UpdateLogsMetric'.DatadogApi.UpdateLogsArchiveOrder
Updates the order of log archives in Datadog. This tool updates the sequence in which log archives are processed within Datadog. Reordering them may impact the structure and content of logs processed by other archives. Use this when you need to change how logs are archived.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
archive_ids_order | array<string> | Optional | An ordered list of `<ARCHIVE_ID>` strings to define the new archives order in Datadog. |
archive_order_type | string | Optional | Specifies the type for the archive order definition. Must be 'archive_order'. |
Requirements
Output
json— Response from the API endpoint 'UpdateLogsArchiveOrder'.DatadogApi.UpdateLogsCustomDestination
Update specific fields of a custom logs destination. Use this tool to update the selected fields of a specific custom logs destination within your organization. This is useful for modifying destination configurations in Datadog. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
custom_destination_id | string | Optional | The unique identifier for the custom logs destination to update. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'UpdateLogsCustomDestination'.DatadogApi.UpdateMetricTagConfiguration
Update the tag configuration of a metric in Datadog. This tool updates the tag configuration for a specific metric in Datadog. It supports updating percentile or custom aggregations, and changing tag exclusion modes. Use it when you need to manage or modify metric tags, especially to switch from an allow-list to a deny-list. Requires specific permissions and an existing configuration. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
metric_name | string | Optional | Specify the name of the metric whose tag configuration you wish to update. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'UpdateTagConfiguration'.DatadogApi.UpdateMonitorNotificationRule
Updates a Datadog monitor notification rule. Use this tool to update a notification rule for a monitor in Datadog by specifying the `rule_id`. It should be called when you need to change the settings or behavior of an existing monitor notification rule. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
monitor_notification_rule_id | string | Optional | ID of the monitor notification rule to update. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'UpdateMonitorNotificationRule'.DatadogApi.UpdateMonitorUserTemplate
Creates a new version of a monitor user template in Datadog. Use this tool to create a new version of an existing monitor user template in Datadog when updates or changes are needed to a monitor's settings. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
monitor_user_template_id | string | Optional | ID of the monitor user template to update with a new version. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'UpdateMonitorUserTemplate'.DatadogApi.UpdateMsTeamsTenantHandle
Update a Microsoft Teams tenant-based handle in Datadog. Use this tool to update a tenant-based handle for the Datadog Microsoft Teams integration. This is useful when you need to modify existing handle configurations for tenant-based integrations.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
tenant_handle_id | string | Required | The unique ID of the tenant-based handle to update in Datadog. |
channel_id | string | Optional | The ID of the Microsoft Teams channel to update for the tenant-based handle. |
team_id | string | Optional | The Microsoft Teams Team ID for the tenant-based handle. Required for updating handle configurations. |
tenant_handle_name | string | Optional | Tenant-based handle name for the Microsoft Teams integration in Datadog. This specifies the handle's identifier within the configuration. |
tenant_handle_resource_type | string | Optional | Specifies the resource type for the tenant-based handle, usually 'tenant-based-handle'. |
tenant_id | string | Optional | The unique identifier for the tenant. Used to specify which tenant's handle is being updated. |
Requirements
Output
json— Response from the API endpoint 'UpdateTenantBasedHandle'.DatadogApi.UpdateNotificationTemplate
Update attributes of a notification template. Use this tool to update an existing notification template's attributes in Datadog's incident management system.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
notification_template_id | string | Required | The unique identifier of the notification template to update. |
notification_template_resource_type | string | Required | Specifies the type of the notification template resource. Must be 'notification_templates'. |
template_id | string | Required | The unique identifier of the notification template to be updated. |
notification_template_category | string | Optional | The category of the notification template to update. |
notification_template_content | string | Optional | The content body of the notification template to be updated. |
notification_template_name | string | Optional | The name of the notification template to update in Datadog. |
notification_template_subject | string | Optional | The subject line of the notification template to be updated in Datadog. |
relationships_to_include | string | Optional | Comma-separated list of relationships to include. Valid values: `created_by_user`, `last_modified_by_user`, `incident_type`. |
Requirements
Output
json— Response from the API endpoint 'UpdateIncidentNotificationTemplate'.DatadogApi.UpdateOktaAccount
Update details of an existing Okta account. Call this tool to update information for a specific Okta account using its account ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
account_id | string | Required | The unique identifier for the Okta account to be updated. |
account_type | string | Optional | Specify the type of the Okta account. Must be 'okta-accounts'. |
authorization_method | string | Optional | Specify the authorization method for the Okta account. This is a required string value. |
okta_account_api_key | string | Optional | The API key for authenticating the Okta account. |
okta_client_id | string | Optional | The Client ID of the Okta app integration to update. |
okta_client_secret | string | Optional | The client secret for the Okta app integration to be updated. Ensure this is kept secure. |
okta_domain | string | Optional | The domain associated with the Okta account to update. |
Requirements
Output
json— Response from the API endpoint 'UpdateOktaAccount'.DatadogApi.UpdateOnCallEscalationPolicy
Update an On-Call escalation policy in Datadog. This tool allows updating an existing On-Call escalation policy in Datadog. Use it to modify the details of a specific policy by providing the necessary updates. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
escalation_policy_id | string | Optional | The unique identifier of the escalation policy to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
include_relationships | string | Optional | Comma-separated list of relationships to be returned. Options: `teams`, `steps`, `steps.targets`. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'UpdateOnCallEscalationPolicy'.DatadogApi.UpdateOnCallSchedule
Update an existing on-call schedule in Datadog. Use this tool to update the details of an existing on-call schedule in Datadog. It should be called when there is a need to modify the configuration or timing of an on-call schedule. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
schedule_id | string | Optional | The unique identifier for the on-call schedule to update in Datadog. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
relationships_to_include | string | Optional | Comma-separated relationships to return, e.g., `teams`, `layers`. Allowed values: `teams`, `layers`, `layers.members`, `layers.members.user`. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'UpdateOnCallSchedule'.DatadogApi.UpdateOpsgenieService
Update a service in the Datadog Opsgenie integration. This tool updates a specified service object within the Datadog Opsgenie integration. It should be called when you need to modify an existing Opsgenie service.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
opsgenie_service_id | string | Required | The unique identifier of the Opsgenie service to be updated. |
service_uuid | string | Required | The UUID of the service to be updated in the Datadog Opsgenie integration. |
custom_region_url | string | Optional | The custom URL for a specific Opsgenie region. Specify if using a custom region. |
opsgenie_api_key | string | Optional | The API key for your Opsgenie service, needed to authenticate the update request. |
opsgenie_service_name | string | Optional | The name for the Opsgenie service to update. It should uniquely identify the service within your Opsgenie account. |
opsgenie_service_region | string | Optional | Specify the region for the Opsgenie service. Allowed values are 'us', 'eu', or 'custom'. |
opsgenie_service_resource_type | string | Optional | Specify as 'opsgenie-service' to denote the Opsgenie service resource type. |
Requirements
Output
json— Response from the API endpoint 'UpdateOpsgenieService'.DatadogApi.UpdateOrgConfig
Update a specified organization configuration in Datadog. Use this tool to update the value of a specific organization configuration in Datadog. Suitable for changing settings like feature toggles or other organizational configurations.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
org_config_data_type | string | Required | The data type of the organization configuration, which should be 'org_configs'. |
org_config_value | string | Required | The new value for the organization configuration. Provide the desired value to update the specific Org Config. |
organization_configuration_name | string | Required | The name of the organization configuration to update in Datadog. |
Requirements
Output
json— Response from the API endpoint 'UpdateOrgConfig'.DatadogApi.UpdateOrgConnection
Update an existing organization connection in Datadog. Use this tool to update details of an existing organization connection in Datadog. Useful for modifying connection configurations or settings.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
org_connection_id | string | Required | The unique identifier of the organization connection in Datadog. |
org_connection_type | string | Required | Specifies the type of organization connection. Must be 'org_connection'. |
organization_connection_id | string | Required | The unique identifier of the organization connection to be updated. |
updated_connection_types | array<string> | Required | A list of updated connection types for the organization connection. |
Requirements
Output
json— Response from the API endpoint 'UpdateOrgConnections'.DatadogApi.UpdatePipeline
Update a pipeline in Datadog's remote config. Use this tool to update specific pipelines in Datadog's remote configuration system using the pipeline ID. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
pipeline_id | string | Optional | The unique ID of the pipeline to update in Datadog. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'UpdatePipeline'.DatadogApi.UpdatePowerpack
Update the details of a specific powerpack in Datadog. Use this tool to modify the properties of an existing powerpack in Datadog by providing the specific powerpack ID. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
powerpack_id | string | Optional | The unique identifier for the powerpack to update in Datadog. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'UpdatePowerpack'.DatadogApi.UpdateReferenceTable
Update data, description, and tags of a reference table. This tool updates a reference table by its ID, allowing changes to the data, description, or tags. It is useful when modifications are needed for existing reference tables, including those with different source types like LOCAL_FILE, S3, GCS, or AZURE. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
reference_table_id | string | Optional | The ID of the reference table that needs to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'UpdateReferenceTable'.DatadogApi.UpdateResourceFilters
Update resource filters in cloud security management. Use this tool to modify resource filters within Datadog's cloud security management. It should be called when you need to change which resources are included or excluded for evaluation. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'UpdateResourceEvaluationFilters'.DatadogApi.UpdateRestrictionPolicy
Update the restriction policy for a Datadog resource. Use this tool to update the restriction policy associated with various Datadog resources, such as dashboards, integration services, notebooks, and more. You can specify the resource type and the new access permissions like viewer, editor, or others depending on the resource. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
resource_identifier | string | Optional | Identifier of the resource, formatted as `type:id`. Includes supported types like `dashboard`, `integration-service`, `notebook`, and others. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
allow_self_lockout | boolean | Optional | Set to true to allow admins to remove their own access from the resource. Default is false, preventing self-lockout. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'UpdateRestrictionPolicy'.DatadogApi.UpdateRumApplication
Update settings of a specific RUM application by ID. Use this tool to modify the configuration or details of a RUM (Real User Monitoring) application within your organization by providing its ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
rum_app_id | string | Required | The unique ID of the RUM application to update. |
rum_application_id | string | Required | The ID of the RUM application to update. |
product_analytics_retention_state | string | Optional | Set the retention policy for Product Analytics data derived from RUM events. Accepted values: 'MAX', 'NONE'. |
rum_application_name | string | Optional | The name of the RUM application to be updated. |
rum_application_type | string | Optional | Specify the type of RUM application. Valid options: `browser`, `ios`, `android`, `react-native`, `flutter`, `roku`, `electron`, `unity`, `kotlin-multiplatform`. |
rum_application_update_type | string | Optional | Specifies the RUM application update type. Allowed value is 'rum_application_update'. |
rum_event_processing_state | string | Optional | Configures which RUM events are processed and stored. Accepts 'ALL', 'ERROR_FOCUSED_MODE', or 'NONE'. |
Requirements
Output
json— Response from the API endpoint 'UpdateRUMApplication'.DatadogApi.UpdateRumMetric
Update a specific rum-based metric in your organization. Use this tool to update details of a specific rum-based metric within your organization's Datadog settings. Ideal for modifying existing metrics to adjust configurations. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
metric_name | string | Optional | The name of the rum-based metric to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'UpdateRumMetric'.DatadogApi.UpdateRumRetentionFilter
Update a RUM retention filter for a RUM application. Use this tool to modify the retention filter settings of a RUM application. It returns the updated RUM retention filter details if the request succeeds.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
filter_id | string | Required | UUID of the retention filter to be updated. |
retention_filter_id | string | Required | The unique ID of the retention filter to be updated. |
rum_application_id | string | Required | The ID of the RUM application to update the retention filter. Required for identifying the application. |
enable_retention_filter | boolean | Optional | Set to true to enable the retention filter. Set to false to disable it. |
filter_name | string | Optional | The name of the RUM retention filter to update. |
resource_type | string | Optional | Specifies the resource type for the retention filter. Must be 'retention_filters'. |
rum_event_type_filter | string | Optional | Specifies the type of RUM events to filter on, such as 'session', 'view', 'action', etc. |
rum_retention_filter_query | string | Optional | The query string used to define criteria for the RUM retention filter. |
sample_rate | integer | Optional | The sample rate for a RUM retention filter, an integer between 0 and 100, specifying the percentage of data to sample. |
Requirements
Output
json— Response from the API endpoint 'UpdateRetentionFilter'.DatadogApi.UpdateScanningGroup
Update a scanning group's rule order in Datadog. Use this tool to update and reorder the rules within a specific scanning group in Datadog. Ensure all current rules are included in the update to maintain the group integrity. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
group_id | string | Optional | The ID of the scanning group whose rules are being updated. This is required to identify the group. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'UpdateScanningGroup'.DatadogApi.UpdateScanningRule
Update a scanning rule in Datadog. Use this tool to update a scanning rule in Datadog's sensitive data scanner. It's important to note that the request must not attempt to edit the regex attribute of rules that include a standard_pattern relationship, as these are non-editable. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
rule_id | string | Optional | The unique identifier for the scanning rule to be updated. This value is required. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'UpdateScanningRule'.DatadogApi.UpdateScorecardOutcomes
Update multiple scorecard rule outcomes in Datadog. Use this tool to update several scorecard rule outcomes in Datadog with a single request. Ideal for synchronizing or modifying multiple outcomes efficiently. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'UpdateScorecardOutcomesAsync'.DatadogApi.UpdateScorecardRule
Updates an existing scorecard rule in Datadog. Use this tool to modify an existing scorecard rule in the Datadog platform by specifying the rule ID and the new details for the rule. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
rule_id | string | Optional | A unique identifier for the scorecard rule to be updated in Datadog. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'UpdateScorecardRule'.DatadogApi.UpdateSecurityFilter
Update a specific security filter's configuration. Use this tool to update the configuration of a specific security filter in Datadog. It returns the updated security filter object when successful. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
security_filter_id | string | Optional | The ID of the specific security filter to update. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'UpdateSecurityFilter'.DatadogApi.UpdateSecurityMonitoringRule
Update an existing Datadog security monitoring rule. Use this tool to update an existing security monitoring rule in Datadog. Ensure all 'cases', 'queries', and 'options' fields are included when making updates. Default rules can only have specific updates allowed. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
security_rule_id | string | Optional | The ID of the security monitoring rule to update. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'UpdateSecurityMonitoringRule'.DatadogApi.UpdateSoftwareCatalogKind
Create or update kinds in the Software Catalog. Use this tool to add new kinds or update existing ones in the Datadog Software Catalog. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'UpsertCatalogKind'.DatadogApi.UpdateSpanMetric
Update a specific span-based metric in Datadog. Use this tool to update a specific span-based metric in your Datadog organization. Call this tool when you need to modify the configuration of an existing span-based metric. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
span_metric_name | string | Optional | The name of the span-based metric to update in Datadog. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'UpdateSpansMetric'.DatadogApi.UpdateSuppressionRule
Update a specific suppression rule in Datadog. Use this tool to modify an existing suppression rule within Datadog's security monitoring configuration. Call this when you need to change the settings of a particular suppression rule identified by its ID. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
suppression_rule_id | string | Optional | The unique identifier of the suppression rule to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'UpdateSecurityMonitoringSuppression'.DatadogApi.UpdateTagPipelineRuleset
Update an existing tag pipeline ruleset with new rules. Use this tool to modify the rules and configuration of an existing tag pipeline ruleset in Datadog. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
ruleset_identifier | string | Optional | A unique string identifier for the tag pipeline ruleset to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'UpdateTagPipelinesRuleset'.DatadogApi.UpdateTeamInfo
Update and modify a team's configuration in Datadog. Use this tool to update a team in Datadog by modifying its configuration using the team's ID. You can adjust team links and other settings as needed. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
team_identifier | string | Optional | The unique identifier for the team to be updated. Must be a valid string representing the team's ID in Datadog. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'UpdateTeam'.DatadogApi.UpdateTeamLink
Updates a team link in Datadog. Use this tool to update the details of a specific team link within the Datadog service. It's useful for modifying or adjusting link information associated with a team.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
link_identifier | string | Required | The unique identifier for the link you want to update. |
link_label | string | Required | Specify the label for the link. This is used to identify or name the link within the team's list of links. |
link_url | string | Required | The URL for the team link. Provide a valid, well-formed URL. |
team_identifier | string | Required | The unique string identifier for the team related to the link. |
link_position | integer | Optional | The position of the link in the list, used to sort links for the team. |
team_id_associated_with_link | string | Optional | The ID of the team associated with the link to be updated. |
team_link_type | string | Optional | Specifies the type of team link. Must be 'team_links'. |
Requirements
Output
json— Response from the API endpoint 'UpdateTeamLink'.DatadogApi.UpdateTeamPermission
Update a team's permission setting in Datadog. Use this tool to update the permission setting for a specific team in Datadog, allowing for customized access control adjustments.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
action_to_update | string | Required | The specific action to update in the team's permission setting, specifying what can be performed. |
team_identifier | string | Required | The unique identifier of the team for which the permission setting will be updated. |
allowed_user_type_for_action | string | Optional | Specify the user type permitted to perform the action. Options: admins, members, organization, user_access_manage, teams_manage. |
team_permission_setting_type | string | Optional | Specify the team permission setting type. Required value: 'team_permission_settings'. |
Requirements
Output
json— Response from the API endpoint 'UpdateTeamPermissionSetting'.DatadogApi.UpdateUserTeamMembership
Update a user's membership attributes on a team. Use this tool to update specific membership attributes for a user within a team's membership in Datadog. This can be useful when user roles or permissions need modification.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
team_id | string | Required | The unique identifier of the team to update the user's membership attributes. |
user_identifier | string | Required | The unique identifier for the user whose membership is being updated. This is required to specify which user's attributes will be changed. |
provisioning_identifier | string | Optional | UUID of the User or Service Account who provisioned this team membership, or null if provisioned via SAML mapping. |
provisioning_mechanism | string | Optional | Specifies how the team relationship was provisioned. Options: null, "service_account", "saml_mapping". |
team_membership_type | string | Optional | Specify the type of team membership. The value must be 'team_memberships'. |
user_role_in_team | string | Optional | Specify the user's role within the team. Accepts 'admin'. |
Requirements
Output
json— Response from the API endpoint 'UpdateTeamMembership'.DatadogApi.UpdateWafCustomRule
Update a specific WAF custom rule in Datadog. Use this tool to update a specific Web Application Firewall (WAF) custom rule in Datadog. It returns the updated custom rule object upon successful execution. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
custom_rule_id | string | Optional | Specify the ID of the custom WAF rule to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'UpdateApplicationSecurityWafCustomRule'.DatadogApi.UpdateWafExclusionFilter
Updates a WAF exclusion filter by its identifier. Use this tool to update a specific Web Application Firewall (WAF) exclusion filter using its ID. It returns the updated exclusion filter object upon a successful request. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
waf_exclusion_filter_identifier | string | Optional | The unique identifier of the WAF exclusion filter to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'UpdateApplicationSecurityWafExclusionFilter'.DatadogApi.UpdateWorkflowById
Update a specific workflow by its ID. Use this tool to update the details of a workflow in Datadog by providing its ID. Ensure required permissions via a registered application key or configure them in the UI. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
workflow_identifier | string | Optional | The unique identifier for the workflow you wish to update in Datadog. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'UpdateWorkflow'.DatadogApi.UpdateWorkflowsWebhookHandle
Update a webhook handle in Datadog's Microsoft Teams integration. This tool updates a Workflows webhook handle for the Datadog Microsoft Teams integration. Use it to modify existing webhook configurations.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
webhook_handle_id | string | Required | The unique identifier for the Workflows webhook handle to be updated. |
webhook_handle_name | string | Optional | The name of the Workflows Webhook handle to be updated. This should be a descriptive string identifying the webhook. |
webhook_handle_resource_type | string | Optional | Specifies the Workflows webhook handle resource type. Use 'workflows-webhook-handle'. |
workflows_webhook_url | string | Optional | The URL for the Workflows Webhook. Specify the endpoint to send requests to. |
Requirements
Output
json— Response from the API endpoint 'UpdateWorkflowsWebhookHandle'.DatadogApi.UpdateWorkloadProtectionAgentRule
Update a specific Workload Protection Agent rule. Use this tool to update a specific Workload Protection Agent rule. This is helpful when you need to modify existing rules for workload protection. Please note that this endpoint is not available for the Government (US1-FED) site. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
agent_rule_id | string | Optional | The unique identifier of the specific Agent rule to update. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
agent_policy_id | string | Optional | The ID of the Agent policy to be updated in the Workload Protection Agent rule. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'UpdateCSMThreatsAgentRule'.DatadogApi.UploadCustomCostsFile
Upload a custom costs file to Datadog. This tool uploads a custom costs file to Datadog. Use it when you need to update or input new cost data into the system. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'UploadCustomCostsFile'.DatadogApi.ValidateMonitorTemplate
Validate the structure and content of a monitor template update. This tool is used to validate the structure and content of an existing monitor user template being updated to a new version. It ensures that the changes align with the required format and content guidelines. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
monitor_template_id | string | Optional | ID of the monitor user template to be validated. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'ValidateExistingMonitorUserTemplate'.DatadogApi.ValidateMonitorUserTemplate
Validate the structure and content of a monitor user template. Use this tool to ensure that a monitor user template in Datadog meets the required structural and content standards. This is essential for verifying templates before implementation. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'ValidateMonitorUserTemplate'.DatadogApi.ValidatePipelineConfig
Validate a pipeline configuration without making changes. Use this tool to check the correctness of a pipeline configuration in Datadog. It helps identify any potential errors without altering existing resources. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'ValidatePipeline'.DatadogApi.ValidateSecurityMonitoringRule
Validate a detection rule in Datadog. Use this tool to validate the configuration of a detection rule in Datadog's security monitoring. It checks if the rule meets all necessary criteria and returns whether it is valid. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'ValidateSecurityMonitoringRule'.DatadogApi.ValidateSuppressionRule
Validate a suppression rule in Datadog's monitoring system. This tool validates suppression rules in Datadog's security monitoring configuration. Use it to ensure rules are correctly set up and functioning as intended.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
is_suppression_rule_enabled | boolean | Required | Indicates whether the suppression rule is currently active. |
suppression_rule_name | string | Required | The name of the suppression rule to be validated. |
suppression_rule_query | string | Required | The rule query for the suppression rule, using detection rules search bar syntax. |
exclusion_query_on_input_data | string | Optional | An exclusion query for input data, such as logs or events. Events matching this are ignored by detection rules in the suppression rule. |
resource_type | string | Optional | Defines the type of the resource. Always set to `suppressions`. |
suppression_query | string | Optional | The query for the suppression rule. Signals matching this query are suppressed, using Signals Explorer syntax. |
suppression_rule_description | string | Optional | A text description of the suppression rule, explaining its purpose and details. |
suppression_rule_expiration_date | integer | Optional | A Unix millisecond timestamp for when the suppression rule expires and stops suppressing signals. |
suppression_rule_start_date | integer | Optional | Unix millisecond timestamp for the start date of the suppression rule, when it begins suppressing signals. |
Requirements
Output
json— Response from the API endpoint 'ValidateSecurityMonitoringSuppression'.DatadogApi.ValidateTagPipelineQuery
Validate the syntax and structure of a tag pipeline query. Use this tool to ensure that a tag pipeline query is correctly structured and free of syntax errors.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
query_attributes | string | Optional | The tag pipeline query to validate. Ensure it is correctly structured and free of syntax errors. |
query_request_data_id | string | Optional | The unique identifier for the RulesValidateQueryRequestData. |
query_resource_type | string | Optional | Specify the type of resource for query validation, always use 'validate_query'. |
Requirements
Output
json— Response from the API endpoint 'ValidateQuery'.