Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Schema
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
No prompts | |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
No resources | |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| ListAPIKeys | List all API keys available for your account. Query Parameters:
Responses:
{
"data": [
"unknown_type"
],
"included": [
"unknown_type"
],
"meta": "unknown_type"
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
} |
| ListSpansMetrics | Get the list of configured span-based metrics with their definitions. Responses:
{
"data": [
"unknown_type"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
} |
| GetSpansMetric | Get a specific span-based metric from your organization. Path Parameters:
Responses:
{
"data": "unknown_type"
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
} |
| ListApmRetentionFilters | Get the list of APM retention filters. Responses:
{
"data": [
"unknown_type"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
} |
| GetApmRetentionFilter | Get an APM retention filter. Path Parameters:
Responses:
{
"data": "unknown_type"
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
} |
| ListApplicationKeys | List all application keys available for your org Query Parameters:
Responses:
{
"data": [
"unknown_type"
],
"included": [
"unknown_type"
],
"meta": "unknown_type"
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
} |
| ListDowntimes | Get all scheduled downtimes. Query Parameters:
Responses:
{
"data": [
"unknown_type"
],
"included": [
"unknown_type"
],
"meta": "unknown_type"
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
} |
| GetDowntime | Get downtime detail by Path Parameters:
Query Parameters:
Responses:
{
"data": "unknown_type",
"included": [
"unknown_type"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
} |
| ListIncidents | Get all incidents for the user's organization. Query Parameters:
Responses:
{
"data": [
{
"attributes": {
"created": "2020-04-21T15:34:08.627205+00:00",
"creation_idempotency_key": null,
"customer_impact_duration": 0,
"customer_impact_end": null,
"customer_impact_scope": null,
"customer_impact_start": null,
"customer_impacted": false,
"detected": "2020-04-14T00:00:00+00:00",
"incident_type_uuid": "00000000-0000-0000-0000-000000000001",
"modified": "2020-09-17T14:16:58.696424+00:00",
"public_id": 1,
"resolved": null,
"severity": "SEV-1",
"time_to_detect": 0,
"time_to_internal_response": 0,
"time_to_repair": 0,
"time_to_resolve": 0,
"title": "Example Incident"
},
"id": "00000000-aaaa-0000-0000-000000000000",
"relationships": {
"attachments": {
"data": [
{
"id": "00000000-9999-0000-0000-000000000000",
"type": "incident_attachments"
},
{
"id": "00000000-1234-0000-0000-000000000000",
"type": "incident_attachments"
}
]
},
"commander_user": {
"data": {
"id": "00000000-0000-0000-cccc-000000000000",
"type": "users"
}
},
"created_by_user": {
"data": {
"id": "00000000-0000-0000-cccc-000000000000",
"type": "users"
}
},
"integrations": {
"data": [
{
"id": "00000000-0000-0000-4444-000000000000",
"type": "incident_integrations"
},
{
"id": "00000000-0000-0000-5555-000000000000",
"type": "incident_integrations"
}
]
},
"last_modified_by_user": {
"data": {
"id": "00000000-0000-0000-cccc-000000000000",
"type": "users"
}
}
},
"type": "incidents"
},
{
"attributes": {
"created": "2020-04-21T15:34:08.627205+00:00",
"creation_idempotency_key": null,
"customer_impact_duration": 0,
"customer_impact_end": null,
"customer_impact_scope": null,
"customer_impact_start": null,
"customer_impacted": false,
"detected": "2020-04-14T00:00:00+00:00",
"incident_type_uuid": "00000000-0000-0000-0000-000000000002",
"modified": "2020-09-17T14:16:58.696424+00:00",
"public_id": 2,
"resolved": null,
"severity": "SEV-5",
"time_to_detect": 0,
"time_to_internal_response": 0,
"time_to_repair": 0,
"time_to_resolve": 0,
"title": "Example Incident 2"
},
"id": "00000000-1111-0000-0000-000000000000",
"relationships": {
"attachments": {
"data": [
{
"id": "00000000-9999-0000-0000-000000000000",
"type": "incident_attachments"
}
]
},
"commander_user": {
"data": {
"id": "00000000-aaaa-0000-0000-000000000000",
"type": "users"
}
},
"created_by_user": {
"data": {
"id": "00000000-aaaa-0000-0000-000000000000",
"type": "users"
}
},
"integrations": {
"data": [
{
"id": "00000000-0000-0000-0001-000000000000",
"type": "incident_integrations"
},
{
"id": "00000000-0000-0000-0002-000000000000",
"type": "incident_integrations"
}
]
},
"last_modified_by_user": {
"data": {
"id": "00000000-aaaa-0000-0000-000000000000",
"type": "users"
}
}
},
"type": "incidents"
}
],
"included": [
"unknown_type"
],
"meta": "unknown_type"
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
} |
| ListIncidentTypes | Get all incident types. Query Parameters:
Responses:
{
"data": [
"unknown_type"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
} |
| GetIncidentType | Get incident type details. Path Parameters:
Responses:
{
"data": "unknown_type"
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
} |
| SearchIncidents | Search for incidents matching a certain query. Query Parameters:
Responses:
{
"data": "unknown_type",
"included": [
"unknown_type"
],
"meta": "unknown_type"
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
} |
| GetIncident | Get the details of an incident by Path Parameters:
Query Parameters:
Responses:
{
"data": "unknown_type",
"included": [
"unknown_type"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
} |
| ListIncidentAttachments | Get all attachments for a given incident. Path Parameters:
Query Parameters:
Responses:
{
"data": [
{
"attributes": {
"attachment": {
"documentUrl": "",
"title": "Postmortem IR-123"
},
"attachment_type": "postmortem"
},
"id": "00000000-abcd-0002-0000-000000000000",
"relationships": {
"last_modified_by_user": {
"data": {
"id": "00000000-0000-0000-cccc-000000000000",
"type": "users"
}
}
},
"type": "incident_attachments"
}
],
"included": [
"unknown_type"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
} |
| ListIncidentIntegrations | Get all integration metadata for an incident. Path Parameters:
Responses:
{
"data": [
"unknown_type"
],
"included": [
"unknown_type"
],
"meta": "unknown_type"
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
} |
| GetIncidentIntegration | Get incident integration metadata details. Path Parameters:
Responses:
{
"data": "unknown_type",
"included": [
"unknown_type"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
} |
| ListIncidentTodos | Get all todos for an incident. Path Parameters:
Responses:
{
"data": [
"unknown_type"
],
"included": [
"unknown_type"
],
"meta": "unknown_type"
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
} |
| GetIncidentTodo | Get incident todo details. Path Parameters:
Responses:
{
"data": "unknown_type",
"included": [
"unknown_type"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
} |
| GetLogsArchiveOrder | Get the current order of your archives. This endpoint takes no JSON arguments. Responses:
{
"data": "unknown_type"
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
} |
| ListLogsArchives | Get the list of configured logs archives with their definitions. Responses:
{
"data": [
"unknown_type"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
} |
| GetLogsArchive | Get a specific archive from your organization. Path Parameters:
Responses:
{
"data": "unknown_type"
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
} |
| ListArchiveReadRoles | Returns all read roles a given archive is restricted to. Path Parameters:
Responses:
{
"data": [
"unknown_type"
],
"meta": "unknown_type"
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
} |
| ListLogsCustomDestinations | Get the list of configured custom destinations in your organization with their definitions. Responses:
{
"data": [
"unknown_type"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
} |
| GetLogsCustomDestination | Get a specific custom destination in your organization. Path Parameters:
Responses:
{
"data": "unknown_type"
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
} |
| ListLogsMetrics | Get the list of configured log-based metrics with their definitions. Responses:
{
"data": [
"unknown_type"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
} |
| GetLogsMetric | Get a specific log-based metric from your organization. Path Parameters:
Responses:
{
"data": "unknown_type"
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
} |
| ListLogsGet | List endpoint returns logs that match a log search query. . Use this endpoint to search and filter your logs. If you are considering archiving logs for your organization, consider use of the Datadog archive capabilities instead of the log list API. See Query Parameters:
Responses:
{
"data": [
"unknown_type"
],
"links": "unknown_type",
"meta": "unknown_type"
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
} |
| ListTagConfigurations | Returns all metrics that can be configured in the Metrics Summary page or with Metrics without Limits™ (matching additional filters if specified).
Optionally, paginate by using the Query Parameters:
Responses:
{
"data": [
"unknown_type"
],
"links": "unknown_type",
"meta": "unknown_type"
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
} |
| ListActiveMetricConfigurations | List tags and aggregations that are actively queried on dashboards, notebooks, monitors, the Metrics Explorer, and using the API for a given metric name. Path Parameters:
Query Parameters:
Responses:
{
"data": "unknown_type"
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
} |
| ListTagsByMetricName | View indexed tag key-value pairs for a given metric name over the previous hour. Path Parameters:
Responses:
{
"data": "unknown_type"
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
} |
| ListMetricAssets | Returns dashboards, monitors, notebooks, and SLOs that a metric is stored in, if any. Updated every 24 hours. Path Parameters:
Responses:
{
"data": "unknown_type",
"included": [
"unknown_type"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
} |
| EstimateMetricsOutputSeries | Returns the estimated cardinality for a metric with a given tag, percentile and number of aggregations configuration using Metrics without Limits™. Path Parameters:
Query Parameters:
Responses:
{
"data": "unknown_type"
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
} |
| ListTagConfigurationByName | Returns the tag configuration for the given metric name. Path Parameters:
Responses:
{
"data": "unknown_type"
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
} |
| ListVolumesByMetricName | View distinct metrics volumes for the given metric name. Custom metrics generated in-app from other products will return Path Parameters:
Responses:
{
"data": "unknown_type"
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
} |
| ListRoles | Returns all roles, including their names and their unique identifiers. Query Parameters:
Responses:
{
"data": [
"unknown_type"
],
"meta": "unknown_type"
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
} |
| GetRole | Get a role in the organization specified by the role’s Path Parameters:
Responses:
{
"data": "unknown_type"
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
} |
| ListRolePermissions | Returns a list of all permissions for a single role. Path Parameters:
Responses:
{
"data": [
"unknown_type"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
} |
| ListRoleUsers | Gets all users of a role. Path Parameters:
Query Parameters:
Responses:
{
"data": [
"unknown_type"
],
"included": [
"unknown_type"
],
"meta": "unknown_type"
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
} |
| ListCloudWorkloadSecurityAgentRules | Get the list of agent rules. Note: This endpoint should only be used for the Government (US1-FED) site. Responses:
{
"data": [
"unknown_type"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
} |
| GetCloudWorkloadSecurityAgentRule | Get the details of a specific agent rule. Note: This endpoint should only be used for the Government (US1-FED) site. Path Parameters:
Responses:
{
"data": "unknown_type"
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
} |
| ListSecurityFilters | Get the list of configured security filters with their definitions. Responses:
{
"data": [
"unknown_type"
],
"meta": "unknown_type"
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
} |
| GetSecurityFilter | Get the details of a specific security filter. See the security filter guide for more examples. Path Parameters:
Responses:
{
"data": "unknown_type",
"meta": "unknown_type"
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
} |
| ListSecurityMonitoringSuppressions | Get the list of all suppression rules. Responses:
{
"data": [
"unknown_type"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
} |
| GetSecurityMonitoringSuppression | Get the details of a specific suppression rule. Path Parameters:
Responses:
{
"data": "unknown_type"
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
} |
| ListSecurityMonitoringRules | List rules. Query Parameters:
Responses:
{
"data": [
"unknown_type"
],
"meta": "unknown_type"
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
} |
| GetSecurityMonitoringRule | Get a rule's details. Path Parameters:
Responses:
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
} |
| ConvertExistingSecurityMonitoringRule | Convert an existing rule from JSON to Terraform for datadog provider resource datadog_security_monitoring_rule. Path Parameters:
Responses:
{
"terraformContent": "string"
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
} |
| GetRuleVersionHistory | Get a rule's version history. Path Parameters:
Query Parameters:
Responses:
{
"data": "unknown_type"
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
} |
| ListSecurityMonitoringSignals | The list endpoint returns security signals that match a search query. Both this endpoint and the POST endpoint can be used interchangeably when listing security signals. Query Parameters:
Responses:
{
"data": [
"unknown_type"
],
"links": "unknown_type",
"meta": "unknown_type"
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
} |
| GetSecurityMonitoringSignal | Get a signal's details. Path Parameters:
Responses:
{
"data": "unknown_type"
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
} |
| ListIncidentServices | Get all incident services uploaded for the requesting user's organization. If the Query Parameters:
Responses:
{
"data": [
{
"id": "00000000-0000-0000-0000-000000000000",
"type": "services"
}
],
"included": [
"unknown_type"
],
"meta": "unknown_type"
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
} |
| ListServiceDefinitions | Get a list of all service definitions from the Datadog Service Catalog. Query Parameters:
Responses:
{
"data": [
"unknown_type"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
} |
| GetServiceDefinition | Get a single service definition from the Datadog Service Catalog. Path Parameters:
Query Parameters:
Responses:
{
"data": "unknown_type"
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
} |
| GetIncidentService | Get details of an incident service. If the Path Parameters:
Query Parameters:
Responses:
{
"data": "unknown_type",
"included": [
"unknown_type"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
} |
| ListSpansGet | List endpoint returns spans that match a span search query. . Use this endpoint to see your latest spans.
This endpoint is rate limited to Query Parameters:
Responses:
{
"data": [
"unknown_type"
],
"links": "unknown_type",
"meta": "unknown_type"
}
{
"errors": [
"unknown_type"
]
}
{
"errors": [
"unknown_type"
]
}
{
"errors": [
"unknown_type"
]
}
{
"errors": [
"unknown_type"
]
} |
| GetOnDemandConcurrencyCap | Get the on-demand concurrency cap. Responses:
{
"data": "unknown_type"
}
{
"errors": [
"Bad Request"
]
} |
| ListIncidentTeams | Get all incident teams for the requesting user's organization. If the Query Parameters:
Responses:
{
"data": [
{
"attributes": {
"name": "team name"
},
"id": "00000000-7ea3-0000-0000-000000000000",
"type": "teams"
}
],
"included": [
"unknown_type"
],
"meta": "unknown_type"
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
} |
| GetIncidentTeam | Get details of an incident team. If the Path Parameters:
Query Parameters:
Responses:
{
"data": "unknown_type",
"included": [
"unknown_type"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
} |
| GetUsageApplicationSecurityMonitoring | Get hourly usage for application security . Note: This endpoint has been deprecated. Hourly usage data for all products is now available in the Get hourly usage by product family API Query Parameters:
Responses:
{
"data": [
"unknown_type"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
} |
| GetBillingDimensionMapping | Get a mapping of billing dimensions to the corresponding keys for the supported usage metering public API endpoints. Mapping data is updated on a monthly cadence. This endpoint is only accessible to parent-level organizations. Query Parameters:
Responses:
{
"data": "unknown_type"
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
} |
| GetCostByOrg | Get cost across multi-org account.
Cost by org data for a given month becomes available no later than the 16th of the following month.
Note: This endpoint has been deprecated. Please use the new endpoint
This endpoint is only accessible for parent-level organizations. Query Parameters:
Responses:
{
"data": [
"unknown_type"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
} |
| GetEstimatedCostByOrg | Get estimated cost across multi-org and single root-org accounts.
Estimated cost data is only available for the current month and previous month
and is delayed by up to 72 hours from when it was incurred.
To access historical costs prior to this, use the This endpoint is only accessible for parent-level organizations. Query Parameters:
Responses:
{
"data": [
"unknown_type"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
} |
| GetHistoricalCostByOrg | Get historical cost across multi-org and single root-org accounts. Cost data for a given month becomes available no later than the 16th of the following month. This endpoint is only accessible for parent-level organizations. Query Parameters:
Responses:
{
"data": [
"unknown_type"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
} |
| GetHourlyUsage | Get hourly usage by product family. Query Parameters:
Responses:
{
"data": [
"unknown_type"
],
"meta": "unknown_type"
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
} |
| GetUsageLambdaTracedInvocations | Get hourly usage for Lambda traced invocations. Note: This endpoint has been deprecated.. Hourly usage data for all products is now available in the Get hourly usage by product family API Query Parameters:
Responses:
{
"data": [
"unknown_type"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
} |
| GetUsageObservabilityPipelines | Get hourly usage for observability pipelines. Note: This endpoint has been deprecated. Hourly usage data for all products is now available in the Get hourly usage by product family API Query Parameters:
Responses:
{
"data": [
"unknown_type"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
} |
| GetProjectedCost | Get projected cost across multi-org and single root-org accounts. Projected cost data is only available for the current month and becomes available around the 12th of the month. This endpoint is only accessible for parent-level organizations. Query Parameters:
Responses:
{
"data": [
"unknown_type"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
} |
| ListUsers | Get the list of all users in the organization. This list includes all users even if they are deactivated or unverified. Query Parameters:
Responses:
{
"data": [
"unknown_type"
],
"included": [
"unknown_type"
],
"meta": "unknown_type"
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
} |
| GetUser | Get a user in the organization specified by the user’s Path Parameters:
Responses:
{
"data": "unknown_type",
"included": [
"unknown_type"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
} |
| ListUserOrganizations | Get a user organization. Returns the user information and all organizations joined by this user. Path Parameters:
Responses:
{
"data": "unknown_type",
"included": [
"unknown_type"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
} |
| ListUserPermissions | Get a user permission set. Returns a list of the user’s permissions granted by the associated user's roles. Path Parameters:
Responses:
{
"data": [
"unknown_type"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
} |
| GetUserMemberships | Get a list of memberships for a user Path Parameters:
Responses:
{
"data": [
"unknown_type"
],
"included": [
"unknown_type"
],
"links": "unknown_type"
}
{
"errors": [
"Bad Request"
]
}
{
"errors": [
"Bad Request"
]
} |